Relationships

Relationships are associations between objectsSalesforce says, "An object allows you to store information in your Salesforce organization." that retrieve data that you can use in the documents you generate. Different types of relationships between objects in Salesforce determine how they handle data deletion, sharing, and required fields in page layouts.

To watch video tutorials on how to use this Nintex capability, take the SELF: Nintex Drawloop DocGen - Expert in Nintex University.

What can you do with relationships?

Relationships send the data within objects to your DocGen PackagesA customizable package that consists of your Salesforce data, documents, and delivery configurations for documents you want to generate. to create documents. The Field Tagger shows tagsA prefilled word block that DocGen selects for fields in your DocGen Package. The tag is a placeholder for the value being retrieved from Salesforce and it gets replaced with the relevant information when the document is generated. that represent what data is available for that DocGen Package.

You can use relationships to:

Types of relationships

There are five different types of relationships. You can combine relationship types to get the required data for your DocGen Packages.

Relationship Type Description
Relationships from Starting Objects Starting Object relationships are known as the basic relationships. We recommend you use this option first.
Relationships from Other Objects Relationships from Other Objects are similar to Salesforce Objects except they can start with any standard object rather than just the starting object for the DocGen Package. Use these when you want to create a relationship from an additional standard objectObjects that are in a Salesforce org by default e.g. Account, Contact, Lead, Opportunity..
Stand Alone Data Relationships Use Stand Alone Data relationships to include data from objects that do not need or have a direct link to other objects in your DocGen Package.
SOQL Query Relationships SOQL Query Relationships are perfect for users who are comfortable with SOQL or if there is a complex relationship that would be hard to express using another relationship type.
Apex Data Relationships Apex Data Relationships are perfect for users who are comfortable with Apex. You can extract and process data in one step.

Supported relationships

The following supported relationships can be created within your DocGen Package with these relationship types.

Relationship type Supported relationship Example
Lookup relationships

Can only be created from the first parent object in Relationships from Starting Objects or Relationships from Other Objects.

Opportunity is the parent starting object and the Account is the lookup relationship.

Child relationships

Can be created from:

  • A valid lookup relationship.
  • A Relationship from a Parent/Starting Object that is three levels from the parent

    • Relationships from Other Objects that are up to two levels down.

     

 

The Parent Object, which is also the Starting Object in this DocGen Package is Account, and the child relationships are Opportunity, Quote, and Quote Line Item.

Relationship Limits

30,000 Row Limit

  • There is a maximum of 30,000 rows of data allowed from all relationships combined.

Repeat By Limit

Each Repeat By option has their own limits. You can use repeat by options to build replication tables, groups of tables, or duplicating document sections. See the table below for details on Repeat By options and their supported template types, and relationships.

Repeat By options and descriptions Supported template type(s) Supported relationships
Section: Allows the data from the Relationship to be represented as sections within Microsoft Word. Word All except Other Objects
Table: Allows the data from the Relationship to be presented in tables. Each table has unique data. Word, PowerPoint (Slide Replication) All except Other Objects
Row: Allows the data from the Relationship to be presented in rows that have unique data in each row. Word, PowerPoint, PDF/Excel All except Other Objects
Group: Duplicates tables that are grouped by field type. Word, PowerPoint

All except SOQL Query and Other Objects

Starting Objects (only from parent relationships)

Hierarchy: Creates slides with a levels of relationships based on field type. Word, PowerPoint

All except SOQL Query and Other Objects

Supported Repeat By combinations

  • Table + Row (Slide Replication + Row in PowerPoint)
  • Section + Table + Row
  • Section + Row
  • Section + Table

Common relationship fields

Many relationships use the same fields (for example, Alias) when creating or managing relationships. The table below shows common fields shared between relationship types:

Section Field

Description

Information Alias

This field helps you differentiate filtered relationships from one another. Also, a new tag is created using the name you enter for the Alias field.

Alias Requirements:

  • Can only contain underscores (_) and alphanumeric characters (a - z, A - Z, 0 - 9)
  • Must be unique and not match the names of Salesforce Custom or Standard Objects (for example, lead, account, opportunity), or stripped Custom Object API names with namespace and suffix removed, including those within installed packages
  • Here are a list of words that can't be used for an alias:
    • Opportunity_LineItem

    • Quote_LineItem

    • Product
    • Org
    • OCR
    • ACR
    • CCR
    • CACR
  • Important: This applies to all current and future objects that you create.

    Example: Namespace__ObjectName__c would be stripped to ObjectName; therefore, you cannot have an alias of ObjectName.

  • Must begin with a letter
  • Must not start or end with an underscore and not contain consecutive underscores
  Repeat By

Determines how records within your related object will be merged into your document.

  • If Row is selected, a row will be created within a table for each record in your related object.
  • If Table is selected, a new table will be created for each related record in your related object.
  Delete Table, Chart, Section (if no records) The entire table/chart/section will be deleted if your related object contains no recordsSalesforce says, "A single instance of a Salesforce object. For example, “John Jones” might be the name of a contact record.".
Order By Criteria Unnamed Drop-down box

Specifies the field which determines the order in which your related object records will be inserted into the document. Based on the field selection, the records are sorted alphabetically within your related object. If None is selected, records are sorted by Name.

  Add field A new field is added to order fields by.

 

Ascending

Specifies the field should use ascending order.

 

  Descending Specifies the field should use descending order.
Filter By Criteria Numbered filter rows Enter field criteria. You must enter a field on your related object to filter by, a criteria and a value. You can have one to several filters on a relationship.
  Field The field that is getting filtered.

 

Operator

Determines how the field and value will be filtered.

 

 

Value

The keyword used by the operator to filter the data.

 

 

DELETE

Removes a filter line.

 

 

Add Filter A new filter row will be added.

 

 

Advanced Filter

Refines filter by using Boolean logic expressions in Advanced Filter Conditions. For more information, see Add Filter Logic in the Salesforce documentation.

 

Filter a relationship

You can use filters in a relationship so tags that are generated from that relationship will only show the filtered information.

For example, say you want to connect a custom objectSalesforce says, "Custom records that allow you to store information unique to your organization." to a standard objectObjects that are in a Salesforce org by default e.g. Account, Contact, Lead, Opportunity. using a Starting Object relationship, but you only want certain details from your custom object to appear in the output.

Some filters are only available for some relationships, while others have limitations.

Relationship Description
Starting Object This is an optional field. Filtering is only available for child relationships.
Other Objects This is an optional field. Filtering is only available for child relationships.
Stand Alone Data This is an optional field. Filtering is only available for child relationships.
Apex Data This is an optional field.
SOQL Query Filtering for SOQL Query relationships is done in the SOQL query.