Defining a Custom Target System Template

This chapter describes how to set up a custom target system template that can be used later on to create multiple instances of this target system type.

About this Use Case

This use case is a natural extension of the previous one. After definition of a new target system template you can create a set of target system instances.

We explain three methods for target system template creation:

  • Use an already existing instance of a target system (the main use case). The advantage of this method is that you can model and especially test a custom target system instance thoroughly before you use it as a new template.

  • Customize one of the built-in target system templates (an alternate configuration proposal).

  • Copy one of the existing custom target system templates (an alternate configuration proposal).

Typically you will use this case when modeling a more common target system type that is not supported by DirX Identity but shall exist in multiple instances within the company.

Compatibility

If you have already used the folder cn=TargetSystems,cn=Customer Extensions,cn=Configuration,cn=domain check if there are TargetSytem Type specific object descriptions. If yes you have to move these definitions to another folder (for example: "cn=TargetSystemDefinitions,cn=Customer Extensions,cn=Configuration,cn=domain") and adjust all the imports referencing these object description. Otherwise you may run in problems like the one described in MZQLRZ: Incorrect Object descriptor nach DXI8.2B Update.

Documentation Hints

The documentation hints of the previous use case are also valid for this one. Read the appropriate chapter above.

Specific Hints and Guidelines

Use a built-in generic type target system to create a single instance of a custom target system.

Regard the following hints and guidelines when you configure you custom target system template:

  • A good starting point is to use the target system instances that you created in the previous use case.

  • Your new target system template should use two levels of target system object descriptions if possible. For more information see the "Specific Hints and Guidelines" section of the previous use case.

  • Use a three level object description hierarchy for your target system template only when you want to customize an existing built-in target system template of other type than generic. In such a case the target system type (dxrType) should be unchanged. This is the preferred method when you plan common customization of a larger number of target system instances of a supported type. Assume for example that you need more specialized target system instances of an ADS or JDBC type. In such a case a new target system template of a known type may be prepared and then simply be reused.

  • Target system templates stored in cn=TargetSystems,cn=Customer Extensions,cn=Configuration,cn=domain are based on common target system instances. They use the same object descriptions and folders. They should never be used directly while implementing a corresponding connectivity workflow. The group and account objects within a target system template do not trigger any real time events for provisioning workflows.

  • The custom target system template should use a unique customer specific name. That name is used by the target system wizard.

Setup and Configuration

Set up of a custom target system template while reusing an existing target system instance requires you to perform the following steps:

  • Prepare a target system instance

  • Create your custom target system template

  • Use your custom target system template

Prepare a Target System Instance

Perform these steps:

  • Login into the Provisioning configuration.

  • Select the Target Systems view

  • Prepare a new or existing target system instance. Later on you can use this instance as basis for your custom target system template.

Note that you can use the target system instance that you generated based on the built-in generic target system type in the previous use case.

Any existing target system instance can be used as a target system template. Be sure that the selected one is correctly configured and then continue with the next step.

Create Your Custom Target System Template

Simply copy a well prepared target system instance to create your custom target system template.

All templates must be stored in the folder:

cn=TargetSystems,cn=Customer Extensions,cn=Configuration,cn=domain

Otherwise the target system wizard is not able to locate them.

Copying the Target System Instance

Perform these steps:

  • Select an existing target system instance in the Target Systems view that you want to reuse.

  • Select Copy (Ctrl+C) from the context menu.

  • Click the Domain Configuration view.

  • Navigate to
    cn=TargetSystems,cn=Customer Extensions,cn=Configuration,cn=domain

  • Select Paste (Ctrl+V) from the context menu.

The result is a complete copy of your target system instance.

Configure the Target System Template

All target system templates must contain the following folder:

Configuration – this folder contains all configuration objects that are relevant for this type of target system. Read the product documentation for details. During creation of a target system instance, the entire content of this folder is copied to the instance.

Dependent on the method to store accounts and groups you have to options:

  • Accounts and groups are stored in separate folders that are named Accounts and Groups.

  • Accounts and groups are stored in a common folder that is named Accounts and Groups.

While creating a new target system instance with the target system wizard you can select the method via the flag Accounts and groups in common subtree. Because the target system wizard requires for full functionality all three containers to exist, create the missing ones:

  • Use New → Account Container from the context menu to create a missing Accounts folder (its type is dxrTSAccountContainer).

  • Use New → Groups Container from the context menu to create a missing Groups folder (its type is dxrTSGroupContainer).

  • Use New → Account-Group Container from the context menu to create a missing Accounts and Groups folder (its type is dxrTSAccountGroupContainer).

The target system wizard checks the presence of these containers and may disable the option Accounts and groups in common subtree according to the existing containers.

Note that the target system template should only contain objects that should be copied to each target system instance that is created from this template. Remove all unnecessary objects, for example all accounts and groups and leave only the objects that shall belong to the template. If you need additional objects in the template, create or copy them now.

The target system templates can be also renamed, use common context menu for this purpose.

Use Your Custom Target System Template

If the custom target system template is correctly configured, you can use it to create new target system instances. Perform these steps:

  • Click the Target Systems view.

  • Select a target system container or a cluster and start the target system wizard.

  • In the Target System Selection step you should see all built-in templates as well as your new custom target system type.

  • Select your new type and fill all necessary tabs and fields to complete the target system creation.

Your new target system instance is created.

Alternative or Extended Configurations

There are more possibilities to create custom target system templates. Create it with the target system wizard directly from built-in types or copy an already existing custom target system template.

We recommend using the method we described above, creating a template from an instance. The big advantage is that you can configure and test the instance completely, especially the connectivity workflows (this is subject of the next chapter).

Creating the Custom Target System Template Using a Built-in Template

Perform these steps:

  • Login into the Provisioning configuration.

  • Select the Domain Configuration view.

  • Navigate to
    cn=TargetSystems,cn=Customer Extensions,cn=Configuration,cn=domain.

  • Select New → Target System from the context menu. A list containing all built-in templates is displayed. Select one of them and the system will create a target system template including the corresponding connectivity workflows if selected.

  • Perform Reload Object Descriptors.

  • Add the missing Accounts, Groups or Accounts and Groups folders.

Note that the list does not contain any custom target system templates. Only built-in types can be used this way.

Customize the created template to get your custom target system template.

Creating the Custom Target System Template Using a Custom Template

Perform these steps:

  • Login into the Provisioning configuration.

  • Select the Domain Configuration view.

  • Navigate to
    cn=TargetSystems,cn=Customer Extensions,cn=Configuration,cn=domain.

  • Select one of the existing custom target system templates and choose Copy Object from the context menu. Do not forget to change the name before you click OK.

  • Perform Reload Object Descriptors.

Customize the copied template to get your new custom target system template.