1. Business Process Framework: Task UI Guide
  2. Creating an Error Step

Creating an Error Step

An error step is a type of Task UI step that creates an error message and returns control to the current view. It allows you to configure Siebel CRM to display an error message in the Siebel client. This functionality is typically required if an error message that a business service returns is not sufficiently clear to the user. The error step in a task supports an exception in a way that is similar to how the Stop step works in a Workflow Process. For example, assume a business service step in a task calls an external system, the external system is down, and an error occurs. An exception branch and an error step handle this error.

If the error step runs, then Siebel CRM does the following:

  • Replaces the existing error message with the error message that you define for the error step. This configuration allows you to display an informative and contextual message in the Siebel client. Siebel CRM displays this error message in a dialog box which opens in the current view.

  • Resets the task to the most recent view step that it displayed before it encountered the error step. If Siebel CRM runs an error step before it displays the first view step in a task, then it cancels the task.

You can use an error step in an exception branch or as part of the normal logic of a task to handle an expected error.

To create an error step

  1. Select the Error step from the Palettes pane, then drag and drop it on the canvas.

    For more information, see Adding a Step to a Task.

  2. In the Error Code property (in the Properties pane), select a predefined error code from the picklist, or define a custom error message.

    For more information, see Creating a Custom Error Message.

Error Handling While a Task Runs

If an exception occurs in a task step while the task runs, and if no exception branch is defined, then Siebel CRM displays a generic error message in a dialog box that opens in the current task view. The user can acknowledge the error message, and then correct the data in the task view, or can navigate to a previous task view to correct the data. This configuration is known as default exception handling.

Error Handling When User Pauses a Task

No exception handling occurs if a user pauses a task. If a paused task fails, then Siebel CRM displays a typical error message, not a pause error. The user can cancel or continue the task.

Error Handling When User Cancels a Task

If the user clicks Cancel, then Siebel CRM displays a dialog box that prompts the user for confirmation. For example, if the user is about to perform a delete or undo operation in a task, and then clicks OK to continue.