Oracle® Application Server Integration B2B User's Guide
10g Release 2 (10.1.2) Part No. B13849-01 |
|
![]() Previous |
![]() Next |
This chapter describes how to administer Oracle Application Server Integration B2B partner and instance data with the OracleAS Integration B2B user interface tool.
This chapter contains these topics:
The OracleAS Integration B2B user interface tool enables you to perform the design tasks shown in Figure 12-1 and the import, export, and purge management tasks shown in Figure 12-2. References to instructions for performing these tasks are listed in Table 12-1:
Table 12-1 Design and Management Tasks
Task | See Section... |
---|---|
Managing contact types | "Managing Contact Types"
|
Managing trading partner identification types | "Managing Trading Partner Identification Types"
|
Importing and exporting the design-time repository | "Exporting and Importing the Design-Time Repository"
|
Purging the design-time repository and portions of the runtime repository | "Purging the Design-Time Repository and Runtime Repository"
|
The OracleAS Integration B2B user interface tool enables you to perform the contact type management tasks shown in Figure 12-3. These tasks are described in detail in this section. The contact type is the method for contacting persons or organizations (such as a phone number or e-mail address). OracleAS Integration B2B includes a predefined set of contact types shown in Figure 12-3 that cannot be updated or deleted.
Table 12-2 identifies the contact type management tasks shown in Figure 12-3 and provides references to procedures for performing these tasks.
Table 12-2 Contact Type Management Tasks
Page Elements | Management Tasks | See Section... |
---|---|---|
Shortcuts section of Figure 12-3 | Take a shortcut to the Trading Partners page | "Managing Trading Partners"
|
Name column of Contact Types section of Figure 12-3 | View details about a contact type | "Viewing a Contact Type"
|
Follow these instructions to view details about a contact type:
Click Administration > Design.
Select a specific contact type to view in the Name column of the Contact Types section.
The Contact Type Details page for the selected contact type appears (for example, for e-mail).
View specific details, including the contact type and description.
Click Return to List to return to the Design tab main page.
The OracleAS Integration B2B user interface tool enables you to perform the trading partner identification type management tasks shown in Figure 12-4. These tasks are described in detail in this section. The trading partner identification type includes a value that uniquely identifies a trading partner, such as a Data Universal Numbering System (DUNS) number or an electronic data interchange (EDI) location code. OracleAS Integration B2B includes a predefined set of trading partner identification types shown in Figure 12-4 that cannot be updated or deleted. You can also create your own custom trading partner identification types.
Figure 12-4 Trading Partner Identification Type Management Tasks
Table 12-3 identifies the trading partner identification type management tasks shown in Figure 12-4 and provides references to procedures for performing these tasks.
Table 12-3 Trading Partner Identification Type Management Tasks
Page Elements | Management Tasks | See Section... |
---|---|---|
Shortcut section of Figure 12-4 | Take a shortcut to the Trading Partners page | "Managing Trading Partners"
|
Create button of Trading Partner Identification Types section of Figure 12-4 | Create a trading partner identification type | "Creating a Trading Partner Identification Type"
|
Name column of Trading Partner Identification Types section of Figure 12-4 | View details about a trading partner identification type | "Viewing a Trading Partner Identification Type"
|
Note: Trading partner identification types cannot be deleted or updated. |
Follow these instructions to create a trading partner identification type:
Click Administration > Design.
Click Create in the Trading Partner Identification Types section.
The Create Trading Partner Identification Type page appears.
Enter the following details to create a trading partner identification type. An asterisk (*) indicates a required field.
Field | Value |
---|---|
Name * | Enter a unique and recognizable trading partner identification type name. |
Description | Enter a description. |
Click Apply.
The trading partner identification type is created and the Trading Partner Identification Type Details page appears. The trading partner identification type appears as a selection on the Create Trading Partner Identification page (accessible by clicking Partners > Trading Partners > trading_partner_name_in_Name_column > Trading Partner Identifications > Create). The trading partner identification type is also available for selection when you run the Create Trading Partner wizard.
See Also: "Creating Trading Partner Identification" for instructions on selecting a trading partner identification value |
Follow these instructions to view details about a trading partner identification type:
Click Administration > Design.
Select a specific trading partner identification type to view in the Name column of the Trading Partner Identification Types section.
The Trading Partner Identification Type Details page for the selected trading partner identification type appears.
View the trading partner identification type description. You can also manage (view, update, and delete) the value of the assigned types from this section.
Click Return to List to return to the Design tab main page.
The OracleAS Integration B2B user interface tool enables you to create partner data (such as trading partners and trading partner agreements) that is stored in the OracleAS Integration B2B design-time repository portion of the Oracle Application Server Metadata Repository. Partner data is the condition of data prior to being included in a deployed configuration. This type of partner data describes the behavior of the configuration and the steps that must be sequenced for the configuration to be executed. Partner data stored in the design-time repository can also be reused in multiple integrations, thus eliminating duplication of effort in designing an integration.
The OracleAS Integration B2B user interface tool provides design-time repository export and import functionality that enables you to perform several tasks. Some of these tasks include the following:
Export and import the entire contents of the 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 the design-time repository
Import supported, predefined RosettaNet collaborations (partner interface processes (PIPs)), EDI X12 and EDI EDIFACT transaction sets (business actions), and UCCnet standards into the design-time repository to assign to trading partners. This information can then be viewed by clicking Partners > Protocols > business_protocol_name_in_Name_column > Process Protocol Revisions > Details. A transaction set maps to a document type of a business action in the OracleAS Integration B2B user interface tool.
There are several methods for using export and import.
In high availability environments, you can back up specific configurations from your design-time repository.
For migrating from a test environment to a production environment, you can import configurations tested in a staging environment into a production environment.
OracleAS Integration B2B supports the following types of export:
The export feature accessible under the Administration tab (and described in this section) exports the latest versions of all partner data in the design-time repository to a file.
The configuration export feature accessible under the Deployment tab exports only the data included in a specific configuration.
The export feature accessible from the Agreement Details page and Trading Partner Details page exports the partner data associated with those pages to XML files. The XSDs for these XML files are included in the exported document.
Note the following details about importing and exporting the latest versions of all partner data to a file:
The wallet password for the host trading partner is not exported or imported. This password must be created manually by following the instructions under Partners > Trading Partners > host_trading_partner_name_in_Name_column.
All trading partner agreements are imported in the Draft state, even if they were approved before the export. You must validate the relevant trading partner agreements before creating and deploying a configuration.
Do not use the OracleAS Integration B2B export and import features for backup or recovery of the design-time repository. OracleAS Integration B2B uses the b2b
schema in the metadata repository. This schema has additional metadata and runtime state not included in the OracleAS Integration B2B export file. Use the Oracle database import and export utilities or the Oracle Application Server archiving tool to back up this schema.
Select a task to perform and see the referenced section for instructions:
Management Task | See Section... |
---|---|
Export the entire design-time repository to a file | "Exporting the Design-Time Repository Contents"
|
Import the design-time repository from a file (exported by clicking Administration > Management > Export) | "Importing the Design-Time Repository Contents"
|
Import a configuration (exported by clicking Deployment > configuration_name_in_Name_column > Export) | "Importing an Exported Configuration"
|
Import supported, predefined RosettaNet collaborations, EDI transaction sets, and UCCnet standards | "Importing Support for Collaborations, Transaction Sets, and UCCnet Standards"
|
See Also:
|
Follow these instructions to export the design-time repository contents:
Ensure that you first reviewed "Exporting and Importing the Design-Time Repository".
Click Administration > Management > Export.
The entire and latest contents of partner data in the design-time repository are copied to a file named export.xml
that you are prompted to open or download to a directory location. Depending on the size of the design-time repository contents, this process can take time.
Follow these instructions to import the design-time repository contents that you exported to an XML file by clicking Administration > Management > Export:
Follow these instructions to import the design-time repository contents:
Ensure that you first reviewed "Exporting and Importing the Design-Time Repository".
Click Administration > Management.
Click Browse to select a file to import.
Click Import.
The Import Status page appears. A clock displays onscreen saying that the import is being processed and can take several minutes.
The entire contents of the file are loaded into their previous locations in the design-time repository and display in the OracleAS Integration B2B user interface tool. You cannot import parts of the file. A message appears indicating that the import completed successfully.
The partner data that comprises a configuration is reimported, but the configuration is not re-created. You must first validate the trading partner agreement of the configuration and then re-create the configuration.
If an import fails, then the changes are rolled back and the design-time repository remains unchanged. A message appears indicating that the import was unsuccessful.
Follow these instructions to import a configuration exported by clicking Deployment > configuration_name_in_Name_column > Export:
Ensure that you first reviewed "Exporting and Importing the Design-Time Repository".
Click Administration > Management.
Click Browse to select the file containing the exported configuration to import.
Click Import.
The Import Status page appears. A clock displays onscreen saying that the import is being processed and can take several minutes.
The trading partner agreement of a configuration is loaded into its previous location in the design-time repository. You must then validate the trading partner agreement and re-create the configuration that includes this trading partner.
If an import fails, then the changes are rolled back and the design-time repository remains unchanged. A message appears indicating that the import was unsuccessful.
OracleAS Integration B2B includes support for importing the following collaborations, transaction sets, and UCCnet standards:
Approximately 25 frequently-used RosettaNet collaborations in the ip/demo/samples/RosettaNet/RosettaNet_sample.xml
file
EDI X12, document protocol revision 4010, transaction sets 850, 855, and 997 in the ip/demo/samples/X12/X12_sample.xml
file
EDI EDIFACT, document protocol revision D98A with transaction sets ORDERS and ORDRSP, and document protocol revision D3 with transaction set CONTRL in the ip/demo/samples/EDIFACT/EDIFACT_sample.xml
file
UCCnet standards (protocol revision 2.3.1) in the ip/demo/samples/UCCnet/UCCnet_sample.xml
file
Before you can use these collaborations, transaction sets, and standards, you must import these files into the design-time repository. This action enables you to see and use them in the OracleAS Integration B2B user interface tool.
Follow these instructions to import RosettaNet collaborations, EDI X12 and EDIFACT transaction sets, and UCCnet standards:
Ensure that you first reviewed "Exporting and Importing the Design-Time Repository".
Click Administration > Management.
The Import page appears.
Click Browse to select the collaborations, transaction sets, or standards to import.
Click Import.
The Import Status page appears. A clock displays onscreen saying that the import is being processed.
Once imported, these collaborations, transaction sets, and standards display in the Process Protocol Revision Details page accessible by clicking Partners > Protocols > business_protocol_name_in_Name_column > Process Protocol Revisions > Details. You can then assign these collaborations, transaction sets, and standards to remote trading partners.
If an import fails, the design-time repository remains unchanged. A message appears indicating that the import was unsuccessful.
See Also: Chapter 2, "Supported Protocols" for a list of supported collaborations, transaction sets, and standards |
OracleAS Integration B2B partner data consists of two types.
Partner data (stored in the OracleAS Integration B2B design-time repository)
See "Exporting and Importing the Design-Time Repository" for a description of partner data.
Instance data (stored in the OracleAS Integration B2B runtime repository)
Instance data is partner data included in a deployed configuration. During configuration creation, partner data of the integration is validated end-to-end a final time to ensure that only a complete and consistent configuration is deployed to the runtime repository. After a configuration is deployed, the runtime repository stores the configuration of instance data required to execute an integration. Instance data is created during runtime when messages are processed.
The OracleAS Integration B2B design-time repository and runtime repository are both part of the Oracle Application Server Metadata Repository.
The OracleAS Integration B2B user interface tool enables you to purge all partner data in the design-time repository (with the exception of predefined data that was part of installation) and instance data in the runtime repository. Data in a deployed configuration in the runtime repository that is not in a completed state is considered to be in use and cannot be deleted. When its state is complete, it can be purged. Purging enables you to perform the following tasks:
Manage disk space and improve performance
Delete multiple objects of larger granularity
Note: A second user accessing the same OracleAS Integration B2B user interface tool on another host can also view purging progress. The second user sees a message stating that purging is in progress. A View Status link appears that takes the second user to a purging progress page. |
Follow these instructions to purge partner data from the design-time repository and instance data from the runtime repository:
Ensure that you first reviewed "Purging the Design-Time Repository and Runtime Repository".
Click Administration > Management > Purge.
The Purge page appears.
Select the type of data you want to purge and see the appropriate section. The page refreshes based on your selection.
Purge Type | Description | See Section... |
---|---|---|
Business Messages | Enables you to purge the design-time repository data and instance data of the runtime repository that you created for use with any EDI or Custom Document business protocol. | "Purging Business Message or Collaboration Instance Data"
|
Collaboration Instances | Enables you to purge the design-time repository data and instance data of the runtime repository that you created for use with the RosettaNet over RNIF business protocol. | "Purging Business Message or Collaboration Instance Data"
|
Entire Repository | Enables you to purge the entire design-time repository and instance data of the runtime repository.
Predefined data that was part of the installation (for example, business protocols such as EDI and RosettaNet and identification types such as a Data Universal Numbering System (DUNS) and an EDI Location Code) is not deleted. This action returns the design-time repository to its state at the time of installation. |
"Purging the Entire Repository"
|
Note: If you do not want to continue purging instance data, click Return to Management. This action returns you to the initial Management page shown in Figure 12-2. |
The page refreshes to display additional fields.
Use the calendar icons in the Date Range section to select the start and end dates for purging the runtime repository of instance data. If you do not specify any dates, all instance data is purged.
The list that displays is based on your selection in Step 3.
Make a selection from the list that appears.
If You Selected... | Then... |
---|---|
Business Messages | Select the business action from the Business Action Name list. |
Collaboration Instances | Select the collaboration from the Collaboration Name list. |
Select the configuration from the Configuration Name list. If you do not select a specific configuration to purge, all configurations are purged.
If you want to configure advanced business message or collaboration parameters, click Show Advanced Parameters. This enables you to more specifically define the data you want to delete.
The page refreshes to display additional fields based on your selection in Step 3.
Enter the following details:
If You Selected... | Then... |
---|---|
Business Messages |
|
Collaboration Instances |
|
Enter the following details.
Field | Value |
---|---|
Trading Partner |
|
|
Select the trading partner that sent the message. |
|
Select the trading partner that received the message. |
|
Select the trading partner identification type of the sending trading partner (for example, DUNS or EDI Location Code). |
|
Enter the sending trading partner identification type value. For example, if you selected DUNS, enter the DUNS number. |
|
Select the trading partner identification type of the receiving trading partner. |
|
Enter the receiving trading partner identification type value. |
Protocol |
|
|
Select the specific EDI or Custom Document business protocol used in this business transaction between sending and receiving trading partners. |
Agreement |
|
|
Select the trading partner agreement in which the sending and receiving trading partners are included. |
Click Purge.
Caution: Purging is an irreversible operation. Ensure that you first archive any important configurations with the Oracle Application Server archiving tool before purging the repository. |
Click Purge.
A message appears stating that purging is an irreversible operation and purged data cannot be recovered. You are asked if you want to continue.
If you want to continue with this action, click Yes. Otherwise, click No.
See Also: Oracle Application Server Administrator's Guide for instructions on archiving data before purging the repository |
This chapter describes how to use the OracleAS Integration B2B user interface tool for the following tasks:
Manage contact types and trading partner identification types
Export and import the design-time repository to and from XML files
Import configurations from XML files
Import RosettaNet collaborations, EDI X12 and EDIFACT transaction sets, and UCCnet standards
Purge data in the design-time repository and instance data in the runtime repository