2017 W-Systems All Rights Reserved

Transcription

1

2 Contents 2 Table of Contents 3 Part I Introduction Introducing DocuSign for SugarCRM 4 Part II Installation Upgrading 11 Part III Configuration Configuring the DocuSign Module Adding the DocuSign Dashlet to a Module's Intelligence Pane DocuSign User Settings DocuSign Dashlet Tabs 22 5 Note... Name DocuSign Sweeper (SugarCRM Scheduler Job) 28 Part IV Usage 28 1 Send... a Document 33 2 Send... Multiple Documents Review Status of Sent Documents / Envelopes Part V Additional Information Contact Information Technical Support End-User License Agreement (EULA) 40 Index

3 1 Introduction 1.1 Introducing DocuSign for SugarCRM Introduction 3 Features and Benefits Increase productivity Sending a document for electronic signature is simple using DocuSign for Sugar 7. Just drag and drop the DocuSign dashlet on any object, including custom objects, and click the Send with DocuSign button. The DocuSign dashlet is included by default on the Account, Contact, Lead, Opportunity, and Quote objects. Then, use the familiar DocuSign interface to specify recipients, define signing workflow, edit tags, and send the envelope from Sugar 7. View real-time updates on the status of DocuSign envelopes, and view signed documents automatically attached back to the originating record in Sugar 7. Increase revenue Designed for sales, there s nothing new to learn with DocuSign. Documents are auto-routed to the right people, with reminders and expiration times. Decision makers can review & approve a contract within minutes. Signed agreements are legally binding & backed by a court-admissible audit trail DocuSign warrants compliance with the December 1999 Federal ESIGN Act, which established a Community framework for the use of electronic signatures on electronic contracts in the United States. DocuSign s advanced signature is ready and legal to accelerate the speed of business. Gain more control and visibility into the process DocuSign provides an audit trail of edits, and notifies every signer when a contract is changed. This helps streamline a negotiation, reduce errors, shorten the sales cycle and lower cost. With DocuSign, you see in real-time who has received, reviewed and signed a contract. Take advantage of customization opportunities DocuSign is a platform designed and built for flexibility. DocuSign can be easily configured or customized to integrate with nearly any business process. DocuSign ships a complete set of APIs along with documentation and a world class SDK to make extending any workflow a breeze. See also: Installation Configuration Technical Support

4 2 Installation 4 Installation Download the DocuSign Package Point your browser to SugarExchange: Search for "DocuSign": Download the DocuSign module package to be installed from the Sugar Connector to DocuSign page. The file name that will be downloaded will follow this format: DocuSign vx.x.x.zip Uploading the DocuSign Package to Sugar In the Developer Tools section of the Administration page, click on Module Loader:

5 Installation 5 After the Module Loader page displays, we will be using the Module Upload panel to access and upload the package to be installed. Click the Choose File button in the Module Upload panel to open a file selection dialog. Within the Open dialog, navigate your local computer to the folder containing the DocuSign v1.x.x.zip module package. In the following example, we have the DocuSign v1.x.x.zip package in the Downloads folder:

6 Installation 6 Click on the DocuSign v1.x.x.zip file, and then click Open button (or simply double-click the file) to get the file selected in the Module Upload panel. After selecting the file, click the Upload button to complete the upload process. After the file has been uploaded, the package will appear in the Uploaded Packages panel: Installing the DocuSign Package

7 Installation 7 After the DocuSign package has been uploaded into Module Loader, it must be installed for the package's contents to work in your SugarCRM instance. Providing that you've followed the steps above for uploading the DocuSign package, it will be available to install. Click the Install button on the Uploaded Packages panel. SugarCRM will take you to a Ready To Install screen. Here you can read the License and Readme documentation as required. If all is acceptable, select Accept radio button and then click Commit to start the installation. The next page displays a progress bar showing the percentage of completion as it is processing the installation. When fully completed, a completion notice will be displayed. NOTE: If there were any errors during the installation, they will be displayed along with an explanation of why they occurred. If there were no errors, you will see 100% and the following link and message:

