19 Creating Reports

This chapter describes Oracle B2B reports that provide real-time status on the runtime behavior of deployed data. It discusses business message report, wire message report, application message report, error report, and conversation report.

The chapter includes the following sections:

19.1 Introduction to Reports

Use the Reports link to search on data in the runtime repository. The Saved Search function is not available.

The following message types are available for searching:

Note:

In a cluster environment, if system time stamps are not synchronized for all nodes in the cluster, then you may see message time stamps that look incorrect, but are not. For example, given an unsynchronized, multinode cluster, if an outbound message is received on one node, but the reply is sent from another node, it is possible for a report to show message receipt at 4 a.m., but an acknowledgment sent at 3:55 a.m.

19.1.1 The Monitor User Role

For individuals such as business analysts who create and analyze message reports, Oracle B2B provides a monitor user role that an administrator can assign to trading partner users. This role provides a user with access to only the functionality of the Reports tab of Oracle B2B. A user with the Monitor role cannot see or access the other parts of the interface or see data for other trading partners. See Adding Trading Partner Users, for how to assign the Monitor role.

19.1.2 Purging Messages

From the Business Message tab, use the Purge button to purge one or more messages that display after you search the instance data.

19.1.3 Resubmitting Messages from Oracle B2B

If errors that occur when sending an inbound or outbound message are internal to Oracle B2B, then you can correct the problem and resend the message. For example, if B2B attempts to send a message to an endpoint that is not configured correctly, or if the agreement is not configured correctly, correct the error and use Resubmit for application messages or wire messages.

Resubmitting an application message, for an outbound message, replays the message from the time of receipt of the message and goes through agreement lookup, message translation (for EDI) and then finally the delivery is attempted. An application message resubmit is helpful when the agreement settings or document configuration is not as required and the message must be restructured with updated settings.

Resubmitting an application message, for an inbound message, attempts to deliver the message again to the back-end application. Resubmitting is useful when the back-end application is down and the delivery must be retried.

