TIP: If you set the Common | ProcessState | PropertyLog | AllDefaultPropertiesForModel configuration parameter in the Designer, One Identity Manager schema columns are already labeled for logging changes and deletions. Define which columns are affected in the QBMVDefaultHistoryColumns database view.
To label a column for recording
-
In the Designer, select the One Identity Manager schema category.
-
Select the table and start the Schema Editor with Show table definition.
-
Select the column and then the Column properties view.
-
Select the Miscellaneous tab and edit the following properties.
NOTE: The information is displayed in the Manager in the process view. For more information, see the One Identity Manager Operational Guide.
To log process information
-
In the Designer, check if the Common | ProcessState configuration parameter is set. If not, set the configuration parameter.
-
In the Designer, check if the Common | ProcessState | ProgressView configuration parameter is set. If not, set the configuration parameter. Select the scope of logging through the configuration parameter option.
Permitted values are:
-
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.
In the Designer, use the Process Editor to set up templates for creating process information for processes, process steps, and events. Use #LD notation for language-dependent definition of process information.
If the Common | ProcessState | ProgressView configuration parameter is enabled, the Job generator creates entries in the status tables during process generation for processes, process steps, and events with process information.
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 GenProcID is written to the GenProcID global variable of the current database connection object before the process is generated and can therefore be used in 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 DialogProcessStep status table 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 DialogProcessChain status table. For each generating operation that has caused an entry in the DialogProcessChain status table, an entry is written to the DialogProcess status table. At the same time, the Job Generator creates the display name for the process view by running 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 77: Possible process states
|
Initial |
<generated> ::= "G" |
|
End of processing |
<finalstate> ::= <ended> | <failed> | <not run>
where:
<ended> ::= "E" (processing successful)
<failed> ::= "F" (processing unsuccessful)
<not run> ::= "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 78: Possible additional information
|
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 |
Identify the processes for process tracking and define templates for the process information.
To edit process information for a process
-
In the Designer, select the process in the Process Orchestration category.
-
Start the Process Editor with the Edit process task.
-
Click on the element for the process in the process document.
-
On the General tab in the Process properties view, edit the following information.
-
Enter the following information in the Process properties view on the Process tracking tab.
Identify the process steps for process tracking and define templates for the process information.
To edit process information for a process
-
In the Designer, select the process in the Process Orchestration category.
-
Start the Process Editor with the Edit process task.
-
Click on the element for the process step in the process document.
-
In the Process step properties view on the General tab, edit the following information.
-
In the Process step properties view on the Process tracking tab, enter the following information.
-
Depth of detail: Select the level of detail of the process information. You can choose from: basic information, extended information and full information.
You use depth of detail to control how process information is displayed in the Manager's process view. Depending on the Manager's program settings, differing levels of detail are offered to the user on views of the process information. For more information, see the One Identity Manager Operational Guide.
-
Process information: Enter the value template for the process information as VB.NET term. Use #LD notation for language-dependent definition of process information.
