ObjectHierarchyRelationship | Manufacturing Cloud Developer Guide

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

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

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	Description
childObjectMapping	Field Type ObjectMapping Description 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.
childObjectMappingId	Field Type String Description The ID of the child object mapping record. This field is available in API version 56.0 and later.
inputObjRecordsGrpFieldName	Field Type string Description The field name in the input object used to group the records. This field is available in API version 55.0 and later.
mappingType	Field Type ObjHierarchyMappingType (enumeration of type string) Description Specifies the type of relationship between two objects. This field is available in API version 55.0 and later. Valid values are: `ChildToChild` `ParentToChild` `ParentToParent` `Support`
masterLabel	Field Type string Description Label name of the mapping definition.
outputPntRelationshipFieldName	Field Type string Description The field name that defines the relationship between a parent and child for the output object. This field is available in API version 55.0 and later.
parentObjectMapping	Field Type ObjectMapping Description 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.
parentObjectMappingId	Field Type string Description The ID of the parent object mapping record. This field is available in API version 56.0 and later.
parentRecord	Field Type string Description The parent record for this object hierarchy relationship. This field is available in API version 55.0 and later.
parentRelationshipFieldName	Field Type string Description Name of the field that defines the relationship between the parent and child.
sourceReferenceRelaFieldName	Field Type string Description The field name in an object that's used to define the relationship between a source and reference object. This field is available in API version 56.0 and later.
usageType	Field Type MappingUsageType (enumeration of type string) Description Required. Name of the usage type of an object hierarchy relationship. Valid value is: `ConvertToSalesAgreement` `CLMFieldMapping` `EligibleProgramRebateType` `MapJournalToMemberAggregate` `TransformationMapping`

ObjectMapping

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

Fields

Field Name	Description
inputObject	Field Type string Description Required. Name of the input object type containing the source fields for mapping. For example, Opportunity or OpportunityLineItem.
mappingFields	Field Type ObjectMappingField Description Mapping of source object input fields to target object for SalesAgreement and SalesAgreementProduct.
outputObject	Field Type string Description 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	Description
inputField	Field Type string Description 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	Field Type string Description 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.

1<?xml version="1.0" encoding="UTF-8"?>
2<ObjectHierarchyRelationship
3	xmlns="http://soap.sforce.com/2006/04/metadata">
4	<parentObjectMapping>
5		<inputObject>Opportunity</inputObject>
6		<outputObject>SalesAgreement</outputObject>
7		<mappingFields>
8			<inputField>AccountId</inputField>
9			<outputField>AccountId</outputField>
10		</mappingFields>
11		<mappingFields>
12			<inputField>CloseDate</inputField>
13			<outputField>StartDate</outputField>
14		</mappingFields>
15	</parentObjectMapping>
16	<childObjectMapping>
17		<inputObject>OpportunityLineItem</inputObject>
18		<outputObject>SalesAgreementProduct</outputObject>
19		<mappingFields>
20			<inputField>TotalPrice</inputField>
21			<outputField>TotalPlannedAmount</outputField>
22		</mappingFields>
23	</childObjectMapping>
24	<usageType>ConvertToSalesAgreement</usageType>
25	<masterLabel>TestOptyToSalesAgreement</masterLabel>
26	<parentRelationshipFieldName>Opportunity</parentRelationshipFieldName>
27	<outputPntRelationshipFieldName>SalesAgreement</outputPntRelationshipFieldName>
28	<parentRecord></parentRecord>
29	<inputObjRecordsGrpFieldName>Account</inputObjRecordsGrpFieldName>
30	<mappingType>ParentToParent</mappingType>
31</ObjectHierarchyRelationship>

The following is an example package.xml that 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>ObjectHierarchyRelationship</name>
6    </types>
7    <version>51.0</version>
8</Package>

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.