Adeptia Business Rules Engine FAQ's
Table of Contents
Adeptia Business Rule Engine Scope
The Adeptia Business Rule Engine enables users to define, manage, and apply custom business logic to automate and optimize data integration processes within the Adeptia platform.
Questions | Answers | |
---|---|---|
1 | What is the purpose of the AI Rules Engine? | The AI Rules Engine is designed to automate the code generation process for workflows driven by specific business rules or logic. It streamlines large-scale data transformations by leveraging AI to interpret, map, and generate the necessary code based on predefined rules and logic. This helps improve efficiency and accuracy in rule-based workflows by automating the creation of complex logic. |
2 | What use cases and scenarios are better suited for AI Rules Engine, and what use cases and scenarios are better suited for Traditional Mapping Rules? | The AI Rules Engine is better suited for handling complex scenarios where:
In contrast, Traditional Mapping Rules are better suited for:
Straightforward rule-based transformations where data changes are predictable and don’t demand flexibility or adaptation. |
3 | What is the difference between AI Rules Engine Auto-Mapper (Local) and Auto-mapper (AI Based)? Â |
|
4 | Will the AI Rules Engine run on both Windows Adeptia environment and Linux Adeptia Environment? | Yes, the AI Rules Engine is designed to run on both Windows and Linux environments within Adeptia. |
5 | Â What version of AC supports AI Rules Engine? Â | This functionality is typically available in newer versions with AI capabilities, specifically in AC 4.3 and above. |
6 | Can AI Rules Engine be added to Previous AC version Deployments? Â | AI Rules Engine is more suited for Adeptia Connect 4.3 and above, where AI capabilities are fully integrated. It does not support the older versions of AC. |
7 | Â Which Adeptia Team is responsible for maintaining the AC Rules Engine? Â | The R&D team will be responsible for all new enhancements, while the MST team will handle any support-related responsibilities. |
8 | Â Can AI Rules Engine be used externally from any other application as a Service or is it embedded within Adeptia and is only used from within the Adeptia solution? | The AI Rules Engine can be used externally as a service, but it is primarily designed to be embedded and utilized within the Adeptia solution itself. |
9 | What are the limitations of AI Rules Engine? Â | Some key limitations mentioned in the document include:
|
Setup
The setup of the Adeptia Business Rule Engine involves configuring the platform to define and apply business rules for automating data processing and integration workflows.
Questions | Answers | |
---|---|---|
1 | Â What are the Infra., Configuration, and Access Prerequisites for communicating with Azure Open AI? Are there specific ports to be opened up or IP Whitelisting to be done or Certificate to be configured? ? | Th following infrastructure, configuration, and access prerequisites for communicating with Azure Open AI. These include:
Certificates: In some cases, certificates may need to be configured to establish secure connections to Azure Open AI services. |
2 | Is AI Rules Engine Deployed as part of the AC Installer or is it installed separately after AC is installed? Â | Currently, The AI Rule Engine will be deployed separately. Â |
3 | What Azure subscription is used for OpenAI Rules Engine?  | The Azure subscription used for the OpenAI Rules Engine depends on the customer’s specific setup. In some cases, Adeptia may provide an Azure subscription for cloud environments, but the document does not specify further details on the subscription type. |
4 | Does the customer need to provide their own Azure Account to use AI Rules Engine for their AC Cloud Environment? Â |
|
5 | Does the customer need to provide their own Azure Account to use AI Rules Engine for their OnPrem AC Environment? |
|
Architecture & Design of AI Rules Engine
The architecture and design of the AI Rules Engine leverage machine learning algorithms and rule-based logic to process, analyze, and automate decision-making across complex datasets in real-time.
Questions | Answers | |
---|---|---|
1 | Â What is the role of AI in AI Rule Engine? | The AI in the AI Rules Engine plays a pivotal role in automating the generation of rules and code. It leverages machine learning models to interpret complex data patterns and create rules for data processing and decision-making. |
2 | What is the AI technology used behind the scene for generating the code? Â | The AI technology used includes Azure OpenAI services, which leverage Generative AI models like GPT to assist in the generation of rules and logic during workflows. |
3 | What Gen AI LLM is used in Azure Open AI for AI Rules Engine? Â | The AI Rules Engine uses Generative AI Language Models (LLM) such as GPT models provided by Azure OpenAI Services. These models assist in code generation and rule automation based on data inputs. |
4 | How does the AI Rules Engine fit in within the Process Flow, Template, or Transaction (Automation)? Is the AI Rules Engine represented as an activity? Â | The AI Rules Engine is represented as an activity within process flows or transactions. It integrates into the workflow template by dynamically generating rules and automating tasks based on data inputs and predefined configurations. |
5 | What software language is the AI Rules Engine code generated as? Â | The AI Rules Engine typically generates code in Python, which is the primary language used for rule execution. |
6 | Â Is Python the only code option, or are there other languages supported for the AI Code Generator? Â | While Python is the default language, the document implies that there could be support for other languages in the future, though Python is the primary option at present. |
7 | Â Can AI Rules Engine be used both at design time and run-time? Â | Yes, the AI Rules Engine can be used both at design time and run-time. This means it can assist in rule generation during the configuration stage and also execute those rules during the actual workflow. |
8 | Does AI Rules Engine use the Azure Open AI Services both at design time and run-time? Â | Yes, the AI Rules Engine utilizes Azure Open AI Services during both design time (when rules are being created) and run-time (when rules are executed). |
9 | What UI Framework is used for implementing the AI Rules Engine UI? Â | ReactJS - is used for implementing UI for AI Rule Engine. |
10 | Where is the AI Python code stored? Is it within the AC Backend Metadata table or in a custom table or somewhere else? | The AI-generated Python code is stored within Adeptia Connect in various metadata tables, including:
|
11 | Where is the AI Rules Engine Python code executed? Is it executed within AC or within Azure Open AI Service? | The AI Rules Engine Python code can be executed either within Adeptia Connect (AC) or using the Azure Open AI Service, depending on the specific implementation. |
12 | Where does the code reside once the code is generated? Does it reside within Adeptia or in an external cloud? Â | Once generated, the code resides within Adeptia. However, depending on the architecture and deployment, it could also reside in an external cloud (e.g., Azure). |
13 | What type of file format is supported by Rules Engine for Rule Data input and Rule Data output schema structure? Is JSON the only format supported as AI Rules Engine Input and Output, or are there other input and output schema formats as well? Â | JSON is the primary format supported for input and output schema in the AI Rules Engine, but there may be support for other formats as well, depending on the specific configuration. |
14 | What is the AI Rules Engine Live Option? | The AI Rules Engine Live Option refers to its ability to operate in real-time, dynamically generating and executing rules based on live data during workflow execution. |
15 | Â Can the Inbuilt AI Rules Engine be Extended with Custom Extensions? Â | Yes, the AI Rules Engine can be extended with custom extensions, allowing users to modify or add functionalities according to their specific requirements. |
16 | How is the AI Rule Engine invoked? (REST Webservices) Â | The AI Rules Engine can be invoked via REST Webservices, enabling external applications or processes to interact with the engine programmatically. |
17 | Is there a feature to create a copy of an existing rule set and save it in a different name? Â | Yes, there is a feature that allows users to create a copy of an existing rule set and save it under a different name for reuse or modification. |
 Security
