Skip to Content

Adapters

Definitions

An adapter is a module (compiled as a DLL) that provides custom connection and communication route to integrate the Platform with external systems

Use the Adapters section to load and compile custom modules to connect the Comindware Business Application Platform to external systems.

Loaded modules are compiled on the server side, and corresponding connections become available when creating connections and communication routes.

Viewing the adapter list

  1. Select Adapters in the AdministrationInfrastructure section.

Adapters item on the Administration page

Adapters item on the Administration page

  1. You will see the adapter list on the Adapters page.

Adapter list

Adapter list

Creating an adapter

  1. Open the adapter list.
  2. Click Create.
  3. The adapter properties page opens.

Adapter properties page

Adapter properties page

  1. Upload a ZIP archive with the adapter source code in the Adapter source code field. The archive must contain the Visual Studio solution:
    • Project with adapter source code.
    • Projects containing the interfaces for the development and subsequent compilation of the adapter.
    • Necessary additional projects for the adapter, for example, a localization project.
    • Folder with the connected libraries.
    • Single solution file (.sln) in the archive's root folder.

Adapter source code archive contents example

Adapter source code archive contents example

  1. Click Save.
  2. Click Publish button to compile the adapter.
  3. Upon successful compilation, the adapter name will be displayed in the adapter list and adapter properties.
  4. After compilation, view the compilation log.

Compilation log example

Compilation log example

  1. To download the archive with adapter execution logs (for example, CBAP.adapters.20221026.logs.zip), click Get execution log.

Adapter execution log example

Adapter execution log example

  1. The connection item for the compiled adapter will be displayed in the Custom connections submenu when creating a connection or communication route.

Creating a connection using a custom adapter

Creating a connection using a custom adapter

Creating a communication route using a custom adapter

Creating a communication route using a custom adapter

Adapter setup

  1. Open the adapter list.
  2. Double-click the adapter row.
  3. The adapter property page will be displayed.
  4. Configure the adapter similarly to creating it.
    • Upload the new source code archive.
    • Save the adapter.
    • Publish the adapter
  5. If necessary view the compilation log or download the execution log.

Deleting an adapter

Attention! Connections and communication routes generated for the deleted adapter will be deactivated and stop working.

  1. Open the adapter list.
  2. Select the adapter to be deleted using the checkbox in the first column.
  3. Click Delete.
  4. In the confirmation window, click Delete.

Adapter delete confirmation

Adapter delete confirmation

Back to top