8 Installation 8 After clicking Back to Module Loader, Sugar will display the Module Loader page. The Installed Packages panel shows the installation was successful: In the System section of the Administration page, click on Repair > Rebuild JS Grouping Files: After the JG Grouping Files rebuild is complete, press <Ctrl+F5> to force a browser refresh. The DocuSign installation is now complete! 2.1 Upgrading To upgrade the DocuSign module to a newer version, the older version needs to be uninstalled. After completing the uninstallation, the newer version can be installed following the Installation instructions. Uninstalling the DocuSign module

9 Installation 9 In the Developer Tools section of the Administration page, click on Module Loader: After the Module Loader page appears, locate the DocuSign for SugarCRM x.* in the Installed Packages panel and click the Uninstall button: When the Ready To Uninstall page appears, select the option: Do Not Remove Tables, and then click Commit:

10 Installation 10 After the completion, Sugar will display that module was successfully uninstalled. Click Back to Module Loader so the old package can be deleted. On the Module Loader page, the uninstalled package will appear in the Uploaded Packages panel. Click Delete Package to remove it from Sugar: To complete the uninstallation, press <Ctrl+F5> to force a browser refresh. Installing the DocuSign module To install the latest version of the DocuSign module, please follow the Installation instructions.

11 3 Configuration 11 Configuration Configuring the DocuSign Module Adding the DocuSign Dashlet to a Module's Intelligence Pane DocuSign User Settings DocuSign Dashlet Tabs Note Name DocuSign Sweeper (SugarCRM Scheduler Job) 3.1 Configuring the DocuSign Module In Sugar, click your user name on the User Menu in the upper right of Sugar and select Admin: This opens the Administration page. Scroll down to locate the DocuSign section and click the DocuSign Settings link: Sugar will display the DocuSign Configuration Settings page. Select Production from the Set DocuSign API Environment drop-down: PLEASE NOTE: If you are using a DocuSign Developer Account for testing or development, select Demo from the Set DocuSign API Environment drop-down. If you are not using a Developer Account and would like more information about obtaining one, please visit the DocuSign Developer Center to get started: For configuring use with a DocuSign Developer Account, select "Demo" from the Set DocuSign API Environment drop-down:

12 Configuration 12 Also for first time users, the "Remove..." buttons do not need to be used. However, these two buttons can be used to clear user data in SugarCRM as required. If this is the case, click the Remove all DocuSign Envelope Status Records and/or the Remove DocuSign Login Information for All Users button(s) and the cleanup takes place when the Save button is clicked. Adding a DocuSign Dashlet to the Sugar Home Page Click on the Sugar Cube icon to get to your Home page in Sugar: At the upper right of the Home page, click the down arrow to select the Edit command:

13 Configuration Locate where you would like to insert the DocuSign Dashlet and click on the Add a Row frame: Next, click the Add a Sugar Dashlet frame: On the Add a Sugar Dashlet page, click the DocuSign link: The following configuration screen will appear. The DocuSign name may be edited or left as the default. Click the Save button to add the DocuSign Dashlet to the dashboard: The resulting DocuSign Dashlet will appear. Click the Configure DocuSign link: 13

14 Configuration 14 Click Save at the upper right of the page: IMPORTANT: DocuSign Account/Configuration Notes The initial configuration should be for the DocuSign account owner. Once this master DocuSign account is configured in Sugar, all other Sugar users can configure their own DocuSign user accounts in Sugar using the same process documented here and then can use the DocuSign features. If the DocuSign owner account is not configured in Sugar, a message informs the user to contact their administrator. To configure the DocuSign account, move back to the new DocuSign Dashlet. Clicking the Configure DocuSign link will display the DocuSign Credentials dialog. Enter your credentials and click OK or use the Create a new DocuSign Account link to create a new account.

15 Configuration 15 CONFIGURATION / TROUBLESHOOTING NOTE: If the login credentials fail, please check these items: 1. Attempt a login directly into DocuSign to test that the credentials being used are valid. 2. Be sure that the correct Set DocuSign API Environment is selected. 3. It is possible that a firewall may be blocking domains / IP addresses for the DocuSign Service. Please visit this URL for more information: whitelist/ and correct as necessary. After the DocuSign account has been entered and validated, the Sugar Home page will refresh and a Summary of Your DocuSign Envelope Statuses for All Objects will display in the DocuSign dashlet: The DocuSign configuration is now complete! 3.2 Adding the DocuSign Dashlet to a Module's Intelligence Pane Now that DocuSign is installed and configured, this section will guide you through adding the DocuSign Dashlet to a module's Intelligence Pane. The instructions that follow can be used for any of these three modules: Accounts, Contacts, and Opportunities. In this example, we'll add the DocuSign Dashlet to the Accounts module. Start by selecting the module. Click on the module name to open the List View and the Intelligence Pane.

