Manufacturing Cloud Developer Guide

Manufacturing Cloud Standard Objects
Manufacturing Cloud Associated Objects
Manufacturing Cloud Business APIs
Manufacturing Cloud Metadata API Types
AccountForecastSettings
AcctMgrTargetSettings
Flow for Manufacturing Cloud
ObjectHierarchyRelationship
SalesAgreementSettings
Settings
Manufacturing Cloud Tooling API Objects
Manufacturing Cloud Standard Invocable Actions
PDF

Newer Version Available

This content describes an older version of this product. View Latest

ObjectHierarchyRelationship

Represents an organization’s custom field mappings for sales agreement conversion. Fields can be mapped from Opportunity and Quotes to SalesAgreement and SalesAgreementProduct. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

ObjectHierarchyRelationship components have the suffix ObjectHierarchyRelationship.settings and are stored in the ObjectHierarchyRelationship folder.

Version

ObjectHierarchyRelationship components are available in API version 51.0 and later.

Fields

Field Name Field Type Description
childObjectMapping ObjectMapping Set of inputObject, mappingFields, and outputObject entries. For example, fields from the input object of OpportunityLineItem maps to fields of the output object of SalesAgreementProduct.
masterLabel string Master label name of the mapping definition.
parentObjectMapping ObjectMapping Required. Set of inputObject, mappingFields, and outputObject entries. For example,fields from the input object of Opportunity maps to fields of the output object of SalesAgreement.
parentRelationshipFieldName string Name of the field that defines the relationship between the parent and child
usageType MappingUsageType (enumeration of type string) Required. Name of the usage type of an object hierarchy relationship.
Possible value is:
  • ConvertToSalesAgreement
  • EligibleProgramRebateType

ObjectMapping

Represents a set of inputObject, mappingFields, and outputObject entries.

Fields

Field Name Field Type Description
inputObject string Required. Name of the input object type containing the source fields for mapping. For example, Opportunity or OpportunityLineItem.
mappingFields ObjectMapping​Field Mapping of source object input fields to target object for SalesAgreement and SalesAgreementProduct.
outputObject string Required. Name of the output object type receiving data conversion. For example, SalesAgreement or SalesAgreementProduct.

ObjectMappingField

Represents a set of inputField and outputField entries.

Fields

Field Name Field Type Description
inputField string Required. Field in the object specified by the inputObject field in ObjectMapping. This field is mapped to the field in outputField, which is a field in the object specified by the outputObject field in ObjectMapping.
outputField string Required. Field in the object specified by the outputObject field in ObjectMapping. This field is mapped to the field name in inputField, which is a field in the object specified by the inputObject field in ObjectMapping.

Declarative Metadata Sample Definition

The following is an example of a ObjectHierarchyRelationship component.

The following is an example package.xml that references the previous definition.

Usage

Use the deploy() call to deploy metadata with a .zip file. Every .zip file contains a project manifest, a file that’s named package.xml, and a set of directories that contain the components. The manifest file defines the components that you’re trying to retrieve or deploy in the .zip file. The manifest also defines the API version that’s used for the deployment or retrieval. For more information on the .zip file, deploying, and retrieving metadata, see Deploying and Retrieving Metadata with the Zip File. You can also deploy and retrieve the metadata API. using Workbench

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.