The security of the AI Rules Engine ensures data protection through encryption, access control, and compliance with security standards to safeguard sensitive information during processing and rule execution.
Questions | Answers | |
---|---|---|
1 | Do all types of Adeptia users have access to AI Rules Engine? Â | No, not all types of Adeptia users have access to the AI Rules Engine. Access is typically restricted based on user roles and permissions. Specific user roles, such as administrators or users with special privileges, may have access to the AI Rules Engine, while other users may have limited or no access. |
2 | Does GAC apply to the AI Rules Engine as well? Â | Yes, GAC (Global Access Control) applies to the AI Rules Engine. This means that access to the AI Rules Engine and its features is governed by Adeptia's access control policies, ensuring that only authorized users can interact with it. |
3 | Â Is customer data passed to the AI Rules Engine during the Design Time? Â | During design time, customer data may or may not be passed to the AI Rules Engine, depending on the use case. Typically, sample data or schema definitions may be provided for rule creation, but it is possible to limit the exposure of actual customer data during this phase. |
4 | Â Is customer data passed to the AI Rules Engine during the Run-Time? Â | Yes, during run-time, customer data is passed to the AI Rules Engine to execute the rules and generate outputs. This is necessary for the engine to process and apply the rules on real-time data transactions. |
5 | What authentication method is used for calling Azure Open AI Services? (Tip: OAUTH) Â | The OAuth authentication method is used for calling Azure OpenAI Services. OAuth provides a secure and standardized method for authentication and authorization when interacting with external services like Azure OpenAI. |
 Implementation