16 Configuration 16 If the Intelligence Pane is not displayed, click the arrow (pointing to the left) located at the upper right of the List View page: This is a screenshot of the Accounts module List View with Intelligence Pane displayed (the Intelligence Pane is shown here enclosed in a red frame for clarity): At the upper right of the Intelligence Pane, click the down arrow to select the Edit command: Locate where you would like to insert the DocuSign Dashlet and click on the Add a Row frame:

17 Configuration Next, click the Add a Sugar Dashlet frame: On the Add a Sugar Dashlet page, click the DocuSign link: The following configuration screen will appear. The DocuSign name may be edited or left as the default. Click the Save button to add the DocuSign Dashlet to the dashboard: The resulting DocuSign Dashlet will appear: 17

18 Configuration 18 Click Save at the upper right of the page: Repeat this process as required to add the DocuSign Dashlet to the Intelligence Pane on other modules. The admin user can login from a DocuSign dashlet after the configurations are complete. Click the DocuSign User Settings tab in the dashlet and click Log In to open the DocuSign Credentials dialog: After a successful login, the menu options: Add to DocuSign and Send with DocuSign will be available on the Documents sub-panel (i.e., these will not appear unless the configurations are

19 Configuration 19 completed). NOTE: The DocuSign dashlet must be added to the Accounts module Detail View's Intelligence Pane to be available as shown here: The New Envelope tab (available only on record view dashlets) will be missing if the user is not logged into DocuSign: 3.3 DocuSign User Settings The DocuSign User Settings menu has the following options: Switch Accounts A pop up window is displayed when selecting this option. You will be able to select one of the accounts related to the same address/password combination:

20 Configuration 20 The behavior is similar to the DocuSign Switch Account option: - The current user that is logged in will be displayed along with their address. - The Log Out option will disconnect the current user from DocuSign. 3.4 DocuSign Dashlet Tabs DocuSign tabs were created for DocuSign dashlet. These will be available for each view as follows: DocuSign dashlet from Sugar Home Page: The DocuSign dashlet on the Sugar Home Page will have only 2 tabs: Overview tab: With the general chart and the counter for each status.

21 Configuration 21 Statuses tab: All envelopes added to DocuSign will be displayed with the details related to each envelope: Envelope status, subject, date created, and name. The DocuSign dashlet from a List View will have only 2 tabs: Overview tab: With the general chart and the counter for each status. Statuses tab: All envelopes added to DocuSign will be displayed with the details related to each envelope: Envelope status, subject, date created, and name. Examples: o The DocuSign dashlet from the Account List View page will offer an overview for all envelopes sent from Accounts. o The DocuSign dashlet from the Contacts List View page will offer an overview for all envelopes sent from Contacts. The DocuSign dashlet from a Record View will have 3 tabs: Overview tab: With the general chart and the counter for each status. Statuses tab: All envelopes added to DocuSign will be displayed with the details related to each envelope: Envelope status, subject, date created, and name. New Envelope tab: Available only on the record view DocuSign dashlets. Examples: o The DocuSign dashlet from Account Record View will show all envelope statuses sent from the current Account. o Statuses should roll up from Contacts to the parent Account so the DocuSign dashlet from Account record view will offer an overview of the envelopes sent from the current Account + the envelope statuses sent from the related Contacts. o The DocuSign dashlet from Contact Record View will show all envelope statuses sent from the current Contact.

22 Configuration 22 The Add to DocuSign action available on the Documents sub-panel will send the document to New Envelope tab that will show the entire list of added documents: 3.5 Note Name The Note name created upon each status transition was changed to: 'DocuSign envelope sent':

