The section below describes how to install the collana pay app in Business Central.
We support the current BC version on a regular basis and also the two previous versions of the current version.
Admin authorizations in both Business Central and Azure (Azure Active Directory) are required for the installation.
1. Open the Extension Marketplace page via the search function in Business Central.
2. In the search field, enter collana pay and carry out the installation process.
3. Finally, accept the terms of use and click on Install.
The installation may take a few minutes. Once the installation is completed, you can use the three dots to check whether the installation was successful. If the Install option is grayed out, the installation was successful.
Webservices
For the integration of collana pay with Business Central, certain endpoints must be set up for notifications to be received by Business Central and used for communication with the collana pay API. To ensure that these notifications can be processed successfully, it is important that the collana pay web services are accessible via the Internet.
During the installation of the collana pay app, two code units or web services are automatically created and published. If the web service has not yet been published, this can be done in the Web services section. To publish the PAY Receive Notification HVE web service, the check mark can be set in the Publish column.
Another web service Pay Receive SOAP Notification HVE is available. It is not required for the installation of collana pay for Business Central SaaS. This web service is used in the on-premise version instead. The web service fulfills the same function and also receives notifications from collana pay. The difference is that it uses an older format that is still compatible with Business Central OnPrem.
Microsoft Entra ID - App registrations
Microsoft Entra ID provides network access management and protects against unauthorized access. To ensure the security of access, configurations are required within Microsoft Entra ID. An app registration is required for this.
To enable access via the Internet, the collana pay Business Central app must be registered in the Microsoft Entra ID (www.portal.azure.com).
When the app is registered, the following IDs are created, which are important for configuration at a later date:
The URLs for the endpoints can be accessed in the Endpoints menu item.
The next step is to configure the platform.
The copied link is pasted into the marked area and the configuration is performed. The following URL must be entered for authentication:
https://businesscentral.dynamics.com/OAuthLanding.htm
In the following case, OAuth2 authentication is set up. Authentication takes place in the following steps:
- When a specific URL is accessed, a login is required.
- After successful login, the user is redirected to an authorized area, which in this case is Business Central.
Client Secret
The next step is to create a client secret. This is required to access the Business Central app. A value is generated during the creation process, which subsequently needs to be entered in the collana pay Admin Portal (COPAL).
As soon as the client secret has been created, it is visible in the overview. The Expires field contains a date that represents the expiration date. This expiration date cannot be extended. Instead, the client secret must be renewed regularly. When the secret expires, collana pay will no longer be able to deliver messages. In Microsoft systems, it is common for passwords to be changed regularly and there is no way to disable this requirement. You should therefore keep an eye on the expiration date and update your password in COPAL as soon as it has expired.
The Value field contains a generated password. This password is essential to access the Business Central app.
Warning! After the value has been generated, the password must be copied in order to store it in the collana pay Admin Portal. It is no longer possible to copy the password at a later time because it is no longer displayed.
API Permissions
In this step, the API authorization is performed by selecting the access to the Business Central app. This determines which information collana pay is allowed to retrieve by registering in the respective tenant.
It is important to ensure that application permissions are selected when selecting the permission, as communication should only occur through the API and no other access permissions should be granted.
Permission can be granted via Grant admin permission. If the authorization does not work, it is due to the current user's authorization.
The app registration has been successfully configured to access certain facilities. Successful registration is indicated by a green check mark and the notification message has been removed.
The next step is the setup to authorize collana pay to access the Business Central callback web service.
Here you will find further instructions.