2 Getting Started with the User Interface Tool

Main List Pages

When you click a subtab of a main tab (for example, the subtab Trading Partners of main tab Partners), a main list page displays information you created such as that shown in Figure 2-1. Main list pages have general names such as Trading Partners or Trading Partner Agreements, and are not named after specific partner data that you create. These main list pages enable you to perform a series of tasks.

Figure 2-1 Main List Page Layout

Description of "Figure 2-1 Main List Page Layout"

Table 2-1 describes the contents of the page shown in Figure 2-1, including the tasks you can perform:

Details Pages

Partner data that you create has its own details page typically accessed through the Name column shown in Figure 2-1. Details pages are named after specific elements that you create. For example, Figure 2-2 shows the details page for a trading partner named RN-TradingPartner1. You access this page by clicking RN-TradingPartner1 in the Name column in Figure 2-1.

Figure 2-2 Details Page

Description of "Figure 2-2 Details Page"

Table 2-2 describes the contents of Figure 2-2 and the tasks you can perform.

Creating Incomplete Partner Data

The OracleAS Integration B2B user interface tool provides a flexibility that does not require you to complete all partner data tasks at the same time or in a completely sequential order.

For example, you can complete all partner tasks and store the partner details for later use. Or, you can complete a portion of your partner tasks and complete the remaining tasks later (for example, you can follow this approach with the Create Trading Partner wizard).

When you initially create a specific element, only fields clearly marked with an asterisk must be completed. You can ignore other fields that are not mandatory. You can modify these details at a later time when the correct details are known.

The approach to follow depends on what is best for your integration environment.

Creating, Adding, Deleting, and Removing Data

The OracleAS Integration B2B user interface tool pages provide Create, Add, Delete, and Remove buttons. The Add and Remove buttons enable you to add or remove an association between elements. For example, when you remove a delivery channel from an agreement, it is still available in OracleAS Integration B2B for reuse at a later time.

The Create and Delete buttons enable you to create and delete partner data. For example, if you delete a trading partner agreement, it is deleted from OracleAS Integration B2B and must be re-created if you want to use it again.

Naming Conventions

You are frequently prompted to provide names when creating data. Oracle recommends that you adhere to the following naming conventions:

• Provide data with unique and meaningful names to make it easy to identify its content.

  For example, if you are creating a trading partner agreement using RosettaNet Partner Interface Process (PIP) 3A4 with a remote trading partner named Acme, use that name in the agreement (for example, Acme_PIP3A4_Agreement).

• Do not include beginning or trailing blank spaces in the names of data you create

Using the Browser Back and Forward Buttons

Do not use the Back or Forward buttons of your Web browser when creating partner data. For example, if you are creating partner data with the Create Trading Partner wizard, use the Back and Next buttons specifically provided by the OracleAS Integration B2B user interface tool.

Using the Return to List Link

Details pages include a Return to List link at the bottom left that enables you to move up one level. For example, clicking Return to List on a specific Trading Partner Details page takes you up to the main Trading Partners list page. Use the Return to List link instead of the Back or Forward buttons of your Web browser to move up levels in the OracleAS Integration B2B user interface tool.

Searching for Data on the Main List Page

The OracleAS Integration B2B user interface tool includes a search feature available from list pages. Figure 2-3 provides an example of the search feature that appears on the Trading Partners page that you access by clicking Partners, then Trading Partners.

Figure 2-3 Search Feature

Description of "Figure 2-3 Search Feature"

The search feature is available only if the number of elements on a page exceeds ten. For example, the number of trading partners available in Figure 2-3 is 11. Instead of browsing from page to page, select a specific search criteria in the Search list to find the appropriate trading partner.

The Search list contains attributes of the element. For example, if a text attribute is selected (such as name) on the Trading Partners main list page, a text field appears and enables you to enter a specific name for which to search. You can use the % sign as a wildcard instead of specifying the entire name.

Exporting Partner Data to an XML File

Some high-level partner data elements include an Export button on their details pages. This button enables you to export your partner data to an XML file. You can then submit this file for review and approval to applicable persons to ensure that it is correct. Figure 2-4 shows the location of the Export button in the upper-right part of a details page for a remote trading partner named RN-TradingPartner1.

Figure 2-4 Partner Data Export Button

Description of "Figure 2-4 Partner Data Export Button"

