Documentation

Introduction

This document will teach you how to configure S-Docs and generate your first documents with the Salesforce mobile app. Once you set up S-Docs for the Salesforce mobile app, you will be able to access the full features & functionality of S-Docs just as you can on a desktop. However, it may be beneficial for mobile clients to streamline document generation on the go. If your users typically create a few documents in the field, such as quotes or service orders, you may want to consider using the S-Docs automation features to simplify the process. This would remove the need to place an S-Docs button on the Salesforce mobile app and reduce the number of taps and potential errors or omissions.

For example, you can add a picklist on your mobile page layout with the following values: Email Quote, Email Service Order. When the user selects that value and saves the Salesforce record, an S-Doc is automatically generated and emailed from the Salesforce cloud. The user does not need to do anything else. This process can be configured without writing any code by using the Salesforce Process Builder. See the documentation here.

If you would like to leverage the full features and functionality of S-Docs on the Salesforce mobile app, it is described in this document.

Preview: Generating Documents on the Salesforce Mobile App

Before we see to configure S-Docs for use with the Salesforce mobile app, we will first see the feature in action.

1. Select the object you created the button for.

2. Select any record from this object. At the bottom of that record’s page, tap Show More.

3. Scroll down and tap S-Docs Mobile.

4. Use S-Docs to generate documents just as you would on a desktop. It’s that simple!

We will now discuss how to set up S-Docs for use with a particular object in the Salesforce mobile app.

Step 1: Create the S-Docs Mobile button

1. Create a new S-Docs Mobile button for a particular object. For standard objects, please follow the instructions in part (a). For custom objects, please follow the instructions in part (b).

a) Creating the Button For A Standard Object

If you are creating this button for a standard object, navigate to the Setup menu, type the name of the object into the Quick Find / Search bar, and click Buttons, Links, and Actions from the options that drop down under your object name.

Then, click New Button or Link.

This concludes part (a).

b) Creating the Button For A Custom Object

If you are creating this button for a custom object, navigate to the Setup menu, type "Objects" into the Quick Find / Search bar, then click Objects from the options that drop down under Create.

Then, click the name of your object (not the Edit button).

After you click the name of your custom object, scroll down to “Buttons, Links, and Actions” and click New Button or Link.

This concludes part (b).

2. On the “New Button or Link” page, fill in the fields as follows:

Label: S-Docs Mobile
Name: S_Docs_Mobile
Display Type: Detail Page Button
Behavior: Display in existing window without sidebar or header
Content Source: URL

Leave “Select Field Type” as the name of your object, and paste the following in the Custom Button or Link Editor:

[code lang="html"]{!URLFOR(
'/apex/SDOC__SDCreate1?id='
+ ChangeToYourObjApiName.Id
+ '&Object=ChangeToYourObjApiName'
+ '&lightningNav=true'
)}[/code]

If you are making the button for a standard object, the API Name is the same as the object name for all objects (e.g. the API name for an opportunity is Opportunity) except for products; for products, the API name is Product2.

If you are making the button for a custom object, you can find the API name on the same page you found the “Buttons, Links, and Actions” table on in 1b.

Once you finish pasting and editing the above code, click Save.

Step 2: Add the S-Docs Mobile Button to the Page Layout

1. Navigate to the Page Layouts for your object. For standard objects, please follow the instructions in part (a). For custom objects, please follow the instructions in part (b).

a) Adding the Button to a Standard Object's Page Layout

If you are adding the button to the Page Layout for a standard object, navigate to the Setup menu, type the name of your object into the Quick Find / Search bar, then click Page Layouts from the options that drop down under your object.

Click Edit next to “YourObjectName Layout.” For Accounts and Opportunities, there is a layout called “ObjectName Layout SDoc.” Do not edit this layout; rather, edit the layout called “ObjectName Layout.” In our Opportunity example, we are editing “Opportunity Layout.”

This concludes part (a).

b) Adding the Button to a Custom Object's Page Layout

If you are adding the button to the Page Layout for a custom object, navigate again to the Setup menu, type "Objects" into the Quick Find / Search bar, then click Objects.

