Difference between revisions of "Intelligent Capture Designer"

Revision as of 02:00, 19 August 2021

Home > Administration > Progressive Capture Designer

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 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.

Nodes

When building a progressive capture script there are a few different nodes that are available to use when considering your design

Start

Every progressive capture flow will have a Start node. This is the entry point for all progressive capture scripts.

Form

You can choose from a number of pre-configured small forms (in Form Properties) and place them in the sequence you need.

Custom Form

Allows you to create your own form complete with custom fields and values.

Branch

Allows a custom expression to alter the flow to show different PCF's.

Switch

Allows you to link progressive capture's together and seamlessly switch from one to another

End

Every progressive capture flow will have at least one of these to end the flow.

Branches

In progressive capture, branches allow the workflow designer to send the user 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 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).
When branching to a new progressive capture it is important to ensure that all Custom Forms have unique names to prevent mapped fields being overwritten.

Custom Expressions

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.

A decision node can have a maximum of three exist nodes. If you require more than three outcomes you can link one decision node to another decision node using a No Match link and you can then add additional outcome option toa second or subsequent decision node.

You can use variable values from any form which has been used in the progressive flow prior to the decision question for example from the Customer Search form you may use the Customer Type variable to branch on
You can branch on a global variable such as where the progressive capture is being used. For example if it is being used by an analyst in the user app you may want to branch to different forms compared to if the same progressive capture was being used by a customer on either the customer or service portals (Global Variable -> Portal Type (Service Desk / Portals)

Switch Capture

In Progressive Capture the Switch Capture node provides the ability to seamlessly move to or link Progressive Capture flows together. One example of where this maybe useful is in Service Manager when choosing a Request Catalog item from the Services Progressive Capture form, the switch process can be used to switch to the the Progressive Capture flow which is assigned to the chosen Request Catalog item.

Using this node replaces the previous behaviour of jumping from an initial progressive capture to another, and in essence any forms used in both are evaluated and re-used when jumping, it also removes the need to evaluate which forms in the second progressive capture to use, and any issues associated with progressive capture forms being skipped.

Using this node, will in effect continue from the initial progressive capture, into the next progressive capture rather than replace it. This means it does not need to evaluate which forms to skip, it simply ignores any forms already used in the initial progressive capture.

Advantages of using the Switch Capture Node

When switching processes the UI for the analyst is smooth as you are linking one process to another not replacing one with another
The ability to return / revisit the forms in the initial process capture flow, once you have switched or linked to a second process capture flow in order to change values / choices or even change which progressive capture to switch / link too.
You don't need to include the same forms in both Progressive Captures, for example the Customer Search form could just be used in the initial progressive capture, and removed from the catalog item progressive capture (obviously if it already exists it will simply be ignored).

Example

Following the use of the Services Details form, you may include a Branch node, and have two outcomes.

1. Using a Custom Expression, perform a check to see if 'Service details -> catalogProgressiveCaptureId Is Set (if a request catalog item has been selected) from here link to the Switch Capture node
2. Using another Custom Expression perform the same check but set this to Is Not Set (a Service rather than a request catalog item has been selected) and build your logic accordingly, equally you could define multiple other outcomes from this branch node to reflect the different service choices and paths you wish to take.

On the Switch Capturenode, you can configure this to link to a specific new process, or use a Variable to link to the progressive capture linked to the request catalog item which has been chosen. In this example this is what we will do and the Variable to use would be Service details -> catalogProgressiveCaptureId

Note: with the introduction of the Switch Capture option, the behaviour will alter slightly on the Services Details form, is as much as the user will now have to select the Next button if they are selecting either the Service or the Request Catalog Item in order to progress the progressive capture. Previously if a Request Catalog Item was chosen the progressive capture would immediately progress without the need to click Next.

Default Form Configuration

Whilst default forms have a set purpose, it is also possible to configure aspects of these forms.

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 and customers to answer during progressive capture.

New - A Never Skip configuration option has been added, which can be set to True, this will ensure that this form is never bypassed in your progressive capture flow, even if custom questions have default values set, and the questions are not set to mandatory. This will ensure the user will always be presented with the form to at least validate the default choices, or change them if required.

Mapping Fields from Customised Forms

When creating customised forms, and custom questions the default behaviour is for the question and answer to be visible on the request form in a Questions collapsable section. It is also possible to map the answer from a custom question to one of the default fields on a request.

Sharing and Visibility

Progressive capture owners will be able to view their own captures, and captures which have been shared with them from the Progressive Capture List.

When creating or editing a capture it is possible via the Manage Process Settings and Grant Access To option to share your process with:

Roles
Users
Groups - Configured via the Organisational group structure

It is possible to share captures with multiple users, roles and groups. Once a capture has been shared, the user will be able to view the capture from the Progressive Capture list.

To remove visibility to a specific User, Role or Group simply select the Trash Can icon next to the item you wish to stop sharing the capture with.

To enforce the above sharing and visibility controls, ensure the system setting security.bpm_access_controls.enabled is set to On from the administration console:

Home > System > Settings > Advanced

Progressive Capture Options

Each Progressive Capture script has a number of configuration options

Download

Download the definition file - downloads to a .txt file, a copy of the current progressive capture script

Upload

Upload a pcf.txt file to the Progressive capture - this will replace the current progressive capture script content

Print

Print out a document that provides a graphical representation of the the Progressive Capture script

Save (Validate, Activate, De-activate)

After the creation or editing of a Progressive Capture script, your script needs to be saved and then activated to make if available for use. Any Progressive Capture that you wish to keep but not have it available for use can be de-activated.

Versions

Experimental Features

Hornbill may introduce new features in an experimental state, customers can choose to enable, use and provide feedback on these features. These features are subject to change and or removal.

Displaying Conditional Fields

This feature allows for the showing or hiding of fields on custom progressive capture forms based on the answers to other questions on either the same custom progressive capture form, or answers to questions on previous progressive capture forms (conditions).

Add a new form field to a progressive capture form and untick the This field will be visible on the form option under the Default Flags tab
A new Override flags tab will be visible next to the Default Flags, navigate here and select Add new condition
Give the condition a name and choose options such as This field will be visible on the form
Using the If the following is true option to add conditions under which this field will be shown / hidden, this can be based on a combination of values (answers) to other questions (fields) on the same or previous progressive capture forms. Select apply Settings when finished.
It is possible to set multiple sets of Conditions under which a field may be shown. Simply add more conditions under the Override Flags tab using the Add new condition option
Where multiple conditions are listed, these will be evaluated from the top down until a match is found, the evaluation will stop here and no further conditions will be checked).
Complete the Field Type Settings options to define the attributes of the conditional field.