19 Creating Reports

This chapter describes how to create OracleAS Integration B2B reports that describe the status of run-time behavior of a deployed configuration.

This chapter contains the following topics:

• Reports Overview

• Creating Business Message Status Reports

• Creating Wire Message Status Reports

• Creating Collaboration Status Reports

• Creating Error Status Reports

• Saving Reports

• Saving Report Definitions

• Importing Reports

• Summary

19.1 Reports Overview

Instance data exists in the runtime repository as business messages are exchanged. The OracleAS Integration B2B user interface enables you to query this information to see what is occurring and to perform business analysis. You can query this information in several different ways based on the type that you want. Specifically, you can query for information such as business message status, wire message status, collaboration status, and errors.

19.1.1 Reports User Role

A trading partner can include individuals such as business analysts who must be able to create and analyze configuration reports.

For these situations, OracleAS Integration B2B provides a Reports user role that you can assign to host trading partner users. This role provides a user with access to only the functionality of the Reports tab of the OracleAS Integration B2B user interface. A user with this role cannot see or access the other parts of the user interface.

Note that a host trading partner user with the Administrator role can access the functionality of the entire OracleAS Integration B2B user interface, including the Reports tab.

See "Assigning a User Role to a Host Trading Partner Person" for instructions on assigning the Reports role to a host trading partner user.

19.2 Creating Business Message Status Reports

Business message status reports identify business message instance details for an electronic data interchange (EDI) or Custom Document business protocol. These details include the sending and receiving trading partners, exchange protocol, document protocol, business action and its state, message date, and message details.

Follow these instructions to create a business message status report.

1. Click Reports, and then Business Message.

   The Business Message Report Definition page appears.

2. Enter the following details. An asterisk (*) indicates a required field.

   Field	Value
   Name*	Accept the default business message report name or enter a unique and recognizable name.
   Start Date	Use the calendar icon to select the date at which to start collecting message details.
   End Date	Use the calendar icon to select the date at which to complete collecting message details.
   Business Action Name	Select the business action from the list.

   
   

3. If you want to specify advanced report parameters, click Show Advanced Report Options.

4. Enter the following details:

   Field	Value
   Business Message Id	Enter an identifier in the field. This is a 16-digit value that you can obtain from the Oracle_Home/ip/log/b2b/b2b.log file. You can enter a portion of this value, and all values that include the portion entered are returned.
   Business Message Status	Select the status of the business message from the list: Aborted Message processing was aborted. Collab Wait A message is waiting for collaboration activity to complete. Complete Message delivery and all processing has completed. Continue Process Message processing is continuing. Error An error occurred during message processing. Invalid The message is invalid. Out of Band Error An out-of-band error has occurred. Process Ack An acknowledgment message is processing for this business message (not a valid state for an acknowledgment message). Process Exp An exception message is processing for this business message (not a valid state for an exception message). Send Ack An acknowledgment message has been sent. Send Exp An exception message has been sent. Transmit Failed Message transmission has failed. Depending upon the number of retries specified, this message may be sent later. If all retries fail, the status of this message changes to an error. Wait Ack Waiting for an acknowledgment message. Wait Transmit Waiting for a message to be transmitted.
   Sending Trading Partner	Select the trading partner that sent the message.
   Receiving Trading Partner	Select the trading partner that received the message.
   Sending Trading Partner Identification	Select the trading partner identification type of the sending trading partner (for example, DUNS or EDI Location Code).
   Sending Trading Partner Value	Select the sending trading partner identification type value. For example, if you selected DUNS, select the Data Universal Numbering System (DUNS) number.
   Receiving Trading Partner Identification	Select the trading partner identification type of the receiving trading partner.
   Receiving Trading Partner Value	Select the receiving trading partner identification type value.
   Business Protocol	Select the specific EDI, RosettaNet, or Custom Document business protocol used in this business transaction between sending and receiving trading partners.
   Agreement Name	Select the trading partner agreement in which the sending and receiving trading partners are participants.
   Configuration Name	Select the configuration that includes this trading partner agreement. By default, the report results come from the latest active configuration.
   Comments	Enter comments to display under the title after report creation is complete.

   
   

