> For the complete documentation index, see [llms.txt](https://arterm-sedov.gitbook.io/low-code-platform-help-excerpt/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://arterm-sedov.gitbook.io/low-code-platform-help-excerpt/adapters.md).

# Adapters

{% hint style="success" %}
**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.
{% endhint %}

## Use the Adapter List

1. On the **Administration** page, select **Infrastructure** → **Adapters**.
2. The adapter list opens.
3. Perform the following operations:
   * **Open** — double-click an adapter row to [configure ](#configure-an-adapter)the existing adapter.
   * **Create** — [configure](#configure-an-adapter) a new adapter.
   * **Delete** — select a checkbox in the first column for an adapter and click **Delete.** Confirm the adapter deletion.

{% hint style="danger" %}
If you **delete an adapter**, connections and communication routes generated for the adapter will be deactivated and stop working.
{% endhint %}

<figure><img src="https://89063707-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWSaevLNGSmww5pgsOsNF%2Fuploads%2FvWb86arRhfENCtumeJ98%2Fimage.png?alt=media&amp;token=8adecf03-72c8-4a25-b789-6ae4f35526e0" alt="Adapter list"><figcaption><p>Adapter list</p></figcaption></figure>

## Configure an Adapter

1. Open the [adapter list](#use-the-adapter-list).
2. Click **Create** or double-click an adapter in the list.
3. The adapter properties page opens.

   <figure><img src="https://89063707-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWSaevLNGSmww5pgsOsNF%2Fuploads%2F0gkBO73dqVrUrSvxRCnw%2Fadapter_properties?alt=media" alt="Adapter properties page"><figcaption><p>Adapter properties page</p></figcaption></figure>
4. 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.

   <figure><img src="https://89063707-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWSaevLNGSmww5pgsOsNF%2Fuploads%2Fz1BXmx6Ui2SMyy6gJUnF%2Fadapter_archive_content?alt=media" alt="Adapter source code archive contents example"><figcaption><p>Adapter source code archive contents example</p></figcaption></figure>
5. **Save** the adapter.
6. **Publish** the adapter to compile it.
7. Upon successful compilation, the adapter name appears in the adapter list and on the adapter properties page.
8. An item for the compiled adapter appears in the **Create** — **Custom connections** menu on the **Connections** and **Communication routes** page.
9. After compilation, view the **compilation log**.
10. To [use the adapter](#use-the-adapter), create a connection and communication routes for it.
11. If the adapter was used after publishing, download and view the [execution log](#viewing-the-adapter-execution-log).

## View the Adapter 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.

1. Open the [adapter list](#use-the-adapter-list).
2. Open an adapter by double-clicking it.
3. Click **Get execution log** to download the adapter execution log archive (for example, *CBAP.adapters.20221026.logs.zip*).
4. Unpack and view the log.

   <figure><img src="https://89063707-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWSaevLNGSmww5pgsOsNF%2Fuploads%2Ffdpo3SV5ES0ALf7X4sJl%2Fadapter_execution_log?alt=media" alt="Adapter execution log example"><figcaption><p>Adapter execution log example</p></figcaption></figure>

## Use the Adapter

An item for the compiled adapter appears in the **Create** — **Custom connections** menu on the **Connections** and **Communication routes** page.

1. Create and configure a connection for your adapter.
2. Create and configure a communication route using your adapter connection.
3. Use the communication route in your application to communicate with external systems.

<figure><img src="https://89063707-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWSaevLNGSmww5pgsOsNF%2Fuploads%2Fij1SQO9uTErWExZkAX1a%2F2023-07-16_00h52_56.png?alt=media&amp;token=81c15a1f-107b-4fde-88ba-5f1cf7277f36" alt="Creating a connection using a custom adapter"><figcaption><p>Creating a connection using a custom adapter</p></figcaption></figure>

<figure><img src="https://89063707-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWSaevLNGSmww5pgsOsNF%2Fuploads%2FxruTl3uKaJIw3H8uOtDz%2F2023-07-16_00h53_39.png?alt=media&amp;token=99d7c2a2-915b-4269-9b73-5be8971d0531" alt="Creating a communication route using a custom adapter"><figcaption><p>Creating a communication route using a custom adapter</p></figcaption></figure>