Difference between revisions of "Customised Forms"

From Hornbill
Jump to navigation Jump to search
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
This document can now be found at its new location in the [https://docs.hornbill.com/servicemanager-config/customize/customized-forms/ Hornbill Document Library].
 +
 +
[[file:hornbill-document-library.png|Customized Capture Forms|link=https://docs.hornbill.com/servicemanager-config/customize/customized-forms/]]
 +
<!--
 
<div style="border:1px solid #90C0FF; background:#D0E0FF; width:99%; padding:4px; margin-bottom:10px;">
 
<div style="border:1px solid #90C0FF; background:#D0E0FF; width:99%; padding:4px; margin-bottom:10px;">
__NOTOC__[[Main Page|Home]] > [[Administration]] > [[Progressive Capture Designer]] > Customised Forms
+
__NOTOC__[[Main Page|Home]] > [[Administration]] > [[Intelligent Capture Designer]] > Customised Forms
 
</div>
 
</div>
 
{|style="width: 100%"
 
{|style="width: 100%"
Line 6: Line 10:
 
|style="width:73%"|
 
|style="width:73%"|
 
== Introduction ==
 
== Introduction ==
As well as standard Progressive Capture forms that are provided with each app, Hornbill also provides the ability to create your own custom forms. With custom forms, you can create multiple questions of different field types for users and customers to answer during progressive capture.
+
As well as standard Capture forms that are provided with each app, Hornbill also provides the ability to create your own custom forms. With custom forms, you can create multiple questions of different field types for users and customers to answer during Intelligent Capture.
 
|style="width:5%"|
 
|style="width:5%"|
 
|
 
|
Line 13: Line 17:
 
== Related Articles ==
 
== Related Articles ==
 
:* [[Mapping_Fields_from_Customised_Forms|Mapping fields from custom forms]]
 
:* [[Mapping_Fields_from_Customised_Forms|Mapping fields from custom forms]]
:* [[Progressive_Capture_Designer#Displaying_Conditional_Fields|Displaying Conditional Fields]]
+
:* [[Intelligent Capture Designer#Displaying_Conditional_Fields|Displaying Conditional Fields]]
 
:* [[Wiki_Markup|Wiki Markup]]
 
:* [[Wiki_Markup|Wiki Markup]]
 
|}
 
|}
Line 22: Line 26:
 
[[File:pcf_customForm2_formProperties.png |right|300px|form properties including form id and form prompt]]
 
[[File:pcf_customForm2_formProperties.png |right|300px|form properties including form id and form prompt]]
 
:* '''Custom Form Name'''
 
:* '''Custom Form Name'''
:: The display name for the node on the progressive capture designer
+
:: The display name for the node on the intelligent capture designer
 
:* '''Purpose'''
 
:* '''Purpose'''
 
:: A text field to record the purpose of the custom form (optional)
 
:: A text field to record the purpose of the custom form (optional)
Line 31: Line 35:
 
:: A default language version of the custom form is provided, but you can opt to create different language versions of the custom form by selecting another available language and populating the labels, answers in different languages.
 
:: A default language version of the custom form is provided, but you can opt to create different language versions of the custom form by selecting another available language and populating the labels, answers in different languages.
 
:* '''Form Id'''  
 
:* '''Form Id'''  
:: This is the unique identifier for the custom form, this can be used later to identify the answers to your questions when using the Hornbill [[Business Process Designer |Business Process Workflow]] engine.  
+
:: This is the unique identifier for the custom form, this can be used later to identify the answers to your questions when using the Hornbill [[Business Process Designer |Business Process Workflow]] engine.
 +
::'''Note:''' The Form Id must be at least 3 characters in length
 
:*'''Form Prompt'''  
 
:*'''Form Prompt'''  
 
:: This is any text you wish to appear with the custom form to help identify it's purpose
 
:: This is any text you wish to appear with the custom form to help identify it's purpose
 
:*'''Never Skip Form'''
 
:*'''Never Skip Form'''
:: 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.
+
:: 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 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.
  
 
=== Form Fields ===
 
=== Form Fields ===
Line 54: Line 59:
  
 
:* '''Field Id'''  
 
:* '''Field Id'''  
:: This is the unique id for the question on the custom form.  This can normally be left, unless you are wanting to map the answer from this question to a custom field on a request, where a field mapping needs to be given.  Read about [[  Progressive_Capture_Designer#Mapping_Fields_from_Customised_Forms| field mappings]]  
+
:: This is the unique id for the question on the custom form.  This can normally be left, unless you are wanting to map the answer from this question to a custom field on a request, where a field mapping needs to be given.  Read about [[  Intelligent Capture Designer#Mapping_Fields_from_Customised_Forms| field mappings]]  
 +
::'''Note:''' The Field Id must be at least 3 characters in length
 
:* '''Label'''
 
:* '''Label'''
 
:: This will be the label used to represent the question on the custom form
 
:: This will be the label used to represent the question on the custom form
Line 118: Line 124:
 
:* Regex Field Validation
 
:* Regex Field Validation
  
[[Category:Administration]][[Category:Videos]]
+
== Displaying Conditional Fields ==
 +
{{#ev:youtube|1dkfPvoKiZY|400|right}}
 +
 
 +
This feature allows for the showing or hiding of fields on custom capture forms based on the answers to other questions on either the same custom capture form, or answers to questions on previous capture forms (conditions).
 +
 
 +
* Add a new form field to a 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 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.
 +
 
 +
[[Category:HDOC]][[Category:Videos]]

Revision as of 22:22, 28 February 2024

This document can now be found at its new location in the Hornbill Document Library.

Customized Capture Forms