If you have a problem understanding how the action works, check: Action, Conditional execution, Components parameters
Basic information
Category: eSignature
Action location: Button, Table button
Available from version: 1.0.0
Description
The action places an electronic signature on documents using a certificate using the Szafir module containing cryptographic tools. The resulting signature files are cumulative signatures, i.e. they contain signed data that is attached to the signature file and encoded using Base64. The action, when signing more than one document, does not stop its operation when it encounters an error with a specific document on the side of the Szafir application - after completing the signing operation, the displayed summary window shows information on the number of correctly signed documents and those that could not be signed. Signed documents are saved in the system archive.
Prerequisites
For the action to work properly, download and install:
- dedicated version of the Szafir SDK Web browser extension
- SzafirHost application
Action call-up
Leaving an empty conditional field is equal to setting it to "true".
Action location | From version | Conditional execution parameter action | Action call-up condition |
|---|---|---|---|
Button | 1.0.0 | Activates action | Pressing the button |
| Table button | 1.0.0 | Activates action | Pressing the button |
Configuration parameters
| Parameter name | From version | Description | Paremeter type | Default value | Field type | Comments and restrictions | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Files download source* | 1.0.0 | Specifies the source from which the files to be signed are to be downloaded. There are 3 options:
| Text | Uneditable drop-down list |
If you select "Process" or "Archive", the latest version of the document will be downloaded. | |||||||||||||||||||||||||||||||||||||||||||||||||
| Document classes [Process] | 1.0.0 | The names of the classes of documents from which the documents are retrieved. | Text values array | Uneditable drop-down list | In case of an empty document class names table (parameter not completed), all documents attached to the process will be downloaded. | |||||||||||||||||||||||||||||||||||||||||||||||||
| Document class [Archive]* | 1.0.0 | Name of the document class from which the documents are retrieved. | Text | Uneditable drop-down list | ||||||||||||||||||||||||||||||||||||||||||||||||||
| Index name [Read] | 1.0.0 | Optional filtering by indexes of the selected document class. This parameter specifies the name of the index. | Text values array | Uneditable drop-down list / editable field | List of indexes to choose from after selecting a specific class of documents. If a variable or function is used in the Document class [Archive] parameter, the field of this parameter becomes an editable field. | |||||||||||||||||||||||||||||||||||||||||||||||||
| Index value [Read] | 1.0.0 | Optional filtering by indexes of the selected document class. This parameter specifies the index value. | Text values array | Editable field | ||||||||||||||||||||||||||||||||||||||||||||||||||
| File identifiers | 1.0.0 | IDs of files to be downloaded from the archive. | Integer values array | Editable field | ||||||||||||||||||||||||||||||||||||||||||||||||||
| Mode of operation* | 1.0.0 | Defines how the Szafir application works. The "Szafir window" mode enables the creation of a signature using the native graphical user interface. On the other hand, the "Window with PIN code and optional certificate selection" mode performs the signing with the use of a dialog in which the PIN for the cryptographic device and optionally the certificate file are entered. | Text | Uneditable drop-down list |
Selecting the "Szafir window" value results in the appearance of the Certificate parameter, and selecting "Window with PIN code and optional certificate selection" - the Certificate parameter and the User selects certificate. | |||||||||||||||||||||||||||||||||||||||||||||||||
| Certificate* | 1.0.0 | File name containing the certificate configuration, which comes from the Plugin Configuration Manager (PCM) panel. The parameter presents a list of all created files with the certificate configuration. | Text | Uneditable drop-down list | ||||||||||||||||||||||||||||||||||||||||||||||||||
| User selects certificate | 1.0.0 | Specifies whether the user on the form can select the certificate file from the Plugin Configuration Manager (PCM) panel. The selection is possible from the level of the dialog box that appears while the Szafir application is running and includes the certificates specified in the Available certificates parameter. | Boolean | Nie | Editable field | Setting the parameter to "Yes" causes the appearance of the Available certificates parameter and hides the Certificate parameter, while setting the parameter to "No" leaves the Certificate visible. | ||||||||||||||||||||||||||||||||||||||||||||||||
| Available certificates | 1.0.0 | It defines the files with the certificate that can be selected by the user on the form from the level of the dialog box. The parameter presents a list of all created files with the certificate configuration. | Text values array | Uneditable drop-down list | ||||||||||||||||||||||||||||||||||||||||||||||||||
| Signature version* | 1.0.0 | Specifies a signature version.
| Text | Uneditable drop-down list |
| |||||||||||||||||||||||||||||||||||||||||||||||||
| Signature format* | 1.0.0 | Specifies the signature format. The parameter presents the list of available formats depending on the selected signature version.
| Text | Uneditable drop-down list |
| |||||||||||||||||||||||||||||||||||||||||||||||||
| Debug mode | 1.0.0 | Opens the console window of the SzafirHost application while the action is running. | Boolean | No | Editable field | |||||||||||||||||||||||||||||||||||||||||||||||||
| Incorrectly processed fileIds | 1.0.0 | Returns the table of identifiers of files with an error while inserting the signature. | Variable | Editable field | ||||||||||||||||||||||||||||||||||||||||||||||||||
| Incorrectly processed file names | 1.0.1 | Returns the table of namesof files with an error while inserting the signature. | Variable | Editable field | ||||||||||||||||||||||||||||||||||||||||||||||||||
| Error descriptions | 1.0.0 | Returns an array of error descriptions for incorrectly processed files from the Incorrectly processed fileIds and Incorrectly processed file names parameter. | Variable | Editable field | ||||||||||||||||||||||||||||||||||||||||||||||||||
| Save as new version* | 1.0.0 | If set to "Yes", the signature file will be saved as a new version of the input document. If set to "No", the signature file will be saved in the specified document class and indices as a new document. | Boolean | Yes | Editable field | |||||||||||||||||||||||||||||||||||||||||||||||||
| Document class [Save] | 1.0.0 | The name of the document class where the file with the signature will be saved. | Text | Uneditable drop-down list | ||||||||||||||||||||||||||||||||||||||||||||||||||
| Index name [Save] | 1.0.0 | The name of the index from the selected document class. | Text values array | Uneditable drop-down list / editable field | List of indexes to choose from after selecting a specific class of documents. If a variable or function is used in the Document class [Save] parameter, the field of this parameter becomes an editable field. | |||||||||||||||||||||||||||||||||||||||||||||||||
| Index value [Save] | 1.0.0 | Index value from the selected document class. | Text values array | Editable field | ||||||||||||||||||||||||||||||||||||||||||||||||||
| Add document to process | 1.0.0 | Attaches a signature file to the process. | Boolean | No | Editable field | |||||||||||||||||||||||||||||||||||||||||||||||||
| Execute actions in the document class | 1.0.0 | It calls actions which have the source of action set to "Add new document in archive". | Boolean | No | Editable field |
Parametr*- mandatory field
Configuration example
Example of operation
An example of operation based on the action configuration below.
One document with the given index values is signed and its content with the signature will be saved as a new version of the document. After clicking on the button on the form under which the action is defined, a dialog box for entering the PIN code and selecting the certificate will open. In the "Certificate" field, you can choose from two certificate configuration items based on the "Available certificates" parameter configured in this action.
After approval, the document is signed. In this mode, the native Szafir application window does not open. The signature operation is entirely based on the contents of the certificate configuration file. After the action is completed, the signature operation summary window appears. During the action, the console of the SzafirHost application is launched.
Change log
1.0.0
- Adding a component
Package with a sample form using the action