The implementation of the AI Rules Engine involves integrating it into existing workflows, configuring rules, and deploying it to automate decision-making processes based on defined criteria.
Questions | Answers | |
---|---|---|
1 | Who from the customer teams will use the AI Rules Engine? Â | The AI Rules Engine will primarily be used by technical teams such as data engineers, system integrators, and developers responsible for configuring and managing workflows, automating rule-based decision-making, and ensuring the smooth execution of data processes. |
2 | What skill sets are required to use the AI Rules Engine? Do I need to be an expert in AI, Python, ReactJS, or any other technologies? Â | Users of the AI Rules Engine do not need to be experts in AI, Python, or ReactJS. The primary skills required are related to understanding the data workflows, business logic, and rule generation within Adeptia. However, some familiarity with Python may help in customizing rules if needed, but it is not mandatory. |
3 | Who will need to generate the schema definition and the sample data to pass to the AI Rules Engine to design and implement the Rules? Â | Data engineers or system integrators will be responsible for generating the schema definitions and providing sample data. This information is necessary for designing and implementing rules within the AI Rules Engine. |
4 | How can I implement nested AI Rules calls? Â | Nested AI Rules calls can be implemented by structuring the rules hierarchically within the Adeptia environment, where one rule can call another rule, creating a chain of dependencies. The details on how to configure this would depend on the specific workflow design. |
5 | How do I relate my data/record Identifier to the results? Â | You can relate your data or record identifier to the results by mapping the identifiers within the rule execution logic. The engine allows you to track specific identifiers through the data processing flow and link them to the rule outcomes. |
6 | Can I call the AI Rules Engine from the Mapper? Â | Yes, the AI Rules Engine can be invoked from the Mapper. This allows you to integrate rule-based decision-making directly into the data transformation process handled by the Mapper. |
7 | Â Is the AI Rules Output return only TRUE or FALSE as result, or can I include my own custom results as well? Â | The AI Rules Engine can return custom results in addition to simple TRUE or FALSE outcomes. You can configure the engine to provide more detailed outputs based on the rule conditions. |
8 | Can I generate a standard Error Code or Error Message as a result across the entire AC Solution Implementation to maintain consistency? Â | Yes, you can generate standard error codes or messages across the Adeptia Connect (AC) solution to maintain consistency. This is useful for creating a unified approach to error handling across different workflows and rules. |
9 | Does the AI Rules Engine support only Flat structure or also Hierarchical structure? Â | The AI Rules Engine supports both flat and hierarchical structures. This flexibility allows it to handle complex data models where records may be nested or layered within the dataset. |
10 | How do I indicate which record or field needs to be tested in a Hierarchical Structure? Â | In a hierarchical structure, you can indicate the specific record or field to be tested by specifying the node or path within the rule definition. The engine will interpret the hierarchy and apply the rule accordingly to the designated field. |
11 | What are the types of Errors that could occur in AI Rules Engine during Design-Time? Â | Design-time errors in the AI Rules Engine can include:
|
12 | What are the types of Errors that could occur in AI Rules Engine during Run-Time? Â | Run-time errors in the AI Rules Engine may involve:
|
  Rule Lifecycle and Governance
