Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
This article describes how to set up batch synchronization in scheduled jobs in Smart ID Identity Manager. Batch Scheduled jobs can be used for example to do scheduled import of person data from Active Directory or human resources (HR) system.
There are two ways to create a scheduled job - via a timed process or via batch synchronization. Both are described in this article.
Prerequisites
Expand | ||
---|---|---|
| ||
The following prerequisites apply:
|
Timed process
A timed process job has a cron expression that defines when and how often the job should run.
Expand | ||
---|---|---|
| ||
|
Expand | ||
---|---|---|
| ||
To add or edit a timed process:
To edit an existing timed process, double-click the timed process name. |
Expand | ||
---|---|---|
| ||
To see the status of a scheduled job:
|
Batch synchronization
To create a batch synchronization, you first need a target data pool, a target core template, a search configuration with a corresponding data pool defining the data source, and a mapping, as described below. These tasks are done in in Identity Manager Admin. The status of scheduled batch synchronizations can be viewed in Identity Manager Operator.
Note | ||
---|---|---|
All search configurations and processes that are executed by a batch synchronization must be assigned to the role | ||
Expand | ||
| ||
The following prerequisites apply: Installed Identity ManagerTo change which role is defined for batch synchronization, there is a setting in system.properties. |
Prerequisites
, see Copy of List of Identity Manager system properties (update link when publishing) |
Create data pools, core template, search configuration, and mapping
Expand | ||
---|---|---|
| ||
|
Expand | ||
---|---|---|
| ||
A source data pool is required to connect to the data source that you wish to synchronize with, for example Active Directory (LDAP) or HR system. To add or edit data pools for batch synchronization:
|
Expand | ||
---|---|---|
| ||
A search configuration is required to search in the source data pool for the unique identifier fields. To add or edit a search configuration for a specific batch job:
|
Expand | ||
---|---|---|
| ||
A target core template and corresponding data pool are required to store the imported data in. To create a target core template and data pool:
|
Expand | ||
---|---|---|
| ||
To adapt the mapping for a specific batch job:
|
Create batch synchronization
Expand | ||
---|---|---|
| ||
To add or edit a batch synchronization:
|
Expand | ||
---|---|---|
| ||
To adapt the batch synchronization to your data source:
|
Expand | ||
---|---|---|
| ||
For scheduling the job, a Cron expression is required. There are Cron generators online that can be used to generate the expression to be entered in Identity Manager Admin. To set the scheduling:
|
Expand | ||
---|---|---|
| ||
When you have set the scheduling of a batch synchronization job, you can chose to activate or deactivate the job with the Batch Synchronization enabled Enabled check box. Activate:
Deactivate:
The scheduler usually runs every minute and checks if the data of batch synchronization job was updated. If the enable flag is set, the scheduler creates a new batch sync job. |
Expand | ||
---|---|---|
| ||
If you want to do some action for all imported or updated data, a process can be set. The process is only executed if data is inserted or updated, not for identical data. To change which process to run in a batch job:
|
Expand | ||
---|---|---|
| ||
To see the status of a batch scheduled job:
|
This article is valid includes updates for Smart ID 2122.04 and later10.
Related information
- Smart ID Identity Manager
- Identity Manager Admin
- Configure Identity Manager
- Set up data pool in Identity Manager
- Set up search configuration in Identity Manager
- Set up identity template in Identity Manager
- Set up mapping in Identity Manager
- Identity Manager Operator