Relationships
What are relationships?
Relationships allow you to retrieve data that you can use to create documents. When you create a DocGen Package with no relationships, you only have access to the data available from the starting object and any reports you may have added.
What can you do with relationships?
The tags that appear in the field tagger represent the data that is available for documents in your DocGen Package. Use relationships for the following:
-
Alias data so that you can identify tags or isolate data from a particular relationship in the field tagger.
-
Filter data so that tags only produce certain data in output documents.
-
Replicate data with copy types to build tables, groups of tables, or duplicate entire sections of your document, with unique data in each section.
Types of relationships
There are five different types of relationships.
Relationship type |
When to use it? |
---|---|
Salesforce Object |
Use Salesforce Object relationship first, unless one of the other relationships seems better suited for your needs. Salesforce Object relationship (also known as the basic relationship) is almost always the best option. |
Top Level |
Use Top Level relationships if you're starting out with a limited amount of data (for example, your starting object is a custom object). |
Unrelated Data |
Use an Unrelated Data relationship if you don't know up front which object contains the data you want to add to your documents. |
Use SOQL Query relationships if you're comfortable working with SOQL or have a super complex relationship that would otherwise be difficult to express with one of the other relationships. |
|
Apex Data |
Use Apex Data relationships if you're comfortable working with Apex. You can extract and process data in one fell swoop, similar to using Excel as middleware to process data before presenting it in output documents. |
Combine relationships and relationship types
Add and combine relationships and relationship types as necessary to get the data you want into the DocGen Package.
Tip: A good rule of thumb is to add as few relationships as necessary to get the data you need for your output documents.
Relationship limits
-
30,000 row limit: You can gather a maximum of 30,000 rows of data from all relationships combined.
-
Copy type limits: Copy types have their own unique limits. and those limits are spelled out in this topic, Build tables, group tables, or duplicate document sections. Use Copy types to build replication assets (tables, groups of tables, or duplicating document sections).
Common relationships fields
Many relationships use the same fields for creating relationships. This reference provides description of common fields shared between relationship types.
Section | Field | Description |
---|---|---|
Information |
Relationship Alias |
Type an Alias name. This field differentiates one filtered relationship from the another. It creates new tags specific to one filtered relationship. For more information on aliasing, see How to alias a relationship. |
|
Copy Type |
This 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. For more information, see Build tables, group tables, or duplicate document sections. |
|
Delete Table (if no records) |
Specifies the entire table will be deleted if your related object contains no records. |
Order Relationship by |
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 selected here, the app alphabetically sorts the order of your records within your related object . If you leave None selected, records are sorted by Name. |
|
Add field |
Specifies a new field should be added to order fields by. Limit 5. |
|
Descending |
Specifies the filed should use descending order. |
Filter Criteria |
Numbered filter rows |
Enter filter criteria. You must select a field on your related object to filter by, a criteria and a value. You can have one or several filters on a relationship. For more information on filtering, see How to filter a relationship. Date Literal support
To filter by date, use any of the following supported Date Literals.
Note: Nintex Drawloop DocGen® for Salesforce date literals use the same conventions as Salesforce date literals, although our app supports only a subset of the date literals available in Salesforce. For more information, see Date Formats and Date Literals in the Salesforce documentation. |
|
Add filter |
Specifies that a new filter row should be added. |
|
Field Tagger |
Opens the Field Tagger. For more information, see Field Tagger. |
|
Advanced Filter Conditions |
Use Boolean logic expressions in Advanced Filter Conditions to refine your filter. For more information, see Add Filter Logic in the Salesforce documentation. |
|
How many records |
Specifies the number of records to include. Leave blank to include all records. If the Copy Type is Hierarchy , the value in this field will limit the number of levels. |