Progressive Capture Workflow

From Hornbill
Jump to navigation Jump to search

Home > Administration > Workflow > Progressive Capture

Introduction

Progressive Capture is a graphical workflow tool that provides a new and simple way to define the capturing of information for a particular application. An application that uses uses Progressive Capture will include a number of small forms for collecting information related to the application. These forms can be optionally added, ordered, and branched depending on the information being captured.

Features

To configure progressive capture for Hornbill Service Manager:-

  1. Use Hornbill Administration - Launch Hornbill Administration
  2. Create or Change the Progressive Capture Flow - Choose Hornbill Service Manager in the drop down box in the top left. Then select Progressive Capture and either select +Create New button or the flow of the existing process you want to change.
  3. Edit the flow - A progressive capture form (PCF) allows you to capture the individual pieces of information that you need to be able to log your request. Progressive capture flows can include one or many PCF's. There are 4 nodes you can use and lines to connect them. Available nodes are:-
  • Start node - Every Progressive capture flow will have one of these to initiate the flow.
  • Branch node - Allows a custom expression to alter the flow to show different PCF's.
  • Form node (PCF) - You can choose from a number of pre-configured small forms (in Form Properties) and place them in the sequence you need. Currently the existing data fields on the forms can't be changed.
  • Customised Form - Allows you to create your own progressive capture form complete with custom fields and values. Currently listed as beta functionality and is subject to change.
  • End node - Every Progressive capture flow will have at least one of these to end the flow.

When editing a progressive capture flow, it is important to remember that there is no 'right click' anywhere on the canvas. To add a new PCF into the flow, click and hold the edge of the form that you wish to append to and drag the mouse into a blank space on the canvas before releasing. You will then be presented with a list of available nodes. To remove a link between two progressive capture forms, highlight the link and press 'delete' on your keyboard. If you are using a mac, press the backspace arrow and fn keys together.

4. Activate the new flow - Activate the Progressive capture flow by selecting the Activate /In-activate button activate
5. Execute the new Progressive Capture - You can bring the new flow into use by specifying the flow against the relevant Service Manager Application setting (available via Hornbill Administration):


use the filter to search for the Progressive Capture Application settings
Each of buttons used to raise a request invokes the Progressive Capture specified in the associated Application Setting


- For "Raise New" use app.itsm.progressiveCapture.newRequest field with the new name and then save
- For "Incident" use app.itsm.progressiveCapture.newIncident field with the new name and then save
- For "Service Request" use app.itsm.progressiveCapture.newServiceRequest field with the new name and then save
- For "Problem" use app.itsm.progressiveCapture.newProblem field with the new name and then save
- For "Known Error" use app.itsm.progressiveCapture.newKnownError field with the new name and then save
- For "Change" use app.itsm.progressiveCapture.newChange field with the new name and then save


Branches

In progressive capture, branches allow the workflow designer to send the analyst down different routes to potentially collect different information depending on the choices that are made on progressive capture forms. It is important to remember that a branch node will always inherit the outcomes from its parent progressive capture forms. This means that if you place a branch node after the request details form (as shown in the below screenshot), the only pieces of data that you can make a decision on are the Summary and Description fields (only 2 fields on this default form).

decision node based on request summary decision node based on request summary

To add a custom expression to a decision node you must first connect the decision node to the next node in the flow. You can then click the linking line and define your custom expression. You can define multiple outcomes from a decision node, however you must always have at least one valid outcome, otherwise the progressive capture flow could potentially have nowhere to go which will make it error.

multiple outcomes no match decision

