transmitdatagroups

Specifies which datagroups are filtered when the form is transmitted.

Filtering a datagroup means keeping or omitting all the data items that are in the specified datagroup.

For example, if a transmitdatagroups option specifies that the "attachments" datagroup should be kept, then all data items within the "attachments" group will be transmitted.

This filter applies to all data items present when transmitted, including those added as enclosures.

Syntax

   <transmitdatagroups>
      <filter>datagroup filter</filter>
      <datagroupref>datagroup reference₁</datagroupref>
      ...
      <datagroupref>datagroup reference_n</datagroupref>
   </transmitdatagroups>

Note: There may be any number of datagroup reference entries.

Table 1. transitdatagroups parameters
Parameter	Type	Description
datagroup filter	keep	include datagroups in the datagroup reference list with the transmission; omit those not in the list
	omit	omit datagroups in the datagroup reference list from the transmission; keep those not in the list
datagroup reference	string	identifies a datagroup whose data items will be filtered

Available in

action, button, cell

Examples

This sample specifies that only items of type data with a datagroup setting of enclosures should be transmitted:

   <transmitdatagroups>
      <filter>keep</filter>
      <datagroupref>enclosures</datagroupref>
   </transmitdatagroups>

This sample specifies that all items of type data except those with a datagroup setting of others should be kept in the transmission:

   <transmitdatagroups>
      <filter>omit</filter>
      <datagroupref>others</datagroupref>
   </transmitdatagroups>

Usage details

Default: omit nothing (keep all data items), unless the containing page is omitted.
Since enclosed files can belong to several datagroups, and datagroups can contain several enclosed files, care must be exercised when setting up transmitdatagroups options to ensure that only the desired datagroups are filtered.
Other filters may take precedence over the transmitdatagroups option. Refer to Order of precedence of filters for more information on the order of precedence of filters.