Then, click the name of your object (not the Edit button).

After you click the name of your custom object, scroll down to “Page Layouts” and click Edit next to “YourObjectName Layout.”

This concludes part (b).

2. Scroll down to Salesforce Mobile & Lightning Experience Actions and click override the predefined actions. Then, click Mobile & Lightning Actions in the toolbar at the top of your screen.

Now, get rid of the standard S-Docs button by clicking it and dragging it anywhere within the toolbar.

After removing the standard S-Docs button, click and drag the S-Docs Mobile button into the "Salesforce Mobile and Lightning Experience Actions" group.

The resulting page should appear as follows:

Click Save to finalize your changes. S-Docs is now enabled for use with this object in the Salesforce mobile app!

Introduction

This guide discusses how to configure and use S-Docs in Salesforce Lightning Experience and how to edit a template in Lightning. You can also view the S-Docs Quick Install and Configuration Guide for Salesforce Lightning Experience for a comprehensive overview of installing and configuring S-Docs in Salesforce Lightning Experience.

Create the S-Docs Button and Add it to an Object's Page Layout in Lightning

If you have not already created an S-Docs button and added it to your page layout, you will need to add a custom button (Note that the S-Docs button comes prepackaged for many standard objects, such as Opportunities, Contacts, and Accounts; however, you still need to add the button to your page layout for these standard objects). To create a new button, you'll need to go to Setup > Object Manager > ObjectNameHere > Buttons, Links & Actions.

Click on New Button or Link and fill in the fields as in the following screenshot. You'll need to modify the button link per your object's API name. In this case, our object is a Product (API name Product2), so we used:

Add The S-Docs Button to your Object's Page Layout

Then, you'll have to add your new button to your page layout. Staying within the Object Manager for your object, click Page Layouts on the sidebar, and then click Edit.

Select the button from the Mobile & Lightning Actions box in the toolbar and add it to the Salesforce Mobile and Lightning Experience Actions box in the page layout.

Click Save and you're all set! You can now generate S-Docs in Lightning.

Using S-Docs in Salesforce Lightning - Generating Documents

To generate an S-Doc for a record, go to that record’s page and click the S-Docs button:

Then, select the templates you would like to use. Click Next Step to generate documents derived from the templates you selected:

Once you have generated your documents, you will see the “View Document(s)” page.

Clicking the "View" icons will bring up your documents in a separate tab:

Let’s return to the “View Document(s)” page. If “Allow Edit” is enabled for a particular template, you can click the pencil icon corresponding to that document to edit it after it’s been generated:

Emailing S-Docs

After you make your edits, you can click Preview to preview the final document, Save to save and return to the “View Document(s)” page, and Close to discard your changes and return to the “View Document(s)” page.

On the “View Document(s)” page, you can click Email Selected Docs to email your documents. Your documents will be included as attachments on an email. Here, you can edit the email fields as desired, scroll down to edit the body of the email, and click Send to send your email or Cancel to return to your record’s page.

Once you return to your record’s page, you will notice that the S-Docs you generated now appear in the S-Docs related list. You can click View All for a more in-depth look at your S-Docs’ details.

On the following page, you can click the document icon in the “View” column, the mail icon in the “Email” column, or the pencil icon in the “Edit” column to respectively view, email, or edit the corresponding document.

Now, going back to the record we generated S-Docs for, if we scroll down to the bottom of the page, we will see that the email we sent was recorded in the “Past Activity” section. Additionally, the Invoice template was saved in the Notes & Attachments section, but not the Opportunity Summary. This is because “Auto-Create Attachment” is enabled for the Invoice template but not the Opportunity Summary.

(If you’re an end-user of S-Docs who is just generating documents and not editing templates, you can ignore the following note).

Additionally, note that if the Auto-Create Salesforce Attachment and link to record box (found under the "Document Options" tab of the template editor) is not checked on a template, the documents created with that template in the S-Docs related list will be regenerated each time they are viewed, emailed, or edited. For example, if this box was not checked for an account summary template, and you opened an account summary document from 6 months ago, the document would be regenerated and the current account info would be displayed, rather than the account info from 6 months ago.

