Packaging Connectors

Getting Started

The XMPro Package Manager is a Windows 11 desktop application that enables you to package a new Connector or update details for an existing Connector. See the Connector article for more information on Connectors.

This application takes you through the process of specifying all the properties your Connector requires, adding or changing the controls for each user setting, and uploading the DLL files of the Connector code. It will provide you, upon completion, with a file that can be uploaded to Application Designer after which you can use the Connector in App Pages.

You can download the software from the Microsoft Windows 10 Store or clicking here.

After installing the XMPro Package Manager, launch the application from the Microsoft Store or search for “XMPro Package Manager” in the Start menu and then click on “XMPro Package Manager”.

New / Import

On the first screen of the application, you can either create a new Connector package or import and update an existing one.

Details

The Details form allows you to specify or edit the properties of a Connector. These properties are listed and explained below.

Name

The name of the Connector is what the Connector will be known as once it is uploaded to the Application Designer platform, for example, “SQL Connector”.

Description

The description is a brief explanation of what the Connector does, for example, “This Connector allows you to read/update a SQL Database table“.

Version

The version of the Connector. Any real number is acceptable, for example, "1.02".

Entry Point

The entry point is the namespace and class name of the actual Connector’s DLL file.

For example, if a Connector with the class name “Connector” is located in the XMPro.AzureSQLConnectors namespace, the Entry Endpoint for it would be “XMPro.AzureSQLConnectors.Connector”.

Icon File

The icon used to represent your Connector. Click the Browse button, navigate to where you’ve stored the file via the Explorer and select the new image file.

References

The References form is where you upload the file(s) required for the Connector to execute. Only files in the Selected File(s) list will be included in the package, and any DLLs must be created in .NET.

To upload a file, click the Browse button next to the DLL File(s) field and navigate to where the files are located. Select all the files needed and click the Add button to add them to the Selected File(s) list.

To remove a file from the list, click the Delete button next to the file name in the Selected File(s) list.

Settings

Depending on what your Connector does, it might require that the user provide certain information, such as a server URL, username, or password. For each of these information fields (or settings), you need to specify which control should be used and what each control represents, for example, the SQL Connector will require the user to add a server URL. The user should provide this value using a text-box control. Thus, you need to create a control with a type of “TextBox” and a caption that reads “Server URL” in the XMPro Package Manager application.

The following controls are available to be used to capture user input:

Each control has several properties that have to be set and not all properties apply to all controls. For example, options apply to a drop-down control and not a text-box control.

The table below contains a list of all the available properties, their description, and to which controls they are applicable.

Adding Settings

Settings are grouped logically into one or more groups, such as authentication, criteria, and output.

Create a group first, then add controls for settings to the group. To do this, follow the steps below:

1. Click on the plus-icon (top right, next to the Settings header). A form section will open, allowing you to specify a group for the settings.

2. Specify a unique value that can be used as the key for the group.

3. Add the caption you would like to use.

4. Click Save.

5. Next, we are going to add a setting. Click on the plus-icon next to the group you’ve created.

6. Choose the type of control you would like to use.

7. Add a unique key for your control. Please note that this key needs to correspond to what you defined in your code.

8. Add a caption for your control.

9. If needed, add a default value.

10. If required, add help text.

11. Select the options that apply from the list of check-boxes.

12. Click Save.

Output

Export as JSON file

Tick the checkbox Export as JSON file too? if you would like to export the file as JSON too. It will later be saved to the same directory as the XMP file with the file name category_name_version.json.

Include Multilingual Support

Tick the checkbox Include Multilingual Support? if you would like to add support for languages other than English. Uncheck languages you don't want to include.

This feature leverages generative AI to provide language translation. It is available only if the following requirements are met:

• You are connected to the internet.

• Open AI is configured (Click here for instructions on how to do so).

Configure OpenAI API

1. Click Configure OpenAI.

2. A form will open for you to add or modify the OpenAI Endpoint and Api Key.

3. Click Save.

Review: Details

Lastly, you can navigate back through the steps to review the details that you’ve specified. If you are satisfied, complete the wizard by clicking the Save button below before navigating to the folder where you would like the package to be exported. Your package will be created with the file name category_name_version.xmp.

Further Reading

• How to upload your new Connector to Application Designer