Bookshelf Home | Contents | Index | Search | PDF

Siebel Remote and Replication Manager Administration Guide > Siebel Remote Reports >

Using the Outbox Analysis Report

---

The Outbox Analysis report is not an on-line report. It is created by a workflow process called Outbox Analysis Report Generator. It is available on all server nodes that have mobile users. This report is used to analyze the potential problems of data models, visibility rules, and router performance.

In this report, transactions in a mobile user's outbox are stored based on the target table name and the type of the operation. The tables that have the largest numbers of transactions are especially important to the outbox transaction analysis. This report provides information about the following for each pre-selected mobile user:

• Remote User Name
• Start time and end time of the transaction
• Top 20 transactions including target table names, database operation type, and the number of transactions

  The 12 database operation types reported are:

  • Insert: Insert a new record added to a table. This is different from Download, described below.
  • Delete: Delete a record from a table
  • Update: Update values of a record
  • Cascade: Bundled operation: Delete a record and multiple cascade operations because of the delete operation
  • MRUpdate: Multi-row update
  • MRDelete: Multi-row delete
  • Download: Record that becomes visible because of a visibility event. Previously the record was in the database, but not visible to the Mobile Web Client.
  • DORemove: Delete a dock object (records from all tables that made up an instance of a dock object) instance.
  • Sinset: Set-based insert (many rows at once)
  • Supdate: Set-based update
  • Sdelete: Set-based delete
  • Others: All other operations except the 11 operations listed above

To run the Outbox Analysis report

1. Modify the Outbox Analysis report configuration file based on the system setup and outbox analysis requirements.

   The location of the Outbox Analysis report configuration file (outboxreport.cfg) is siebsrvr\bin\$LANG\ where $LANG is the language setting of the Siebel server. For example, an English-language setting is $LANG=enu. Therefore outboxreport.cfg is in siebsrvr\bin\enu\.

   The report configuration file input parameters are:

   1. DataSource (Required field). The ODBC data source name.
   2. TableOwner (Required field). The table owner of the database.
   3. DockingDirectory (Required field). The location of the Siebel Remote docking directory. For example: siebsrvr\docking.
   4. NodeName (Required field).

      If there is only one mobile user's outbox to be analyzed, put that mobile user's login name here. For example: NodeName = BCOOK.

      If there are multiple users, a text file that contains the remote users' login names is required. For example, nodelist.txt with a list such as:

      BCOOK

      APARKER

      Use the @ and full path to designate the node list file. For example, NodeName=@d:\siebsrvr\docking\nodelist.txt.

   5. Repository (Required field). SIEBEL_REPOSITORY name.
   6. StartTime (Optional field). A time stamp indicates that only those transactions created at and after this time will be processed. If StartTime is not given, it will be set to 24 hours before the current time. The time is in format YYYY-MM-DD HH:MM:SS. For example, StartTime= 2002-6-10 14:20:00.
   7. EndTime (Optional field). A time stamp indicates that only transactions created at and before this time will be processed. If EndTime is not given, it will be set to the current time. The time is in format YYYY-MM-DD HH:MM:SS.
   8. Repeat (Optional field). Indicates whether the outbox transaction processing will stop at the current time or continue to EndTime— if EndTime is set to some time after current time. Can be Y or N, default is N.

      If Repeat is set to Y, and the EndTime is set to some time after current time, an outbox report will be generated every 24 hours until the EndTime is reached.

      The following is an example of an outboxreport.cfg file, which is used to analyze outbox transactions in the past 24 hours.

      DataSource = siebsrvr_datasource

      TableOwner = Siebel

      DockingDir = D:\siebsrvr\docking

      SiebelRepository = Siebel Repository

      ClientName = @D:\siebsrvr\docking\report\nodelist.txt

2. Navigate to Server Administration > Enterprise Operation > Component Requests, and click New.

   In the Component Job field, select Workflow Processor Manager.

   Complete the remaining fields as necessary for the particular request.

3. In the Component Request Parameters list, click New.
4. In the Component Request record, add the Workflow Process Name parameter as shown below.

   In the Name field, select Workflow Processor Name.

   In the Value field, select Outbox Analysis Report Generator.

5. In the Component Requests form menu, choose Submit request.
6. Navigate to siebsrvr > DOCKING > Report to read the generated report.

   The name of this report is report_<starttimemonth>_<starttimedate>.txt.

   For example, if the StartTime in outboxreport.cfg is set to April 9, the path to the report is siebsrvr\DOCKING\Report\report_4_9.txt.

   NOTE:  There are two ways to view the report from Siebel Remote Administration > Mobile Client Status:
   
   1. When using the Web client, report files must be manually copied to the report server machine to a folder <homedir>\docking\report. SIEBEL_ROOT environment variable should be set as <homedir>. If the Siebel_Root parameter is set to an absolute folder instead of the SIEBEL_ROOT environment variable in Actuate6\Server\rptsrvr.cfg, then report files should be copied to the docking\Report subdirectory in that folder.
   
   2. When using the dedicated Web client, siebel.exe must be started on the same machine where the Siebel Remote Server and the report files reside.

Bookshelf Home | Contents | Index | Search | PDF