9Testing, Troubleshooting, Deploying, and Administering a Task UI
Testing, Troubleshooting, Deploying, and Administering a Task UI
This chapter describes how to test, troubleshoot, deploy, and administer a task UI. It includes the following topics:
Process of Testing a Task UI
This process is a step in Roadmap for Developing a Task UI. To test a task UI, perform the following tasks:
Optional. Using the Task Debugger
Optional. Troubleshooting a Task UI
You must test a task UI before you deploy it. Testing a task UI verifies that the task UI you release to the production environment runs properly and does not cause conflicts with another existing task UI.
This topic also describes how to modify data that Siebel CRM collects during testing. For more information, see Modifying How Siebel CRM Logs Data During Testing.
Validating a Task UI
This task is a step in Process of Testing a Task UI.
The Validate tool in Siebel Tools is an error correction tool that you can use before you deploy a task UI. Validation enforces the semantic consistency of a task. For example, you can use validation to make sure an error process does not include an error process.
To validate a task UI
Locate the task UI you must validate.
For more information, see Locating a Task UI in the Tasks List.
Right-click the task UI in the Tasks list, and then choose Validate.
In the Validate dialog box, click Start.
Siebel Tools displays the following message in the lower corner of the Validate dialog box:
Starting validation
If your task contains an error, then Siebel Tools displays a warning that describes the error.
If Siebel Tools reports a problem after it finishes the validation, then use the information that it displays in the Errors window to help correct the error.
Validate the task UI until you resolve all errors. If the task contains no errors, then Siebel Tools displays the following message in the lower corner of the Validate dialog box:
Total tests failed: 0
Click Cancel to close the Validate dialog box and end the validation.
Errors That the Validate Tool Detects
This topic describes problems you might encounter when you use the Validate tool. To resolve the problem, look for it in the Symptom or Error Message column in the following table.
Table Errors That the Validate Tool Can Detect
| Symptom or Error Message | Solution |
|---|---|
Connector is not attached correctly. |
Make sure you correctly attach all connectors. |
Conditional branch is not defined for a Decision point. |
Make sure you define at least one conditional branch that emanates from each decision point in the task UI. |
Business service or business service method is not defined for a business service step. |
Make sure you define the Business Service Name and Business Service Method properties for each business service step in the task UI. |
Business component is missing from a Siebel operation step. |
Make sure you define the Business Component property for each Siebel operation step that the task UI contains. |
Name of the subtask is not defined for a subtask step. |
Make sure you define the Subtask Name property for each subtask step that the task UI contains. |
Using the Task Debugger
This task is a step in Process of Testing a Task UI.
The Task Debugger is a tool that you can run to test a task UI. You can use the Debug Mode in the Siebel client when you use the Task Debugger to do the same work that you expect the user to perform. The debugger allows you to read a watch window that displays values of various properties that are involved with the task UI. The debugger displays and modifies these values while you use the task UI.
Making the Debug Mode Available
You can step through the task UI in debug mode. Debug Mode is a restricted menu item that Siebel CRM displays on the Tools menu in the Siebel client. If the EnableRestrictedMenu parameter is set to:
TRUE. Siebel CRM displays the Debug Mode item.
FALSE. Siebel CRM does not display the Debug Mode menu item.
The procedure you perform depends on the type of Siebel client you use.
To make the debug mode available when using the Siebel Mobile Web Client
Use a text editor to open the configuration file (.cfg) for the Siebel application.
For example, to open the configuration file for Siebel Call Center, navigate to the following directory, and then open the uagent.cfg file:
D:\Siebel\81\21031\MWC\BIN\ENU
In the InfraUIFramework section, set the EnableRestrictedMenu parameter to TRUE.
For example:
EnableRestrictedMenu = TRUE
If EnableRestrictedMenu is not in the InfraUIFramework section, then add it.
Save your modifications, and then close the file.
Run the Task Debugger.
For more information, see Running the Task Debugger.
If the EnableRestrictedMenu parameter is set to something other than True or False, or if it is not defined in the InfraUIFramework section, then Siebel CRM does not display the Debug Mode menu item unless you possess access to the Admin - Restricted Menu Items view.
To make the debug mode available when using the Siebel Web Client
In the Siebel client, navigate to the Administration - Server Configuration screen, and then the Servers view.
In the Siebel Servers list, choose a Siebel Server.
Click the Components view tab.
In the Components list, query the Component field for the application object manager.
For example, query the Component field for the following text:
Call Center Object Manager (ENU)
Click the Parameters view tab 9 (which appears after the Components list).
In the Component Parameters list, query the Parameter field for EnableRestrictedMenu.
Set the value to True to enable debug mode.
Run the Task Debugger.
For more information, see Running the Task Debugger.
Running the Task Debugger
You can choose the Tools menu and then the Debug Mode menu item in the Siebel client to toggle the Debug Mode on or off. You can toggle this mode before, during, or after running a task UI.
To run the task debugger
Log in to the Siebel client.
Choose the Tools menu, and then the Debug Mode menu item.
To open the task pane, click the Open Task Pane icon.
Siebel CRM displays the Open Task Pane icon in the same row of icons where it displays the Site Map icon.
From the task pane, drill down on the task UI that you must debug.
Siebel CRM opens the task UI and then runs the start step of the task UI. It displays the Task Properties watch window for this task UI, including the properties for the step that it most recently run. It displays a line titled Last Action under the name of the task UI you are debugging. This line indicates the last navigation action that it performed. For example, Next.
Click Continue in the watch window.
Siebel CRM runs the next step in the task UI. For example, if the next step is a task view step, then it displays a task view.
To continue to run and debug the task UI, click one of the playbar buttons in the task view.
Repeat the previous two steps until you reach the end step.
Debugging ends when you reach the end step.
Optional. To end a debugging session before you reach the end step, you can do one of the following:
Click Stop in the watch window.
Click Cancel in a task view.
Verifying Functionality of a Task UI
This task is a step in Process of Testing a Task UI.
To finish testing for a task UI, you can verify that the task includes the functionality that is required to meet your business requirements. You run the task in the Siebel client, and then verify that the task functionality matches the functionality that you described during the planning phase. To view an example, see Verifying the Task UI.
Modifying How Siebel CRM Logs Data During Testing
This topic describes how to modify the way that Siebel CRM logs data during testing. It includes the following topics:
Using Logging on the Siebel Server
Event logging provides a convenient, nonintrusive way to trace components that require further examination. Similar to Siebel Workflow, Siebel Task UI provides for tracing through event logging. You set trace levels on a server component to turn on logging on the Siebel Server.
To use logging on the Siebel Server
In the Siebel client, navigate to the Administration - Server Configuration screen, Servers, Components, and then the Events view.
In the Components applet, choose the component you must trace.
You can choose the following components:
Call Center Object Manager
Custom Application Object Manager
To view the configurable event types for the component that you chose in the previous step, click the Events tab.
Siebel CRM sets the log level to 1, by default.
Modify the value of the log level to 3, 4, or 5.
For more information, see About Event Logging.
You can increase the tracing level for the following events to increase the number of entries that Siebel CRM logs:
Task UI Object Manager Log
Task UI Conflict Log
Task UI Union Sql Log
If you increase the Component Event Configuration Log Level value, then Siebel CRM creates more tracing information. For more information, see Siebel System Monitoring and Diagnostics Guide.
Setting Log Levels on the Siebel Client
You can set the log level of the Siebel client.
To set log levels on the Siebel client
Open a command prompt.
You can open the prompt from a directory on the Siebel Server.
Set the SIEBEL_LOG_EVENTS environment variable.
For example, set the logging level for the following log events:
Set the TskNav log event to 3
Set the TskExec log event to 3
Set the StpExec log event to 4
Set the TskPresInfo log event to 4
You run the following command for this example from a command prompt:
set SIEBEL_LOG_EVENTS = TskNav =3, TskExec=3, StpExec=4, TskPresInfo=4
This following file is an example of a log file that displays information about the TskExec, TskNav, and TskPresInfo log events:
TskExec TskState 3 0000000243fc1350:0 2006-02-22 23:49:49 Task state transition changes : Action invoked: 'Navigate', Current State: 'Navigate', Next State: 'Navigate'. TskNav Oper 3 0000000243fc1350:0 2006-02-22 23:49:49 Task engine requested to navigate to next view. TskNav Oper 3 0000000243fc1350:0 2006-02-22 23:49:49 Task engine requested to navigate to next step: 'Task View 1'. TskNav PathChange 3 0000000243fc1350:0 2006-02-22 23:49:49 Pushing frame to stack : '1*05*Start0*1*00*'. TskNav PathChange 3 0000000243fc1350:0 2006-02-22 23:49:49 Pushing frame to stack : '1*011*Task View 03011*8#Bookmark4#8#viewName21#EnvironmentDetailView6#bAdmin1#06#viewId0#14#bIgnoreContext1#03#18#frameBo okmarkArray18#frameBookmarkArray1#4#size1#33#1#21#210#6#rowIds0#16#extraInformation0#14#ToggleSequence2#- 111#columnNames0#11#InQueryMode1#013#SavedShowMode4#Edit9#frameName17#EnvironmentDetail16#RuntimeClassNam e19#CSSSWEFrameBookmark8#ShowMode4#Edit8#UniqueID1#30#1#11#110#6#rowIds0#16#extraInformation0#14#ToggleSe quence2#-111#columnNames0#11#InQueryMode1#013#SavedShowMode4#Base9#frameName28#Task Playbar Applet - TskPresInfo ViewInfo 3 0000000243fc1350:0 2006-02-22 23:49:49 Task presentation view info (0) : TYPE = WfTaskViewInfo TskPresInfo ViewInfo 3 0000000243fc1350:0 2006-02-22 23:49:49 Task presentation view info (0) : ViewName = RequiredFieldView TskPresInfo ViewInfo 3 0000000243fc1350:0 2006-02-22 23:49:49 Task presentation view info (0) : child count = 0TskPresInfo ViewInfo 0000000243fc1350:0 2006-02-22 23:49:49 Task presentation view info (0) : child count = 0 TskPresInfo ViewInfo 3 0000000243fc1350:0 2006-02-22 23:49:49 Task presentation view info (1) : TYPE = WfTaskPlaybarInfo TskPresInfo ViewInfo 3 0000000243fc1350:0 2006-02-22 23:49:49 Task presentation view info (1) : Submit = HIDDEN TskPresInfo ViewInfo 3 0000000243fc1350:0 2006-02-22 23:49:49 Task presentation view info (1) : Next = ENABLED TskPresInfo ViewInfo 3 0000000243fc1350:0 2006-02-22 23:49:49 Task presentation view info (1) : Prev = ENABLED TskPresInfo ViewInfo 3 0000000243fc1350:0 2006-02-22 23:49:49 Task presentation view info (1) : Pause = ENABLED TskPresInfo ViewInfo 3 0000000243fc1350:0 2006-02-22 23:49:49 Task presentation view info (1) : Cancel = ENABLED
Collecting Timestamp Metrics of a Task UI
You can configure Siebel CRM to collect timestamp metrics after you deploy the task UI. For more information, see About Task Metrics.
To collect timestamp metrics of a task UI
Deploy the task UI.
For more information, see Deploying and Migrating a Task UI.
Open the Siebel client.
Navigate to the Administration - Business Process screen, and then the Task Deployment view.
Set the Analytics Level field to one of the following values:
Timestamp
All
These values allow Siebel CRM to collect timestamp metrics at run time.
Collecting Property Metrics of a Task UI
You can configure Siebel CRM to collect property metrics of a task UI after you deploy it. For more information, see About Task Metrics.
To collect property metrics of a task UI
Locate the task UI where you must collect property metrics.
For more information, see Locating a Task UI in the Tasks List.
In the Object Explorer, expand the Task tree, and then click Task Metric.
In the Task Metrics list, create a new task metric, using values from the following table.
Property Description Metric Name
Choose the required metric from the list of predefined metric names.
Property Name
Choose a task property from the list of properties that are defined for the task UI. Siebel Tools sets the run-time value of the metric to the run-time value of the task property that Siebel CRM references. You modify the value only for customizable metrics, and not for system metrics, whose values are set by Siebel Task UI.
Inactive
Choose FALSE.
The option in the Inactive column does not include a check mark, by default. It allows you to turn off a metric and turn it on later.
Deploy the task UI.
For more information, see Deploying and Migrating a Task UI.
Open the Siebel client.
Navigate to the Administration - Business Process screen, and then the Task Deployment view.
For testing purposes, set the Analytics Level field to All.
This step turns on property metrics so Siebel CRM collects them at run time.
Run the task UI at least one time, and then query the tables where Siebel CRM stores the data.
For example, enter the following query:
select s.row_id, s.flow_name, s.PARENT_FLOW_NAME, s.ROOT_FLOW_NAME, s.FLOW_INST_ID_VAL, s.flow_type_cd, s.created from siebel.s_wfa_anly_info as s
Optional. Use DML to modify the stored data.
For example, to delete a record, enter the following query:
delete from siebel.s_wfa_anly_info
Disabling Task Transactions
In some testing situations it might be beneficial to temporarily disable transactions for a task UI. You can disable task transactions at the business component level and at the task UI level.
For more information, see About Task Transaction.
To disable transactions at the task level
Locate the task UI that you must modify.
For more information, see Locating a Task UI in the Tasks List.
Set the Transactional property to FALSE.
Caution: Disabling task transaction can result in unpredictable behavior. You must thoroughly test disabling task transaction before you use it in a production environment.If you set the Transactional property to FALSE, then task transaction is off. Siebel CRM immediately saves to the base tables any updates that occur on business components that the task UI references. For more information, see Disabling Task Transactions.
To disable transaction at the business component level
If necessary, display the Business Component User Prop object.
For more information, see Displaying Object Types You Use to Develop a Task UI.
In Siebel Tools, in the Object Explorer, click Business Component.
In the Business Components list, query the Name property for the business component that is involved with the task transaction.
In the Object Explorer, expand the Business Component tree, and then click Business Component User Prop.
In the Business Component User Properties list, query the Name property for Immediate Commit In Task.
You can do the following to view the predefined business components that include an Immediate Commit In Task user property:
In the Object Explorer, click the Flat tab.
In the Object Explorer, click Business Component User Prop.
In the Business Component User Properties list, query the Name property for the following string:
Immediate Commit In Task
Set the value property to TRUE.
If the Value property for the Immediate Commit In Task user property is TRUE, then Siebel CRM turns off task transaction, and it immediately saves to the base tables any updates that occur on the business components that the task UI references. For a business component to be part of the task transaction, the task transaction must be turned on at the business component level and at the task level. For more information, see Using the Defer Write Record Property When You Disable Task Transaction.
Using the Defer Write Record Property When You Disable Task Transaction
If you set the Immediate Commit In Task business component user property to TRUE, and if a Siebel operation step references the business component where this property resides, and if the Operation property for this Siebel operation step is set to Insert, then do not set the Defer Write Record property in this Siebel operation step to TRUE. This requirement applies to any Siebel operation step in any task UI.
If you set the Transactional property for a task UI to FALSE, and if this task includes a Siebel operation step, and if the Operation property for this step is set to Insert, then do not set the Defer Write Record property for this Siebel operation step to TRUE. This requirement applies to any Siebel operation step in this task UI.
For more information, see About the Defer Write Record Property.
Troubleshooting a Task UI
This topic describes how to troubleshoot problems that you might encounter when you develop a task UI. It includes the following topics:
Task UI Does Not Display in the Task Pane
If Siebel CRM does not display your task UI in the task pane, then do the following work:
Make sure you add the responsibility that you assign to the user to the task UI. For more information, see Adding a Responsibility to a Task UI.
Make sure the task UI references a view task group. Siebel CRM displays a task group that the the Task Pane View references before it displays a view that is specific to a task group that it arranges sequentially. For more information, see Creating a Task Group.
Make sure the view task group references one of the following items:
The current standard view in the current application
The Task Pane View
For more information, see Adding a Task Group to a View.
Make sure the parent task group references a view.
Make sure object definitions exist in the repository for the following items:
Task UI
Task group
Metadata
Make sure you compile the objects that your task UI references to the SRF (Siebel Repository File). Example objects include the task applet, business component, and so on. For more information, see Preparing to Publish a Task UI.
Make sure the following is true:
You publish the task UI to the current run-time database.
This publication includes an activation date that has passed or is not defined.
This publication includes an expiration date that has not passed or is not defined.
For more information, see Publishing a Task UI.
Make sure you properly defined the Context Business Component property. For more information, see Using a Context Business Component with a Task Group.
Make sure you define the task UI as a task that is running in a Siebel application. For example, Call Center. For more information, see Adding a Task Group to a View.
Record Context Is Lost
If Siebel CRM loses the record context while the user navigates between views, even though no Query operation exists, then you must make sure the following items are true:
The search specifications across views are consistent.
The search specifications for the view step match.
Inconsistent Search Specifications Across Views
If all of the following situations exist, then Siebel CRM repeats a search:
The first view includes an applet search specification or a view search specification, but the second view does not include either of these search specifications.
The Retain Applet Search Spec property or the Retain View Search Spec property is set to FALSE.
The Retain Applet Search Spec property or the Retain View Search Spec property is set to FALSE, so Siebel CRM repeats the search, and then it loses the record context. The second view is supposed to display data from the business component without the constraint that the search specification of the first view imposes.
You must configure Siebel CRM to retain the search specification to avoid this situation. To do this, you set the Retain Applet Search Spec property or the Retain View Search Spec property to TRUE.
Guidelines for Defining a Search Specification
To more clearly define the scope of the search specification, it is recommended that you set the constraint for a search specification on the business component or on the view step rather than on the applet. Note the following situations:
A search specification on a business component applies throughout the task UI.
A search specification on a view step applies only for the step where you define it.
A search specification on a view step applies until Siebel CRM runs the next task UI step, depending on the value of the Retain View Search Spec property.
Specialized Code That Starts a Task UI Might Cause a Loss of Context
If any of the following situations apply, then specialized code might start a task UI and can cause a loss of record context:
The steps include an identical applet.
The steps include identical search specifications.
The Retain Applet Search Spec property is TRUE.
The Retain View Search Spec property is TRUE.
Repeat runs of the task UI occur.
To debug this situation, you can perform the following work:
Use logging with the ObjMgrSqlLog event set to 5 to inspect the search specification that Siebel CRM uses for each SQL statement.
Review your log for the CSSSqlObj::InvalidateSQLCursor call.
Determine if performing this call creates an error.
Build View Errors Occur with Task UI
The following build view errors might occur if the user navigates through a task UI, and if the mode for this task UI is set to In Task UI:
Siebel CRM does not delete the previous view so an active view still exists. In this situation, Siebel CRM displays a dialog box in the Siebel client. You can dismiss the message, correct the problem, and then try to navigate or cancel the task UI.
Siebel CRM deletes the previous view, so no active view is available. In this situation, Siebel CRM displays an HTML page in the Siebel client that describes the error.
Troubleshooting Other Errors
This topic describes problems you might encounter when you develop a task UI. To resolve the problem, look for it in the Symptom or Error Message column in the following table. For more information, see Overview of Transient Data.
Table Other Problems That Can Occur When You Develop a Task UI
| Symptom or Error Message | Solution |
|---|---|
A text field does not display properly when a task UI runs. The task UI uses a transient business component with this text field. |
Modify the property of the field to Text. The default is RadioButton. |
You cannot find a transient business component in the Business Component property of a task step. |
Add the transient business component to the corresponding business object:
|
Siebel CRM does not display a Task applet while you define a view. |
Choose the task UI that Siebel CRM links to the applet. |
A task step includes a forward button type of Submit. |
Choose a view step and modify the type to Submit. For more information, see Validation with Forward Navigation in the Task Playbar. |
Siebel CRM does not list a task UI in the Application - Administration screen, Tasks view. |
Publish and activate the task UI. |
A transient business component is missing when a task UI runs. |
Add the transient business component to the corresponding business object:
|
The Siebel client does not display views or applets that you defined. |
Do the following work:
|
Siebel CRM does not display the name of the task group in the task pane. |
Define a display name, and then update the display name in the task group. |
Siebel CRM does not display the task group in the task pane. |
Make sure you add the task group to the standard UI. |
Siebel CRM does not display the task UI in the task group. |
Add the task UI to the task group, and then compile your modifications. |
Siebel CRM does not display the task group or the name of the task UI in the standard UI. |
Compile the standard UI that contains the objects. |
Siebel CRM does not display chapter definitions. |
For more information, see Creating a Task Chapter. |
Siebel CRM does not display a view name. |
Define a display name and update the display name in the view. |
Siebel CRM displays an error that indicates that a required field includes no data. |
Set the Defer Write Record property on the Siebel operation step to TRUE. For more information, see About the Defer Write Record Property. |
A condition does not include a condition that matches a run-time value. |
For more information, see Creating a Branch Connector. |
Deploying and Migrating a Task UI
This topic describes how to deploy and migrate a task UI. It includes the following topics:
Process of Deploying a Task UI
This process is a step in Roadmap for Developing a Task UI.
To deploy a task UI, perform the following tasks:
A deployed task is a task UI that is published and activated. You create a task UI in your development environment, and then you deploy it to a testing or production environment. You can use Siebel Tools to publish the task and then activate it in the Siebel client. This process deploys task objects from the SRF (Siebel Repository File) to the run-time environment.
As an alternative, you can publish and activate a task UI in Siebel Tools. For more information, see Publishing and Activating a Task UI in Siebel Tools.
Preparing to Publish a Task UI
You must compile the SRF before you publish a task UI. If you add or modify repository objects that are part of the task UI or that this task references, then you must compile the SRF. Example objects in the SRF that the task might require include business components, business services, and views.
To prepare to publish a task UI
Validate the task UI.
For more information, see Validating a Task UI.
Compile modified objects:
In Siebel Tools, choose the Tools menu, and then the Compile Projects menu item.
In the Object Compiler dialog box, click Locked Projects, and then click Compile.
Publishing a Task UI
Publishing a task UI makes the task visible in the Siebel client. Siebel CRM reads the object definition of the task UI from the SRF when you publish it, and then writes the definition and deployment parameters in XML format to the run-time environment. If your task UI includes a subtask step, then you must publish the subtask first so that the subtask is available to the parent task UI in the run-time environment.
To publish a task UI
Locate the task UI you must modify.
For more information, see Locating a Task UI in the Tasks List.
Make sure the status property is In Progress.
On the WF/Task Editor toolbar, click the Publish icon.
For more information, see Using the WF/Task Editor Toolbar.
If you click Publish, then Siebel Tools prompts you to validate your task or to continue.
Click Yes to continue.
Make sure the status property is Completed.
If Siebel Tools modifies the status from In Progress to Completed, then the task UI is available in the Siebel client.
Activating a Task UI
This topic describes how to activate a task UI.
To activate a task UI
Log in to the Siebel Client.
Navigate to the Administration - Business Process screen, and then the Task Deployment view.
The Published Tasks list displays task UIs that are published from the repository tables. If you revise and publish a task UI, then Siebel CRM increments the repository version of the task. If you click the task name link, then Siebel CRM displays the child items of the task. These child items are the object definitions of the published task.
In the Published Tasks list, query the Name field for the task UI you must activate.
In the Published Tasks list, click Activate.
Siebel CRM validates the format, and then modifies the deployment status of the task UI to Active. For more information, see the following section.
Verify that the Deployment Status field of the Active Tasks list displays a value of Active for the task UI that you activated previously.
Optional. In the Active Tasks list, define deployment parameters for the task UI:
In the Activation Date/Time field, set the activation date.
It is not necessary to set an activation date or an expiration date. If you leave these fields empty, then the task UI is active and does not expire.
In the Expiration Date/Time field, set the expiration date.
Set the replication to None, unless you are deploying the task UI to a Siebel Mobile Web Client.
If you are deploying the task UI to a Siebel Mobile Web Client, then see Replicating a Task UI to the Siebel Mobile Web Client.
About the Deployment Status
If the deployment status of the previous active version of a task UI exists when you activate a task, then Siebel CRM modifies the deployment status to Outdated. You can view this modification in the Active Tasks applet that Siebel CRM displays in the lower portion of the Task Deployment screen.
The deployment status of a deployed task can include one of the following values:
Active. A task UI that is active is the basis for a new task instance. Only one active version of a task with a specific name can exist.
Outdated. A task instance that is already in progress or that is in the inbox can continue to use the outdated object definition. A new instance does not use the outdated definition.
Inactive. If a task UI is inactive, then no new or paused task instance can use the inactive definition.
Adding a Responsibility to a Task UI
You publish and activate a task UI, specify the responsibilities that can run it, and then define the access rights that Siebel CRM must include in these responsibilities in the inbox. The Registered Task Administration view allows you to determine if a user can run, transfer, or delete a task UI. You must add the responsibility that Siebel CRM assigns to the user to the registered task so that this user can access this task UI.
If a user possesses the privileges that Siebel CRM requires to run a task UI, then this user also possesses the privileges required to access the views that this task UI uses.
You administer access control for a task UI in a way that is similar to how you administer access control for a view.
For more information, see Siebel Security Guide.
To add a responsibility to a task UI
Log in to the Siebel client.
Register the task UI:
Navigate to the Administration - Application screen, and then the Tasks view.
In the Registered Tasks list, click New.
In the Task Name field, choose the task UI that you must register, and then click OK.
Siebel CRM displays a list that includes deployed tasks. For more information, see Process of Deploying a Task UI.
Add a responsibility to the task UI you registered in the previous step:
Make sure the task UI you registered in the previous step is still chosen in the Registered Tasks list.
-
In the Responsibilities list, click New.
In the Tasks dialog box, query for the responsibility that must include access to the task UI, and then click OK.
If you typically log in with administrator privileges, then, for testing purposes, add the Siebel Administrator responsibility.
- In the Responsibilities list, make sure each of the following fields include a check mark:
Allow Delete. Allows the user to delete a paused task UI that Siebel CRM displays in the Universal Inbox.
Allow Transfer. Allows the user to transfer a paused task.
The default value for each of these properties includes a check mark. For more information, see Resuming a Paused Task UI, and Universal Inbox.
In the Registered Tasks list, click Clear Cache.
Log out of the Siebel client.
Publishing and Activating a Task UI in Siebel Tools
You can publish and activate a task UI in Siebel Tools instead of publishing it in Siebel Tools and then activating it in the Siebel client. For more information, see Process of Deploying a Task UI.
To publish and activate a task UI in Siebel Tools
Validate the task UI.
For more information, see Validating a Task UI.
Compile locked projects.
For more information, see Preparing to Publish a Task UI.
To publish and activate the task UI, do the following:
Make sure the latest version of the task UI you are publishing is chosen in the Tasks list.
In the WF/Task Editor Toolbar, choose the Publish/Activate button.
For more information, see Using the WF/Task Editor Toolbar.
Do not set the optional fields.
Optional. For testing purposes, add the Siebel Administrator responsibility to the task UI.
For more information, see Adding a Responsibility to a Task UI.
If the Siebel client is open, then clear the cache, and then log out of the Siebel client.
Migrating a Task UI
This topic is a step in Roadmap for Developing a Task UI.
Migration is the process of moving object definitions between environments. For example:
Between a development environment and a test environment
Between a test environment and a production environment
This topic describes deployment and migration options that are available with a task UI. Deployment and migration options for a task UI are similar to the deployment and migration options that are available for a workflow process. For more information, see Siebel Business Process Framework: Workflow Guide.
Before you migrate data, make sure the data that the task UI requires exists in the target environment. For example, if the task UI requires custom entries in the List Of Values (LOV) table, then make sure these entries exist and are active.
To migrate a task UI
Choose the migration option that most closely meets your requirements.
For more information, see Comparison of Migration Options.
Do the migration.
For more information, see the relevant documentation for the migration option you chose in the previous step.
Comparison of Migration Options
The following table compares options for migrating a task UI.
Table Comparison of Options for Migrating a Task UI
| Migration Option | Description |
|---|---|
Application Deployment Manager (ADM) |
Use ADM in the following situations:
ADM is a tool that streamlines the process of deploying enterprise customization data, such as views, responsibilities, assignment rules, tasks, and workflow processes. A task deployment package in ADM includes the Siebel Repository File (SRF), tasks, subtasks, and their run-time settings, such as activation and expiration times. For more information, see Siebel Application Deployment Manager Guide. |
Repository Import and Export (REPIMEXP) |
Use REPIMEXP in the following situations:
REPIMEXP is a manual process that you can use for repository migration. You can use it to migrate repository objects in bulk, including object definitions for a task UI. REPIMEXP is a command line utility that resides in the BIN directory of your Siebel installation. Enter the following command in a command prompt to view usage options: repimexp /help If you use REPIMEXP, then you cannot pick and choose the task UIs to migrate. You can use one of the other migration options to migrate a single task UI or to migrate only some task UIs. |
Import and export |
Use import and export in the following situations:
In Siebel Tools, you can export objects from the SRF to an archive file (SIF), and then import objects from the archive file back to the SRF. You can include individual objects or entire projects in an archive file. Example individual objects include business components, applets, views, and task UIs. For more information, see Using Siebel Tools. |
Publish |
For more information, see Publishing a Task UI. |
Replicating a Task UI to the Siebel Mobile Web Client
This topic describes how to configure a task UI to run on a Siebel Mobile Web Client that can run with a regional database or a local database. The Inbox screen is visible in the Siebel Mobile Web Client. Siebel CRM does the following, by default:
Replicates to the Siebel Mobile Web Client a task UI inbox item that the user creates on the Siebel Server.
Replicates to the Siebel Server a task UI inbox item that the user creates on the Siebel Mobile Web Client.
Does not automatically replicate to the Siebel Mobile Web Client any object definitions for a task UI that reside in the SRF (Siebel Repository File).
To replicate a task UI to the Siebel Mobile Web Client
In the Siebel client, navigate to the Administration - Workflow Process screen, Task Deployment, and then the Published Task view.
In the Active Tasks list, query the Name field for the task deployment record that you must replicate.
For example, search for the name of the task UI.
Modify the Replication field of the task deployment record according to the following requirements:
To Regional for a Siebel Mobile Web Client that connects only to a regional database
To All for a Siebel Mobile Web Client that connects to a regional or a local database
How Siebel CRM Runs a Task UI Across Nodes
A run-time instance of a task UI is the underlying object of a task UI inbox item. Siebel CRM does not replicate a task run-time instance between the Siebel Server and the Siebel Mobile Web Client. A user can run a task inbox item only on the same node where Siebel CRM creates this task inbox item. For example, if the node is a server, then the user can only run the instance from this Siebel Server. If the user attempts to run a task UI inbox item from an incorrect node, then Siebel CRM returns an error.
Siebel CRM allows a task transfer only between users that reside on the same node. A user can transfer a task inbox item that Siebel CRM creates on the Siebel Server or regional node to other users that reside on the same server or regional node. If a user creates a task inbox item while using a Siebel Mobile Web Client, and if the user connects this client to a local database during login, then Siebel CRM cannot transfer this task inbox item.
Setting Synchronization Interval for a Task UI
You can set the synchronization interval for a task UI that Siebel CRM replicates to the Siebel Mobile Web Client to manage how frequently Siebel CRM does synchronization. For more information, see Siebel Remote and Replication Manager Administration Guide.
Administering a Task UI
This topic describes how to administer a task UI. It includes the following topics:
This topic is a step in Roadmap for Developing 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 the previous step.
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 previously.
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 lower applet.
Siebel CRM displays information about process properties in the lower applet. The step you choose in the Task Step Instances list references these process properties.
Monitoring Levels of the Task Instance Monitor
The following table 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 Monitoring Levels You Can Set in the Task Instance Monitor
| Monitoring Level | Description |
|---|---|
None |
Siebel CRM does not display a new record for any task instance in any of the following views:
|
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:
|
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 the relevant step in Using the Task Instance Monitor. |
Debug |
Displays the same information as the Detail monitoring level. |
Fields That Siebel CRM Displays in the Task Instance Monitor
The following table describes fields that Siebel CRM displays in the Task Instance Monitor.
Table Fields That Siebel CRM Displays in the Task Instance Monitor
| Field | Description |
|---|---|
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:
If the Status is In Error, then Siebel CRM displays this task UI in a different font color (that is, 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. |
Using Task Reports
You can create a task report that includes historical information about completed task instances. It can include information from fields that Siebel CRM displays in the Task Instance Monitor, such as Start Time, End Time, and so on. For more information, see Fields That Siebel CRM Displays in the Task Instance Monitor.
You can use task reports in the Siebel client. Siebel CRM includes a report record even if the user cancels or stops a task instance. For example, if the user cancels a task instance, then Siebel CRM includes information about all task steps that the user completed.
To use task reports
Make sure the file system includes an att folder.
For example:
\machine\fs\att
Siebel CRM uses this att folder to create a report.
Set the monitoring level and then run the task UI.
For more information, see Using the Task Instance Monitor.
Log in to the Siebel client with administrator privileges.
Navigate to the Administration - Business Process screen, and then the Task Reports view.
Click the following Reports icon:
Choose one of the following output formats for the report:
Task Report - MHTML
Task Report - PDF
Task Report - PPT
Task Report - RTF
In the File Download dialog box, choose one of the following options:
Open. Siebel CRM opens the report in a separate window according to the output format you choose in the previous step. For example, if you choose PDF, then Siebel CRM uses the program that you configure your computer to use to open a PDF file.
Save. Siebel CRM saves the report to a location that you specify.
Allowing Task Transfer
Siebel CRM allows a user to transfer a task UI to another user, by default. If you configure Siebel CRM to not allow a task transfer, then it makes the owner field read-only and disables the Transfer button for the current task item that it displays in the Inbox Items List view.
To allow task transfer
Log in to the Siebel client with administrator privileges.
Navigate to the Administration - Application screen, and then the Tasks view.
In the Registered Tasks list, choose the task UI where you must control task transfer.
In the Responsibilities list, choose the responsibility where you must allow task transfer, and then make sure the Allow Transfer option includes a check mark.
To disable task transfer, make sure the Allow Transfer option does not include a check mark.
Step off the record to save your modifications.
Transferring a Task Instance
The owner of a task instance can use the Universal Inbox to transfer a task UI.
Siebel CRM constrains the list of users that the user can choose to transfer a task instance. It constrains this list to users whose responsibility is added for the task. For more information, see Adding a Responsibility to a Task UI.
To transfer a task instance
In the Siebel client, navigate to the Inbox screen, and then the Inbox Items List view.
Choose the task UI you must transfer.
Make sure the Transfer button is available.
If Siebel CRM disables the Transfer button, then you cannot transfer this task instance.
Click Transfer.
Siebel CRM displays the Transfer To dialog box.
In the Owner field, choose the owner to whom you must transfer the task instance.
In the Comments field, enter a reason for the transfer.
Click OK, and then refresh the screen.
Siebel CRM does the following:
Closes the pop-up applet
Removes the task instance from your inbox
Displays the task instance in the inbox of the new owner
Enters a check mark in the Completed field in your My Inbox Items list
Adds the task instance to your My Completed Items list
Deactivating a Deployed Task UI
This topic describes how to deactivate a task UI that you deployed to the Siebel client.
To deactivate a deployed task UI
In the Siebel Client, navigate to the Administration - Business Process screen, and then the Task Deployment view.
In the Active Tasks list, query the Name field for the task UI you must deactivate.
Choose the task UI, and then click Deactivate Task.
Siebel CRM modifies the deployment status of the task UI to Inactive.
Deleting a Deployed Task UI
This topic describes how to delete a task UI that you deployed to the Siebel client.
To delete a deployed task UI
In the Siebel Client, navigate to the Administration - Business Process screen, and then the Task Deployment view.
In the Active Tasks list, query the Name field for the task UI you must delete.
Click the task UI, and then click Delete Task.
Caution: Deleting a deployed task UI affects running instances of this task and might corrupt data. If you must delete a deployed task UI, then it is recommended that you deactivate the task first, and then delete it. For more information, see Deactivating a Deployed Task UI.
Deleting a Task Instance From the Inbox
You can delete a task instance from the inbox.
To delete a task instance from the inbox
In the Siebel client, navigate to the Administration - Application screen, and then the Tasks view.
Choose the task UI that you must delete.
Make sure the Allow Delete option includes a check mark.
Step off the record to save your modifications.
Navigate to the Inbox screen, and then the Inbox Items List view.
Choose the task UI that you must delete.
Click the Detail tab, and then click Delete.
Siebel CRM removes the task instance from the inbox.
Removing Temporary Data After a Task UI Finishes
Siebel CRM stores temporary data for a task instance in the S_TU_LOG table. The user finishes a task instance, and then the Siebel Object Manager clears the temporary data. This behavior varies depending on the following data source where the user connects:
Server. For performance reasons, a batch process runs every five minutes that deletes used records from the S_TU_LOG table.
Local. Deletes rows from the S_TU_LOG table as soon as the user finishes the task instance.
Sample. Never deletes rows from the S_TU_LOG table.
You can run the Task Log Cleanup Service business service to manually delete temporary data that Siebel CRM stores for a finished task instance. This service allows you to specify when Siebel CRM deletes temporary data rather than performing the delete at a predefined interval.
For more information, see Transparent Storage.
To remove temporary data after a task UI finishes
Add a business service step to your task UI immediately after a commit step. Use values from the following table.
Property Value Business Service Name
Task Log Cleanup Service
Business Service Method
CleanTaskLog
Optional. Define the Task Id input argument for the business service that you added in the previous step.
Siebel CRM does the following:
If you specify a value for the Task Id input argument, then Siebel CRM deletes only temporary data for the task UI that the Task Id identifies.
If you do not specify a value, then Siebel CRM deletes all expired rows from the S_TU_LOG table.
Configuring Siebel CRM to Resolve Task Transaction Conflicts
This topic describes how to configure Siebel CRM to resolve task transaction conflicts. For more information, see About Task Transaction.
Configuring Siebel CRM to Resolve Duplicate Conflicts
This topic describes how to configure Siebel CRM to resolve duplicate conflicts. A duplicate conflict is a type of conflict that occurs when a unique key violation exists in the RDBMS during a commit.
To configure Siebel CRM to resolve duplicate conflicts
Open Siebel Tools.
Display the Business Component User Property object type.
For more information, see Displaying Object Types You Use to Develop a Task UI.
In the Object Explorer, click Business Component.
In the Business Components list, locate the business component you must modify.
In the Object Explorer, expand the Business Component tree, and then click Business Component User Prop.
In the Business Component User Properties list, add a new record using values from the following table.
Name Description Dup Conflict In Task
Enter one of the following values:
Resolve. Siebel CRM writes the duplicate record with the Conflict Id field set to the value of Id, by default.
Fail. Siebel CRM stops the task transaction.
Ignore new record. Siebel CRM skips the duplicate record but saves the rest of the task transaction.
Configuring Siebel CRM to Resolve Update and Delete Conflicts
You can configure Siebel CRM to resolve the following types of conflicts:
Update conflict. Occurs if Siebel CRM modifies the same record inside and outside of the task transaction. Similar to the standard UI, Siebel CRM detects the update conflict according to the Modification Id system field.
Delete conflict. Caused by one of the following reasons:
Siebel CRM deletes a record in a task transaction, and then updates this record outside the task transaction.
Siebel CRM updates a record in a task transaction, and then deletes this record outside the task transaction.
Siebel CRM detects an update conflict or a delete conflict in the following situations:
When it gets data in the task transaction
During a commit
To configure Siebel CRM to resolve update and delete conflicts
Create a task property using values from the following table.
Property Description On Conflict
Use one of the following values:
Continue operation. Siebel CRM overwrites modifications that the user saves outside of the task transaction with modifications that the user makes in the task transaction. If the user deletes the record outside of the task transaction, then Siebel CRM returns an error message.
Cancel operation. Siebel CRM displays an error message that describes the conflict. Data that resides in conflicting fields in the task transaction are lost. The user must manually reenter values in the fields to resolve this conflict.
For more information, Creating a Task Property.