OneIM DB2DatabasesConnector UserGuide
OneIM DB2DatabasesConnector UserGuide
One Identity Manager Generic Database Connector User Guide for Connecting DB2 (LUW) Databases
Updated - 19 September 2022, 12:01
For the most recent documents and product information, see One Identity Manager documentation.
Contents
Troubleshooting 34
Help for analyzing synchronization issues 34
About us 35
Contacting us 36
Index 38
With this generic database connector, you can synchronize external databases with the
One Identity Manager database. One Identity Manager supports connecting to DB2 (LUW)
databases, amongst others. Only databases for the operating systems Linux, UNIX, and
Windows can be synchronized.
The generic database connector cannot load any random external database system data
configuration. For example, custom data types and columns containing value list are not
currently supported.
The generic database connection does not provide a project template for setting up
synchronization. You must create synchronization configuration components (such as
mappings, workflows or start up configurations) manually after the synchronization project
has been saved.
In the Synchronization Editor, external database tables and columns are referenced as
schema types and schema properties.
1. Install and configure a synchronization server and declare the server as a Job server
in One Identity Manager.
2. Provide One Identity Manager users with the required permissions for setting up
synchronization and post-processing synchronization objects.
3. Create a synchronization project with the Synchronization Editor.
In the case of One Identity Manager tools non role-based login, it is sufficient to add a
system user in the DPR_EditRights_Methods and QBM_LaunchPad permissions
groups. For more information about system users and permissions groups, see the One
Identity Manager Authorization and Authentication Guide.
User Tasks
One Identity Manager One Identity Manager administrator and administrative system
administrators users Administrative system users are not added to application
roles.
One Identity Manager administrators:
l Create customized permissions groups for application
roles for role-based login to administration tools in the
Designer as required.
l Create system users and permissions groups for non role-
based login to administration tools in the Designer as
required.
l Enable or disable additional configuration parameters in
the Designer as required.
l Create custom processes in the Designer as required.
l Create and configure schedules as required.
Table 2: User and permissions groups for role-based login: Mapped as custom
target system
User Tasks
One Identity Manager One Identity Manager administrator and administrative system
administrators users Administrative system users are not added to application
roles.
One Identity Manager administrators:
l Create customized permissions groups for application
roles for role-based login to administration tools in the
Designer as required.
l Create system users and permissions groups for non role-
based login to administration tools in the Designer as
required.
l Enable or disable additional configuration parameters in
the Designer as required.
l Create custom processes in the Designer as required.
l Create and configure schedules as required.
Table 3: User and permissions groups for role-based login: Default table
mapping
User Tasks
One Identity Manager One Identity Manager administrator and administrative system
administrators users Administrative system users are not added to application
roles.
One Identity Manager administrators:
l Create customized permissions groups for application
roles for role-based login to administration tools in the
Designer as required.
l Create system users and permissions groups for non role-
based login to administration tools in the Designer as
required.
l Enable or disable additional configuration parameters in
the Designer as required.
l Create custom processes in the Designer as required.
l Create and configure schedules as required.
User Tasks
One Identity Manager One Identity Manager administrator and administrative system
administrators users Administrative system users are not added to application
roles.
One Identity Manager administrators:
l Create customized permissions groups for application
roles for role-based login to administration tools in the
Designer as required.
l Create system users and permissions groups for non role-
based login to administration tools in the Designer as
required.
l Enable or disable additional configuration parameters in
the Designer as required.
l Create custom processes in the Designer as required.
l Create and configure schedules as required.
1. In the Manager, select the default application role to use to edit the objects you want
to synchronization.
l Establish the application role's default permissions group.
If you want to import employee data, for example, select the Identity
Management | Employees | Administrators application role. The default
permissions group of this application role is vi_4_PERSONADMIN.
2. In the Designer, create a new permissions group .
l Set the Only use for role based authentication option.
3. Make the new permissions group dependent on the vi_4_SYNCPROJECT_ADMIN
permissions group.
Then the vi_4_SYNCPROJECT_ADMIN permissions groups must be assigned as
the parent permissions group. This means that the new permissions group inherits
the properties.
4. Make the new permissions group dependent on the default permissions group of the
selected default application role.
Then the default permissions groups must be assigned as the parent permissions
group. This means that the new permissions group inherits the properties.
5. Save the changes.
6. In the Manager, create a new application role.
1. In the Designer, create a new permissions group for custom tables that are populated
by synchronization.
l Set the Only use for role based authentication option.
2. Guarantee this permissions group all the required permissions to the custom tables.
3. Create another permissions group for synchronization.
l Set the Only use for role based authentication option.
4. Make the permissions group for synchronization dependent on the permissions group
for custom tables.
Then the permissions group for custom tables must be assigned as the parent
permissions group. This means the permissions groups for synchronization inherits
its properties.
5. Make the permissions group for synchronization dependent on the vi_4_
SYNCPROJECT_ADMIN permissions group.
Then the vi_4_SYNCPROJECT_ADMIN permissions groups must be assigned as
the parent permissions group. This means the permissions groups for
synchronization inherits its properties.
6. Save the changes.
7. In the Manager, create a new application role.
a. Assign the Custom | Managers application role as the parent application role.
b. Assign the permissions group for the synchronization.
8. Assign employees to this application role.
9. Save the changes.
For more information about setting up application roles and permissions groups, see the
One Identity Manager Authorization and Authentication Guide.
The synchronization server must be declared as a Job server in One Identity Manager.
Use the One Identity Manager Service to install the Server Installer. The program runs the
following steps:
l Sets up a Job server.
l Specifies machine roles and server function for the Job server.
l Remotely installs One Identity Manager Service components corresponding to the
machine roles.
l Configures the One Identity Manager Service.
l Starts the One Identity Manager Service.
NOTE: The program performs a remote installation of the One Identity Manager Service.
Local installation of the service is not possible with this program.
To remotely install the One Identity Manager Service, you must have an
administrative workstation on which the One Identity Manager components are
installed. For more information about installing a workstation, see the One Identity
Manager Installation Guide.
NOTE: To generate processes for the Job server, you need the provider, connection
parameters, and the authentication data. By default, this information is determined from
the database connection data. If the Job server runs through an application server, you
must configure extra connection data in the Designer. For more information about setting
up Job servers, see the One Identity Manager Configuration Guide.
2. On the Database connection page, enter the valid connection credentials for the
One Identity Manager database.
3. On the Server properties page, specify the server on which you want to install the
One Identity Manager Service.
a. Select a Job server from the Server menu.
- OR -
To create a new Job server, click Add.
b. Enter the following data for the Job server.
l Server: Name of the Job server.
l Queue: Name of the queue to handle the process steps. Each Job server
within the network must have a unique queue identifier. The process
Data Explanation
Synchronization All One Identity Manager Service actions are run against the
server target system environment on the synchronization server. Data
entries required for synchronization and administration with the
One Identity Manager database are processed by the
synchronization server.
Installed components:
l One Identity Manager Service (started)
server Manager must load the data from the target system. One
Identity Manager communicates directly with the target system
to do this. Sometimes direct access from the workstation, on
which the Synchronization Editor is installed, is not possible. For
example, because of the firewall configuration or the workstation
does not fulfill the necessary hardware and software
requirements. If direct access is not possible from the
workstation, you can set up a remote connection.
The remote connection server and the workstation must be in
the same Active Directory domain.
Remote connection server configuration:
l One Identity Manager Service is started
l RemoteConnectPlugin is installed
l ADO.NET provider for DB2 (LUW) is installed
Base object You cannot normally specify a base object for synchronizing with
database connectors. In this case, assignment of one base table
and the synchronization server is sufficient.
l Select the table from the Base table menu in which to
load the objects. The base table can be used to defined
downstream processes for synchronization. For more
information about downstream processes, see the One
Identity Manager Target System Synchronization
Reference Guide.
l The Synchronization servers menu displays all Job
Variable set If you implement specialized variable sets, ensure that the start
up configuration and the base object use the same variable set.
2. Add mappings. Define property mapping rules and object matching rules.
3. Create synchronization workflows.
4. Create a start up configuration.
5. Define the synchronization scope.
6. Specify the base object of the synchronization.
7. Specify the extent of the synchronization log.
8. Run a consistency check.
9. Activate the synchronization project.
10. Save the new synchronization project in the database.
If you run the project wizard in expert mode or directly from the Synchronization Editor,
additional configuration settings can be made. Follow the project wizard instructions
through these steps.
1. Start the Launchpad and log in on the One Identity Manager database.
NOTE: If synchronization is run by an application server, connect the database
through the application server.
3. On the System access page, specify how One Identity Manager can access the
target system.
l If access is possible from the workstation on which you started the
Synchronization Editor, do not change any settings.
l If access is not possible from the workstation on which you started the
Synchronization Editor, you can set up a remote connection.
Enable the Connect using remote connection server option and select the
server to be used for the connection under Job server.
l Click Next to start the system connection wizard to create a connection to an
external database.
4. On the Select database system page, select the database system to which you
want to connect.
l Select DB2 (LUW).
5. Configure the system connection.
For more information, see Connecting a system to a DB2 (LUW) database on
page 17.
6. On the Save configuration page, you can save the current configuration as a
template. When you reconnect to a database system of the same type, you can use
this configuration as a template.
l Click and enter the name and repository of the configuration file.
7. You can save the connection data on the last page of the system connection wizard.
l Set the Save connection locally option to save the connection data. This can
be reused when you set up other synchronization projects.
l Click Finish, to end the system connection wizard and return to the
project wizard.
8. On the One Identity Manager Connection tab, test the data for connecting to the
One Identity Manager database. The data is loaded from the connected database.
Reenter the password.
NOTE:
l If you use an unencrypted One Identity Manager database and have not yet
saved any synchronization projects to the database, you need to enter all
10. On the Select project template page, select a project template to use for setting
up the synchronization configuration.
NOTE: The generic database connector does not provide a default project template
for setting up synchronization. If you have created your own project template, you
can select it to configure the synchronization project. Otherwise, select Create
blank project.
11. Enter the general setting for the synchronization project under General.
Property Description
Script Language in which the scripts for this synchronization project are
language written.
Scripts are implemented at various points in the synchronization
configuration. Specify the script language when you set up an
empty project.
IMPORTANT: You cannot change the script language once the
synchronization project has been saved.
If you use a project template, the template's script language is
used.
Data Explanation
Server Name of the server on which the database server is installed. The fully
qualified server name or the IP address may be given.
User User account and password used by the generic database connector to log
account in to the external database. Make a user account available with sufficient
and permissions.
password
1. On the Database connection page, enter the connection parameters. Enter all the
parameters required by the generic database connector to create a connection with
the selected database system.
l To enter additional system-specific information about the system connection,
click Advanced.
The database system connection is tested the moment you click Next.
2. On the Describe the database page, enter a display name and a unique identifier
for the database connection.
l Database display name: Display name of the database for displaying in the
One Identity Manager tools.
l System identifier: Unique system identifier.
IMPORTANT: The system identifier of the database must be unique. These
identifiers help to differentiate between the databases. To prevent incorrect
behavior and loss of data ensure that the system identifiers are unique within
the One Identity Manager environment.
l Identifiers may not be defined more than once.
l Identifiers must not be changed after the connection is saved.
l System category: Category for further differentiation of system types. A
maximum of 16 characters, consisting of numbers and letters, are permitted
for the identifier.
Connections with the generic database connector are usually stored with the
DB system type. The system category allows one more classification into
subtypes. This allows different database connections with differing content to
be distinguished from one another.
Example:
Connection 1: type=DB, subtype=Rights
Connection 2: type=DB, subtype=PersonImport
3. On the Load configuration page, you can enter a file from which the connection
configuration can be loaded. This data is used in subsequent steps in the connection
wizard and can be modified there.
6. On the Select partial schemas page, you can reduce the database schema by
selecting partial schemas. If the database contains several schema, specify here,
which schemas are loaded into the synchronization project.
l In the Partial schemas/owner list, enable the schemas you want to
be processed.
7. The database schema is loaded on the Schema detection page. during which One
Identity Manager tries to identify a known schema.
l If a One Identity Manager schema is detected, the Fill in system description
completely option is displayed. If you only want allow read-only access to the
database, you can deactivate this option.
If the schema is loaded successfully, the next step in the sequence can be
carried out.
8. On the Extend key information page, specify columns for each table to be used as
unique keys for identifying objects.
NOTE:
l This page is only displayed if the schema of the external database there are
tables with no identifiable unique keys.
l Tables without unique keys are not used in the synchronization configuration.
Property Description
Column group Button for editing column groups. Create a column group, if a
unique key can only be made of a combination of more than one
column.
l To create a column group, click Add.
l To edit or remove an existing column group, click Edit or
remove.
Property Description
Key name Column group identifier. Permitted characters are letters and under-
score. A virtual schema property is formed from the column group
called vrtColumnGroup<column group>.
Columns Columns included in the column group. Mark all the columns that
together make up the unique key.
NOTE: Columns of type Char are not supported.
9. On the Define data relations page, you can enter information about object
relations.
Property Description
Target(s) Columns to which the reference refers. Enter the table and column
name in the following syntax:
<schema>.]<table name>.<column name>
If a reference points to several column, enter the targets in a
comma delimited list. The target columns must be labeled as key
columns.
TIP: You can copy the column name of a referenced column
using the Copy fully qualified column names item in the
context menu and add this as a target.
Referential Specifies whether the referential integrity of the data in the target
integrity table has been tested.
enabled
10. On the Complete schema page, you can enter additional schema information.
Property Description
Preferred key Specifies whether the column is primarily used for object identi-
fication. A preferred key can defined, if a table has more than one
unique key. Only columns with the String data type can be
selected.
Revision Specifies whether the column contains the revision counter. The
counter data in this column form the comparison value for revision
filtering.
Sort criteria Specifies whether the value in this column maps the path in an
for hierarchies object hierarchy. If this table’s objects are sorted by this column, it
results in a list sorted in hierarchical order. This makes it possible
to resolve object dependencies. Only one column per table can be
marked as a sort criterion. An example is the CanonicalName
column.
Scope Specifies whether the column can be used to form the reference
reference scope. Only one column per schema type can be labeled as the
reference scope.
Auto fill Specifies whether the values entered in the column are identified
behavior automatically.
Property Description
Property Description
12. The Extend target system schema page opens if you enable the Fill in system
description completely option on the Load schema page or make settings on the
Define data operations page. You can add virtual schema properties to the target
system schema here. Use the virtual schema properties to provide additional data for
your own DML handling.
Property Description
Schema Tables in the target system schema for which virtual schema
properties can be added or exist already.
Related topics
l Creating a synchronization project on page 15
Updating schemas
All the schema data (schema types and schema properties) of the target system schema
and the One Identity Manager schema are available when you are editing a synchronization
project. Only a part of this data is really needed for configuring synchronization. If a
synchronization project is finished, the schema is compressed to remove unnecessary data
from the synchronization project. This can speed up the loading of the synchronization
project. Deleted schema data can be added to the synchronization configuration again at a
later point.
If the target system schema or the One Identity Manager schema has changed, these
changes must also be added to the synchronization configuration. Then the changes can be
added to the schema property mapping.
To include schema data that have been deleted through compression and schema
modifications in the synchronization project, update each schema in the synchronization
project. This may be necessary if:
l A schema was changed by:
l Changes to a target system schema
l Customizations to the One Identity Manager schema
l A One Identity Manager update migration
l A schema in the synchronization project was shrunk by:
l Enabling the synchronization project
To edit a mapping
Starting synchronization
Synchronization is started using scheduled process plans. A scheduled process plan is
added once a start up configuration is assigned to a schedule. Use schedules to define
running times for synchronization.
NOTE: Synchronization can only be started if the synchronization project is enabled.
To run synchronization regularly, configure, and activate the a schedule. You can also start
synchronization manually if there is no active schedule.
IMPORTANT: As long as a synchronization process is running, you must not start another
synchronization process for the same target system. This especially applies, if the same
synchronization objects would be processed.
l If another synchronization process is started with the same start up configuration,
the process is stopped and is assigned Frozen status. An error message is written
to the One Identity Manager Service log file.
l Ensure that start up configurations that are used in start up sequences are
not started individually at the same time. Assign start up sequences and start
If you want to specify the order in which target systems are synchronized, use the start up
sequence to run synchronization. In a start up sequence, you can combine start up
configurations from different synchronization projects and specify the order in which they
are run. For more information about start up sequences, see the One Identity Manager
Target System Synchronization Reference Guide.
Analyzing synchronization
Synchronization results are summarized in the synchronization log. You can specify the
extent of the synchronization log for each system connection individually. One Identity
Manager provides several reports in which the synchronization results are organized under
different criteria.
This means, all memberships and assignments remain intact until the outstanding objects
have been processed.
Start target system synchronization to do this.
Related topics
l Post-processing outstanding objects on page 29
l Users and permissions for synchronizing on page 5
1. In the Manager, select the Data Synchronization > Basic configuration data >
Target system types category.
2. Click in the result list.
3. Edit the target system type main data.
4. Save the changes.
Property Description
Display Name of the target system type as displayed in One Identity Manager
name tools.
Cross- Specifies how user accounts are assigned to or inherit groups and system
boundary entitlements if they belong to different custom target systems.
inheritance
l If the option is set, groups and system entitlements can be assigned
to user accounts that belong to the same target system or to
different target systems. The target systems must have the same
target system type.
For all target systems of a target system type, the settings for the
User Account Contains Memberships column
(UNSRootB.UserContainsGroupList) must be identical.
l If the option is not set, groups and system entitlements can only be
assigned to the same target system.
NOTE: If the option is not set, the target system type is used to simplify
grouping of the target systems.
Show in Specifies whether the target system type for compliance rule wizard can
compliance be selected when rule conditions are being set up.
rule wizard
Text snippet Text snippets used for linking text in the compliance rule wizard.
Alternative List of connector that can process this type of target system.
connectors
1. In the Manager, select the Data Synchronization > Basic configuration data >
Target system types category.
2. In the result list, select the target system type.
3. Select the Assign synchronization tables task.
4. In the pane, assign custom tables to the outstanding objects you want to handle.
5. Save the changes.
6. Select the Configure tables for publishing task.
7. Select the tables that contain the outstanding objects that can be published in the
target system and set the Publishable option.
8. Save the changes.
NOTE: The connector must have write access to the target system in order to publish
outstanding objects that are being post-processed. That means, the Connection is
read-only option must not be set for the target system connection.
NOTE: By default, the selected objects are processed in parallel, which speeds up the
selected method. If an error occurs during processing, the action is stopped and all
changes are discarded.
Bulk processing of objects must be disabled if errors are to be localized, which means the
objects are processed sequentially. Failed objects are named in the error message. All
changes that were made up until the error occurred are saved.
Related topics
l Configuring target system synchronization on page 27
l Users and permissions for synchronizing on page 5
If one membership in One Identity Manager changes, by default, the complete list of
members is transferred to the target system. Therefore, memberships that were previously
added to the target system are removed in the process and previously deleted
memberships are added again.
1. In the Manager, select the Data Synchronization > Basic configuration data >
Target system types category.
2. In the result list, select the target system type.
3. Select the Configure tables for publishing task.
4. Select the assignment tables that you want to set up for single provisioning. Multi-
select is possible.
5. Click Merge mode.
NOTE:
l This option can only be enabled for assignment tables that have a base table
with a XDateSubItem column.
l Assignment tables that are grouped together in a virtual schema property in
the mapping must be marked identically.
Example: ADSAccountInADSGroup, ADSGroupInADSGroup, and
ADSMachineInADSGroup
6. Save the changes.
For each assignment table labeled like this, the changes made in One Identity Manager are
saved in a separate table. Therefore, only newly added and deleted assignments are
processed. During modification provisioning, the members list in the target system is
compared to the entries in this table. This means that only modified memberships are
provisioned and not the entire members list.
NOTE: The complete members list is updated by synchronization. During this process,
objects with changes but incomplete provisioning are not handled. These objects are
logged in the synchronization log.
You can restrict single provisioning of memberships with a condition. Once merge mode has
been disabled for a table, the condition is deleted. Tables that have had the condition
deleted or edited are marked with the following icon: . You can restore the original
condition at any time.
1. Select the auxiliary table for which you want to restore the condition.
2. Right-click on the selected row and select the Restore original values
context menu item.
3. Save the changes.
NOTE: To create the reference to the added or deleted assignments in the condition, use
the i table alias.
Example of a condition on the UNSAccountBInUNSGroupB assignment table:
Prerequisites
l A synchronization step exists that can import the changes to the changed object into
One Identity Manager.
l The table that contains the changed object is assigned to a target system type.
l The path to the base object of the synchronization is defined for the table that
contains the changed object.
Specify the tables that you want to synchronize using single object synchronization and
configure single object synchronization for these tables. For more information, see the One
Identity Manager Target System Synchronization Reference Guide, section Include custom
tables in the synchronization.
To define the path to the base object for synchronization for a table
1. In the Manager, select the Data Synchronization > Basic configuration data >
Target system types category.
2. In the result list, select the target system type.
3. Select the Assign synchronization tables task.
4. In the Add assignments pane, assign the table for which you want to use single
object synchronization.
5. Save the changes.
6. Select the Configure tables for publishing task.
7. Select the table and enter the Root object path.
IMPORTANT: If this option is set, One Identity Manager tries to ignore commit errors that
could be related to data errors in a single column. This causes the data changed in the
affected column to be discarded and the object is subsequently saved again. This effects
performance and leads to loss of data.
Only set this option in the exceptional circumstance of not being able to correct the data
before synchronization.
Troubleshooting
For more information about correcting errors during synchronization of object hierarchies,
see the One Identity Manager Target System Synchronization Reference Guide.
About us
One Identity solutions eliminate the complexities and time-consuming processes often
required to govern identities, manage privileged accounts and control access. Our solutions
enhance business agility while addressing your IAM challenges with on-premises, cloud and
hybrid environments.
For sales and other inquiries, such as licensing, support, and renewals, visit
https://www.oneidentity.com/company/contact-us.aspx.
Technical support is available to One Identity customers with a valid maintenance contract
and customers who have trial versions. You can access the Support Portal at
https://support.oneidentity.com/.
The Support Portal provides self-help tools you can use to solve problems quickly and
independently, 24 hours a day, 365 days a year. The Support Portal enables you to:
l Submit and manage a Service Request
l View Knowledge Base articles
l Sign up for product notifications
l Download software and technical documentation
l View how-to videos at www.YouTube.com/OneIdentity
l Engage in community discussions
l Chat with support engineers online
l View services to assist you with your product
A R
application role 5 remote connection server 13
application role for synchronization 9
S
B schema
base object 13, 32 changes 24
shrink 24
D update 24
single object synchronization 32
database connector
synchronization
generic 4
start 25
synchronization analysis report 34
J
synchronization configuration 13, 15
Job server synchronization log 26
edit 10 synchronization server 13
configure 10
M install 10
modify provisioning 30
T
O target system synchronization
outstanding 26, 29
publish 29 V
outstanding object 26 variable set 13
P
provisioning
members list 30