Default Forms (PCF's)

Hornbill provide a number of default progressive capture forms that are available to use right out of the box. These forms are listed alphabetically below:

  • Add Attachments
  • Analyst Assignment
  • Analyst Request Type
  • Asset Details
  • Change Type
  • Customer Request Type
  • Customer Search
  • Known Error Details
  • Organisation Details
  • Request Category
  • Request Details
  • Request Priority
  • Service Details


Add Attachments


The 'Add Attachments' PCF allows an analyst to add attachments when raising a request. Multiple attachments can be provided and individual descriptions can be applied to each file:

progressive capture designer form properties

Analyst view when logging a request:
user application

Analyst Assignment


The 'Analyst Assignment' PCF allows an analyst to select the team and owner of the request. An analyst can choose to assign the request to just a team or to a team and a specified analyst:

progressive capture designer form properties

Analyst view when logging a request:
user application

Analyst Request Type


The 'Analyst Request Type' PCF allows an analyst to choose the type of request that will be created. This PCF form is most commonly seen in the 'New Request' progressive capture flow as the analyst may not know which type of request needs to be raised when they first start capturing information:

progressive capture designer form properties

Analyst view when logging a request:
user application

Asset Details


The 'Asset Details' PCF allows an analyst to associate assets to the request. By default, all assets that are associated to the customer of the request are shown however it is also possible to perform a general search on assets that are in the system. It's possible to associate multiple assets to each request:

progressive capture designer form properties

Analyst view when logging a request:
user application user application

Change Type


The 'Change Type' PCF allows an analyst to select the type of change request that will be raised. This PCF is usually only seen on the new Change progressive capture flow:

progressive capture designer form properties

Analyst view when logging a request:
user application

Customer Request Type


The 'Customer Request Type' PCF allows the customer to choose what type of request they are raising. This PCF is most commonly seen on the 'New Self Service' progressive capture flow which is used by both the Hornbill Service and Customer portals. It is slightly different to the PCF 'Analyst Request Type' in that it only offers the ability to select a request type of Incident (Something is broken) or Service Request (I need something):

progressive capture designer form properties

Customer view when logging a request:
user application

Customer Search


The 'Customer Search' PCF allows an analyst to select a customer for the request:

progressive capture designer form properties

Analyst view when logging a request:
user application

Known Error Details


The 'Known Error Details' PCF allows an analyst to specify root cause and workaround details for a known error. This PCF is usually only seen on the new Known Error progressive capture flow:

progressive capture designer form properties

Analyst view when logging a request:
user application

Organisation Details


The 'Organisation Details' PCF allows an analyst to see additional information about the customer's organisation that is defined by a Hornbill administrator. There is no data captured in this PCF - it is purely informational only:

progressive capture designer form properties form properties

Analyst view when logging a request:
user application

Request Category


The 'Request Category' PCF allows an analyst to specify a category when logging a request.

progressive capture designer form properties

Analyst view when logging a request:
user application

Request Details


The 'Request Details' PCF allows an analyst to enter both a summary and a description for the request:

progressive capture designer form properties

Analyst view when logging a request:
user application

Request Priority


The 'Request Priority' PCF allows an analyst to set the priority of the request:

progressive capture designer form properties

Analyst view when logging a request:
user application

Service Details


The 'Service Details' PCF allows an analyst to specify a service when logging a request:

progressive capture designer form properties

Analyst view when logging a request:
user application


Default Form Configuration

When selecting a default Hornbill PCF there are two ways in which you can customise it:

  1. Mark as Mandatory - Setting this option to true means that a value or values will need to be provided by the analyst before they can advance to the next progressive capture form. The default setting for each form is false. Mandatory fields are indicated by the vertical red bar on the left edge of the field. If a field is required and you attempt to move to the next PCF without providing a value, you will be shown an error message.

mandatory setting in the progressive capture designer mandatory setting enforced in the user app

2. Define Additional Display Fields - Certain PCF's have the ability to display additional information such as the Organisation Details and Customer Search forms. A Hornbill administrator can select which additional data is displayed when an analyst selects a value from the selected progressive capture form.

In the progressive capture designer additional display fields shown in the user app

Customised Forms

As well as standard forms, Hornbill also provide the ability to create your own custom forms. With custom forms, you can create multiple questions of different field types for analysts to answer during progressive capture. This feature is particularly useful for new starter/leaver processes as the progressive capture workflow designer is able to ask for the exact pieces of information that they require for their process.

In the progressive capture designer form properties

With each custom form, it is a good idea to give it a unique form id so that you can identify the answers to your questions later on when using the Hornbill Business Process Workflow engine. The Form Prompt is the piece of text that the user will see when they get to the custom PCF when logging a new request:

form properties including form id and form prompt form prompt text in user app

When adding fields to custom forms, there are several configuration options to consider. You can for example, mark a field as mandatory, read only, and include it as part of the summary. There are also multiple field types to choose from including single text fields, a multi line text field, selection boxes and date/time pickers:

form properties - static drop down selection box form properties - date time picker form properties - multi line text input form summary in user app

Analyst view when logging a request:

Custom PCF in user app Custom PCF in user app

Hornbill Default Progressive Capture Flows

By default, Hornbill provide the following seven progressive capture flows. These can be edited, copied or deleted accordingly:

- New Request
- New Self Service
- New Incident
- New Service Request
- New Problem
- New Change Request
- New Known Error

New Request

new request progressive capture flow

New Self Service

new self service progressive capture flow

New Incident

new incident progressive capture flow

New Service Request

new service request progressive capture flow

New Problem

new problem progressive capture flow

New Change Request

new change request progressive capture flow

New Known Error

new known error progressive capture flow