Universal Adapter


The Universal Adapter allows you to add any application connector dynamically. ConnectALL has defined a standard request and response format for the synchronization process.

Supported Functionalities

(tick) Sync Fields

(tick) Sync Custom Fields

(tick) Sync Comments (Only for ConnectALL Provided API)

(tick) Sync Attachments (Only for ConnectALL Provided API)

(error) Sync Issue Linking

ConnectALL's Universal Adapter supports two very different approaches to integrating with applications. In one approach, the Universal Adapter is in control of the polling and queries an API provided by the other application. In the other approach, the other application is in control of the polling and queries an API provided by ConnectALL.

External Application Provided APIThis approach is suitable when the application you want to integrate with provides a ReST API that ConnectALL can use to query/poll for changes to objects/entities, to read records/objects/entities from the other application, to put new records to the application, and to put changes to records back to the application. To adopt this approach, you can specify the application's API and data transformations in the ConnectALL configuration screen. Once configured, ConnectALL will poll the other application using that application's ReST API.

ConnectALL Provided APIConnectALL has exposed a set of Rest APIs that other applications or scripts can use to query (poll) for modified records, to retrieve modified records, to put new records, and to post modifications to the destination application. Whenever your application or script uses ConnectALL's APIs, ConnectALL will then respond by managing the synchronization or data retrieval with the mapped application.

In either case, the configuration of a Universal Adapter begins with the configuration of the adapter descriptor that we discuss below.

Creating Universal Adapter

You can create a universal adapter through the ConnectALL UI. To do this:

  1. Click the cogwheel icon on the top right corner of the navigation bar and click Universal Adapters from the drop-down menu.
  2. Click Create Adapter. The Create New Adapter screen will be displayed.
  3. Enter a name, application type, and select an API Provider(from the drop-down list). Note that the application type you enter here should be the same value that is in your license.
  4. Click Proceed. The screen displays all the fields that you need to configure in an adapter.
  5. Click against the fields to enter the values. For the MetaData field, click Configure and enter the details (datatype) in the Artifact Edit dialog box.

    Note that, in the version 2.10.9 and above,

    • A datatype drop-down list is displayed in the Artifact Edit dialog box, from which you can choose a datatype.
    • For the ID, Title, and Modified Date Fields, you will be able to add the fields directly. To do so, click against a field, enter the field name and click Add to Fields. The datatype of those fields will be automatically displayed in the Artifact Edit window. 
  6. Click Save Configuration. You will be able to save only if you have finished configuring the mandatory fields (displayed in red).

Once you save, the Universal Adapters page will be displayed and it will display the adapter that you have created. You could click the  icon against Active to activate the adapter you created.


Date Format

When you create a Universal adapter, the Query Date Format is one of the fields in which you have to choose a date format. The option that is selected here will be the format that is supported by that application for which you are creating the Universal Adapter. Some adapters accept only the Unix Epoch format. To support such adapters, starting from version 2.10.24, ConnectALL provides the option to select a Unix Epoch format (can be ‘Millis’ or ‘Seconds’) for date format. The Unix Epoch format that your application supports can be chosen from the drop-down list options as shown below.


By default, the DATE_TIME_FORMAT option is selected. If your adapter supports only Unix Epoch timestamp format, please choose either MILLIS_SINCE_UNIX_EPOCH or SECS_SINCE_UNIX_EPOCH depending on what your application supports. If your application supports only the DATE_TIME_FORMAT, and not a Unix Epoch format, select the option DATE_TIME_FORMAT and enter the date and time in the adjacent field that will appear. For example, if you are creating a Universal Adapter for Jira that supports only the DATE_TIME_FORMAT, do not choose the displayed Unix Epoch formats. If you choose an option different from the one that is supported by the application (in this case, Jira), it will not be possible for ConnectALL to read the records from Jira, and that will result in synchronization errors.


Import Universal Adapter

ConnectALL allows you to import an adapter configuration that will have all the basic information required by ConnectALL. To import:

  1. Click the cogwheel icon on the top right corner of the navigation bar and click Universal Adapters from the drop-down menu.
  2. Click Import Adapters Configuration. The local drives from your computer will be displayed. 
  3. Select the adapter configuration file and click Open. The newly imported adapter configuration will be displayed on the Universal Adapters page. 
  4. Configure all the required fields and click Save Configuration. You will not be able to save the configuration unless you configure all the required fields.

The imported adapter configuration is automatically activated. Use the Configure link displayed against the API Configuration field for further configuration. It is explained here


Note: The error ‘Missing required information to save’ is displayed when trying to import a universal adapter configuration file when there is a mismatch in the datatypes.

If you encounter this message, click OK and proceed. Click the Configure link against ‘Fields’. In the Artifact Edit screen, you will notice that the DATATYPE drop-down fields will display Select Type for some IDs. Select the appropriate data type for the IDs and click Save. The configuration will be successfully saved.


Export Universal Adapter

You can export a universal adapter by using the icon on the top right corner of the adapter descriptor section. Note that the export option allows you to export an API along with its spec. 

           

If you are using ConnectALL version 2.10.9 and above, use the edit and export configuration buttons that are available at the end of an adapter descriptor section. Use the downward arrow displayed on top right side corner of the panel to expand and see the full panel. When you expand, all the descriptor fields along with the edit and export configuration buttons will be displayed.

Editing Adapter Descriptor 

  1. Click  on the adapter descriptor (top right corner) to enable the edit mode.
  2. Once the edit icon is clicked, the adapter will be in edit mode with the save and cancel icons in the upper right corner.



  3. Click on any of the properties to edit the configuration.
  4. To edit the values for the fields like metadata, fields, and login option, click on the configure link, and edit the values from the popup.
  5. Once all the values are configured, click  to save the configuration.

The application link can be configured similarly to the other adapters. Please find the reference in Setup (Map Applications). The metadata and fields will be loaded from the adapter descriptor that you uploaded.

API Authentication

ConnectALL uses the API KEY authentication for synchronization.

Generate an API Key

A ConnectALL system admin or a Group admin is the only user who can generate an API Key.  Note that a non-admin user cannot generate an API Key.  The API Key management feature is available in the 'User Management' page of ConnectALL UI from where you can generate an API Key.

  • In the above screen, click Generate to generate an API Key. You can copy the displayed key.
  • After you generate the key, View and Deactivate buttons appear replacing the Generate button. You can view the generated key or if required, deactivate it.

Time Difference Configuration

To know how to calculate the time difference, and configure it in the ConnectALL UI,  read the topic Time Difference Configuration.