Salesforce Object relationships

Salesforce Object relationships

Use a Salesforce Object relationship to make data available to your DocGen Package. How would you know that you need to add a Salesforce Object relationship? The simple answer is that the tags for the data you want don't appear in the field tagger.

Let's say you based your DocGen Package on the Account object. By default, the field tagger offers you all the data that's typically available from the Account object, including some additional data. But you might want data that the app hasn't included by default. Maybe you customized the Account object by adding the Events related list to  associate events with accounts. Now you want to include the event information in your documents. You can do this, but first you must create a relationship between the Account and Event objects. After you add the relationship, use the field tagger to make sure the tags for the new data appear.

Create a Salesforce Object relationship

You can add Salesforce Object relationships to a DocGen Package with the DocGen Package Wizard or the Relationships related list on the DocGen Package. The related list contains more options for relationships.

To add a Salesforce Object relationship from the DocGen Package Wizard

  1. From the Force.com app menu, select Nintex DocGen, and then click DocGen Packages.

    Tip: You can also select this from Lightning with the App Launcher.

  2. Click New. 

  3. From Basics, enter required information in these fields: 

    • DocGen Package Name

    • Type

    • DocGen Package Starting Object.

    For more information, see Create new DocGen Packages with the DocGen Package Wizard.

  4. Click the Relationships tab.

  5. In Related By (What you have), select the Salesforce Object or relationship you want to use as the starting point in the relationship you're trying to create.

    For example, if you based your DocGen Package on the Account object, then select Account here.

    Tip: You can use Related By (What you have) to build multi-level relationships for generating tables or to work around relationship constraints. For more information, see Build tables, group tables, or duplicate document sections or Top Level relationships.

  6. In Relationship (What you want), select the object you want to include data from.

    For example, if you wanted to include data from Event object, you would select Event here.

  7. In Related By, select an option.

    Option

    Description

    - - None - - Always available. Resets the user interface.
    Lookup from what you have This is a child relationship. Only available if the object you selected in Relationship (What you want) includes a lookup. No other options are available with lookups (no filtering, aliasing, or creating tables with copy types).

    Name of field ID (Related List)

    This is a parent relationship. You can use this relationship to build tables, groups of tables, or duplicate entire sections of your document, with unique data in each section. You can also use a parent relationship to filter and alias data. For more information, see Relationships and Build tables, group tables, or duplicate document sections.

    The fields available for you to select in this field depend on the relationships available for the object you selected in Relationship (What you want).

  8. (Optional) In Copy Type, select a Copy Type.

    Note: Copy Type enables you to create tables and rows (and do other types of replication) with your data. For more information, see Build tables, group tables, or duplicate document sections.

  9. Configure any remaining fields for standard options. For more information, see Common relationship fields

  10. On DocGen Package Templates, select or upload a template and click Save.

To add a Salesforce Object relationship with the Relationships related list

  1. From the Force.com app menu, select Nintex DocGen, and then click DocGen Packages.

    Tip: You can also select this from Lightning with the App Launcher.

  2. Select a DocGen Package.

  3. From Relationships, click New Relationship.

    Tip: You can also edit an existing relationship.

  4. In Type, select Salesforce Object.

  5. In Related By (What you have), select the Salesforce Object or relationship you want to use as the starting point in the relationship you're trying to create.

    For example, if you based your DocGen Package on the Account object, then select Account here.

    Tip: You can use Related By (What you have) to build multi-level relationships for generating tables or to work around relationship constraints. For more information, see Build tables, group tables, or duplicate document sections or Top Level relationships.

  6. In Relationship (What you want), select the object you want to include data from.

    For example, if you wanted to include data from the Event object, you would select Event here.

  7. In Related By, select an option.

    Option

    Description

    - - None - - Always available. Resets the user interface.
    Lookup from what you have This is a child relationship. Only available if the object you selected in Relationship (What you want) includes a lookup. No other options are available with lookups (no filtering, aliasing, or creating tables with copy types). For more information, see How to add tags from a lookup relationship.

    Name of field ID (Related List)

    This is a parent relationship. You can use this relationship to build tables, groups of tables, or duplicate entire sections of your document, with unique data in each section. You can also use a parent relationship to filter and alias data. For more information, see Relationships and Build tables, group tables, or duplicate document sections.

    The fields available for you to select in this field depend on the relationships available for the object you selected in Relationship (What you want).

  8. (Optional) In Copy Type, select a Copy Type.

    Note: Copy Type enables you to create tables and rows (and do other types of replication) with your data. For more information, see Build tables, group tables, or duplicate document sections.

  9. Configure any remaining fields for standard options. For more information, see Common relationship fields

  10. Save the relationship.

Confirm the Salesforce Object relationship added the new data

Once you add the Salesforce Object relationship to your DocGen Package, confirm your DocGen Package has the new data by using the field tagger.

To test the Salesforce Object relationship

  1. From the Force.com app menu, select Nintex DocGen, and then click DocGen Packages.

    Tip: You can also select this from Lightning with the App Launcher.

  2. Select a DocGen Package that contains a Salesforce Object relationship.

  3. Open the field tagger and in Main Object, select the object you chose for Relationship (What you want) when you created the Salesforce Object relationship.

Related information

Field Tagger