Only the details pages of certain partner data elements include the export feature. High-level partner data elements include lower-level partner data elements on their details pages that can also be defined.

For example, the Trading Partner Details page in Figure 2-4 enables you to manage such lower-level partner data elements as trading partner identifications, associated trading partner agreements, and remote trading partner certificates. When you click Export on the Trading Partner Details page, the partner data that you defined for the trading partner is all included in the XML file (including data for trading partner identifications, associated trading partner agreements, and certificates).

Table 2-3 identifies the high-level partner data elements that have an Export button, and the partner data that is included in the XML file when you click Export. References are provided for more specific details about managing this data.

See "Partners Tab Overview" for additional details about the partner data described in this section.

Viewing the State of Partner Data on the Details Pages

Partner data created under the Partners tab goes through several lifecycle states from the time of creation through its role in a validated and deployed configuration. The current state of trading partners and trading partner agreements displays in the Details sections on their details pages. For example, see Figure 2-4, where the State is Draft for RN-TradingPartner1. Table 2-4 shows the states available for trading partners and trading partner agreements.

The following sections describe the support for these lifecycle states provided by the OracleAS Integration B2B user interface tool:

• Draft State for Partner Data

• Approved State for Partner Data

• Deployed State for Partner Data

Draft State for Partner Data

When you create partner data, its initial state is Draft, which is displayed in the Details section of the details page. Figure 2-5 shows the Draft state (in this example, for a trading partner). During this state, you can optionally export your partner data to XML files to submit to specific persons for their review. The procedure to submit an XML file to a reviewer is completely optional. If any reviewers agree to and sign off on the partner data (for example, through notification by an e-mail), you (as the host trading partner) can update the status of the trading partner with the OracleAS Integration B2B user interface tool.

Figure 2-5 Draft State

Description of "Figure 2-5 Draft State"

See "Exporting Partner Data to an XML File" for more information.

Approved State for Partner Data

You can validate your partner data for individual correctness after creation by clicking the Validate button. This individual validation is separate from the complete, end-to-end validation that is performed on all partner data when you create a configuration. If no validation errors occur, the details page refreshes and the state changes from Draft to Approved, as shown in Figure 2-6. The Validate button is gone.

Figure 2-6 Approved State

Description of "Figure 2-6 Approved State"

If validation errors occur, they appear on the page. You must correct the errors and click Validate again.

Trading Partners List Page

When you select the Trading Partners tab, the list page shown in Figure 2-8 appears:

Figure 2-8 Trading Partners Tab

Description of "Figure 2-8 Trading Partners Tab"

The Trading Partners page displays the host trading partner (in this example, named Acme and automatically identified by the word Host in parentheses) and all remote trading partners you created. The host trading partner name is automatically named MyCompany after installation. You can update it after installation to a name that uniquely reflects your organization (for example, Acme).

The host trading partner is the organization in which OracleAS Integration B2B is installed. There can be only one host trading partner. It cannot be deleted. The remote trading partners are the organizations outside your enterprise with whom to conduct business, as defined in a trading partner agreement. There can be multiple remote trading partners.

The host trading partner uses the OracleAS Integration B2B user interface tool to define the capabilities for all trading partners (both host and remote). The host trading partner consults with the remote trading partner to obtain the necessary details.

The Trading Partners page enables you to perform the following tasks to manage host and remote trading partners participating in an integration:

• Access a shortcut in the Shortcuts section to create a trading partner agreement

• Manage the host trading partner (update and view) and remote trading partners (create, delete, update, and view)

• Click a specific trading partner in the Name column to access the page shown in Figure 2-9 with links for managing (create, view, update, add, and delete) the following:

  • Trading partner identification types, associated agreements, remote trading partner certificates, and the host trading partner wallet password (under the General section at the top left of the page)

  • Trading partner organizations and persons and their contact details (under the Organization and Users sections at the top left of the page)

  • Business protocols (under the Capabilities section at the top left of the page). Once you add support for a business protocol to a remote trading partner (for example, RosettaNet over RNIF for RosettaNet or EDI EDIFACT over Generic Exchange for EDI EDIFACT), you can perform the following management tasks by clicking on the business protocol in the Name column of the Capabilities page shown in Figure 2-10:

    • Operational capabilities tasks for the business protocol of the remote trading partner, such as adding or removing support for a collaboration (if using the RosettaNet over RNIF business protocol) or a business action (if using any EDI or Custom Document business protocol). See Figure 10-3 for an example.

    • Communication capabilities tasks for the business protocol of the host and remote trading partner, such as managing delivery channels, document exchanges, transports, transport servers, and endpoints. See Figure 10-3 for an example.

    The host trading partner is automatically assigned business protocols and operational capabilities. You assign a business protocol and create operational capabilities for the remote trading partner only.

  Figure 2-9 Trading Partner Details Page

  
  Description of "Figure 2-9 Trading Partner Details Page"
  
  

  Figure 2-10 Business Protocol Details Page

  
  Description of "Figure 2-10 Business Protocol Details Page"
  
  

