Skip to main content

End to end tutorial

The end-to-end tutorial is installed as part of the Omada Connectivity SDK and shows you how to fully manage a directory with users, groups and assignments.

The directory is persisted in the SampleDirectory.xml file, which you must install, manage and configure. The file path is C:\Program Files\Omada SDK\V14.0\ tutorials\endto-end.

The end-to-end tutorial includes the configuration and code to read and write to a user, as well as a permission repository in an XML file.

All files and code are referenced in the tutorial.sln file, which you can open using Visual Studio. The tutorial itself is also located in the \end-to-end folder.

This tutorial helps you perform the following procedures:

  • Deploy and register the connectivity in Omada Identity.

    info

    The Register Connectivity utility does not work if the SDK version does not match your version of Omada Identity. You must also run the utility on the server where Omada Identity is installed. Alternatively, you must add the following registry key to the Omada Identity database:

    HKEY_LOCAL_MACHINE\SOFTWARE\Omada\Omada Enterprise\14.0\ConnStr

  • Write a .NET based query collector for the warehouse, which reads information from the SampleDirectory.xml file.

  • Write a system onboarding POST action that validates input.

  • Write a custom Queries and mappings screen.

  • Write a provisioning connector, including data model and task mappings that can update the SampleDirectory.xml file.

Overview of folders and files​

This table shows the different folders and files in this tutorial:

Name of folder or fileDescription
tutorial.slnThis file is the Visual Studio solution file.
SampleDirectory.xmlThis file contains the directory with roles, users and assignments that you want to manage.
\configurationThis folder contains references to all the files that are necessary for registering the connectivity in Omada Identity.
\collectorThe collector project is a .NET assembly project that implements a query collector for the Omada Data Warehouse and reads data from the SampleDirectory.xml file.
\connectorThe connector project is a .NET assembly that is used by the Omada Identity Provisioning Service to write to the SampleDirectory.xml file.
\postactionThe POST action project is a .NET assembly which is used by Enterprise Server during system onboarding. The POST action validates connection details.

Target system​

The tutorial provides guidance for end-to-end connectivity for a sample directory. The sample directory contains users, roles and assignments between users and roles. All entities are stored in the SampleDirectory.xml file. Initially, the content of the file is limited to a list of predetermined roles. See the following code sample:

<?xml version="1.0" encoding="utf-8"?>
<SampleDirectory xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Roles>
    <Role>
      <Action>C</Action>
      <RoleId>0001</RoleId>
      <RoleName>ROLEA</RoleName>
    </Role>
    <Role
      <Action>C</Action>
      <RoleId>0002</RoleId>
      <RoleName>ROLEB</RoleName>
    </Role>
  </Roles>
</SampleDirectory>

The default import for this project sample is set to Delta in the OnboardingConfiguration.xml file. This is reflected in the code sample.

The Action field, shown in the above sample code, is mapped from the Queries and Mappings task specified in the onboarding page. This must be completed for a delta import and should specify if the data has been deleted (D) or created/changed (C) in the source system.

Delta import can also be used in combination with the high-water mark functionality. The usage will depend on the source system.