23 Configuration 23 DocuSign Envelopes on Document Record View Each document can be tracked within the DocuSign Envelopes section of each document record view: DocuSign Envelopes Each new envelope created will be registered within the DocuSign Envelopes module. The DocuSign Envelopes module can be accessed from DocuSign Statuses tab when pressing on the hyperlink which can be found on the Name column:

24 Configuration 24 On the record view you can find relevant details related to the current envelope: Envelope ID DocuSign Envelope ID: The ID of the record from which the user sent the envelope. Envelope Status: The current status of the current envelope (created, sent, delivered, completed, voided, and declined). Subject: The subject. DocuSign Parent Record: The name of the record from which the user sent the envelope. Envelope URL Created By: The Sugar user that initiated the envelope. 3.6 DocuSign Sweeper (SugarCRM Scheduler Job) The following instructions are for configuring a scheduled job in SugarCRM. The purpose of this job is to check with DocuSign for any envelope updates and update SugarCRM by setting the envelope status and by writing a note related to the envelope about any envelope status change. Create the Scheduler Job in SugarCRM From the User Menu drop-down, select Admin > Scheduler (in the System section):

25 Configuration 25 SugarCRM will open the Schedulers page and display a list of the scheduled jobs. In the navigation bar's module tabs, use the Sugar Scheduler drop-down to select Create Scheduler: SugarCRM will open the page used to create the scheduler job. Fill the form in as follows: Job Name = DocuSign Sweeper Job = DocuSign Sweeper (select this from the drop-down) Status = Active Advanced Options: (leave this unchecked) Interval: Set to Every "15" "Minutes" for all days (or greater). PLEASE NOTE: Setting this to a value that is "less than" 15 minutes is not recommended and may cause envelopes and statuses to not be returned as expected (this is due to an API polling compliance). This is especially true when there is a lot of activity within your organization's DocuSign account. After populating the fields, click the Save button to save the job and start it running. This next screenshot shows how the job looks in its Detail View after saving it (please note the Job Log sub-panel initially displays "No data" in the Job Name column):

26 Configuration 26 After a short time, the Job Log shows the Job Status as "queued" (not shown here) and then "running" as shown: After the job completes, the Job Log shows the Job Status as "done": The job is set to keep running and as shown in the next screenshot, it is queued again to run. The Job Log sub-panel display recent execution history. To access the job at a later time to review its settings or its logs, go back into the Schedulers List View

27 Configuration 27 by clicking on the Sugar Scheduler drop-down and selecting Schedulers: The Sugar Scheduler List View displays. Click on the DocuSign Sweeper link in the Scheduler column and the DocuSign Sweeper Detail View will open.

28 4 Usage 28 Usage Send a Document Send Multiple Documents Review Status of Sent Documents/Envelopes 4.1 Send a Document To send a document from SugarCRM, the document needs to be linked to a module (i.e., Accounts, Contacts, etc.). Go to the module having a linked document that needs to be sent. In the Documents sub-panel, if the document is not already linked, create a new document record or link an existing document from the Documents module. From the document record's Actions drop-down, select Send with DocuSign: The DocuSign editing windows will appear:

29 Usage 29 The next steps are to add recipients, a message, tags, and send he document. Adding Recipients Click the To button (or recipient field to the right of the To button) to open the Recipients and Routing dialog. Use this dialog to enter or select the recipients of the document being sent. Add a recipient by entering their address and name in the appropriate fields (see blue frame in the image) and clicking the Add Signer button. Recipients can also be added from the Address Book by clicking the address book icon to make the Address Book dialog open. Make the appropriate selection from the Address Book drop-down and then select the recipient(s) you want to send the envelope to and click the Add button.

30 Usage 30 If there are multiple recipients, you can change the routing order in which the recipients receive the envelope and perform signing. Click Done to save the recipient list. (NOTE: The list of recipients can be edited if needed by clicking the To button or by clicking within the recipient list to open the Recipients and Routing dialog.)

