Creating a field definition

Often the content of one or several fields on the document are used (together with process rules) to specify which path a document will take through a process. In order to help you formulate a process rule for this purpose, XBOUND has to know which fields are expected to be on the document. For this you create field definitions.

Field definitions always apply to a particular document type, so first you must create a document type. Document types indicate the functional category of a document and are valid for a particular process.

This procedure is needed if you want to enter field values in the Edit Process Rule dialog.

Tip: Field definitions for email import can be created automatically. See The XBOUND Collector for IMAP dialog for details.

To create a field definition

1. Using the XBOUND Management Center, open a console containing the Process Designer.

2. Under Process Navigation, click the desired process.

3. In the Process area, click Document Types:

   

4. Select the document type for which you want to create a field definition.

5. Click the Open Lock button ( ).

6. In the new row that is displayed, specify the appropriate settings:

   Name	Type the name of the field.
   Type	Select the field type. The options are: Text Number Floating Point Number Date Group (a combination of two or more fields, for example Address [group] with city and postal code) Tip: Only text fields can be searched in the Process Monitor. If you need to be able to search in documents for the value of this field, select Text.
   Default value	If the field has a default value, specify it here.
   Min. value	If the field has a minimum value, specify it here (applies to the Number type).*
   Max. value	If the field has a maximum value, specify it here (applies to the Number type).*
   Min. length	If the field has a minimum length, specify it here (applies to the Text type).*
   Max. length	If the field has a maximum length, specify it here (applies to the Text type).*
   Mandatory	Select Mandatory if this field is required.* Select Read only if this field is to be read-only.*
   Read only
   Save history	When this option is activated, field changes are saved. This makes it possible to trace changes to the field. You can see if the field was changed, and when (such as during Verification). This option must be activated in order to generate Capture Statistics and other reports. Note: For this option to work, Save history must also be selected in the Document Type dialog.
   Use for report	This option makes field data available for analysis in its own report. The field data is accessible using the "Report Field" label. Note: The Agent for Reporting must also be configured.
   Report field	The name used as label in reports.

   * Warning: These settings are important when registering documents in XBOUND. In the Register Documents activity you can define fields that can or must be filled in upon registration. Such values are checked using the Min./Max. value and Min./Max. length options. If a field is read only, then a Function must be selected on the Document type tab of the Register Documents activity.

7. Click the closed lock button ().

8. Save the process by clicking the Save button:

   

Related topics

Deleting a field definition

Processes: Overview

Process Designer plug-in: Process area