Button Wizard field reference

The Button Wizard creates buttons and other elements (links and tabs) that you use to generate documents.

Nintex Drawloop DocGen® for Salesforce comes with built-in buttons for standard objects, but sometimes you need to create custom buttons. You might create a custom button to generate documents from a custom object or to customize what happens when the user clicks the button.

Button Wizard settings

Section Field Description
(none) Create Button

Opens a new browser window with the Salesforce setup page for creating an element (button, link or tab), specified in the wizard. The wizard supplies all the code required to create the element.

  Reset Options Resets the wizards options to default values.
Code Code

The code window shows you the code for your element. As you select options for your element, the code in the windows updates itself.

 

Default value: /apex/loop__looplus?&eid={!Opportunity.Id}

Basics

Button Name

This is the name of the button that DocGen Users will click. Button Name only appears if you have Type set to create a button element.

 

This is a required field. Default value: Generate Documents.

 

Link Name

This is the name of the link that DocGen Users will click. Link Name only appears if you have Type set to create a link element.

 

This is a required field. Default value: Generate Documents.

 

Tab Name

This is the name of the tab that DocGen Users will click. Tab Name only appears if you have Type set to create a tab element.

 

This is a required field. Default value: Generate Documents.

 

DocGen Package Starting Object

This is the object from which your button or link will be available. For example, if you wanted to run a DocGen Package from the Opportunity object, you would select Opportunity here.

Tabs work different from buttons and links. For tabs, all the DocGen Packages for the object you select here will appear on the tab. For example, if you were creating a tab and selected Opportunity here, all the DocGen Packages based on the Opportunity object would appear on that tab.

For custom objects, select Other.

This is a required field.

Example: eid={!Object.Id}

Where

Object = the name of a standard or custom object

 

Object Name

Select the name of the custom object to be used as the starting object.

This is a required field. Object Name only appears if you select Other as the DocGen Package Starting Object.

 

Type

Select the type of element to create.

Possible options: 

  • Single Record Button

    A button to generate a document for a single record.

  • Single Record Link

    A link to generate a document for a single record.

  • Mass DocGen Package via List View Button

    A button to generate documents for multiple records on a list.

  • Mass DocGen Package via Report Button

    A button to generate documents for multiple records based on a Salesforce report.

  • Mass DocGen Package via Report Tab

    A tab to generate documents for multiple records based on a Salesforce report.

Mass elements enable you to generate documents for multiple records. You need to enable your edition to generate documents this way. For more information, see Mass DocGen Packages and Purchase, upgrade, or manage edition options.

 

Return URL

The destination to send users after they generate documents.

Possible options:

  • Starting Object

    Returns the user to the object in DocGen Package Starting Object.

  • Any object associated with the Starting Object.

    A dynamically assembled list of all the objects associated with the starting object.

  • Other

    Opens a new box to the right of Return URL for a custom URL. Type the URL for the destination to return the user.

Example: retURL=/{!Object.Id}

Where

Object = the name of a standard or custom object

 

Account

Used to pass an account Id as a top level Id.

Example: accountId={!Object.Account.Id}

Where

Object = the name of the starting object

 

Case

Used to pass a case Id as a top level Id.

Example: caseId={!Objecdt.Case.Id}

Where

Object = the name of the starting object

 

Contact

Used to pass a contact Id as a top level Id.

Example: contactId={!Object.Contact.Id}

Where

Object = the name of the starting object

 

Contract

Used to pass a contract Id as a top level Id.

Example: contractId={!Object.Contract.Id}

Where

Object = the name of the starting object

 

Lead

Used to pass a lead Id as a top level Id.

Example: leadId={!Object.Lead.Id}

Where

Object = the name of the starting object

 

Opportunity

Used to pass an opportunity Id as a top level Id.

Example: opportunityId={!Object.Opportunity.Id}

Where

Object = the name of the starting object

Interface Options

Hide Header

Hides the breadcrumb and everything above it on the Visualforce page that appears after users click the button, link, or tab.

Example: header=false

 

Hide Sidebar

Hides the DocGen Package sidebar on the Visualforce page that appears after users click the button, link, or tab.

Example: sidebar=false

 

Hide Contact Selection

Hides contact selection on the Visualforce page that appears after users click the button, link, or tab.

Example: hidecontact=true

 

