Set up AIP connection
The AIP Connection Setup page is used to configure the general and tenant information to connect Business Central with the appropriate AIP product. It also allows defining subscriptions for inbound events to automatically receive data updates.
-
Select the Search icon
, enter AIP Connection Setup, and then choose the related link.
The AIP Connection Setup page opens. -
On the General FastTab, in the Base URL, IAM URL, Client ID, and Client Secret fields, enter the credentials.
-
On the Tenant Information FastTab, in the API Product ID and API Tenant ID fields, enter the credentials.
To know your credentials, please contact the Aptean support team.
These configurations ensure that the integration with external systems is correctly established. -
On the Advanced Settings FastTab, in the Support Email field, enter a valid email address where notifications related to AIP integration will be sent.
-
Turn on the Notify on Review toggle to receive an email notification when an event is waiting to be processed.
-
Turn on the Notify on Error toggle to receive an email notification if an event is stopped due to an error.
-
In the Maximum Number of Requests field, enter the value that defines the maximum number of allowed requests. The default value is set to 100.
-
In the Retry Attempts field, enter the number of retry attempts to be made if an event fails to process. The default value is set to 2.
-
On the action bar, select the action to perform the respective function:
Action Description Load Data Load all the AIP products, AIP product events, consumers and custom consumers. Publishing Event Setup Load all the AIP product events. Using this setup, you can map an export event in Business Central to its corresponding definition type, ensuring its creation on the AIP Events page with that type. Consuming Events Setup Load all the AIP consumer events. Using this setup, you can map an inbound event in Business Central to its corresponding event type, enabling its import with that type. Product View all the AIP products along with its associated event information. Translation View the AIP translation values for the available AIP products. Events View the AIP events created from different sources, their status, and subscriptions. Process Events Process inbound, outbound or both events based on the Type field value selected in the AIP Process Events dialog. The process includes three operations based on the selected type:
Outbound: Prepares the data (payload) before sending it to an external system and then transfers it.
Inbound: Retrieves events from external systems, transfers them to Business Central, and processes the data after it is available in the event list.
Both: Combines inbound and outbound processing to handle selected events in one step.Set Up Job Queue Entry Automate the outbound and inbound event processing. This configuration allows events to be processed based on a predefined schedule, ensuring a streamlined flow for event handling. Audit Log View the errors that occurred while processing the AIP events.
Details on the AIP products
The AIP Products page displays all the available products and the event subscription information for each product.
- Select the Search icon
, enter AIP Products, and then choose the related link.
Alternatively, you can open the AIP Products page from the AIP Connection Setup page by selecting the Product action.
The AIP Products page opens. - Enter the required information in the following fields:
Field Description Id Specify the AIP ID associated with the product. Name Specify the name of the product. Event Subscribed Specify the number of events subscribed to the AIP product. Available Event Specify the total number of available events. Disabled Specify if the product is disabled for event subscription.
On the action bar, select Load Product Events to load the events associated with the selected AIP product.
The Product Events action displays the details of the available event. On selecting this action, the AIP Product Events page opens.
The Consumer Events action displays the details of the subscribed events. On selecting this action, the AIP Consumer Events page opens, displaying the subscribed events that can be processed based on the configuration.