TrustCenterSendToSign

CAUTION! It is recommended to use a TrustCenterSendToSignEx() function instead.

Sends document with the list of persons to Trust Center.

Syntax

TrustCenterSendToSign("documentField","documentName","documentDescription","creator","signersTable")

TrustCenterSendToSign("documentField","documentName","documentDescription","creator","signersTable","mapping")

TrustCenterSendToSign("documentField","documentName","documentDescription","creator","signersTable","mapping","signatureOptions")

Function arguments

• Document – (UNKNOWN) Document to sign. It can be value of document field or AttId of attachment
• DocumentName – (String) Name of the document, if empty then name of the file will be used
• DocumentDescription – (String) Description of the document
• Creator – (UNKNOWN) User that will be set as creator of the signing process
• TableName – (String) Name of the table with signers list.
• TableFieldsMapping – (Object) [Optional] Mapping of fields from table with signers list. If empty string then default mapping is used. Signers list have to contains columns with names (not display names): FirstName, LastName, CompanyRole, Company, Email, Phone
• Signature options – (Object) [Optional] Signature options to use in Trust Center. Allow to change which authorization or signing options are available. If empty string then default options are used. Allowed properties with their default values:
  • „RequireEmailCodeToOpenDocument”: false,
  • „RequireSMSCodeToOpenDocument”: false,
  • „CallbackRule”: „”,
  • „AllowHandwrittenSignature”: true,
  • „AllowHandwrittenSignatureWithSMS”: true,
  • „AllowQualifiedSignature”: true,
  • „AllowSimpleSignature”: false,
  • „AllowSMSSignature”: true,
  • „AllowToAddNewSigners”: true,
  • „AllowToReplaceSigners”: true,
  • „Language”: „en-GB”,
  • „PartialSigning”: false .

If some option is not specified then default property value is used.

Return value

This function returns String. Returns empty string if document were successfully sent to TrustCenter, otherwise returns error description if something went wrong.

Examples

Example 1: This will send document from Agreement field to Trust Center with current user as a creator along with data of people listed in Signers table

TrustCenterSendToSign([Agreement], [DocumentName], [DocumentDescription], CurrentUser(), "Signers")

Example 2: This will send document from Agreement field to Trust Center with current user as a creator along with data of people listed in Signers table. users who login will not be proptem about SMS code, and Trust Center language and emails will be set to polish language by default.

options.Language="pl-PL";
options.RequireSMSCodeToOpenDocument="false";
TrustCenterSendToSign([Agreement], [DocumentName], [DocumentDescription], CurrentUser(), "Signers", "", options)

Example 3: This will send document from Umowa field to Trust Center with current user as a creator along with data of people listed in Podpisujący table. Names of the fields from Podpisujący table are in polish so they are mapped in map variable.

map.FirstName="Imię"
map.LastName="Nazwisko"
map.CompanyRole="Stanowisko"
map.Company="Spółka"
map.Email="Adres email"
map.Phone="Telefon"
TrustCenterSendToSign([Umowa], [DocumentName], [DocumentDescription], CurrentUser(), "Podpisujący",map)

Example 4: This will send document from Umowa field to Trust Center with current user as a creator along with data of people listed in Podpisujący table with default mapping. In this case users do must enter email code but do not have to enter SMS code. Signers will be able to sign using default signature types while being able to add new people to signature.

options.RequireEmailCodeToOpenDocument="true"
options.RequireSMSCodeToOpenDocument="false"
options.AllowToAddNewSigners="true"
TrustCenterSendToSign([Umowa], [DocumentName], [DocumentDescription], CurrentUser(), "Signers","", options)

Example 5: This will send document from Umowa field to Trust Center with current user as a creator along with data of people listed in Podpisujący table with default mapping. In this case users must enter email and sms code to authorize. After successfull authorization signers will be able to sign document using only simple signature and they cannot be able to add new people to sign document.

options.RequireSMSCodeToOpenDocument="true"
options.RequireEmailCodeToOpenDocument="false"
options.AllowSimpleSignature="true"
options.AllowSMSSignature="false"
options.AllowHandwrittenSignature="false"
options.AllowHandwrittenSignatureWithSMS="false"
options.AllowQualifiedSignature="false"
options.AllowToAddNewSigners="false"
TrustCenterSendToSign([Umowa], [DocumentName], [DocumentDescription], CurrentUser(), "Signers","", options)