The environment command enables you to display or reconcile user and group environment records for all isolated regions within a workflow system schema. Information that is stored in environment records includes the name and user preferences such as email address, step notification preferences, and tracker notification preferences.
Cached records are updated when stale, the memory record is updated with the latest database record, and the database record is updated with the latest LDAP information that is retrieved from Content Platform Engine.
The syntax varies depending on the action you choose to perform. You can use the short command name env for environment
Action to perform | Syntax |
---|---|
View environment records | To view all environment records, enter: environment v There are two options to view environment records, cache and persistent. environment v [c server | p] [ short_name | @userid ] The c (cache) option lists the environment records that are in cache memory, and the p (persistent) option lists the permanent workflow system environment records. The option for cache is:
The options for cache and persistent are either short_name or @userid
To view persistent records that are associated
with the short name peadmin, type:
To
view cached records that are associated with the short name peadmin on
a specified server, type:
To
view persistent records that are associated with the user ID 50, type:
To
view cached records that are associated with the user ID 50, type:
|
Report or reconcile environment record inconsistencies | To report or reconcile inconsistent environment records, use
either of the following options: environment i [r | f] where r reports all of the inconsistent environment records, and f reconciles (fix) the inconsistent environment records. The options for f reconcile (fix) are:
To report all inconsistent environment records,
type:
To
reconcile an environment record that is specified by the old short
name and change it with the new short name, type:
To
reconcile all inconsistent environment records, type:
|
Cache an environment record to memory | To cache a specified environment record to memory, enter: environment c short_name where short_name specifies the short name of the environment record to place into memory for all servers. The following command places the environment record
named peadmin into cache memory for all servers:
To
place all environment records into cache memory for all servers, type:
|
Flush environment records from memory | To flush an environment record that is cached
in memory, enter: environment r c short_name where short_name specifies the short name of the environment record to remove from the memory of all servers. The following command flushes the environment
record named peadmin from memory of all farm servers:
To flush all records from memory, use this environment command or the flushusercache command. |
Allow default email notification | To apply the default email notification settings
to a specific user, enter: environment n user_name where user_name is a specific user. To apply the default email notification settings to all users, enter: environment n * |
You can use the environment command to reconcile cached and permanent environment records on the workflow system server with the possibly more up-to-date data in the FileNet P8 domain directory service. Workflow system duplicates certain parts of the security information in its own database. Over time, the information in the directory service can be changed or updated. When this happens, the information in workflow system environment records, whether cached or permanent, can contain old, invalid information about workflow system users and groups.
The reconciliation option uses the short name that is supplied by the directory service to identify a user or group. Based on the short name, the information in the workflow system environment record (and any cached entry) is compared to the information stored in the directory service. If the information does not match, vwtool automatically reconciles the data, or reports the inconsistency if reconciling the data is not possible.
The following table lists the inconsistencies that can be reconciled and whether the corrections can be made automatically.
Inconsistency | Action |
---|---|
A group or user was reorganized. That is, the distinguished name of a user or group was changed while maintaining the same short name. | vwtool automatically updates the environment record. |
A user was added to or removed from a group. | vwtool automatically updates the group membership. |
A user email address was changed. | vwtool automatically updates the email address if you answered "y" to the email update option. |
A user short name was changed but the SID remains the same. | vwtool automatically updates the workflow system
stored short name to the new name defined in LDAP. Previously, when an administrator changes a short name in LDAP, the vwtool single fix up is run to fix the stored workflow system short name before this user or group accesses workflow system. This enables the user to log in with his new name and see all of his work intact. Failure to run fix up would mean loss of referenced work because workflow system automatically creates a record for a name that did not exist in its database, assigns this record a different id, and subsequently requires user to do more fix ups. |