View Source

Jeśli masz problem ze zrozumieniem jak działa zadanie automatyczne, sprawdź opisy: Zadanie automatyczne, Wykonanie warunkowe, Parametry komponentów

Kategoria: Watermark

Dostępne od wersji: 1.0.1

Komponent dodaje znak wodny do podpiętych w procesie dokumentów w formacie PDF określonej klasy dokumentów. Zmieniony plik dokumentu jest dodawany jako nowa wersja dokumentu. Oryginalny dokument (bez znaku wodnego) jest dostępny w najstarszej wersji dokumentu.

Nazwa parametru

Od wersji

Opis

Typ parametru

Wartość domyślna

Rodzaj pola

Uwagi i ograniczenia

Rodzaj znaku wodnego*

1.0.1

Określa typ znaku wodnego.

Tekstowy

Lista wartości

Wartość wyświetlana	Opis
Kod kreskowy	Koduje wartość parametru Tekst do postaci kodu kreskowego o określonym formacie zdefiniowanym w parametrze Format. Znak wodny umieszczany na dokumencie jest kodem kreskowym.
Tekst	Wartość parametru Tekst jest nanoszona na dokument jako znak wodny w formie jawnej, niezakodowanej.

Klasa dokumentów*

1.0.1

Nazwa klasy dokumentów, której dokumenty będą modyfikowane poprzez wstawienie znaku wodnego.

Tekstowy

Lista wartości

Tekst*

1.0.1

Przyjmuje wartość tekstową, która jest wykorzystywana do utworzenia znaku wodnego. W celu skorzystania z wartości indeksów dokumentu należy umieścić identyfikator indeksu w nawiasach klamrowych {}. Istnieje możliwość wykorzystania więcej niż jednej wartości indeksu w parametrze. Każdy kolejny indeks musi być opatrzony nawiasami klamrowymi.

Przykład.

"Numer sprawy: {8}, Data rejestracji: {9}"

Tekst znaku wodnego ->

Numer sprawy: 433589, Data rejestracji: 13-02-2021

Możliwe jest również skorzystanie ze specjalnych słów kluczowych zwracających informacje o użytkowniku, identyfikatorze procesu i zadania. Lista wszystkich dostępnych wartości znajduje się w kolumnie obok.

Przykład:

"Nazwa użytkownika: {USER_NAME}, Data: {CURRENT_DATE}"

Tekst znaku wodnego ->

"Nazwa użytkownika: admin, Data: 2022-10-21"

Tekstowy

Pole edytowalne

Wszystkie wpisane identyfikatory indeksów w ciągu tekstowym muszą istnieć w klasie dokumentów podanej w parametrze Klasa dokumentów. Jeśli przeglądany dokument nie zawiera wartości indeksu (jest pusty), którego identyfikator został podany w tym parametrze w nawiasach klamrowych, to identyfikator zostanie zastąpiony pustym łańcuchem znaków "".

Słowo kluczowe	Opis
{CURRENT_DATE}	Bieżąca data w formacie yyyy-MM-dd.
{CURRENT_DATE_AND_TIME}	Bieżąca data i czas w formacie yyyy-MM-dd HH-mm-ss.
{PROCESS_ID}	Identyfikator procesu.
{ACTIVITY_ID}	Identyfikator zadania.
{USER_NAME}	Nazwa użytkownika.
{USER_EMAIL}	Email użytkownika.
{USER_FULL_NAME}	Pełna nazwa użytkownika składająca się na imię i nazwisko.
{USER_FIRST_NAME}	Imię użytkownika.
{USER_LAST_NAME}	Nazwisko użytkownika.
{USER_NUMBER}	Numer użytkownika.

Róg strony*

1.0.1

Określa względem którego z czterech rogów strony dokumentu obliczona zostanie pozycja znaku wodnego na podstawie wartości parametrów Pozycja X% oraz Pozycja Y%.

Więcej informacji...

Tekstowy

TOP_LEFT

Lista wartości

Należy zwrócić uwagę na odpowiednie wartości parametrów Pozycja X% oraz Pozycja Y%, ponieważ w zależności od wartości parametru Róg strony, Kotwica oraz rozmiarów znaku wodnego, znak wodny może wykraczać poza stronę dokumentu, czyli być częściowo lub wcale niewidoczny.

Wartość wyświetlana	Wartość przekazywana
Górny lewy róg dokumentu	TOP_LEFT
Górny prawy róg dokumentu	TOP_RIGHT
Dolny lewy róg dokumentu	BOTTOM_LEFT
Dolny prawy róg dokumentu	BOTTOM_RIGHT

