The SyntaxCard setting defines the output card as a syntax card.

Configure an output card as a syntax card by using the card settings and selecting Yes for the SyntaxCard setting. The default value for the SyntaxCard setting is NO.

When you specify a card as a syntax card, the map passes any syntax items it created to the next card. A map uses a syntax card so that the delimiter structure defined for a variable syntax object persists as the data flows from one output card to the next output card in the map. The card that follows a syntax card inherits the delimiter structure that is set by a syntax card.

A syntax card works with other output cards in the following way:
  1. Output card 1 is defined as a syntax card. The syntax card maps most elements to =NONE and maps only the syntax items. For example, an EDI X12 element delimiter value can be represented as ="*".
  2. Output card 2 maps only the data. Output card 2 does not map the syntax items that are defined in output card 1. But the mapping process maps the data according to the output card 2 structure as if the syntax items have been set.

For example, when producing EDI such as X12 and EDIFACT documents, syntax elements define the syntax of the components in the EDI schema. The syntax can vary for each input. Without a syntax card, you must define the syntax elements in the envelope to use the syntax structure later on. When bursting, a map can produce many EDI transactions. Without a syntax card, the only way to initialize the syntax is to include an envelope in each burst. The service that reads the output from the map must strip the envelopes from the output.

When your map includes a syntax card, the syntax need not be initialized with each burst. Also, it is not necessary to strip the envelopes from the output.

There are additional requirements and considerations for using the SyntaxCard setting.

You might have a requirement to pass the syntax value on additional output cards that do not follow directly after the card that is configured as the syntax card. In this scenario, you must also set the SyntaxCard setting to Yes on all of the output cards in between the syntax card and the card that uses the syntax values defined on the syntax card. For example, output card 1 is the SyntaxCard. You need to use the syntax values on output card 3. Therefore, you must also set the SyntaxCard setting to Yes on output card 2.

On the syntax item in the schema where the Delimiter property value is Variable, you must set the FIND setting to NO. When the FIND setting is set to NO, the predefined or default value is mapped.

You must use the same schema for the output card defined as the syntax card and the output card that uses the syntax values defined on the syntax card.

Although you are not restricted from doing so, you should use only the output card that is defined as the syntax card to define the syntax items.