See the following for more information:

• Chapter 9, "Creating Trading Partners"

• Chapter 10, "Managing Trading Partners"

Trading Partner Agreements List Page

When you select the Agreements tab, the Trading Partner Agreements list page shown in Figure 2-11 appears:

Figure 2-11 Trading Partner Agreements Tab

Description of "Figure 2-11 Trading Partner Agreements Tab"

This page enables you to perform the following tasks to manage agreements between trading partners:

• Manage (create, update, delete, and view) trading partner agreements between trading partners

• Click a specific trading partner agreement in the Name section to access a page to update details about the trading partners participating in the trading partner agreement (both remote and host trading partners)

• Access shortcuts listed in the Shortcut section for performing agreement-related tasks (for example, creating a remote trading partner)

See Chapter 12, "Creating and Managing Trading Partner Agreements" for more information.

Protocols List Page

When you select the Protocols tab, the Business Protocols list page shown in Figure 2-12 appears:

Figure 2-12 Protocols Tab

Description of "Figure 2-12 Protocols Tab"

This page enables you to perform the following tasks to manage business protocols of trading partners:

• View all business protocols available with OracleAS Integration B2B

• Click a specific business protocol in the Name section to access a page to manage (create, delete, update, and view) the process protocol, document protocol, and exchange protocol of a business protocol. From this page, you can access the Process Protocol Revision Details page to manage (create, delete, update, and view) support for collaborations (for RosettaNet over RNIF) and business actions (for EDI or Custom Document, such as UCCnet standards) of business protocols. Collaborations, business actions, and standards describe business documents and their movement between trading partners.

See Chapter 8, "Managing Business Protocols" for more information.

Callouts List Page

XSLTCallout, which is provided with OracleAS Integration B2B, transforms XML documents from one form to another (for example, Oracle E-Business Suite XML to RosettaNet XML and vice versa).

When you select the Callouts tab, the list page shown in Figure 2-13 appears:

Figure 2-13 Callouts Tab

Description of "Figure 2-13 Callouts Tab"

This page enables you to perform the following tasks to manage callouts:

• Manage (create, delete, update, and view) callouts used to manipulate documents outside of OracleAS Integration B2B.

• Click a callout in the Name section to access a page to view callout details (such as classification, language type, implementation name, and library name), and manage (create, delete, update, and view) callout properties and usages.

See Chapter 11, "Managing Callouts" for more information.

Design List Page

When you select the Design tab, the list page shown in Figure 2-17 appears:

Figure 2-17 Design Tab

Description of "Figure 2-17 Design Tab"

This page enables you to perform the following tasks:

• View the methods available for contacting organizations and persons (contact types).

• Manage trading partner identification types. If you create a trading partner identification type on this page, it displays when you create a trading partner identification by clicking Partners, then Trading Partners, then trading_partner_name_in_Name_column, then Trading Partner Identifications, and then Create.

See the following for more information:

• "Managing Contact Types"

• "Managing Trading Partner Identification Types"

Management List Page

When you select the Management tab, the list page shown in Figure 2-18 appears:

Figure 2-18 Management Tab

Description of "Figure 2-18 Management Tab"

This page enables you to perform the following tasks:

• Import the OracleAS Integration B2B design-time repository data that was previously exported. During import, the host trading partner, as identified in the user interface tool, and the host trading partner identified in the export file must be the same.

• Export and import the entire contents of the OracleAS Integration B2B design-time repository to and from an XML file. This enables you to export the contents from one repository and import it into another repository.

• Export and import a configuration created under the Deployment tab to and from an XML file

• Purge the entire repository. See "Purging the Entire Repository" for more information.

See the following for more information:

• "Exporting and Importing the Design-Time Repository"

• "Purging the Entire Repository"