Kotwica*

1.0.1

Określa punkt na obwodzie znaku wodnego lub na jego środku, na podstawie którego określane jest położenie znaku wodnego biorąc pod uwagę wartości parametrów Pozycja X% oraz Pozycja Y%.

Więcej informacji...

Tekstowy

BOTTOM_LEFT

Lista wartości

Wartość wyświetlana	Wartość przekazywana
Górny lewy róg znaku wodnego	TOP_LEFT
Górny środek znaku wodnego	TOP_MIDDLE
Górny prawy róg znaku wodnego	TOP_RIGHT
Lewy środek znaku wodnego	CENTER_LEFT
Środek znaku wodnego	CENTER_MIDDLE
Prawy środek znaku wodnego	CENTER_RIGHT
Dolny lewy róg znaku wodnego	BOTTOM_LEFT
Dolny środek znaku wodnego	BOTTOM_MIDDLE
Dolny prawy róg znaku wodnego	BOTTOM_RIGHT

Pozycja X%*

1.0.1

Wskazuje pozycję procentową X (w poziomie) znaku wodnego względem wymiarów strony dokumentu. Pozycja ustawiana jest na podstawie wybranego rogu strony w parametrze Róg strony.

Całkowity

5

Pole edytowalne

Wartość z przedziału 0 -100.

Pozycja Y%*

1.0.1

Wskazuje pozycję procentową Y (w pionie) znaku wodnego względem wymiarów strony dokumentu. Pozycja ustawiana jest na podstawie wybranego rogu strony w parametrze Róg strony.

Całkowity

10

Pole edytowalne

Wartość z przedziału 0 -100.

Przezroczystość*

1.0.1

Określa stopień widoczności wstawianego znaku wodnego.

Zmiennoprzecinkowy

1

Pole edytowalne

Wartość 0 (lub mniej)

Element jest w pełni przezroczysty (niewidoczny).

Wartość z przedziału (0, 1)

Element jest częściowo przezroczysty.

Wartość 1 (lub więcej)

Element jest w pełni nieprzezroczysty (jednolity).

Stopnie rotacji*

1.0.1

Określa rotację (obrót) znaku wodnego o zadaną wartość w stopniach. Znak wodny w formie tekstu jest obracany zgodnie z kierunkiem ruchu wskazówki zegara. Natomiast kierunek obrotu znaku wodnego w formie kodu kreskowego jest zależny od wartości parametru Mechanizm rotacji.

Zmiennoprzecinkowy

0

Pole edytowalne

Usuń hasło z pliku*

1.0.2

Usuwa hasło, zabezpieczenia pliku chroniące przed jego modyfikacją. Nowa wersja pliku nie posiada żadnych zabezpieczeń w porównaniu z jego pierwotną wersją. Parametr nie uwzględnia usuwania hasła użytkownika (odczytu), które zostało użyte w celu zabezpieczenia dokumentu przed otwarciem.

Logiczny

Nie

Pole edytowalne

Format*

1.0.1

Określa standard kodu kreskowego.

Więcej informacji...

Tekstowy

CODE_128

Lista wartości

Dostępne wartości
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
ITF
PDF_417
QR_CODE
UPC_A
UPC_E

Szerokość*

1.0.1

Definiuje szerokość kodu kreskowego w pikselach.

Całkowity

40

Pole edytowalne

Określa minimalną szerokość kodu kreskowego. W przypadku, gdy wartość do zakodowania z parametru Tekst okaże się zbyt długa, szerokość zostanie zwiększona.

Wysokość*

1.0.1

Definiuje wysokość kodu kreskowego w pikselach.

Całkowity

15

Pole edytowalne

Wyświetl tekst pod kodem kreskowym*

1.0.1

Określa, czy ma być wyświetlany pod kodem kreskowym tekst (wartość parametru Tekst), który został w nim zakodowany.

Logiczny

Nie

Pole edytowalne

Tekst ma stały rozmiar czcionki 11 i kolor czarny.

Mechanizm rotacji

1.0.8

Określa w jaki sposób ma działać rotacja kodu kreskowego. Sposób 1 - (przestarzały) rotacja odbywa się na zasadach podstawowej funkcji biblioteki. Rotacja dla znaku wodnego w formie kodu kreskowego wykonuje się w przeciwnym kierunku do ruchu wskazówek zegara Sposób 2 (zalecany) - rotacja odbywa się względem punktu znaku wodnego określonego w parametrze anchor. Rotacja kodu kreskowego wykonuje się w kierunku zgodnym do ruchu wskazówek zegara. Parametr jest opcjonalny. W przypadku pozostawienia go pustego, zostanie zastosowany Sposób 1.

Tekstowy

Pole edytowalne

Wartość wyświetlana	Wartość przekazywana
Sposób 1	METHOD_1
Sposób 2	METHOD_2

Rozmiar czcionki*

1.0.1

Rozmiar tekstu.

Zmiennoprzecinkowy

15

Pole edytowalne

Rodzaj czcionki*

1.0.1

Rodzaj czcionki tekstu.

Tekstowy

HELVETICA

Lista wartości

Wartość	Opis
COURIER	Courier
COURIER_BOLD	Courier Bold
COURIER_OBLIQUE	Courier Oblique
COURIER_BOLDOBLIQUE	Courier Bold Oblique
HELVETICA	Helvetica
HELVETICA_BOLD	Helvetica Bold
HELVETICA_OBLIQUE	Helvetica Oblique
HELVETICA_BOLDOBLIQUE	Helvetica Bold Oblique
SYMBOL	Symbol
TIMES_ROMAN	Times Roman
TIMES_BOLD	Times Bold
TIMES_ITALIC	Times Italic
TIMES_BOLDITALIC	Times Bold Italic
ZAPFDINGBATS	Zapf Dingbats

Kolor*

1.0.1

Kolor tekstu.

Tekstowy

LIGHT_GRAY

Lista wartości

Wartość	Opis
WHITE	Biały
LIGHT_GRAY	Jasnoszary
GRAY	Szary
DARK_GRAY	Ciemnoszary
BLACK	Czarny
RED	Czerwony
PINK	Różowy
ORANGE	Pomarańczowy
YELLOW	Żółty
GREEN	Zielony
MAGENTA	Magenta
CYAN	Cyjan
BLUE	Niebieski

Kodowanie*

1.0.1

Kodowanie znaków.

Więcej informacji...

Tekstowy

CP1250

Lista wartości

Dostępne wartości
CP1250
CP1252
CP1257
MACROMAN

Kolor tła

1.0.1

Ustawia tło dla tekstowego znaku wodnego o wymiarach takich samych jak długość i szerokość tekstu. W przypadku braku uzupełnienia parametru, tło nie zostanie użyte.

Tekstowy

Lista wartości

Wartość	Opis
WHITE	Biały
LIGHT_GRAY	Jasnoszary
GRAY	Szary
DARK_GRAY	Ciemnoszary
BLACK	Czarny
RED	Czerwony
PINK	Różowy
ORANGE	Pomarańczowy
YELLOW	Żółty
GREEN	Zielony
MAGENTA	Magenta
CYAN	Cyjan
BLUE	Niebieski

Parametr*- pole wymagane

Dostępne Wtyczki i Moduły (Uniwersalne komponenty PWE Home) > [ZADANIE AUTOMATYCZNE] Dodanie znaku wodnego do dokumentu > image2021-9-9 15:43:4.png

Dostępne Wtyczki i Moduły (Uniwersalne komponenty PWE Home) > [ZADANIE AUTOMATYCZNE] Dodanie znaku wodnego do dokumentu > image2021-9-9 15:45:5.png

Przykład działania dla powyższej konfiguracji aplikacji.

Oryginalny dokument:

Dostępne Wtyczki i Moduły (Uniwersalne komponenty PWE Home) > [ZADANIE AUTOMATYCZNE] Dodanie znaku wodnego do dokumentu > image2021-6-7 13:53:23.png

Po zmianie:

Dostępne Wtyczki i Moduły (Uniwersalne komponenty PWE Home) > [ZADANIE AUTOMATYCZNE] Dodanie znaku wodnego do dokumentu > image2021-6-7 13:54:45.png

1.0.1 (obowiązująca dokumentacja)

Dodanie komponentu

1.0.2 (obowiązująca dokumentacja)

Dodanie parametru "Usuń hasło z pliku" obsługującego zabezpieczone hasłem pliki

1.0.4 (obowiązująca dokumentacja)

Dodanie słów kluczowych do użycia w parametrze tekst

1.0.8

Dodanie parametru "Mechanizm rotacji" zmieniającego działanie rotacji kodu kreskowego

Zadania związane z komponentem

Aktualne

Archiwalne

If you have a problem understanding how the action works, check: Automatic tasks, Conditional execution, Components params

Category: Attachment

Available from version: 1.0.23

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.

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

Displayed value	Passed value
BARCODE	Encodes the value of the Text parameter into a barcode with the specified format defined in Format parameter. The watermark on the document is a barcode.
TEXT	The value of the Text parameter is applied to the document as an explicit, unencoded watermark.

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 "".

Keyword	Description
{CURRENT_DATE}	Current date in yyyy-MM-dd format.
{CURRENT_DATE_AND_TIME}	Current date and time in yyyy-MM-dd HH-mm-ss format.
{PROCESS_ID}	Process id.
{ACTIVITY_ID}	Activity id.
{USER_NAME}	User name.
{USER_EMAIL}	User email.
{USER_FULL_NAME}	User full name that consists of first and last name.
{USER_FIRST_NAME}	User first name.
{USER_LAST_NAME}	User last name.
{USER_NUMBER}	User number.

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.

More information...

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.

Available values
TOP_LEFT
TOP_RIGHT
BOTTOM_LEFT
BOTTOM_RIGHT

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%.

More information...

Text

BOTTOM_LEFT

Values list

Available values
TOP_LEFT
TOP_MIDDLE
TOP_RIGHT
CENTER_LEFT
CENTER_MIDDLE
CENTER_RIGHT
BOTTOM_LEFT
BOTTOM_MIDDLE
BOTTOM_RIGHT

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

Value 0 (or less)

The element is fully transparent (invisible).

Value between (0, 1)

The item is partially transparent.

Value 1 (or more)

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.

More information...

Text

CODE_128

Values list

Available values
AZTEC
CODABAR
CODE_39
CODE_93
CODE_128
DATA_MATRIX
EAN_8
EAN_13
ITF
PDF_417
QR_CODE
UPC_A
UPC_E

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

Displayed value	Passed value
Method 1	METHOD_1
Method 2	METHOD_2

Font size*

1.0.1

Text size.

Float

15

Editable field

Font type*

1.0.1

Text font type.

Text

HELVETICA

Values list

Value	Description
COURIER	Courier
COURIER_BOLD	Courier Bold
COURIER_OBLIQUE	Courier Oblique
COURIER_BOLDOBLIQUE	Courier Bold Oblique
HELVETICA	Helvetica
HELVETICA_BOLD	Helvetica Bold
HELVETICA_OBLIQUE	Helvetica Oblique
HELVETICA_BOLDOBLIQUE	Helvetica Bold Oblique
SYMBOL	Symbol
TIMES_ROMAN	Times Roman
TIMES_BOLD	Times Bold
TIMES_ITALIC	Times Italic
TIMES_BOLDITALIC	Times Bold Italic
ZAPFDINGBATS	Zapf Dingbats

Color*

1.0.1

Color of the text.

Text

LIGHT_GRAY

Values list

Value	Description
WHITE	White
LIGHT_GRAY	Light gray
GRAY	Gray
DARK_GRAY	Dark gray
BLACK	Black
RED	Red
PINK	Pink
ORANGE	Orange
YELLOW	Yellow
GREEN	Green
MAGENTA	Magenta
CYAN	Cyan
BLUE	Blue

Coding*

1.0.1

Character encoding standard.

More information...

Text

CP1250

Values list

Available values
CP1250
CP1252
CP1257
MACROMAN

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

Value	Description
WHITE	White
LIGHT_GRAY	Light gray
GRAY	Gray
DARK_GRAY	Dark gray
BLACK	Black
RED	Red
PINK	Pink
ORANGE	Orange
YELLOW	Yellow
GREEN	Green
MAGENTA	Magenta
CYAN	Cyan
BLUE	Blue

Parameter*- mandatory field

Dostępne Wtyczki i Moduły (Uniwersalne komponenty PWE Home) > [ZADANIE AUTOMATYCZNE] Dodanie znaku wodnego do dokumentu > image2021-9-9 15:51:11.png

Dostępne Wtyczki i Moduły (Uniwersalne komponenty PWE Home) > [ZADANIE AUTOMATYCZNE] Dodanie znaku wodnego do dokumentu > image2021-9-9 15:53:2.png

An example of operation for the above application configuration.

Original document:

Dostępne Wtyczki i Moduły (Uniwersalne komponenty PWE Home) > [ZADANIE AUTOMATYCZNE] Dodanie znaku wodnego do dokumentu > image2021-6-7 14:41:56.png

After change:

Dostępne Wtyczki i Moduły (Uniwersalne komponenty PWE Home) > [ZADANIE AUTOMATYCZNE] Dodanie znaku wodnego do dokumentu > image2021-6-7 14:44:28.png

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