In This Article:

  1. Apex Parameter Table

The following parameters can be appended to an Apex button (most notably, the S-Docs button) or to the end of an S-Doc creation call.

Note: These parameters are case-sensitive.

Parameter

Values

 

Function

prepemail= 1 to enable, 0 to disable (disabled by default). This will create but not automatically send an email.
sendemail= 1 to enable, 0 to disable (disabled by default). This will create and automatically send an email.
autoSSign= 1 to enable, 0 to disable (disabled by default). This will generate an S-Sign e-signature request and navigate the user to the Email page. For sign in-person use cases, the signing experience will open after generation.
doclist= Comma delimited list of S-Docs template names or IDs. (For example, doclist='Template1,Template2') This will automatically generate the documents specified in the parameter and route the user to the "Generated Documents" screen. It's also used for specifying which documents to generate when using S-Docs with the Salesforce Process Builder.
oneclick= True to enable, false to disable (enabled by default). This parameter modulates the doclist parameter; if it is set to "false," the doclist parameter will not automatically generate documents, but will simply route the user to the template selection page with the documents pre-selected.
aid= Comma delimited list of IDs for attachments on a record’s “Attachments” related list. For attaching attachments to your email.
fid= Comma delimited list of IDs for files from your "Files" tab. For attaching files to your email.
did= Comma delimited list of IDs for documents from your “Documents” tab. For attaching documents to your email.
autoopen= To open in the same browser tab: 1 to enable, 0 to disable (disabled by default).

Example: autoopen='1'

To open in a new browser tab: newtab

Example: autoopen='newtab'

Note that your popup blocker must be disabled for Salesforce in order for the newtab value to function properly.

 

This will make the document automatically open after being generated. Note that this shouldn’t be used on calls to create S-Docs, since users aren’t explicitly creating these documents in the way that they do with an Apex button.
useExistingNoContactRecord= True to enable, False to disable (disabled by default). By default, when an email is sent by S-Docs to an address that isn’t listed under a contact in your org, S-Docs creates and immediately deletes a contact record called “No Contact Record.” If you have validation rules in place that require multiple contact fields be completed, you can create your own No Contact Record and use this parameter. The record should have a last name of No Contact Record (first name not required) and an email address of this.email@is.invalid
attParentId2= A single Salesforce record ID (for example, attParentId2='a0C4N00003LcItc'). When you click Attach or Remove Files on the S-Docs email page, the menu will show all attachments and files of the base record used to generate the documents by default. When you use this parameter and specify another record ID, this page will also show all of the attachments and files of that additional record. Note that additional attachments are not supported for S-Sign email templates at this time.
attParentId2FilterAtt= SOQL Query filter for the list of attachments related to the attparentID2 record. Allows you to set filter criteria for which attachments are displayed from the record  specified by the attParentId2 parameter.
attParentId2FilterFile= SOQL Query filter list of files related to the attparentID2 record. Allows you to set filter criteria for which files are displayed from the record specified by the attParentId2 parameter.
additionalFields= Comma-delimited list of Salesforce field API names. For example, AdditionalFields='Industry__c'

You can also add preset values to filter these additional fields. For example, AdditionalFields='Industry__c:Textiles'

Allows you to display fields from the template detail page as custom columns on the "Select template(s)" page that is displayed after a user clicks the S-Docs button. This parameter also allows you to set custom filters for those columns.

For example, say you have two custom fields on your template, Region__c and Industry__c, and you've added AdditionalFields='Region__c,Industry__c' to your S-Docs button. These fields will then show up as columns on the template list view displayed on the "Select template(s)" page. Additionally, search fields will show up for these fields on the "Select template(s)" page so the user can apply a filter/search on one or both of these fields in order to see only the templates that match the supplied criteria.

AFIncludeNulls= True to enable, False to disable. This parameter is used in conjunction with the additionalFields= parameter. When set to true, this parameter will include fields with null values.
AFPicklist= True by default, false to hide the picklist (essentially, choosing false will enable the intended functionality of this parameter). This parameter will hide the picklist that is shown on the template selection page when using the AdditionalFields= parameter, making it so that users cannot edit filters that have been applied.
generatedFields= Comma delimited list of Salesforce field API names.

