Adapters
Last updated
Last updated
Definition
An adapter is a module (compiled as a DLL) that provides a custom connection with its communication route to integrate the CMW Platform with external systems.
Loaded modules are compiled on the server side, and corresponding connections become available when creating connections and communication routes. You can then use the adapter communication routes in your application to exchange data with external systems.
On the Administration page, select Infrastructure → Adapters.
The adapter list opens.
If you delete an adapter, connections and communication routes generated for the adapter will be deactivated and stop working.
Open the adapter list.
Click Create or double-click an adapter in the list.
The adapter properties page opens.
Upload a ZIP archive with the adapter source code in the Adapter source code field. The archive must contain the Visual Studio solution:
Solution file (.sln) in the archive's root folder.
Project with the adapter source code.
Projects containing the interfaces for the development and compilation of the adapter.
Any additional projects needed for the adapter, e.g., a localization project.
Folder with the necessary libraries.
Save the adapter.
Publish the adapter to compile it.
Upon successful compilation, the adapter name appears in the adapter list and on the adapter properties page.
An item for the compiled adapter appears in the Create — Custom connections menu on the Connections and Communication routes page.
After compilation, view the compilation log.
To use the adapter, create a connection and communication routes for it.
If the adapter was used after publishing, download and view the execution log.
After you publish the adapter and use its connection and communication routes, you can download the adaptor execution log from its properties pages.
Open the adapter list.
Open an adapter by double-clicking it.
Click Get execution log to download the adapter execution log archive (for example, CBAP.adapters.20221026.logs.zip).
Unpack and view the log.
An item for the compiled adapter appears in the Create — Custom connections menu on the Connections and Communication routes page.
Create and configure a connection for your adapter.
Create and configure a communication route using your adapter connection.
Use the communication route in your application to communicate with external systems.