The Rule Lifecycle and Governance framework ensures the proper creation, management, versioning, and auditing of rules within the AI Rules Engine to maintain consistency, compliance, and accuracy.
Questions | Answers | |
---|---|---|
1 | Is it possible to have an audit trail of Rules set changes after the Rules have been published for governance of the rule life cycle? | Yes, it is possible to have an audit trail of rule set changes after the rules have been published. This feature is essential for governance of the rule life cycle, allowing users to track changes, modifications, or updates made to the rules over time. It ensures that all changes can be reviewed, making it useful for auditing and compliance purposes. |
2 | Is there a plan to implement Rule versioning? It would be a desirable feature to roll-back or go to a previous version. Â | Yes, there is a plan to implement rule versioning. This feature would allow users to create different versions of a rule set, providing the ability to roll back or revert to a previous version if necessary. Versioning is important for managing changes over time, ensuring stability, and allowing users to restore older versions of rules in case of errors or new requirements. |
 Testing
Testing in the AI Rules Engine involves validating and verifying the accuracy and performance of rules to ensure they function as intended within various scenarios before deployment.
Questions | Answers | |
---|---|---|
1 | What is the Accuracy of AI Rules Engine? Â | The accuracy of the AI Rules Engine depends on several factors, including the quality of the input data, the complexity of the rules, and how well the AI has been trained to handle specific use cases. The document does not specify a fixed accuracy rate, but it implies that the engine can be highly accurate when configured properly, especially in scenarios involving complex data processing where AI-driven decision-making adds value. |
2 | How do we test AI Rules Engine during the Design Time? Â | During design time, you can test the AI Rules Engine by:
Using the built-in validation tools: Adeptia's platform likely offers debugging tools that allow you to check if the rules are correctly designed before they go live. |
3 | Â How do we debug AI Rules Engine execution results during the Run-Time? Â | To debug AI Rules Engine execution results during run-time, you can:
|
 Migration
Adeptia Business Rule Engine Migration involves transferring existing business rules from one environment to another while ensuring compatibility, integrity, and minimal disruption to workflows.
Questions | Answers | |
---|---|---|
1 | Is the Migration Utility also used for Migrating AI Rules Engine code? Â | Yes, the Migration Utility can also be used for migrating AI Rules Engine code. This tool is part of the broader Adeptia Connect (AC) platform and is designed to facilitate the migration of various components, including rules, configurations, and code, between different environments (e.g., development, testing, and production). |
2 | How does the migration process work for the AI Rules Engine code? Â | The migration process for the AI Rules Engine code typically involves the following steps:
|
 Monitoring & Maintenance
Monitoring and Maintenance of the AI Rules Engine involve continuously tracking performance, identifying issues, and applying updates to ensure optimal functionality and rule accuracy over time.
Questions | Answers | |
---|---|---|
1 | How does versioning work for the AI Rules Engine code? Â | Versioning in the AI Rules Engine involves maintaining different versions of the rules and associated code over time. Each time a rule is updated or modified, a new version can be created. This allows users to:
|
2 | Where are the AI Rules Engine execution logs stored? Â | The execution logs for the AI Rules Engine are stored within the Adeptia Connect (AC) platform, typically in backend log tables. These could include tables specifically designed to track rule executions, such as:
|
3 | How are the AI Rules Engine execution logs visible to the users? Â | The execution logs are made visible to users through the Adeptia user interface. Users with the appropriate permissions can:
Use filters and search capabilities to locate specific logs related to particular rule executions or error events. |
4 | How does the AI Rules Engine log maintenance fit into the Log maintenance policy within Adeptia? Â | The AI Rules Engine log maintenance is integrated into the broader log maintenance policy within Adeptia. This policy typically involves:
|
Â
Â
 Benchmarks
Benchmarks for the AI Rules Engine assess its performance, efficiency, and scalability by measuring key metrics such as execution speed, data throughput, and system resource utilization under various conditions.
Questions | Answers | |
---|---|---|
1 | What volume of data can AI Rules Engine support? | The volume of data an AI Rules Engine can support varies widely based on the specific engine and its implementation. Generally, it depends on factors such as:
|
 Best Practices
