--- schema_version: "1" id: c4683b7a7378f9ee5a9cc5a481eef7c0d502ccc24547da691afa7420d9cb79f2 title: RelationshipGraphDefinition collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_relationshipgraphdefinition.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_relationshipgraphdefinition.htm source_site: developer.salesforce.com content_type: documentation content_hash: 2355c6fd4a38e5c81ed544fee8b66c86d1c1312b8fcb92216cdf90ed65c5c804 description: Represents a definition of a graph that you can configure in your organization to traverse object hierarchies and record details, giving you a glimpse of how your business works. --- # RelationshipGraphDefinition Represents a definition of a graph that you can configure in your organization to traverse object hierarchies and record details, giving you a glimpse of how your business works. ![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png) #### Important 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. ## Parent Type This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field. ## File Suffix and Directory Location RelationshipGraphDefinition components have the suffix .relationshipGraphDefinition and are stored in the relationshipGraphDefinitions folder. ## Version RelationshipGraphDefinition components are available in API version 55.0 and later. ## Special Access Rules The Financial Services Cloud permission set license is required to access this object. ## Fields | Field Name | Description | | --- | --- | | isActive | Field Type boolean Description Required. Indicates whether the relationship graph is available for use (true) or not (false). The default value is true. ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png) #### Note This field is read-only in API version 55.0. | | isTemplate | Field Type boolean Description Required. Indicates whether you can configure this relationship graph as a template (true or not false). The default value is false. In the UI, this field is _Set as Template_. | | masterLabel | Field Type string Description Required. A user-friendly name for RelationshipGraphDefinition, which is defined when the RelationshipGraphDefinition is created. In the UI, this field is _Label_. | | relationshipGraphDefVersions | Field Type [RelationshipGraphDefVersion\[\]](#subtype_RelationshipGraphDefVersion) Description Represents a list of graph versions associated with the relationship graph definition. | ## RelationshipGraphDefVersion The list of graph versions associated with the relationship graph definition. | Field Name | Description | | --- | --- | | graphDefinition | Field Type string Description Required. Specifies a set of properties required to create a relationship graph, such as parent node, child relationships, filter and sort fields, and graph UI elements. | | graphType | Field Type string Description Required. Specifies the type of graph. In API version 55.0, only HorizontalHierarchy graph type is supported. | ## Declarative Metadata Sample Definition The following is an example of a RelationshipGraphDefinition component. false true Account Graph { "graph" : { "rootNode" : { "object" : { "entity" : "Account" }, "configurationType" : "Primary", "sortFields" : \[ { "field" : { "field" : "LastModifiedDate", "whichEntity" : "TARGET" }, "order" : "DESC" } \], "nodeUiConfig" : { "fieldsToDisplay" : \[ \], "showFieldLabels" : true, "actions" : { } }, "childRelationships" : \[ { "OneToMany" : { "targetObjectNode" : { "object" : { "entity" : "Contact" }, "configurationType" :"Custom", "sortFields" : \[ { "field" : { "field" : "LastModifiedDate", "whichEntity" : "TARGET" }, "order" : "DESC" } \], "nodeUiConfig" : { "fieldsToDisplay" : \[ { "field" : "Name", "whichEntity" : "TARGET" }, { "field" : "Phone", "whichEntity" :"TARGET" } \], "showFieldLabels" : true, "actions" : { "containerActions" : \[ { "action" : "New" } \], "recordActions" : \[ { "action" : "Edit" }, { "action" : "Delete" } \] } }, "childRelationships" : \[ \] }, "relationshipUiConfig" : { }, "filter" : { "filterCriteria" : \[ { "field" : { "field" : "Name", "whichEntity" : "TARGET" }, "operator" : "eq", "value" : "Salesforce" } \], "booleanFilter" : "1" }, "targetObjectField" : { "field" : "AccountId", "whichEntity" : "TARGET" } } } \] }, "globalUiConfig" : { "borderColor" : "Green2", "borderThickness" : "2px";, "colorShading" : "Black", "fieldLayout" : "Vertically Stacked", "recordContainerExpansion" : true, "recordExpansion" : true } } } HorizontalHierarchy The following is an example package.xml that references the previous definition. Package1 \* RelationshipGraphDefinition 55.0 ## 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").