Test PDF file

Quick Start GuideDocuSign Retrieve — 3.2.3Published March 2016Overview DocuSign® Retrieve is a windows-based tool that \"retrieves\" envelopes, documents, and data from DocuSign for use in external systems. Retrieve runs on your system and can be run as one-time request or on a schedule. When run, Retrieve contacts DocuSign, and retrieves envelopes, documents, and information for those envelopes based on filters you set. Note: With v3.2, the DocuSign Fetch application was renamed DocuSign Retrieve. This guide provides information about: l Installing Retrieve l Creating, loading, deleting, and setting default Retrieve settings l Using the Retrieve command line The DocuSign Retrieve application and Retrieve settings can be set up with the assistance of DocuSign Professional Services. Contact your Account Manager for more information about working with DocuSign Professional Services and Retrieve.About Retrieve 2Installing DocuSign Retrieve 2Logging on to DocuSign 4Creating Retrieve Settings 5Default Retrieve Settings 10Loading Retrieve Settings 10Deleting Retrieve Settings 10Retrieve Command Line Information 11For More Information or Assistance 13221 Main Street, Suite 1000, San Francisco, CA 94105 Ι Tel. 866.219.4318 Ι www.docusign.com Ι © DocuSign, Inc.

DocuSign Retrieve Quick Start Guide 2About RetrieveRetrieve is a DocuSign product that allows you to download envelope information from DocuSign bycreating Retrieve settings. Retrieve settings are \"bookmarks\" where you save search information.When creating Retrieve settings, you can select the date range and the envelope statuses to search,along with how and where to save the search results. You can save Retrieve settings for later use anduse them to build a command line for scheduled tasks.You can configure the Retrieve output to meet your needs. You can have the output saved as a ZIP file,as separate PDF files or as a single PDF file. You can also specify where to save the output files.Many customers save files to some convenient location, and then have their back end system pick upthe files from that location on a regular schedule. Additionally, if you want the data (such as envelopeID, date signed, custom information you added to the documents, etc.), then you can have Retrievecreate and save an Index file (a CSV file) with this data.For example, you can have a schedule set to run Retrieve once per day to retrieve all of the completed,signed PDFs, for any envelope completed in the last 24 hours, and create an Index file with the valuesfor the 20 custom fields you placed in those documents.Installing DocuSign RetrieveThis topic describes how to install DocuSign Retrieve, including system requirements and otherprerequisites.System RequirementsDocuSign Retrieve supports the following Windows server, desktop, or laptop systems. The applicationmay function on other configurations not listed here, but only the following systems are supported:Operating Systems l Windows 7, SP2 l Windows 8.1Server Environments l WinServer 2012 R2.NET l .NET 4.5 requiredIMPORTANT: Before installing Retrieve v3.2.x, you must uninstall any previously installed version,v3.2 or above. You do not need to uninstall any installed versions prior to v3.2. However, you must221 Main Street, Suite 1000, San Francisco, CA 94105 Ι Tel. 866.219.4318 Ι www.docusign.com Ι © DocuSign, Inc.

