UI Overview and configuration

This section introduces the setup and configuration of the Wair Connector App, with a focus on understanding and managing the limits associated with API requests. Proper configuration ensures that the app functions smoothly, aligning with the specific requirements of the Wair API. This guide will walk through the steps necessary to configure connection details, set operational limits, and understand how these limits affect data processing. Additionally, it will cover the Wair Log Entries page, which records detailed information about each API request, providing insights for monitoring and troubleshooting the integration process.

Wair Connector Setup

Once the Wair Connector App is installed, it is important to verify that the connection details are correctly configured. To do this, navigate to the "Wair Connector Setup" page within Business Central. On this setup page, you will need to enter configuration details needed for establishing and maintaining a connection between Business Central and Wair.

Picture 1 "Wair Connector Setup" page

These details include (This information will be provided by your integration contact at Wair):

• Username: The Wair account username.

• Tenant: The tenant ID associated with the Wair account.

• Password: The password for the Wair account.

• URL: The base URL for the Wair API (more details can be found here: URL overview).

"Test Connection" is an action used to verify if the provided details are correct. It attempts to obtain an authorization token from Wair. If it fails, an error message indicates what is missing, or if the password is incorrect, it shows that the call is unauthorized. On success, it displays "Connection successful."

Limits Configuration

The limits configuration is on the "Wair Connector Setup" page, directly below the general connection information section. These settings ensure that data transmissions align with the Wair API's capacity and performance parameters.

Picture 2 Maximum number of records per API call

• Record Limit Configuration: specifies the maximum number of records that can be processed in a single API call. When the number of records to be sent exceeds this limit, the system will automatically divide the data into multiple requests.

  For instance, if there are 25,000 Sales Orders to be transmitted and the API limit is set at 10,000 records per request, the system will split the data accordingly. In this scenario, the 25,000 Sales Orders will be divided into three separate requests: the first two requests will each handle 10,000 records, while the final request will manage the remaining 5,000 records.

• Recommendations Retrieval Limit: determines the maximum number of recommendations to be retrieved in a single API call from Wair. For example, if this limit is set to 10 and there are 50 generated recommendations in Wair, it will require 5 calls to retrieve all recommendations, with each call returning 10 recommendations. The initial value for recommendations is set to 1000.

This process ensures that all records are transmitted successfully while staying within the defined API constraints. Entities that don’t have a limit setting in the Wair Connector Setup page are not limited.

There is an exception for the DELETE calls. There’s no option to set the limit for these calls as the limit for them is always 2000 characters URL per call. When the URL length exceeds this limit on URL creation the appended record key is moved to new URL.

Note: The default limits are pre-configured according to the guidelines provided in the Wair documentation. The maximum number of objects allowed per API call can be found here: Integration core principles.

Wair Log Entries

The Wair Log Entries page serves as a tracking tool within the Wair Connector App, recording detailed information about each API request made through the app. This page logs key aspects of every request, allowing for effective monitoring and troubleshooting of the integration process. Each log entry includes:

• Creation Time: The exact time when the API request was sent, helping to track the sequence of operations.

• HTTP Method: The type of request made, such as POST, DELETE, or GET.

• API URL: The endpoint URL used in the request, providing clarity on which part of the Wair API was accessed.

• Status Code: The response code returned by the Wair API, which indicates whether the request was successful or if there was an issue.

• Status Description: A brief explanation or message accompanying the status code, offering additional context on the request’s result.

• Error Indicator: Signals whether the response encountered an error, allowing quick identification of problematic requests.

The only exception to this logging is the process of obtaining the authorization token from Wair, which is not recorded on the Wair Log Entries page due to security reasons. This exclusion ensures that sensitive authentication details are not exposed, while still maintaining a focus on tracking the operations that directly impact data exchange between Business Central and Wair.

Picture 3 Wair Log Entries page

It is also possible to change the page view by clicking on the view section and selecting either to see all log entries or only those with errors.

Picture 4 Wair Log Entries page view change

Opening the log entry from the list will display the card page for that entry. On this page, the JSON Data FastTab provides access to the request and response information. Additionally, two actions are available: Download Request and Download Response.

Picture 5 Wair Log Entry Card Page

Viewing both the request and response is useful in case of an error, as it allows for the possibility of identifying what was sent and what error was received:

Picture 6 Wair Log Entry Card error example