Salesforce Health Cloud Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
UIObjectRelationConfig
Parent Type
This type extends the Metadata metadata type and inherits its fullName field.
File Suffix and Directory Location
UIObjectRelationConfig components have the suffix .uiObjectRelationConfig and are stored in the uiObjectRelationConfigs folder.
Version
UIObjectRelationConfig components are available in API version 54.0 and later.
Special Access Rules
You must be a Health Cloud or Life Sciences Cloud customer to use this metadata type
Fields
| Field Name | Description |
|---|---|
| contextObject |
|
| contextObjectRecordType |
|
| directRelationshipField |
|
| indirectObjectContextField |
|
| indirectObjectRelatedField |
|
| indirectRelationshipObject |
|
| isActive |
|
| masterLabel |
|
| relatedObject |
|
| relatedObjectRecordType |
|
| relationshipType |
|
| UIObjectRelationFieldConfigs |
|
UIObjectRelationFieldConfig
Represents a configuration for a single row of content on a specific object relation configuration.
| Field Name | Description |
|---|---|
| displayLabel |
|
| queryText |
|
| rowOrder |
|
Declarative Metadata Sample Definition
This is an example of a UIObjectRelationConfig component.
<?xml version="1.0" encoding="UTF-8"?>
<UIObjectRelationConfig xmlns="http://soap.sforce.com/2006/04/metadata">
<UIObjectRelationFieldConfigs>
<displayLabel>Address:</displayLabel>
<queryText>{
"startNode": {
"initialObject": "RelatedObject"
},
"traversalNodes": [],
"fieldNode": {
"fieldEnumOrId": "ShippingAddress"
}
}</queryText>
<rowOrder>1</rowOrder>
</UIObjectRelationFieldConfigs>
<UIObjectRelationFieldConfigs>
<displayLabel>Phone:</displayLabel>
<queryText>{
"startNode": {
"initialObject": "RelatedObject"
},
"traversalNodes": [],
"fieldNode": {
"fieldEnumOrId": "Phone"
}
}</queryText>
<rowOrder>2</rowOrder>
</UIObjectRelationFieldConfigs>
<UIObjectRelationFieldConfigs>
<displayLabel>Fax:</displayLabel>
<queryText>{
"startNode": {
"initialObject": "RelatedObject"
},
"traversalNodes": [],
"fieldNode": {
"fieldEnumOrId": "Fax"
}
}</queryText>
<rowOrder>3</rowOrder>
</UIObjectRelationFieldConfigs>
<UIObjectRelationFieldConfigs>
<displayLabel>Parent Organization:</displayLabel>
<queryText>{
"startNode": {
"initialObject": "RelatedObject"
},
"traversalNodes": [
{
"destinationObjectEnumOrId": "Account",
"fieldEnumOrId": "ParentId",
"traversalDirection": "parent"
}
],
"fieldNode": {
"fieldEnumOrId": "Name"
}
}</queryText>
<rowOrder>4</rowOrder>
</UIObjectRelationFieldConfigs>
<contextObject>Contact</contextObject>
<directRelationshipField>AccountId</directRelationshipField>
<isActive>true</isActive>
<masterLabel>Sample Primary Account Configuration</masterLabel>
<relatedObject>Account</relatedObject>
<relationshipType>Direct</relationshipType>
<indirectObjectRelatedField></indirectObjectRelatedField>
<indirectObjectContextField></indirectObjectContextField>
<contextObjectRecordType></contextObjectRecordType>
<indirectRelationshipObject></indirectRelationshipObject>
<relatedObjectRecordType></relatedObjectRecordType>
</UIObjectRelationConfig>This is an example package.xml that references the previous definition.
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>*</members>
<name>UIObjectRelationConfig</name>
</types>
<version>54.0</version>
</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.