Working with the Instance Analytics Tab

Edit online

About this task

The following table describes the error types that are listed on the Instance Analytics tab on the Edit Process page.

Error Type Description
Built-in System Errors Built-in system errors are error types that are automatically assigned to all processes by Process Tracker. For built-in system-error types, users can only configure whether the specific error condition stops (cancels) a process instance. The following three built-in system-error types are automatically assigned to all processes: Step Out Of Sequence, Subprocess Error, and System Error.
  • The built-in system-error types Step Out Of Sequence and System Error are displayed by default for all processes.
  • The built-in system-error type System Error indicates an exception detected in the Analytic Engine that affects the status (also known as the state) of a process instance or a step instance. System Error types are for troubleshooting or explaining an incorrect process status or step status.
  • The built-in system-error type Subprocess Error will appear only for processes that contain referenced subprocesses.
Standardized Errors Standardized error types are user-defined error types tracked by Optimize. Standardized error types relate to conditions triggered by the Analytic Engine against a process instance, a step instance, or a step transition instance. Standardized error types use built-in error conditions that can be configured on the Add Standardized Error Type page.
Custom Errors Custom error types are user-defined error types that are activated externally and tracked by Optimize. Custom error types can be defined by the user on the Create Custom Error Type page. Alternatively, custom error types can be created automatically by Optimize upon detection of the first received custom error, via the pushExecutionError (Execution Error) operation (for more information, see Sending Process Data in Configuring and Using the Web Service Data Collector).

The following table describes the information that is displayed on the Instance Analytics tab on the Edit Process page.

Column Description
Name Name of the error type.
For Scope of the error condition. All Process Instances indicates that this error type applies to all instances of the process. If the error type applies to only one dimension of the process, that dimension is displayed in the following format:

dimension name(event mapname): dimension value

Condition The condition that, when true, causes an error of this type to display in the Process Errors panel on the Process Instance Detail page.
Last Occurrence Timestamp of the last occurrence of an error of this type.
Stop Whether tracking of this process instance will stop when the error condition occurs.

Green Checkmark icon = The occurrence of this error condition stops the tracking of this process instance.

Red Circle icon = Tracking of this process instance will continue even if this error condition occurs.

Edit Click Edit icon to edit the definition of this error type. The three built-in system-error types (System Error, Step Out Of Sequence, and Subprocess Error) can only be edited to specify whether the occurrence of the error condition stops (cancels) the tracking of the process instance.

Standardized Error Types

Edit online

About this task

Standardized error types are configurable by clicking the Add Standardized Error Type button in the Instance Analytics panel of the Edit Process page.

The Add Standardized Error Type dialog is displayed.

Add Standardized Error Type dialog

Standardized error types can be configured for the following five types of error conditions:

  • Cycle Time
  • Step Relative Wait Time
  • Step Absolute Wait Time
  • Iterations
  • Deadline

Cycle-Time Standardized Error Types

Edit online

About this task

Cycle-time error types are intended for configuring errors related to the time that it takes a process instance or a step in a process instance (also known as a step instance) to cycle through once, from start to finish.

To add a cycle-time standardized error type

Procedure

  1. Click the Add Standardized Error Type button in the Instance Analytics panel of the Edit Process page.

    To configure a new cycle-time error type, provide the information that is described in the following table.

    Field Description
    Error Type Name Enter a unique name for the error type.

    It can be helpful to create a name that indicates the parameters of the error type. Although this field will accept up to 150 alphanumeric characters, the name will be truncated at 50 characters on the Instance Analytics panel of the Edit Process page.

    Filter By Dimension Choose All Process Instances to apply the error type to all instances of the process. Alternatively, you can select a dimension from the drop-down list of all of the dimensions for all of the business event maps defined for this process. Each dimension listed will identify the event map with which that dimension is associated.

    Select a dimension from the drop-down list to apply the error type only to a specific instance of the selected dimension. If you select a dimension, enter the dimension instance in the text box to the right.

    Condition Type Select the Cycle Time error type.
    Condition Parameters Use the drop-down menus to create an error condition consisting of: <operand> + <operator> + <value>
    <operand> Select an operand for the error condition from the first drop-down menu. Cycle-time operands consist of the name of the process instance, or the name of a step in the process instance, plus Cycle Time.
    <operator> Select an operator for the error condition from the second drop-down menu.

    Choose from the following operators:

    • Greater Than Or Equal To
    • Above Normal
    • One standard deviation above normal
    • Well Above Normal
    • Two standard deviations above normal
    <value> This text box is available only if you selected the Greater Than Or Equal To operator. In the text box, enter a whole number against which to evaluate the error condition, and then select from the last drop-down menu a unit of measure for that whole-number value.

    Choose from the following units of measure:

    • Milliseconds
    • Seconds
    • Minutes
    • Hours
    • Days
    • Weeks
    Stop Process Tracking Select this check box if you want Optimize to stop tracking this process instance if the error type occurs.
    Create Rule This check box is available only if the current user has Access Privileges for the Rule List page (see Administering IBM My webMethods Server). Select this check box if you want to automatically create a rule for this error type. The rule name will be the same as the error-type name, and the rule type will be Event.

    Errors appear only on the Process Instance Detail page. If you create an automatic rule for the error type, that rule will display on both the Problems page and the KPI Instance Detail page.

    If the error type is subsequently deleted, the associated rule remains unless it is manually deleted, as well.

    Send Alert This check box is available only when Create Rule is selected and a valid e-mail address has been configured for the current user. Select this option if you want an e-mail alert sent to you when the rule you created is violated.
  2. Click Save to save the error type, or click Cancel to return to the Edit Process page without saving.

