Scheduling Trading Partner Downtime

20-2 Oracle Fusion Middleware Users Guide for Oracle B2B infrastructure. Signing, encryptiondecryption, authentication, authorization, auditing, and reporting will be provided by this tool kit. Hence, this web service implementation will not address the details of security, signing, and encryption. Web service methods hold the business logic instead of security details. Based on the policy enforced in Oracle Weblogic Server console, the web service client must attach security details with the web services port.

20.2 Using the Outbound Web Service

The Outbound Web Service is exposed as a built-in internal listening channel, and messages are enqueued to this service. Based on the details and headers in soap:body, agreement identification is done and the message are routed to the partner. Table 20–1 , Table 20–2 , and Table 20–3 describe the Outbound Web Service request, response and fault notification message parameters. Table 20–1 Outbound Web Service Request Parameters Header Data Type Description Required from String Host name or identification value No to String Trading Partner name or identification value Yes type String Example: DUNS Identification type No documentProtocolVersion String Example: 4010 Document type version Yes 1 1 Either documentProtocolVersion and documentTypeName must be present, or action, service, and serviceType must be present. A custom generic case only requires action and not the others. documentTypeName String Example: 850 Document type name action String Example: PurchaseOrder ebMS action name service String Example: OrderProcessing ebMS service name serviceType String Example: string Default: string ebMS service type messageId String Message ID given in this parameter is used to create APP_Message. No replyToMessageId String Example: reply_msgID:collaborationID Holds the message ID of which message this reply goes to, along with the collaboration ID. No messageType String Type of the message No encoding String Example: ISO-8859-1 Default: UTF-8 Encoding format No payload Xsd:anyType Holds the payload Yes attachment Xsd:anyType Attachment, if any No Using the Oracle B2B Web Services 20-3

20.3 Using the Translation Web Service

The Translation Web Service translates the XML payload, such as HL7, EDI, to native format. Table 20–4 , Table 20–5 , and Table 20–6 describe the Translation Web Service request, response and fault notification message parameters. Table 20–2 Outbound Web Service Response Parameters Header Data Type Description Required isTransmitted Boolean If true, the message was successfully transmitted; otherwise false. Yes Table 20–3 Outbound Web Service Fault Message Parameters Header Data Type Description ExceptionMessage String If a fault is found, the Exception Stack Trace is transmitted. Note: If a non-EDI XML is sent, then the translated content contains the same payload as it is, provided the agreement matches in Oracle B2B server. If the EDI XML is sent for translation, and the document is involved as part of a batch, then the translated response will not translate the payload. Note: The Translation Web Service translates the EDI XML payload native format, but does not translate the native payload to XML. Note: Translation Web service requests are not differentiated from other outbound requests in reporting and metrics. Table 20–4 Translation Web Service Request Parameters Header Data Type Description Required from String Host name or identification value No to String Trading Partner name or identification value No type String Example: DUNS Identification type No action String Example: PurchaseOrder ebMS action name No documentProtocolVersion String Example: 4010 Document type version Yes 20-4 Oracle Fusion Middleware Users Guide for Oracle B2B

20.4 Using the Query API

The Query API retrieves the configured details from Oracle B2B, and share them with applications. Before initiating a message transmission from applications, a health check request is made for the given parameters. This check finds if any configurations exist, and how many are active. If no configuration is found, the application can stop message flow in its layer with the message no configuration found in B2B. The following APIs are provided: ■ Is Trading Partner Agreement Setup returns true if agreement found for the given inputs. See Section 20.4.1, Is Trading Partner Agreement Setup Parameters for parameter details. ■ Get Trading Partner Agreement Information returns agreement details. See Section 20.4.2, Get Trading Partner Agreement Information Parameters for parameter details.

20.4.1 Is Trading Partner Agreement Setup Parameters

documentTypeName String Example: 850 Document type name Yes encoding String Example: ISO-8859-1 Default: UTF-8 Encoding format No payload Xsd:anyType Holds the payload Yes Table 20–5 Translation Web Service Response Parameters Header Data Type Description Required payload Xsd:anyType Translated message, with the same encoding type sent in the request. Yes Table 20–6 Translation Web Service Fault Message Parameters Header Data Type Description ExceptionMessage String If a fault is found, the Exception Stack Trace is transmitted. Table 20–7 Is Trading Partner Agreement Setup Request Parameters Header Data Type Description Required from String Host name or identification value No to String Trading Partner name or identification value No Table 20–4 Cont. Translation Web Service Request Parameters Header Data Type Description Required