Relationships from Starting Objects
Use Relationships from Starting Objects to display all the data from the starting object for your DocGen Package A customizable package that consists of your Salesforce data, documents, and delivery configurations for documents you want to generate.. You can use the field tagger A tool that displays tags for your template based on the object you're working with and easily inserts the field tags into your templates for your DocGen Package. to tag your templates with all the data available with that object. Creating relationships allow you to customize and add in data that is not included by default.
To get data from objects Salesforce says, "An object allows you to store information in your Salesforce organization." related to your starting object through a lookup relationship Salesforce says, "A relationship between two records so you can associate records with each other." or related list, you need a relationship Salesforce says, "A connection between two objects, used to create related lists in page layouts and detail levels in reports." to that object. All the data is pulled directly from Salesforce, so it's readily available to use.
You'll know you need to create a relationship from your starting object if the tags for the data you want is not appearing in the field tagger.
Create a relationship for your object from a new DocGen Package
- Navigate to the App Launcher by selecting the in the upper left corner, select Nintex DocGen.
- Select the DocGen Packages tab.
- Click New.
- Type in the DocGen Package details and select your Starting Object.
- Click Save.
Nintex DocGen will automatically add in the Starting Object and any child relationships it's associated with the object in the Relationships section. The starting object can't be edited unless a different object is selected.
- From the Relationships section, you can edit the Repeat By field to:
Repeat By Options
Section Copies a specific section in your document that has unique data. Table Copies tables. Each table has unique data. Row Copies rows that have unique data in each row. Group Duplicates tables that are grouped by field type. Hierarchy Creates slides with a hierarchy of relationships based on field type. The Default value is row.
Note: You also have the option of adding in an Order By of the field of your choice. This is dependent on the Starting Object selected.
- Click Save.
Create a relationship for your object from an existing DocGen Package
- Navigate to the App Launcher by selecting the in the upper left corner, select Nintex DocGen.
- Select the DocGen Packages tab.
- Select and open the DocGen Package you want to work with.
- In the Relationships section, select the drop-down arrow from the object and select Add Child + to add any additional Salesforce object relationships to the DocGen Package.
- In Related By, select an option:
- None: Always available and resets the user interface.
- Lookup from what you have: This option is only available if the object you selected includes a lookup. For more information, see Field Tagger.
- This field is optional. In the Alias field, type a short name or keyword that will differentiate a relationship to identify the tags from that relationship in the field tagger.
- From the Relationships section, you can edit the Repeat By field to:
Repeat By Options
Section Copies a specific section in your document that has unique data. Table Copies tables. Each table has unique data. Row Copies rows that have unique data in each row. Group Duplicates tables that are grouped by field type. Hierarchy Creates slides with a hierarchy of relationships based on field type. The Default value is row.
Note: You also have the option of adding in an Order By of the field of your choice. This is dependent on the Starting Object selected.
- Click Save.
- Navigate to the DocGen Packages tab in Nintex DocGen.
- Select and open the DocGen Package you want to work with.
- In the Relationships section, select the drop down arrow from the relationship and select Edit.
- Edit what you need to and click Save.
- Navigate to the DocGen Packages tab in Nintex DocGen.
-
Select a DocGen Package that contains a relationship for your object.
-
Click the Field Tagger button.
- In Main Object, select the object you chose for Relationship when you created the relationship for your object.
- Exit out of the Field Tagger.
Field | Description |
---|---|
Object | A database table that stores data specific to the organization in Salesforce. |
Child | An association between two objects that creates a relationship in Salesforce. |
Lookup | Creates a field that allows users to click a lookup icon and select another record from a pop-up window. |
Alias | A short name/keyword to help identify record ownership. |
Repeat By |
The field that allows you to identify how the data is to be replicated in your template. |
None |
Resets the user interface. |
Row | Outputs data by row. |
Table | Outputs data in a table. |
Group | Outputs data in a group. |
Hierarchy |
Outputs data in a hierarchy based on how you rank. |
Section |
Outputs data by section based on your section. |