Wait-Time Standardized Error Types

Edit online

About this task

Wait-time error types are intended for configuring errors related to the time that elapses leading to the start of a specified step in a process instance (the destination step). Wait-time error types are always applied to the destination step. The two available wait-time error types are Step Relative Wait Time and Step Absolute Wait Time.

A Step Relative Wait Time error type relates to the time that elapses between the completion of one step in a process instance (the source step) and the start of a subsequent, specified step in that same process instance (the destination step). A Step Absolute Wait Time error type relates to the time that elapses between the beginning of a process instance and the start of a specified step in that process instance.

To add a wait-time standardized error type

Procedure

  1. Click the Add Standardized Error Type button in the Instance Analytics panel of the Edit Process page.

    To configure a new wait-time error type, provide the information that is described in the following table.

    Field Description
    Error Type Name Enter a unique name for the error type.

    It can be helpful to create a name that indicates the parameters of the error type. Although this field will accept up to 150 alphanumeric characters, the name will be truncated at 50 characters on the Instance Analytics panel of the Edit Process page.

    Filter By Dimension Choose All Process Instances to apply the error type to all instances of the process. Alternatively, you can choose to apply the error type to a specific dimension attribute, such as Customer. If you choose to apply the error type to a specific dimension attribute, you must also specify a value for that dimension attribute. In the example of the dimension attribute Customer, a value for that dimension attribute could be IBM.

    To apply the error type to a specific dimension attribute, choose from the drop-down list of all of the available dimensions for all of the business event maps defined for this process instance. Each dimension listed will identify the event map with which it is associated.

    Once you've selected a dimension attribute from the drop-down list, enter a dimension value in the text box beside the drop-down list. The text box will default with the text of the selected dimension, up to a maximum of 80 alphanumeric characters.

    Condition Type Select either the Step Relative Wait Time or the Step Absolute Wait Time error type.
    Condition Parameters Use the drop-down menus to create an error condition consisting of: <operand> + <operator> + <value>
    <operand> Select an operand for the error condition from the first drop-down menu. Wait-time operands consist of the name of a step in the process instance plus Wait Time.

    Only steps that have an inbound transition (i.e., steps that can be entered from another step) appear in this drop-down menu.

    <operator> Select an operator for the error condition from the second drop-down menu.

    Choose from the following operators:

    • Greater Than Or Equal To
    • Above Normal
    • One standard deviation above normal
    • Well Above Normal
    • Two standard deviations above normal
    <value> This text box is available only if you selected the Greater Than Or Equal To operator. In the text box, enter a whole number against which to evaluate the error condition, and then select from the last drop-down menu a unit of measure for that whole-number value.

    Choose from the following units of measure:

    • Milliseconds
    • Seconds
    • Minutes
    • Hours
    • Days
    • Weeks
    Stop Process Tracking Select this check box if you want Optimize to stop tracking this process instance if the error type occurs.
    Create Rule This check box is available only if the current user has Access Privileges for the Rule List page (see Administering IBM My webMethods Server). Select this check box if you want to automatically create a rule for this error type. The rule name will be the same as the error-type name, and the rule type will be Event.

    Errors appear only on the Process Instance Detail page. If you create an automatic rule for the error type, that rule will display on both the Problems page and the KPI Instance Detail page.

    If the error type is subsequently deleted, the associated rule remains unless it is manually deleted, as well.

    Send Alert This check box is available only when Create Rule is selected and a valid e-mail address has been configured for the current user. Select this option if you want an e-mail alert sent to you when the rule you created is violated.
  2. Click Save to save the error type, or click Cancel to return to the Edit Process page without saving.