DocuSign Retrieve Quick Start Guide 3 install Retrieve v3.2.x to a different folder than those prior versions. DocuSign recommends uninstalling older Fetch versions once you have installed v3.2 and are satisfied with its operation. (Fetch was the previous name for this application.) When you install v3.2.x, it recognizes and uses any previously saved configuration and settings.Internet Communications - Security ConsiderationsRetrieve securely connects to DocuSign's API servers via HTTPS. These servers reside at multiple publicaddresses hosted under \"docusign.net\". Example addresses include: www.docusign.net,na2.docusign.net, eu.docusign.net, and demo.docusign.net.Retrieve relies on its underlying .NET 4.5 framework for negotiating TLS/SSL versions and proxyconfiguration as described below. Contact your IT operations group before attempting to installRetrieve. DocuSign Professional Services can help answer any questions your IT operations group mighthave.TLS/SSLThe .NET 4.5 framework attempts a connection to a host using the highest level of TLS available.Should that fail, attempts are made to successively lower levels of TLS and SSL. Should all fail, Retrievediscontinues connection attempts.Proxy ServerThe .NET 4.5 framework uses the proxy as configured and used with Microsoft Internet Explorer. Youcan override this behavior using .NET configuration files. For further information, see MicrosoftDeveloper Network <defaultProxy> Network Settings function.To install RetrieveOnce you have signed up to use Retrieve, DocuSign provides you with the DocuSign Retrieve zip file. Toinstall Retrieve: 1. Uninstall any previously installed versions, v3.2 or above. You do not have to uninstall versions prior to v3.2. 2. Extract the files from the zip file. There are two files in the zip file: l Release Notes l DocuSignRetrieve.3.2.3.Install.msi 3. Run DocuSignRetrieve.3.2.3.Install.msi to start the installation. The setup uses an installation wizard to gather information and install Retrieve on your system. 4. If you have prior versions installed, be sure to install this version in a different folder. 5. Follow the wizard instructions to complete the installation.221 Main Street, Suite 1000, San Francisco, CA 94105 Ι Tel. 866.219.4318 Ι www.docusign.com Ι © DocuSign, Inc.

DocuSign Retrieve Quick Start Guide 4Logging on to DocuSignWhen you open DocuSign Retrieve, the main window is shown. The Retrieve main window is used toconfigure Retrieve settings, which determine the envelope information that is searched for anddownloaded, save Retrieve settings, select Retrieve settings, and to run the Retrieve process manually.You must be logged on to a DocuSign account within a particular environment, such as Production orDemo, to take actions in the Retrieve main window.To log on to an account 1. In the Login Info tab, select the Environment to retrieve the envelope information from, and then type the email address and password associated with your DocuSign account. 221 Main Street, Suite 1000, San Francisco, CA 94105 Ι Tel. 866.219.4318 Ι www.docusign.com Ι © DocuSign, Inc.

DocuSign Retrieve Quick Start Guide 5 If the selected Environment is Other, an additional Host field is shown. Type the Host server location (examples of other DocuSign environments are: Preview and Test).2. Click Login to verify and load all the accounts associated with your email address and password for the selected environment. The DocuSign environment you are logged on to is shown in the upper left of the Retrieve main window. 3. Retrieve can only retrieve information from one corporate account at a time. If you have multiple accounts associated with the login credentials, use the account drop-down list (adjacent to the Make Default button) to select the account from which information is retrieved.Creating Retrieve SettingsRetrieve settings are \"bookmarks\" where you to save search information (such as environment,passwords, and filters), so they can be reused repeatedly without having to create a new setting eachtime.Define an Index output fileAs an optional part of a Retrieve setting, you can define an Index output file. The Index file data caninclude common information, such as a recipient's name or envelope ID, along with envelope customfields and custom tags that are specific to each customer's use case. You can specify which data areincluded in the Index file in the Output Columns tab. This file is a CSV file that can be used to importdata about envelopes and documents into your system.Follow the steps below to create a new Retrieve setting for your system.221 Main Street, Suite 1000, San Francisco, CA 94105 Ι Tel. 866.219.4318 Ι www.docusign.com Ι © DocuSign, Inc.

DocuSign Retrieve Quick Start Guide 6To create a Retrieve setting1. From Retrieve, log on to a DocuSign environment.2. Select the account to use from the drop-down menu:Note: Retrieve can only retrieve information from one corporate account at a time. If you havemultiple accounts, use the drop-down list (adjacent to the button) to select theaccount you want to check.3. Set the output format and location information for retrieved files: a. Click the Output tab.b. Location. Type or select the location of where to save the files. You can browse to the location by clicking the folder icon. This folder can be on your workstation or on a server.c. File Save Format. Select the format for the saved file. The file can be saved as a zipped file, as one merged PDF, or as separate PDFs, with or without the Certificate of Completion. Or you can choose to save just the Index file with your document data output.d. File Name Format. Select how the saved files are named. The can be by envelope subject, envelope ID, or using one or more custom fields.221 Main Street, Suite 1000, San Francisco, CA 94105 Ι Tel. 866.219.4318 Ι www.docusign.com Ι © DocuSign, Inc.