Editing S-Docs Templates in Salesforce Lightning

Editing templates in Lightning works just the same as in Classic. The only difference is getting there! To get there, select the S-Docs app from the app launcher.

Then, click the “S-Docs Templates” tab. From here, you can select any template you’d like to edit by clicking on its name.

Once you select a template, you can edit its fields or head over to the template editor to edit the contents of the template itself.

And there it is! Editing your template in Lightning works exactly the same as editing your template in Classic. If you wish to learn more about editing S-Docs templates, please see our overview of the template editor.

Introduction

S-Docs can be used in Salesforce communities too! In this guide, we will be setting up this functionality for a particular Salesforce object (you will need to follow the steps in this guide for each object you are enabling S-Docs with communities for). To do so, all we have to do is create a button that will show up for your community users and add it to an object’s page layout.

This button is not unique to communities; it will also exist in our production org and operate exactly the same as an ordinary S-Docs button. This means if we already have an S-Docs button, we will be replacing it with a new button that can be used by community users as well as users in our production org.

Step 1: Create the S-Docs for Communities Button

In this step, we will be creating a button that will enable the use of S-Docs with Salesforce communities for a particular object. In this example, we will be creating the button for an opportunity.

1. You will first need to navigate to the “Buttons, Links, and Actions” page for the Salesforce object you would like to create a communities button for.

a.) Creating the button for a custom object

Navigate to Setup > Build > Create > Objects.

Find the name of the custom object you would like to create the button for and click the name of this object (do not click the Edit button). In this example, we will be creating the button for the Check object, a custom object representing the data for a standard business check.

Next, a page will display for your custom object.

The API Name is often just the “Object Name” appended with __c (note the two underscores), but sometimes this is not the case, so please take note of that here. In the case of our custom Check object, we will note that our API Name is Check__c.

On the page for your custom object, scroll down to “Buttons, Links, and Actions” and click New Button or Link.

This concludes part (a).

b.) Creating the button for a standard object

Navigate to Setup > Build > Customize > YourObjectNameHere > Buttons, Links and Actions. In this example, we will be finding the “Buttons, Links, and Actions” page for an Opportunity.

Once you’re on the “Buttons, Links, and Actions” page for your standard object, click New Button or Link.

This concludes part (b).

2. We will now complete the “New Button or Link” page. Here is how the finished page might appear:

Here’s what to fill in:

Label: Create Documents (S-Docs)
Name: Create_Documents_S_Docs
Display Type: Detail Page Button
Behavior: Display in existing window without sidebar or header
Content Source: URL

Finally, paste the following code into the “Custom button or link editor.”
[code lang="html"]{!URLFOR($Site.BaseCustomUrl+'/'+
SUBSTITUTE($Site.Prefix, '/', '') +
IF ( OR(ISBLANK($Site.Prefix),$Site.Prefix='') ,
'apex/SDOC__SDCreate1?id='+ChangeToYourObjAPIName.Id+'&Object=ChangeToYourObjAPIName&site='+IF(ISBLANK($Site.Prefix),'DEFAULT',$Site.Prefix),
'/apex/SDOC__SDCreate1?id='+ChangeToYourObjAPIName.Id+'&Object=ChangeToYourObjAPIName&site='+$Site.Prefix))}[/code]
Again, please make sure that both appearances of “ChangeToYourObjAPIName” have been changed to your object’s API name. Click Save to finish the button.

Step 2: Add the S-Docs for Communities Button to the Page Layout

Now, all we have to do is add the button we just created to our object’s page layout.

1. You will first need to navigate to the “Page Layout” page for the Salesforce object you would like to add the button to.

a.) Adding the button to a custom object’s page layout

Navigate to Setup > Build > Create > Objects.

Find the name of your custom object and click the name of this object (do not click the Edit button). In this example, we will be adding the button to a Check’s page layout.

On the page for your custom object, scroll down to “Page Layouts” and click Edit next to “YourObjectName Layout.”

