Process Inspector is intended for a platform business administrator and enables you to identify and filter instances of applications based on their attributes and gives the possibility to correct them if they are in a Failed state.
What is a process instance you ask? well... A process instance is a specific occurrence or execution of a business process. For example, if making a cake is a process, the recipe is the process model. A process instance occurs each time a person makes a cake using this recipe.
How to access
In order to access this feature, you must have administrator privileges on the Aurachain platform.
Login to the Aurachain portal using your given credentials.
Navigate to the Admin Work space.
On the left side and under the default selection you will notice a new icon entitledProcess Inspector.
What is Process Inspector used for?
It is a straight forward way for you to identify and filter where and why your business process crashed. You can also take different actions on a single instance or multiple ones, in order to retry them.
How do I use Process Inspector?
When you first access the Process Inspector page, a search will be automatically be performed in all platform instances with the default “failed” filter settings applied. The Process Inspector page is split into two sections:
Filter section – this is where you will apply filters in order to narrow down the number of instances returned. By default, the status Failed filter is applied;
Results section – this is where the instances are displayed based on your filters.
There is a number of filters meant to help you identify and target the instances you are looking for easier. They can be used in combination in order to narrow down the results:
Search filter – search for keywords in the task subject name, instance name, instance ID, application name, status, task name, task ID.
System status – the current status of an instance. An active instance is considered Running. A completed instance is considered Completed. An instance that has encountered a problem and cannot be completed is considered Failed.
Application – returns only the instances belonging to the selected application/s. You can search for an application by name or click the button to display a drop-down list of all applications. Tick the box next to the applications you want to see the instances of;
Data model – if you have selected a single application in the Application filter, you have the option to filter by any data model attributes associated to the application;
Date – either start date and/or last update. You have to set both from and to dates;
Initiator – search for a user or select one or more from the drop-down list;
Assignee – search for a user or group or select one from the drop-down list;
This is where the result of your filter will display all instances that fit the criteria.
Each entry in the result list represents an instance.
In the top left corner of the section you will see a counter for the number of instances returned.
On the header of the section you have a few options:
Refresh – will re-search based on the same filters. This is useful when you have changed an instance’s attributes and want to see if the search criteria still apply to them;
Sort by – you have the option to sort the result, in ascending or descending order, by the start date, last update or instance status;
In the 3 dotted menu you will find the option to initiate a retry sequence for all instances displayed. Please note that this applies only to instances with “failed” status. The retry option can be used to a particular instance also, and can be found on the right of each instance line.
In the result list you can see the following information:
Instance name – in bold,
if no custom instance name is configured on the process definition, then the instance name will display the name of the application, start date of the instance and instance id.
Start date and last update;
Instance status, color coded;
Clicking on an instance in the result list will open a details page to the right of the screen. The page is composed of:
Refresh button – in the top right of the details page. Use this option after retrying a failed instance in order to reload the details in case they have been changed;
Summary – read only section with details about the instance, such as application details (name, published by, last published datetime), instance name, instance id, start date/last update and the name of the user that performed the last action on the instance;
Instance contents – separated into tabs by type of information.
For Data Model it displays in JSON text format, all the metadata of the instance. The information can be editable by pressing the Edit button on the right side of the window only on failed instances. The Edit button appears on mouse over. You will be able to change details on the instance in an attempt to fix it, for example, in case that it is in a Failed state because it is missing mandatory data;
For API it displays in JSON or XML text format, all the metadata for the request and response of the instance . The information can be copied or downloaded from the contextual 3 dotted menu.