Skip Headers

Home

Contents

Book
List

Contact
Us

PDF

15 External Integration

This chapter contains the following:

Web Services: Overview

Files for Import and Export

External Data Integration Services for Oracle Cloud

Web Services: Overview

Use web services to integrate web-based applications into your Oracle Fusion applications. Web services expose Oracle Fusion Applications business objects and processes to other applications through the use open standards-based technologies. Some of these technologies include Extensible Markup Language (XML), Simple Object Access Protocol (SOAP), Business Process Execution Language (BPEL), Web Services Description Language (WSDL), and XML schema definitions (XSD). Oracle Fusion Applications web services support development environments and clients that comply with these open standards.

Oracle Fusion Applications includes two types of web services: Application Development Framework (ADF) services and composite services. The following table describes the two types.

Web Service Type	Description
ADF services	ADF services usually represent business objects, such as employees or purchase orders. ADF services typically expose standard operations, such as create, update, and delete. However, for locally-persisted objects, ADF services are not limited to these operations. Examples of ADF services include: `Worker.changeHireDate` - a service that updates the hire date of the worker business object. `ProjectTask.createTask` - a service that adds a task to the project task business object.
Composite services	Composite services usually represent end-to-end business process flows that act on business events produced by the ADF services. Composite services orchestrate multiple object-based services, rules services, and human workflows. Examples of composite services include: `ProjectStatusChangeApproval.process` - a service that accepts the change in project status. `ScheduleOrchestrationOrderFulfillmentLineService.scheduleOrders` - a service that schedules resources used to fulfill an order.

Web Service Type

Description

ADF services

ADF services usually represent business objects, such as employees or purchase orders. ADF services typically expose standard operations, such as create, update, and delete. However, for locally-persisted objects, ADF services are not limited to these operations.

Examples of ADF services include:

Worker.changeHireDate - a service that updates the hire date of the worker business object.
ProjectTask.createTask - a service that adds a task to the project task business object.

Composite services

Composite services usually represent end-to-end business process flows that act on business events produced by the ADF services. Composite services orchestrate multiple object-based services, rules services, and human workflows. Examples of composite services include:

ProjectStatusChangeApproval.process - a service that accepts the change in project status.
ScheduleOrchestrationOrderFulfillmentLineService.scheduleOrders - a service that schedules resources used to fulfill an order.

Access Oracle Enterprise Repository for Oracle Fusion Applications to find detailed information about integration assets, such as web services. To view lists of web services, select these asset types:

ADF Service
ADF Service Data Object
Composite Service
Composite

Service methods and parameters, the service path, the WSDL URL and other technical data, appear on the Detail tab of each web service. Step-by-step instructions regarding the invocation of a service and the service XSD appear on the Documentation tab.

Files for Import and Export

Files for Import and Export: Highlights

The File Import and Export page accesses repositories of content. For example, each Oracle Fusion Applications instance connects to a single Oracle WebCenter Content server for content management.

The following documents describe use and administration of content management:

Oracle WebCenter Content User's Guide for Content Server
Oracle WebCenter Content System Administrator's Guide for Content Server

Using Content Management

For information about what objects to upload and download, including templates for external data integration, refer to the Oracle Enterprise Repository for Oracle Fusion Applications.
For general access to content management, including to all metadata and to manage accounts, use the Oracle WebCenter Content Server's standard service user interface.
See: Oracle WebCenter Content User's Guide for Content Server

For information on creating accounts in WebCenter Content accounts, refer to WebCenter Content System Administrator's Guide for Content Server.
See: Accounts
For information about naming accounts involved with import and export, see Files for Import and Export: Points to Consider.

For programmatic upload and download to content management, refer to Oracle WebCenter Content System Administrator's Guide for Content Server.
See: About Batch Loading

