@Deprecated [Hook] Wstawianie znaku wodnego do dokumentu

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

Basic information

Available from version: 1.0.17

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

Configuration parameters

Parameter name

From version

Parameter name in JSON configuration

Description

Paremeter type

Comments and restrictions

Document Class ID

1.0.17

documentClassId

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

Integer

Type

1.0.17

type

Specifies what type of watermark is.

Text

Value	Meaning
BARCODE	Barcode

Format

1.0.17

format

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.

Index ID

1.0.17

indexId

Indicates the index from which the value to be encoded in the watermark is taken.

Integer

The index value must be of the text type.

Watermark width

1.0.17

codeWidth

Defines the width of the watermark in pixels.

Text

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 height

1.0.17

codeHeight

Defines the height of the watermark in pixels.

Text

Position

1.0.17

position

Positions the watermark on the appropriate part of the page. There are 9 predefined positions to use.

Text

Value	Meaning
TOP_RIGHT	Upper right corner
TOP_LEFT	Upper left corner
BOTTOM_RIGHT	Lower right corner
BOTTOM_LEFT	Lower left corner
TOP	Top middle
BOTTOM	Bottom middle
LEFT	Left middle
RIGHT	Right middle
CENTER	Middle

Margin

1.0.17

margin

Defines the distance of the watermark from the specified edge of the page depending on the value of the Location parameter, e.g. when the mentioned parameter is TOP, the margin refers to the top edge of the document page.

Float

transparency

1.0.17

opacity

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

Float

Value in the range 0-1.

Permissions

1.0.17

permissions

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

Object

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

groups

Indicates groups of system users.

Text table

Configuration example

Example JSON configuration

[
  {
   "documentClassId": 2,
   "watermark": {
        "type": "BARCODE",
        "format": "CODE_128",
        "indexId": 2,
        "codeWidth": 30,
        "codeHeight": 30,
        "position": "RIGHT",
        "margin": 5.0,
        "opacity": 0.5
    },
   "permissions": {
       "groups": ["Users", "Administrators"]  
    }      
  },
  {
   "documentClassId": 1,
   "watermark": {
        "type": "BARCODE",
        "format": "CODE_128",
        "indexId": 2,
        "codeWidth": 60,
        "codeHeight": 60,
        "position": "LEFT",
        "margin": 5.0,
        "opacity": 0.5
    }
  }
]

Change log

1.0.17

Hook adding

1.0.26 (applicable documentation)

Fix the situation where there is no user context

1.0.X

Adding a @Deprecated Annotation

@Deprecated [Hook] Wstawianie znaku wodnego do dokumentu

Available from version: 1.0.17

0 Comments