Manage Connectors

Connectors allow you to connect to third-party sources of data. Examples of these Data Sources include databases, Data Streams, or Recommendations, which can be integrated into the Application and are needed if you want to display any real-time or context data to the user on a Page of an Application.

It is recommended that you read the article listed below to improve your understanding of Connectors.

• Connector

Creating Connectors

Creating a Connector can be divided into two parts:

Writing the code for a Connector

Connectors are generally written in C# as library projects that make use of the XMPro.Integration.Framework NuGet package.

XMPro.Integration.Framework requires your project to be written using a predefined structure. This structure requires you to implement certain interfaces.

To learn more about how to use this framework, refer to these instructions.

Code for some Connectors has been made available on GitHub. It might be useful to use these resources as an example when writing your own Connectors.

Packaging the Connector

After writing your code, you need to use the XMPro Package Manager Windows 10 desktop application to package your Connector.

This application allows you to specify all the properties your Connector requires, add the user settings in the form of controls, and allows you to upload the DLL of the Connector you’ve written. Finally, it will create a file with a “.xmp” extension, which you can upload to App Designer and start to use to build Applications.

To package the Connector, refer to these instructions.

Adding a Connector

Connectors can be added via the Connectors page before being used in any of the Applications.

1. Click on the Connectors page from the left-hand menu.

2. Click on Add.

3. Upload the xmp file of the Connector.

4. The unique ID, name, version, and description are re-filled based on details from the file uploaded.

5. Add the category.

6. Click on Save.

Selecting an existing Connector opens the configuration panel where details for the Connector can be viewed. The category can also be changed here.

Deleting Connectors

Connectors can be removed via the Connectors page. To remove Connectors:

1. Open the Connectors page from the left-hand menu.

2. Click Select.

3. Select the Connectors that you would like to remove.

4. Click Delete.

5. Confirm that you would like to delete the Connectors selected.

Versions of a Connector

When a new version of a Connector is added, the Connector will be updated to the new version. The old version will remain and Applications using the old version of the Connector will continue to use that version until it is upgraded manually.

1. Open the Connectors page from the left-hand menu.

2. Select a Connector to view its information.

3. Each version is shown along with the number of Applications still using that version.

4. Select the version to view the complete list of Applications still using that version.

Users with DeleteConnector rights and Admins see the usage count for all Applications, whereas other users see the usage count of Applications to which they have access.

Categories

Connectors can be organized into categories. These categories are separate from the App and Data Stream Categories.

1. Click on the Connectors page from the left-hand menu.

2. Click on Manage Categories.

3. The list of existing categories is shown.

4. Click on Add.

5. Name the category. 6. Click on Add.

Categories for Connectors can also be edited or removed. To edit or remove a category for Connectors, select the category from the list of existing categories to enable the edit and remove options.

Finding Help for Connectors

Help documentation is available for every Connector. These pages provide context, configuration definitions, an example, and release notes to help if you are unsure of anything related to the Connector you are configuring.

See the Integrations article for the list of Connector documentation links.