This concludes part (a).

b.) Adding the button for a standard object.

Navigate to Setup > Build > Customize > YourObjectNameHere > Page Layouts. In this example, we will be finding the “Page Layouts” page for an Opportunity.

Now click Edit next to “YourObjectName Layout.” (There may be other layouts, such as “YourObjectName Layout SDoc”. Do not edit these; only edit “YourObjectName Layout.”)

This concludes part (b).

2. Now we can add the button to the page layout. Drag the button you created in Step 1 into the “Custom Buttons” box. If there is already an S-Docs page button here, you may remove it from the “Custom Buttons” box by dragging it into the toolbar you pulled your Create Documents (S-Docs) button from. Your new button works the same as the old S-Docs button, except now it can be used by communities in addition to users within your production org.

Here’s how the finished page will appear.

Click Save and you’re all done! You should now have an S-Docs button on your object’s page that can be used by users in your communities, as well as users in your production org.

Introduction

S-Docs works great with the custom objects and even the Force.com platform edition, which is entirely comprised of custom objects. Your documents can span many relationships to include data from formula fields, rich text, parent records, child, grandchild and related objects--all within the same document.

Since every organization creates different custom objects to meet their unique requirements, you need to configure S-Docs to recognize which custom objects you want to leverage with S-Docs.

To learn how to configure S-Docs with custom objects in Salesforce Classic, you can watch the following tutorial video, which will walk you through the process. You can also refer to the written instructions below the video, which provide a detailed, step-by-step guide to configuring S-Docs with custom objects. Timestamps from the video are provided in the table of contents. To view the same guide for Salesforce Lightning Experience, click here.

For the purposes of this guide, we assume your custom object is named CustomObj and has an API name of CustomObj__c. (Note: the API name has two underscores.) Whenever you see "CustomObj" in this document, you can replace it with the name of your custom object. S-Docs can also integrate with other AppExchange apps. (Note: there are a few setup differences.) This document will walk you through the step-by-step configuration process. It is intended for Salesforce.com administrators who are familiar with standard configuration tasks.

Sample templates can be found here.

Tutorial Video

Step 1: Add a lookup field to allow relationship linking [00:56]

This step allows you to associate the S-Doc with the Custom object, so that users can see a related list of all S-Docs created on your Custom Objects page layout.

1. Navigate to Setup ➤ Build ➤ Create ➤ Objects.
2. Select SDOC_Relationship. Do not select Edit.
3. Under Custom Fields and Relationships, click the New button.
4. Follow the New Custom Field steps:

Step 1 of 6 - Pick Lookup Relationship. Click Next.
Step 2 of 6 - Select your Custom Object (e.g. CustomObj__c) from picklist values, then click Next.
Step 3 of 6* - Field label and field name should be your custom object name without the “__c.”  In our example it would be "CustomObj." Click Next.
Step 4 of 6 - Checkbox should be visible for all users. Click Next.
Step 5 of 6 - Checkbox should add the field for the layout.
Step 6 of 6 - Accept default. Click Save.

Step 2: Create a button to place it on your Custom Object page Layout [02:17]

Just like using S-Docs with other objects, you need to place an S-Docs button on the record detail page layout. Users click the button to initiate creating a document from the record detail page.

Create the S-Docs button.

1. Navigate to Setup ➤ Build ➤ Create ➤ Objects.
   
2. From the list of custom objects, click on your Custom Object link. Do not click on the Edit link.
3. From the custom object definition page, scroll down to the “Buttons, Links, and Actions” related list, and click  New Button or Link.
4. Button Label: Choose a label (e.g. "S-Docs")
5. Display Type: Detail Page Button
6. Behavior: Display in existing window without sidebar or header
7. Content Source: URL
8. Use the following URL (note that double underscores are used in three places):
   {!URLFOR('/apex/SDOC__SDCreate1', null,[id=CustomObj__c.Id, Object='CustomObj__c'])}
    

   Note: If you are using S-Docs with an object within another AppExchange managed package, your button syntax should include the entire object API name that includes the domain (e.g. package__CustomObj__c). Note that double underscores are used throughout. Your button syntax should therefore look similar to the following:
   {!URLFOR('/apex/SDOC__SDCreate1', null,[id=Package__CustomObj__c.Id, Object='Package__CustomObj__c'])}