31 Usage 31 Adding a Message Click the Message button (or message field to the right of the Message button) to open the Message dialog. Use this dialog to edit the subject line and to add an message (optional). There is also the availability to "Customize and signing language for each recipient". Click the hyperlink and set the desired language from the drop-downs. Notes can be added for specific recipients. To add a note for a specific recipient, select the recipient from the drop-down and click the Add button. Type the note and then click Done. Adding Fields After adding recipients and messages, the fields to instruct your signers to provide their signatures need to be added to the document (other items may also be added to the document). You can add specific signing fields for each recipient. Select the recipient you want to add fields for: From the list of fields in the left window, drag and drop the fields as needed onto the document (in this example the Signature and the Full Name fields were placed onto the document):

32 Usage 32 After inserting the fields as desired, click the Send button to send the document t the recipients to be signed. NOTE: You may optionally use the Preview, Save Draft, or Discard Changes commands for the document. What the Recipient Recieves When the recipient receives the document to be signed as configured in the prior example, it will appear as shown here: And after signing, the document will look appear as shown here:

33 4.2 Usage 33 Send Multiple Documents When multiple documents need to be sent/signed, the additional documents are added to the Documents list prior to sending them to the recipient(s). Preliminary steps are required before adding additional documents and those steps are described in the topic: Send a Document. Once the initial document is ready to be sent, other documents can be added. These additional documents can also contain fields like signature requests, names, dates signed, etc. Adding Additional Documents Within the DocuSign window, click the Documents button at the top of the Documents list window. This will open the Documents for Signature dialog. Click the Browse from my Computer or the Choose and Online Document button to open a browse dialog (not shown) that is used to select the document to be added. After selecting a document, it is added to the Documents for Signature dialog as shown here in the red frame. The documents can be reordered if desired. After adding one or more additional documents, click the Done button.

34 Usage 34 Click on a newly added document to add fields for signing and others as required (see: Send a Document). In the following example, this document is setup to go to two recipients and require signatures from each of them. After the additional documents are ready to be sent, click the Send button (or use the other available options like Save Draft or Discard Changes). 4.3 Review Status of Sent Documents / Envelopes The Overview and the Statuses tabs on the DocuSign dashlet display information regarding the status of documents/envelopes. Overview tab

35 Usage 35 The Overview tab incorporates a doughnut chart. On the dashlet, directly below the chart, is a key to what is being displayed. The colored icons contain a number representing the quantity of each specific status type as shown here: Description of statuses: Created: The envelope has been created in SugarCRM but has not been sent. Sent: The envelope has been sent out of SugarCRM but not delivered to the recipient. Delivered: The envelope has been delivered to the recipient. Completed: The recipient completed the signature signing. Declined: A signer for the document has declined to sign it. Voided: The sender canceled the document before it was completed. Recipients can no longer view or sign the document. Voided documents appear in your sending account as voided. You can still view and print the document, though it has a "VOID" watermark.. All: This is the total sum of all statuses. Statuses tab The following image is an example of what appears on the Statuses tab. This tab contains more details for each of the envelopes and are displayed in a list view. Clicking the link in the Name column opens the envelope record in the Document Envelope module DetailView.

36 Usage 36