Iterations Standardized Error Types

Edit online

About this task

Iterations error types are intended for configuring errors related to how many times a step in a process instance is repeated.

To add an iterations standardized error type

Procedure

  1. Click the Add Standardized Error Type button in the Instance Analytics panel of the Edit Process page.

    To configure a new iterations error type, provide the information that is described in the following table.

    Field Description
    Error Type Name Enter a unique name for the error type.

    It can be helpful to create a name that indicates the parameters of the error type. Although this field will accept up to 150 alphanumeric characters, the name will be truncated at 50 characters on the Instance Analytics panel of the Edit Process page.

    Filter By Dimension Choose All Process Instances to apply the error type to all instances of the process. Alternatively, you can choose to apply the error type to a specific dimension attribute, such as Customer. If you choose to apply the error type to a specific dimension attribute, you also will need to specify a value for that dimension attribute. In the example of the dimension attribute Customer, a value for that dimension attribute could be IBM.

    To apply the error type to a specific dimension attribute, choose from the drop-down list of all of the available dimensions for all of the business event maps defined for this process instance. Each dimension listed will identify the event map with which it is associated.

    Once you've selected a dimension attribute from the drop-down list, enter a dimension value in the text box beside the drop-down list. The text box will default with the text of the selected dimension, up to a maximum of 80 alphanumeric characters.

    Condition Type Select the Iterations error type.
    Condition Parameters Use the drop-down menus to create an error condition consisting of: <operand> + <operator> + <value>
    <operand> Select an operand for the error condition from the first drop-down menu. Iteration operands consist of the name of a step in the process instance plus Iterations.
    <operator> Select an operator for the error condition from the second drop-down menu.

    For iteration error types, only the following operator is available:

    • Greater Than
    <value> Enter in the text box a whole number against which to evaluate the error condition.
    Stop Process Tracking Select this check box if you want Optimize to stop tracking this process instance, or to stop tracking a step in this process instance, if the error type occurs.
    Create Rule This check box is available only if the current user has Access Privileges for the Rule List page (see the Administering IBM My webMethods Server). Select this check box if you want to automatically create a rule for this error type. The rule name will be the same as the error-type name, and the rule type will be Event.

    Errors appear only on the Process Instance Detail page. If you create an automatic rule for the error type, that rule will display on both the Problems page and the KPI Instance Detail page.

    If the error type is subsequently deleted, the associated rule remains unless it is manually deleted, as well.

    Send Alert This check box is available only when Create Rule is selected and a valid e-mail address has been configured for the current user. Select this option if you want an e-mail alert sent to you when the rule you created is violated.
  2. Click Save to save the error type, or click Cancel to return to the Edit Process page without saving.

Deadline Standardized Error Types

Edit online

About this task

Deadline error types are intended for configuring errors related to a fixed completion date/time for a process instance. Deadline error types allow you to designate a field (or fields) with a process event map as a date, including a specific time. You can then select any such date field in the process of configuring a deadline error type. Deadlines apply only to process cycle time and not to individual step processing times.

Deadline error types allow you to leverage Date type event-map attributes as deadlines, based on the value of the event-map attribute when received as part of business data for a process instance. For example, if your process is associated with an event map that has a shippingDate date attribute, you can specify a deadline timeout against shippingDate. When a shippingDate value is sent as part of business data for a process instance, that process instance must complete before the specified value of shippingDate plus or minus any additional offset time specified with the deadline error type.

To add a deadline standardized error type

