Skip to main content

Configuration and general information

Information, procedures, and tips applicable to all collectors​

The following section provides configuration details and procedures that you can use for all connectors deployed in your environment.

tip

If a resource type is used in multiple systems (and you are changing it), ensure that you commit settings in all affected systems.

Configuration (on-prem only)​

Connectivity package installation (on-prem only)​

Connectivity packages are part of the Omada.Connectivity.StandardCollectors and Omada.Connectivity.StandardConnectors packages. To install a connectivity package in your installation of Omada Identity:

  1. Download the latest connectivity package from Omada Community.

  2. Extract the contents of the downloaded .zip files to a folder (for example: C:\Users\administrator\Downloads\).

  3. Run the cmd (command line) as the administrator.

  4. Navigate to the folder where you extracted the package and to the Registration Utility folder within (for example: C:\Users\administrator\Downloads\RegistrationUtility).

  5. Register the connectivity package using the Register Connectivity tool supplied with the package.

  6. Go one folder up (to **C:\Users\administrator\Downloads\Omada.Connectivity.**name.<version>.XX) and run the command:

    powershell . ./deploy.ps1
    note

    The deploy.ps1 script copies binaries to the appropriate places. It starts and stops services, if necessary, for example OPS and ES Timer Services. It is necessary to run the script on all servers hosting ES, ODW or OPS.

  7. Run the Enterprise Server and go to Setup > Administration > Connectivity > Packages. Check if the installed connectivity package is on the package list.

Registering the Connectivity package (on-prem only)​

You can register the connectivity package using Omada Identity OData API. Using the integrated authentication, run the following command:

Omada.SDK.RegisterConnectivity.exe -F "C:\Users\administrator\Downloads\Omada.Connectivity.<name>.<version>.<XX>\Artifacts\Registration\Registration.xml" -url "https://<url>/OData"

where:

  • C:\Users\administrator\Downloads is changed to the actual location where you extracted the Connectivity package
  • name is the name of the downloaded Connectivity package
  • XX is the actual version of the downloaded Connectivity package
  • url is the actual URL to your Omada Identity OData API endpoint
tip

When using a configuration-only node environment, temporarily disable RequireChangeSet in customer settings before running the registration, then re-enable it afterwards.

If you are a Data Administrator, you can perform the registration in the context of another user. To do so, run the following command:

 Omada.SDK.RegisterConnectivity.exe -F "C:\Users\administrator\Downloads\Omada.Connectivity.<name>.<version>.<XX>\Artifacts\Registration\Registration.xml" -url "https://<url>/OData" -user "<user>" -pwd "<password>"

where:

  • C:\Users\administrator\Downloads is changed to the actual location where you extracted the Connectivity package
  • name is the name of the downloaded Connectivity package
  • XX is the actual version of the downloaded Connectivity package
  • url is the actual URL to your Omada Identity OData API endpoint
  • user is your actual administrator username
  • password is your actual password

Register a new system​

  1. In Systems view, click New to register a new system.
  2. Enter the name of the new system in the Name field of the pop-up screen.
  3. Enter the unique system ID in the System ID field.
  4. From the Category dropdown, select New.
  5. Select the relevant Connectivity radio button.
  6. In the Content field, select the type of data that you want to import from and provision to the system.

Extensions.GetValue and Extensions.SidToHex functions​

Omada version badge Supported versions

If you use the expression mapping type, you can utilize the following functions:

  • Extensions.GetValue(value, defaultValue) - returns the value (if provided) or defaultValue (if the value is null).
  • Extensions.SidToHex(value) - converts a SID string to the hexadecimal representation.

Offboarding (removing) an existing system​

Offboarding a system removes it from active use in Omada Identity. Resource assignments, role references, and provisioning are retired instead of being left behind as orphaned configuration. To remove a system, choose one of the following options depending on your scenario:

  1. Live systems (data has already been imported) - by setting the system's Status to Removed.
  2. System with no imported data - by deleting them without any additional actions.

Live systems offboarding​

Prerequisites:

The Status change to Removed is rejected with the The system cannot be removed message until you meet the following conditions:

  • Content is set to Access Rights. Systems whose Content is Identity or Both Identity and Access Rights cannot be removed this way, since they are still relied on as a source of identity data. If the system to offboard also serves as an identity source, plan and execute that migration separately (moving identity data ownership to another source) before attempting to remove it, or change the system's Content to Access Rights first, and only proceed once you've confirmed the system is no longer needed for identity data.
  • No other onboarded system trusts this system. Check the Trusts section on every other system's general settings. If any of them lists the system you are offboarding, remove that trust reference first.
  • The system is not the built-in OIS system. The internal Omada Identity System can never be removed.

Once you resolve the prerequisites described above:

  1. Go to Setup > Systems > All systems and open the system to offboard.
  2. Disable provisioning. Under Enable provisioning, set Method for accounts and Method for assignments to None.
  3. In the system's general settings, set Status to Removed.
  4. Click Save. A confirmation dialog summarizes the impact: When a system is removed, its resources will be permanently removed from all places they are referred, including assignment policies, constraints and roles. Also, all provisioning tasks (OPS and manual) will be terminated.

Once the Status change is saved, Omada Identity performs the following cleanup for the system:

  • Any queued OPS provisioning jobs for the system are archived.
  • The system's own Trusts references are cleared.
  • The system's resources are removed from any assignment policies, constraints (role combinations), and parent roles that reference them as child roles. If a parent role in the Role category is left with no child resources at all (across every system), its own resource assignments are expired.
  • All resource assignments for the system's resources are expired.
  • Any outstanding manual provisioning tasks for the system are terminated.

Systems with no imported data offboarding​

Deletion is permitted when no data has been imported yet:

  1. Go to Setup > Systems > All systems.
  2. Locate the system you want to remove. Click the ellipsis (three dots) and click Delete.
  3. Confirm the deletion.