To add a system data field to a generic form template

Parent Previous Next

<This topic is in draft form only - it has been constructed solely from the corresponding requirements documentation and supporting use cases>


The procedure to add a system data field to a generic form template is as follows:

  1. Navigate to Quick Menu > Forms > Configuration > Form Definition. The Form Definition window is displayed.
  2. Expand an entity heading and select a generic form definition from the alphabetical list, or type its name into the Search Forms field. By default the list is filtered to show Current form definitions. An alternative filter can be applied using the Select view drop-down field: Expired, Future or All combinations 1.
  3. Click on Templates. The Templates tab is activated.
  4. Using the Select version drop-down field, choose the correct variant of the generic form template onto which an additional system data field will be inserted; all existing field elements are displayed in the design area. Otherwise, click on Create New Version to commence a new variant of the latest form template 2.
  5. Click on the Cx field heading. All system field element options are revealed as discrete objects, each containing a collection of related database components, supported by user-defined characteristics that control the behaviour and data validation thresholds at individual component level. Each available option and associated component attribute settings is summarised in the table below.
  6. To control the appearance of each component within the newly-added system field, click on the adjacent formatting icon (). The Formatting window is displayed, ready to apply a custom style. This procedural step mirrors that covered separately in the topic To assign custom field styles within a generic form template.
  7. To control the characteristics of each component within the newly-added system field, click on the adjacent properties icon (). The Settings window is displayed, ready to configure the operational and validation attributes. This procedural step mirrors that covered separately in the topic To assign custom field properties within a generic form template.
  8. Repeat steps 5 through 8 to add further system data fields onto the generic form template. The precise positioning of fields can be adjusted at any time, simply by dragging the corresponding element to the preferred placeholder location.
  9. Optionally, to remove a newly-added field, click on the adjacent delete icon ().
  10. Click on Save. All inserted field elements and proposed changes are stored against the current version number of the form template 3.


Note

1 The Search Forms field will match against any element of the generic form description.

2 Field element objects can only be transferred onto the design area once a form template version has been selected or created.

3 Where a new variant is being created, the version number is automatically assigned using a sequential counter.


Form Element Type

Field Component

Criteria Fields

Comments

Cx Address Field

Street, Town, Postcode

Maximum number of characters

Defines the upper validation threshold for the short character entry and appears as a single line on the published form.



Input Pattern

Defines the prescribed syntax for the captured text value e.g. AAAnnn, where 'A' represents a character and 'n' an integer.

Cx Asset Field

Asset Type

(Note: This asset-specific field component is a default placeholder and can be adjusted to represent a different focus area, if required)

Lookup Type (General Lookup)

Choosing the desired Cx lookup type parameter will enable one or more inherent values to be included as permitted form responses.



Lookup Type (System Lookup)

Choosing the desired Cx lookup type parameter will enable one or more inherent values to be included as permitted form responses.



Lookup Type (Table Lookup)

Choosing the inter-related Table name and Column name parameters will enable one or more inherent values to be included as permitted form responses.


Asset Description, Asset Address

Maximum number of characters

Defines the upper validation threshold for the short character entry, appearing as a single line on the published form.



Input Pattern

Defines the prescribed syntax for the captured text value e.g. AAAnnn, where 'A' represents a character and 'n' an integer.


Asset Image

Width & Height

Defines the desired image size in terms of pixels.

Cx Contact Field

First Name, Last Name

Maximum number of characters

Defines the upper validation threshold for the short character entry, appearing as a single line on the published form.



Input Pattern

Defines the prescribed syntax for the captured text value e.g. AAAnnn, where 'A' represents a character and 'n' an integer.


DOB

Minimum Date & Maximum Date

(Note: This maps to the Fixed Date validation type)

Defines the validation thresholds for a captured date value, with each cell linked to a dynamic calendar.



Minus / Plus 'x' Number of Days

(Note: This maps to the Dynamic Range validation type)

Defines the accepted variance  - expressed as an integer - between the current system date and a captured date value.



Validation Type

None, Dynamic Range or Fixed Dates.


Title, Marital Status, Companies, Contact Type

(Note: These contact-specific field components are default placeholders and can be adjusted to represent a different focus area, if required)

Lookup Type (General Lookup)

Choosing the desired Cx lookup type parameter will enable one or more inherent values to be included as permitted form responses.



Lookup Type (System Lookup)

Choosing the desired Cx lookup type parameter will enable one or more inherent values to be included as permitted form responses.



Lookup Type (Table Lookup)

Choosing the inter-related Table name and Column name parameters will enable one or more inherent values to be included as permitted form responses.

Cx Lookup Field

Cx Lookup

(Note: This field component placeholder can be adjusted to represent any system parameter or database table value)

Lookup Type (General Lookup)

Choosing the desired Cx lookup type parameter will enable one or more inherent values to be included as permitted form responses.



Lookup Type (System Lookup)

Choosing the desired Cx lookup type parameter will enable one or more inherent values to be included as permitted form responses.



Lookup Type (Table Lookup)

Choosing the inter-related Table name and Column name parameters will enable one or more inherent values to be included as permitted form responses.


See related topics...

To add a standardised entry field to a generic form template

To create a new generic form definition