DocGen Package Form Steps

This feature is not yet supported in the Lightning Experience DocGen Designer.

Create a DocGen Package using form data

Create a DocGen Package exclusively from form data. DocGen Forms allow you generate documents from form fields. No data from your Salesforce objects will be merged into your documents with a form DocGen Package. Users generate documents from the DocGen Forms object, so you do not need to navigate to a Salesforce record or create a button to generate documents from DocGen Forms.

You can only create a DocGen Package based on DocGen Forms from the DocGen Package wizard.

To create a DocGen Package based on DocGen Forms:

  1. Create a template with tags.

    2. Form field tags should only contain the following characters:

    • A - Z (Upper case letters A thru Z)
    • a- z (Lower case letter a thru z)
    • 0 - 9 (Numerals 0 through 9)
    • _ (single underscores)

    When tagging your Microsoft Word or Microsoft PowerPoint documents with form fields, create unique range names and surround them with angle brackets, for example, <<Name>>, <<Age>>, <<Street>>, <<City>>. Since the range names do not match any ranges in the field tagger, they will be automatically detected when the DocGen Package Form is edited.

    When tagging your Microsoft Excel or PDF documents, create unique range names and then insert them into your documents. You must insert these ranges as you would field tags from a field tagger, for example, Principal (principal), Rate (rate), Period (period). Since the ranges for these form fields do not match ranges from the field tagger, they will be automatically detected by the app when Editing the Form on the DocGen Package.

  2. Open Nintex DocGen for Salesforce and then click DocGen Packages.
  3. Click New.
  4. Under Basics, for DocGen Package Starting Object, select Form.
  5. Enter the required information in these fields:

    • DocGen Package Name

    • Type

      • Note: Add Delivery Options as you would for a regular DocGen Package. The Relationships, Create/Edit Records, and Tag Documents tabs are irrelevant for Form DocGen Packages.

  6. On DocGen Package Templates, select or upload the template you created. For more information, see Manage templates in DocGen Packages.
  7. Click Save.
  8. From the Form Steps related list, click Edit Form.
    By selecting the Edit Form button, all of your form fields will be automatically detected from your DocGen Package files and pushed into the Form Editing Page.
  9. Create form steps, re-label form steps, move form fields, and edit form field properties.
    For more information on the fields on this screen, see Common DocGen Forms fields.
  10. Save your forms.

    11. Once you have finished editing your form, you can generate documents with form fields.

Section

Field

 Description
Header Save and Run Save and run the form
  View rules View conditional actions for the form
  Load New Fields Scan your DocGen Package files and auto-detect any additional Form Fields in your documents.
  Quick Save Save changes and continue to work on the form.
  Save Save and close the form.
  Cancel Close without saving.
Tab headers Edit Step Label Selecting the pencil icon allows you to change the label for your Form Step
  Ignored Fields Fields that will not be included in the form.
  Add Step

This button allows you to add additional Form Steps to your DocGen Package Form.

Note:  You cannot use Forms with Steps from the Lightning Experience. If you want to add steps to your form, you must generate documents from the Classic Experience.
Tab body Move To: This drop down will display a list of all of your Form Steps. If Form Fields are selected using the check boxes, then the selected Form Fields will be moved to whichever Form Step is selected in the drop down.
  Ignore Pushing this button will move all checked Form Fields to Ignore Fields.
  Add field Add a field to the form.
  Add title Add a title to the form.
  Add note Add a note to the form.
  Tag Form field tag
  Field label Form field label
  Type

