Skip to main content
Version: Cloud

Connectivity package export

The connectivity package export feature allows to create and export a custom connectivity package that is a representation of an already onboarded system. This package then can be used as a template for a new collector, and if available, a template for a new connector.

The connectivity package export can be created for systems using one of the following template collectors:

  • REST
  • LDAP
  • OData
  • SCIM
  • SOAP

Creating an export is also available for systems utilizing connectors from different technologies and if provisioning is not configured.

The exported connectivity package works with the RegisterConnectivity tool in the Omada Software Developers Kit (SDK) by utilizing the Registration.xml file.

Export scope​

Various scope of data is exported depending if it's a collector or connector. Security related information are excluded from the export and sharing user sensitive data is limited.

Data exported for the collector

  • Connection details:

By default secureStringType properties are excluded from the export and configured settings values are exported as defaultValues.

  • Default data:

Attributes, Attribute Sets, Resource types are part of the exported configuration and will get created on another environment when the exported template collector is used for the onboarding of a new system.

note

The default data contains resource types for which at least one resource with reference to the system exists.

  • Queries and Mappings
  • Account rules

Data exported for the connector

  • Connection details: If the connector is based on a template connector REST, LDAP, OData, SCIM, SOAP, the configured settings values are exported as defaultValues.

  • Data model:

  • Task mappings:

Only task mappings that are related to resource types are exported.

Exported package composition and naming convention​

The export procedure results in download of a compressed file with a following name pattern:

Example

Custom.Connectivity.{TechnologyName}.{PackageName}.zip

The connectivity package is composed of the following files that are accessible after unpacking:

  • Registration.xml
  • {PackageName} Onboarding configuration.xml
  • A collector onboarding file

If the connector is also configured, the following files are available:

  • {PackageName} Connector configuration.xml
  • {PackageName} Connector Data Model.xml
  • {PackageName} Connector default.xml
  • Task mappings files with name pattern {Resource Type}_{TargetObjectType}.xml

Performing export​

To use the connectivity package export perform the following steps:

  1. In the Omada Identity go to Setup > Master Data > System.
  2. Open an onboarded system that you want to export.
  3. Expand the ellipsis menu with additional options and choose the Export Connectivity Package option.
  4. In the opened dialog box specify which settings values to override, depending on data sensitivity and used technology, and confirm with the OK button.

::: note The data is changed only in the export, leaving the source system onboarding configuration unchanged. :::

  1. In the Specify for export dialog box provide the Package name name and click the OK button to confirm.

Postrequisites​

The generated connectivity package doesn't contain the custom reference properties, since import function does not allow to create them.

Therefore, during exporting connectivity package it is necessary to provide information on which custom reference properties are used and how to create them.

The required information are:

  • Property name
  • Property system name
  • Reference data object type
  • Multi-value or single-value
example

CUSTOMREFERENCEPROPERTY, C_CUSTOMREFPROP, Data object type: Identities, SV-REF

note

To properly use connectivity package for onboarding of a new system, it is required to firstly create manually provided custom reference properties.