Initialization Parameters

The following table contains a list of some of the configurable options when initializing the Viewing Client plugin. For additional configuration options, refer to the Namespace: fn API topic.

Parameter	Data Type	Description
annotationID	String	Specifies the annotation file to be used within the Viewing Client. For example: When the annotation is saved, the Viewing Client prompts the user to provide the annotation name (example: myTestAnnotation). The annotation file is saved with this naming convention: <documentID>_<annotationName>.xml (example: F7-92-5C-CE-28-BE-AD-6F-79-C3-FE-FF-87-FE-FA-B6-73-7F-F5-92_0_myTestAnnotation.xml). When specifying the value for the annotationID, it will be the annotation name that was provided at the time of saving (example: stampAnnotation), not the annotation file name (F7-92-5C-CE-28-BE-AD-6F-79-C3-FE-FF-87-FE-FA-B6-73-7F-F5-92_0_myTestAnnotation.xml).
autoLoadAnnotation	Boolean	If set to True, the specified annotation file will be loaded when the Viewing Client launches resourcePath.
debug	Boolean	If true, Viewing Client logs to the console. If false or no value, Viewing Client will not log to the console.
documentID	String	Specifies the document to be loaded within the Viewing Client.
encryption	Boolean	Specifies whether content encryption is turned on or off.
imageHandlerUrl	String	Specifies the location of the image handler.
language	Object	An object containing the contents of the language.json file.
predefinedSearch	Object	An object containing all predefined search options. These are defined in the predefinedSearch.json file. See Pre-loaded Search for more information.
resourcePath	String	The location of the images used in the Viewing Client.
serviceResponseTimeout	Integer	Indicates the response timeout interval, in milliseconds, for all services to the server. Default is 60000.
signatureCategories	String	Specifies the categories of E-Signature to add to the UI. This is a comma separated string containing the types of signatures that the application expects. When no value is passed in, the UI to select categories will be disabled. Example: "Full Signature,Initials,Name,Title"
template	Object	An object containing the different templates used in the Viewing Client.
uiElements	Object	An object containing parameters that toggle UI elements in the Viewing Client. See uiElements for more information.