You are here: Section Rules Reference > Section Rules Summary > Field2GVM

Field2GVM

Use this section level rule to create a GVM variable from the fields in the current section. For instance, you can use this rule to store the system date for later use.

Syntax

Field2GVM (FieldName,GVMName)

Parameter	Description
FieldName	Name of the field on the current section from which the data is retrieved.
GVM name	Name of the GVM variable in which the retrieved data will be stored.

You can use this rule to output data into one of the batches or the NEWTRN.DAT file if the GVM variable name matches the field name in the DFD file.

GVM variables are essential part of Documaker Server. For example, the fields in the NEWTRAN.DAT file, or in recipient batch records are all GVM variables during runtime. This rule lets you take data from a field and place the data into a GVM variable. If that GVM variable happened to be one of the fields in a recipient batch record, it would be written out to the RCB file.

You can also use the \O parameter to identify fields the system should consider as optional.To flag a field as optional, include \O at the end of the field name. Here is an example:

Field2GVM Date\O,CurrentDate,DTE_CLOSED,DTEACCTCLSD

This example will not generate an error if Date cannot be located on the section. An error will be generated if DTE_CLOSED is missing.

If the system cannot find a field marked as optional, it will not change the destination GVM variable. This behavior supports situations where you map any of several fields that could be generated to the same GVM variable.

Note, that this rule creates a GVM variable if necessary. Therefore, be sure to check the spelling of the GVM variable name if you intend to use one created by a prior process. Otherwise, a new variable is created.

Keep in mind...

If the GVM variable you specify does not exist, it will be created. This differs from other rules which expect you to have defined the GVM variable by some other means. This means that if you misspell the variable name, you will not get an error because a GVM variable will be created for that name.
Designating a field as optional does not change the value of the GVM variable if the field is missing. The system does not clear the GVM variable of data just because a field is missing.