Skip to main content

Step 1. Register connectivity and connector

To use the custom connectivity in the System onboarding process, register the connectivity in the Enterprise Server.

Omada version badge

As of Omada Identity 16.0.0, the SDK installer is no longer available. Obtain the current version of the Registration Utility from the existing connectivity packages available on Omada Community. Registration of SSIS packages is deprecated.

Usage:

Omada.SDK.RegisterConnectivity.exe -F <registrationFile.xml> -url <odataUrl> [-C <contentFolder>] [-user <user> -pwd <password>] [-token <token>]

ParameterUsage
-f (required)Specifies the full path to the registration XML file.
-c (optional)Specifies the full path to the folder where the files referenced in the registration file are located.

If you do not specify the parameter, the files are read from the same folder as the registration file.
-url (optional)Specifies the URL to the Omada Identity OData service in order to use of the OData authentication for the registration utility, for example, http://enterpriseserver/OData.
-user (optional)Specifies the username for the OData authentication of the registration utility.
-pwd (optional)Specifies the password for the OData authentication of the registration utility.
-token (optional)Specifies the security token for the OData authentication of the registration utility.
/unregister (optional)Use this parameter to remove the registered objects again.

You cannot unregister if an already registered system uses any of the registered objects.
/ignoreVersion (optional)Use this parameter to ignore the version check.

You must supply either -user/-pwd, or -token. If -url is not supplied, the utility exits with an error.

Registering connectivity in Omada Identity 15.0.x line

To register the connectivity, you must use the Register Connectivity utility. For the template collector, the registration.xml file is located in the folder C:\Program Files\Omada SDK\V15.0\tutorials\template connectivity\configuration.

info

You must perform the procedures in this tutorial in chronological order.

To register the connectivity and connector:

  1. In Windows, open the command prompt by pressing the Windows key + R. In the Run dialog box, enter cmd, and click OK.

  2. From the command prompt, navigate to C:\Program Files\Omada SDK\V15.0\tutorials\template connectivity\configuration.

  3. To perform the registration, from the configuration folder, run the following command:

    Omada.SDK.RegisterConnectivity.exe -F "C:\Program Files\OmadaSDK\V14.0\tutorials\template\configuration\Registration.xml"

The utility now registers the needed objects, and your new connectivity is ready to be used.

info

You can run the registration as many times as you want. Any subsequent attempt will just update the existing registration.