Page History

Polish

Info
Jeśli masz problem ze zrozumieniem jak działają hook'i, sprawdź opis: Mechanizm hook'ów

Panel

title	Podstawowe informacje

Dostępny od: 1.0.0

Panel

title	Opis

Hook pełni funkcję umieszczania znaku wodnego na dokumencie w czasie jego wyświetlania. Jest on zaimplementowany na podstawie definicji hook'a systemowego ReadFileHookAdapter, który umożliwia zmianę strumienia binarnego wyświetlanego dokumentu z archiwum lub w podglądzie w procesie. Konfiguracja hook'a wstawiającego znak wodny jest określana w formacie JSON pod postacią listy i zarządzana jest przez wtyczkę PCM (Plugin Configuration Manager). Znak wodny jest umieszczany na każdej stronie dokumentu i akceptuje tylko format PDF.

Panel

title	Parametry konfiguracyjne

Nazwa parametru w konfiguracji JSON

Od wersji

Opis

Typ parametru

Uwagi i ograniczenia

documentClassId*

1.0.0

Identyfikator klasy dokumentów wskazuje dla których dokumentów ma być uruchamiany mechanizm wstawiania znaku wodnego.

Całkowity

type*

(watermark)

1.0.0

Określa typ znaku wodnego.

Tekstowy

Wartość	Znaczenie
BARCODE	koduje wartość parametru text do postaci kodu kreskowego o określonym formacie zdefiniowanym w parametrze format. Znak wodny umieszczany na dokumencie jest kodem kreskowym.
TEXT	Wartość parametru text jest nanoszona na dokument jako znak wodny w formie jawnej, niezakodowanej.

text*

(watermark)

1.0.0

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

Tekstowy

Warning
Wszystkie wpisane identyfikatory indeksów w ciągu tekstowym muszą istnieć w klasie dokumentów podanej w parametrze documentClassId. 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 "".

alignment*

(watermark)

1.0.0

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

Tekstowy

Należy zwrócić uwagę na odpowiednie wartości parametrów positionX% oraz positionY%, ponieważ w zależności od wartości parametru alignment, anchor oraz rozmiarów znaku wodnego, znak wodny może wykraczać poza stronę dokumentu, czyli być częściowo lub wcale niewidoczny.

Wartość	Znaczenie
TOP_LEFT	Pozycja znaku wodnego względem górnego lewego rogu.
TOP_RIGHT	Pozycja znaku wodnego względem górnego prawego rogu.
BOTTOM_LEFT	Pozycja znaku wodnego względem dolnego lewego rogu.
BOTTOM_RIGHT	Pozycja znaku wodnego względem dolnego prawego rogu.

anchor*

(watermark)

1.0.0

Określa pozycję znaku wodnego względem odpowiedniego rogu znaku wodnego.

Tekstowy

Wartość

Znaczenie

BOTTOM_LEFT

Pozycja znaku wodnego względem lewego dolnego rogu znaku wodnego.

positionX%*

(watermark)

1.0.0

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

Całkowity

Wartość z przedziału 0 - 100.

positionY%*

(watermark)

1.0.0

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

Całkowity

Wartość z przedziału 0 -100.

opacity*

(watermark)

1.0.0

Określa przezroczystość wstawianego znaku wodnego.

Zmiennoprzecinkowy

Wartość z przedziału 0.0 - 1.0.

format*

(watermark.watermarkBarcode)

1.0.0

Określa standard kodów kreskowych w postaci jednowymiarowej (zapis informacji w jednej linii, w formie kresek).

Tekstowy

Wartość	Znaczenie
CODE_39	Znany też jako "USS Code 39", "Code 3/9", "Kod 3 z 9", "USD-3", "Alpha39") – alfanumeryczny kod kreskowy o stałej szerokości pojedynczego znaku.
CODE_93	Code 93 został zaprojektowany jako udoskonalenie kodowania Code 39. Podobnie jak swój pierwowzór w wersji podstawowej jest w stanie przechowywać 43 znaki alfanumeryczne. Jednak w stosunku do swojego poprzednika posiada jeszcze 4 dodatkowe znaki sterujące.
CODE_128	Kod alfanumeryczny o zmiennej długości i wysokiej gęstości. Potrafi kodować znaki z całego zakresu ASCII.

codeWidth*

(watermark.watermarkBarcode)

1.0.0

Definiuje szerokość kodu kreskowego w pikselach.

Całkowity

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

codeHeight*

(watermark.watermarkBarcode)

1.0.0

Definiuje wysokość kodu kreskowego w pikselach.

Całkowity

size*

(watermark.watermarkText)

1.0.0

Rozmiar tekstu.

Zmiennoprzecinkowy

