Using Keyword Data Set Values - E-Forms - English - Foundation 22.1 - OnBase - Premier - external - Standard - Premier

Using Keyword Data Set Values - E-Forms - English - Foundation 22.1 - OnBase - Premier - external - Standard - Premier - Standard

E-Forms

Platform

OnBase

Product

E-Forms

Release

Foundation 22.1

License

Premier

Standard

A Keyword Data Set associated with the Keyword Type can automatically populate drop-down fields with Data Set values within E-Forms, HTML Custom Queries, and Workflow HTML user forms. Data Set values are appended to any existing values associated with the drop-down field. External Keyword Data Sets are also supported. The Keyword Type for the Data Set must be assigned to the Document Type. For more information on Keyword Type Data Set configuration, see the System Administration module reference guide.

Note:

Ensure fields are not mapped to empty Data Sets. If a Data Set is empty, values are not saved regardless of whether values are hard coded in the form for selection.

The field using a data set must be named using the following format: OBDataset_Keyword_Type_Name_#

The following table defines each part of the Keyword Data Set format:

OBDataset_	Each Keyword Type Data Set mapping must begin with OBDataset_ or OBDataset__. Note: OBDataset is followed by one underscore character (_) when using a Keyword Type Name and two underscores (__) when using a Keyword Type Number. The following limitations apply with this piece of the Keyword Data Set format: If creating scripts to manipulate E-Form data, please note that the OBDataset_ mapping is converted to an OBKey_ mapping in the OnBase Client. When using data sets within E-Forms, data set values should have only one space between each word. Regardless of if more than one space is placed between words within a data set value, only one space is displayed and stored when using the data set value in an E-Form.
Keyword_Type_Name or Keyword Type #	Keyword Type Data Sets are mapped similarly to Keywords. The name of the Keyword Type to which the form field is mapped can be identified by the Keyword Type Name or the Keyword Type Number. The Keyword Type Name must match the Keyword Type Name configured in the system. Map codes are not case sensitive. The Keyword Type Name must appear in the map with underscores rather than spaces. For example, the Keyword Type Request Type is mapped as Request_Type_# or request _type_#.
#	The number of occurrences of the Keyword on the form. For example, the first use of the Keyword Type Request Type would be mapped as Request_Type_1. The second occurrence would be mapped as Request_Type_2, and so on. Note: If the Keyword Type is also mapped on the same form using the OBKey_ or OBKey__ mappings described above, then subsequent uses of OBDataset_ mappings must have the number of occurrences properly incremented. For example, if OBKey__1_1 is included on the form, then a second Data Set mapping must be OBDataset__1_2.

OBDataset_

Each Keyword Type Data Set mapping must begin with OBDataset_ or OBDataset__.

Note:

OBDataset is followed by one underscore character (_) when using a Keyword Type Name and two underscores (__) when using a Keyword Type Number.

The following limitations apply with this piece of the Keyword Data Set format:

If creating scripts to manipulate E-Form data, please note that the OBDataset_ mapping is converted to an OBKey_ mapping in the OnBase Client.
When using data sets within E-Forms, data set values should have only one space between each word. Regardless of if more than one space is placed between words within a data set value, only one space is displayed and stored when using the data set value in an E-Form.

Keyword_Type_Name or Keyword Type #

Keyword Type Data Sets are mapped similarly to Keywords. The name of the Keyword Type to which the form field is mapped can be identified by the Keyword Type Name or the Keyword Type Number. The Keyword Type Name must match the Keyword Type Name configured in the system. Map codes are not case sensitive. The Keyword Type Name must appear in the map with underscores rather than spaces. For example, the Keyword Type Request Type is mapped as Request_Type_# or request _type_#.

The number of occurrences of the Keyword on the form. For example, the first use of the Keyword Type Request Type would be mapped as Request_Type_1. The second occurrence would be mapped as Request_Type_2, and so on.

Note:

If the Keyword Type is also mapped on the same form using the OBKey_ or OBKey__ mappings described above, then subsequent uses of OBDataset_ mappings must have the number of occurrences properly incremented. For example, if OBKey__1_1 is included on the form, then a second Data Set mapping must be OBDataset__1_2.

The following are examples of data set fields:

Single Selection List:

Multiple Selection List:

Note:

Any codes used to map Keywords, including the Keyword name itself, are not case sensitive.