5. Click Run Report.

   The status report appears.

6. View specific details. If you want to save the report results to a comma-delimited file, click Save Report.

7. If you want to save the report definition, click Save Definition.

19.3 Creating Wire Message Status Reports

Wire messages are the native format of data sent from trading partners. Wire messages can contain a number of sections, such as payloads, attachments, or trailers. Wire message status reports identify details about wire message instances, such as the transport protocol name, the transport protocol revision, and the protocol message identification and its state.

Follow these instructions to create a wire message status report.

1. Click Reports, and then Wire Message.

   The Wire Message Report Definition page appears.

2. Enter the following details. An asterisk (*) indicates a required field.

   Field	Value
   Name*	Accept the default wire message report name or enter a unique and recognizable name.
   Start Date	Use the calendar icon to select the date at which to start collecting message details.
   End Date	Use the calendar icon to select the date at which to complete collecting message details.
   Protocol Message Id	Enter the protocol message identification. You can obtain this value from the Oracle_Home/ip/log/b2b/b2b.log file or from the trading partners that sent or received the message. You can enter a portion of this value, and all values that include the portion entered are returned.
   Transport Protocol	Select a transport protocol about which to collect data from the list: AQ - 1.0 B2B Queues - 1.0 E-Mail - 1.0 FTP - 1.0 File - 1.0 HTTP - 1.0 HTTP - 1.0 (Secure) HTTP - 1.1 HTTP - 1.1 (Secure) JMS - 1.0 XML Gateway Queues - 1.0
   Wire Message Status	Select the wire message status from the list: Complete Message processing has completed. Consumed The message has been deleted. Error An error occurred during message processing. Processing The message is currently processing.

   
   

3. If you want to specify advanced report parameters, click Show Advanced Report Options.

4. Enter the following details:

   Field	Value
   Sending Trading Partner	Select the trading partner that sent the message.
   Receiving Trading Partner	Select the trading partner that received the message.
   Sending Trading Partner Identification	Select the trading partner identification type of the sending trading partner (for example, DUNS or EDI Location Code).
   Sending Trading Partner Value	Select the sending trading partner identification type value. For example, if you selected DUNS, select the DUNS number.
   Receiving Trading Partner Identification	Select the trading partner identification type of the receiving trading partner.
   Receiving Trading Partner Value	Select the receiving trading partner identification type value.
   Configuration Name	Select the configuration that includes this trading partner agreement. By default, the report results come from the latest active configuration.
   Comments	Enter comments to display under the title after report creation is complete.

   
   

5. Click Run Report.

   The status report appears.

6. View specific details. If you want to save the report results to a comma-delimited file, click Save Report.

7. If you want to save the report definition, click Save Definition.

19.4 Creating Collaboration Status Reports

Collaboration status reports identify collaboration instance details for the RosettaNet over RNIF business protocol. These details include the revision, protocol collaboration identification, state, and start and end times for the collaboration.

Follow these instructions to create a collaboration status report.

1. Click Reports, and then Collaboration.

   The Collaboration Report Definition page appears.

2. Enter the following details. An asterisk (*) indicates a required field.

   Field	Value
   Name*	Accept the default collaboration report name or enter a unique and recognizable name.
   Start Date	Use the calendar icon to select the date at which to start collecting message details.
   End Date	Use the calendar icon to select the date at which to complete collecting message details.
   Collaboration Name	Select the collaboration from the list (for example, 3A4).

   
   

3. If you want to specify advanced report parameters, click Show Advanced Report Options.