fontType

(watermark.watermarkText)

1.0.0

Rodzaj czcionki tekstu.

Tekstowy

Parametr jest opcjonalny. W przypadku braku jego zdefiniowania, domyślną czcionką będzie HELVETICA.

Wartość	Znaczenie
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

(watermark.watermarkText)

1.0.0

Kolor tekstu.

Tekstowy

Parametr jest opcjonalny. W przypadku braku jego zdefiniowania, domyślnym kolorem będzie LIGHT_GRAY.

Wartość	Znaczenie
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

encoding*

(watermark.watermarkText)

1.0.0

Kodowanie znaków.

Tekstowy

Wartość	Znaczenie
CP1250	Strona kodowa służąca do reprezentacji tekstów w językach środkowoeuropejskich używających alfabetu łacińskiego, na przykład albańskim, chorwackim, czeskim, polskim, rumuńskim, słowackim, słoweńskim, węgierskim.
CP1252	Strona kodowa służąca do reprezentacji tekstów w językach zachodnioeuropejskich.
CP1257	Strona kodowa służąca do reprezentacji tekstów w językach estońskim, litewskim, czy łotewskim. Zestaw ten jest w znacznej części kompatybilny z ISO 8859-13, oraz nadaje się do kodowania języka polskiego.
MACROMAN	Kodowanie znaków używane głównie w klasycznym systemie Mac OS do reprezentowania tekstu. Koduje 256 znaków, z których pierwsze 128 jest identyczne z ASCII, a pozostałe znaki obejmują symbole matematyczne, znaki diakrytyczne i dodatkowe znaki interpunkcyjne. Jest odpowiedni dla języka angielskiego i kilku innych języków zachodnich.

clockwiseAngle*

(watermark.watermarkText)

1.0.0

Rotacja znaku wodnego zgodnie z kierunkiem ruchu wskazówki zegara.

Zmiennoprzecinkowy

groups

(permissions)

1.0.0

Uprawnienia określające dla jakich zalogowanych użytkowników w systemie przy próbie otwarcia dokumentu zostanie uruchomiony hook. Wskazuje na grupy użytkowników systemowych.

Tablica wartości tekstowych

Parametr opcjonalny, gdy nie jest uzupełniony, to mechanizm wstawiania znaku wodnego działa dla każdego użytkownika.

Parametr*- pole wymagane

Panel

title	Formaty kodu kreskowego

Format

Opis

Code_39

Jednowymiarowy kod kreskowy zawierający znaki alfanumeryczne o zmiennej długości, w którym występują paski o dwóch różnych szerokościach. Do kodowania CODE_39 używane są 43 znaki plus dodatkowe znaki, które są ogranicznikami i znakami start/stop. Znak start/stop zawsze występuje jako pierwszy i ostatni znak kodu i jest nim znak '*'. Ten format nie pozwala na zakodowanie małych liter.

Znak	Wartość	Znak	Wartość	Znak	Wartość	Znak	Wartość
0	0	B	11	M	22	X	33
1	1	C	12	N	23	Y	34
2	2	D	13	1O	24	Z	35
3	3	E	14	P	25	-	36
4	4	F	15	Q	26	.	37
5	5	G	16	R	27	space	38
6	6	H	17	S	28	$	39
7	7	I	18	T	29	/	40
8	8	J	19	U	30	+	41
9	9	K	20	V	31	%	42
A	10	L	21	W	32

Code_93

Jednowymiarowy kod kreskowy będący udoskonaleniem formatu CODE_39. Występują w nim paski o czterech różnych szerokościach. Podobnie jak swój pierwowzór przechowuje 43 znaki alfanumeryczne, ale dodatkowo posiada 4 znaki sterujące (($), (%), (/), (+)), które są używane do kodowania wszystkich 128 znaków ASCII (CODE_93 Extended). Kod przyjmuje wyłącznie wielkie litery, chyba że zostaną użyte znaki sterujące.

Znak	Wartość	Znak	Wartość	Znak	Wartość	Znak	Wartość
0	0	C	12	O	24	-	36
1	1	D	13	P	25	.	37
2	2	E	14	Q	26	space	38
3	3	F	15	R	27	$	39
4	4	G	16	S	28	/	40
5	5	H	17	T	29	+	41
6	6	I	18	U	30	%	42
7	7	J	19	V	31	($)	43
8	8	K	20	W	32	(%)	44
9	9	L	21	X	33	(/)	45
A	10	M	22	Y	34	(+)	46
B	11	N	23	Z	35

Code_128