DocuSign Retrieve Quick Start Guide 7 If you select to use custom fields for naming the files, type the custom field name and click Add Custom Field. Remove custom fields by clicking on the field name and clicking Remove Custom Field.4. Set the date range for the query. a. Click the Date Range tab. b. Type the Start Date Time and End Date Time for the setting.  The default value for the end date is the current date. The default value for the start date is one week ago. All times are in Greenwich Mean Time (GMT). Important: DocuSign recommends you limit the extent of your date range. Large date range requests can take a long time to complete and result in very large files, and you should avoid using them if possible.5. Set the envelope filter information. The filter process also allows you to limit the information retrieved. For example, if you only want to retrieve information for envelopes sent and completed by all signers, you would select to include only envelopes “Sent out to at least one signers” that have changed status to “Completed or Signed by all the signers.” 221 Main Street, Suite 1000, San Francisco, CA 94105 Ι Tel. 866.219.4318 Ι www.docusign.com Ι © DocuSign, Inc.

DocuSign Retrieve Quick Start Guide 8 a. Click the Envelope Filters tab. b. Select the changed from envelope statuses (the check boxes on the left). Then select the changed to envelope status (the radio buttons on the right).  You can select any number of changed from statuses, but only one changed to status.6. (Optional) Set the Index output file information. The Index file is a CSV file containing the data from your envelopes that you specify in the Output Columns tab. a. Click the Output Columns tab.221 Main Street, Suite 1000, San Francisco, CA 94105 Ι Tel. 866.219.4318 Ι www.docusign.com Ι © DocuSign, Inc.

DocuSign Retrieve Quick Start Guide 9 b. Select a property in the Index Options column and use the green right arrow button to move it to the Index Fields column. To remove a property, select it in the Index Fields column and use the red left arrow button to move it to the Index Options column. Note: The information in the Index output file writes in the order shown in the Index Fields column (from top to bottom).  Some of the options are explained here: l Document - Date Signed. If you include the Date Signed field in your documents, then that data will write to the Index file. l Document - Title. If you include the Title field in your documents, then that data will write to the Index file. l Document - Company. If you include the Company field in your documents, then that data will write to the Index file. l Envelope – Custom Field. Enter the envelope custom field name in the Custom Field Name field. Then then use the green right arrow to move the option to the Index Fields column. Envelope Custom Fields are set up in the DocuSign web application in the account Preferences. These entries are case sensitive. l Document – Custom Fields Enter the field's Label value (Data Label in the New DocuSign Experience) in the Custom Field Name field. Then use the green right arrow to move the option to the Index Fields column. Custom Tags are set up in the DocuSign web application in the account Preferences. These entries are case sensitive and must match exactly the Label entry. c. (Optional) Select Include Headers to include envelope headers in the Index output file. d. (Optional) Select Skip Missing to create CSV rows in the Index file only for envelopes with information in all of the selected index fields. If this option is not selected, a CSV row is created for all envelopes that meet your envelope filter criteria, even if an envelope does not have information for all selected index fields. In that case, the column for an index field that does not have information is left blank. 7. Test and save the setting information. a. To test a setting or run a setting, click the Test tab and then click Start Processing to download the envelopes that meet the criteria of the setting.  A Processing complete dialog box displays when the processing is completed. The dialog box shows the number of envelopes and documents processed by the setting. Click OK to close the dialog box.221 Main Street, Suite 1000, San Francisco, CA 94105 Ι Tel. 866.219.4318 Ι www.docusign.com Ι © DocuSign, Inc.

