For the complete documentation index, see llms.txt. This page is also available as Markdown.

Oracle Fusion Cloud SCM Integration

How to integrate Oracle Fusion Cloud SCM with Connectware, including basic authentication, reporting operation and material transactions, and polling work orders.

This guide describes how to integrate Oracle Fusion Cloud Supply Chain Management (SCM) with Connectware. You configure a service commissioning file that reports production progress from the shop floor to Oracle Manufacturing through its REST APIs and polls work orders in return. A complete example file is available at the end of this guide.

Objectives

  • Establishing a connection between Connectware and the Oracle Fusion Cloud SCM REST APIs.

  • Reporting work order operation transactions with shop floor data.

  • Reporting material transactions for component issues and returns.

  • Polling released work orders and publishing them to the MQTT topic hierarchy.

Prerequisites

To follow this guide, you will need the following:

  • A running instance of Cybus Connectware.

  • Access to an Oracle Fusion Cloud SCM environment with the Manufacturing offering, and the hostname of your instance. For example, servername.fa.us2.oraclecloud.com.

  • A dedicated integration user with the privileges to view work orders and report production transactions in the target manufacturing organization.

  • Manufacturing master data in Oracle Fusion Cloud: an organization code and at least one released work order with operations.

  • Access to the Admin UI with sufficient user permissions.

  • Basic knowledge of MQTT and the Connectware services concept (for example, service commissioning files, connections, and endpoints).

Connectware and Oracle Fusion Cloud SCM Integration

Oracle Fusion Cloud SCM exposes its functionality as REST APIs under a common base path of the form https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05. The version segment 11.13.18.05 is the stable REST API version of Oracle Fusion Cloud Applications. The APIs support basic authentication over TLS as well as SAML and JWT tokens. Connectware communicates with these APIs through the HTTP/REST connector.

This guide uses three Manufacturing resources of the REST API for Oracle Fusion Cloud SCM:

  • Operation Transactions (/operationTransactions): Reports the progress of work order operations, such as completed quantities.

  • Material Transactions (/materialTransactions): Reports components that are issued to or returned from a work order.

  • Work Orders (/workOrders): Provides the work orders of a manufacturing organization. Connectware polls this resource and publishes the result to an MQTT topic.

The MQTT topics in this guide follow an ISA-95-style equipment hierarchy (<enterprise>/<site>/<area>/<line>/<cell>). The mappings subscribe with wildcards across all levels, so any machine in the hierarchy is picked up without changing the integration.

Oracle Fusion Cloud SCM Connection Properties

The connection to Oracle Fusion Cloud SCM requires the hostname of your instance and the credentials of the integration user. We add them as parameters to the service commissioning file, so you can set them when you install the service.

Do not worry about copying the service commissioning file snippets together into one, the complete example file is available at the end of this guide.

  • oracleFusionHost: The hostname of your Oracle Fusion Cloud instance, without the scheme. For example, example.fa.us2.oraclecloud.com.

  • restApiVersion: The REST API version in the base path. Defaults to 11.13.18.05.

  • integrationUsername and integrationPassword: The credentials of the integration user.

  • organizationCode: The code of the manufacturing organization whose work orders are polled.

  • pollInterval: The polling interval for work orders in milliseconds. Defaults to one minute.

  • topicRoot: The root of the MQTT topic hierarchy. Defaults to enterprise.

Oracle Fusion Cloud SCM Connection

To connect to the Oracle Fusion Cloud REST APIs, we set up a Cybus::Connection resource that uses the HTTP/REST connector with basic authentication. The auth property holds the credentials of the integration user, and the prefix property applies the common base path to all endpoints of this connection. This keeps the endpoint paths short and moves the API version into a single parameter.

If your environment requires additional headers on every request, for example REST-Framework-Version, add them with the headers property of the connection.

Reporting Operation Transactions

The Operation Transactions resource reports the progress of a work order operation, for example moving a quantity from the READY to the COMPLETE dispatch state. Each POST request creates one or more operation transactions.

We define a write endpoint for the API path and a mapping that feeds it from the MQTT topic hierarchy. The HTTP/REST connector expects the request body in the body property of the message (see Publishing Data to REST Servers). The transform rule wraps the incoming payload accordingly, so machines can publish their data without knowing about this convention.

Any message published to a matching topic, for example enterprise/hamburg/machining/line-1/cnc-01/work-order-transactions, now creates one operation transaction in Oracle Manufacturing. The payload must follow the request schema of the Operation Transactions resource. The dispatch states come from the Oracle lookup type ORA_WIE_DISPATCH_STATE:

Reporting Material Transactions

The Material Transactions resource works the same way and reports components that are issued to or returned from a work order. The endpoint uses the same connection with a different path, and the mapping listens on the material-transactions leaf of the topic hierarchy.

The payload must follow the request schema of the Material Transactions resource. The item, the subinventory, and the transaction type must exist in your Oracle Fusion Cloud master data:

Polling Work Orders

For the opposite direction, a subscribe endpoint polls the Work Orders resource at the configured interval. The query property adds the standard Oracle REST query parameters to every request: the q parameter filters for released work orders of the configured organization, onlyData omits the navigation links from the response, and limit caps the page size. The valid work order status codes are available through the workOrderStatuses resource of your instance, ORA_RELEASED is the seeded code for released work orders.

Every poll result is published to the topic enterprise/oracle-fusion/work-orders in the standardized wrapper of the HTTP/REST connector (see Response Message Format). The value property contains the Oracle response with one entry per work order in the items array. From there, any other Connectware service can pick up the work orders, for example to display the order queue on a shop floor dashboard.

Using OAuth 2.0 Instead of Basic Authentication

Basic authentication with a dedicated integration user is the most direct way to connect and is used throughout this guide. Oracle Fusion Cloud also supports token-based authentication through Oracle Identity and Access Management, for example with JWT bearer tokens. If your Oracle environment provides an OAuth token endpoint with client credentials, replace the auth property of the connection with the oauthClientCredentials property. Connectware then fetches and renews the token automatically. For more information, see OAuth 2.0 Client Credentials Grant.

Verifying the Integration

  1. Install the service and set the parameters for your Oracle Fusion Cloud instance and integration user.

  2. Check that the connection is in the Connected state on the service details page in the Admin UI. The connected state confirms that Connectware reaches the Oracle host. Authentication errors appear on the endpoint result topics instead.

  3. Open the Data Explorer and subscribe to enterprise/oracle-fusion/work-orders. A message with the released work orders arrives with every polling interval.

  4. Publish a test operation transaction to enterprise/hamburg/machining/line-1/cnc-01/work-order-transactions, for example with an MQTT client or the Admin UI. Use the work order number and operation sequence of a released work order from the previous step.

  5. Inspect the /res topic of the operation transactions endpoint in the Data Explorer. On success, the Oracle response contains "ErrorsExistFlag": false. If the request fails, the message contains an error property with the HTTP status, and business validation errors are listed in the ErrorMessages attribute of the Oracle response.

  6. In Oracle Fusion Cloud, open the Work Execution work area and check that the completed quantity of the work order operation has increased.

Service Commissioning File Example

Last updated

Was this helpful?