Best Practices for the AI Rules Engine involve following guidelines and strategies to optimize performance, ensure reliability, and enhance rule accuracy and maintainability.
Questions | Answers | |
---|---|---|
1 | What is the alternative traditional way of implementing the rules? |
|
2 | What is the advantage of an AI Rules Engine over traditional methods? |
|
3 | When should you use an AI Rules Engine, and when should you not? |
|
4 | What are the design best practices for using an AI Rules Engine as part of the solution? |
|
5 |  What are the absolute Dos and Don’ts of using an AI Rules Engine? | DO’s
Don’ts:
|
6 | What are the best practices design considerations while using an AI Rules Engine? |
|
7 | What is the best approach for implementing an AI Rules Engine for a large volume of records within a single file? |
|
8 | What are the best approaches to handling AI Rules Engine errors? |
|
9 | What are the best practices for optimal AI Rules Engine performance? |
|
 Licensing
Licensing for the AI Rules Engine defines the usage terms, access rights, and pricing structure based on factors such as the number of users, executions, or features utilized.
Questions | Answers | |
---|---|---|
1 | What are the license implications of using an AI Rules Engine? | Licensing Models: AI Rules Engines typically come with specific licensing terms that can include:
|
2 | Is the AI Rules Engine available in all Tiers of Adeptia, AC Professional, AC Premier, AC Enterprise? |
|
3 | What is the cost model for using an AI Rules Engine? Is there an additional cost? Does the cost vary based on the usage in terms of the number of executions? |
|
 Miscellaneous Questions
Questions | Answers | |
---|---|---|
1 | Â Do the Rules Work on Field Match or File Match? |
|
2 | Â Where Are the Rules Stored in Backend? | Storage: Rules are typically stored in a database rather than in a single file. This allows for better management, querying, and updating of rules. The rules are often stored in tables or collections within the backend system. |
3 | Â For Uploading Definition File/Test File, Is There a File Limit? Any Recommendations? | As of now there is no limit set.
|
4 | Is It Possible to View a Summary of Rule/Rule Set in English After Saving/Modifying? | Summary in English: Many AI Rules Engines offer features to view or generate summaries of rules in human-readable formats. This typically includes descriptions or explanations of the rules, which can be in plain language (e.g., "Rule to check if policy number is an integer with 4 digits"). |
5 | Can You Copy and Paste or Upload a Definition File (PDF/Word) Containing Rules? | No, it is mandatory to create rules every time. (explicitly add fields ) |
6 | Is There a Way to Transform Excel/CSV/TXT to JSON Inside the New GUI to Generate a Definition File? | No, as of now this feature is not available. Â |
7 | Â Is It Mandatory to Select Fields from a Drop-Down and Be Literal? | Yes, ,Currently we have to select fields from drop down |
8 | When Integrating API Calls with Transaction/PF:
|
|
9 | Â Is the Data Encrypted When Passing Files to the Rules Engine? | Yes, it encrypts while passing files to the rule engine.. |
10 | Â How Long Are the Results of a Rules Execution Stored? Is This Configurable? | Results of the rule engine are temporarily stored until it is processed. currently there is no provision of configuring it. |
11 | Where Are the Logs Stored? | Logs Storage: Logs are typically stored in a database or file system designated for logging purposes. Check the documentation for details on where logs are kept. |
12 | Is There a Cleanup Job? | No, currently this is not implemented; it will be done based on client requirements. Â |
13 | Â Since We May Have to Define Rules Based on File Type and Hierarchy, How Big Can the Rules Engine Grow on Server? | Scalability: The scalability of the rules engine depends on its architecture and server resources. AI Rules Engines are designed to handle significant growth, but specific limits depend on the implementation and infrastructure. |
14 | Is It Possible to Integrate This Mapping? Can You Demo That? | Integration: Integration possibilities depend on the rules engine’s capabilities and the available APIs or connectors. A demo can be arranged with the vendor to showcase integration capabilities. |
15 | Is the AI Rules Engine a Separate Microservice or Deployed on the Same AI Map Page? Do They Share the Knowledge Base? | Deployment: The AI Rules Engine may be deployed as a separate microservice or integrated within a larger application depending on the architecture. Knowledge bases might be shared or managed separately based on system design. |
16 | Â Is the Rules GUI and Rules Defined GAC Controlled? | GAC Control: The Global Assembly Cache (GAC) control depends on the application and its configuration. If rules are implemented in .NET or similar environments, GAC control may apply. |