Using the HL7 Document Protocol

8-22 Oracle Fusion Middleware Users Guide for Oracle B2B Document Type Parameters When you create an HL7 document type, you can set various parameters. Figure 8–12 shows the document type parameters for an HL7 document. Figure 8–12 Document Type Parameters for an HL7 Document The image shows the HL7 Document Type screen. The first area of the screen shows the following fields: Document Type Name and Description. The first area also shows the Reset Parameter button. The second area of the screen shows the Transaction tab and displays the following fields: HL7 Generic ACK a check box, Map ACK Control Delimiters Tab Click Select Hexadecimal Characters next to any of the delimiter fields to provide values. See Table 8–4 for more about delimiters. Element Delimiter A single character that follows the segment identifier and separates each data element in a segment except the last. The value 0x7c is supplied. Escape Character The value 0x5c is supplied. Repeating Separator A service character used to separate adjacent occurrences of a repeating data element, or to separate multiple occurrences of a field.The value 0x7e is supplied. Segment Delimiter A syntax character indicating the end of a segment a logical grouping of data fields within a message. The value 0x0d is supplied. Subcomponent Delimiter The value 0x26 is supplied. Subelement Delimiter The value 0x5e is supplied. Miscellaneous Tab - Ignore Envelope Parameters Use this option to provide a list of envelope elements, separated by commas, to be ignored during look-up validation. The possible values depend on the identifiers used in the agreement. For an HL7 agreement, the possible values include MessageSendingApp, MessageReceivingApp, MessageSendingFacility, and MessageReceivingFacility. Table 8–11 Cont. Document Version Parameters for an HL7 Document Parameter Description Using Document Protocols 8-23 ID a check box, and Accept Acknowledgement a drop-down list At the top right of the screen are the Save and New Definition buttons. Table 8–12 describes the document type parameters for an HL7 document. Document Definition Parameters When you create an HL7 document definition, you can set various parameters. Figure 8–13 shows document definition parameters for an HL7 document. Figure 8–13 Document Definition Parameters for an HL7 Document The image shows the HL7 New Definition screen. The first area of the screen shows the following fields: Document Definition Name, Description, Definition, and Root XSD Name. The second area of the screen shows the following tabs: Transaction, Table 8–12 Document Type Parameters for an HL7 Document Parameter Description Transaction Tab - HL7 Generic ACK If selected, Oracle B2B sends a generic ACK immediately upon receiving an HL7 message. Map ACK Control ID Select to enable mapping the MSH.10 of the business message to the MSH.10 of the acknowledgment. Note: This Map ACK Control ID parameter is for the functional ACK. Accept Acknowledgement A functional acknowledgment is generated when MSH.15 has no value. Select None to take no action. Acknowledgment generation is dependent on the value in MSH.15 of the business message. Select AL always to generate the acknowledgment under any conditions. Select ER errorreject to generate the acknowledgment when the message errors or is rejected. Select SU successful completion to generate the acknowledgment when the message is successfully processed. 8-24 Oracle Fusion Middleware Users Guide for Oracle B2B Routing, XPath, Correlation, and Apps. The Transaction tab is selected and shows the following field: Transaction Set ecs File. Table 8–13 describes the document definition parameters for an HL7 document. About Using HL7 ■ No business message is produced for an HL7 immediate acknowledgment transport-level acknowledgment. When using AS2, you see one acknowledgment business message for MDN transport-level acknowledgment, and for ebMS, you see one acknowledgment business message in the business message report. In summary, because immediate acknowledgments are sent at the transport level, the entry is available only in the wire message report and not in the business message report. ■ Negative acknowledgment messages indicating errors in an HL7 exchange may be truncated because of the 80-character length limitation in HL7 versions 2.1 through 2.5. Table 8–13 Document Definition Parameters for an HL7 Document Parameter Description Transaction Tab - Transaction Set ecs File Use the Browse button to find the ecs file. Routing Tab - Document Routing ID Sets the consumer name to the back-end application XPath Tab See Section 8.1.1, How to Configure the XPath Expression for a Custom XML Document, for more information. XPath Name1 The XML XPath name for retrieving the value from the payload XPath Expression1 The XML XPath expression for retrieving the value from the payload XPath Name2 The XML XPath name for retrieving the value from the payload XPath Expression2 The XML XPath expression for retrieving the value from the payload XPath Name3 The XML XPath name for retrieving the value from the payload XPath Expression3 The XML XPath expression for retrieving the value from the payload Correlation Tab - Correlation From XPath Name The name of the correlation property for initiating the correlation. Correlation From XPath Expression The XML XPath for retrieving the value from the payload to initiate the correlation. Correlation To XPath Name The name of the correlation property for the correlation. Correlation To XPath Expression The XML XPath for retrieving the value from the payload for the correlation. Apps Tab - Document The name of the internal application document. Action A sub-classification within the document. XSLTFile The name of the XSLT file. Using Document Protocols 8-25

