Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Image Added

 

Polish
Info

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

Panel
titlePodstawowe informacje

Kategoria: Watermark

Dostępne od wersji: 1.0.1

Panel
titleOpis

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.

Panel
titleParametry konfiguracyjne
Nazwa parametruOd wersjiOpisTyp parametruWartość domyślnaRodzaj polaUwagi i ograniczenia
Rodzaj znaku wodnego*1.0.1

Określa typ znaku wodnego.

Tekstowy Lista wartości
Wartość wyświetlanaOpis
Kod kreskowyKoduje wartość parametru Tekst do postaci kodu kreskowego o określonym formacie zdefiniowanym w parametrze Format. Znak wodny umieszczany na dokumencie jest kodem kreskowym.
TekstWartość parametru Tekst jest nanoszona na dokument jako znak wodny w formie jawnej, niezakodowanej.
Klasa dokumentów*1.0.1Nazwa 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
Warning

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 kluczoweOpis
{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...

TekstowyTOP_LEFTLista 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 stronyKotwica oraz rozmiarów znaku wodnego, znak wodny może wykraczać poza stronę dokumentu, czyli być częściowo lub wcale niewidoczny.

Wartość wyświetlanaWartość przekazywana
Górny lewy róg dokumentuTOP_LEFT
Górny prawy róg dokumentuTOP_RIGHT
Dolny lewy róg dokumentuBOTTOM_LEFT
Dolny prawy róg dokumentuBOTTOM_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...

TekstowyBOTTOM_LEFTLista wartości
Wartość wyświetlanaWartość przekazywana
Górny lewy róg znaku wodnegoTOP_LEFT
Górny środek znaku wodnegoTOP_MIDDLE
Górny prawy róg znaku wodnegoTOP_RIGHT
Lewy środek znaku wodnegoCENTER_LEFT
Środek znaku wodnegoCENTER_MIDDLE
Prawy środek znaku wodnegoCENTER_RIGHT
Dolny lewy róg znaku wodnegoBOTTOM_LEFT
Dolny środek znaku wodnegoBOTTOM_MIDDLE
Dolny prawy róg znaku wodnegoBOTTOM_RIGHT
Pozycja X%*1.0.1Wskazuje 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łkowity5Pole edytowalneWartość z przedziału 0 -100.
Pozycja Y%*1.0.1Wskazuje 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łkowity10Pole edytowalneWartość z przedziału 0 -100.
Przezroczystość*1.0.1Określa stopień widoczności wstawianego znaku wodnego.Zmiennoprzecinkowy1Pole 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).

RotacjaStopnie rotacji*1.0.1Rotacja

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.

Zmiennoprzecinkowy0Pole edytowalne 
Usuń hasło z pliku*1.0.2Usuwa 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.LogicznyNiePole edytowalne 
Format*1.0.1

Określa standard kodu kreskowego.


Więcej informacji...

TekstowyCODE_128Lista 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.1Definiuje szerokość kodu kreskowego w pikselach.Całkowity40Pole edytowalneOkreś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.1Definiuje wysokość kodu kreskowego w pikselach.Całkowity15Pole edytowalne

 

Wyświetl tekst pod kodem kreskowym*1.0.1Określa, czy ma być wyświetlany pod kodem kreskowym tekst (wartość parametru Tekst), który został w nim zakodowany.LogicznyNiePole edytowalneTekst ma stały rozmiar czcionki 11 i kolor czarny.
Mechanizm rotacji1.0.8Okreś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świetlanaWartość przekazywana
Sposób 1METHOD_1
Sposób 2METHOD_2
Rozmiar czcionki*1.0.1Rozmiar tekstu.Zmiennoprzecinkowy15Pole edytowalne 
Rodzaj czcionki*1.0.1Rodzaj czcionki tekstu.TekstowyHELVETICALista wartości
WartośćOpis
COURIERCourier
COURIER_BOLDCourier Bold
COURIER_OBLIQUECourier Oblique
COURIER_BOLDOBLIQUECourier Bold Oblique
HELVETICAHelvetica
HELVETICA_BOLDHelvetica Bold
HELVETICA_OBLIQUEHelvetica Oblique
HELVETICA_BOLDOBLIQUEHelvetica Bold Oblique
SYMBOLSymbol
TIMES_ROMANTimes Roman
TIMES_BOLDTimes Bold
TIMES_ITALICTimes Italic
TIMES_BOLDITALICTimes Bold Italic
ZAPFDINGBATSZapf Dingbats
Kolor*1.0.1Kolor tekstu.TekstowyLIGHT_GRAYLista wartości
WartośćOpis
WHITEBiały
LIGHT_GRAYJasnoszary
GRAYSzary
DARK_GRAYCiemnoszary
BLACKCzarny
REDCzerwony
PINKRóżowy
ORANGEPomarańczowy
YELLOWŻółty
GREENZielony
MAGENTAMagenta
CYANCyjan
BLUENiebieski
Kodowanie*1.0.1

 Kodowanie znaków.

 