9. *Optional* You can have users save clicks by enabling the “One-Click” feature. Enabling this will bypass the document creation wizard. An administrator simply needs to change the button definition to include a list of pre-selected S-Docs template names that will be automatically generated. Placing this button will let users create all the documents encoded in the button without any additional interaction. The button syntax uses a parameter called “doclist,” which is followed by one or more template names to be auto-generated. Here is an example of the button syntax (replace the highlighted values with your own template names):
   {!URLFOR('/apex/SDOC__SDCreate1', null,[id=CustomObj__c.Id, Object='CustomObj__c', doclist='Template1,Template2'])}
10. Click Save

Step 2b: Place button on your page layout [03:08]

1. Navigate to the page layout: Setup ➤Build ➤ Create ➤ Objects.
2. Click on your object name from the Label column (do not click on the Edit link).
3. Scroll down to the page layout related list section, and click the Edit link next to the page layout where you want to add the S-Docs button (you will repeat this for each page layout that you want the S-Docs button to appear in).                                         
4. From the Salesforce page layout screen, click Buttons, located in the top left toolbar menu. Once clicked, the right panel will display available buttons, where you should see your new button.
5. Click and begin dragging the S-Docs button that you just created into the lower portion of the page (your custom objects Detail Page Layout). Once you drag the button over the Custom Buttons section, you will see a green checkbox (indicating OK to drop) and you can release the button.
6. Be sure to click Save to apply the changes to the page layout and repeat steps 3-6 for any other layouts where you would like to add the button.

To use this new S-Docs button, you first need to add your custom object as an available picklist value in the "Related to Type" field on the S-Docs template detail page, and then create at least one template to use with your custom object. The next two steps describe this process.

Step 3: Add Your Custom Object API Name  to the "Related to type" field on the "SDoc Template" object [03:42]

1. Navigate to Build ➤ Create ➤ Objects.
2. Click on the SDoc Template link (not the Edit link).
3. Scroll down to the "Custom Fields and Relationships" section. Click on the Related to Type link.
4. Scroll down to the "Values" section and click on the New button.
5. Add your custom object’s API name (e.g. CustomObj__c)  as a picklist value, then click Save.
   Note: if you are using S-Docs with another AppExchange managed package, then your custom object API name should include the domain name of the package followed by two underscores and then the object name (e.g. package__CustomObj__c). You should use the entire API name for the S-Docs picklist value.

   

As a reminder, you should substitute your object’s API name (not use the example CustomObj__c shown above).

Step 4: Create your Custom Object Template [04:32]

1. Go to the S-Docs template home page by clicking on All Tabs (+ icon), and then selecting S-Docs Templates.
2. Click the New button from the S-Doc template object home page.
3. Create your Custom Object template record. Be sure to select your Custom Object name from the “related to type” picklist values. Before you can first use this template, you should confirm you have also checked the Available for Use and Initially Visible checkboxes.
4. Click Save, then click the Template Editor button.
5. Once in the editor mode, you can design your quote template using the WYSIWYG editor. The editor allows you to add text, format styles, insert tables, insert images and merge Salesforce data by using the Insert Field and Insert Related List buttons.
6. You can also edit the template HTML directly by clicking on the Source button. You can also paste pre-made template code here. Sample templates are available here.
   
7. Once your template is saved, you can test it by opening a sample custom object record, clicking on the S-Docs button, selecting your new template, and then clicking on Next Step.
8. Click on the View PDF icon or the document number to view or download the document.
9. The document will open in another tab with all of the fields filled in.

Introduction

The following parameters can be appended to an Apex button or to the end of an S-Doc creation call.

Template Editor Parameters

Template Selection Parameters

Document Generation & Email Parameters

Live Edit Parameters

S-Sign Parameters

General Parameters