Errors
The Errors node allows you to Add, Edit and Delete Error Profiles to view Workflow instances in Error status. You can then go to these Profiles and Retry Workflow instances in error state (see the topic Retrying workflow errors for more information and background on repairing failed workflows with the Retry command).
K2 workflows can encounter unexpected errors from time to time. The very nature of K2 solutions (where K2 acts like an intermediary between different systems and may depend on other systems like Active Directory) means that K2 processes can sometimes fail if there is a problem with a supporting system. If the workflow developer has not specifically handled errors in the workflow design, any processes that encounter unexpected errors will be put into Error status and K2 will suspend further execution of the workflow. These processes will appear in the Error Profiles section, and the K2 administrator can then Retry failed instances of the workflow when the root cause of the error is resolved.
You can create separate Error Profiles to filter errors based in various selections. For example, perhaps you have a workflow that often fails because of an unreliable third-party system. You can create a separate profile for only this workflow, so that you can easily select all the errors in that Error profile and retry all the errors at once. Alternatively, you could create an Error Profile to list only specific types of errors (for example Destination errors) so that you can easily list and manage workflows that failed due to that particular type of error, e.g. when K2 is unable to assign tasks to users.
Error Profiles
The All Error Profile is created by default and will be listed in this view. This profile lists all Workflow instances in error status. The Error Profiles view is used to Add, Edit and Delete profiles. See Working with Error Profiles to learn how to retry Workflow instances in error state.
Adding your own Error Profile is useful when you want to view errors on Workflows by a certain grouping. Follow these steps to add an Error Profile:
- Click the New button from the Error Profiles view.
- Enter values for the Error Profile. Use the image and table below as a guideline for the configuration.
- Click OK after completing the Error Profile configuration.
- The new Error Profile will be listed in the Error Profiles view.
- To show the new Error Profile in the Tree View, right-click the Errors node in the K2 Management tree view and click Refresh Menu.
- The new Error Profile will now display in the tree view.
Field Name | Description |
---|---|
Name | The name for the Profile being created. Type a value in the field provided. |
Use From Date | Select this check box if you want this profile to list Workflow instances from a specific date. Use the calendar button to select the date. |
Use To Date | Select this check box if you want this profile to list Workflow instances up to a specific date. Use the calendar button to select the date. |
Process Set Name | Use the drop down to select a Workflow or select the All option from the drop down to include all Workflows for this Profile. |
Process Errors | All the Process Error options are selected by default. Check or uncheck the check boxes to include or exclude the available options for this Profile. |
Activity Errors | All the Activity Error options are selected by default. Check or uncheck the check boxes to include or exclude the available options for this Profile. |
Event Errors | All the Event Error options are selected by default. Check or uncheck the check boxes to include or exclude the available options for this Profile. |
OK Button | Click OK after you've completed the Error Profile configuration. This will take you back to the Error Profiles view and the new Profile will be listed. |
Cancel Button | Click Cancel if you do not want to complete the Error Profile configuration. Click OK on the confirmation message. This will take you back to the Error Profiles view and the Profile will not be created. |
Follow these steps to edit an Error Profile:
- Select the Error Profile you want to edit. Click Edit.
- Change the values that require editing. Use the table provided in the Add section as a guideline for configuring the fields.
- Click OK to save the changes made to the Profile.
Follow these steps to delete an Error Profile:
- Select the Error Profile you want to delete by clicking the check box in front of the Profile. You can also click the top check box if you want to delete all the Profiles. Click Delete.
- Click OK on the confirmation message.
Use the Refresh button to refresh the list of Error Profiles. After clicking Refresh, Error Profiles created, edited and deleted will be updated.
The available Error Profiles can now be used to view Workflow Instances in Error state. The Error Profiles are useful when for example you noticed a Workflow Instance in Error state from the Workflows node.
You can now use the All Error Profile or a Profile created to view the error message. This will help to understand what needs to be fixed for this Workflow Instance. After completing the fix, the Retry option can be used to retry this Workflow Instance. Follow these steps to retry a Workflow Instance in Error state:
- Expand the Errors node and click on the Error Profile you want to use.
- This opens the Error Logs view listing the Workflow Instances in Error state.
- Find the Workflow Instance you want to view and read the Description of the error. The description will indicate what needs to be fixed for this instance.
- To view the Full Details of the error, click the check box for the Workflow Instance and click Show Details.
- Address the source of the error, if necessary.
- To Retry the instance, click the check box for the instance from the Error Logs view. The Retry button becomes available.
- Click Retry.
- If the fix was successful, the Error Logs view will refresh and the Workflow Instance will be removed from the list as the status will now be Active again for the instance.