This section lists the properties that can be set as part of the data transformation map in Data Interchange Services client and their corresponding WebSphere Partner Gateway attributes. If these properties are set in the map, they take precedence over the WebSphere Partner Gateway flow definition or envelope profile attributes. Attributes listed for document flow definition also apply to the participant's B2B capabilities.
During runtime the WebSphere Partner Gateway configured attributes get manifested into the Business Document Object (BDO). The BDO contains the metadata about the document being processed. The properties in this table apply to source documents. These are typically used by the source EDI Validator and will be used for obtaining information from the BDO. Other maps may also use these values.
Data Interchange Services client property | Obtains the attribute values from WebSphere Partner Gateway | WebSphere Partner Gateway object |
---|---|---|
Alphanum | Alphanumeric validation table | Document flow definition |
Charset | Char set validation table | Document flow definition |
GrpLvlFA | Generate group level information only in functional acknowledgment | Document flow definition |
ServSegVal | Detailed validation segment | Document flow definition |
ValLevel | Validation level | Document flow definition |
ValErrLevel | Maximum validation error level | Document flow definition |
ValMap | Validation map | Document flow definition |
During runtime the WebSphere Partner Gateway configured attributes get manifested into the Business Document Object (BDO). The BDO contains metadata about the document being processed. The properties in this table apply to target documents. They are used in subsequent processing of the target document. They are set by the data transformation map, which overrides the value configured in WebSphere Partner Gateway.
Data Interchange Services client property | WebSphere Partner Gateway corresponding attribute | WebSphere Partner Gateway object |
---|---|---|
AckReq | Acknowledgment request | Envelope profile |
Alphanum | Alphanumeric validation table | Document flow definition |
Charset | Char set validation table | Document flow definition |
CtlNumFlag | Control numbers by Transaction Id | Envelope profile |
DIProlog | Does not apply | Runtime |
DocType | Document flow | Business Document Object (runtime) |
EdiDecNot (Decimal notation) | Decimal notation | Document flow definition |
EdiDeDlm (Data element separator) | Data element delimiter | Document flow definition |
EdiDeSep (Repeating data element separator) | Repeating data element separator | Document flow definition |
EdiRlsChar (Release character) | Release character | Document flow definition |
EdiSeDlm (Component data element separator) | Subelement delimiter | Document flow definition |
EdiSegDlm (Segment terminator) | Segment delimiter | Document flow definition |
EnvProfName | Envelope profile | Document flow definition |
EnvType | Envelope type | Envelope profile |
MaxDocs | Maximum transactions number | Envelope profile |
Package | Package | Business Document Object (runtime) |
Protocol | Protocol | Business Document Object (runtime) |
ReceiverTP | Target partner | Business Document Object (runtime) |
Reroute | Reroute | Business Document Object (runtime) |
SegOutput | Segment output | Document flow definition |
SenderTP | Sender partner | Business Document Object (runtime) |
ValLevel | Validation level | Document flow definition |
ValErrLevel | Maximum validation error level | Document flow definition |
ValMap | Validation map | Document flow definition |
The following table describes Data Interchange Services client properties that are generic to the EDI Envelope and their relationship to WebSphere Partner Gateway attributes. During runtime the WebSphere Partner Gateway configured attributes get manifested into the Business Document Object (BDO). The BDO contains the metadata about the document being processed.
When processing the source EDI Interchange document, the Data Interchange Services client properties can be used for reading the WebSphere Partner Gateway attributes from the BDO. For the target EDI Interchange document, the Data Interchange Services client properties can be used to override the WebSphere Partner Gateway attributes or to provide additional information in the target BDO.
Some of the listed Data Interchange Services client properties are not set from a map but are provided by a runtime component into a BDO and can then be read by a map or another runtime component. An example of such a property is GrpTrxCnt, which is indicated under the "WebSphere Partner Gateway corresponding attribute" column as "Does not apply."
Data Interchange Services client property | WebSphere Partner Gateway corresponding attribute | WebSphere Partner Gateway object |
---|---|---|
IchgCtlNum | Interchange control number | Control number initialization or status |
IchgSndrQl | Interchange sender qualifier | Document flow definition |
IchgSndrId | Interchange sender ID | Document flow definition |
IchgRcvrQl | Interchange receiver qualifier | Document flow definition |
IchgRcvrId | Interchange receiver ID | Document flow definition |
IchgDate | Does not apply | Runtime |
IchgTime | Does not apply | Runtime |
IchgPswd | Interchange password | Envelope profile |
IchgUsgInd | Interchange usage indicator | Document flow definition Envelope profile |
IchgAppRef | Interchange application reference | Envelope profile |
IchgVerRel | Interchange - depends on the standard | Envelope profile |
IchgGrpCnt | Does not apply | Runtime |
IchgCtlTotal | Does not apply | Runtime |
IchgTrxCnt | Does not apply | Runtime |
GrpCtlNum | Group control number | Control number initialization or status |
GrpFuncGrpId | Functional group ID | Envelope profile |
GrpAppSndrId | Group application sender ID | Document flow definition Envelope profile |
GrpAppRcvrId | Group application receiver ID | Document flow definition Envelope profile |
GrpDate | Does not apply | Runtime |
GrpTime | Does not apply | Runtime |
GrpPswd | Group password | Envelope profile |
GrpVer | Group version | Envelope profile |
GrpRel | Group release | Envelope profile |
GrpTrxCnt | Does not apply | Runtime |
TrxCtlNum | Transaction control number | Control number initialization or status |
TrxCode | Does not apply | Runtime |
TrxVer | Transaction version | Envelope profile |
TrxRel | Transaction release | Envelope profile |
TrxSegCnt | Does not apply | Runtime |
Examples:
SetProperty: The SetProperty command is used to set a special processing property of the target message. Various special properties are defined to control things such as the EDI envelope fields or the XML prolog. The SetProperty command uses the following format:
SetProperty(char propertyName, char propertyValue)
Where: propertyName is the property name to be set in the target message. propertyValue Is the value that it should be set to.
A list of target document properties may be obtained by right clicking the propertyName in the command.
Example: Override the segment terminator in a particular map. The following steps describe how to do this:
GetProperty: The GetProperty function is used to get a property of the source message. This can be used to retrieve information such as EDI envelope header elements. The GetProperty function uses the following format:
char GetProperty(char propertyName)
Where: propertyName is the name of the property you want to retrieve. Results: The value associated with the specified message property. If the propertyName is not set in the source message, an empty string is returned.
Example: var1 = GetProperty("ISA04") will set var1 to the value that was in the ISA04 element in the X12 ISA segment. The following steps describe this.