Accessing our Business Processes

Our Business Processes Page can be found underneath the “Admin” page in the navigation bar.

The UI

When you access the page, you’re greeted with something that looks like this:

This is a grid that contains all of the business processes we currently have. This is a list of processes that can be scheduled to run at specific times of the day, can be run manually or they can run automatically in the background whenever transaction files or Masterdata files are uploaded to our Document Management System.

Creating a Business Process

You can create a new business process by clicking on the “New” button at the top of the , this will bring up a dialog that looks something like this:

Here, “Name” should be filled in with the name of the process you wish to create, the “Description” should be filled in with a brief description of what the process will be used for, for example “Transaction Processing” should have a description like “This processes the client’s transactions, taking them from the CSV sent by the client and allowing them to be visible within the portal”. The “Category” should be filled in with something intuitive and relevant to the process.

Once all of the fields have been filled, clicking “Create” will create the new business process in the grid.

Updating a Business Process

You can edit any of the details of the business process from this grid, by clicking on any of the information you want to change.

To save any changes you’ve made, you click the “Save” button on the row which you’ve applied changes to.

Expanding a Business Process

Each business process has its own workflows attached to it, this is where we manage how the transactions are taken from DMS and processed so they are visible in our UI. Expanding a business process will display a grid that looks something like this:

Here, there’s a workflow that’s called “Import” which is responsible for getting the client’s transactions into the portal and ensuring they’re visible to the user.

Creating a Workflow

Clicking the “New” button in the workflows grid will bring up a dialog that looks something like this:

Here, “Name” should be filled in with the name of the workflow you wish to create, this should be clear and make it obvious what the workflow is to be used for. “Executable By” determines who can run this workflow, generally this is set to administrators.

Updating a Workflow

You can edit any of the details of the workflow from this grid, by clicking on any of the information you want to change.

To then save the changes you’ve made to the grid, you click the save button on the corresponding row.

Editing a Workflow

To edit a workflow, you click on the edit button. This will take you away from the Business Processes page and take you into our Workflow Designer which is where all of the workflows that are used across our system are configured. This page also has its own dedicated documentation, so to find out more, click here.

Expanding a Workflow

Expanding a workflow will give you a view of of the times the workflow were run, by default these are sorted by date, so the most recent instance is at the top.

The “Id” allows us to easily identify the instance that has run, the “State” informs us of whether or not the workflow ran successfully or not. If it runs successfully, this state will be “Complete” if, for any reason the workflow doesn’t run successfully, then this state will be “Failed”. The “Caller” is defined by the user account that was responsible for that instance being run. “Start” is the date and the time at which the instance was run and the “End” is the date and time that the workflow finished running. This is useful information as it allows you to see how long the previous instances have taken to run, this is useful when attempting to spot any issues with the processes if it takes longer than expected.

Expanding an Instance

Expanding a workflow instance will give you a view that looks something like this:

Here, the “Logs” can be used to debug any issues during the workflow run. If there are any issues with the workflow, or the data that it’s processing then they will be visible here. Whenever there are any errors, they are visible in red, and contain descriptive text to allow the swift identification of any bugs. The “Context” tab contains useful information, described in the table below:

The “Flow” tab, looks something like this:

This displays the flow of tasks (for offer generation) that are followed by the workflow, it begins at the “Start”, which is responsible for kicking off the workflow. “Get App Info” is responsible for retrieving the information about the application. “Retire Existing Proposals” is responsible for retiring any offers that are no longer up to date. “Get Eligible Transactions” gets any transactions in the system that are eligible to have offers generated for them and finally, “Generate Offers” generates the offers and makes them visible in the UI. Allowing users to accept them.

The “Report” tab in this view summarises the offer generation process. It displays the total number of offers generated successfully along with any failures with a concise explanation as to why they failed to generate.

Deleting an Instance

To delete an instance of a workflow, you must click the “Delete” button on the row corresponding to the instance you wish to delete. Once clicked, the instance will be deleted and will no longer be visible in the UI.

Deleting a Business Process

To delete a Business Process, you must click the “Delete” button on the row corresponding to the Business Process you wish to delete. Once clicked, the Business Process will be deleted and will no longer be visible in the UI.