ViewSign Professional Integration Guide: Difference between revisions

From ViewSonic Documentation
Jump to: navigation, search
Line 11: Line 11:


The following parameters are supported:
The following parameters are supported:
{| class="wikitable" width=auto style="background-color:#FFFFFF";
{| class="wikitable" width=auto
!style="background-color:#c41230; color:#ffffff;"|Parameter  
!style="background-color:#c41230; color:#ffffff;"|Parameter  
!style="background-color:#c41230; color:#ffffff;"| Description
!style="background-color:#c41230; color:#ffffff;"| Description

Revision as of 08:59, 1 September 2020

Client Integration Guide

This guide describes integration scenarios for the Client. It is intended for the integrator (software developer/customizer) at your organization.

Command Line

You can start xyzmo Client via the command line.

To start xyzmo Client

  • Run the following command:
SIGNificantOfflineClient.exe filename

The following parameters are supported:

Parameter Description
-b64 Mark filename as base64 encoded. Must be before the filename. This is useful for filenames containing special characters.

Example: SignificantOfflineClient.exe -b64 "ASDLFKJASLDFKJ ALSK=="

filename The full path and filename of the file that xyzmo Client should open.

Example: c:\Temp\document.pdf

/DisableStringRemoving Disables the removing of Sig-/Ord-/Attachment-/… Strings from the document when it’s loaded.
/disablesigstringparsing Disables Sig String parsing.
/disableordstringparsing Disables Ord String parsing.
/signatureTemplate This parameter tells the client to take the Signature Template XML given with its full path to create and position signature fields. Refer to the appropriate chapter for more details.
/config This parameter takes an alternative _global.xml from a given path.

Note: This will be supported in future version.

/attachAsFile This parameter takes a file and attaches it as file attachment. A full qualified path name is required.

Example: /attachAsFile c:\testfiles\test.pdf /attachAsFile "\\testres.trosoft.local\testfiles\test.xml" => this would attach the file c:\testfiles\test.pdf and c:\test2\test.doc

/attachAsPage This parameter takes a file and attaches it as additional page. A full qualified path name is required.

Example: /attachAsPage "\\testres.trosoft.local\testfiles\test.pdf" /attachAsPage c:\test2\test.jpg => This would attach the file c:\testfiles\test.pdf and c:\test2\test.jpg as additional pages.

/sq This parameter limits signing to a certain signature field given by the given sequence number (only for stepping and autostep)

Example (doc. contains fields with sq=1 to sq=10): /sq 1 /sq 2 /sq 5 => this limits signing to the signature fields with sq=1, 2 and 5. Example (doc. contains fields with no sq numbers): /sq 1 /sq 2 /sq 5 => this effectively disables signing of existing signature fields. Example (doc. contains fields with sq=1 to sq=10): /sq 1 /sq 2 /sq 15 => this limits signing to the signature fields with sq=1, 2; 15 is ignored

/username This parameter limits signing to the signature fields of a specific user

Example: /username userA /username LoggedOnUser - the logged on user; which is "userA" for example. => If a username is given, the user is only allowed to sign the signature fields for the given username.

/cbv1; /cbv2; /cbv3 Additional cmd parameters, will be passed to a custom action.

Signature Strings

Signature Templates

Customization

FAQ