Procedure

  1. Click the Add Standardized Error Type button in the Instance Analytics panel of the Edit Process page.

    To configure a new deadline error type, provide the information that is described in the following table.

    Field Description
    Error Type Name Enter a unique name for the error type.

    It can be helpful to create a name that indicates the parameters of the error type. Although this field will accept up to 150 alphanumeric characters, the name will be truncated at 50 characters on the Instance Analytics panel of the Edit Process page.

    Filter By Dimension Choose All Process Instances to apply the error type to all instances of the process. Alternatively, you can choose to apply the error type to a specific dimension attribute, such as Customer. If you choose to apply the error type to a specific dimension attribute, you must also specify a value for that dimension attribute. In the example of the dimension attribute Customer, a value for that dimension attribute could be IBM.

    To apply the error type to a specific dimension attribute, choose from the drop-down list of all of the available dimensions for all of the business event maps defined for this process instance. Each dimension listed will identify the event map with which it is associated.

    Once you've selected a dimension attribute from the drop-down list, enter a dimension value in the text box beside the drop-down list. The text box will default with the text of the selected dimension, up to a maximum of 80 alphanumeric characters.

    Condition Type Select the Deadline error type.

    The Deadline error type is available only if at least one process-associated event map has at least one Date attribute mapped.

    Condition Parameters Use the drop-down menus to create an error condition consisting of: <operand> + <operator> + <value>
    <operand> Select an operand for the error condition from the first drop-down menu. Deadline operands consist of “Dateattribute name” (event map name).
    <operator> Select an operator for the error condition from the second drop-down menu.

    Choose from the following operators:

    • Greater than or equal to
    • Use this operator to specify a “grace period” after the deadline occurs before issuing the error.
    • Less than or equal to
    • Use this operator to issue an error as an early warning before the deadline occurs.
    <value> In the text box, enter a whole number against which to evaluate the error condition, and then select from the last drop-down menu a unit of measure for that whole-number value.

    Choose from the following units of measure:

    • Milliseconds
    • Seconds
    • Minutes
    • Hours
    • Days
    • Weeks
    Stop Process Tracking Select this check box if you want Optimize to stop tracking this process instance, or to stop tracking a step in this process instance, if the error type occurs.
    Create Rule This check box is available only if the current user has Access Privileges for the Rule List page (see Administering IBM My webMethods Server). Select this check box if you want to automatically create a rule for this error type. The rule name will be the same as the error-type name, and the rule type will be Event.

    Errors appear only on the Process Instance Detail page. If you create an automatic rule for the error type, that rule will display on both the Problems page and the KPI Instance Detail page.

    If the error type is subsequently deleted, the associated rule remains unless it is manually deleted, as well.

    Send Alert This check box is available only when Create Rule is selected and a valid e-mail address has been configured for the current user. Select this option if you want an e-mail alert sent to you when the rule you created is violated.
  2. Click Save to save the error type, or click Cancel to return to the Edit Process page without saving.

Editing an Existing Standardized Error Type

Edit online

About this task

To edit a previously configured standardized error type

Procedure

  1. On the Edit Process page, click edit icon Edit beside the error type you want to edit.

    The Edit Error Type page is displayed.

    Note: For built-in system-error types (Step Out Of Sequence, Subprocess Error, and System Error), you can only enable or disable Stop Process Tracking. Otherwise, built-in system-error types cannot be edited.
  2. Make any changes to the error-type definition.
  3. Click Save to save your changes, or click Cancel to return to the Edit Process page without saving.

Deleting a Previously Defined Standardized Error Type

Edit online

About this task

To delete a previously defined standardized error type

Procedure

  1. On the Edit Process page, select the check box beside the name of the error type you want to delete.

    Check boxes are available only for standardized or custom error types that have no associated error instances. Built-in system-error types cannot be deleted. Once you select an available check box beside the name of an error type, the Delete button is activated.

  2. Click Delete.

    The error type is deleted, and if a rule was generated automatically when the error type was created, that rule is also deleted. However, any rules that were manually created for this error type also must be deleted manually.

    Note: Built-in system-error types (Step Out Of Sequence, Subprocess Error, and System Error) cannot be deleted. In addition, any error type that has an existing instance cannot be deleted.

Custom Error Types

Edit online

About this task

To add a custom error type to the list of error types displayed in the Instance Analytics panel on the Edit Process page, you must define the custom error-type name. Custom errors are activated externally and then tracked by Optimize.

To add a custom error type

Procedure

  1. On the Edit Process page, click the Create Custom Error Type button in the Instance Analytics panel.

    The Create Custom Error Type dialog is displayed.

    Create Custom Error Type dialog
  2. Enter a unique name for the error type in the Error Type Name field. The name must match the name originally given to this error type. Custom errors are sent into Optimize by a custom data collector. The custom data collector gives each custom error a name, and the name entered on the Create Custom Error Type page must match that name from the custom data collector.

    Although this field will accept up to 150 alphanumeric characters, the name is truncated at 50 characters on the Instance Analytics panel of the Edit Process page.

  3. Select Stop Process Tracking if you want Optimize to stop tracking this process instance, or to stop tracking a step in this process instance, if the error type occurs.
  4. Select Create Rule if you want to automatically create a rule associated to this error type. The rule name will be the same as the error-type name, and the rule type will be Event.

    This check box is available only if the current user has Access Privileges for the Rule List page (see Administering IBM My webMethods Server).

    Note: Errors appear only on the Process Instance Detail page. If you create an automatic rule for the error type, that rule is displayed on both the Problems page and the KPI Instance Detail page. If the error type is subsequently deleted, the associated rule remains unless it is manually deleted, as well.
  5. If you selected Create Rule, you can select the Send Alert check box if you want an e-mail alert sent to you when the rule you created is violated.

    This check box is available only if a valid e-mail address has been configured for the current user.