Identify destination records (beta)
The file output system of record extension supports two options for identifying the record that a file will be written to: a workflow variable value or a record ID returned from a Read from workflow step. See the next sections for details.
Use a workflow variable value
During workflow File Output step configuration, the process builder can select a workflow variable to use as the record identifier. The variable can represent a value that:
- Is passed to the workflow from an API integration that triggered the workflow
- Identifies the customer, such as their name or email address
- The customer enters during a previous workflow step, such as a Send Documents for Signature step
The process builder also selects the object in the system of record that the file will be written to.
At runtime, when a workflow instance reaches the File Output step, Docusign sends a Write File request to the external system. The request includes the object the process builder selected and the variable value as the record identifier.
For additional details about configuration and runtime execution, see Extensions and actions: Record identifier is a workflow variable.
This option for selecting a record identifier is easier for workflow process builders to configure. However, it requires that the external system use a single workflow variable value, along with an object name, to uniquely identify a record to write files to. If this is not feasible, you can instead identify a record using a Read from workflow step, as described in the next section.
Use an ID returned by a Read from workflow step
During workflow configuration, a process builder can include a Read from step that defines a search query to the external system. The query identifies the record to write a file to and returns the record ID. When the process builder configures the File Output step, they select the ID returned by the Read from step as the record identifier.
At workflow instance runtime, the Read from step execution sends a query to the external system, which returns the ID of the record to write the file to. Docusign includes this ID in the request it sends to the external system when the File Output step is executed.
For additional details about configuration and runtime execution, see Extensions and actions: Record ID is from a Data read step.
Use this option if you need more than a single workflow variable value to identify the record to write a file to. For example, if a customer name, email address, and account number are all required to uniquely identify a destination record, a process builder can configure a Read from step that launches a query that uses all three values. You may also prefer this option if other steps in a workflow, such as a Collect Data with Web Forms step, require values to be retrieved from the record in the external data source. In this case, you can configure the Read from step so that it returns multiple values from the data source record, in addition to the ID of the record that the files are to be written to.
Impact on implementation
The choice of how to identify records to write to determines which extensions and actions your app must implement, so it should be made early in your development planning process. The required extensions and actions for each option are listed below.
For additional information, see:
- Workflow configuration for file output scenarios for details about workflow setup.
- Extensions and actions to learn about the required extension app components.
Next steps
- See the choices available to select as the file source.
- Learn more about setting up workflows that include file output to system of record.
- Get an overview of the process to build an extension app.