Hide DocGen Package Selection

Hides DocGen Package selection box on the Visualforce page that appears after users click the button, link, or tab.

Example: hideddp=true

 

DocGen Package List Height

Type a value. This is the maximum number of DocGen Packages to show at one time on the Visualforce page that appears after users click the button, link, or tab. For example, if this were set to the default value of 10, and there were 11 DocGen Packages, the user would have to scroll the DocGen Package list.

Default value: 10

Example: ddpheight=value

Where

value = the maximum number of DocGen Packages to display in the list

 

Tab Style Class

Select a value from the list. Overrides the image and style on the Visualforce page that appears after users click this element. Not available for buttons or links for these objects: Accounts, Cases, Contacts, Contracts, Leads, Opportunities, and Quotes.

Example: tabclass=value

Where

value = the value for the tab you selected from the list

Note: You typically use this option when your Starting Object is a custom object. View the source of a Visualforce page on the custom object and look for the body class that page uses to get this value.

 

DocGen Package Label

Type a value. Replaces all instances of DocGen Package with the value you type on the Visualforce page that appears after users click the button, link, or tab.

Example: ddplabel=value

Where

value = a string that replaces all instances of the string DocGen Package

 

In Service Cloud Console

Enables buttons and links for Service Cloud Console.

Not available for tab elements.

For more information, see Set up a Salesforce Console for Service.

Custom Options

Auto Run

Automatically runs the DocGen Package with the default selections.

Example: autorun=true

 

Attach Back

Selected if the DocGen Package has Allow Document Storage enabled on the Delivery Options related list.

Example: attach=true

 

Include Session Id

Specifies that the Session Id should be added to the button code, which is only necessary for using reports with DocGen Packages.

 

Example: sessionId={$Api.Session_ID}

Tip: If the button you're creating is for Salesforce Lighting, don't use this option. The sessionId parameter can cause problems in Lightning.

 

Attachment Ids

Type a value or a list of values separated by commas. Selects specified attachments. Use JavaScript or Apex to determine IDs. Only available for single record buttons or links.

Examples:

attachIds=value,value

attachids=all

Where

value = the Id of an attachment

all= keyword that specifies all attachments should be included

 

Parent Ids

Type a value or a list of values separated by commas. Attachments from the specified records Ids are made available to users to select. Use JavaScript or Apex to determine IDs. Only available for single record buttons or links.

Examples:

parentIds=value,value

Where

value = the Id of an attachment from an additional record

 

Filter

Select a value to filter the DocGen Package list on the Visualforce page that appears after users click the button, link, or tab. You select one of the standard fields to filter on from the drop-down list, or you can select Other and an editable box appears for you to type a string. You can filter against the string entered here with a string entered on the DocGen Package Detail page, under Options, in Filter.

Filter works with Filter Type to specify filter behavior.

For an example of how to use a filter with a button, see Button Parameters.

Example: filter={!Object.Value}

Where

Object = Starting Object for this element

Value = Selected Filter

 

Filter Type

Select a value from the list. Modifies the application of Filter.

  • Contains

  • Does not contain

  • Does not equal

  • Ends with

  • Equals

  • Starts with

Equals is the default filter type.

Example: filtertype=value

Where

value= one of the Filter Type options

 

DocGen Package Ids

Type a value or a list of values separated by commas. Limits DocGen Packages on the Visualforce page that appears after users click the button, link, or tab.

Example: ddpIds=value,value

Where

value = the Id of a DocGen Package

Tip: DocGen Package Ids works best when you are not migrating DocGen Packages between organizations.

 

Delivery Option Id

Specifies a Delivery Option. Works best if used with a Filter or DocGen Package Ids.

Example: deploy=value

Where

value = a deployment Id or string that identifies the Delivery Option.

Tip: DocGen Package Ids works best when you are not migrating DocGen Packages between organizations.

 

Included Optional Docs

Type All, a value, or a list of values separated by commas (all or doc1,docZ). Used to specify or select all optional sections of a specific DocGen Package.

Examples:

included=value

included=all

Where

value= a specific document to include with the DocGen Package

all= the string all specifies all documents should be included with the DocGen Package

Related information

Access tools to create buttons

Add a button that generates documents in Classic Experience

Add a button that generates documents from multiple records in Classic Experience

Create new names for default buttons