Complex Type: WorkFlowEx2

The WorkflowEx2 type defines the fields that are used when constructing a workflow package.

Parameter	Type	Requirement	Description
participants	array	mandatory	The array, ArrayOf_tnsl_WorkflowParticipantsEx2, contains objects used in the workflow.
attachments	array	mandatory	The array, ArrayOf_tnsl_Attachment, contains objects used in the workflow. All signers see all documents.
typeString	string	mandatory	The parameter must be set to SIGNING.
authenticate	boolean	mandatory	The parameter must be passed as TRUE or FALSE.
initiator	string	mandatory	The username (email address) of the account to be used as the initiator.
metaData	string	optional	If the skin is configured to use meta data then this can be provided here.
msgBody	string	optional	This is the body of the message that will be displayed to all signers.
startDate	dateTime	optional	The optional UTC timestamp to start expiry and reminder countdowns from. If not supplied then the system will use the time the package is submitted.
sendReminders	boolean	mandatory	Set to TRUE to have workflow reminders sent to the active participant
reminderInterval	string	optional	If sendReminders is set to TRUE then this value will be a comma delimited hourly interval for the reminders.
expiryPeriod	string	optional	This defines the expiry time in BUSINESS DAYS for a package.

Usage Details

The following provides more details descriptions for some of the parameters on this data type.

Parameter	Detailed Description
authenticate	The parameter must be passed as TRUE or FALSE. If TRUE then the packages will be subject to secondary authentication according to the skin setup. Please see the web services guide for more information on secondary authentication.
initiator	This account must exist within the SDX system, it must have rights to send packages and it will receive the final completed workflow or any rejections. The username must not include the context id. An initiator cannot also be a participant
reminderInterval	Valid values include: x,y, z, and nr. The values define reminder after x, y and z hours (as in 1,2,3) and nr: which means every n hours (as in 6r).
expiryPeriod	Each participant will have this amount of time from when their element of the package was submitted to them in which to respond. So each signer will have expiryPeriod in which to sign/reject the package. So an expiryPeriod of 10 will allow the user 10 business days to sign.