Chat now with support
Chat with Support

Identity Manager 8.0 - Configuration Guide

One Identity Manager Software Architecture Working with the Designer Customizing the One Identity Manager Default Configuration Checking Data Consistency Compiling a One Identity Manager Database Working with Change Labels Basic System Configuration Data
One Identity Manager Authentication Module Database Connection Data Configuration Parameters for System Configuration Setting up the Mail Notification System Enabling More Languages for Displaying and Maintaining Data Displaying Country Information Setting Up and Configuring Schedules Password Policies in One Identity Manager Reloading Changes Dynamically TimeTrace Databases Machine Roles and Server Functions Files for Software Update Operating Systems in Use System Configuration Reports Using Predefined Database Queries Managing Custom Database Objects within a Database
The One Identity Manager Data Model Granting One Identity Manager Schema Permissions Working with the User Interface
Object definitions for the User Interface User Interface Navigation Forms for the User Interface Statistics in the One Identity Manager Extending the Launchpad Task Definitions for the User Interface Applications for Configuring the User Interface Icons and Images for Configuring the User Interface Language Dependent Data Representation
Process Orchestration in One Identity Manager
Declaring the Job Server One Identity Manager Service Configuration Handling Processes in the One Identity Manager
Tracking Changes with Process Monitoring Conditional Compilation using Preprocessor Conditions One Identity Manager Scripts Maintaining Mail Templates Reports in the One Identity Manager Custom schema extensions Transporting One Identity Manager Schema Customizations Importing Data Web Service Integration SOAP Web Service One Identity Manager as SPML Provisioning Service Provider Searching for Errors in the One Identity Manager Processing DBQueue Tasks One Identity Manager Configuration Files

Logging Process Information during Process Handling

Table 250: Configuration Parameters for Logging Process Information
Configuration parameter Effect
Common\ProcessState Process monitoring can be configured if the configuration parameter is set. The data is displayed in the Manager process view.
Common\ProcessState\ProgressView When the parameter is set, changes in the context of process monitoring and display of information takes place in the process view.

The following prerequisites are required to log process information during process execution:

  • Set the configuration parameter "Common\ProcessState" in the Designer.
  • Set the configuration parameter "Common\ProcessState\ProgressView" in the Designer. Specify the scope of logging through the configuration parameter option.

    Table 251: Scope of Process Logging

    Option

    Description

    1

    Full process tracking Process information from all processes marked for process tracking is logged.

    2

    Web Portal tracking Only process information for process marked for process tracking the Web Portal is logged. (default)

  • Label the process and process steps for process tracking and define templates for event, process and process step process information.

NOTE: The information is displayed in the Manager’s process view. For more information, see the One Identity Manager User Guide for One Identity Manager Tools User Interface and Default Functions.

If the configuration parameter "Common\ProcessState\ProgressView" is enabled, the Job Generator creates an entry in the status table while generating process information for processes and process steps.

Right at the start, the Job Generator uses the GenProcID for the generating operation. If there is no GenProcID passed at runtime, a new one is automatically created. This ID is written to the global variable "GENPROCID" for the current database connection object before the process is generated. Therefore, it can be used by all processes. All partial steps that are triggered by a generating operation are grouped together in this way and logged. Bulk operations such as synchronization and CSV import are an exception. In this case, a new GenProcID is created for each individual step in tracking the object changes and not for the process as a whole.

An entry is set up in the status table DialogProcessStep for each process step that is marked for tracking. For each process that has at least one such process step, an entry is made in the status table DialogProcessChain. For each generating operation that has caused an entry in the status table DialogProcessChain, an entry is written to the status table DialogProcess. At the same time, the Job Generator creates the display name for the process view by executing the given VB.Net expression for the process information.

The possible processing states and additional information available for the respective processing statuses are listed in the following tables.

Table 252: Possible Process States
Process State Description
Initial <generated> ::= "G"
End of processing

<finalstate> ::= <ended> | <failed> | <not executed>

where:

<ended> ::= "E" (processing successful)

<failed> ::= "F" (processing unsuccessful)

<not executed> ::= "N" (no longer accessible during processing)

In progress

<workingstate> ::= <delayed> | <processing> [<ProcessStateAddON>]

where:

<delayed> ::= "D" (processing delayed)

<Long delayed>::="L" (processing was put on hold)

<processing> ::= "P" (in progress)