8.5 Using the OAG Document Protocol

Oracle B2B implements Open Applications Group OAG standards, a robust XML standard used across many industries. This standard defines messages as business object documents BODs. For information about the organization that created and maintains the OAG standards, go to http:www.oagi.org Document Version Parameters No parameters need to be set when you create the document version for an OAG document. Document Type Parameters When you create an OAG document type, you can set various parameters. Figure 8–14 shows the document type parameters for an OAG document. Figure 8–14 Document Type Parameters for an OAG Document The image shows the OAG Document Type screen. The first area of the screen shows the following fields: Document Type Name and Description. The first area also shows the Reset Parameter button. The second area of the screen shows the Control Area tab and displays the following fields: Logical Identifier, Component, Task, FA on Error, Language, Code Page, Authorization Identifier, and Date Time Qualifier. At the top right of the screen are the Save and New Definition buttons. Table 8–14 describes the document type parameters for an OAG document. 8-26 Oracle Fusion Middleware Users Guide for Oracle B2B Document Definition Parameters When you create an OAG document definition, you can set various parameters. Figure 8–15 shows document definition parameters for an OAG document. Figure 8–15 Document Definition Parameters for an OAG Document The image shows the OAG-7.2.1-PROCESS_PO_007--New Definition screen. The first area of the screen shows the following fields: Document Definition Name, Description, Definition, and Root XSD Name. The second area of the screen shows the following tabs: XML, Routing, XPath, Correlation, and Apps. The XML tab is selected and shows the following fields: Identification Expression XPath, Identification Value, and DTDXSD Namespace Conversion. Table 8–14 Document Type Parameters for an OAG Document Parameter Description Control Area Tab - Logical Identifier Logical Identifier Component Component Task Task FA on Error When enabled, CONFIRMATION flag is set to 1. Language Language Code Page Code Page Authorization Identifier Authorization Identifier Date Time Qualifier Date Time Qualifier attribute Using Document Protocols 8-27 Table 8–15 describes the document definition parameters for an OAG document.

8.6 Using the Positional Flat File Document Protocol

Oracle B2B supports message exchange for positional flat files, for example, NCPDP Telecom documents and SAP iDocs intermediate documents text files used with SAP applications. This adds capabilities beyond handling XML files and traditional EDI files based on various XML and EDI standards. Table 8–15 Document Definition Parameters for an OAG Document Parameter Description XML Tab - Identification Expression XPath Locates a node in the XML payload Identification Value Provides the value to match in the node identified by the identification expression. If the values match, then the document is successfully identified. If the value is left blank, then Oracle B2B checks for the existence of the node and the document is successfully identified. DTDXSD Namespace Conversion Select from None, Both, Inbound, or Outbound. Routing Tab - Document Routing ID Sets the consumer name to the back-end application XPath Tab See Section 8.1.1, How to Configure the XPath Expression for a Custom XML Document, for more information. XPath Name1 The XML XPath name for retrieving the value from the payload XPath Expression1 The XML XPath expression for retrieving the value from the payload XPath Name2 The XML XPath name for retrieving the value from the payload XPath Expression2 The XML XPath expression for retrieving the value from the payload XPath Name3 The XML XPath name for retrieving the value from the payload XPath Expression3 The XML XPath expression for retrieving the value from the payload Correlation Tab - Correlation From XPath Name The name of the correlation property for initiating the correlation. Correlation From XPath Expression The XML XPath for retrieving the value from the payload to initiate the correlation. Correlation To XPath Name The name of the correlation property for the correlation. Correlation To XPath Expression The XML XPath for retrieving the value from the payload for the correlation. Apps Tab - Document The name of the internal application document. Action A sub-classification within the document. XSLTFile The name of the XSLT file. Note: Positional flat files must be manually upgraded from 10g to 11g. 8-28 Oracle Fusion Middleware Users Guide for Oracle B2B Document Version Parameters No parameters need to be set when you create the document version for a positional flat file. Document Type Parameters No parameters need to be set when you create the document type for a positional flat file. Document Definition Parameters When you create a document definition for a positional flat file, you can set various parameters. Figure 8–16 shows document definition parameters for a positional flat file. Figure 8–16 Document Definition Parameters for a Positional Flat File including SAP iDocs The image shows the PositionalFlatFile Document Definition screen. The first area of the screen shows the following fields: Document Definition Name, Description, Definition, and Root XSD Name. The first area also shows the Reset Parameter button. The second area of the screen shows the following tabs: Transaction, Identification, Routing, XPath, Correlation, and Apps. The Transaction tab is selected and shows the Transaction Set ecs File field. At the top right of the screen is the Save button. Table 8–16 describes the document definition parameters for a positional flat file. Table 8–16 Document Definition Parameters for a Positional Flat File Parameter Description Transaction Tab - Transaction Set ecs File Use the Browse button to find the ecs file. Identification Tab -