25External Integration

This chapter contains the following:

Web Services

Web Services: Overview

Use web services to integrate web-based applications into your Oracle Applications Cloud. Web services expose business objects and processes to other applications through the use of open standards-based technologies.

The web services support development environments and clients that comply with the following open standards:

  • Extensible Markup Language (XML)

  • Simple Object Access Protocol (SOAP)

  • Business Process Execution Language (BPEL)

  • Web Services Description Language (WSDL)

  • XML schema definitions (XSD)

Oracle Applications Cloud includes two types of web services:

  • Application Development Framework (ADF) services

  • 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.

For more information about web services, see the SOAP Web Services guide for your cloud services.

Developer Connect

Developer Connect: Overview

The Developer Connect portal provides information about the web services deployed to your Oracle Applications Cloud instance. You can use this information to integrate with or extend Oracle Applications Cloud and develop solutions to suit your business requirements.

To use the Developer Connect portal, your job role must have the FND_INTEGRATION_SPECIALIST_JOB, FND_APPLICATION_DEVELOPER_JOB, or ZCA_CUSTOMER_RELATIONSHIP_MANAGEMENT_APPLICATION_ADMINISTRATOR_JOB privilege. Alternately, you can grant the ATK_WEB_SERVICE_INFO_ACCESS_PRIV entitlement to your custom role, and then grant the custom role to users who require access. For more information, see the security guide for the appropriate cloud service at Oracle Help Center (https://docs.oracle.com).

To open the Developer Connect portal, from the Navigator menu, select Tools - Developer Connect. This portal displays dynamic information of the web services, and the modifications done to web services to integrate with Oracle Applications Cloud. You can synchronize the Developer Connect portal with your cloud instance to retrieve the latest web service information such as service attributes, operations, business objects, security policies, and WSDL files.

Use the Developer Connect portal to:

  • View the summary of the web service information such as the business object that the service defines, life cycle status, and security policy.

  • Discover the operations available for the selected web service, and the request and response payloads for each operation.

  • View the hierarchy of the service data objects and know information such as the data type and whether it's a required field for user-defined attributes.

  • Review the sample payload XMLs for the operations of the web service. You can add or edit sample payloads, and also delete user-defined sample payloads.

Web Service Life Cycle: Explained

A web service goes through three phases in a life cycle:

  • Active: A service is active when it's delivered the first time, until it's deprecated.

  • Deprecated: A service is deprecated when it's superseded by a newer version, or if there is a planned obsolescence in a future release. A service in this state is still supported and becomes obsolete in a later release.

    Note: You must use the active version of the service. If you were previously using a service that has been deprecated, then migrate to the new, active version.
  • Obsolete: A service is obsolete when it's no longer shipped or supported.

Managing Web Service Sample Payloads: Worked Example

This example demonstrates how to add and edit a sample payload XML for a web service operation. It also describes how to delete a user-defined sample payload XML.

Adding a Sample Payload XML

Follow these steps to add a sample payload XML for the getEntityList operation of Help Topic Abstract Service:

  1. From the Navigator menu, select Tools - Developer Connect.

  2. On the Web Service overview page, search for Help Topic Abstract Service, and click the service display name.

  3. On the Summary page, click the Sample Payloads tab, and then click Add Sample Payload.

  4. Select getEntityList operation from the list, and enter a brief description.

  5. Enter the payload XML, and click OK.

Editing a Sample Payload XML

The Developer Connect portal displays predefined and user-defined payloads of the web services. You can edit only the user-defined payloads. Follow these steps to edit a user-defined sample payload of the getEntityList operation of Help Topic Abstract Service:

  1. On the Web Service overview page, select Help Topic Abstract Service.

  2. On the Summary page of the web service, click the Sample Payloads tab and select getEntityList operation.

  3. In the Edit Sample Payload dialog box, edit the payload XML and click OK.

Deleting a Sample Payload XML

You can delete only user-defined payloads, and not predefined payloads. Follow these steps to delete a user-defined sample payload of the getEntityList operation of Help Topic Abstract Service:

  1. On the Web Service overview page, select Help Topic Abstract Service.

  2. On the Summary page of the web service, click the Sample Payloads tab and select getEntityList operation.

  3. Click the delete icon for the selected operation and click OK.

Importing Value Set Values to Oracle Applications Cloud: Worked Example

This example demonstrates how to use the information in the Developer Connect portal to import value set values to Oracle Applications Cloud.

Suppose a fictional partner application wants to extend it with certain functionality available in another application. Instead of creating the required business objects and attributes in this application, you can import them using a web service. Before you proceed with the import process, enable the access permissions for the web service and review the information in the Developer Connect portal:

  • Synchronize the web services information

  • Review the web service details

  • Update the request payload

Synchronizing Web Services Information

You must synchronize the Developer Connect portal with your Oracle Applications Cloud instance to get the latest web service information. Follow these steps:

  1. From the Navigator menu, select Tools > Developer Connect.

  2. Click Synchronize.

    Note: The Last Refreshed date indicates when the Developer Connect portal was last synchronized with your cloud instance.

Searching And Reviewing Web Service Information

On the Web Services overview page, you can enter Manage File Import and Export in the Find field. You can also use Advanced Search option to find web service names that contain import, and select the relevant service from the search results.

To review the information:

  1. On the Web Services overview page, select Manage File Import and Export Service. The Summary panel shows information such as the display name, business object that the service defines, life cycle status, QName, security policy used, and a brief overview of the service.

  2. Click the Operations tab to view the operations supported by the web service.

  3. Click the uploadFiletoUCM operation and review the result parameter in the response payload. This parameter holds the file ID in the WebCenter Content repository from which the value set values are imported.

  4. Click the valueSetValuesDataLoader operation and review the fileIdAtRepository parameter in the request payload. This parameter holds the file ID in the WebCenter Content repository.

  5. Click WSDL File link of the service to download the web service information.

Updating Request Payload

To add a sample payload to import the value set values:

  1. Click the Sample Payloads tab and then click Add Sample Payload.

  2. Select uploadFiletoUCM from the operation name list.

  3. Enter a brief description of the payload in the description text box.

  4. Add the payload to get the file ID from the WebCenter Content repository:

    <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
     <soap:Body>
     <ns1:uploadFiletoUCM 
    xmlns:ns1="http://xmlns.oracle.com/oracle/apps/fnd/applcore/webservices/types/"
      ns2="http://xmlns.oracle.com/oracle/apps/fnd/applcore/webservices/" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    
      <ns1:document xsi:type="ns2:DocumentDetails">
      <ns2:fileName>VS123.txt</ns2:fileName>
      <ns2:contentType>plain/text</ns2:contentType> <ns2:content>
    VmFsdWVTZXRDb2RlfEluZGVwZW5kZW50VmFsdWV8SW5kZXBlbmRlbnRWYWx1ZU51bWJlcnxJbmRlcGVuZGVudFZhbHVlRGF0ZXxJbmRlcGVuZGVudFZhbHVlVGltZXN0YW1wfFZhbHVlfFZhbHVlTnVtYmVyfFZhbHVlRGF0ZXxWYWx1ZVRpbWVzdGFtcHxUcmFuc2xhdGVkVmFsdWV8RGVzY3JpcHRpb258RW5hYmxlZEZsYWd8U3RhcnREYXRlQWN0aXZlfEVuZERhdGVBY3RpdmV8U29ydE9yZGVyfFN1bW1hcnlGbGFnfEZsZXhWYWx1ZUF0dHJpYnV0ZTF8RmxleFZhbHVlQXR0cmlidXRlMnxGbGV4VmFsdWVBdHRyaWJ1dGUzfEZsZXhWYWx1ZUF0dHJpYnV0ZTR8RmxleFZhbHVlQXR0cmlidXRlNXxGbGV4VmFsdWVBdHRyaWJ1dGU2fEZsZXhWYWx1ZUF0dHJpYnV0ZTd8RmxleFZhbHVlQXR0cmlidXRlOHxGbGV4VmFsdWVBdHRyaWJ1dGU5fEZsZXhWYWx1ZUF0dHJpYnV0ZTEwfEZsZXhWYWx1ZUF0dHJpYnV0ZTExfEZsZXhWYWx1ZUF0dHJpYnV0ZTEyfEZsZXhWYWx1ZUF0dHJpYnV0ZTEzfEZsZXhWYWx1ZUF0dHJpYnV0ZTE0fEZsZXhWYWx1ZUF0dHJpYnV0ZTE1fEZsZXhWYWx1ZUF0dHJpYnV0ZTE2fEZsZXhWYWx1ZUF0dHJpYnV0ZTE3fEZsZXhWYWx1ZUF0dHJpYnV0ZTE4fEZsZXhWYWx1ZUF0dHJpYnV0ZTE5fEZsZXhWYWx1ZUF0dHJpYnV0ZTIwfEN1c3RvbVZhbHVlQXR0cmlidXRlMXxDdXN0b21WYWx1ZUF0dHJpYnV0ZTJ8Q3VzdG9tVmFsdWVBdHRyaWJ1dGUzfEN1c3RvbVZhbHVl QX R0cmlidXRlNH xDdXN0b21WYWx1ZUF0dHJpYnV0ZTV8Q3VzdG9tVmFsdWVBdHRyaWJ1dGU2fEN1c3RvbVZhbHVlQXR0cmlidXRlN3xDdXN0b21WYWx1ZUF0dHJpYnV0ZTh8Q3VzdG9tVmFsdWVBdHRyaWJ1dGU5fEN1c3RvbVZhbHVlQXR0cmlidXRlMTAKUkVMN19CNl9WU19DSEFSX0lORF9URVhUX01MMjB8fHx8fFRyZWVzV1N8fHx8fFRlc3RpbmcgZm9yIEJ1ZyAxNzM3NTY4NHxOfDIwMDAtMTAtMDF8MjAwMC0xMC0zMHwxfHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fApSRUw3X0I2X1ZTX0NIQVJfSU5EX1RFWFRfTUwyMHx8fHx8RmxleFdTfHx8fHxUZXN0aW5nIGZvciBCdWcgMTczNzU2ODR8WXwyMDExLTEwLTAxfHwyfHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fApSRUw3X0I2X1ZTX0NIQVJfREVQX1RFWFRfTUwyMHxGbGV4V1N8fHx8S0ZGV1N8fHx8fFRlc3RpbmcgZm9yIEJ1ZyAxNzM3NTY4NCB1cGRhdGVkfE58MjAwMC0wMS0xMXwyMDAwLTAxLTIyfDF8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8ClJFTDdfQjZfVlNfQ0hBUl9ERVBfVEVYVF9NTDIwfEZsZXhXU3x8fHxERkZXU3x8fHx8VGVzdGluZyBmb3IgQnVnIDE3Mzc1Njg0fFl8MjAwMC0wMS0wMXwyMDAwLTAxLTMwfDJ8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8ClJFTDdfQjZfVlNfTlVNX0lORHx8fHx8MTAwMHwxMDAwfHx8fFRlc3RpbmcgZm9yIEJ1ZyAxNzM3NTY4NHxZfHx8MXx8fHx8fHx8fHx8fHx8fHx8fHx8f Hx 8fHx8fHx8fHw K UkVMN19CNl9WU19OVU1fSU5EfHx8fHwyMDAwfHx8fHxUZXN0aW5nIGZvciBCdWcgMTczNzU2ODR8WXwyMDExLTEwLTAxfDIwMTItMTAtMzB8Mnx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHwKUkVMN19CNl9WU19OVU1fREVQfDEwMDB8MTAwMHx8fDEwMDAwfDEwMDAwfHx8fFRlc3RpbmcgZm9yIEJ1ZyAxNzM3NTY4NHxZfHx8MXx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHwKUkVMN19CNl9WU19OVU1fREVQfDIwMDB8fHx8MjAwMDB8fHx8fFRlc3RpbmcgZm9yIEJ1ZyAxNzM3NTY4NHxZfDIwMTEtMTAtMDF8MjAxMi0xMS0zMHwyfHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fApSRUw3X0I2X1ZTX0NIQVJfSU5EX1RURVhUX01MMjB8fHx8fFRyZWVzMVdTfHx8fFRyZWVzMSBUTFdTfFRlc3RpbmcgZm9yIEJ1ZyAxNzM3NTY4NHxOfDIwMTMtMTAtMTF8MjAxMy0xMC0zMHwxfHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fApSRUw3X0I2X1ZTX0NIQVJfSU5EX1RURVhUX01MMjB8fHx8fEF0dGFjaG1lbnQxV1N8fHx8QXR0YWNobWVudDEgVExXU3xUZXN0aW5nIGZvciBCdWcgMTczNzU2ODR8WXwyMDEzLTEwLTAxfDIwMTMtMTAtMzB8Mnx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHwKUkVMN19CNl9WU19EQVRFX0lORHx8fHx8MjAzMC0wMS0wMXx8MjAzMC0wMS0wMXx8fFRlc3RpbmcgZm9yIEJ1ZyAxNzM3NTY4NHxZfDIwMTEtMTAtMDF8MjAxMi0xMC0zMHwxfHx8fHx 8f Hx8fHx8fHx8f H x8fHx8fHx8fHx8fHx8fApSRUw3X0I2X1ZTX0RBVEVfSU5EfHx8fHx8fDIwMzAtMDEtMDJ8fHxUZXN0aW5nIGZvciBCdWcgMTczNzU2ODQtMXxZfDIwMTEtMTAtMDV8MjAxMi0xMC0zMHwyfHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fApSRUw3X0I2X1ZTX0RBVEVfREVQfDIwMzAtMDEtMDF8fDIwMzAtMDEtMDF8fDIwMzAtMDEtMTF8fDIwMzAtMDEtMTF8fHxUZXN0aW5nIGZvciBCdWcgMTczNzU2ODR8WXwyMDExLTEwLTAxfDIwMTItMTAtMzB8MXx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHwKUkVMN19CNl9WU19EQVRFX0RFUHwyMDMwLTAxLTAxfHx8fDIwMzAtMDEtMjJ8fHx8fFRlc3RpbmcgZm9yIEJ1ZyAxNzM3NTY4NC0xfE58MjAxMS0xMC0wNXwyMDEyLTEwLTMwfHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHwKUkVMN19CNl9WU19EQVRFVElNRV9JTkR8fHx8fDIwMzEtMDMtMDEgMDE6MDA6MDAuMDB8fHwyMDMxLTAzLTAxIDAxOjAwOjAwLjAwfHxUZXN0aW5nIGZvciBCdWcgMTczNzU2ODR8WXwyMDExLTAxLTAxfDIwMTItMDEtMzB8MXx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHwKUkVMN19CNl9WU19EQVRFVElNRV9JTkR8fHx8fDIwMzEtMDMtMDEgMDI6MDA6MDAuMDB8fHx8fFRlc3RpbmcgZm9yIEJ1ZyAxNzM3NTY4NC0xfE58MjAxMS0xMC0wMnwyMDEyLTEwLTMwfDJ8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8ClJFTDdfQjZfVlNfREFURVRJT UV fREVQfDIwMzE t MDMtMDEgMDE6MDA6MDAuMDB8fHwyMDMxLTAzLTAxIDAxOjAwOjAwLjAwfDIwMzEtMDMtMDEgMDE6MDE6MDAuMDB8fHwyMDMxLTAzLTAxIDAxOjAxOjAwLjAwfHxUZXN0aW5nIGZvciBCdWcgMTczNzU2ODR8WXwyMDExLTAxLTAxfDIwMTItMDEtMzB8NHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHwKUkVMN19CNl9WU19EQVRFVElNRV9ERVB8MjAzMS0wMy0wMSAwMTowMDowMC4wMHx8fHwyMDMxLTAzLTAxIDAxOjAyOjAwLjAwfHx8fHxUZXN0aW5nIGZvciBCdWcgMTczNzU2ODR8WXwyMDExLTAxLTAxfDIwMTItMDEtMzB8NHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHwK
       </ns1:content>
      <ns2:documentAccount>fin$/tax$/import$</ns2:documentAccount>
      <ns2:documentTitle>VS</ns2:documentTitle>
     </ns2:document>
     </ns1:uploadFiletoUCM>
     </soap:Body>
    </soap:Envelope>

  5. Click OK.

  6. Select valueSetValuesDataLoader from the operation name list.

  7. Enter a brief description of the payload in the description text box.

  8. Add the payload to read the contents from the file and import the value set values:

    <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
     <soap:Body>
     <ns1:valueSetValuesDataLoader 
    xmlns:ns1="http://xmlns.oracle.com/oracle/apps/fnd/applcore/webservices/types/">
     <ns1:fileIdAtRepository>1234</ns1:fileIdAtRepository>
     </ns1:valueSetValuesDataLoader>
     </soap:Body>
    </soap:Envelope>

Message Patterns: Explained

All operations exposed on a business object service have both synchronous and asynchronous message patterns defined. For conciseness, the service documentation includes the definition for the synchronous message pattern only. Both synchronous and asynchronous operations have the same functional behavior, and request and response payloads. Custom object services don't have corresponding asynchronous operations.

Naming Conventions and Examples

The naming convention for the asynchronous operation is:

  • Operation name: Synchronous operation name appended with Async

  • Callback name: Synchronous operation name appended with AsyncResponse

Using Help Topic Abstract Service as an example, if the name of the synchronous operation is getEntityList, the asynchronous operation name and callback name would be getEntityListAsync and getEntityListAsyncResponse.

CORS: Explained

Cross-Origin Resource Sharing (CORS) enables secure cross domain communication from a browser. You can configure CORS headers to enable a client application running in one domain to retrieve resources from another domain, using HTTP requests. By default, browser-based programming languages, such as JavaScript, can access content only from the same domain. CORS provides a mechanism to overcome this limitation and access resources from different domains.

To enable CORS in Oracle Applications Cloud, you must set profile option values for the CORS headers in the Setup and Maintenance work area. This table lists the supported CORS headers.

CORS Header Purpose

Access-Control-Allow-Origin

Contains a comma-separated list of trusted origins that a client application can access resources from.

Access-Control-Max-Age

Specifies the duration of storing the results of a request in the preflight result cache.

Access-Control-Allow-Methods

Contains a comma-separated list of permitted HTTP methods in a request.

Access-Control-Allow-Headers

Contains a comma-separated list of permitted HTTP headers in a request.

Access-Control-Allow-Credentials

Specifies whether a client application can send user credentials with a request.

Example

A client application retrieves resource X from server A, which runs the application logic. The client application then makes an HTTP request to retrieve resource Y from server B. To allow this cross-server request from the client application, you must configure the Access-Control-Allow-Origin header in server B. Otherwise, the request fails and displays an error message.

Managing Profile Option Values for CORS Headers: Points to Consider

You can set profile option values for the CORS headers using the Manage Administrator Profile Values task in the Setup and Maintenance work area.

CORS Headers

This table lists the CORS headers that you can set profile option values for.

CORS Header Profile Option Name (Profile Option Code) Profile Option Values

Access-Control-Allow-Origin

Allowed Domains (ORACLE.ADF.VIEW.ALLOWED_ORIGINS)

Valid values for allowed origins:

  • URL of the specific origin, for example, http://www.mydomain.com

  • Comma-separated list of origins, for example,

    http://www.mydomain.com, http://adc6160507.us.oracle.com, http://software.dzhuvinov.com

  • * to allow access to resources from all origins

  • Empty (no value set) to prevent access to resources from any origin

Note: You must set a value for this header to enable CORS.

Access-Control-Max-Age

CORS: Access-Control-Max-Age (CORS_ACCESS_CONTROL_MAX_AGE)

Default value for caching preflight request is 3600 seconds.

Access-Control-Allow-Methods

CORS: Access-Control-Allow-Methods (CORS_ACCESS_CONTROL_ALLOW_METHODS)

Default values for allowed methods are OPTIONS, HEAD, GET, POST, PUT, PATCH, DELETE.

Access-Control-Allow-Headers

CORS: Access-Control-Allow-Headers (CORS_ACCESS_CONTROL_ALLOW_HEADERS)

Default values for allowed headers are Accept, Accept-Encoding, Cache-Control, Content-MD5, Content-Type, If-Match, If-None-Match,Origin, User-Agent, X-HTTP-Method-Override, X-Requested-By.

Note: You must include Authorization, with a comma as the delimiter, to the list of allowed headers.

For example: Accept, Accept-Encoding, Cache-Control, Authorization

Access-Control-Allow-Credentials

CORS: Access-Control-Allow-Credentials (CORS_ACCESS_CONTROL_ALLOW_CREDENTIALS)

  • True to enable sending credentials with the request

  • False, which is the default value, to disable sending credentials with the request

Viewing Details About Predefined Scheduled Processes: Procedure

To use web services to run predefined scheduled processes, you need details about the processes. View job definitions that the processes are based on, for example to get information about parameters. You might also need to find security requirements for running the scheduled process.

Job Definitions

A job definition contains the metadata that determines how a scheduled process works and what options are available during submission.

To view job definitions:

  1. Go to the Setup and Maintenance work area.

  2. From the Application Extensions functional area, open any of these tasks as appropriate:

    • Manage Custom Enterprise Scheduler Jobs for Customer Relationship Management and Related Applications

    • Manage Custom Enterprise Scheduler Jobs for Financial and Supply Chain Management and Related Applications

    • Manage Custom Enterprise Scheduler Jobs for Human Capital Management and Related Applications

  3. In the Manage Job Definitions tab, select your job definition and click Edit.

    Note: Predefined job definitions are marked with an asterisk.
  4. Cancel after you get the information you need.

Security

Privileges provide the access needed to run specific scheduled processes. Privileges are granted to duty roles, which are granted to job roles. To see which job roles inherit the needed privileges, use the Security Console or the security reference manuals for the appropriate product family.

Files for Import and Export

Files for Import and Export: Explained

You can import data into or export data out of the applications. A repository stores the content and the import and export processes handle the data movement into and out of the repository. 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:

  • Using the File Import and Export page

  • Interacting with content management

  • Uploading to facilitate import

  • Downloading to facilitate export

  • Determining the file size

The File Import and Export Page

Use the File Import and Export page to upload content to or download content from the document repository of Oracle WebCenter Content. Search criteria on the page are limited to the minimum metadata of content management records needed for file import and export. To open the page, from the Navigator menu in the global header, select Tools > File Import and Export.

Contact the WebCenter Content Administrator for the following additional requirements:

  • Information or assistance regarding general access to content management (including all metadata)

  • Creating and managing accounts

  • Programmatically uploading and downloading content

Interacting with Content Management

Each user with access to the File Import and Export page is assigned to one or more accounts in Oracle WebCenter Content. Accounts organize and secure access to the content items.

Uploading to Facilitate Import

Uploading a file creates a record in Oracle WebCenter Content. When you upload a file, you must also specify an account to which you upload the file. The account you specify determines which import process picks up that file to import it. You can upload any compatible file format, such as MIME, which the content repository can parse. However, the uploaded format must conform to the requirements of the import process. For example, the comma-separated values (CSV) file for the Load Interface File for Import process.

Downloading to Facilitate Export

Records in the search results table of the File Import and Export page provide download links to the files.

File Size

Upload and download don't apply the following by default:

  • Data compression

  • File 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 requires securing content in an account. You can use the predefined accounts that are available in Oracle WebCenter Content.

Areas of file import and export involve the following:

  • Defining security

  • Searching records

  • Accessing content in a new account

  • Naming the account

  • Deleting files

Defining Security

You require the File Import and Export Management duty role for accessing the File Import and Export page. This duty role is included in the predefined role hierarchy for integration specialist roles and product family administrator roles. Files in Oracle WebCenter Content are associated with an account so that only users having access to that account can work with those files. Account names are unique and each account is treated as discrete by access control. You can only upload and download files to and from content repositories that are linked to the accounts you can access. The underlying integrated content management handles security tasks such as virus scanning.

Searching Records

A record in Oracle WebCenter Content contains the metadata used for accessing the file. When a scheduled process is run on a file, the record for the file is assigned a process ID.

Accessing Content in a New Account

After you create a new account in Oracle WebCenter Content, restart the content server. Otherwise, when you use the File Import and Export page to access content in the new account, you may experience a delay. That's because the policy store is being updated with the new account information.

Naming the Account

If you create accounts for importing or exporting data, use the following conventions for naming the account:

  • Don't include a forward slash (/) at the beginning or end.

  • End the name with a dollar sign ($) to avoid partial string matching.

  • Use dollar sign and forward slash ($/) as a separator in the hierarchical structure.

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

Deleting Files

You can delete one file at a time when you use the File Import and Export page. To delete multiple files simultaneously from the content repository, use the standard service page in Oracle WebCenter Content.

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.

External Data Integration Services for Oracle Cloud include the following components:

  • Templates to structure, format, and generate the data file according to the requirements of the target application tables.

  • File-based load process to load the data files into the interface tables.

  • Application-specific data import processes to transfer data from interface tables to the application tables in your Oracle Fusion Applications.

The following flow diagram outlines the steps involved in loading data from external sources.

This graphic shows the steps of the process, including
downloading and preparing the data file template, loading data to
interface and application tables, and correcting errors. The result
being data is successfully uploaded to the product tables.

For further information, see Using External Data Integration Services for Oracle ERP Cloud (2102800.1) on My Oracle Support at https://support.oracle.com.

Locating File Import Templates: Explained

The File Based Data Import guides in the Oracle Help Center (http://docs.oracle.com) include 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. Use the templates to ensure that your data conforms to the structure and format of the target application tables.

Preparing external data using templates involve the following tasks:

  • Downloading templates

  • Preparing data using the XLS template

Downloading Templates

To download the templates:

  1. Open the File Based Data Import guide for your cloud service.

  2. Locate the import process.

  3. View the list of files.

    • Control files describe the logical flow of the data load process.

    • XLSM templates include the worksheets and macros for structuring, formatting, and generating your data file.

      Note: You can use XML templates to import data into Oracle Data Integrator.
  4. Click the template link in the File Links table to download the file. For example, click JournalImportTemplate.xlsm in the Journal Import topic.

Preparing Data Using the XLS Template

To prepare your data in a spreadsheet format:

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

    Note: If you don't follow the instructions, you get data load errors and data import failures.
  2. Save the file.

  3. Click the Generate CSV File button.

    The macro generates a comma-separated values (CSV) file and compresses the file 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, download the XML templates using the following steps:

  1. Import the family-level template as a model folder.

  2. Import the product-level template as a model folder within the family-level model folder.

  3. Import the product template as a model within the product-level model folder.

  4. Create the integration project.

  5. Create the package.

  6. Add and configure these elements:

    • Integration projects

    • Content management document transfer utility

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

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

The File Based Data Import guides in the Oracle Help Center (http://docs.oracle.com) include 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. Use the templates to ensure that your data conforms to the structure and format of the target application tables.

Template Structure

The integration templates include the following characteristics:

  • 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.

  • Columns are formatted, where applicable, to match the target field data type to eliminate data entry errors.

    The worksheet columns appear in the order that the control file processes the data file.

For more information on the template structure, see the Instructions and CSV Generation worksheet in the template.

Template Requirements

To minimize the risks of an unsuccessful data load, ensure the following:

  • Unused columns can be hidden, but not reordered or deleted.

    Caution: Deleting or reordering columns causes the load process to fail and results in an unsuccessful data load.
  • External data must conform to the data type accepted by the control file and process for the associated database column.

  • Date column values must appear in the YYYY/MM/DD format.

  • Amount column values can't have 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.

  • For columns that require internal ID values, refer to the bubble text for additional guidance about finding these values.

After you finish preparing the data in the sheet, click the Generate CSV File button to generate a ZIP file containing one or more CSV files.

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

Use XML templates in Oracle Data Integrator to prepare your external data for the load and import process.

The File Based Data Import guides in the Oracle Help Center (https://docs.oracle.com) include three types of XML templates that you import as target models in your Oracle Data Integrator repository:

  • 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:

  • Use the family-level XML file to support assets in the family, for example, Oracle Fusion Financials or Human Capital Management.

  • Import the family-level XML file into your Oracle Data Integrator repository prior to importing the other XML files.

  • Import one family-level XML file as a model folder for each family of products.

  • Import each family-level XML file as a top-level model folder.

  • Import the family-level XML file one time; it supports all subsumed product-level model folders.

  • 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:

  • Use the product-level XML file to support assets in the product line, for example, Fixed Assets, General Ledger, or Payables.

  • Import one product-level XML file as a model folder for each line of products.

  • Import the product-level XML file as a model folder into your Oracle Data Integrator repository.

  • Import the family-level XML file before you import product XML files.

  • Import each product-level XML file as a mid-level model folder within the appropriate family-level model folder.

  • Import the product-level XML file one time; it supports all subsumed product models.

  • Select Synonym Mode Insert Update as the import type.

Product XML Files

A product XML file represents a specific interface table asset.

Consider the following points when you use product XML files:

  • Import one product XML file as a model for each interface table or set of tables, for example, Mass Additions.

  • Import the product XML file as a model into your Oracle Data Integrator repository after you import the product-level XML file.

  • Import each product XML file as a model within the appropriate product-level model folder.

  • Import each product XML file one time. The model is based on File technology.

  • Select Synonym Mode Insert Update as the import type.

  • After you import the product model, connect the model to the correct logical schema.

Transferring Data Files to Oracle WebCenter Content Using Manual Flow: Explained

After you generate the ZIP file that contains the CSV data import file, transfer the ZIP file to the content repository.

Use any of the following methods to transfer file:

  • File Import and Export page in Oracle Fusion Applications: Manual flow

  • Oracle Fusion ERP Integration web service: Automated flow

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

  • Target accounts

  • Accessing transferred content

Predefined Target UCM Accounts

You can transfer data files to predefined accounts in the Universal Content Management server that correspond to the interface table or assets.

To find the UCM account:

  1. Open the File Based Data Import guide for your cloud service.

  2. Locate your respective import process. For example, Journal Import.

  3. View the UCM account in the Details section.

For more information, see the following guides in the Oracle Help Center (https://docs.oracle.com):

  • SOAP Web Services guide for your cloud services

  • File Based Data Import guide for your cloud services

Load Interface File for Import Process

Use to load external setup or transaction data from a data file in the content repository to interface tables. The process prepares the data for import into application tables.

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

Before running this process, you must:

  1. Prepare your data file.

  2. Transfer the data file to the content repository.

Parameters

Import Process

Select the target import process.

Data file

Enter the relative path and the file name of the *.zip data file in the content repository.

Importing Data into Application Tables: Procedure

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

Importing data into application tables involves 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 application 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 using the following steps:

  1. From the Navigator, click Tools.

  2. Click Scheduled Processes.

  3. Click the Schedule New Process button.

  4. Search and select the Load Interface File for Import job.

  5. On the Process Details page:

    1. Select the target import process.

    2. Enter the data file name.

  6. Submit the process.

If the process is successful, the status is SUCCEEDED and the process populates the interface tables. If the process isn't successful, the status is ERROR.

Note: The data file remains in the content repository after the process ends.

Finding and Submitting the Import Process

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

To import your data into the application tables:

  1. From the Navigator, click Tools.

  2. Click Scheduled Processes.

  3. Click the Schedule New Process button.

  4. Search and select the import process for the target application tables.

  5. On the Process Details page, select the process that corresponds to the data that you're importing. For example, Journal Import.

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

  6. Submit the process.

If the process is successful, the status is SUCCEEDED. The data in the interface tables is validated and the successful records are imported into the Oracle Fusion application tables. If the process isn't successful, the status is ERROR.

Note: For more 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 Load File to Interface child process ends as an error or warning. All rows that were loaded by the process are deleted and the entire batch of records is rejected.

Correcting Data Upload Errors

To correct errors:

  1. Review the error logs.

  2. Change any structural or formatting anomalies in the data.

  3. Generate the ZIP file containing the CSV files using the template.

  4. Upload the file to the UCM server and resubmit the Load Interface File for Import process.

  5. Repeat these steps until the process successfully loads all the data.

Correcting Import Process Errors

If the import process fails with errors:

  1. Review the errors in the import log.

  2. Correct the error records using the ADFdi correction spreadsheets.

Importing Purchasing Documents: Procedure

You can import purchasing documents from external applications into Oracle Fusion Purchasing.

How to Import Purchasing Documents

You can run the purchasing document import tasks from the Purchase Agreements or Purchase Orders work areas. Use the following purchasing tasks to import purchasing documents:

  • Import Orders

  • Import Blanket Agreements

  • Import Contract Agreements

Run the import process to import purchase orders, blanket agreements, or contract agreements into the application for further processing.

You can query, modify and validate successfully imported documents. During import, records that have insufficient or invalid data are rejected. You can use an automatically produced report to review the documents that could not be imported. You can resubmit the import task after making corrections to rejected documents.

Prerequisite

Before you can run the import process, you must first have loaded the relevant information into the appropriate interface tables.

Note: You can load data to interface tables using predefined templates and the Load Interface File for Import scheduled process. Both are part of the External Data Integration Services for Oracle Cloud. For other implementations, optionally use this feature only if you have SFTP configured for it.

For more information refer to the File-Based Data Import for Oracle Procurement Cloud guide on the Oracle Help Center.

Import Process

To run the process to import purchase orders, blanket agreements, or contract agreements into the application, follow these steps:

  1. From the Purchase Agreements or Purchase Orders work area, open the appropriate task you want to use:

    • Import Orders

    • Import Blanket Agreements

    • Import Contract Agreements

  2. Depending on the purchase document import task you are using, you can set one or more selection parameters before running the process. The following table lists some of the possible selection parameters and their descriptions.

    Parameter Description

    Procurement BU

    Specify the name of the Procurement business unit that these documents should be imported into.

    Default Buyer

    Specify the name of the buyer to be used when one is not included in the import data.

    Create or Update Item

    Select "Yes" to create an item that does not exist or update an existing item.

    Approval Action

    Select one of the following actions:

    • Do Not Approve: Imports the document in Incomplete status requiring manual interaction.

    • Submit for Approval: Imports the document and submits it to the approval process after the document is imported.

    • Bypass Approval: Imports the document in Open (approved) status without going through the approval process.

    Batch ID

    Enter the value for your import data from the file-based data import template, to select the interface table data to be processed in the current run. For example: Batch ID = 123. Use it in conjunction with Import Source to identify the documents to be loaded to the application tables.

    Import Source

    Enter the value for your import data from the file-based data import template, to select the interface table data to be processed in the current run. For example: Import Source = External Contracts. Use it in conjunction with Batch ID to identify the documents to be loaded to the application tables.

    Default Requisitioning BU

    Specify the name of the Requisitioning business unit to be used when one is not included in the import data.

    Communicate Orders, or Communicate Agreements

    Select Yes to have imported purchasing documents communicated to the supplier.

    Select No to not have imported purchasing documents communicated to the supplier.

  3. When the processes are complete, view the output report in PDF format. The report details the status of the records that were imported. If a record could not be imported, then the Status is set to Rejected with a reason for the rejection.

  4. Fix the problems that are identified in the report and then resubmit the import task.

Viewing the Import Process Results

The results for each import process are compiled in a PDF output report which you can view online or print. The validation error details are accessible from the Purchasing Document Import Errors report. To see the report click the Output icon in the Scheduled Processes region of the import page.

Project Information in Imported Procurement Transactions: Explained

You can include sponsored project information when importing requisition and purchase order transactions, using these methodologies:

  • The document is created in an external application, and sent to the requisition or purchasing application through a web service.

  • You import the document using a cloud import template.

  • You import the document using open interface.

Attributes you can use in the imports include:

  • Project Number

  • Task Number

  • Expenditure Item Date

  • Expenditure Type

  • Expenditure Organization

  • Contract Number

  • Funding Source