<ProcessStateAddON> ( optional additional information)

Table 253: Possible Additional Information
Additional Information Description
Processing deferred until

<datetime> ::= <YYYY> - <MM> - <DD> <HH> : <NN> : <SS>

where:

<YYYY> ::= 1980..9999

<MM> ::= 01..12

<DD> ::= 01..31

<HH> ::= 00..23<NN> ::= 00..59

<SS> ::= 00..59

Retries <retryinfo> ::= 1..99
Related Topics

Setting Up Process Information for Process Handling

You can set up templates for creating process information for processes, process steps and events with the Process Editor in the Designer. Use #LD notation for language dependent definition of process information.

To edit process information a process

  1. Open the process in the Process Editor in the Designer.
  2. Click on the element for the process in the process document.
  3. Select how the process information should be logged by selecting a value from the Process information menu.

    Table 254: Permitted Values

    Value

    Description

    None

    The process information is not logged.

    Full process tracking

    The process information is logged and displayed in the Manager.

    Web Portal tracking

    The process information is logged and displayed in the Manager and in the Web Portal.

  4. Enter the template for process information in the Process information text box.

To edit process information for a process

  1. Open the process in the Process Editor in the Designer.
  2. Click on the element for the process step in the process document.
  3. Select how the process information should be logged by selecting a value from the Process information menu.

    Table 255: Permitted Values

    Value

    Description

    none

    The process information is not logged.

    Full process tracking

    The process information is logged and displayed in the Manager.

    Web Portal tracking

    The process information is logged and displayed in the Manager and in the Web Portal.

  4. Select Detail depth for the process information on the Process tracking tab. The following options are available: "Basic information", "Advanced information" and "Full information".

    You use depth of detail to control how process information is displayed in the Manager's process view. This provides users with different layers of detail for process information depending on the configuration in the Manager’s user interface.

  5. Enter the template for process information in the Process information text box.

To edit process information for events

  1. Open the process in the Process Editor in the Designer.
  2. Click on the element for the process in the process document.
  3. Select the Events view.
  4. Select the event and option the edit dialog box with .
  5. Enter the template for process information in the Event process information text box.
  6. Click OK.

IMPORTANT: At least one event process must have process tracking enabled in order to generate process information for events.

If several processes point to one event, the event with a process information template is found that has the lowest generating order specified in its process configuration. This template is evaluated and shown in the process view.

If there no template is available, the information is evaluated as follows:

<table> - <event> - <object display name>

Related Topics

Recording Messages in the Process History

Table 256: Configuration Parameter for Logging Messages in the Process History
Configuration parameter Meaning
Common\ProcessState\JobHistory Logs entries in the table JobHistory.

Processes being handled are logged in the process history. The process history can be analyzed with the help of the "Job Queue Info" program.

To log messages to the process history

  • Set the configuration parameter "Common\ProcessState\JobHistory" in the Designer and specify a range for the log entries.
    Table 257: Permitted Values for the Configuration Parameter "Common\ProcessState\JobHistory"
    Value Meaning
    NO No messages are written to the process history.
    ALL All handled process steps are written to the process history.
    ERROR Only failed process steps are written to the process history.

    ERRORorSELECTED

    Failed process steps and process steps marked with the option Process history are logged in the process history.

    SELECTED

    Only process steps marked with the option Process history are logged in the process history.

Log entries in the process history are exported from the One Identity Manager database at regular intervals. One Identity Manager provides various methods to do this. For more information, see Archiving and Deleting Recordings.

Related Topics

Process Tracking for DBQueue Processor Operations

Process Tracking for DBQueue Processor Operations

In order to track inherited calculations as a result of changes to the system, the GenProcID is always passed to the DBQueue Processor operation. There may only be one entry in the DBQueue for each operation and object in case of follow-on operations. To map such processes, a new GenProcID is issued and used in subsequent processes. The conflicting processes and their GenProcID’s are saved in the table DialogProcessSubstitute.

When a new GenProcID is created for conflicting processes, the following rules apply:

  • Several of the same DBQueue Processor operations on one object are merged into one process (one GenProcID). This uses existing substitute processes if the number is identical to the predecessor (with respect to the root process).
  • If further conflicts occur in the sequence, the GenProcIDs that have already been replaced are reset to the original and a new substitute is created.
  • A substitute is only valid for one set of original processes.
Related Topics
Related Documents