Table of Contents
1. AC5.X Deployment
Category | Question | Answer |
Prerequisites and Setup | What are the prerequisites for deploying AC 5 on Azure? | Ensure Kubernetes service, backend and log databases, Azure AKS credentials, secure VPN connection, and admin rights are in place. |
How do I access Azure AKS credentials? | Obtain credentials from the infrastructure team, including Azure portal credentials and Jumphost credentials. | |
What applications are required for AC 5 deployment? | Azure CLI, kubectl CLI, and Helm CLI are required for managing Azure resources, Kubernetes clusters, and application deployment. | |
Installation and Configuration | How can I install the Azure CLI on Windows? | Download the installer, follow setup instructions, and verify installation with az --version. |
How is kubectl CLI installed on macOS? | Update Macports with sudo port selfupdate, install kubectl with sudo port install kubectl, and verify with kubectl version --client. | |
How do I create a Kubernetes namespace? | Use kubectl create ns <namespace name>. Example: kubectl create ns ac5tmt. Follow naming conventions. | |
How do I configure the database for AC 5? | Create two MySQL databases (backend and log), create a user, and grant full privileges. | |
How can I set up environment variables in values.yaml? | Open values.yaml, update fields like BACKEND_DB_USERNAME and BACKEND_DB_PASSWORD, and enable jobs as needed. | |
How do I install Adeptia Connect using Helm? | Navigate to Helm chart folder and run helm install <release name> <chart path> --timeout 10m --debug -n <namespace>. | |
Deployment Verification and Troubleshooting | How can I verify Adeptia Connect’s deployment status? | Use kubectl get pods -n <namespace>. If errors occur, use kubectl logs <pod-name> -n <namespace> to troubleshoot. |
What is the purpose of the values.yaml file in deployment? | Centralizes configuration details for easy management of environment-specific settings. | |
Networking and Accessibility | What is the function of Ingress in AC 5 deployment? | Ingress manages external HTTP/HTTPS access to Kubernetes services and enables secure routing of traffic. |
How can I set up Ingress for AC 5? | Modify ingress.yaml, create a TLS secret using kubectl create secret tls, and apply configuration with kubectl apply -f ingress.yaml. | |
How is the external IP for AC 5 obtained? | Assigned to the Ingress service, with DNS binding handled by the MST team for user-friendly access. | |
Key Components and Services | What is Helm, and why is it necessary for AC 5? | Helm simplifies deployment using pre-configured charts, streamlining Kubernetes manifest management. |
What role does RabbitMQ play in AC 5? | RabbitMQ facilitates asynchronous communication between services, supporting event-driven processing and task queuing. | |
What databases are required for AC 5’s backend and log data? | The backend database stores application data, and the log database captures system logs. Defined in values.yaml. | |
What are the main microservices in AC 5’s architecture? | Portal (user management), Webapp-gateway (request routing), and Event processor (managing triggers). | |
User Interaction and Operations | How do users interact with the AC 5 application? | Via a browser. Requests are routed through the web app gateway to backend services like the portal or event processor. |
How can I check existing namespaces in AKS? | Use kubectl get ns to list all namespaces and their statuses. |
2. Automations
Category | Question | Answer |
Overview and Basics | What is an Automation in AC5 Professional? | Automation is a defined workflow for automating ETL processes and ensuring efficient data flow between source and destination applications. |
What are the types of Automation in AC5? |
| |
| ||
What is the difference between App-to-App and IDP Automation? | App-to-App directly transfers data, while IDP processes unstructured data (e.g., PDFs) into structured formats before transferring. | |
Which applications can be used in Automations? | Supported apps include QuickBooks, Xero, Salesforce, Shopify, Google Drive, Zoho CRM, HubSpot, and more. | |
Creating and Configuring | How do I create an Automation with QuickBooks? | Navigate to Automation > Create New, define QuickBooks as source/destination, configure settings, save, and activate the Automation. |
What is a trigger in Automation? | A trigger is an event that starts an Automation, like "New Account" in QuickBooks. | |
How do I map source and destination elements? | Use the Data Mapper tool to drag/drop fields or apply mapping expressions; enable data splitting for large files if needed. | |
How can I configure triggers for execution? | Use POLLING for intervals or CRON EXPRESSION for exact schedules to define trigger execution timings. | |
What is a trigger condition? | A filter that retrieves data meeting specific criteria (e.g., date range or logical operators). | |
IDP Automation | What is IDP Automation, and how does it work? | Processes unstructured data (e.g., PDFs), extracts key info, converts it to structured formats (e.g., JSON), and transfers it. |
Can I customize data extraction in IDP? | Yes, you can define rules for precise data extraction based on business requirements. | |
What file formats are supported in IDP? | Formats like PDFs are supported, with extracted data converted into JSON or other structured formats. | |
Management and Operations | How can I manage an Automation? | View, edit, delete, activate/deactivate, or run Automations instantly as needed. |
What are the key aspects of Automation? | Data flow management, process automation, system integration, monitoring, configuration, and error handling. | |
Can Automations process data in parallel? | Yes, enable "Parallel Processing" and define the number of concurrent processes. | |
How can I apply filters to data? | Use logical conditions like AND/OR to filter data from the source application. | |
What happens if an error occurs? | AC5 logs errors, notifies contacts, and allows review/reprocessing of failed tasks. | |
Integration and Connectivity | What is the role of OAuth in QuickBooks integration? | OAuth provides secure authentication for data exchanges. Configure an OAuth Client with a callback URL for setup. |
How do I test the connection with QuickBooks? | After configuration, click the "Test" button to verify connectivity and resolve issues if any. |
2.1 Automation: IDP to JSON
Category | Question | Answer |
Document Processing | What types of documents can AC5 Professional process? | AC5 can process invoices, purchase orders, and receipts in PDF format. |
How does AC5 handle unstructured data in PDFs? | AC5 uses generative AI to extract key data fields (e.g., dates, amounts, customer details) from unstructured PDFs and converts them into structured JSON format. | |
Can I select specific pages of a PDF for processing? | Yes, on the IDP tab, choose Specific Pages and specify page numbers or ranges. | |
How do I specify a page range in AC5? | Use the format, e.g., "18-37" for a range or "1, 2, 7, 9" for individual pages. | |
Source Applications & Formats | What applications can I connect to with AC5 Professional? | You can connect AC5 to ERP, CRM, financial systems, Google Drive, Dropbox, and FTP servers. |
What source file formats are supported in AC5? | AC5 supports file sources such as JSON, with options for FTP, Google Drive, Dropbox, and File Upload. | |
How do I define Google Drive as the source application? | Follow the steps on the Create Automation using Google Drive page, defining Google Drive in the source application section. | |
Can I use Dropbox as the source for my automation? | Yes, you can use Dropbox by following steps in the Create Automation using Dropbox section. | |
What steps should I follow to set up FTP as the source application? | Follow the 15 steps outlined in the Create Automation using FTP page to set up FTP as the source. | |
Can AC5 be configured to process multiple types of source applications? | Yes, you can configure AC5 to use different sources like Google Drive, Dropbox, and FTP for processing. | |
JSON Layout & Data Review | How can I define a custom JSON layout in AC5? | On the Setup tab, select New JSON Layout, provide a name and description, upload a JSON file defining the desired data structure, and save it. |
Is there an option to preview the JSON data format before submission? | Yes, click Test on the JSON Layout screen to check and adjust the JSON format. | |
How can I review data before submission to the destination app? | Select Yes (Recommended) under the Review data option to verify the JSON format before submission. | |
Where can I view and update the JSON data format during execution? | Go to the Dashboard, select Executions, choose IDP, locate your automation, and update the JSON if necessary. | |
Can I apply custom validation rules to the extracted data? | Yes, you can apply validation rules by configuring them under the Data Validation Rules section. | |
What does the ‘Select CDM Source Schema’ field do? | It allows you to choose a schema for defining the JSON structure of the extracted data. | |
Can I test the automation configuration without sending data to the destination? | Yes, the Test button allows you to review the JSON data format before final submission. | |
How do I save changes after modifying JSON data during automation execution? | Click Save & Submit to execute the automation with the updated JSON. | |
Automation Setup & Execution | How do I define QuickBooks as the destination application? | Follow the steps on the Create Automation using QuickBooks page. |
Can I set Xero as the destination app? | Yes, refer to the Create Automation using Xero section for setup instructions. |
2.2 Automation: App to App
Category | Question | Answer |
Automation Basics | What is an Automation in AC5 Professional? | An Automation in AC5 Professional is a defined workflow that automates and manages data flow between applications, including extraction, transformation, and loading. |
What types of data formats can AC5 Professional handle in Automations? | It can handle both structured and unstructured data, converting unstructured data into a structured format using generative AI capabilities. | |
What are the types of Automations in AC5 Professional? | The types are App-to-App Automations, IDP (Intelligent Document Processing), and Partner-to-App Automations. | |
What is the key difference between App-to-App and IDP Automations? | App-to-App involves data exchange between business applications, while IDP processes data from a file-based application, extracting relevant information before transferring it. | |
Key Aspects of Automation | What are the key aspects of Automation in AC5? | They include data flow management, business process automation, integration, configuration, monitoring and tracking, and error handling. |
What is the role of a Trigger in Automation? | A Trigger initiates the data transfer process by fetching data from the source application. | |
What is the role of an Action in Automation? | An Action specifies the operations performed on the destination application to process the transferred data. | |
Integration and Compatibility | Can Automations in AC5 integrate with multiple applications? | Yes, they integrate seamlessly with applications like QuickBooks, Xero, Google Drive, Salesforce, Shopify, and more. |
Can Automations validate and transform data? | Yes, they can validate and transform data as part of predefined workflows. | |
Is it possible to use file-based applications as sources in Automations? | Yes, especially in IDP Automations where file-based data is processed intelligently. | |
Monitoring and Error Handling | What capabilities does AC5 offer for monitoring Automations? | It provides monitoring and tracking features to oversee data exchanges, identify issues, and ensure successful completion of processes. |
How does AC5 handle errors in Automations? | It includes mechanisms for error handling, logging issues, and addressing exceptions during data processing. | |
Business Applications | What business applications can serve as a destination in Automations? | Applications like QuickBooks, Xero, Salesforce, Zoho CRM, and ServiceNow, among others. |
Pre-built Automations | What is the benefit of using pre-built Automations? | Pre-built Automations saves time and ensures accuracy by providing predefined workflows for common use cases. |
Unstructured Data Processing | Can AC5 Automations manage unstructured data from file sources? | Yes, AC5 can process and structure unstructured data using AI before transferring it. |
What are some common use cases for IDP Automations? | IDP Automations are used for extracting information from invoices, contracts, and other file-based documents for integration into business applications. | |
Productivity and Efficiency | How does AC5 Professional ensure seamless integration between systems? | It defines data exchange and processing rules to create smooth connections between various applications and databases. |
What industries benefit from AC5 Automations? | Industries needing data exchange, integration, and process automation across applications, such as finance, retail, HR, and customer support. | |
How does AC5 enhance productivity with Automations? | By automating repetitive tasks, reducing manual errors, and ensuring efficient data handling across systems. |
2.2.1 FAQs for QuickBooks Online Integration
Category | Question | Answer |
Purpose and Overview | What is the purpose of this training document? | The document provides a structured guide for setting up OAuth credentials to integrate QuickBooks Online with applications, including creating and configuring a QuickBooks app, retrieving necessary credentials, defining OAuth scopes, and configuring Redirect URIs. |
OAuth Credentials | What credentials are required for the OAuth flow? |
|
| ||
| ||
| ||
Account and App Creation | How can I create an Intuit Developer Account? | Visit the Intuit Developer Portal, and either sign up for a new account or log in if you already have one. |
What steps are needed to create a QuickBooks Online app? | Navigate to the Intuit Developer Dashboard, click "Create an App," fill in the app details, and select QuickBooks Online and Payments as the platform. | |
Where can I find my Client ID and Client Secret after app creation? | These credentials are located on your app's details page in the Intuit Developer Portal. | |
OAuth Scopes and Configuration | What are common scopes used in QuickBooks OAuth integration? |
|
| ||
| ||
How do I configure Redirect URIs for testing? | Use a localhost URL (e.g., http://localhost:3000/callback) during development or the production URL for live apps. | |
OAuth Flow and Authentication | What is the OAuth 2.0 flow in QuickBooks? | It involves redirecting users to QuickBooks' OAuth consent screen, exchanging an authorization code for an access token, and using the token for API requests. |
How do I refresh an expired access token? | Send a POST request to the token endpoint (https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer) with your refresh token, Client ID, and Client Secret. | |
What is the URL format for the authorization request? | ||
Testing and Troubleshooting | Can I test OAuth integration without a live app? | Yes, you can use the OAuth Playground in the Intuit Developer Portal or a localhost setup for testing. |
What is the lifespan of a QuickBooks access token? | Access tokens typically expire after one hour. | |
What steps should be followed after creating OAuth credentials? | Use the credentials to request access tokens and implement API calls to QuickBooks. | |
How do I retrieve the authentication code during login? | The code is sent to a predefined email. Contact the email owner for the code. |
2.2.2 FAQs for Xero Management
Category | Question | Answer |
Overview and Purpose | What is the purpose of this training document? | The document provides guidance on using Xero, a cloud-based accounting tool, focusing on account setup, navigation, and integration with other platforms like AC5.x. |
What is Xero? | Xero is a cloud-based accounting solution that automates financial tasks, provides real-time insights, and simplifies financial management for businesses. | |
Account Setup and Configuration | How can I set up a new account in Xero? | Visit Xero's website, click "Start Free Trial," fill in your details, verify your email, and set up your organization with business details like name, country, industry type, and currency. |
How do I verify my email during Xero account setup? | After signing up, you will receive an email with a verification link. Click the link to complete verification. | |
What details are needed during Xero organization setup? | Business name, country and industry type, and currency for transactions. | |
Customization and Integration | What are custom fields in Xero, and how are they used? | Custom fields allow users to add personalized information to records like invoices, bills, and transactions for better tracking and categorization. |
How do custom fields benefit businesses in Xero? | They allow businesses to track specific details, such as project codes or client references, for tailored reporting. | |
What is the scope of integrating Xero with other applications? | Integration allows seamless data exchange for invoices, bills, and financial records, enhancing workflow automation. | |
Authentication and Security | What authentication type is used for Xero in AC5.x integration? | OAuth is the authentication type used for securely connecting Xero with other platforms. |
How do I configure Xero in AC5.x? | Provide a name for the account, select "OAuth" as the authentication type, and enter the Client ID, Client Secret, and Redirect URI obtained from the Xero Developer Portal. | |
What are the prerequisites for setting up Xero in AC5.x? | Client ID and Client Secret from the Xero Developer Portal, properly configured Redirect URI, and OAuth authentication setup. | |
Developer Portal and Access | Where is the Xero Developer Portal located? | The portal is available at Xero’s official website, under the developer section for API integrations. |
What steps are involved in creating OAuth credentials for Xero? | Register your app in the Xero Developer Portal, obtain the Client ID and Client Secret, and configure scopes and Redirect URI. | |
How secure is the data exchange using App Keys? | App Keys ensure secure authentication between Xero and third-party applications, protecting user data. | |
Testing and Validation | How can I test a Xero integration? | Use test credentials and the Redirect URI to authenticate and validate data exchange between Xero and the integrated application. |
Multiple Organizations | Can I manage multiple organizations in Xero? | Yes, Xero allows users to set up and manage multiple organizations under a single account. |
Compliance and Reporting | How does Xero help with compliance and reporting? | Xero provides automated tax reporting, real-time financial insights, and customizable fields to meet compliance needs. |
2.2.3 FAQs for FreshBooks Management
Category | Question | Answer |
Purpose and Overview | What is the primary purpose of the FreshBooks App? | The FreshBooks App helps users manage business finances efficiently by enabling invoicing, expense tracking, financial reporting, and more to save time and improve decision-making. |
What is the scope of the FreshBooks App? | The app provides mobile access to essential accounting features, enhancing productivity, streamlining financial processes, and supporting small business owners, freelancers, and accountants. | |
Account Setup and Configuration | How do I set up an account on FreshBooks? | Visit the FreshBooks website, log in to the Developer Console, create a new app, enter required details, save the app, and retrieve OAuth credentials. |
What are the OAuth credentials in FreshBooks? |
| |
| ||
Where can I locate the Client ID and Client Secret? | These credentials are found in the settings of your app in the FreshBooks Developer Console. | |
Features and Functionality | What are the main features of the FreshBooks App? |
|
| ||
| ||
How does FreshBooks help with mobile financial management? | The app provides access to financial data and tools on mobile devices, allowing users to manage invoices, expenses, and reports on the go. | |
What is the role of custom fields in FreshBooks? | Custom fields allow the personalization of data in invoices, expenses, and reports to meet specific business needs. | |
Integration and Security | What are App Keys, and how are they used in FreshBooks? | App Keys authenticate and authorize third-party apps to access FreshBooks data securely. |
What is the role of OAuth in FreshBooks integration? | OAuth provides secure authentication for connecting FreshBooks with third-party apps and systems like AC5.x. | |
Configuration in AC5.x | How do I configure FreshBooks in AC5.x? | Add the FreshBooks account, configure OAuth details, including Client ID and Client Secret. |
What are the authentication types supported in FreshBooks? | FreshBooks supports OAuth authentication for secure access and data exchange. | |
Management and Productivity | What are some typical entities managed in FreshBooks? | Entities include invoices, expenses, time entries, and reports, with specific allowed operations for each. |
How can FreshBooks enhance productivity for businesses? | By automating financial tasks, providing real-time data access, and offering flexible tools for managing finances from any location. | |
Developer Console and Security | What is the importance of the FreshBooks Developer Console? | It allows users to create apps, manage credentials, and configure integrations for enhanced functionality. |
How secure is data managed through FreshBooks? | FreshBooks employs OAuth credentials and secure authentication methods to ensure data protection. | |
Account and Data Management | What details are required for account creation in FreshBooks? |
|
| ||
Integration with Other Tools | Can FreshBooks be integrated with other tools? | Yes, FreshBooks can integrate with platforms like AC5.x through OAuth configuration and API keys. |
Financial Reporting | What is the purpose of financial reporting in FreshBooks? | To provide users with insights into their financial health, enabling better planning and decision-making. |
3. Marketplace
Category | Question | Answer |
Marketplace Overview | What is the Marketplace? | The Marketplace is a central hub where users can access and install pre-built Automations tailored to their needs. It streamlines integration by offering ready-made solutions. |
Tabs and Navigation | What tabs are available on the Marketplace? | The available tabs are: |
| ||
| ||
| ||
| ||
App Connectors | What are App Connectors? | App Connectors display a list of business applications. Selecting an app leads to the "All Automations" tab where pre-built Automations using that app can be viewed. |
Document Processing (IDP) | What types of documents can be processed using the Marketplace's Document (IDP) feature? | The Document (IDP) tab processes documents like: |
| ||
| ||
| ||
| ||
| ||
Using Pre-built Automations | How do I use a pre-built Automation? |
|
| ||
| ||
| ||
Document Type Selection | What happens after I select a document type from the Document (IDP) tab? | After selecting a document type (e.g., Purchase Orders), you are taken to "All Automations" where pre-built Automations process the unstructured file and write structured data to the destination application. |
All Automations | What is the 'All Automations' tab? | The "All Automations" tab displays all pre-built Automations available on the Marketplace, providing easy access for installation. |
Configuration of Automations | How do I configure an installed Automation? | After installing a pre-built Automation, configure it according to specific needs. Refer to the "Create Automation" section in the documentation for detailed instructions. |
Exploring Automations | Can I use multiple tabs to explore Automations? | Yes, you can explore Automations across multiple tabs (Partner Network, App Connectors, Document (IDP), All Automations) to find solutions suited to different needs. |
Business Applications | What types of business applications are available in App Connectors? | The App Connectors tab displays business applications like QuickBooks, which can be integrated into pre-built Automations available in the Marketplace. |
4. Connectors
Category | Question | Answer |
App Connectors Overview | What are app connectors? | App connectors are specialized software components that facilitate communication and data exchange between different applications or systems, enhancing efficiency and automating tasks. |
Functionality of App Connectors | How do app connectors function in Adeptia Connect? | App connectors use triggers and actions to interact with applications. A trigger initiates workflows or actions at the source, and an action performs the operation in the target application. |
Authentication Methods | What authentication methods do app connectors use in Adeptia Connect? | App connectors use token-based, OAuth, API key, and other secure authentication processes based on the application. |
Custom App Connectors | Can I create custom app connectors in Adeptia Connect? | Yes, you can create custom app connectors using an Open API Specifications (OAS) based YAML file to connect to applications that do not have pre-built connectors. |
CDATA Connectors | What is a CDATA custom connector? | A CDATA custom connector is a JDBC-based connector that allows data exchange with specific applications like NetSuite, SAP, or Salesforce. |
How can I add a custom CDATA connector in Adeptia Connect? | To add a custom CDATA connector, configure it within the platform using JDBC protocols and application details. | |
Pre-built vs. Custom Connectors | What is the difference between pre-built and custom connectors in Adeptia Connect? | Pre-built connectors are designed for popular applications, while custom connectors are built using specifications like OAS for applications not covered by pre-built connectors. |
Advantages of App Connectors | What are the key advantages of using app connectors? | App connectors streamline workflows, automate tasks, improve data flow, reduce complexity, and enable efficient communication between systems. |
Applications for Integration | What types of applications can I connect to using app connectors in Adeptia Connect? | You can connect to CRM systems, ERP platforms, financial tools like Salesforce, NetSuite, SAP, QuickBooks, and more. Custom connectors can be created for other applications. |
Business Use Cases | What are the main use cases for app connectors in a business environment? | Use cases include automating data exchange, integrating CRM, ERP, and marketing platforms, improving data accuracy, and enabling real-time communication between business tools. |