environment

This command allows you to display or reconcile user and system environment records for all isolated regions. Information stored in user environment records includes the user name and user preferences such as email address, step notification preferences, and tracker notification preferences.

Environment record reconciliation

You can use this command to reconcile cached and permanent user data environment records on the Process Engine (PE) server with the possibly more up-to-date data in the FileNet P8 domain directory service. PE duplicates certain parts of the user security information in its own database. Over time, the information in the directory service may be changed or updated. When this happens, the information in PE’s environment records, whether cached or permanent, can contain old, invalid information about PE users and groups.

The reconciliation option uses the short name supplied by the directory service to identify a user. Based on the short name, the user's information in the PE environment record (and any cached entry) is compared to the information stored in the directory service. If the information doesn't match, vwtool automatically reconciles the data or, where necessary, allows the administrator to determine how to reconcile the differences.

The table below lists the inconsistencies that can be reconciled and whether the corrections can be made automatically or require input from the system administrator.

Inconsistency Action
A group or user has been reorganized. That is, the distinguished name of a user or group has changed while maintaining the same short name. vwtool automatically updates the environment record.
A user has been added to or removed from a group. vwtool automatically flushes the group from cache.
A user or group has been deleted. vwtool prompts you to delete the environment record.
A user’s email address has been changed. vwtool automatically updates the email address if you answered "y" to the email update option.

Syntax

The syntax varies depending on the action you choose to perform.

Action to perform Syntax

View user environment records

environment v <record_set> <user_name>

Report or reconcile environment record inconsistencies

environment i <fixup_option> <user_option> <email_option> <delete> <confirmation>

For example, to reconcile all inconsistencies, including email addresses, enter:

environment i f m y

Parameters

record_set

Enter "p" for permanently stored user information, including user preferences; enter "c" for a list of the currently cached users.

user_name

The user name. For FileNet Web Services and Open Client systems, you can also enter a full three-part name. Enter an asterisk (*) to list all users.

fixup_option Enter "r" to display a list of inconsistencies; enter "f" to reconcile the inconsistencies. The default option is "r".
user_option Enter "s" to specify a user environment record; enter "m" to check all (multiple) environment records. The default option is "s".
email_option Enter "y" to have vwtool update all environment record email addresses to match the email address stored in the directory service; enter "n" to ignore all email address inconsistencies. The default option is "n".
delete

Enter "y" to delete the PE environment record, or "n" to do nothing. The default option is "n". If you select "y", the environment record is deleted. The next time the user or group information is needed by PE, it will be retrieved from the directory service.

When deleting a user or group account, you must make sure the deletion does not disrupt currently running workflows. Use the Out of Office and Assign/Reassign features in Process Administrator to prevent new work from being assigned to a user and to reassign all current work to a different user, respectively, before deleting a user. Do not delete the user until s/he is no longer assigned any work. Failing to do so will cause any remaining work to be placed into the Conductor queue in an exception state.

Once a user’s (or group’s) environment record is deleted, any work that might be queued for that user (or group) will end up in an exception state or in the Conductor queue.

NOTE  If you choose to delete the environment record, you must confirm your choice. Enter "Yes" to perform the action, or "No" to do nothing. You must enter the answer exactly as indicated—"yes" or "y" is not the same as "Yes" in this case.