REST Settings

The REST settings allows you manage REST API specific settings including connection options, storage directory, number of threads used by processes when making REST API calls to the server.

To view the REST Settings: Go to Preferences Panel > REST Tab

Settings

General

Rest Server - Sets the IP address to receive REST calls from on the server. When set to a specific address calls can only be made to the server from that address. If 0.0.0.0 is selected the server will serve REST resources on all available network interfaces.

Content Provider: Sets the content provider (where the files are stored and managed) for the PAS service

PAS Storage: The default value that uses the directory set in the "Storage Directory" option. This directory is local to where the server is running.
Alfresco: Integrates with an Alfresco Document Management server. The Alfresco provider is configured with alfresco.properties in the QoppaPAS directory within Progam Data. The server must be restarted to access new properties. See Alfresco Setup for more information

Storage Directory - enter the complete file path to the directory you wish to have all of the REST files stored on the server.

Note: This directory is local to where the server is running not the PAS Manager and so the file path must follow the format set by the OS of the server.

CPU threads - the number of threads (cores) on the server you want to be used by REST processes. The number to the right of the field will display the total number of cores available on the server.

Allow Origin - Setting that lets you access REST services from another domain. It will set the value of the "Access-Control-Allow-Origin" response header.

HTTP

Enable HTTP - enables HTTP access to a specified port

HTTP Port - port to be used for HTTP access. The default setting is 8090.

Note: The HTTP Port cannot match the HTTPS or RMI (default 1099) port settings

HTTPS

Enable HTTPS - enables HTTPS access to a specified port

HTTPS Port - port to be used for HTTPS access. The default setting is 8091.

Note: The HTTPs Port cannot match the HTTP or RMI (default 1099) port settings

PKCS#12 File - enter the complete file path to the PKCS#12 file (.pfx or .p12) used by HTTPS calls made to the server.

Note: This directory is local to where the server is running not the PAS Manager and so the file path must follow the format set by the OS of the server.

Password - The password to access the keystore file

Default Signature

Signature File - The full path to the Digital ID file used in the signature on the server. Accepted formats are .p12 & .pfx.

Note: This directory is local to where the server is running not the PAS Manager and so the file path must follow the format set by the OS of the server.

Password - The password needed to open the Digital ID file

Load IDs - When clicked will display the Digital IDs stored within the file

Digital IDs - Displays a list of all the digital IDs stored within the signature file

ID Password - The password for the selected digital ID. You must enter the correct password in order to be able to digitally sign the document

Signature Information

Format: The format to be used when encrypting the signature

Signature - A digital signature contains encrypted information that is unique to the signer so it cannot be forged. The signer’s certificate or issuing third-party Certificate Authority will need to be trusted by the user receiving the PDF in order for the signature to be considered valid. Once signed, if the document is modified in any way the signature will no longer be considered valid.

Certifying Signature - A certified signature provides additional document security options to prevent the document from being modified. When choosing certifying signature, a combo box will show, allowing to specify which changes are permitted on the certified document.

Disallow Changes: Does not allow any further changes to the document once signed
Allow Form fill and Signatures: Allows users to fill forms and complete signatures once signed
Allow Form fill, Signatures, and Comments: Allows users to fill forms, complete signatures, and add comments to the document once signed

Reason - Select a reason the document was signed from the list from the below options

I approve this document
I am the author of this document
I have reviewed this document
I attest to the accuracy and integrity of this document
I agree to the terms defined by this document

Location - Enter additional location details

Contact Information - Enter additional contact information for the signature

Timestamp Server

Use Timestamp Server: Check this option to use a timestamp server during the signing process

URL - the URL of the timestamp server

TSA Requires Authentication - check this box if the server requires authentication

User name - the user name for authentication on the timestamp server

Password - the password for authentication on the timestamp server

Signature Appearance

Image

Show Image - When checked an image can be added to the background of the digital stamp appearance

File - The full path to the image file used in the signature on the server. Accepted formats are jpg, png, gif, & tiff.

Note: This directory is local to where the server is running not the PAS Manager and so the file path must follow the format set by the OS of the server.

Align - Allows you to align the image on the left, center, or right of the signature

Transparency - Transparency setting for the image

Text

Show - The options below, when checked, set which digital signature properties will be displayed on the signature

Name: The large text that will display the name
Digitally signed by: Adds the text "Digitally signed by" before the Common Name
Date: Date the signature was completed
Common Name: The name associated with the digital ID
Organizational Unit: The organizational unit associated with the digital ID
Organization Name: The organization name associated with the digital ID
Locality/City: the locality/city associated with the digital ID
State: The state associated with the digital ID
Country: The country associated with the digital ID
Email: The email associated with the digital ID

Orientation - Sets the digital signature text to be displayed with one of two options

Left to Right: Displays the Name on the left and all other properties in smaller text on the right
Right to Left: Displays the Name on the right and all other properties in smaller text on the left