Custom connectors

About custom connectors

You can use custom connectors to call functions from an application to perform a custom task.

Customer connectors are written in c#, and you can use them to do almost virtually any task. Mobile Enterprise Platform includes functionality that allows you to create custom integrations that require no customization of platform itself. Developers can use the following platform dlls when building a custom connector.

DSI.Connector.dll
DSI.Configuration.dll
DSI.BaseInterface.dll

These dlls provide the functionality the custom connector needs, such as the base class and interface.

Build a custom connector

Developers can use DSI.Connector.dll, DSI.Configuration.dll, and DSI.BaseInterface.dll to build a custom connector.

To build a custom connector, complete the following steps in a development tool, such as MS Visual Studio.

In a visual development tool, create a project.
In the preamble of the project, declare the use of the following files in your application.
1. DSI.Connector.dll
2. DSI.Configuration.dll
3. DSI.BaseInterface.dll

Define your functions as shown below.

Step Information

<Functions>  <Function id="DummyFunction" description="MEP Dummy Function Call" required="false" >   <Parameter id="Parameter1" direction="Both" type="JCHAR" length="255" />   </Function>   </Functions>

Compile your project.

Postrequisite: Deploy a custom connector

Deploy a custom connector

After a custom connector is built and compiled, you must install it into all application servers in a platform installation in order for the server to execute custom functions. These steps must be completed for all applications, support services, and cloud gateway servers in an installation.

Prerequisite: Before a custom connector can be deployed, it must be built and compiled. Refer to Build a custom connector.

To deploy a custom connector, complete the following steps in each application server.

Login to the application server's operating system as the windows service account user.
Locate the installation folder for your Mobile Enterprise Platform installation.

Step Information

Note:This will typically be located in C:\Program Files\DSI\MEP\<installname>.
In this installation folder, create a new folder called CustomConnectors.

Step Information

Note:The folder must be named exactly as shown, CustomConnectors. This requirement is case sensitive.
Copy the following .dll files from the installation folder.
1. DSI.Connector.dll
2. DSI.Configuration.dll
3. DSI.BaseInterface.dll
Paste the .dll files in the CustomConnectors folder, along with your custom .dll.

Step Information

Note:In some cases, an .XML file is used to hold the input/output parameter information used by DSI Platform Manager. If this is the case, this file will be located in the CustomConnectors folder.

Postrequisite: Register custom connector functions.

Register custom connector functions

Registering functions provides access to the functions to be called in apps. A function can be registered any time, but it must be registered before creating an app that uses that function.

Prerequisites:

To register a function to a custom connector, complete the following steps in Advanced Inventory Platform Manager.

Go to Develop > Connectors.
Select your custom connector.

Step Information

Note:If your custom connector does not display here, it was not successfully built or copied to the installation folder.
If your system uses more than one environment, select your desired environment.
On the Registered Functions page, select Register New Function(s).
Select Select all to select all functions or just select specific functions.

Step Information

Note:You can clear all selections and start over by selecting Select none.
Select Next.
On the Select Functions to Register page, select the functions to register.
Select Finish.

Expected Result

Result: A confirmation page displays the names of the functions as they are registered.
When all functions are registered, select Done.

Postrequisite: After a function is registered, it can be tested using the Test tool for that function on the Registered Functions page. Refer to Test functions.

There was a problem loading this topic