This chapter covers the following topics:
To easily track business transactions raised within Oracle E-Business Suite and messages exchanged with trading partners, Oracle XML Gateway uses the Collaboration History feature to record these business processes or events such as purchase order, change order. When an order is cancelled or created, relevant actions can be triggered such as notify the document owner or trading partner, or raise business events for the acknowledgement or exception handling. All of these business processes are tracked and recorded using the Collaboration History.
In order to capture business transactions or collaborations and also take actions in acknowledging or handling the business events, specifically Collaboration History comprises the following two components:
Collaboration History records all business transactions and messages exchanged with trading partners.
Collaboration History allows you to:
Record all key processing events of a unique collaboration or Partner Interface Process (PIP) from the initial event or message to the final message, including any exceptions issued by the trading partner or the business-to-business gateway.
Search history by business document number, date, status, document owner, or trading partner.
Reinitiate a collaboration.
View the XML payloads associated with a particular collaboration.
Use workflow events to create, update, and add details of collaboration history when implementing a collaboration.
A collaboration is an association where an enterprise that uses Oracle E-Business Suite exchanges messages with a trading partner. The trading partners use either an Oracle E-Business Suite application or the Internet for exchange of messages. Collaborations represent business processes such as purchase order, change order, inventory report, and item master. Collaborations usually require more than one interaction among the trading partners involved, with some involving existing business workflows.
For any collaboration, there can be many collaboration events. A collaboration event represents a system component that acts on information in a message or XML payload. Oracle XML Gateway generating an Open Applications Group (OAG) XML message and an Oracle E-Business Suite application accepting a change electronically are both collaboration events.
A collaboration event is supported by a XML payload or some collaboration event details. Some events have associated XML like an OAG CONFIRM_BOD or PROCESS_PO message.
For example, the Order Collaboration events are recorded as follows:
After a purchase order (PO) is approved and the collaboration is created or initiated, a new unique collaboration ID is assigned.
When the Oracle XML Gateway receives the PO Approval event and generates the OAG PROCESS_PO message. Once the message is available in the outbound Advanced Queue (AQ), a collaboration event is recorded.
When the business-to-business gateway picks up the message from the buy side Oracle E-Business Suite AQ, transforms it to a RosettaNet PO request, and sends it to the trading partner gateway through the Internet. The trading partner gateway returns an acknowledgement. This acknowledgement signal is transformed into an OAG CONFIRM_BOD by the business-to-business gateway and placed on the Oracle E-Business Suite AQ. During the inbound processing of this BOD by the Oracle XML Gateway, a collaboration event is recorded.
When the trading partner returns the PO confirmation request, the business-to-business gateway transforms it into an OAG ACKNOWLEDGE_PO BOD, and lists it on the buy side Oracle E-Business Suite AQ. During the inbound processing of this message by the Oracle XML Gateway, a collaboration event is recorded.
When the buy side Oracle E-Business Suite recognizes the ACKNOWLEDGE_PO BOD and generates an outbound Confirm_BOD. During the inbound processing of the Acknowledge_PO BOD by the Oracle XML Gateway and after the Confirm_BOD is generated, a collaboration event is recorded.
Use the resend feature of Collaboration History to reinitiate any eligible failed collaboration. An update event is raised to update the Collaboration History.
Whenever there is an exception in the business-to-business gateway of the host or that of the trading partner. An OAG CONFIRM_BOD is listed on the host Oracle E-Business Suite AQ by the Oracle XML Gateway and a collaboration event is recorded.
The collaboration event details contain information received from a trading partner or other target applications. The information can also include error messages and exceptions.
When an order is cancelled, Collaboration History uses the Notification Processing feature to provide generic and consistent methods to capture and take actions in response to the collaboration event.
Notification Processing allows you to:
Capture notification messages from sources outside the applications as business-to-business gateways or trading partners.
Capture exceptions generated by the Oracle XML Gateway.
Record notifications in Collaboration History.
Perform actions based on the notification settings as Notify System Administrator, Notify Trading Partner, Call a predefined API, Raise a predefined Business Event, and Start Workflow.
Provide predefined notification actions for all supported collaborations.
Permit customization of preseeded notifications to fit your business requirements.
Establish notification actions for new collaborations defined in Collaboration History.
Notification Processing is structured as notification types, notifications, and notification actions. Additionally, objects from the Collaboration History, such as applications and collaborations, are referenced and used to define portions of Notification Processing.
Notifications are raised to represent the success, exception, or error at predefined points within a collaboration. A notification is classified based on the source, that is, application, XML Gateway, or the business-to-business gateway. A notification action defines the action taken at a predefined point within a collaboration, based upon the notification raised.
The relationship between Collaboration History and Notification Processing is explained. Under the Notification Processing Subsystem, notification is defined for a notification source. Under Collaboration History Subsystem, collaboration is defined under applications. Notification actions are defined for a combination of collaboration and notification.
A notification is uniquely identified by a notification code and a notification source, which describes the location of the event within a given collaboration. An example of a notification source is the XML Gateway or the business-to-business gateway. A notification code is the actual error, warning, or status message passed from the notification source. Additionally, a description is specified for display purposes where notifications are referenced elsewhere.
Characteristics of a Notification Action
A notification action has the following characteristics:
A collaboration which is an occasion where messages are communicated between an enterprise that uses the Oracle E-Business Suite and a trading partner who uses the Internet or two Oracle E-Business Suite applications. Collaborations represent business processes such as an order, change order, forecast, or work-in-process action.
An application that owns the collaboration. For example, Oracle Purchasing or Oracle Order Management.
A notification source which describes the software component generating the notification.
A notification to describe the success, error, or warning.
All notification actions required for collaborations supported by Oracle Supply Chain Trading Connector are preseeded for supported transactions. All preseeded notification actions that handle error conditions are configured with the default action of notifying the administrator.
Additional business rules, such as initiating a workflow to place an inbound purchase order on hold when a trading partner identification error is encountered in a given collaboration, are specified using Notification Processing.
The notification processing engine handles the notifications from different sources such as the business-to-business gateway, Oracle XML Gateway, and Oracle E-Business Suite applications.
Business-to-Business Gateway
The business-to-business gateway generates a notice to Oracle E-Business Suite if it identifies an issue with the collaboration, such as Time to perform Exceeded (Notification Code: IP-05). The business-to-business gateway forms an OAG CONFIRM BOD and places it on the Oracle XML Gateway AQ. The Oracle XML Gateway processes the OAG CONFIRM BOD and passes it to the notification processing engine through an event subscription. The engine records an entry in the Collaboration History. Based on the notification code in the Confirm BOD and the setup data, the engine runs the indicated actions.
XML Gateway
The Oracle XML Gateway generates the XML messages outbound from Oracle E-Business Suite and uses the inbound messages to invoke the appropriate Oracle E-Business Suite APIs to affect a transaction. While processing these messages, if an error occurs, then the Oracle XML Gateway stops the process and raises a business event. The notification code is passed as a parameter of the event.
Oracle E-Business Suite Applications
For the inbound messages, APIs are called from the Oracle XML Gateway Message map. If the API returns an exception, then the application raises a business event. For example, the Order Import API raises an exception such as Invalid Sales Order Status (Notification Code: SO_IN03). This notification code is passed as a parameter of the event. The notification processing engine subscribes this event. The engine records an entry in the Collaboration History. Based on the notification code and the setup data, the engine runs the indicated actions.
Collaboration History uses the following windows to provide its features:
Use the Collaboration History window to view or monitor different business transactions and messages consumed by Oracle XML Gateway and exchanged between trading partners and Oracle E-Business Suite.
To view collaboration history, use the following ways to define your search:
To set up collaboration display information, see Using the Collaboration Display Setup Window and Updating the Collaboration Display Header and Details for details.
The Collaboration History simple search enables you to search collaborations based on application, document number, collaboration type, and collaboration standard. Enter the search criteria and initiate a query to view the collaborations.
Approve a purchase order and initiate an order collaboration.
Navigate to the Collaboration History window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor > Collaboration History.
To narrow the search in the Search region:
Select Collaboration Standard such as OAG, Rosettanet, UCCnet or you can leave it blank.
Select an appropriate Application.
Select Collaboration Type as one of the many collaboration types used. This includes values such as Change Order, Cancel Order, Change Planning, Change Order Notification, Forecast.
Enter Document Number such as a PO number or a customer order number. You can perform a search to find a value.
Click Go to view the search results. See: Viewing the Collaboration History Search Results.
Use the advanced search to search collaborations by a range of documents for a specific collaboration type. Enter the search criteria and initiate a query to view the collaborations.
Please note that you may enter additional search criteria through the advanced search if you have the Collaboration Standard, Application, and Collaboration Type fields in the simple search region specified and these values are corresponded with the fields you defined as the Display Labels Header for the Collaboration Display Setup window if it is set up properly.
For example, you enter "OAG" as collaboration standard, "Purchasing" as application, and "Order" as collaboration type in the simple search region. When clicking Show More Search Options, you can find additional search fields populated if you have the Collaboration Display Setup window defined properly for the collaborations with the same collaboration standard "OAG" and collaboration type "Order" in Oracle Purchasing application.
Note: You do not need to specify all the three fields mentioned here in the simple search region for additional search fields if the Collaboration Standard and Application, for example, are the only two fields that you defined in the Collaboration Display Setup window. In this case, you only need to enter "OAG" as collaboration standard and "Purchasing" as the application without specifying the collaboration type, such as "Order", and you can still see the additional search fields displayed in the advanced search region.
See Using the Collaboration Display Setup Window and Updating the Collaboration Display Header and Details for details.
Navigate to the Collaboration History window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor > Collaboration History.
Click the Show More Search Option link to see more search fields displayed in the Collaboration History window in addition to the Simple Search Criteria, collaboration standard, type, application, and document number
To narrow the search with additional criteria:
Select Organization name for your search.
Enter the Initiate Date From and Initiate Date To fields as the range to search for transactions that are initiated, terminated, or completed.
Enter Collaboration as a specific collaboration instance by entering the number. You can perform a search to find a desired value.
Enter Trading Partner for your search. You can perform a search to find a desired value.
Select Collaboration Status as Completed Normal, Completed Error, Initiated, Resent, Started, or Terminated.
Select Disposition from the drop-down list with the values such as Accepted, Failed, Pending, Reviewed, Synchronized, or Rejected.
The Disposition indicates the outcome of a collaboration, which can be rejected by a trading partner even though the collaboration is completed normally.
Click Go to view the search results. See: Viewing the Collaboration History Search Results.
After a simple or an advanced search, collaborations that match the search criteria are displayed in the Collaboration History search results region in the Collaboration History windows. Each line in the results region is for one collaboration. For each collaboration, you can the following information displays: document number or other display name (such as "PO") specified in the Collaboration Display Setup window, collaboration, collaboration type, collaboration standard, application, collaboration date, trading partner, resend count, collaboration status, and disposition.
Note: In addition to Document Number, you can also rename the following three more parameters in the Collaboration Display Setup window for your applications: Document Owner, Message Initiator, and Partner Document Number. Also, you may see additional fields displayed in the search result region if you have the collaboration display information defined properly in the Collaboration Display Setup window and have those additional fields selected in the Display Enabled For Results Table check box. See Using the Collaboration Display Setup Window and Updating the Collaboration Display Header and Details for details.
From the Collaboration History window, you can perform the following tasks:
View the collaboration search results
Reinitiate collaborations that resulted in errors by selecting one or more collaborations in the enabled Select check box and then click Reinitiate.
When reinitiating a collaboration, you will only resend the initiating message to the trading partner, not all the events in the collaboration. This rule should apply for both inbound and outbound messages on the Collaboration History window.
Collaborations whether they can be resent depend on their associated message types. If the Select check box is not enabled, then you cannot resend the collaboration. For more information on message types, see Creating a Collaboration Property.
View the details of a collaboration by clicking the collaboration number link you want to see to access the Collaboration Events window where displays all events for the selected collaboration. See: Using the Collaboration Events Window.
Use the Collaboration Events window to view read-only information for the collaboration details, such as collaboration number, status, date, type, document number, create and revision date.
Note: You may see additional fields displayed here if you have the collaboration display information defined properly in the Collaboration Display Setup window and have those additional fields selected in the Display Enabled For Events Screen check box. See Using the Collaboration Display Setup Window and Updating the Collaboration Display Header and Details for details.
In addition, all events for the collaboration are also listed in a table, including collaboration point, reference number, document type, direction, status, and messages when the trading partner returns a confirmation or rejection. You can also drill down to view event messages and payload information if it is available.
Search for a collaboration.
Enable Message in the Oracle XML Gateway for a collaboration point.
Enable Payload in the Oracle XML Gateway for a collaboration point.
Navigate to the Collaboration Events window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor > Collaboration History. Click the collaboration number link that you want to see from the Collaboration History search results.
Click the enabled Message link for a Collaboration Point to view the message details. See: Viewing the Collaboration Event Messages.
Click the enabled Payload for a Collaboration Point to view the payload details. See: Viewing the Collaboration Event XML Payload.
By clicking the enabled Message link in the Collaboration Events window, you can view the message details, including document number, reference 1, reference 2, reference 3, reference 4, reference 5, and message text. The reference fields store additional information about the event. The value of the reference fields are PIP dependent.
For example, for a 3A4, if an acknowledgement has five lines out of which two are rejected and three are accepted, then all five lines display in the event details; reference 1 is line number, reference 2 is item, reference 3 is accepted or rejected, and so on.
The message text contains the actual message, which explains the reason for accepting or rejecting a collaboration event handled by Oracle XML Gateway.
The Collaboration Event Payload window displays payload details, such as document number, collaboration number, collaboration point, type, event message, XML payload details.
By clicking Printable Page, you can print the collaboration event payload information.
Use the Collaboration Event Definitions window to query existing events. After performing a search, all events match with your search criteria are displayed in the results region.
In addition, you can also create a new event, update and delete an existing event. All collaboration events associated with the XML payload are set up using the Collaboration Event Definitions window.
Verify if you have the Workflow Administrator Web Applications responsibility to access the Collaboration Monitor: Setup privilege.
Define the necessary lookups.
Navigate to the Collaboration Event Definitions window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Collaboration Event Definition.
To narrow the search:
Select Transaction Type as the type of transaction in use. This list of values is preseeded or you can define the transaction types in the Oracle XML Gateway.
Select Transaction Subtype as the subtype of a transaction in use. This list of values is preseeded or you can define the transaction subtypes in the Oracle XML Gateway.
Select Document Direction as In or Out.
Select the collaboration Application such as Oracle Purchasing, iProcurement Connector, Oracle Inventory.
Select Document Type as one of the many documents used in the business transactions. This list includes values such as Acknowledge PO, Change PO, Item Master.
Select Collaboration Type as one of the many collaboration types used. This list includes values such as Cancel Order, Change Order Notification, Forecast.
Click Go to execute the search.
Navigate to the Collaboration Event Definitions window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Collaboration Event Definition.
Click Create Definition to create a new collaboration event in the Create Collaboration Event Definition window. See: Creating a Collaboration Event Definition.
Navigate to the Collaboration Event Definitions window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Collaboration Event Definition.
Search the collaboration event definition by entering search criteria.
Click the enabled Update for the collaboration event definition. The Update Collaboration Event Definition window appears. See: Updating a Collaboration Event Definition.
Click Delete to delete a collaboration event definition. You are prompted to confirm the deletion.
Use the Create Collaboration Event Definition window to create a new collaboration event definition.
Verify if you have the Workflow Administrator Web Applications responsibility to access the Collaboration Monitor: Setup privilege.
Define the necessary lookups.
Enter the new collaboration type in the relevant lookup for a new collaboration.
Enter the new application in the relevant lookup for a new application.
Enter the new document type in the relevant lookup for a new document type.
Navigate to the Create Collaboration Event Definition window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Collaboration Event Definition > the Create Definition button.
Select the values for the following fields:
Select Transaction Type as the type of transaction for your new event definition. This list of values is preseeded or you can define the transaction types in the Oracle XML Gateway.
Select Transaction Subtype as the subtype of a transaction. This list of values is preseeded or you can define the transaction subtypes in the Oracle XML Gateway.
Select Document Direction as In or Out.
Select the collaboration Application for your new event definition.
Select Document Type to be used in the business transactions.
Select Collaboration Type for your new event definition from the list of values such as Cancel Order, Change Order Notification, Forecast.
Click Apply to create a new collaboration event definition.
If the combination of values provided for the Transaction Type, Transaction Subtype, and Document Direction combination is not defined in the Oracle XML Gateway Transactions Setup, then an error message displays.
Use the Update Collaboration Event Definition window to update an existing collaboration event definition.
Verify if you have the Workflow Administrator Web Applications responsibility to access the Collaboration Monitor: Setup privilege.
Define the necessary lookups.
Navigate to the Collaboration Event Definitions window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Collaboration Event Definition.
Search the collaboration event definition by entering search criteria in the fields.
Click the enabled Update for a Transaction Type in the search results area.
Update the collaboration event by selecting appropriate values for the Transaction Type, Transaction Subtype, Document Direction, Document Type, Application, and Collaboration Type fields.
Click Apply to commit the modifications.
If the combination of values provided for the Transaction Type, Transaction Subtype, Document Direction, Application, Document Type, and Collaboration Type combination is not defined in Oracle XML Gateway Transactions Setup, then an error message displays.
See Setting Up a New Collaboration chapter for details.
The final collaboration event is generally an occurrence of an inbound or outbound message in the Oracle XML Gateway. It is set up in Collaboration History to record the final status of the overall collaboration.
Use the Collaboration Final Event Definitions window to query, update, and delete existing final events as well as create new final events.
Navigate to the Collaboration Final Event Definitions window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Collaboration Final Event Definition.
To narrow the search:
Select an appropriate value for the Application.
Select Collaboration Type for your search, such as Change Order, Cancel Order.
Select Document Type for the documents used in the business transactions, such as Acknowledge PO, Change PO, Item Master.
Select Document Direction as In or Out.
Click Go to perform a search.
Navigate to the Collaboration Final Event Definitions window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Collaboration Final Event Definition.
Click Create Definition to create a new final event in the Create Collaboration Final Event Definition window.
Navigate to the Collaboration Final Event Definitions window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Collaboration Final Event Definition.
Perform a search by entering search criteria.
Click the enabled Update for an Application in the search results area. The Update Collaboration Final Event Definition window appears.
Click Delete for the associated collaboration final event definition. You are prompted to confirm the delete action.
Use the Create Collaboration Final Event Definition window to create a new collaboration final event definition.
Navigate to the Create Collaboration Final Event Definition window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Collaboration Final Event Definition > the Create Definition button.
Select the values for the following fields:
Select a value for the collaboration Application.
Select Collaboration Type from the drop-down list.
Select Document Type for your new final event definition.
Select Document Direction as In or Out.
Select Collaboration Standard from the drop-down list.
Enter Message Count information for your new final event definition.
The Message Count field represents the total numbers of messages with the same application, document type, collaboration type, collaboration standard, and document direction.
Click Apply to create a new collaboration final event definition.
If the combination of values provided for the Application, Collaboration Type, Document Type, and Document Direction combination is not defined in Oracle XML Gateway Transactions Setup, then an error message displays.
After performing a search, you can update an existing final event definition by clicking the Update button associated with the event you want to update. The Update Collaboration Final Event Definition window appears.
Set up and activate the Collaboration Event Definition.
Navigate to the Update Collaboration Final Event Definition window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Collaboration Final Event Definition > the Update button.
Update your final event definition in the Application, Collaboration Type, Document Type, Document Direction, Collaboration Standard, and Message Count fields.
Click Apply to commit the modifications made to the selected collaboration final event definition.
If the combination of values provided for the Application, Document Type, Collaboration Type, and Document Direction combination is not defined in Oracle XML Gateway Transactions Setup, then an error message displays.
Use the Collaboration Properties window to associate collaboration types and application names with appropriate message types. These message types indicate the different nature of the collaborations. Based on the message types, collaborations displayed in the Collaboration History window can be resent in case they fail.
You can query existing collaboration properties, create new collaboration properties, and update or delete existing ones in the Collaboration Properties window.
Navigate to the Collaboration Property window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Collaboration Property.
To narrow the search:
Select Application such as Oracle Purchasing, Oracle Inventory.
Select Collaboration Type such as Cancel Order, Forecast for your collaboration.
Select Message Type such as Notify, Distribute, Sync, and Request.
Click Go to execute the search.
Navigate to the Collaboration Property window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Collaboration Property.
Click Create Collaboration Property to open the Create Collaboration Property window. See: Creating a Collaboration Property.
Navigate to the Collaboration Property window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Collaboration Property.
Perform a search by entering search criteria in the Collaboration Property window.
Click the enabled Update for a collaboration property in the search results area. The Update Collaboration Property window appears.
Click the enabled Delete for a collaboration property in the search results area. You are prompted to confirm the delete action.
Use the Create Collaboration Property window to associate collaboration types and application names with appropriate message types. These message types indicate the different nature of the collaborations. Based on the message types, collaborations displayed in the Collaboration History window can be resent in case they fail.
For example, a Notify message type is associated with Oracle Purchasing with Ship Notice as the collaboration type, then the Reinitiate action should be available in the Collaboration History window for the Purchasing Ship Notice type of collaborations with statuses of Started, Complete Normal, and Completed Error. If it is a Request message type, then the Reinitiate action should be available only when the collaboration status is Started or Completed Error. For more information on reinitiating collaborations, see Viewing the Collaboration History Search Results.
Navigate to the Create Collaboration Property window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Collaboration Property > the Create Collaboration Property button.
Enter the following fields for your Collaboration Property:
Select a value for the collaboration Application.
Select Collaboration Type from the drop-down list.
Select Message Type for your new collaboration property.
Select Application Linking Function.
The Application Linking Function field is used to link the Collaboration History feature to product specific windows by specifying the function along with the full URL information. This field appears as document number for a collaboration event listed in the Collaboration History window.
Click Apply to create a new collaboration property.
After performing a search in the Collaboration Property window, you can update an existing collaboration property by clicking the Update button for the property that you want to update. The Update Collaboration Property window appears.
Navigate to the Update Collaboration Property window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Collaboration Property > the Update button.
Update the property fields for Application, Collaboration Type, Message Type, or Application Linking Function fields.
Click Apply to update the selected collaboration property.
Use the Collaboration Display Setup window to set up additional fields to be displayed in the Collaboration History window for the advanced search and search results screens, as well as in the Collaboration Events window.
For example, a display setup is created for events with Collaboration Standard UCCNet, Oracle Engineering Online application, and Collaboration Type UCCNet Worklist Query, then when you search for collaboration events with the same collaboration standard, type, and application using the Collaboration History window, you should find additional fields if you specified properly in the setup window for these particular events appear in the advanced search and search results screens. If you click the event name link from the search results screen, then you should also see additional fields displayed in the Collaboration Events window if those additional fields are selected properly in the display setup window. Notification receivers will also receive the notification with the event information in line with the display setup. See Updating the Collaboration Display Header and Details for details.
In addition, you can query existing collaboration display setups, update the header, update the details, view details, and delete existing setups.
Navigate to the Collaboration Display Setup window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Collaboration Display Setup.
To narrow the search in the Search region:
Select Collaboration Standard such as OAG, Rosettanet, or UCCnet.
Select Application such as Oracle Purchasing, Oracle Inventory.
Select Collaboration Type such as Cancel Order, Forecast for the display setup.
Click Go to execute the search. The search results are displayed in the tabular format.
Navigate to the Collaboration Display Setup window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Collaboration Display Setup.
Click Create Display Labels Header to open the Create Display Labels Header window. See: Creating a Collaboration Display Label Header.
Navigate to the Collaboration Display Setup window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Collaboration Display Setup.
Perform a search by entering search criteria in the Search region. The search results are displayed in the tabular format.
To update the header, click enabled Update Header to open the Update Display Labels Header window.
To update the details, click enabled Update Details to open the Update Display Labels Details window.
See: Updating the Collaboration Display Label Header and Details.
To delete an existing setup, click enabled Delete and confirm the action.
Use the Create Collaboration Display Labels Header window to create new display header information, including collaboration standard, application, and collaboration type.
Navigate to the Create Display Labels Header window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Collaboration Display Setup > the Create Display Labels Header button.
Enter the following information for your new display header:
Select Collaboration Standard such as OAG, Rosettanet, or UCCnet.
Select Application such as Oracle Purchasing, Oracle Inventory.
Select Collaboration Type such as Cancel Order, Forecast for the display setup.
Click Apply to confirm the creation.
You can update existing collaboration display header and details from the search results in the Collaboration Display Setup window.
The display header contains collaboration standard, type, and application information; the collaboration details contain the internal column names and associated display labels appropriate for calling applications. Each column name can have in the following attributes:
Search Enabled: This check box indicates that the associated column name can be added to the Collaboration History advanced search screen to search for the events with the same display header information.
See: Using an Advanced Search.
Displayed Enabled for Events Screen: This check box indicates that the associated column name can be displayed in the Collaboration Event window where you can view the read-only information for an event.
Display Enabled for Results Table: This check box indicates that the associated column name can be added to the Collaboration History search results screen for the events retrieved with the same display header information. It also indicates that notification receivers will received notifications with the event information containing this column.
Collaboration History allows you to change the following display names appropriate for your application needs:
Document Number
Document Owner
Message Initiator
Partner Document Number
Additionally, you can add more columns or delete an entry of a column name if you do not want it to be displayed as the collaboration details.
Navigate to the Update Display Labels Header window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Collaboration Display Setup > the Update Display Labels Header button.
Update the Collaboration Standard, Application, and Collaboration Type fields as needed.
Click Apply to confirm the changes.
Navigate to the Update Display Labels Details window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Collaboration Display Setup > the Update Display Labels Details button.
Update the following fields as needed:
Select CLN Column from the drop-down list, such as Attribute 1, Date Attribute 1, Document Number.
Enter Display Label for the CLN Column name you just entered.
Select the following check boxes for each of your Column name if it is necessary:
Search Enabled
Display Enabled for Events Screen
Display Enabled for Results Table
Optionally click Add Another Row to add more entries for your display details.
Click Delete to remove an entry of a record if it is necessary.
Click Apply to confirm the changes.
The Notification Definition window enables you to search a notification based on source, notification code, and notification description. Also, it enables you to create a new notification definition and update or delete an existing notification definition.
Define the application and collaboration type lookups.
Navigate to the Notification Definition window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Notification Definition.
To narrow the search:
Select Source as the software component generating the notification. This list includes values such as Oracle Applications, B2B Server, iProcurement Connector (ITG), XML Gateway.
Enter Notification Code as the actual error, warning, or status message passed from the notification source.
Enter Notification as the description of the notification. A notification description is specified for display purposes where notifications are referenced elsewhere.
Click Go. The window displays the results of the search.
Navigate to the Notification Definition window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Notification Definition.
Click Create Definition to open the Create Notification Definition window.
Navigate to the Notification Definition window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Notification Definition.
Search for a notification definition.
Click Update for a Source in the search results region to open the Update Notification Definition window. See: Updating a Notification Definition.
Click Delete for the associated notification definition. You are prompted to confirm the delete action.
Use the Create Notification Definition window to create a new notification definition.
Define the application and collaboration type lookups.
Navigate to the Create Notification Definition window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Notification Definition > the Create Definition button.
Enter the values for the following fields:
Select Source as the software component generating the notification. This list includes values such as Oracle Applications, B2B Server, iProcurement Connector, XML Gateway.
Enter Notification Code as the actual error, warning, or status message passed from the notification source. The Notification Code values are preseeded or you can define them in the Oracle XML Gateway.
Enter Notification as the description of the notification. A notification description is specified for display purposes where notifications are referenced elsewhere.
Click Apply to create a new notification definition.
After a search in the Notification Definition window, you can update an existing notification definition retrieved from the search. This update includes modifying its source, notification code, or notification description.
Define the application and collaboration type lookups.
Navigate to the Update Notification Definition window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Notification Definition > the Update button.
Update the values for the Source, Notification Code, or Notification fields.
The Notification field is the actual description of the notification to be displayed.
Click Apply to commit the changes.
When notifications are raised at predefined points, such as cancel orders or change orders, within a collaboration, notification actions are taken places and routed to appropriate people, such as notify administrators or document owners, based on your action definitions specified in the Notification Action Definitions window.
The notification action definition contains two parts:
Notification Action Header: The action header defines the combination of an application that owns the collaboration, collaboration type, source, and notification description.
Notification Action Details: The action details specify the information of how the action will be taken. For example, when a notification is triggered, then the document owner will be notified or relevant business events will be raised.
You can use the Notification Action Definitions window to search, create, update, or delete notification actions, as well as to view and update notification action details.
Define the notification code lookup.
Identify the user to send the notification.
Navigate to the Notification Action Definitions window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Notification Action Definition.
To narrow the search:
Select the collaboration Application where a collaboration occurs.
Select Collaboration Type such as Cancel Order, Change Order Notification, Forecast.
Select Source as the software component generating the notification. This list includes values such as Oracle Applications, B2B Server, iProcurement Connector, XML Gateway.
Enter Notification as the description of the notification.
A notification description is specified for display purposes where notifications are referenced elsewhere. You can search a notification from the Search and Select: Notification window, which displays a list of values.
Click Go. The window displays the results of the search.
Navigate to the Notification Action Definitions window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Notification Action Definition.
Click Create Definition to open the Create Notification Action Header window.
Navigate to the Notification Action Definitions window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Notification Action Definition.
Search for a notification.
You can perform the following tasks from the search results region:
To update a notification action header, click the enabled Update for a notification to open the Update Notification Action Header window.
To create and update notification action details, click the enabled Update Action Details for a notification to open the Notification Action Definition window.
To view notification action details, click the enabled notification name link in the search results region. The Notification Action Definition window appears.
To delete a notification, click Delete for an associated notification. You are prompted to confirm the delete action.
Use the Create Notification Action Header window to create a notification action header. The notification action header represents the transaction details for which notifications are defined in the notification action details section.
Define the notification code lookup.
Identify the user to send the notification.
Navigate to the Create Notification Action Header window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Notification Action Definition > the Create Definition button.
Enter the values for the following fields:
Select the collaboration Application from the drop-down list.
Select Collaboration Type as one of the many collaboration types used such as Cancel Order, Change Order Notification.
Select Source as the software component generating the notification. This list includes values such as Oracle Applications, B2B Server, iProcurement Connector, XML Gateway.
Enter Notification as the description of the notification. A notification description is specified for display purposes where notifications are referenced elsewhere. You can search for a notification from the Search and Select: Notification window, which displays a list of values.
Click Apply to create a new notification action definition header.
After a search from the Notification Action Definitions window, you can update an existing notification action header from the search results by modifying the Application, Collaboration Type, Source, and Notification fields.
Define the notification code lookup.
Identify the user to send the notification.
Navigate to the Notification Action Definitions window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Notification Action Definition.
Click the enabled Update for a notification in the search results region to open to the Update Notification Action Header window.
Select the values for the following fields:
Select the collaboration Application as Oracle Purchasing, Oracle Inventory, Oracle Order Management.
Select Collaboration Type as one of the many collaboration types used. This list includes values such as Cancel Order.
Select Source as the software component generating the notification such as Oracle Applications, B2B Server, iProcurement Connector, XML Gateway.
Enter Notification as the description of the notification. A notification description is specified for display purposes where notifications are referenced elsewhere.
Click Apply to update the notification action definition header.
Once a notification action has been created, you can search for the notification action that needs to be modified and then update the action details by clicking enabled Update Action Details from the search results region. This opens the Notification Action Definition window where you can perform the following tasks:
View a list of existing notification action information including action header and action details
The "Notify Administrator" notification action is the default action for each notification.
Create new actions for a given notification
You can select one of the following values from the Create Action drop-down list for your action:
Call API
Notify Document Owner
Notify Trading Partner
Notify Administrator
Raise Business Event
Start Workflow
You need to select Active check box to enable this new notify action. See: Setting Up Customized Collaborations for technical requirements and information of each type of action.
Update existing actions
You can activate or deactivate a notification action and update action details based on your selected action name.
For example, if the action is "Notify Administrator", then the Update Notify Administrator Action Definition window appears. In addition to activate or deactivate the action, you can also update the Notification User/Roles with valid users or roles in Workflow Directory. See Oracle Workflow Administrator's Guide for details.
Delete existing actions
Define the notification code lookup.
Identify the user to send the notification.
Navigate to the Notification Action Definitions window from the Workflow Administrator Web Applications responsibility: Collaboration Monitor: Setup > Notification Action Definition.
Search for a notification action definition.
Click the enabled Update Action Details from the search results region to open the Notification Action Definition window.
To create a new action, select an action name from the Create Action drop-down list and click Go.
In addition to select the Active check box to enable the new notify action, enter appropriate information based on the selected action name:
Call API:
Enter event name as the Procedure Name of the API. Select Online or Concurrent as the Mode of Execution field.
Raise Business Event:
Enter the event name as the fully qualified Name. Enter parameter 1 to parameter 14.
Start Workflow:
Enter appropriate information for the Workflow Item Type field and Workflow Process.
Notify Administrator:
Enter Notification User/Roles up to 15 roles. The user/role must be a valid user or role in Workflow Directory.
Notify Trading Partner or Document Owner:
Need to specify the Active check box to enable the notification.
To update the action, click the enabled Update for an action listed in tabular format. The associated update action definition window appears with various fields based on your selected action name. For example, if the action "Start Workflow" needs to be updated, then you may update the Workflow Item Type and Workflow Process fields.
To delete the action, click the enabled Delete for an action. You are prompted to confirm the deletion.
After a search in the Notification Action Definitions window, you can click the enabled Notification Name link in the search results region to view the notification action information. This includes the notification header containing application, collaboration type, source, and notification description, as well as the details of actions for the notification. The action details include the action name such as "Notify Document Owner", active flag, parameter 1, parameter 2, parameter 3, parameter 4, and parameter 5.
Click the enabled Action to view the corresponding action details.
See: Viewing Action Definition Details.
After clicking a specific notification Action Name link from the Notification Action Details page, you can view the associated action name details. For example, if the enabled Action is Notify Administrator, then click to view the Notify Administrator Action Definition details, including action name, active status and notification role information.