For information about the Oracle WebCenter Content Server Document Transfer Utility, see documentation resources in Oracle Enterprise Repository for Oracle Fusion Applications (http://fusionappsoer.oracle.com).

Security in Content Management

For information about security, see the Security tab in Oracle Enterprise Repository for Oracle Fusion Applications.

For information about roles such as the integration specialist roles for each product family, see the Oracle Fusion Applications security reference manuals for each offering. For example:
See: Oracle Fusion Applications Common Security Reference Manual

Files for Import and Export: Explained

You can import data into or export data out of Oracle Fusion Applications using repositories of content and processes for import and export.

Integration specialists stage data for import and export. Application administrators run processes to import data in repositories of content to application transaction tables, or retrieve data exported from applications.

Aspects of managing files for import and export involve the following.

The File Import and Export page
Interacting with content management
Uploading for import
Downloading for export
File size

The File Import and Export Page

The File Import and Export page lets you upload content to, or download content from the document repository of Oracle WebCenter Content Management.

Search criteria on the page are limited to the minimum metadata of content management records needed for file import and export.

Navigation: Navigator > Tools > File Import and Export.

Interacting with Content Management

Everyone who uses the File Import and Export page is assigned to one or more accounts in content management.

Accounts organize and secure access to content items.

Uploading for Import

Uploading a file creates a record.

When you create a record, you must specify an account as well as the file. When you create a record, you must specify an account as well as the file. The account you specify determines which import process picks up that file to import it.

You can upload any file formats that can be parsed by the content repository being used, such as any MIME or content types. However, the format uploaded should conform to the requirements of the import process being used, such as a comma-separated values (CSV) file for the Load Interface File for Import process.

Downloading for Export

Processes you run to export data result in files in content management. Records in the search results table of the File Import and Export page provide links to the files for download.

Note

The owner of a data export file can be an application ID (APPID).

File Size

Upload and download does not intentionally apply the following:

Data compression
File chunking or splitting

The UPLOAD_MAX_DISK_SPACE parameter in the web.xml file determines the maximum allowable file size in content management. The default maximum size is 10240000 (10MB).

Files for Import and Export: Points to Consider

Interaction between the File Import and Export page and Oracle WebCenter Content Management requires securing content in an account. Oracle provides predefined accounts in Oracle WebCenter Content.

Areas of file import and export to consider involve the following.

Security
Searching records
Accessing content in a new account
Account names
Deleting files

Security

The duty role needed for accessing the File Import and Export page is File Import and Export Management Duty. This duty role is included in the predefined role hierarchy for integration specialist roles and product family administrator roles.

Files in Oracle WebCenter are associated with an account so that only users who have permission to a particular account can work with content items that belong to that account. You can only upload and download files to and from content management that are associated with accounts that you are entitled to access.

Oracle WebCenter Content does not support trailing slashes (/). Account names are appended with a $ to ensure each account is unique. Account names are dynamic so that if they overlap (one name is completely contained in another, longer name, such as US and USSales), each account is treated as discrete by access grants.

Security such as virus scanning is handled by the underlying integrated content management.

Searching Records

A record in Oracle WebCenter content management contains metadata used for accessing the file.

When a scheduled process has run to completion on a file, the ecord for the file includes a process ID.

Accessing Content in a New Account

When you create a new account in Oracle WebCenter Content and the Oracle WebCenter Content Server is not restarted, access to content in the new account from the File Import and Export page may be delayed until the policy store is updated.

Account Names

If you create custom accounts for importing or exporting data, use the following conventions for naming the account: Do not include a slash "/" at the beginning or end End with "$" to avoid partial string matching Use "$/" as a separator in the hierarchical structure.

For example: fin$/journal$/import$ The File Import and Export page transforms account names by removing the $s. For example fin$/journal$/import$ displays as fin/journal/import. The Remote Introdoc Client (RIDC) HTTP command-line interface (CLI) transforms the account name you specify without $ symbols to one that includes them. For example, fin/journal/import becomes fin$/journal$/import$ in WebCenter Content.

Deleting Files

In the File Import and Export page, you can delete one file at a time. To delete multiple files at a time from content management, use the content management server's standard service user interface.

External Data Integration Services for Oracle Cloud

External Data Integration Services for Oracle Cloud: Overview

Use External Data Integration Services for Oracle Cloud to load data into Oracle Fusion Applications from external sources, such as legacy systems and third-party applications.

Components of External Data Integration Services for Oracle Cloud include:

Templates and control files for formatting, structuring, and generating the data file.
A general file load process for loading values from the data file into interface tables.
Application-specific data import processes for transferring data from interface tables to the application tables in your Oracle Fusion Applications.

To use External Data Integration Services for Oracle Cloud to load data into Oracle Fusion Applications tables:

Prepare your data and generate a data file by using the product-specific templates and control files.
Transfer the data file to the integrated content management server.
Run the Load Interface File for Import process.
Correct data load errors, if necessary.
Run the appropriate application-specific process for validating and inserting the data into application tables.
Correct data import errors, if necessary.

For templates and control files, see assets with the File-Based Data Import type in Oracle Enterprise Repository for Oracle Fusion Applications (http://fusionappsoer.oracle.com). For more information, see the Documentation tab for the Load Interface File for Import process in Oracle Enterprise Repository.

Locating File Import Templates: Explained

External data that you integrate into your Oracle Fusion Applications must be structured and formatted according to the properties of the fields and tables that store the data. To prepare external data so that data types, structural relationships, and other properties of the data correctly align to the data types, structural relationships, and properties of the target tables, use the product-specific templates and control files in Oracle Enterprise Repository for Oracle Fusion Applications.

You access these files from the Documentation tab of the scheduled process that corresponds to the interface tables that store the data. To find the process, you can search the interface table or you can search the specific process, if you know it.

Aspects of preparing external data using templates involve these tasks.

Finding templates and control files
Downloading the templates
Opening XLS templates
Opening XML templates

Finding Templates and Control Files

To find the templates and control files:

Sign in to Oracle Enterprise Repository.
Enter the following information in the Search fields:

Field

Value

Search String

FBDI

Type

Scheduled Process

FusionApps: Logical Business Area

(Optional) Select the value relevant to your implementation.
Click Search.
Select the Load Interface File for Import from the results.

Field	Value
Search String	FBDI
Type	Scheduled Process
FusionApps: Logical Business Area	(Optional) Select the value relevant to your implementation.

Downloading the Templates

To download the templates:

Use the Search area to locate the Load Interface File for Import job and then select it from the search results.
Click the Documentation tab in the lower pane to see a list of links to application-specific import jobs.
Click a link to access the job.
Click the Documentation tab in the lower pane to see a list of links that access:
- Control files, which describe the logical flow of the data load process
- XLS templates, which include worksheets and macros that assist you in structuring, formatting, and generating your data file
- XML templates, which you import into Oracle Data Integrator
Click the link to download the file.

Opening the XLS Template

To prepare your data in a spreadsheet format, use XLS templates:

Open the XLS template.
The first worksheet in each template provides instructions for using the template.

Important

If you omit or fail to complete the instructions, data load errors and data import failure are likely.
Save a copy of the file.
Click the Generate CSV File button.

The macro generates a comma-separated values (CSV) file and compresses it into a ZIP file; you must transfer the ZIP file to the content management server.

Opening the XML Template

To prepare your data in Oracle Data Integrator (ODI), download the XML template into ODI:

Import the family-level template as a model folder.
Import the product-level template as a model folder within the family-level model folder.
Import the product template as a model within the product-level model folder.
Create the integration project.
Create the package.
Add and configure these elements:
1. The integration projects
2. The ODIZip tool
3. The content management document transfer utility (Currently not available in Oracle Cloud implementations.)
Execute the package.

The package generates the CSV file and compresses it into a ZIP file.

Note

In Oracle Cloud implementations, you manually upload the ZIP file to the content management server in Oracle Cloud. In non-Cloud implementations, you can configure the content management document transfer utility as part of the ODI flow to automate the ZIP file upload.

Using Excel Integration Templates to Generate Data Files: Points to Consider

Oracle Enterprise Repository for Oracle Fusion Applications includes integration templates to help you prepare external data for loading and importing. Each template includes table-specific instructions, guidelines, formatted spreadsheets, and best practices for preparing the data file for upload. By following the instructions with exactness when you use the templates, you ensure that your data conforms to the structure and format of the target application tables.

Templates

This list details the characteristics of the templates:

Each interface table is represented by a separate worksheet.
Each interface table field is represented by a worksheet column with a header in the first row.
Each column header contains bubble text, or comments, that include details about the column, such as the expected data type, length, and, in some cases, other instructional text.
The worksheet columns appear in the order that the control file processes the data file.
The columns that you do not intend to use can be hidden, but not reordered or deleted.
Important

Deleting or reordering columns will cause the load process to fail and result in an unsuccessful data load.
The external data must conform to the data type that the control file and process for the associated database column accepts.
- Date column values must appear in the YYYY/MM/DD format.
- Amount column values must appear with no separators other than a period (.) as the decimal separator.
- Negative values must be preceded by the minus (-) sign.
- Column values that require whole numbers include data validation to allow whole numbers only.
Columns are formatted, where applicable, to match the expected data type to eliminate data entry errors.
For columns that require internal ID values, refer to the bubble text for additional guidance about finding these values.
When using Microsoft Excel to generate or update the CSV file, you must select YYYY/MM/DD as your regional setting for date values.

Using XML Templates to Generate Data Files for Integration: Highlights

Oracle Enterprise Repository for Oracle Fusion Applications includes XML integration templates assets that you use with Oracle Data Integrator (ODI) to generate import files from your external data.

To use the XML templates and generate the import files, you must:

Install and set up Oracle Data Integrator
Create source and target models
Create integration projects

Note

In Oracle Cloud implementations, you must upload the ZIP file to the content management server in Oracle Cloud. In non-Cloud implementations, you can streamline the data integration process by installing the content management document transfer utility so ODI performs the ZIP file transfer.

Oracle Data Integrator provides a solution for integrating complex data from a variety of sources into your Oracle Fusion applications. The Oracle Fusion Middleware Installation Guide for Oracle Data Integrator and the Oracle Fusion Middleware Developer's Guide for Oracle Data Integrator provide complete details pertaining to the installation and set up of this product.

Installing and Setting Up Oracle Data Integrator

Install Oracle Data Integrator to use Oracle Fusion Applications XML integration templates. Refer to the Oracle Fusion Middleware Installation Guide for Oracle Data Integrator.
See: Installing Oracle Data Integrator
Set up Oracle Data Integrator to use Oracle Fusion Applications XML integration templates. Refer to the Oracle Fusion Middleware Developer's Guide for Oracle Data Integrator.
See: Setting up the Topology

Creating Source and Target Models

Create the ODI models for both the source and target datastores. You determine the source models that you use based on the system or technology of the external data that you to import into your Oracle Fusion application. You create the target models by importing the XML files, which you download from Oracle Enterprise Repository. For more information, refer to the Oracle Fusion Middleware Developer's Guide for Oracle Data Integrator.
See: Creating and Reverse-Engineering a Model

Configuring Integration Projects

Create and configure an integration project, which entails selecting the knowledge modules, creating the interfaces, and mapping the source and target datastores. For more information, refer to the Oracle Fusion Middleware Developer's Guide for Oracle Data Integrator.
See: Creating an Integration Project

Using XML Integration Templates to Generate Data Files: Points to Consider

Use XML templates in Oracle Data Integrator to prepare your external data for loading and importing. Oracle Enterprise Repository for Oracle Fusion Applications includes three types of XML templates that you import as target models in your Oracle Data Integrator repository.

Oracle Enterprise Repository includes these three levels of XML files:

Family-level
Product-level
Product

Family-Level XML Files

A family-level XML file is common to a group of product-level model folders and product models.

Consider the following points when you use family-level XML files:

The family-level XML file supports all of the Oracle Enterprise Repository assets in the family, for example Oracle Fusion Financials or Human Capital Management.
You import the family-level XML file into your Oracle Data Integrator repository prior to importing the other XML files.
You import one family-level XML file as a model folder for each family of products.
You import each family-level XML file as a top-level model folder.
You import the family-level XML file one time; it supports all subsumed product-level model folders.
You select Synonym mode Insert Update as the import type.

Product-Level XML Files

A product-level XML file is common to a group of product models.

Consider the following points when you use product-level XML files:

The product-level XML file supports all of the Oracle Enterprise Repository assets in the product line, for example Fixed Assets, General Ledger, or Payables.
You import one product-level XML file as a model folder for each line of products.
You import the product-level XML file as a model folder into your Oracle Data Integrator repository after you import the family-level XML file, but before you import product XML files.
You import each product-level XML file as a midlevel model folder within the appropriate family-level model folder.
You import the product-level XML file one time; it supports all subsumed product models.
You select Synonym mode Insert Update as the import type.

Product XML Files

A product XML file represents a specific Oracle Enterprise Repository interface table asset.

Consider the following points when you use product XML files:

You import one product XML file as a model for each interface table or set of tables, for example Mass Additions.
You import the product XML file as a model into your Oracle Data Integrator repository after you import the product-level XML file.
You import each product XML file as a model within the appropriate product-level model folder.
You import each product XML file one time.
You select Synonym mode Insert Update as the import type.
The model is based on File technology.
After you import the product model, you connect the model to the correct logical schema.

Transferring Data Files to Content Management: Explained

After you generate the comma-separated values (CSV) file, transfer it to the content management server.

You can use the following methods to transfer files:

File Import and Export page in Oracle Fusion Applications
Oracle WebCenter Content Document Transfer Utility
Oracle web service

For details about programmatic file transfer using the Oracle WebCenter Content Document Transfer Utility, refer to documentation resources in Oracle Enterprise Repository for Oracle Fusion Applications (http://fusionappsoer.oracle.com).

Aspects of transferring data files to content management involve the following:

Target accounts
Accessing transferred content

Target Accounts

You must transfer files to the predefined account in content management that corresponds to the interface table or assets.

Interface Table	Predefined Account
Payables Standard Invoice Import	`fin/payables/import`
AutoInvoice Import Receivables Standard Receipt Import Customer Import China Value Added Tax Invoice Import	`fin/receivables/import`
BAI2 Format Bank Statements Import EDIFACT FINSTA Format Bank Statements Import ISO200022 CAMT053 Format Bank Statements Import SWIFT MT940 Format Bank Statements Import	`fin/cashManagement/import`
Fixed Asset Mass Additions Import Fixed Asset Mass Adjustments Import Fixed Asset Mass Retirements Import Fixed Asset Mass Transfers Import Fixed Asset Units of Production Import	`fin/assets/import`
Intercompany Transaction Import	`fin/intercompany/import`
Journal Import Chart Of Account Segment Values and Hierarchies Import	`fin/generalLedger/import`
General Ledger Budget Balance Import	`fin/budgetBalance/import`
Supplier Bank Account Import	`fin/payables/import`
Tax Configuration Content Import	`fin/tax/import`
Import Blanket Purchase Agreements	`prc/blanketPurchaseAgreement/import`
Import Contract Purcahse Agreements	`prc/contractPurchaseAgreement/import`
Import Purchase Orders	`prc/purchaseOrder/import`
Import Requisitions	`prc/requisition/import`
Import Suppliers Import Supplier Sites Import Supplier Site Contacts Import Supplier Site Assignments	`prc/supplier/import`
Project Enterprise Resource Import	`prj/projectManagement/import`
Project Unprocessed Expenditure Item Import	`prj/projectCosting/import`
Cycle Count Import	`scm/cycleCount/import`
Inventory Reservation Import	`scm/inventoryReservation/import`
Inventory Transaction Import	`scm/inventoryTransaction/import`
Item Import	`scm/item/import`
Receiving Receipt Import	`scm/receivingReceipt/import`
Shipment Request Import	`scm/shipmentRequest/import`

You can create subaccounts for further file organization. However you need to create the subaccount under the predefined account for the asset you are integrating.

Accessing Transferred Content

To access your transferred data you must access the account that corresponds to the interface table or asset appropriate for the data.

Available data integration processes move the content into and out of Oracle Fusion Applications tables. Running an import or export process creates a process ID in content management that you can use to identify the content you wish to overwrite or extract.

Oracle Enterprise Scheduler import process jobs result in the following hierarchy of items in Oracle WebCenter Content Management:

A root import job is a list of all unprocessed files in an account. This job submits the child jobs that process each unprocessed file.
A parent import job is a single file ID, account name, and the import steps (download, extract, import) for a single job, job set, or subrequests. This type of job tags the file with its request ID, provided the file is not deleted immediately after successful import.
A child import job is a direct data load from a prepared file, typically a SQLLoader. Typically, the parent import job submits this job.

Load Interface File for Import Process

Loads external setup or transaction data from the data file on the content management server to interface tables.

You run this process from the Scheduled Processes page. You can run it on a recurring basis.

Before running this process, you must:

Prepare your data file.
Transfer the data file to the content management server.

Parameters

Import Process

Select the target import process.

Data file

Enter the relative path and the file name of the ZIP data file on the content management server.

Importing Data into Application Tables: Procedure

The final destination for your external data is the application data tables of your Oracle Fusion Applications product.

Aspects of importing data into application tables involve the following:

Loading data into interface tables
Finding and submitting the import process

Loading Data into Interface Tables

Interface tables are intermediary tables that store your data temporarily while the system validates format and structure. Run the Load Interface File for Import scheduled process to load data from the data file into the interface table that corresponds to the template that you use to prepare the data.

To load your data into interface tables, submit the Load Interface File for Import scheduled process:

Sign in to Oracle Fusion Applications.
In the Navigator menu, select Tools, Scheduled Processes
Click the Schedule New Process button.
Search and select the Load Interface File for Import job.
When the Process Details page appears:
1. Select the target import process.
2. Enter the relative path of the data file.
  Note
  
  The path is relative to the account in the content management server. If the file exists in the account, enter the file name only. If the file exists in a subaccount subordinate to the account, you must include all subaccounts and the file name.
3. The data file is retained on the content management server when the process is complete.
Submit the process.
If no errors exist in the data file, then the process populates the interface tables.

Finding and Submitting the Import Process

Run the import process appropriate to your data to import the data into application data tables into the application tables of your Oracle Fusion Applications product.

To import your data:

Sign in to Oracle Fusion Applications.
In the Navigator menu, select Tools, Scheduled Processes
Click the Schedule New Process button.
Find and select the import process that is specific to the target application tables.
When the Process Details page appears, select the process that corresponds to the data that you are importing.

If you prepared your data using the spreadsheet template, select the process named in the Overview section of the spreadsheet.
Submit the process.
Note

For more detailed information on the process used for data prepared using the spreadsheet template, see the Instructions and CSV Generation tab of the spreadsheet template

Correcting Import Load Process Errors: Explained

The Load Interface File for Import process ends in error if the load of the data file fails on any row.

The following conditions apply when the process ends in error:

The Load File to Interface child process ends in either warning or error.
All rows that were loaded by the process are deleted, even those rows that loaded successfully.

To correct errors:

Review the error logs.
Change any formatting or structural anomalies that exist in the data.
Recreate the CSV and ZIP files.
Transfer the file to the content management server.
Submit the Load Interface File for Import job.
Repeat these steps until the process successfully loads the data.
Import the data using the appropriate product-specific process.