Bookshelf Home | Contents | Index | PDF     

Siebel Business Process Framework: Task UI Guide > Testing, Troubleshooting, Deploying, and Administering a Task UI > Process of Testing a 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

  1. In the Siebel client, navigate to the Administration - Server Configuration screen, Servers, Components, and then the Events view.
  2. In the Components applet, choose the component you must trace.

    You can choose the following components:

    • Call Center Object Manager
    • Custom Application Object Manager
  3. To view the configurable event types for the component that you chose in Step 2, click the Events tab.

    Siebel CRM sets the log level to 1, by default.

  4. 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

  1. Open a command prompt.

    You can open the prompt from a directory on the Siebel Server.

  2. 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

Example of a Log File

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#frameBookmarkArray18#frameBookmarkArray1#4#size1#33#1#21#210#6#rowIds0#16#extraInformation0#14#ToggleSequence2#-111#columnNames0#11#InQueryMode1#013#SavedShowMode4#Edit9#frameName17#EnvironmentDetail16#RuntimeClassName19#CSSSWEFrameBookmark8#ShowMode4#Edit8#UniqueID1#30#1#11#110#6#rowIds0#16#extraInformation0#14#ToggleSequence2#-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

  1. Deploy the task UI.

    For more information, see Deploying and Migrating a Task UI.

  2. Open the Siebel client.
  3. Navigate to the Administration - Business Process screen, and then the Task Deployment view.
  4. 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

  1. Locate the task UI where you must collect property metrics.

    For more information, see Locating a Task UI in the Tasks List.

  2. In the Object Explorer, expand the Task tree, and then click Task Metric.
  3. 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.
  4. Deploy the task UI.

    For more information, see Deploying and Migrating a Task UI.

  5. Open the Siebel client.
  6. Navigate to the Administration - Business Process screen, and then the Task Deployment view.
  7. For testing purposes, set the Analytics Level field to All.

    This step turns on property metrics so Siebel CRM collects them at run time.

  8. 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

  9. 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

  1. Locate the task UI that you must modify.

    For more information, see Locating a Task UI in the Tasks List.

  2. 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 Using the Defer Write Record Property When You Disable Task Transaction.

To disable transaction at the business component level

  1. If necessary, display the Business Component User Prop object.

    For more information, see Displaying Object Types You Use to Develop a Task UI.

  2. In Siebel Tools, in the Object Explorer, click Business Component.
  3. In the Business Components list, query the Name property for the business component that is involved with the task transaction.
  4. In the Object Explorer, expand the Business Component tree, and then click Business Component User Prop.
  5. 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

  6. 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.

    
Siebel Business Process Framework: Task UI Guide Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.