Here is where you select which type of form field you want. Your options are:

  • Text - This will allow users to enter in a string of text. This will only allow 255 characters to be entered.

  • Memo - This will provide users with a text area (that will be expandable) in which they can enter text. This area can contain more text than the previous option.

  • Rich text - This will allow users to enter formatted content. For more information, see Rich text support for Nintex DocGen.

  • Drop Down - This will provide a dropdown of values for the user select. The dropdown will be dependent upon what is entered into the List Values field.

  • Radio - Provides the ability to list radios vertically. Radios are dependent on values entered into the List Values field.

  • Radio Inline - Provides the ability to list radios horizontally. Radios are dependent on values entered into the List Values field.

  • Checkbox - Provides the ability to list one or several checkboxes vertically. Checkboxes are dependent on values entered into the List Values field.

  • Checkbox Inline - Provides the ability to list one or several checkboxes horizontally. Checkboxes are dependent on values entered into the List Values field.

  • Date - Forces users to enter a value in date format. There will be a calendar tool that will allow them to choose a date.

  • View - Allows you to lock the value entered into the Default Value field.
  Default Value Allows you to auto-populate your Form Fields with information that is either static or dynamic that will pull from your related objects.
  Lookup Selecting this icon allows you to set a dynamic Default Value
  Help Text Entering text here will be viewable by the user from the DocGen Forms Page. Enter in a description on what information should be populated in the form field.
  List values

Select form field list values.

Each item must be on its own line. An item can contain a separate display and pass value by separating the values with a comma.
  Validation

A regular expression you wish to use to validate this field.
  Error messages Form field error messages

Generate documents from a DocGen Package based on DocGen Forms

Once you create a DocGen Package based on DocGen Forms, you are ready to generate documents with DocGen Forms.

To test the DocGen Package based on DocGen Forms:

  1. Open Nintex DocGen and click DocGen Forms.
    You can also click Run Form from the DocGen Package.

  2. Select a DocGen Package that contains the DocGen Forms.

  3. Click Run.
    The forms you added are displayed.

  4. Complete all the fields in the form and click Run to generate documents.

Add DocGen Forms to an existing DocGen Package

You can add a form to an existing DocGen Package. Form fields allow you to display a form to users as they generate documents where they can enter information. A form can consist of several steps with several different field types. The fields can be defaulted with either static text or Salesforce Object data. Information the user enters into the form fields can then be merged into your DocGen Package documents.

You can add DocGen Forms to a DocGen Package from the Form Steps related list on a DocGen Package.

To add a form to a DocGen Package:

  1. Create a template with tags. Tag names should not match anything in the field tagger.

    2. Form field tags should only contain the following characters:

    • A - Z (Upper case letters A thru Z)
    • a- z (Lower case letter a thru z)
    • 0 - 9 (Numerals 0 through 9)
    • _ (single underscores)

    When tagging your Microsoft Word or Microsoft PowerPoint documents with form fields, create unique range names and surround them with angle brackets, for example, <<TermsandCond>> and <<Reference>>. Since the range names do not match any ranges in the field tagger, they will be automatically detected when the DocGen Package Form is edited.

    When tagging your Microsoft Excel or PDF documents, create unique range names and then insert them into your documents. You must insert these ranges as you would field tags from a field tagger, for example, a range for Social Security Number (ssn), Marital Status (marital), Favorite Color (favcolor) and Another Description (otherdescr). Since the ranges for these form fields do not match ranges from the field tagger, they will be automatically detected by the app when editing the form on the DocGen Package.

  2. Open Nintex DocGen for Salesforce and click DocGen Forms.

  3. Open a DocGen Package to which you want to add DocGen Forms.

  4. Add the templates you created to the DocGen Package. For more information, see Manage templates in DocGen Packages.

  5. On the Form Steps related list, click Edit Form.

  6. By selecting the Edit Form button, all of your form fields will be automatically detected from your DocGen Package files and pushed into the Form Editing Page.
  7. Create form steps, re-label form steps, move form fields, and edit form field properties.
    For more information on the fields on this screen, see Common DocGen Forms fields.
  8. Save your forms.
    Once you have finished editing your form, you are now fully set up to generate documents with form fields.

Use a DocGen Package with DocGen Forms added

Once you add DocGen Forms to a DocGen Package, you can generate documents with form data.

To use the DocGen Forms capability:

  1. From the starting object of the DocGen Package with the DocGen Forms, select a record and generate documents.
    For example, if you added DocGen Forms to a DocGen Package based on the Accounts object, select an account record and generate documents.

  2. Select the DocGen Package with the DocGen Forms added.

  3. Complete the generate documents page (select a contact, the Delivery Option, and anything else required) and click Run.

    The app displays the forms you added.

  4. Complete the form (Click Next if there are multiple forms) and click Run.