This module writes the One Identity Manager Service messages. The following module types may be selected:
About this guide
One Identity Manager software architecture
Working with objects in One Identity Manager
Inserting, modifying, and deleting an object in One Identity Manager
Customizing the One Identity Manager default configuration
Reloading changes dynamically
Locking and unlocking individual properties for editing
System configuration reports
Customizing the One Identity Manager base configuration
Overview of the database settings
Changing database connection data
Database configuration for a test, development, or productive environment
Language settings for displaying and maintaining the data
Default country for determining working hours and public holidays
Configuration parameters for system configuration
One Identity Manager schema basics
Overview of the One Identity Manager schema
Table types and default columns in the One Identity Manager data model
Notes on editing table definitions and column definitions
Table definitions
Editing the user interface
Table types in One Identity Manager
Column definitions
Database views of the View type
Database views of the proxy type
Database views of the Union type
Database views of the Read-only type
Table scripts
Working with a globally unique identifier module
Defining unique columns for tables
Specifying deferred deletion for objects
Editing table definitions
Table definition properties
Displaying the table definition Customizer
Templates for generating values
Table relations
Dynamic foreign key
Supporting file groups
Selecting templates from the configuration library
Editing value templates
Preventing a change to a column
Restricting performance of value templates
Example of local value templates within an object
Example of cross-object value templates
Limiting column lengths
Defining decimal places for displaying values
Using predefined formatting types
Creating formatting scripts
Selecting formatting scripts from the configuration library
Column dependencies for setting values
Permitted column values
Specifying requirements for MVP columns
Defining bitmasks
Configuring columns for full-text search
Scripts for conditionally displaying and editing columns
Editing column definitions
Column definition properties
Object definitions for the user interface
Localization in One Identity Manager
Selection criteria for object definitions
Using the captions for object definitions
Creating and editing object definitions
Object definition properties
User interface navigation
Navigation elements
Recommendations for editing menu navigation
Tips for working with the User Interface Editor
Selecting the user interface navigation view for editing
Forms for the user interface
Loading a complete user interface navigation
Loading menu navigation using an application
Direct loading of menu items
Loading menu items using permissions groups
Loading menu navigation using a where clause
Simulating user interface navigation during editing
Copying existing user interface navigation for new permissions groups
Creating a new user interface navigation
Copying menu items
Creating new menu items
Creating new menu categories
Assigning menu items to applications
Assigning menu items to permissions groups
General menu item properties
Creating database queries for data-dependent menu items
Editing lists
Using links in the navigation
Using variables in the navigation
Recommendations for editing forms
Editing user interface forms
Statistics in One Identity Manager
Tips for working with the Form Editor
Disabling user interface forms
Copying user interface forms
Creating user interface forms
Assigning user interface forms to applications
Assigning user interface forms to permissions groups
Assigning user interface forms to object definitions
Effects of object definitions when displaying interface forms
Assigning user interface forms to menu items
Displaying custom columns and tables on main data forms
Forms for custom extensions
Hierarchical display of data on assignment forms
User interface form properties
Form definitions and form templates
Working with overview forms
Creating and editing statistic definitions
Disabling statistics definition
Including statistics in the user interface
Diagram types for visualizing statistics
Examples of statistic definitions
Extending the Launchpad
Recommendations for extending the Launchpad
Actions for the Launchpad
Creating new menu items and actions for the Launchpad
Task definitions for the user interface
Creating and editing task definitions
Disabling task definitions
Script for conditional displaying of tasks
Properties of task definitions
Applications for configuring the user interface
Icons and images for configuring the user interface
Using predefined database queries
Working in different time zones
Determining working hours
Editing country information
Process orchestration in One Identity Manager
Setting countries and states
Specifying the standard hours for countries and states/provinces/counties
Displaying public holidays for countries and states
Editing countries
Editing states
Country properties
State properties
Public holiday properties
Language-dependent data representation
Basic rules for using language-dependent data
Flagging columns for translation
Using the text memory for translation
Displaying translations in the Language Editor
Showing usage of a translation
Editing translations of a single table
Editing all translations
Changing translation keys
Importing translations from the language pack
Mapping processes in One Identity Manager
The One Identity Manager Service functionality
Editing processes with the Process Editor
Defining processes
Setting up Job servers
Creating and editing processes
Copying processes
Creating and editing process steps
Copying single process steps
Importing process steps into a process
Searching for entries within processes
Comparing processes
Exporting and importing processes
Process properties
Process step properties
Process step parameters
Events for processes
Permissions for triggering processes
Simulating process generation
Checking the validity of a process
Compiling processes
Using process-specific and global variables for the process definition
Thresholds for handling processes
Specifying the executing server
Notifications about process step handling
Running processes automatically
Displaying process plan status
Starting a process plan immediately
Creating and editing process plans
Process plan properties
Overview of process components
Handling processes with the One Identity Manager Service
Parallel processing of processes by the One Identity Manager Service
Running external processes with the StdioProcessor
Configuring the One Identity Manager Service
Tracking changes with process monitoring
One Identity Manager Service configuration files
Customizing the One Identity Manager Service configuration for a Job server
Template for the configuration file
Selecting module types and editing parameters
Validating the configuration file
Process collection module
Job destination module
Configuration module
Logwriter module
Dispatcher module
Connection module
HTTP authentication module
Module plug-ins
HTTPLogPlugin
ScheduleCommandPlugin
RequestWatchDogPlugin
PerformanceCounterPlugin
DebugMailPlugin
ShareInfoPlugin
Configuring the RemoteConnectPlugin
DatabaseAgentPlugin
File module with private key
Basic rules for process monitoring
Logging data changes
Logging process information during process handling
Conditional compilation using preprocessor conditions
Editing process information for processes
Editing process information for process steps
Editing process information for events
Recording messages in the process history
Process tracking for DBQueue Processor operations
Archiving and deleting records
Preprocessor-relevant configuration parameters
Preprocessor conditions in objects
Preprocessor conditions in VB.Net expressions
Evaluation of preprocessor conditions during compilation
Scripts in One Identity Manager
Visual Basic .NET scripts usage
Notes on message output
Notes on using date values
Tips for using PowerShell scripts
Using dollar ($) notation
One Identity Manager query language
Accessing local object columns
Accessing columns of an object connected by a relation
Accessing the old column value
Accessing the display value of a column
Accessing references in comments
Accessing metavalues of the local object
Accessing objects' display values
Using base objects
Calling functions
Pre-scripts for use in processes and process steps
Using session services
Querying configuration parameters
Testing for the existence of certain database entries
Querying session object global variables
Using #LD notation
Script library
Support for processing scripts in the Script Editor
Creating and editing scripts in the Script Editor
Copying scripts in the Script Editor
Testing scripts in the Script Editor
Testing script compilation in the Script Editor
Overriding scripts
Permissions for running scripts
Editing and testing script code with the System Debugger
Loading the script library
Tips for editing script code in the System Debugger
Logging database queries and object actions
Testing script code in the System Debugger
Extended debugging in the Object Browser
Testing scripts in the System Debugger
Testing templates and formatting scripts in the System Debugger
Testing methods in the System Debugger
Testing table scripts in the System Debugger
Saving changes to the database
Language elements of the One Identity Manager query language
Formulating queries in the One Identity Manager query language
Reports in One Identity Manager
Query header
Where clauses
Search clauses
Select clauses
Order by clauses
Paging clauses
Display value clauses
Query parameter clauses
Query hints
Conditions
Comparing columns
Comparison by means of IN and NOT IN clauses
Compare date differences
Compare date ranges
Compare fixed values
Comparing parameters
Using preformatted Where clauses
Working with the Report Editor
Adding custom tables or columns to the One Identity Manager schema
Menu items in Report Editor
Views in the Report Editor
Report Editor program settings
Logging database queries
Creating and editing reports in the Report Editor
Editing general report properties
Creating and editing data sources
Data retrieval using SQL queries
Data retrieval using database views
Data retrieval using an object
Data retrieval using single object history
Data retrieval using multiple object history
Data retrieval using historical assignments
Data query for simulation data
Report parameters
Editing report parameters
General parameter settings
Parameter value definitions
Settings for calculating values
Using virtual data sources
Editing the report form
Example of a simple report with data grouping
Embedding reports in the user interface
Translating reports
Generating and exporting reports
Creating new tables
Extending tables
Defining columns
Web service integration
Creating simple columns
Creating foreign key columns
Creating dynamic foreign keys
Creating new columns for database views with type view
Advanced configuration of columns
Creating database views with read-only type
Creating database views with Union type
Creating new assignment tables
Creating indexes
Removing custom schema extensions
Permissions for schema extensions
Change labels for the schema extensions
Adding schema extensions to the database
Recommendations for advanced configuration of custom schema extensions
Notes for custom functions, triggers, or database procedures
Managing custom database objects within the database
Binding a web service
One Identity Manager as SCIM 2.0 service provider
Generic web service call
Direct web service call
Self-defined web service call
Creating web service solutions with the Web Service Integration Wizard
Modifying a web service solution
Deleting a web service solution
Endpoints and base URL
SCIM plug-in features
Authenticating SCIM clients
Authenticating SCIM plug-ins in One Identity Manager
Special features of generating the SCIM schema
SCIM plug-in requests
Processing DBQueue tasks
DBQueue Processor configuration for test, development, or productive environments
Configuring notification behavior for DBQueue Processor initialization
Reinitializing the DBQueue Processor
Bulk processing in the DBQueue Processor
Processing DBQueue Processor tasks by the Database Agent Service
One Identity Manager Service configuration files
Logwriter module
EventLogLogWriter
The EventLogLogWriter writes messages from the One Identity Manager Service to an event log. To view the event log, you can use the results display in the Microsoft Management Console, for example.
|
Parameters |
Description |
|---|---|
|
EventLog |
Name of the event log to which the messages are written. The messages are written to the application log with Application as the default value. NOTE: If more than one One Identity Manager Service write event logs on a server, make sure that the first eight letters in the log name are unique on the server. |
|
LogSeverity |
Severity levels of the logged messages. Permitted values are:
|
|
EventID |
The ID of the messages written to the event log. |
|
Category |
The category of the messages written to the event log. |
|
Source |
The name of the source of the messages written to the event log. |
By default, the One Identity Manager Service only logs messages in the event log Application.
To use an event log with a different name
-
On the Job server, manually add the file for theOne Identity Manager Service to write to. You can use PowerShell, for example, to do this.
-
Run PowerShell as administrator on the Job server.
-
Run the following CmdLet:
New-EventLog -Source "Foobar" -LogName "<file name>"
-
-
Enter this file name in the One Identity Manager Service configuration file, in the module EventLogWriter as the name for the event log.
-
Restart the computer.
-
Restart the One Identity Manager Service.
Related topics
FileLogWriter
The FileLogWriter writes messages from One Identity Manager Service to a log file. The log file can be displayed in a browser.
You call up the log file with the appropriate URL.
http://<server name>:<port number>
The default value is port 1880.
|
Parameters |
Description |
|---|---|
|
Log file (OutputFile) |
Name of the log file, including the directory name. Log information for the One Identity Manager Service is written to this file. IMPORTANT: The directory specified for the file must exist. If the file cannot be created, no error output is possible. Error messages then appear under Windows operating systems in the event log or under Linux operating systems in /var/log/messages. |
|
Log rename interval (LogLifeTime) |
In order to avoid unnecessarily large log files, the module supports the functionality of exchanging the log file with a history list. The LogLifeTime specifies the maximum life of a log file before it is renamed as backup. If the log file has reached its maximum age, the file is renamed (for example, as JobService.log_20040819-083554) and a new log file is started. Timeout format: day.hour:minutes:seconds |
|
Process step log lifetime (JobLogLifeTime) |
Retention time for process step logs. After this expires, the logs are deleted. Timeout format: day.hour:minutes:seconds For test purposes, you can enable logging of individual process steps in the Job Queue Info. The processing messages of the process step is written to a separate log with the Debug NLog severity. The files are stored in the log directory. Repository structure: <Log directory>\JobLogs\<First 4 digits of the UID_Job>\Job_<UID_Job>_<yyyymmdd>_<Timestamp>.log |
|
Number of history logs (HistorySize) |
Maximum number of log files. If several log files exist, the oldest backup file is deleted when a new log file is created so that the limit is not exceeded. |
|
Max. log file size (MB) (MaxLogSize) |
Maximum size in MB of the log file. Once the log file has reached the limit, it is renamed as a backup file and a new log file is created. |
|
Max. length of parameters (ParamMaxLength) |
Maximum number of characters allowed in a process step parameter so that they are written to the log file. |
|
LogSeverity |
Severity levels of the logged messages. Permitted values are:
|
|
Add server name (AddServerName) |
Specifies whether the server name is to be added to the log entries. |
Dispatcher module
In a hierarchical server structure a server can be used as a proxy server for other servers. The proxy server makes requests at set time intervals for process steps to be processed on a server and sends them to the next server. If the request load needs to be minimized, a proxy server is recommended.
|
Parameters |
Description |
|---|---|
|
Acts as proxy for other servers (IsProxy) |
Specifies whether the server is to act as a proxy server. Set this option if the server should be a proxy server. |
|
ProxyInterval |
Time interval in seconds, after which the proxy server acting as deputy for another server, should renew a request to the database. |
The following guidelines can be used as orientation for the configuration of One Identity Manager Service polling intervals in a cascading environment:
| Parameters | Root Server (direct connection to database) | Leaf server (connected by HTTP or file) |
|---|---|---|
|
JobServiceDestination.StartInterval |
90 seconds |
600 seconds |
|
JobServiceDestination.Statisticinterval |
360 seconds |
600 seconds |
|
Dispatcher.ProxyInterval |
180 seconds |
|
|
Dispatcher.IsProxy |
True |
False |
The proxy mode of a root server ensures that, acting on behalf of the leaf server, process steps are queried in shorter proxy intervals. When the root server is restarted, it may take a while until all leaf servers have sent their first request (in this case a maximum of 600 seconds). However, the system then swings into action.
Figure 28: Dispatcher configuration example
