Skip to main content

Synchronisation of document and instance settings

Currently, it's important that we bear in mind that certain settings will need to be kept in sync when setting up the documents which will be used within a Scrive Flow e-signing workflow.

This is fairly ugly and we will be extending the functionality of the Scrive Flow APIs so that documents can be created during the process of setting up your e-signing workflow. Much of the need to worry about this will be obviated long term.

Until the Flow project matures though, you will need to set up documents yourself, and then provide their document IDs when starting an instance.

There are some other things that are worth watching out for when setting up documents which are intended for use with the Scrive Flow API. This article will detail those.

Document fields which are not supported​

The following fields are not supported by Flow, and should be left empty:

  • days_to_remind, auto_remind_time - Flow currently does not support automatic reminder messages.
  • days_to_sign, timeout_time - Timeouts should be configured when starting Flows in the Start Instance end-point.

Document fields which must be consistent with the Flow Instance​

Primarily, we make sure that the signatory (or approver/viewer) metadata that you've provided is consistent with what you've provided when starting the instance.

These fields must also be in sync across documents but we'll focus here on the fact that they must be in sync with the instance itself too.

  • First name
  • Last name
  • Full name
  • Email
  • Phone number
  • User ID

You likely haven't provided all of these for each document, but you must have provided some of them. This is because you must have chosen a means of identifying the participant when starting the instance.

For example, let's say you identified a user by email when creating your flow instance. Of course, in each document related to that user, you must have a participant which has an email address that matches the one in the instance.

Participants which are ignored by Scrive Flow​

  • Viewing parties

Given that we have not implemented the viewed-by condition which is permissible in the DSL definition, we currently just ignore and viewing parties.

You may set up documents which contain them, but it will be as if they do not exist from the perspective of the instance.

Peculiarities with confirmation emails / SMSs​

Whether or not the confirmation notification settings for each document are ignored depends on whether you have provided a confirmation stage in your DSL process description.

If one is not present, then we use the confirmation settings that are present in the document. If one is present then these settings will be ignored and a unified Flow confirmation email will be sent out that invites the participant back to the overview page so that they can view the completed documents.