Adding data fields with the Data Field Wizard

You can add data fields to the Case Analyzer store. Data fields that are added for case management activities are stored in the Content Platform Engine. Case Analyzer retrieves case data from the Content Platform Engine and places them in the Case Analyzer store for generating OLAP cubes and fact tables.

About this task

The changes that you make here are not reflected in reports until the next time the underlying cubes are processed. The work-in-progress cubes are processed based on the publishing interval. In addition, the historical and work-in-progress cubes are processed daily based on the schedule that you set. You can wait for the next scheduled processing, or you can process the cubes manually. For more information, see Processing the Case Analyzer cubes.

Alternatively, you can import one or more data fields from a text file. For more information, see Importing data fields.

Procedure

To add a data field by using the Data Field Wizard:

  1. Stop Case Analyzer if it is running.
  2. To add a field, select the Data Fields folder, and from the Action menu select New. To modify an existing data field, select the data field, and from the Action menu select Edit.
  3. From the Select a method for configuring the data field window, choose the Content Platform Engine to browse for data fields.
  4. When you select Browse Content Platform Engine to Select Data Fields, a window opens to display a list of available connection points. Select the appropriate connection point from the list.
  5. From the Field list, select a field. Select the Show system fields check box to display available system fields in the Field list, or clear Show system fields to display user-defined fields in the Field list.
    A list of fields is displayed. Depending on the source that you chose, the list includes these fields:
    • Fields in the Content Platform Engine event log of the current isolated region
    • Fields in the audit log of the IBM® Case Manager target object store
    Important: The maximum length of a Case Analyzer data field value is 64 characters. Longer event log and audit log fields are truncated at 64 characters.
  6. In the Unique Name field, enter a name for this data field. The name for the data field can be different from the name of the data field on the Content Platform Engine. However, the name must be unique among all exposed data fields on Case Analyzer.

    The name that you enter cannot be longer than 128 characters, must begin with a letter, and contain only letters, numbers, or underscores.

    You cannot use a name that is used internally by the Case Analyzer Engine. The following names are reserved:

    Table 1. Reserved names for Case Analyzer data fields
    Reserved name Reserved name Reserved name
    Average Age Days Avg. Wait Min Current Route Percentage
    Average Age Hours Avg. Wait Time Days Status
    Average Age Minutes Avg. Wait Time Hours User
    Average Completion Time Days Avg. Wait Time Minutes Time
    Average Completion Time Hours Case Task
    Average Completion Time Minutes Case Count Task Count
    Average Days in Current Step Case In Progress Task in Progress
    Average Hours in Current Step Case Load TaskLoad
    Average Minutes in Current Step CaseLoad Task State
    Average Fail Time Days Case State Time Spent
    Average Fail Time Minutes Completed Work Item Count Time Usage Minutes
    Average Processing Time Days Completed Workflow Count Cycle Time Minutes Total Completion Time Minutes
    Average Processing Time Hours Data Source Total Processing Time Minutes
    Average Ready Time Days Incoming Total Route Count
    Average Ready Time Minutes Incoming Adjusted Total Step Count
    Average Wait Time Days Incoming_InComp Total Wait Time Minutes
    Average Wait Time Minutes Incoming Work Load TSCreation Time
    Avg. Completion Time Days Outgoing TSLastEvent
    Avg. Completion Time Hours Proc Min Current Wait Min Current
    Avg. Completion Time Minutes Productivity Count Work Item Count
    Avg. Proc Min Current Queue Workflow
    Avg. Processing Time Days Queue Load Workflow Count
    Avg. Processing Time Hours Route Workflow Definition
    Avg. Processing Time Minutes Route Count Workload
  7. Click Next.
  8. Specify how to expose the data field: Dimension or Measure.

    Dimension: Any data type can be a dimension.

    Measure: Define measures as aggregate values. A measure must be data type integer or float. The default aggregation function for a measure is Sum.

    Restriction: Many dimensions per cube can result in poor performance when you process the cubes. Try to limit the number of dimensions per cube to 15 for historical cubes and to 30 for the work-in-progress cubes.
  9. Define ranges of values to aggregate values for dimensions of data type integer, float (required), or time. Each range is defined by two boundary values (lower value+1) to the higher value.
    Tip: A float data type stores a close approximation of an actual value. This imprecision can have an impact on the dimension ranges and the float measures that you create.

    To add a boundary value to the list, enter the value in the Boundary field, and click Add. For example, for boundary values 500, 1000, 2550, you see the following ranges:

    Table 2. Example boundary ranges for the boundary values 500, 1000, and 2550
    Boundary value Description
    < 500 implicit range includes everything less than 500
    500 - 1000 range includes 500 - 999
    1000 - 2550 range includes 1000 - 2549
    2550 > range includes everything greater than or equal to 2550
  10. Click Next.
  11. On the Reporting Source window, choose where to expose the data field.
    • Cubes and fact tables (OLAP cube reports).
    • Fact tables only (detailed reports from the Case Analyzer database).

    Exposing a data field of a granular dimension that might yield many unique values (such as social security numbers) to an OLAP cube is not practical. A dimension of many members can also use a large amount of memory and processor time. If queries for this level of detail are necessary, then that data must be exposed to the fact table only and reports obtained from that fact table.

    Important: If you choose to generate reports directly from the fact tables, be aware that the Case Analyzer database schema is subject to change without notification.
  12. Select the cubes or fact tables on which to expose the data field. Exposing data fields affects the performance of Case Analyzer. Select only those cubes or fact tables where the data field is useful.

    Use the following tables as a guideline.

    Table 3. Cube or fact table for cases
    Cube or Fact Table Name Description
    Case in progress View up-to-the-moment information about all cases currently in the system. The information includes the number of cases, processing times, and status. You can break down the information by case or task.
    Case load View information about the number of cases in process during a specified time period.
    Table 4. Cube or fact table for tasks
    Cube or Fact Table Name Description
    Tasks in progress View up-to-the-moment information about all tasks currently in the system. The information includes the number of tasks, processing times, and status.
    Task load View information about the number of case tasks in process during a specified time period.
    Table 5. Cube or fact table for work items
    Cube or Fact Table Name Description
    Queue load View information about the amount of work that is being done in each queue during a specified time period.
    Work in progress View up-to-the-moment information about all work currently in the system. The information includes the number of work items, processing times, and status. You can break down the information by workflow or work item.
    Work item processing time View information about processing time for work items during a specified time period. You can break down the information by user.
    Routing View information about the number of work items that are taking a particular route between two connected steps in a workflow.
    Table 6. Cube or fact table for workflows
    Cube or Fact Table Name Description
    Work load View information about the amount of work that is being done in the system during a specified time period.
    Workflow in progress View up-to-the-moment information about all work currently in the system. The information includes the number of work items, processing times, and status. You can break down the information by workflow or work item.

    If you are exposing a data field as a measure, you can specify when the data field must be updated for the following cubes:

    Table 7. Events when the queue load and work load data field values must be updated
    Queue Load Work Load Case Load Task Load
    Work item is queued Workflow is created Case is initiated Task is initiated
    Work item is completed Workflow is terminated Case is completed Task is completed
  13. Click Finish.