Kod alfanumeryczny o zmiennej długości i wysokiej gęstości. Potrafi kodować znaki z całego zakresu ASCII. Do kodowania używa się kreski i przerwy o czterech możliwych szerokościach, co czyni go zwartym kodem. Kod 128 może być skanowany w każdym kierunku i nie ma ograniczeń co do długości samego kodu.

Panel

title	Przykładowa konfiguracja

Image Modified

Code Block

language	js
linenumbers	true

[
  {
   "documentClassId": 4,
   "watermark": {
        "type": "TEXT",
        "text": "Numer sprawy: {8}, Data rejestracji: {9}",
		"alignment": "TOP_LEFT",
        "anchor": "BOTTOM_LEFT",
		"positionX%": 5,
        "positionY%": 5,
        "opacity": 0.7,
        "watermarkText":{
            "size": 15,
			"fontType": "HELVETICA",
			"color": "LIGHT_GRAY",
            "encoding": "CP1250",
            "clockwiseAngle": 0
        }
    },
   "permissions": {
       "groups": ["Users", "Administrators"]  
    }
  },
  {
   "documentClassId": 4,
   "watermark": {
        "type": "BARCODE",
        "text": "{8}",
		"alignment": "TOP_LEFT",
        "anchor": "BOTTOM_LEFT",
        "positionX%": 80,
        "positionY%": 10,
        "opacity": 0.5,
        "watermarkBarcode":{
            "format": "CODE_128",       
            "codeWidth": 50,
            "codeHeight": 15
        }
    },
   "permissions": {
       "groups": ["Users", "Administrators"]  
    }
  }
]

Panel

title	Przykład działania

Przykład działania dla powyższej konfiguracji JSON'a.

Oryginalny dokument:

Po otwarciu:

Panel

title	Change log

1.0.0

Dodanie hook'a

English

← Return to the list of hooks

Info
If you have a problem understanding how the hook works, check: Hook's mechanism

Panel

title	Basic information

Available from version: 1.0.0

Panel

title	Description

Hook places a watermark on the document as it is displayed. This hook is implemented based on the definition of the ReadFileHookAdapter system hook, which allows to change the binary stream of the displayed document from archive or in preview in the process. Configuration of the watermark insert hook is defined in JSON format as a list and is managed by the PCM (Plugin Configuration Manager). A watermark is placed on every page of the document and accepts only PDF format.

Panel

title	Configuration parameters

Parameter name in JSON configuration

From version

Description

Paremeter type

Comments and restrictions

documentClassId*

1.0.0

The document class id indicates for which documents the watermark insertion parameters are to be considered.

Integer

watermark

type*

1.0.0

Specifies what type of watermark is.

Text

Value	Meaning
BARCODE	Encodes the value of the text parameter into a barcode with the specified format defined in the 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.

watermark

text*

1.0.0

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

Text

Warning
Any typed index ids in the text string must exist in the document class specified by the documentClassId 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 "".

watermark

positionX%*

1.0.0

Indicates the X (horizontal) position of the watermark in percent relative to the document page dimensions.

Integer

Value between 0 and 100.

watermark

positionY%*

1.0.0

Indicates the Y (vertical) position of the watermark in percent relative to the document page dimensions.

Integer

Value between 0 and 100.

watermark

opacity*

1.0.0

Specifies the transparency of the inserted watermark on the pages of the document.

Float

Value between 0.0 and 1.0.

watermark

alignment*

1.0.0

Specifies relative to which of the four corners of the document page the position of the watermark will be calculated based on the positionX% and positionY% parameters.

Text

Value	Meaning
TOP_LEFT	The position of the watermark in relation to the top left corner.
TOP_RIGHT	The position of the watermark in relation to the top right corner.
BOTTOM_LEFT	The position of the watermark in relation to the bottom left corner.
BOTTOM_RIGHT	The position of the watermark in relation to the bottom right corner.

watermark

anchor*

1.0.0

Specifies the position of the watermark in relation to the corresponding corner of the watermark.

Text

Value

Meaning

BOTTOM_LEFT

The position of the watermark in relation to the lower left corner of the watermark.

watermark

watermarkBarcode

format

1.0.0

Specifies standard for one-dimensional barcodes (writing information on one line, in the form of dashes).

Text

Value

Meaning

CODE_39

Barcode with variable-length alphanumeric characters to store 43 different characters. Each sign consists of 9 elements (light and dark bars), 3 of which are significantly wider. This format allows you to encode numbers, capital letters and characters (-, ., (Space), $, /, +,%, *).

Char	Value	Char	Value	Char	Value	Char	Value
0	0	B	11	M	22	X	33
1	1	C	12	N	23	Y	34
2	2	D	13	O	24	Z	35
3	3	E	14	P	25	-	36
4	4	F	15	Q	26	.	37
5	5	G	16	R	27	space	38
6	6	H	17	S	28	$	39
7	7	I	18	T	29	/	40
8	8	J	19	U	30	+	41
9	9	K	20	V	31	%	42
A	10	L	21	W	32