Example: generatedFields='Base_Object_Type__c,Name' would show the related list object and the template name in columns on the generated document page table.

Allows you to display fields from your template(s) as custom columns on the "Generated Documents" page that is displayed after a user generates their documents (after users select their template(s) and click "Next Step").

This parameter is similar to the additionalFields parameter, however fields specified with that parameter appear on the select templates page, while fields specified with this parameter appear on the generated documents page.

autoBox= 1 to enable, 0 to disable (disabled by default). This parameter will automatically upload generated documents to Box if you have enabled S-Docs Box Integration.
UIlanguage= Language that is supported by a downloaded translation template (see article: Translate the S-Docs UI). This will translate the user interface of S-Docs (see article: Translate the S-Docs UI).
ssignParams= Language that is supported by a downloaded translation template (see article: Translate the S-Sign UI). This will translate the user interface of S-Sign (see article: Translate the S-Sign UI).
GenAtEmail= True to enable, False to disable (disabled by default). This parameter adds a button to the S-Docs email page that allows you to generate & attach a new document to your current email.
language= Salesforce Language ID. This parameter will allow merge fields and field labels to be translated (provided that the translate keyword is used in the merge fields in the template). (See article: Translate Merge Fields and Field Labels)
replyToMostRecentEmail= True to enable, False to disable. This will include the most recent email’s text in the body email on the S-Docs email page.
useAttNameForDocName= True to enable, False to disable. Will display the attachment name instead of the document name on the generated documents page.
quickPickJunctions= Contact Quick Pick picklist.

Syntax (single junction): quickPickJunctions='Contact_Junction_Obj_API_Name,
Base_Obj_Lookup_API_Name,
Contact_Lookup_API_Name

Syntax (multiple junctions):
quickPickJunctions=Contact_Junction_1__c,
Opportunity_1__c,Contact_1__c;
Contact_Junction_2__c,
Opportunity_2__c,
Contact_2__c;
Contact_Junction_3__c,
Opportunity_3__c,
Contact_3__c

This is used to notify the S-Docs email page of a junction object between Contact and the base object that a document was generated from. It adds the junction object’s contacts to the email contact quickpick list.
showHeader= True to enable, False to disable. This will hide the header on the S-Docs template selection and document creation pages.
sidebar= True to enable, False to disable. This will hide the sidebar on the S-Docs template selection and document creation pages.
customRedirect= Custom VisualForce page URL. This will redirect users to a custom VisualForce page in your org after their documents finish generating. The IDs for the documents that generated with this parameter will be visible in the URL after "sdocsIds="
rpRichText= True by default, false to disable rich text fields. For templates that have a very large number of runtime prompts, this will replace all rich text editors for runtime prompts with regular text areas to decrease loading times.

Note that this parameter needs to be added to the URL for the S-Docs template editor button, and not the S-Docs button.

SDEditSameTab= True to enable, False to disable (false by default) If a template has the Allow Edit feature enabled, this will cause a pencil icon to appear next to the document once a user generates it (e.g. after clicking Next Step during the document generation process). By default, clicking this pencil will open the Allow Edit live editor in a new tab.

This parameter causes the Allow Edit live editor to open in the same tab as the "View Documents" page. This parameter also replaces the Close button in the Allow Edit live editor with a Return to Record button.

customSave= override, newbutton This will modify the Save button on the S-Docs Allow Edit live editor (which allows users to edit a document after it has been generated).

Override will replace the Save button with a button that saves the document and redirects the user to a specified URL.

Newbutton will retain the original Save button and add a new button that saves the edited document and redirects the user to a specified URL. 

Both of these need to be enabled in Custom Settings > SDocsSettings and added to the URL in specified SDEdit Custom URL.

editorWidth= String (number of pixels).

Example: editorWidth='500'

Adjusts the width of the rich text editor on the S-Docs email page. It is useful mainly if you’re using Salesforce on a phone or tablet.
color= Color hex number without the pound (#) symbol.

Example: color='FFFFFF'

This can be added to the SDEdit Custom URL (In Custom Settings > SDocs Settings) to change the button text color.
backgroundColor= Color hex number without the pound (#) symbol.

Example: color='FFFFFF'

This can be added to the SDEdit Custom URL (In Custom Settings > SDocs Settings) to change the button background color.