Siebel Business Process Framework: Task UI Guide > Testing, Troubleshooting, Deploying, and Administering a Task UI > Administering a Task UI >
Using the Task Instance Monitor
The Task Instance Monitor is an administrative tool that you can use to view a detailed status of active tasks and tasks that Siebel CRM has recently run. To use the Task Instance Monitor
- Log in to the Siebel client with administrator privileges.
- Adjust the monitoring level for the task UI you must monitor:
- Navigate to the Administration - Business Process screen, and then the Task Deployment view.
- In the Child Items list, locate the task UI you must monitor.
- In the Monitoring Level field, choose a monitoring level.
Siebel CRM sets the monitoring level for every task UI to None, by default. You must set the monitoring level to a value other than None to collect data for a task UI. For more information, see Monitoring Levels of the Task Instance Monitor.
- Run the task UI that you set up to monitor in Step 2.
- Navigate to the Administration - Business Process screen, and then the Task Instance Monitor view.
- In the Task Name field, locate the task UI you set up to monitor in Step 2.
The Task Name field uses the following format:
name:number
where:
- name is the name of the task UI.
- number is the repository version of the task.
For example:
BPF-Acceptance:32
The Task Instance Monitor displays information only for task UIs that are active and published. All fields are read-only.
- Examine information about the task instance.
For more information, see Fields That Siebel CRM Displays in the Task Instance Monitor.
- To examine information about task steps for this task instance, do the following:
- Click the Task Step Instances tab.
The Task Step Instances tab lists all the steps that constitute this task UI. It includes information for each task step. Example information includes Start Time, End Time, Status, and so on.
- To view information about process properties for the step, examine details in the bottom applet.
Siebel CRM displays information about process properties in the bottom applet. The step you choose in the Task Step Instances list references these process properties.
Monitoring Levels of the Task Instance Monitor
Table 17 describes the monitoring levels you can adjust in the task instance monitor. Siebel CRM uses the monitoring level that you set for each task UI, even if the monitoring level is different for a subtask. For example, assume you set the monitoring level to Progress for the parent task UI and to None for a subtask. In this situation, Siebel CRM does the following:
- Displays a new record for any new instance of the parent task UI
- Does not display a new record for any new instance of the subtask
If a task UI includes an error step, and if a task instance of this task UI runs the error step, then Siebel CRM still displays a record for the task instance according to the monitoring level you set.
Table 17. Monitoring Levels You Can Set in the Task Instance Monitor
|
|
None |
Siebel CRM does not display a new record for any task instance in any of the following views:
- Task Instance Monitor
- Task Step Instances
- Task Report
|
Status |
Siebel CRM displays a new record in the Task Instance Monitor view and the Task Report view for any new task instance. It does not display a new record in the Task Step Instances view. |
Progress |
Siebel CRM displays a new record for any new task instance in each of the following views:
- Task Instance Monitor
- Task Step Instances
- Task Report
|
Detail |
Siebel CRM displays the same information that it displays for the Progress monitoring level, plus information about process properties. To view this information, see Step 7. |
Debug |
Displays the same information as the Detail monitoring level. |
Fields That Siebel CRM Displays in the Task Instance Monitor
Table 18 describes fields that Siebel CRM displays in the Task Instance Monitor.
Table 18. Fields That Siebel CRM Displays in the Task Instance Monitor
|
|
Application |
The name of the Siebel application where Siebel CRM runs this task instance. For example, Siebel Call Center. |
Current Step Name |
The step name of the currently active step of this task instance. |
Duration |
The total amount of time that has elapsed between the Start Time and the End Time. |
End Time |
The time of day that the user completed or canceled the task UI. |
Instance Id |
A value that uniquely identifies an instance of a task UI or subtask. |
Owner Id |
The name of the user who started the task instance. |
Resume Time |
The time of day when the user resumed a paused task. |
Server Name |
The name of the Siebel Server where the task instance runs. |
Start Time |
The time of day that the user started this task instance. |
Status |
Displays the status. It can include one of the following values:
- Running
- Paused
- Stopped
- Completed
- In Error
If the Status is In Error, then Siebel CRM displays the font color for this task UI in red. |
Task Id |
A value that uniquely identifies a task UI or subtask. |
Task Name |
The value that Siebel Tools displays in the Display Name property for the task UI. |
|