OrchestrationPlanCtxMapping

Represents the context mapping that Dynamic Revenue Orchestrator (DRO) uses to generate and orchestrate a plan for an object, such as a non-sales transaction for billing or another generic business process.

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

OrchestrationPlanCtxMapping components have the suffix .orchestrationPlanCtxMapping and are stored in the orchestrationPlanCtxMappings folder.

Version

OrchestrationPlanCtxMapping components are available in API version 67.0 and later.

Fields

Field Name	Description
contextDefinition	Field Type string Description Required. ContextDefinition that the orchestration use case is based on.
contextItemNode	Field Type string Description Name of the item-level node in the context definition. The item node represents the line items or child records of the root node, such as the items in an order.
contextMapping	Field Type string Description Required. Name of the context mapping that maps the source object fields to the nodes in the context definition.
contextRootNode	Field Type string Description Required. Name of the root node in the context definition. The root node represents the parent record that the orchestration plan is generated for, such as an order.
label	Field Type string Description Required. UI label for the orchestration plan context mapping.
objectName	Field Type string Description Required. API name of the object that the orchestration plan is generated for. The combination of objectName and orchestrationType must be unique.
orchestrationType	Field Type PlanUsageType (enumeration of type string) Description Required. Type of orchestration plan that this context mapping applies to. Valid values are: `Billing` `Fulfillment` `Generic` `IntegrationOrchestrator` `InsuranceRuleAction` `OrderFulfillment` `StageManagement`

Declarative Metadata Sample Definition

This sample shows the definition of an OrchestrationPlanCtxMapping component for a fulfillment plan that orchestrates an order.

1<?xml version="1.0" encoding="UTF-8"?>
2<OrchestrationPlanCtxMapping xmlns="http://soap.sforce.com/2006/04/metadata">
3    <label>Order Fulfillment Context Mapping</label>
4    <orchestrationType>Fulfillment</orchestrationType>
5    <contextDefinition>SalesTransactionContext__stdctx</contextDefinition>
6    <objectName>Order</objectName>
7    <contextMapping>OrderEntitiesMapping</contextMapping>
8    <contextRootNode>SalesTransaction</contextRootNode>
9    <contextItemNode>SalesTransactionItem</contextItemNode>
10</OrchestrationPlanCtxMapping>

This sample package.xml references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>OrchestrationPlanCtxMapping</name>
6    </types>
7    <version>67.0</version>
8</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide