If you have a problem understanding how the action works, check: Automatic tasks, Conditional execution, Components params
Basic information
Category: Attachment
Available from version: 1.0.23
Description
The component adds a watermark to documents in PDF format of a specified class of documents attached to the process. The revised document file is added as a new document version. The original document (without the watermark) is available in the oldest version of the document.
Configuration parameters
Parameter name | From version | Description | Paremeter type | Default value | Field type | Comments and restrictions | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Watermark type* | 1.0.1 | Specifies what type of watermark is. | Text |
| Values list |
| ||||||||||||||||||||||||||||||
| Document class* | 1.0.1 | Name of the document class whose documents will be modified by inserting a watermark. | Text | Values list | ||||||||||||||||||||||||||||||||
| Text* | 1.0.1 | Takes the text value that is used to create the watermark. In order to use document index values, the index id should be enclosed in curly braces {}. It is possible to use more than one index value in a parameter. Each subsequent index must be followed by curly braces. Example: Case number: "{8}, Registration Date {9}" Watermark text -> Case number: 433589, Registration Date: 13-02-2021 It is also possible to use special keywords that return information about the user, process id and activity id. All available values are listed in the next column.
Example: "Username: {USER_NAME}, Date: {CURRENT_DATE}" Watermark text -> "Username: admin, Date: 2022-10-21" | Text | Editable field | Any typed index ids in the text string must exist in the document class specified by the Document Class parameter. If the document being viewed does not contain an index value (it is empty) whose id is given in curly braces in this parameter, the id will be replaced with the empty string "".
| |||||||||||||||||||||||||||||||
| Page corner* | 1.0.1 | Specifies relative to which of the four corners of the document page the position of the watermark will be calculated based on the Position X% and Position Y% parameters.
| Text | TOP_LEFT | Values list | Pay attention to the corresponding values of the Position X% and PositionY % parameters, because depending on the value of the Alignment, Anchor parameter, and the size of the watermark, the watermark may extend beyond the document page, i.e. be partially or completely invisible.
| ||||||||||||||||||||||||||||||
| Anchor* | 1.0.1 | Specifies a point in the circumference or in the center of the watermark from which the position of the watermark is determined based on the values of parameters Position X% and Position Y%.
| Text | BOTTOM_LEFT | Values list |
| ||||||||||||||||||||||||||||||
| Position X%* | 1.0.1 | Indicates the X (horizontal) position of the watermark in percent relative to the document page dimensions. The position is set based on the selected page corner in the Alignment parameter. | Integer | 5 | Editable field | Value between 0 and 100. | ||||||||||||||||||||||||||||||
| PositionY%* | 1.0.1 | Indicates the Y (vertical) position of the watermark in percent relative to the document page dimensions. The position is set based on the selected page corner in the Alignment parameter. | Integer | 10 | Editable field | Value between 0 and 100. | ||||||||||||||||||||||||||||||
| Opacity* | 1.0.1 | Specifies the degree of visibility of the inserted watermark. | Float | 1 | Editable field |
The element is fully transparent (invisible).
The item is partially transparent.
The element is fully opaque (uniform). | ||||||||||||||||||||||||||||||
| Rotation degrees* | 1.0.1 | Specifies rotation of the watermark by the specified degrees amount. The text watermark is rotated clockwise. However, the direction of rotation of the barcode watermark depends on the value of the Rotation mechanism parameter. | Float | 0 | Editable field | |||||||||||||||||||||||||||||||
| Remove password from the file* | 1.0.2 | Removes the file's password that protects it from being modified. The file's new version has no security compared to its original version. The parameter does not take into account the removal of the file password that was used to prevent the file from being opened. | Boolean | No | Editable field | |||||||||||||||||||||||||||||||
| Format* | 1.0.1 | Specifies the barcode format. | Text | CODE_128 | Values list |
| ||||||||||||||||||||||||||||||
| Width* | 1.0.1 | Defines the width of the barcode in pixels. | Integer | 40 | Editable field | Specifies the minimum width of the barcode. In case the value to be encoded from the text parameter turns out to be too long, the width will be increased. | ||||||||||||||||||||||||||||||
| Height* | 1.0.1 | Defines the height of the barcode in pixels. | Integer | 15 | Editable field | |||||||||||||||||||||||||||||||
| Display text below the barcode* | 1.0.1 | Specifies whether to display the text encoded in the barcode below this barcode. | Boolean | No | Editable field | The text has a fixed font size of 11 and black color. | ||||||||||||||||||||||||||||||
| Rotation Mechanism | 1.0.8 | Specifies how a barcode watermark rotation should work. Method 1 - (obsolete) rotation is based on the basic functions of the library. The rotation for the barcode watermark is counterclockwise. Method 2 (recommended) - rotation takes place relative to the watermark point specified in the Anchor parameter. The rotation is clockwise for the barcode watermark. Parameter is optional. If left blank, Method 1 will be used. | Text | Editable field |
| |||||||||||||||||||||||||||||||
| Font size* | 1.0.1 | Text size. | Float | 15 | Editable field | |||||||||||||||||||||||||||||||
| Font type* | 1.0.1 | Text font type. | Text | HELVETICA | Values list |
| ||||||||||||||||||||||||||||||
| Color* | 1.0.1 | Color of the text. | Text | LIGHT_GRAY | Values list |
| ||||||||||||||||||||||||||||||
| Coding* | 1.0.1 | Character encoding standard.
| Text | CP1250 | Values list |
| ||||||||||||||||||||||||||||||
| Display text background* | 1.0.1 | Sets the background for a text watermark with dimensions the same as the length and width of the text. | Text | No | Editable Field | |||||||||||||||||||||||||||||||
| Background color | 1.0.1 | Sets the background for a text watermark with dimensions the same as the length and width of the text. If the parameter is not completed (empty), the background will not be used. | Logical | Values list |
|
Parameter*- mandatory field
Configuration example
Example of use
An example of operation for the above application configuration.
Original document:
After change:
Change log
1.0.1 (applicable documentation)
- Component adding
1.0.2 (applicable documentation)
- Adding "Remove password from the file" parameter for password-protected files
1.0.4 (applicable documentation)
- Adding keywords to use in the text parameter
1.0.8
- Adding Rotation Mechanism parameter that changes the barcode rotation behavior
Add Comment