Loading
Get Started with Communications, Media, and Energy & Utilities (CME)...
Table of Contents
Filter by (0)Add
Select Filters

          No results
          No results
          Here are some search tips

          Check the spelling of your keywords.
          Use more general search terms.
          Select fewer filters to broaden your search.

            Search all of Salesforce Help
            Search all of Salesforce Help
            Relationship Graph Traversal Object Fields and Mappings

            You are here:

            1. Salesforce Help
            2. Docs
            3. Communications, Media, and Energy & Utilities Managed Package

            Relationship Graph Traversal Object Fields and Mappings

            When you create a Relationship Graph traversal, you must map a few required traversal fields to relationship fields. For Party Relationship and Custom Junction objects, many more traversal field mappings are optional.

            In these tables, a relationship object is either a Party Relationship object or a Custom Junction object. The first table lists traversal fields. The second table lists options for referencing relationship object label fields. The third table shows examples of traversal-to-relationship field mappings.

            Setting

            One to Many

            Many to Many

            Description

            Relationship Graph Traversal Name

            Required

            Required

            The name of this Relationship Graph Traversal object.

            Source Object API Name

            Required

            Required

            The object type for the primary role.

            Target Object API Name

            Required

            Required

            The object type for the secondary role.

            Source Object Field

            Not present

            Required

            The field in the relationship object that references the Id of the source object.

            Target Object Field

            Required

            Required

            One-to-many: The field in the target object that references the Id of the source object.

            Many-to-many: The field in the relationship object that references the Id of the target object.

            Relationship Object

            Not present

            Required

            The name of the Party Relationship or Custom Junction object.

            Relationship Type Field

            Not present

            Required for Party Model

            The field in the Party Relationship object that references the Id of the Party Relationship Type object.

            Relationship Type Value

            Not present

            Required for Party Model

            The Id of the Party Relationship Type object.

            Source Label

            Required

            Required

            A label for the primary role. For a many-to-many relationship, the mouse-over text is this value or the Source Label Field value.

            Target Label

            Required

            Required

            A label for the secondary role. For a many-to-many relationship, the mouse-over text is this value or the Source Label Field value.

            Source Label Field

            Not present

            Optional

            The field in the relationship object or Party Relationship Type that labels the primary role. To refer to Party Relationship or Party Relationship Type fields, see the next table.

            Target Label Field

            Not present

            Optional

            The field in the relationship object or Party Relationship Type that labels the secondary role. To refer to Party Relationship and Party Relationship Type fields, see the next table.

            Role Field

            Not present

            Optional

            The field in the relationship object that specifies the relationship role name.

            Default Strength Value

            Required

            Required

            The default strength if no Strength Field value exists.

            Strength Field

            Not present

            Optional

            The field in the relationship object that specifies the relationship strength.

            Influence Score Field

            Not present

            Optional

            The field in the relationship object that specifies the relationship influence level.

            Start Date Field

            Required for Timeline graph, otherwise optional

            Required for Timeline graph, otherwise optional

            One-to-many: The field in the target object that specifies when the relationship started.

            You can reference a field in the source object using relationship notation. See Include Related Object Fields in a Relationship Graph.

            Many-to-many: The field in the relationship object that specifies when the relationship started.

            End Date Field

            Optional

            Optional

            One-to-many: The field in the target object that specifies when the relationship ended.

            You can reference a field in the source object using relationship notation. See Include Related Object Fields in a Relationship Graph.

            Many-to-many: The field in the relationship object that specifies when the relationship ended.

            Comment Field

            Not present

            Optional

            The field in the relationship object that stores comments.

            Field List

            Not present

            Optional

            JSON code that lists other fields to fetch from the relationship object.

            The following table shows options for referencing Party Relationship Type and Party Relationship fields in the Source Label Field and Target Label Field. The namespace is assumed to be vlocity_ins.

            Referenced Field

            Source Label Field or Target Label Field Value

            Party Relationship Type, Source Role

            vlocity_ins__RelationshipTypeId__r.Name

            Party Relationship Type, Target Role

            vlocity_ins__RelationshipTypeId__r.vlocity_ins__TargetRole__c

            Party Relationship Type, Label String

            vlocity_ins__RelationshipTypeId__r.vlocity_ins__SourceString__c

            Party Relationship, Primary Role

            vlocity_ins__PrimaryRole__c

            Party Relationship, Target Role

            vlocity_ins__TargetRole__c

            In the table below, for all custom objects and fields that have a namespace, you must include the namespace followed by two underscores as a prefix. For example, if the namespace is vlocity_ins and the object type is PartyRelationship__c, the fully qualified name is vlocity_ins__PartyRelationship__c. If the namespace is acme and the field name is GroupId__c, the fully qualified name is acme__GroupId__c.

            Setting

            One-to-Many Example

            Party Model Example

            Custom Junction Example

            Relationship Graph Traversal Name

            Account and Contact Traversal

            Teacher Student Traversal

            Interest Groups Traversal

            Source Object API Name

            Account

            Contact

            acme__Group__c

            Target Object API Name

            Contact

            Contact

            Contact

            Source Object Field

            —

            SourcePartyId__r.vlocity_ins__PartyEntityId__c

            acme__GroupId__c

            Target Object Field

            AccountId

            TargetPartyId__r.vlocity_ins__PartyEntityId__c

            acme__MemberId__c

            Relationship Object

            —

            vlocity_ins__PartyRelationship__c

            acme__GroupsAndMembers__c

            Relationship Type Field

            —

            vlocity_ins__RelationshipTypeId__c

            —

            Relationship Type Value

            —

            a0v1U000000mtlZQAQ

            —

            Source Label

            Account

            (Source Label Field used instead)

            (Source Label Field used instead)

            Target Label

            Contact

            (Target Label Field used instead)

            (Target Label Field used instead)

            Source Label Field

            —

            vlocity_ins__PrimaryRole__c

            acme__GroupLabel__c

            Target Label Field

            —

            vlocity_ins__TargetRole__c

            acme__MemberLabel__c

            Role Field

            —

            (not used)

            acme__MemberRole__c

            Default Strength Value

            1

            3

            2

            Strength Field

            —

            vlocity_ins__Strength__c

            acme__DedicationLevel__c

            Influence Score Field

            —

            vlocity_ins__InfluenceScore__c

            acme__LeadershipLevel__c

            Start Date Field

            CreatedDate

            vlocity_ins__RelationshipStartDate__c

            acme__JoinDate__c

            End Date Field

            —

            vlocity_ins__RelationshipEndDate__c

            acme__LeaveDate__c

            Comment Field

            —

            vlocity_ins__Comment__c

            acme__Comments__c

            Field List

            —

            ["vlocity_ins__IsActive__c", "vlocity_ins__Color__c"]

            ["acme__IsActive__c", "acme__YearsInGroup__c"]
             
            Loading
            Salesforce Help | Article