CODE_93

The barcode is an improvement of the CODE_39 format. Like its prototype, it stores 43 alphanumeric characters, but additionally has 4 control characters (($), (%), (/), (+)).
The code accepts only uppercase letters.

Char	Value	Char	Value	Char	Value	Char	Value
0	0	C	12	O	24	-	36
1	1	D	13	P	25	.	37
2	2	E	14	Q	26	space	38
3	3	F	15	R	27	$	39
4	4	G	16	S	28	/	40
5	5	H	17	T	29	+	41
6	6	I	18	U	30	%	42
7	7	J	19	V	31	($)	43
8	8	K	20	W	32	(%)	44
9	9	L	21	X	33	(/)	45
A	10	M	22	Y	34	(+)	46
B	11	N	23	Z	35

Code 93

CODE_128

Variable length, high density alphanumeric code. It can encode characters from the entire ASCII range.

watermark

watermarkBarcode

codeWidth

1.0.0

Defines the width of the barcode in pixels.

Integer

The parameter does not define the maximum width of the barcode - in the case when the substituted value turns out to be too long, the width will be automatically increased.

watermark

watermarkBarcode

codeHeight

1.0.0

Defines the height of the barcode in pixels.

Integer

watermark

watermarkText

size

1.0.0

Text size.

Float

watermark

watermarkText

encoding

1.0.0

Character encoding.

Text

Value	Meaning
CP1250	A code page for the representation of texts in Central European languages using the Latin alphabet, for example Albanian, Croatian, Czech, Polish, Romanian, Slovak, Slovenian, Hungarian.
CP1252	A code page to represent texts in Western European languages.
CP1257	A code page used to represent texts in Estonian, Lithuanian or Latvian. This set is largely compatible with ISO 8859-13, and is suitable for coding the Polish language.
MACROMAN	Character encoding mainly used in classic Mac OS to represent text. It encodes 256 characters, the first 128 of which are identical to ASCII and the remaining characters include math symbols, diacritics, and additional punctuation marks. It is suitable for English and several other Western languages.

watermark

watermarkText

color

1.0.0

The color of the text.

Text

Value	Meaning
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

watermark

watermarkText

fontType

1.0.0

Text font type.

Text

Value	Meaning
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

watermark

watermarkText

rotation

1.0.0

Watermark rotation.

Float

The value between 0.0 and 360.0.

Permissions

groups

1.0.0

Permissions defining for which users logged in to the system the hook will be run when trying to open a document.

Array of text values

Optional parameter, when is not filled, everyone can see the watermark.

Panel

title	Barcode formats

Format

Description

Code_39

text

Code_93

text

Code_128

text

Panel

title	Configuration example

Code Block

language	js
linenumbers	true

[
  {
   "documentClassId": 5,
   "watermark": {
        "type": "TEXT",
        "text": "Case number: {10}, Registration date: {11}",
        "positionX%": 5,
        "positionY%": 5,
        "opacity": 0.7,
        "alignment": "TOP_LEFT",
        "anchor": "BOTTOM_LEFT",
        "watermarkText":{
            "size": 15,
            "encoding": "CP1252",
            "color": "LIGHT_GRAY",
            "fontType": "HELVETICA",
            "rotation": 0
        }
    },
   "permissions": {
       "groups": ["Users", "Administrators"]  
    }
  },
  {
   "documentClassId": 5,
   "watermark": {
        "type": "BARCODE",
        "text": "{10}",
        "positionX%": 80,
        "positionY%": 10,
        "opacity": 0.5,
        "alignment": "TOP_LEFT",
        "anchor": "BOTTOM_LEFT",
        "watermarkBarcode":{
            "format": "CODE_128",       
            "codeWidth": 50,
            "codeHeight": 15
        }
    },
   "permissions": {
       "groups": ["Users", "Administrators"]  
    }
  }
]

Panel

title	Example of use

Example of use for the above JSON configuration.

Original document:

After opening:

Panel

title	Change log

1.0.0

Hook adding

*

Page History

Versions Compared

Old Version 19

New Version 20

Key

Dostępny od: 1.0.0

Available from version: 1.0.0

Char

Value

Char

Value

Char

Value

Char

Value

0

0

B

11

M

22

X

33

1

1

C

12

N

23

Y

34

2

2

D

13

O

24

Z

35

3

3

E

14

P

25

-

36

4

4

F

15

Q

26

.

37

5

5

G

16

R

27

space

38

6

6

H

17

S

28

$

39

7

7

I

18

T

29

/

40

8