37 5 Additional Information 5.1 Contact Information Additional Information 37 W-Systems 19 Spear Road, Suite 101 Ramsey, New Jersey Phone: [201] Toll free: [800] Fax: [201] Web: Technical Support For Technical Assistance: Visit DocuSign for their list of Frequently Asked Questions: DocuSign Support Center: If technical support is needed for this installation, please feel free to write to us at: Please include as much information as possible regarding your issue and supply full contact information so we know who to contact when we respond. Thank you! 5.3 End-User License Agreement (EULA) END USER LICENSE AGREEMENT This copy of Sugar Connector to DocuSign ("the Software Product") and accompanying documentation is licensed and not sold. This Software Product is protected by copyright laws and treaties, as well as laws and treaties related to other forms of intellectual property. W-Systems or its subsidiaries, affiliates, and suppliers (collectively W-SYSTEMS") own intellectual property rights in the Software Product. The Licensee's ("you" or "your") license to download, use, copy, or change the Software Product is subject to these rights and to all the terms and conditions of this End User License Agreement ("Agreement").

38 Additional Information 38 Acceptance BY DOWNLOADING, INSTALLING AND/OR USING THE PRODUCT, YOU ARE AGREEING TO BE BOUND BY THE TERMS OF THIS AGREEMENT. IF YOU DO NOT AGREE TO THE TERMS OF THIS AGREEMENT, DO NOT DOWNLOAD, INSTALL AND/OR USE THE PRODUCT. License Grant This Agreement entitles you to install and use one copy of the Software Product in conjunction for a single licensed copy of SugarCRM. You may additionally install and use the Software Product on multiple test or development instances of SugarCRM as provided by your SugarCRM license For further information regarding multiple copy licensing of the Software Product, please contact: Attention: Licensing Address: W-Systems 19 Spear Road Ramsey, NJ USA Phone Number: Address: info@w-systems.com Restrictions on Transfer Without first obtaining the express written consent of W-SYSTEMS, you may not assign your rights and obligations under this Agreement, or redistribute, encumber, sell, rent, lease, sublicense, or otherwise transfer your rights to the Software Product. Restrictions on Alteration You may not modify the Software Product or create any derivative work of the Software Product or its accompanying documentation other than for the purpose of using this derivative work on your own licensed SugarCRM instance. Derivative works include but are not limited to translations. You may not distribute a derivative or altered version of the Software Product for any other purpose than specifically allowed in this agreement. Disclaimer of Warranties and Limitation of Liability UNLESS OTHERWISE EXPLICITLY AGREED TO IN WRITING BY W-SYSTEMS, W-SYSTEMS MAKES NO OTHER WARRANTIES, EXPRESS OR IMPLIED, IN FACT OR IN LAW, INCLUDING, BUT NOT LIMITED TO, ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OTHER THAN AS SET FORTH IN THIS AGREEMENT OR IN THE LIMITED WARRANTY DOCUMENTS PROVIDED WITH THE SOFTWARE PRODUCT. W-SYSTEMS makes no warranty that the Software Product will meet your requirements or operate under your specific conditions of use. W-SYSTEMS makes no warranty that operation of the Software Product will be secure, error free, or free from interruption. YOU MUST DETERMINE WHETHER THE SOFTWARE PRODUCT SUFFICIENTLY MEETS YOUR REQUIREMENTS FOR SECURITY AND UNINTERRUPTABILITY. YOU BEAR SOLE RESPONSIBILITY AND ALL LIABILITY FOR ANY LOSS INCURRED

39 Additional Information 39 DUE TO FAILURE OF THE SOFTWARE PRODUCT TO MEET YOUR REQUIREMENTS. W-SYSTEMS WILL NOT, UNDER ANY CIRCUMSTANCES, BE RESPONSIBLE OR LIABLE FOR THE LOSS OF DATA ON ANY COMPUTER OR INFORMATION STORAGE DEVICE. Governing Law, Jurisdiction and Costs This Agreement is governed by the laws of New Jersey, without regard to New Jersey's conflict or choice of law provisions. Severability If any provision of this Agreement shall be held to be invalid or unenforceable, the remainder of this Agreement shall remain in full force and effect. To the extent any express or implied restrictions are not permitted by applicable laws, these express or implied restrictions shall remain in force and effect to the maximum extent permitted by such applicable laws.

40 Index Index -Ffields -A- -I- additional 33 address book 28 administration 8 agreement 37 installation 4 Intelligence Pane introduction 3 -BBrowse from my Computer 15 -L33 -CChoose an Online Document 33 commit 8 completed 34 configuration 11, 15, 19, 20, 22, 24 configure 11, 15, 19, 20, 22, 24 contact information 37 created 34 credentials 11 license 37 login 11 -Mmessage 28 module loader 4, 8 module upload 4, 8 multiple 33 -Nnotes -D- 22 -O- dashlet 15, 20 dashlet tabs 20 declined 34 delivered 34 developer tools 8 document 28, 33, 34 documents 28, 33, 34 download 4 order 28 -Rrebuild 4 recipients 28 record view 22 review 34 routing 28 -E message 28 end-user 37 end-user license agreement envelopes 22, 34 EULA Sscheduler 24 scheduler job 24 send 33 send document 28 40

41 send multiple 33 signature 28 signer 28 status 34 statuses 34 switch accounts 19 -Ttechnical support 37 -Uuninstall 8 uninstallation 8 upgrade 8 upload 4 user settings 19 -Vvoided 34 -Wwhitelist 11 W-Systems 37 Index 41