Skip to main content

Settings for EDIFACT Business Operations

Provides reference information for settings of EDIFACT business operations.


EDIFACT business operations provide the following settings:

Group Settings
Basic Settings File Name
Additional Settings Auto Batch Parent Segs, Separators, Search Table Class, Validation, Reply Code Actions, No Fail While Disconnected

The remaining settings are either common to all business operations or are determined by the type of adapter. For information, see:

Auto Batch Parent Segs

(File and FTP only) If set to True, when writing a message that has a batch parent, output the batch headers first, and follow up with the batch trailers when triggered by the final batch parent header message or by a file name change. All child messages of a batch parent message are written out unless already written previously while Auto Batch Parent Segs = True.

File Name

(File and FTP only) The target file name. The File Path adapter setting determines the path for this file; File Name determines the name. File Name can include time stamp specifiers. If you leave File Name blank, the default uses the time stamp specifier %f_%Q where:

  • %f is the name of the data source, in this case the input filename

  • _ is the literal underscore character, which will appear in the output filename

  • %Q indicates ODBC format date and time

In substituting a value for the format code %f, InterSystems IRIS strips out any of the characters |,?,\,/,:,[,],<,>,&,,,;,NUL,BEL,TAB,CR,LF, replacing spaces with underscores (_), slashes (/) with hyphens (-), and colons (:) with dots (.).

See Time Stamp Specifications for Filenames.

No Fail While Disconnected

(HTTP only) If set to True, suspend counting seconds toward Failure Timeout while disconnected. Does not apply if Failure Timeout = -1 or StayConnected = 0.

Reply Code Actions

(HTTP only) A comma-separated list of codes specifying what action this process takes on various reply status conditions. See Reply Code Actions.

HTTP adapters provide more additional possible values; see EnsLib.EDI.EDIFACT.Operation.ReplyStandardOpens in a new tab.

Search Table Class

See Search Table Class in Settings for EDIFACT Business Services.


A string specifying characters to be used as separators for encoding outbound EDIFACT documents.

Separators accepts up to seven characters as input and defaults to :+?*'\r\n. Each character of input is interpreted from left to right as follows:

Position Separator Default value
1 Component Separator : (colon)
2 Data Element Separator + (plus sign)
3 Escape Separator ? (question mark)
4 Repetition Separator * (asterisk)
5 Segment Terminator ' (apostrophe)
6–7 appendix to Segment Terminator \r\n (new line)

If the Separators string is empty, the separator values supplied within each EDIFACT document will be used.

Any characters in positions 6 and 7 will be appended to the Segment Terminator. By default \r\n occupy these positions where \r (ASCII 13) represents a carriage return and \n (ASCII 10) represents a line feed. These characters resolve to a new line such that each segment is represented on its own line in output.


A question mark (?) also acts as an escape for characters reserved as separators. InterSystems IRIS will automatically escape any reserved characters in an EDIFACT message that were not previously separators. Conversely, InterSystems IRIS will un-escape any characters that were previously reserved but are no longer. For example, if ^ was the default Component Separator in a document and you set : to override it then any : characters will be escaped as ?:, any ^ separators will be converted to :, and any escaped ?^ characters will be converted to ^.


String specifying types of validation to perform; see EnsLib.EDI.EDIFACT.ValidatorOpens in a new tab for details. Any nonzero string invokes basic validation.

FeedbackOpens in a new tab