Więcej informacji...

TekstowyCP1250Lista wartości
Dostępne wartości
CP1250
CP1252
CP1257
MACROMAN
Kolor tła1.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
WHITEBiały
LIGHT_GRAYJasnoszary
GRAYSzary
DARK_GRAYCiemnoszary
BLACKCzarny
REDCzerwony
PINKRóżowy
ORANGEPomarańczowy
YELLOWŻółty
GREENZielony
MAGENTAMagenta
CYANCyjan
BLUENiebieski

Parametr*- pole wymagane

Panel
titlePrzykładowa konfiguracja

 

Panel
titlePrzykład działania

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

Oryginalny dokument:

Po zmianie:

 

Panel
titleChange log

 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
Hide If
special@anonymous

Zadania związane z komponentem

Aktualne

Archiwalne

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-470

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-519

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-528

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-486

English
Info

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

Panel
titleBasic information

Category: Attachment

Available from version: 1.0.23

Panel
titleDescription

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.

Panel
titleConfiguration 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

Displayed valuePassed value
BARCODEEncodes 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.
TEXTThe value of the Text parameter is applied to the document as an explicit, unencoded watermark.
Document class*1.0.1Name 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
Warning

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

KeywordDescription
{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...

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

TextBOTTOM_LEFTValues 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.1Indicates 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.Integer5Editable fieldValue between 0 and 100.
PositionY%*1.0.1Indicates 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.Integer10Editable fieldValue between 0 and 100.
Opacity*1.0.1Specifies the degree of visibility of the inserted watermark.Float1Editable 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).

Clockwise angleRotation degrees*1.0.1Watermark rotation.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.Float0Editable field 
Remove password from the file*1.0.2Removes 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.BooleanNoEditable field 
Format*1.0.1

Specifies the barcode format.


More information...

TextCODE_128Values 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.1Defines the width of the barcode in pixels.Integer40Editable fieldSpecifies 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.1Defines the height of the barcode in pixels.Integer15Editable field 
Display text below the barcode*1.0.1Specifies whether to display the text encoded in the barcode below this barcode.BooleanNoEditable fieldThe text has a fixed font size of 11 and black color.
Rotation Mechanism1.0.8Specifies 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 valuePassed value
Method 1METHOD_1
Method 2METHOD_2
Font size*1.0.1Text size.Float15Editable field 
Font type*1.0.1Text font type.TextHELVETICAValues list
ValueDescription
COURIERCourier
COURIER_BOLDCourier Bold
COURIER_OBLIQUECourier Oblique
COURIER_BOLDOBLIQUECourier Bold Oblique
HELVETICAHelvetica
HELVETICA_BOLDHelvetica Bold
HELVETICA_OBLIQUEHelvetica Oblique
HELVETICA_BOLDOBLIQUEHelvetica Bold Oblique
SYMBOLSymbol
TIMES_ROMANTimes Roman
TIMES_BOLDTimes Bold
TIMES_ITALICTimes Italic
TIMES_BOLDITALICTimes Bold Italic
ZAPFDINGBATSZapf Dingbats
Color*1.0.1Color of the text.TextLIGHT_GRAYValues list
ValueDescription
WHITEWhite
LIGHT_GRAYLight gray
GRAYGray
DARK_GRAYDark gray
BLACKBlack
REDRed
PINKPink
ORANGEOrange
YELLOWYellow
GREENGreen
MAGENTAMagenta
CYANCyan
BLUEBlue
Coding*1.0.1

Character encoding standard.

 

More information...

TextCP1250Values list
Available values
CP1250
CP1252
CP1257
MACROMAN
Display text background*1.0.1Sets the background for a text watermark with dimensions the same as the length and width of the text.TextNoEditable Field 
Background color1.0.1Sets 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
ValueDescription
WHITEWhite
LIGHT_GRAYLight gray
GRAYGray
DARK_GRAYDark gray
BLACKBlack
REDRed
PINKPink
ORANGEOrange
YELLOWYellow
GREENGreen
MAGENTAMagenta
CYANCyan
BLUEBlue

Parameter*- mandatory field

 

 

Panel
titleConfiguration example

 

Panel
titleExample of use

An example of operation for the above application configuration.

Original document:

After change:

Panel
titleChange 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