Process Admin Console
The Process Admin Console is a web based application that can be accessed from the following URL:
The login screen looks as follows:
After a successful login, the screen looks as follows:
The Process Admin Console is used to administer a Process Server instance.
At a high level, the following tasks can be performed:
IBM BPM Admin
Working with users. See: Process Admin - User Management
Working with global groups and group membership. See: Group Management
Bulk User Attribute Assignment Setting attributes on user definitions. See: Bulk User Attribute Assignment User Synchronization Monitoring Instrumentation Process Monitor Event Manager Monitor Blackout Periods Synchronous Queues EM JMS Error Queue Admin Tools Manage EPVs My Password Management Change Password Saved Search Admin Saved Search Admin
Process Admin - IBM BPM Admin
The IBM BPM Admin section of the Process Admin console provides for cache and task cleanup. The columns on the cache table mean the following: || |Column Name|Description| |CA (Cache Access)|The number of times the cache was refreshed and accessed.| |UCA (Un-refreshed Cache Access)|The number of times the cache was accessed but not refreshed.| |UCP (Un-refreshed Cache Percentage)|The percentage of un-cached access versus cached access.| |Last A. (Last Access)|The time of the last access.| |Status|Is caching on or off.| |Actions|Links to show and reset cache contents.|
Process Admin - User Management
The set of users known to IBPM can be updated from the Process Admin Console. A number of pre-defined resources are already present: || |tw_admins|group| |tw_admin|user| |tw_author|user| |tw_portal_admin|user| |tw_runtime_server|user| |tw_webservice|user| To retrieve a list of all existing users, use the wild card character '%' as the profile name to retrieve: New users can be added by entering the details of the user and pressing the Add button. IBPM sets some requirements on the password values including:
User Management > Group Management section of the Process Admin Console we can work with the global groups. We can create a new group or work with existing groups.
To see all groups, enter three spaces. For more details, see Security Groups.
Bulk User Attribute Assignment
Attributes associated with users can be setup in this area. We can select an attribute and see the values that each user has for that attribute or else we can select a user and see all the attributes for that user. Here we see the value of an attribute for a set of users. and here we see the attributes for a given user: The default attributes for a user are:
If a user attribute is defined as having values from a list of possible values then a drop-down entry is displayed from which the possible values can be selected: See also:
Process Admin - Monitoring
Process Admin - Event Manager
Within the Event Manager section of the Process Admin Console we are presented with a number of options relating to event processing within IBPM.
Event Manager > Monitor
Within the Monitor section, we are shown a list of the scheduled items that are to be executed when the event time is reached:
Event Manager > Blackout Periods
We can define periods of time when the scheduling of events should be suspended. This can be set in the Event Manager > Blackout Periods
Event Manager > Synchronous Queues
When the Event Manager is ready to dispatch a job for execution, it can place the request in a queue. In IBPM there are two "types" of queues. Asynchronous queues and synchronous queues. If a job is dispatched through an Asynchronous queue then the work associated with that job does not need to complete before the next job can be submitted for processing. For synchronous queues, when work is dispatched to a synchronous queue, that work must be completed before the next piece of work can be processed from the same queue. By default, IBPM provides three synchronous queues but others can be added. A synchronous queue is utilized in an UCA definition.
Event Manager > Event Managed JMS Error Queue
If the Event Manager is unable to dispatch a job for processing, the "data" associated with that job is saved in an error queue managed by the underlying JMS subsystem. The content of this queue can be examined:
Admin Tools > Manage EPVs
As discussed here: Exposed Process Values (EPVs), EPVs allow us to dynamically change values available to a process at run-time. These values can be changed through the Process Admin Console in the
Admin Tools > Manage EPVs section:
When selected, the Snapshot (which includes acronym and snapshot name) is selected from the snapshot pull-down. The lists of EPVs associated with that entity are then selectable and one should be selected for the Name field.
The list of variables in the named EPV container is then displayed along with their current values:
A particular variable name may then be selected at which point a new panel appears allow us to set a new value:
Clicking on the New button opens a window in which a new value for the variable may be defined including a date and time at which that new value should become effective:
The ability to schedule EPV variable changes for the future is incredibly useful. If we know in advance that some law or rule is to take effect from a given date/time then we can define that those changes can take effect in the future automatically. If the changes were not automatic but were instead manual
Note that the effective date/time must be in the future. Unfortunately, the date/time set by default is "now" which means that if it isn't changed to a future date, pressing the OK button will result in an error. One a value has been created for a scheduled future change, that value and date/time may be edited until the change happens.
After a change has happened, the change becomes fixed until another change request entry is created. The history of changed including the old values, who changed them and when the changes were made are recorded for subsequent viewing.
Process Admin – Saved Search Admin
Under the Saved Search Admin area we can find the entry to create Saved Searches. A Saved Search is a way to define searches that can be given a name and then a user can execute such a search merely by providing that name.
Once selected, the Saved Search editor is presented:
From here we can enter a description of the search we wish to have saved.
If we wish to build and create saved searches programatically, we can use the REST API for searching which has a "
Save As" option.
Process Admin – Process Inspector
Within the Process Admin console is a primary section called "Process Inspector". This is a search and filter mechanism to allow the BPM administrator to view the state of the system. It is not intended to be used by any kind of business user. At the highest level, we can execute a search for process instances. We can filter those processes by a variety of different states, owners and date ranges. The result is a set of processes that meet the desired criteria. The following is an example screen shot of such a search: The filtering rules available include:
After executing a search, the results are shown in the middle of the page. Selecting a process then shows addition details on the right of the page as well as actions that can be performed against that process instance. Each process instance has an icon beside it. These icons are: || |Icon|Description| ||Active| ||Completed| ||Terminated| ||Suspended| |TBD|Failed|
Process Admin - Installed Apps
The Installed Apps section of the Process Admin Console allows us to see which applications and their snapshots are currently deployed on the Process Server. From here we can perform some administration. If we select an individual application, we have options including:
For applications which have UCAs associated with them, we can choose to enable/disable their execution.
Customizing the Process Admin Console
The Process Admin Console contains a list of actions that can be performed in the left hand side of the web page:
These actions are configurable. New ones can be added and the existing ones removed. This allows administrators to add new functions specific for the local environment. To add a new entry, create a new Human Service within a Process Application. In the
Exposed As selection, choose
Administration Service. This is the attribute that says it will be exposed in the Process Admin Console.
(See also: Exposing the Human Service for starting)
When a user logs into the Process Admin Console, they will see a new entry corresponding to the Process Application in which the service is defined. Underneath the Process Application, will be the name of the new Human Service definition. Selecting that entry will cause the service definition to run.
To remove the original entries for the console, the file located at:
<Profile Root>/config/cells/cell name/node/node name/servers/sever name/process-server/config/console.xml
can be edited. This XML file contains entries for the folders and choices that appear by default on the console. Rather than delete the entries, it is suggested that they be commented out by bracketing the XML element with the
Powered by Wiki.js.
Return to top