Table of Contents
1. AC5.X Deployment
Q: What are the prerequisites for deploying AC 5 on Azure?
A: Before deploying AC 5 on Azure, several prerequisites need to be in place:
Ensure that a Kubernetes service is already installed and configured within the Azure environment.
The backend and log databases must be set up to store application data.
Obtain the necessary Azure AKS credentials from the IT administrator to access the Azure Kubernetes Service cluster.
Set up a secure VPN connection to the Azure cluster, enabling access from your local machine.
Verify that you have administrative rights on your machine, as they are required to install necessary applications such as Azure CLI, Helm, and kubectl. If you lack these permissions, reach out to the IT team for assistance.
Q: How do I access Azure AKS credentials?
A: To access the Azure Kubernetes Service (AKS) environment, you will need specific login credentials provided by the infrastructure team:
Azure portal credentials for direct access, including a username and password.
Jumphost credentials for remote access, including a separate username, password, and IP address for secure connectivity. Make sure to securely store these credentials and use them according to company access policies for security compliance.
Q: What applications are required for AC 5 deployment?
A: The AC 5 deployment process requires three main command-line interface (CLI) tools:
Azure CLI for managing and configuring Azure resources directly from the command line.
kubectl CLI for interacting with Kubernetes clusters, deploying containerized applications, managing resources, and troubleshooting.
Helm CLI to deploy and manage Kubernetes applications through charts, simplifying complex configurations with pre-built templates. Install these applications on your local machine with administrative privileges, or request assistance from the IT team if admin rights are restricted.
Q: How can I install the Azure CLI on Windows?
A: To install Azure CLI on Windows, follow these steps:
Download the Azure CLI installer from the official Microsoft documentation page.
Run the installer and follow the on-screen instructions to complete the setup on your local machine.
Once installed, open a command prompt and verify the installation by typing az --version. This command should display the installed version of Azure CLI, confirming a successful installation.
Q: How is kubectl CLI installed on macOS?
A: To install kubectl CLI on macOS, you can use Macports, a package manager for macOS:
Update Macports by running sudo port selfupdate in the terminal.
Then, install kubectl with sudo port install kubectl.
Verify the installation by running kubectl version --client to check the installed version and ensure the installation was successful.
Q: What is Helm, and why is it necessary for AC 5?
A: Helm is a package manager designed for Kubernetes, which simplifies the deployment and management of applications within the Kubernetes environment. Using Helm, you can deploy complex applications with a single command by leveraging "charts," which are pre-configured YAML templates. For AC 5, Helm is essential because it provides a structured way to deploy and manage Kubernetes manifests, allowing for easier application updates and configurations.
Q: How do I create a Kubernetes namespace?
A: Namespaces in Kubernetes allow you to organize and manage different environments and resources efficiently. To create a namespace:
Use the command kubectl create ns <namespace name>.
Follow naming conventions by using only lowercase letters and avoiding special characters or underscores.
For example, use kubectl create ns ac5tmt to create a namespace called "ac5tmt."
Q: How can I check existing namespaces in AKS?
A: To view a list of all available namespaces in the Azure Kubernetes Service (AKS) environment, run the command kubectl get ns. This command will return the names and statuses of all namespaces, allowing you to check if the desired namespace already exists or needs to be created.
Q: How do I configure the database for AC 5?
A: Database configuration for AC 5 involves setting up a MySQL database to manage and store application data. Steps include:
Accessing the MySQL workbench and creating two databases: one for backend data and one for logging.
Creating a user with a unique username and password who has full access to both databases.
Granting this user full privileges on the databases to enable read and write access for AC 5 applications.
Q: What is the purpose of the values.yaml file in deployment?
A: The values.yaml file contains key environment configurations and database settings for the AC 5 application. It specifies parameters such as backend database URLs, usernames, and passwords. This file is crucial because it centralizes all configuration details, making it easy to manage and modify settings without editing multiple files. It also allows for environment-specific adjustments that are essential for seamless deployment.
Q: How can I set up environment variables in values.yaml?
A: To set up environment variables in values.yaml:
Open the file and locate the environment variables section.
Update fields like BACKEND_DB_USERNAME, BACKEND_DB_PASSWORD, LOG_DB_USERNAME, and others with the relevant database credentials.
Set execution parameters like EXECUTE_CLEANUP_JOB, EXECUTE_STATIC_JOB, and EXECUTE_MIGRATION_JOB to "True" as needed. These control background jobs that maintain data consistency and manage migrations within the application.
Q: How do I install Adeptia Connect using Helm?
A: To install Adeptia Connect using Helm:
Open a command prompt in the Adeptia folder where the Helm charts are stored.
Run the command helm install <release name> <helm chart path> --timeout 10m --debug -n <namespace>.
Replace placeholders with the actual release name, chart path, and namespace.
This will initiate the installation, setting up required pods and services within your Kubernetes cluster.
Q: How can I verify Adeptia Connect’s deployment status?
A: To verify the deployment, use kubectl get pods -n <namespace>. This command displays the status of each pod. Look for the "Running" status, which indicates that the services are correctly deployed. If any pods show errors or a different status, investigate the logs using kubectl logs <pod-name> -n <namespace> to troubleshoot.
Q: What is the function of Ingress in AC 5 deployment?
A: Ingress is a Kubernetes feature that allows you to expose HTTP and HTTPS routes from outside the cluster to services within it. It manages external access, routing traffic based on hostnames and paths. In AC 5, Ingress ensures that application components are accessible externally, enabling users to access the service through a secure, manageable entry point.
Q: How can I set up Ingress for AC 5?
A: To set up Ingress:
Open the ingress.yaml file in the Ingress folder and modify the namespace, hostname, and secret names.
Run kubectl create secret tls <secret name> --key="tls.key" --cert="tls.crt" --namespace <namespace> to create the required TLS secret.
Finally, apply the Ingress configuration with kubectl apply -f ingress.yaml to make the application accessible via the specified hostnames.
Q: How is the external IP for AC 5 obtained?
A: After applying the Ingress configuration, the external IP is assigned to the Ingress service, allowing external access. The MST team will link this IP with DNS records, creating a user-friendly domain name that points to the AC 5 application. This DNS binding enables users to access the application directly via a specified URL.
Q: What role does RabbitMQ play in AC 5?
A: RabbitMQ is a message broker that facilitates asynchronous communication between services. In AC 5, it enables various services to communicate through message queues, supporting event-driven processing, task queuing, and handling "Trigger Transactions" generated by certain services. This setup promotes scalability and allows services to process tasks independently.
Q: What databases are required for AC 5’s backend and log data?
A: AC 5 requires two main databases configured in MySQL:
A backend database to store essential application data.
A log database to capture and store system logs. Each database has unique credentials and URLs specified in values.yaml. Proper database configuration is crucial to ensuring data consistency and application performance.
Q: How do users interact with the AC 5 application?
A: Users access AC 5 through a browser, where they interact with the web interface. Requests from the browser go through the webapp-gateway, which routes them to backend services like the portal, web-runner, or event processor based on user actions. This architecture provides a smooth user experience while efficiently managing data flow to backend components.
Q: What are the main microservices in AC 5’s architecture?
A: AC 5’s architecture is based on a microservices model, including core services like:
Portal for user management and interface rendering.
**Web
2. Automations
1. What is an Automation in AC5 Professional?
Automation in AC5 Professional is a defined workflow used to automate data exchange processes between applications. It facilitates extracting, transforming, and loading (ETL) data, ensuring accurate and efficient data flow between a source and destination application.
2. What are the types of Automation in AC5 Professional?
There are two types of Automation:
App-to-App Automation: Involves data exchange between two business applications like QuickBooks and Xero.
IDP (Intelligent Document Processing) Automation: Processes unstructured data from file-based applications (like PDFs) before transferring it to business applications.
3. What is the difference between App-to-App and IDP Automation?
App-to-App Automation directly transfers data between two business applications. In contrast, IDP Automation extracts relevant information from unstructured data (e.g., PDFs) before sending it to the destination application.
4. Which applications can be used as source or destination in Automations?
Some supported applications include:
QuickBooks
Xero
Google Drive
Salesforce
Shopify
Microsoft SharePoint
BambooHR
Zoho CRM
HubSpot, and many others.
5. How do I create an Automation with QuickBooks in AC5?
To create an Automation using QuickBooks, follow these steps:
Navigate to the Automation menu and select "Create New."
Define QuickBooks as either the source or destination application.
Configure the necessary settings such as triggers, actions, and mapping.
Save the Automation and activate it if required.
6. What is a trigger in Automation, and how do I define one?
A trigger is an event or condition that initiates the execution of an Automation. For example, in QuickBooks, triggers like "New Account" or "New Customer" can be defined to fetch data based on specific events.
7. How do I map source and destination elements in an Automation?
In AC5 Professional, the Data Mapper allows you to create a mapping between source and destination elements by either dragging and dropping fields or using mapping expressions. You can also enable data splitting for large files.
8. What is IDP Automation, and how does it work?
IDP Automation is used to process unstructured data (e.g., PDF files) by extracting key information and converting it into a structured format like JSON. The structured data is then transferred to a destination application.
9. Can I customize data extraction in IDP Automation?
Yes, AC5 Professional allows you to customize data extraction rules for processing unstructured data, ensuring it meets your specific business requirements.
10. How can I manage an Automation once it is created?
You can manage Automations using options like:
View details
Edit configurations
Delete outdated Automation
Run Automations instantly
Activate or deactivate Automation
.11. What are the key aspects of an Automation in AC5 Professional?
The key aspects include:
Data flow management
Business process automation
System integration
Configuration of rules and settings
Monitoring and tracking
Error handling
12. What file formats are supported in IDP Automation?
AC5 Professional can handle both structured and unstructured data formats. For IDP Automation, file formats such as PDFs are supported for extracting key information and converting it into structured formats like JSON.
13. How can I configure triggers for Automation execution?
You can configure triggers either through POLLING or CRON EXPRESSION:
POLLING: Defines a time interval for checking and executing the Automation.
CRON EXPRESSION: Specifies an exact schedule for Automation execution.
14. What is a trigger condition, and how is it used?
A trigger condition filters data fetched from the source by specifying conditions, such as retrieving data within a specific date range or applying additional criteria.
15. Can Automations process data in parallel?
Yes, AC5 Professional allows parallel processing of data. You can enable it by selecting the "Parallel Processing" checkbox and defining the number of concurrent processes.
16. What is the importance of data mapping in Automations?
Data mapping ensures that data from different sources is accurately and consistently transferred or merged into a target system, maintaining data integrity and enabling seamless workflows.
17. What is the role of OAuth in QuickBooks integration?
OAuth is used for authenticating and authorizing data exchanges between QuickBooks and AC5 Professional. You must configure an OAuth Client with a callback URL to enable this.
18. How do I test the connection between AC5 Professional and QuickBooks?
After configuring QuickBooks as either the source or destination application, you can test the connectivity by clicking the "Test" button to ensure data exchanges work correctly.
19. How can I apply filters to data in Automations?
Filters can be applied based on specific criteria to control which records or data sets are fetched from the source application. Filters can be set using logical operators like AND/OR.
20. What happens if an error occurs during Automation execution?
AC5 Professional includes error handling mechanisms to log and address any issues. You can configure notifications to be sent to specific contacts when an error occurs.