DocuSign Retrieve Quick Start Guide 10b. To save a Retrieve setting, click Save Settings.  Type a Name for the setting and click Save. The setting is added to the Retrieve settings list in the upper portion of the Retrieve main window:Default Retrieve SettingsA default Retrieve setting is the setting that is automatically loaded when a user logs on to Retrieve.You can only have one default setting at a time, but you can change this setting at any time. Thedefault setting has a star adjacent to its name.You can make a Retrieve setting the default setting by selecting it in the upper portion of the Retrievemain window and clicking Make Default.Loading Retrieve SettingsYou can load any previously saved Retrieve setting. Loading a setting allows you to use it to processyour envelopes.To load an existing Retrieve setting 1. Log on to a DocuSign environment and if necessary, select the account to use.2. Select the Retrieve setting you want to load in the upper portion of the Retrieve main window.3. Click Load Settings.The selected Retrieve setting is loaded for use. You can run the setting, by clicking the Test tab andthen clicking Start Processing to download the envelopes that meet the criteria of the setting.Deleting Retrieve SettingsYou can delete previously saved Retrieve settings. You cannot delete your default settings. To deletedefault settings, first select a new default setting. 221 Main Street, Suite 1000, San Francisco, CA 94105 Ι Tel. 866.219.4318 Ι www.docusign.com Ι © DocuSign, Inc.

DocuSign Retrieve Quick Start Guide 11To delete a Retrieve setting1. From Retrieve, log on to a DocuSign environment and select the account to use.2. Select the Retrieve setting you want to delete in the upper portion of the Retrieve main window.3. Click Delete Settings.4. Click Yes to delete the setting.Retrieve Command Line InformationWith the Retrieve Console Script Builder, you can display a script with the command line parametersassociated with a selected Retrieve setting. You can copy the command line information to use it toschedule a task that runs the Retrieve process, which automatically runs Retrieve to downloadenvelopes. Note: Retrieve v3.x supports command line scripts created in Fetch v1. Fetch v2 did not support command line information. (Fetch was the previous name for this application.)To schedule a task using the script for a Retrieve setting1. In the Retrieve main window, log in, and create a new setting or load an existing Retrieve setting.2. In the Retrieve main window menu, click Tools and select Console Script Builder. The Script Builder dialog box appears. The upper section of the dialog box shows the differentcommand line parameter definitions and the lower section shows the command line informationfor the selected Retrieve setting. Important: The user ID and password parameters in the command line information are shown in plain text. You should protect your user ID and password information.221 Main Street, Suite 1000, San Francisco, CA 94105 Ι Tel. 866.219.4318 Ι www.docusign.com Ι © DocuSign, Inc.

DocuSign Retrieve Quick Start Guide 12 Note: The Script Builder converts the date range for the Retrieve setting into the span parameter, which sets the number of days for the search. For the Retrieve setting shown above, the system searches for envelopes that meet the filter criteria for the past month days (-31). a. Copy the command line information in the lower section of the dialog box and then close the dialog box. b. (Optional) Click Open Command Prompt to open a command prompt in a separate window and paste the command line information there to run the command.3. Open the Windows Task Scheduler and create a new task. Name the new task and set the Triggers for the task. l For the Actions, select Start a Program and paste the command line into the program/script field.  l Save the new task.4. Close the Windows Task Scheduler. Your automatic download is set up. 221 Main Street, Suite 1000, San Francisco, CA 94105 Ι Tel. 866.219.4318 Ι www.docusign.com Ι © DocuSign, Inc.

DocuSign Retrieve Quick Start Guide 13For More Information or AssistanceFor more information or assistance, visit DocuSign Support, the DocuSign Community, docusign.com, orcontact DocuSign Support.221 Main Street, Suite 1000, San Francisco, CA 94105 Ι Tel. 866.219.4318 Ι www.docusign.com Ι © DocuSign, Inc.