Edifacttranslator ConfigurationThe component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.
EDIFACTTranslator Configuration Settings
|CloseStreamAfterTranslate: If true, the component will close the output stream after translation.When set to True (default), the component will close the output stream specified by SetOutputStream after Translate returns. If set to False the output stream will remain open. The default value is True.
|ComponentDelimiter: The delimiter character to use to separate components.When set, this changes the default delimiter to use to separate components within a data element. The default value depends on the EDI specification being used.
|CrossFieldValidationEnabled: Enables cross-field validation rules.If true, cross-field validation rules present in the document schema will be checked. The default value is false. Note, Bots Schema Files do not support syntax rules, therefore CrossFieldValidation rules will never execute for these schemas.
The document format.This property specifies standard that the document follows. Possible values are:
|ElementDelimiter: The delimiter character to use to separate data elements.When set, this changes the default delimiter to use to separate data elements within a segment. The default value depends on the EDI specification being used.
|Encoding: The character encoding to be applied when reading and writing data.If the data contains non-ASCII characters this setting should be specified so characters are properly preserved. This value should be set to a valid character set such as "UTF-8" or "ISO-8859-1".
Whether to include empty data elements in a composite element.When translating to EDIFACT or X12 this setting specifies whether empty data elements of a composite element will be included.
For instance when set to True (default) a segment may look like:
When set to False empty data elements are not include and a segment may look like:
|IncludeFooters: Whether to include footer information in the XML.This setting specifies whether footer information is included in the translated XML. For EDIFACT this includes UNT, UNE, and UNZ. For X12 this include GE, SE, and IEA. The default value is True.
|IncludeUNA: Whether to include the UNA segment in the output.This setting controls whether the output EDIFACT document contains the UNA segment. The default value is True. This may be set to False if there is a specific reason to not include the UNA segment.
An optional prefix for reserved names when translating to JSON.This setting optionally specifies a prefix to prepend to the meta, type, desc, and value JSON elements when translating to JSON. This may be set to any ASCII character if desired. For instance:
//use the '@' character
Will result in JSON like:
"@desc": "Authorization Information Qualifier",
The default value is empty string and no prefix is used.
|LastIXControlNumber: The control number of the most recently parsed interchange.This setting may be queried from within events. For instance from within the Warning event it may be desirable to know which interchange control number the warning applies to; in that case querying this setting from within Warning will return the expected value.
|LastTransactionControlNumber: The control number of the most recently parsed transaction.This setting may be queried from within events. For instance from within the Warning event it may be desirable to know which transaction control number the warning applies to; in that case querying this setting from within Warning will return the expected value.
|ReleaseChar: The character to use to escape delimiters within values.When set, this changes the default escape character. The default value depends on the EDI specification being used.
The renaming rules data.This setting may be used to get or set renaming rules without using a file on disk. When calling SaveRenamingRules
or LoadRenamingRules set the RuleFile parameter of the method to empty string to use the value in this
setting instead of a file on disk. For instance:
//Save Renaming Rules
string ruleData = editranslator.Config("RenamingRulesData");
//Load Renaming Rules
editranslator.Config("RenamingRulesData=" + ruleData);
|RepetitionChar: The repetition character.When set, this changes the default repetition character. The default value depends on the EDI specification being used.
|SegmentDelimiter: The delimiter character to use to separate segments.When set, this changes the default delimiter to use to separate segments within an EDI document. The default value depends on the EDI specification being used.
Specifies the behavior during schema validation.This setting specifies what happens when performing schema validation and a validation
warning occurs. By default this value is set to 1 (Warn) and the Warning event will fire, but processing
will not stop. See the WarnCode parameter list in the Warning event for details about
possible validation warnings. Possible values for this setting are:
Whether the human readable description is stored as an attribute or XML comments.When translating to XML the human readable description of the element will be included in the output.
This setting specifies whether the description is present as an attribute of the XML element, or
preceding the XML element as a XML comment. For instance:
UseXMLComments is True or 1:
<!--Entity Identifier Code-->
UseXMLComments is False or 0 (default):
<N101 desc="Entity Identifier Code">ST</N101>
The special value 2 tells the component to omit all comments. For instance:
UseXMLComments is 2:
This setting is False (0) by default.
Base Configuration Settings
|BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build.
Tells the component whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.
In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:
|UseDaemonThreads: Whether threads created by the component are daemon threads.If set to True (default), when the component creates a thread the thread's Daemon property will be explicitly set to True. When set to False the component will not set the Daemon property on the created thread. The default value is True.
|UseInternalSecurityAPI: Tells the component whether or not to use the system security libraries or an internal implementation. By default the component will use the system security libraries to perform cryptographic functions. Setting this to True tells the component to use the internal implementation instead of using the system's security API.