4. Enter the following details:

   Field	Value
   Protocol Collaboration Id	Enter an identifier in the field. You can obtain this value from the Oracle_Home/ip/log/b2b/b2b.log file or from the trading partners that sent or received the collaboration. You can enter a portion of this value, and all values that include the portion entered are returned.
   Collaboration Status	Select the collaboration message status from the list: Aborted Collaboration processing was aborted. Complete Collaboration delivery has completed. Error An error occurred during collaboration processing. In Progress The collaboration is currently in progress. Out of Band Error An out-of-band error has occurred.
   Sending Trading Partner	Select the trading partner that sent the message.
   Receiving Trading Partner	Select the trading partner that received the message.
   Sending Trading Partner Identification	Select the trading partner identification type of the sending trading partner (for example, DUNS or EDI Location Code).
   Sending Trading Partner Value	Select the sending trading partner identification type value. For example, if you selected DUNS, select the DUNS number.
   Receiving Trading Partner Identification	Select the trading partner identification type of the receiving trading partner.
   Receiving Trading Partner Value	Select the receiving trading partner identification type value.
   Agreement Name	Select the trading partner agreement in which the sending and receiving trading partners are participants.
   Configuration Name	Select the configuration that includes this trading partner agreement. By default, the report results come from the latest active configuration.
   Comments	Enter comments to display under the title after report creation is complete.

   
   

5. Click Run Report.

   The status report appears.

6. View specific details. If you want to save the report results to an XML file, click Save Report.

7. If you want to save the report results to a comma-delimited file, click Save Report.

8. If you want to save the report definition, click Save Definition.

19.5 Creating Error Status Reports

Error status reports identify error message details. These details include the error code, error text, business message identification, message date, and message details.

Follow these instructions to create an error message status report.

1. Click Reports, and then Error.

   The Error Report Definition page appears.

2. Enter the following details. An asterisk (*) indicates a required field.

   Field	Value
   Name*	Accept the default error status report name or enter a unique and recognizable name.
   Start Date	Use the calendar icon to select the date at which to start collecting message details.
   End Date	Use the calendar icon to select the date at which to complete collecting message details.
   Message Type	Select Business Message, select Wire Message, or leave this field unselected to collect data for both message types.

   
   

3. If you want to specify advanced report parameters, click Show Advanced Report Options.

   Field	Value
   Configuration Name	Select the configuration that includes this trading partner agreement. By default, the report results come from all configurations. For this reason, no configuration is selected by default.
   Comments	Enter comments to display under the title after report creation is complete.

   
   

4. Click Run Report.

   The status report appears.

5. View specific details. If you want to save the report results to a comma-delimited file, click Save Report.

6. If you want to save the report definition, click Save Definition.

19.6 Saving Reports

You can save the generated reports in comma-delimited format. This enables you to view reports in Microsoft Excel.

Follow these instructions to save the contents of a generated report:

1. Create an appropriate report.

2. Click Run Report.

   The status page appears.

3. Click Save Report.

   The report contents are saved to comma-delimited format. Only Microsoft Excel is supported for viewing comma-delimited reports.

19.7 Saving Report Definitions

You can save the contents of your generated reports to XML files. You can then reimport the report contents as needed into the OracleAS Integration B2B user interface.

Follow these instructions to save the contents of a generated report:

1. Create an appropriate report.

2. Click Run Report.

   The status page appears.

3. Click Save Definition.

   The report contents are copied to an XML file that you are prompted to open or download to a directory location.

19.8 Importing Reports

You can import a report that you saved previously to an XML file through the Save Definition option.

Follow these instructions to import a saved report:

1. Click Reports, and then Import.

   The Import page appears.

2. Click Browse to select a report definition file to import.

3. Click Finish.

   The report contents are reimported and the report results appear in OracleAS Integration B2B.

19.9 Summary

This chapter describes how to create business message, wire message, collaboration, and error status reports. This chapter also describes how to save report results to a comma-delimited file for viewing in Microsoft Excel and how to save the report definition to an XML file that you can later reimport into OracleAS Integration B2B.