Resubmitting a wire message, for an outbound message, tries to redeliver only the previously processed message. There is no repackaging or other message transformation. This is helpful when the problem was with the delivery endpoint (for example, the partner's server is down and unable to receive the message).

Resubmitting a wire message, for an inbound message, replays the message from the time of receipt from the trading partner. The exchange and document are re-identified and an agreement lookup is done. The processed message is then delivered to the back-end. This is useful when the agreement or document setting are not correct and the message must be translated and validated again.

Note:

For EDI/EDIFACT documents, the user can set XPath expressions to check for, and thus avoid duplicates. If two messages arrive with the same XPath values, the latter of the messages is marked as duplicate and it errors out.

When you resubmit this errored duplicate message (a wire message resubmit), Oracle B2B processes the message ignoring the fact that it is a duplicate, because the resubmission is done intentionally. So, if you do not want Oracle B2B to process duplicate messages, you should not resubmit those messages.

Note:

If you resubmit an inbound AS2 synchronous wire message, the MDN is generated, but it is not returned to the sender in synchronous mode. This is because the sender is not the one who is initiating the originating message. In this scenario, the MDN message state is in the MSG_COMPLETE state.

19.1.3.1 Correlation Flow Id Response in B2B During Resubmission

Wire message-based inbound resubmission results in a new correlation flow id. It is treated as new business flow.

Inbound Application resubmission re-uses the correlation information because the B2B business information is not altered.

If you want to retain the correlation information, you can use Application message resubmission; if you are initiating a new flow completely, you can use wire resubmit.

For Outbound Application and Wire resubmission, existing correlation information is re-used as it is the same business flow in the background that is used.

19.2 Creating Business Message Reports

Business message status reports identify business message instance details for a document protocol. These details include the sending and receiving trading partners, the agreement name, the business action, the business message ID, the status, the exchange protocol and document protocol, and message details.

Figure 19-1 shows a business message report.

Figure 19-1 Business Message Report

Description of Figure 19-1 follows
Description of "Figure 19-1 Business Message Report"

To create a business message report:

  1. Click Reports, and then Business Message.
  2. Provide search parameters.
    Field Description

    Generate URL from current search criteria

    A URL is generated for the current search criteria. This URL can then be used for repeatable searches using the same search criteria without setting up the search criteria again.

    Basic/Advanced

    Click this toggle button to display a list of basic or advanced search criteria.

    Match

    Select All or Any.

    Sender

    Select from Starts With, Equals, Contains, or Ends With. Provide all or part of a trading partner name.

    Receiver

    Select from Starts With, Equals, Contains, or Ends With. Provide all or part of a trading partner name.

    Agreement

    Select from Starts With, Equals, Contains, or Ends With. Provide all or part of a trading partner agreement name.

    Send Time Stamp

    Select from Less Than, Greater Than, Greater Than Equals, Equals, or Less Than Equals. Provide a date and time in the format shown (MM/DD/YYYY HH:MM:SS AM/PM) or click the Select Date and Time button.

    Receive Time Stamp

    Select from Less Than, Greater Than, Greater Than Equals, Equals, or Less Than Equals. Provide a date and time in the format shown (MM/DD/YYYY HH:MM:SS AM/PM) or click the Select Date and Time button.

    State

    Select from the following message states (Equals is the only operator).

    All
MSG_COMPLETE 
MSG_ERROR
MSG_WAIT_TRANSMIT
MSG_WAIT_FA
MSG_SEND_FA
MSG_WAIT_BATCH
MSG_INVALID
MSG_CONTINUE_PROCESS
MSG_COLLAB_WAIT
MSG_PROCESS_ACK
MSG_SEND_ACK
MSG_WAIT_ACK
MSG_SEND_EXP
MSG_PROCESS_EXP
MSG_ABORTED
MSG_TRANSMITFAILED
MSG_WAIT_STACK
MSG_WAIT_TA1
MSG_SEND_TA1

    Message ID

    Select from Starts With, Equals, Contains, or Ends With. Provide all or part of a message ID.

    Correlation Flow

    Select from Starts With, Equals, Contains, or Ends With. Provide all or part of a correlation flow.

    Search Name

    This field enables user to search for the values of XPath Name1, XPath Name2, XPath Name3.

    Search Value

    Search for the values of XPath Value1, XPath Value2, XPath Value3 in B2B UI Reports.

    Search

    Click this button to start searching for the messages.

    Reset

    Click this button to reset the search criteria to the default state.
  3. To add more search fields, click Advanced and select from Add Fields. The following list shows the fields available:

    • Document Remaining Retry

    • Batch Id

    • Content Type

    • Sender Id Type

    • XPath Name1

    • XPath Name2

    • XPath Name3

    • Acknowledgement Mode

    • Delivered Endpoint

    • Created

    • Receiver Value

    • STATUS

    • Native Message Size

    • Collaboration Name

    • Document Protocol Version

    • Collaboration State

    • Correlation To XPath Value

    • Payload Name

    • Business Action Name

    • Group Control Number

    • Label

    • Document Definition

    • Modified

    • Attribute1, 2, 3, 4, 5

    • Business Transaction Name

    • Translated Message Size

    • Document Retry Interval

    • Business Transaction Id

    • Queue Time

    • Processing Time

    • Business Transaction Version

    • Correlation From XPath Name

    • Exchange Protocol Name and Version

    • Doc Attempt Count

    • Refer To Message Id

    • Job Id

    • Protocol Work Area

    • Direction

    • Response Mode

    • Sender Value

    • Document Protocol Name

    Use the document search parameters as follows: Select a document protocol name first to populate the list of document protocol versions; next select a document protocol version to populate the list of document types; and then select a document type to populate the list of document definitions.

  4. Click Search.

    View the results, as shown in Figure 19-1.

  5. In the Details column of the Results area, click the button to see report details.

    Figure 19-2 shows the business message details. The screen is in two columns, which makes reading it easier, without the need to scroll.

    Figure 19-2 Business Message Details

    Description of Figure 19-2 follows
    Description of "Figure 19-2 Business Message Details"

19.2.1 Message State Definition

Table 19-1 provides message state definitions.

Table 19-1 Message State Definitions

Message Descriptions

Stable status messages

-

MSG_COMPLETE

Business message state after completion of message transfer (and after receiving acknowledgment of the transmission if there is Ack/FA). The wire message state is moved to MSG_COMPLETE state as well.

MSG_WAIT_ACK

Business message state when an outbound message is sent to trading partner and B2B waits for Ack to be received.

MSG_ERROR

Business message state after a problem occurs in B2B or a negative acknowledgement is received from the trading partner. Wire message state is moved to MSG_ERROR state as well.

Intermittent status messages

-

MSG_WAIT_TRANSMIT

Business message state while B2B is sending message to trading partner. This state is also observed for the messages when they are queued in case of sequencing.

MSG_WAIT_FA

Business message state when an outbound message is sent to trading partner and B2B waits for Functional Ack to be received.

MSG_SEND_FA

Business message state when B2B is sending Functional Ack to trading partner.

MSG_WAIT_BATCH

Business message state while messages are batched up during the interval before batch expiration. After the batch expires, the entire batch of messages are sent out, and business and wire message states move to MSG_COMPLETE (or MSG_ERROR if a problem occurs).

MSG_WAIT_STACK

Business message state when there is any transport error in case of sequencing.

MSG_WAIT_TA1

Business message state while waiting for TA1 Message for EDI-X12.

MSG_SEND_TA1

Business message state while sending TA1 Message for EDI-X12.

MSG_CONTINUE_PROCESS

Business message state when message is being processed in B2B (engine).

MSG_COLLAB_WAIT

Business message state when message is waiting for Collaboration.

MSG_PROCESS_ACK

Business message state while processing an Acknowledgement.

MSG_SEND_ACK

Business message state when an inbound message is received from trading partner and B2B is sending an Acknowledgement.

MSG_SEND_EXP

Business message state while sending an Exception message.

MSG_PROCESS_EXP

Business message state while Processing an Exception Message

MSG_INVALD

This state is the default/first state when the message processing begins in B2B. This state should not be encountered while monitoring the Message states in B2B.

MSG_ABORTED

The message has been aborted.

19.3 Creating Wire Message Reports

Wire messages are the native format of data sent from trading partners. Wire messages can contain several 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. The reports enable you to go from a business message to its corresponding wire message and from a wire message to its corresponding business messages.

Figure 19-3 shows a wire message report.

Figure 19-3 Wire Message Report

Description of Figure 19-3 follows
Description of "Figure 19-3 Wire Message Report"

See Table 19-1 for a list of applicable message states.

To create a wire message report:

  1. Click Reports, and then Wire Message.
  2. Provide search parameters.
    Field Value

    Generate URL from current search criteria

    A URL is generated for the current search criteria. This URL can then be used for repeatable searches using the same search criteria without setting up the search criteria again.

    URL

    Select from Starts With, Equals, Contains, or Ends With. Provide all or part of the URL.

    Transport Protocol

    Select from Starts With, Equals, Contains, or Ends With. Provide all or part of the transport protocol.

    State

    Select from Starts With, Equals, Contains, or Ends With. Provide all or part of a message state:

    Created Date

    Select from Less Than, Greater Than, Greater Than Equals, Equals, or Less Than Equals. Provide a date and time in the format shown (MM/DD/YYYY HH:MM:SS AM/PM) or click the Select Date and Time button.

    Message ID

    Select from Starts With, Equals, Contains, or Ends With. Provide all or part of a message ID.

    Protocol message id

    The Protocol message id is the message id specific to the protocol if it is defined in the exchange/transport protocol.

    For example, in the AS2 exchange protocol, the Protocol message id is the Message-ID field in the HTTP header (http://www.ietf.org/rfc/rfc4130.txt page 12).

    You can use this Message-ID to identify the message exchanged between 2 B2B systems without specifying the details of the payload such as purchase order number or control numbers.

    If there is no message id specified in the protocol such as the custom exchange and file protocol, the protocol message id is auto-generated by B2B.

    For an outbound file transport protocol, the file name is used as the protocol message id.

    For the inbound file transport protocol, the file name is appended with a UUID (for example, prodatTXNUM.dat@0AF29CCD14586BE31190000075F71D16 comprised of prodatTXNUM.dat (filename) appended with @0AF29CCD14586BE31190000075F71D16
  3. To add more search fields, click Advanced and select from Add Fields.
    Field Description

    Document Protocol Name

    Select from Custom, EDI_EDIFACT, EDI_X2, HL7, OAG, PositionalFlatFile, RosettaNet, or UCCNet. (Equals is the only operator.)

    Document Type

    Select from a previously created document type, for example, 850 for EDI X12. (Equals is the only operator.)

    Document Protocol Version

    Select from a previously created document protocol version. (Equals is the only operator.)

    Document Definition

    Select from a previously created document definition. (Equals is the only operator.)
  4. Click Search.

    View the results, as shown in Figure 19-3.

  5. In the Details column of the Results area, click the button to see report details.

    Figure 19-4 shows wire message details.

    Figure 19-4 Wire Message Details

    Description of Figure 19-4 follows
    Description of "Figure 19-4 Wire Message Details"

19.4 Creating Application Message Reports

This report provides information related to the SOA Composite—the name, version, and so on, if a back-end composite application sent or received the message.

Figure 19-5 shows an application message report.

Figure 19-5 Application Message Report

Description of Figure 19-5 follows
Description of "Figure 19-5 Application Message Report"

See Table 19-1 for a list of applicable message states.

To create an application message report:

  1. Click Reports, and then Application Message.
  2. Provide search parameters.
    Field Description

    Match

    Select All or Any.

    Created Date

    Select from Less Than, Greater Than, Greater Than Equals, Equals, or Less Than Equals. Provide a date and time in the format shown (MM/DD/YYYY HH:MM:SS AM/PM) or click the Select Date and Time button.

    Document Protocol Name

    Select from Custom, EDI_EDIFACT, EDI_X2, HL7, OAG, PositionalFlatFile, RosettaNet, or UCCNet. (Equals is the only operator.)

    Document Protocol Version

    Select from a previously created document protocol version. (Equals is the only operator.)

    Document Type

    Select from a previously created document type, for example, 850 for EDI X12. (Equals is the only operator.)

    Document Definition

    Select from a previously created document definition. (Equals is the only operator.)

    State

    Select from Starts With, Equals, Contains, or Ends With. Provide all or part of a message state.

    ECID

    Select from Starts With, Equals, Contains, or Ends With. Provide an instance ID.

    Fabric CompositeDN

    Do not use.

    Service Name

    Select from Starts With, Equals, Contains, or Ends With. Provide the name of the B2B service binding component.

    Reference Name

    Select from Starts With, Equals, Contains, or Ends With. Provide the name of the B2B reference binding component.

    Domain Name

    Select from Starts With, Equals, Contains, or Ends With. Provide the name of the. basic administration unit that includes a special WebLogic Server instance called the Administration Server.

    Composite Name

    Select from Starts With, Equals, Contains, or Ends With. Provide all or part of the SOA composite application name.

    Composite Version

    Select from Starts With, Equals, Contains, or Ends With. Provide the version of the SOA composite application in Oracle JDeveloper.

    Composite Instance Id

    Select from Starts With, Equals, Contains, or Ends With. Provide the id of the composite application.

    Note:

    The application message pop-up in the B2B UI reports displays the following fields only when there is in-memory integration with fabric:

    • Domain Name

    • Composite Name

    • Composite Version

    • Service Name

    • Reference Name

  3. To add more search fields, click Advanced and select from Add Fields.
    Field Description

    Application Name

    Provide the name of the application.

    Composite Version

    Provide the version of the SOA composite application in Oracle JDeveloper.

    ECID

    Select from Starts With, Equals, Contains, or Ends With. Provide an instance ID.

    Sender ID Type

    Provide the sender's identifier type, such as Name, DUNS, or MLLP ID.

    Service Name

    Provide the name of the B2B service binding component.

    Receiver ID Type

    Provide the receiver's identifier type, such as Name, DUNS, or MLLP ID

    Receiver Value

    Provide the value of the receiver's identifier type. For example, if DUNS is the Receiver ID Type, provide the DUNS number.

    Sender Value

    Provide the value of the sender's identifier type. For example, if Name is the Sender ID Type, provide the trading partner name as set in the identifier type in the trading partner's profile.

    Reference Name

    Provide the name of the B2B reference binding component.

    Fabric CompositeDn

    Do not use.
  4. Click Search.

    View the results, as shown in Figure 19-5.

  5. In the Details column of the Results area, click the button to see report details.

    Figure 19-6 shows application message details.

    Figure 19-6 Application Message Details

    Description of Figure 19-6 follows
    Description of "Figure 19-6 Application Message Details"

19.5 Creating Error Reports

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

Figure 19-7 shows an error report.

Figure 19-7 Error Report

Description of Figure 19-7 follows
Description of "Figure 19-7 Error Report"

To create an error report:

  1. Click Reports, and then Error.
  2. Provide search parameters.
    Field Description

    Match

    Select All or Any.

    Error Code

    Select from Starts With, Equals, Contains, or Ends With. Provide all or part of an error code.

    Error Level

    Select from Starts With, Equals, Contains, or Ends With. Provide all or part of an error level

    Error Severity

    Select from Starts With, Equals, Contains, or Ends With. Provide all or part of an error severity.

    Error Text

    Select from Starts With, Equals, Contains, or Ends With. Provide all or part of the error text.

    Error Description

    Select from Starts With, Equals, Contains, or Ends With. Provide all or part of the error description.

    Send Time Stamp

    Select from Less Than, Greater Than, Greater Than Equals, Equals, or Less Than Equals. Provide a date and time in the format shown (MM/DD/YYYY HH:MM:SS AM/PM) or click the Select Date and Time button.
  3. To add more search fields, click Advanced and select from Add Fields.
    Field Description

    Document Definition

    Select from a previously created document definition. (Equals is the only operator.)

    Document Type

    Select from a previously created document type, for example, 850 for EDI X12. (Equals is the only operator.)

    Document Protocol Version

    Select from a previously created document protocol version. (Equals is the only operator.)

    Document Protocol Name

    Select from Custom, EDI_EDIFACT, EDI_X2, HL7, OAG, PositionalFlatFile, RosettaNet, or UCCNet. (Equals is the only operator.)
  4. Click Search.

    View the results, as shown in Figure 19-7.

  5. In the Details column of the Results area, click the button to see report details.

    Figure 19-8 shows error report details.

    Figure 19-8 Error Report Details

    Description of Figure 19-8 follows
    Description of "Figure 19-8 Error Report Details"

19.6 Creating Conversation Reports

A conversation message results when the correlation XPath is set in a document definition to correlate messages. A correlation message also shows messages that are correlated automatically.

For example, an AS2 message and its acknowledgment (MDN) are automatically correlated as part of a conversation. In RosettaNet, request and response messages are also correlated, in addition to the acknowledgments sent and received. These related messages are displayed on the Conversation tab.

Figure 19-9 shows a conversation report.

Figure 19-9 Conversation Report

Description of Figure 19-9 follows
Description of "Figure 19-9 Conversation Report"

To create a conversation report:

  1. Click Reports, and then Conversation.
  2. Provide search parameters.
    Field Description

    Match

    Select All or Any.

    Send Time Stamp

    Select from Less Than, Greater Than, Greater Than Equals, Equals, or Less Than Equals. Provide a date and time in the format shown (MM/DD/YYYY HH:MM:SS AM/PM) or click the Select Date and Time button.

    Collaboration Name

    Applies to ebMS and RosettaNet documents and is available from header information.

    Collaboration ID

    Applies to ebMS and RosettaNet documents and is available from header information.

    No additional fields can be added using the Advanced search button.

  3. Click Search.

    View the results, as shown in Figure 19-9.

  4. In the Details column of the Results area, click the button to see report details.

    Figure 19-10 shows conversation report details.

    Figure 19-10 Conversation Report Details

    Description of Figure 19-10 follows
    Description of "Figure 19-10 Conversation Report Details"