1. Implementing Order Management
  2. Use References to Tie Your Imports to Documents

Use References to Tie Your Imports to Documents

Use a reference to tie an order line that you import to a document.

Here are some examples of documents:

  • Warranty agreement
  • Subscription agreement
  • Service agreement
  • Record in an asset management system
  • Sales order in Oracle Order Management

How Do I Do It?

You can specify a document reference when you import through:

  • File-Based Data Import. Use the DOO_ORDER_DOC_REFERENCES_INT worksheet in the SourceSalesOrderImportTemplate.xlsm file. Follow the instructions in the file. For example, if the column name has an asterisk, such as *Source Transaction Line Identifier, then you must include a value in that column. Make sure you enter one and only one value for each color group.
  • REST API. Go to REST API for Oracle Supply Chain Management Cloud, expand Order Management > Sales Orders for Order Hub Requests > Create Sales Orders, search for DocumentReference, then see how the example payloads use the DocumentReferenceType attribute and the OrigSystemDocumentReference attribute. There are more examples in Get All Sales Orders and Update One Sales Order.

Specify the Document Reference Type

You must specify the Document Reference Type attribute in your import payload. Set it to one of these values:

Use This Type To Tie the Line That You're Importing To:
ORIGINAL_ORCHESTRATION_ORDER

The original order line in Order Management.

Use it with a referenced return when you create the original sales order in Order Management.
ORIGINAL_SALES_ORDER

The original order line in your source system.

Use it with a referenced return when you create the original order in your source system.
EXTERNAL_ASSET_REF

An asset that you manage outside of Oracle Applications.

For example, you use your own asset management software to track your assets, such as computers, equipment, vehicles, or machinery.
COVERED_ITEM_FOR_ADHOC_RTN

A covered item on an unreferenced return.

For example, you purchase the 2 Year Warranty when you buy the AS54888 computer on sales order 54381. The warranty is the coverage item and the computer is the covered item. You add the AS54888 to a return order but you don't reference the original 54381 sales order that you used to purchase the computer.
COVERAGE_COVERED_ASSOCIATION

A covered item when the line that you're importing contains the coverage item and you manage the covered item in Oracle Applications.

For example, the line that you're importing has the 2 Year Warranty, that warranty must cover the AS54888 computer, and you use Oracle's Product Information Management work area to set up and manage the AS54888.
SOURCE_COVERAGE_COVERED_ASSOC

A covered item when the line that you're importing contains the coverage item and you manage the covered item outside of Oracle Applications.

For example, the line that you're importing has the 2 Year Warranty, that warranty must cover the AS54888 computer, and you use your source system to set up and manage the AS54888.
SOURCE_SUBSCRIPTION_ASSOC A coverage or subscription that you manage outside of Oracle Applications.

Use these types when you manage the coverage or subscription in Oracle Subscription Management:

Use This Type To Tie the Line That You're Importing To:

SUBSCRIPTION_ASSOCIATION

 A coverage or subscription.
AMEND_SUBS_COV_RELATIONSHIP A coverage or subscription that you need to end as part of the Amendment action.
RENEW_SUBS_COV_RELATIONSHIP A coverage or subscription that you need to renew as part of the Renew action.
COVERED_ASSET_ASSOCIATION

An asset that needs a coverage or subscription.

For example, the line that you're importing has the 2 Year Warranty and you need to tie it to the AS54888 computer. The computer is the asset and the warranty is the coverage.

Other Uses

Use a document reference to map data elements between entities and your fulfillment system. See the Map Document References section in Connect Order Management to Your Fulfillment System.

Use an order management extension to display document references for a sales order. See the Get and Display Document References section in Use Extensions to Manage Messages. For the attributes that you can use, see the Document Reference Attributes section in Attributes That You Can Use With Order Management Extensions.