← Powrót do listy dostępnych hook'ów

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

Dostępny od: 1.0.0

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 przez wtyczkę PCM (Plugin Configuration Manager). Znak wodny jest umieszczany na każdej stronie dokumentu i akceptuje tylko format PDF.

   - documentClassId
   - watermark
       - type
       - text
	   - alignment
       - anchor 
	   - positionX%
       - positionY%
       - opacity
       - clockwiseAngle
       - watermarkBarcode
            - format
            - codeWidth
            - codeHeight
            - textUnderBarcode
       - watermarkText
            - fontSize
			- fontType
			- fontColor
            - encoding
            - backgroundColor
   - permissions
       - groups
   - errorHandling
   - removePDFSecurity

Wersja wtyczki 1.0.0 jest niekompatybilna z nowszymi wersjami. Instalowanie wersji wtyczki 1.0.1 lub nowszej spowoduje uruchomienie Upgrader'a, który zaktualizuje plik konfiguracyjny JSON na zgodny z wersją wtyczki 1.0.1.

Nazwa parametru w konfiguracji JSONOd wersjiOpisTyp parametruUwagi i ograniczenia
documentClassId*1.0.0Identyfikator klasy dokumentów wskazuje dla których dokumentów ma być uruchamiany mechanizm wstawiania znaku wodnego.Całkowity

 

type*

(watermark)

1.0.0Określa typ znaku wodnego.
Tekstowy
WartośćOpis
BARCODEkoduje wartość parametru text do postaci kodu kreskowego o określonym formacie zdefiniowanym w parametrze format. Znak wodny umieszczany na dokumencie jest kodem kreskowym.
TEXTWartość 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

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


Więcej informacji...

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.

Dostępne wartości
TOP_LEFT
TOP_RIGHT
BOTTOM_LEFT
BOTTOM_RIGHT

anchor*

(watermark)

1.0.0

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 positionX% oraz positionY%.

 

Więcej informacji...

 

Tekstowy
Dostępne wartości
TOP_LEFT
TOP_MIDDLE
TOP_RIGHT
CENTER_LEFT
CENTER_MIDDLE
CENTER_RIGHT
BOTTOM_LEFT
BOTTOM_MIDDLE
BOTTOM_RIGHT

positionX%*

(watermark)

1.0.0Wskazuje 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łkowityWartość z przedziału 0 - 100.

positionY%*

(watermark)

1.0.0Wskazuje 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łkowityWartość z przedziału 0 -100.

opacity*

(watermark)

1.0.0Określa stopień widoczności (nieprzezroczystość) wstawianego znaku wodnego.Zmiennoprzecinkowy
  • 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).

clockwiseAngle*

(watermark)

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

format*

(watermark.watermarkBarcode)

1.0.0

Określa standard kodu kreskowego.


Więcej informacji...

Tekstowy
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

codeWidth*

(watermark.watermarkBarcode)

1.0.0Definiuje 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.0Definiuje wysokość kodu kreskowego w pikselach.Całkowity 

textUnderBarcode*

(watermark.watermarkBarcode)

1.0.1Określa, czy ma być wyświetlany pod kodem kreskowym tekst (wartość parametru text), który został w nim zakodowany.LogicznyTekst ma stały rozmiar czcionki 11 i kolor czarny.

fontSize*

(watermark.watermarkText)

1.0.0Rozmiar tekstu.Zmiennoprzecinkowy 

fontType*

(watermark.watermarkText)

1.0.0Rodzaj czcionki tekstu.Tekstowy
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

fontColor*

(watermark.watermarkText)

 

1.0.0Kolor tekstu.Tekstowy
WartośćOpis
WHITEBiały
LIGHT_GRAYJasnoszary
GRAYSzary
DARK_GRAYCiemnoszary
BLACKCzarny
REDCzerwony
PINKRóżowy
ORANGEPomarańczowy
YELLOWŻółty
GREENZielony
MAGENTAMagenta
CYANCyjan
BLUENiebieski

encoding*

(watermark.watermarkText)

 1.0.0

 Kodowanie znaków.


Więcej informacji...

 Tekstowy
Dostępne wartości
CP1250
CP1252
CP1257
MACROMAN

backgroundColor

(watermark.watermarkText)

1.0.1Kolor tła tekstu 

Parametr jest opcjonalny. W przypadku braku jego zdefiniowania, nie zostanie zastosowane tło dla znaku wodnego w formie tekstu.

WartośćOpis
WHITEBiały
LIGHT_GRAYJasnoszary
GRAYSzary
DARK_GRAYCiemnoszary
BLACKCzarny
REDCzerwony
PINKRóżowy
ORANGEPomarańczowy
YELLOWŻółty
GREENZielony
MAGENTAMagenta
CYANCyjan
BLUENiebieski
errorHandling*1.0.1

Obsługa błędów. Określa w jaki sposób ma się zachować okno podglądu dokumentu przy wystąpieniu jakiekolwiek błędu np. niepoprawne znaki w tekście użytym do zakodowania kodu kreskowego dla określonego formatu kodu kreskowego.

Tekstowy
WartośćOpis
BLOCKWyświetlana jest strona HTML z informacją o błędzie. Nie ma możliwości pobrania oryginalnego (bez znaku wodnego) dokumentu.
DISPLAY_ORIGINALWyświetlany jest oryginalny dokument i jest on możliwy do pobrania.

Wartość tego parametru jest brana pod uwagę po deserializacji JSON'a (po wpisaniu poprawnych nazw i wartości parametrów konfiguracji JSON w PCM), stąd jeśli na etapie deserializacji wystąpi błąd, zostanie zastosowana domyślna obsługa błędów BLOCK.

groups

(permissions)

1.0.0Uprawnienia 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 tekstowychParametr opcjonalny, gdy nie jest uzupełniony, to mechanizm wstawiania znaku wodnego działa dla każdego użytkownika.
removePDFSecurity1.0.2Usuwa hasło, zabezpieczenia pliku chroniące przed jego modyfikacją, co sprawia możliwość wstawienia znaku wodnego do pliku. Wynikowy plik nie posiada żadnych zabezpieczeń w porównaniu do jego pierwotnej wersji. Parametr nie uwzględnia usuwania hasła pliku, które zostało użyte w celu zabezpieczenia go przed otwarciem.LogicznyParametr opcjonalny, gdy nie jest zdefiniowany, domyślnie przyjmowana jest wartość false zgodnie z kompatybilnością wsteczną.

Parametr*- pole wymagane


 

[
  {
   "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,
        "clockwiseAngle": 0,
        "watermarkText":{
            "fontSize": 15,
			"fontType": "HELVETICA",
			"fontColor": "WHITE",
            "encoding": "CP1250",
            "backgroundColor": "BLACK"
        }
    },
   "permissions": {
       "groups": ["Users", "Administrators"]  
    },
   "errorHandling": "BLOCK"
  },
  {
   "documentClassId": 4,
   "watermark": {
        "type": "BARCODE",
        "text": "{8}",
		"alignment": "TOP_LEFT",
        "anchor": "BOTTOM_LEFT",
        "positionX%": 80,
        "positionY%": 10,
        "opacity": 0.5,
        "clockwiseAngle": 0,
        "watermarkBarcode":{
            "format": "CODE_128",       
            "codeWidth": 50,
            "codeHeight": 15,
            "textUnderBarcode": false
        }
    },
   "permissions": {
       "groups": ["Users", "Administrators"]  
    },
   "errorHandling": "BLOCK",
   "removePDFSecurity": 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,
        "clockwiseAngle": 0,
        "watermarkText":{
            "fontSize": 15,
			"fontType": "HELVETICA",
			"fontColor": "LIGHT_GRAY",
            "encoding": "CP1250"
        }
    },
   "permissions": {
       "groups": ["Users", "Administrators"]  
    },
   "errorHandling": "BLOCK"
  },
  {
   "documentClassId": 4,
   "watermark": {
        "type": "BARCODE",
        "text": "{8}",
		"alignment": "TOP_LEFT",
        "anchor": "BOTTOM_LEFT",
        "positionX%": 80,
        "positionY%": 10,
        "opacity": 0.5,
        "clockwiseAngle": 0,
        "watermarkBarcode":{
            "format": "CODE_128",       
            "codeWidth": 50,
            "codeHeight": 15,
            "textUnderBarcode": false
        }
    },
   "permissions": {
       "groups": ["Users", "Administrators"]  
    },
   "errorHandling": "BLOCK"
  }
]

Oryginalny dokument:

Po otwarciu:

 

[
  {
   "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,
        "clockwiseAngle": 0,
        "watermarkText":{
            "fontSize": 15,
			"fontType": "HELVETICA",
			"fontColor": "WHITE",
            "encoding": "CP1250",
            "backgroundColor": "BLACK"
        }
    },
   "permissions": {
       "groups": ["Users", "Administrators"]  
    },
   "errorHandling": "BLOCK"
  },
  {
   "documentClassId": 4,
   "watermark": {
        "type": "BARCODE",
        "text": "{8}",
		"alignment": "TOP_LEFT",
        "anchor": "BOTTOM_LEFT",
        "positionX%": 20,
        "positionY%": 10,
        "opacity": 0.9,
        "clockwiseAngle": 0,
        "watermarkBarcode":{
            "format": "CODE_128",       
            "codeWidth": 50,
            "codeHeight": 15,
            "textUnderBarcode": true
        }
    },
   "permissions": {
       "groups": ["Users", "Administrators"]  
    },
   "errorHandling": "BLOCK",
   "removePDFSecurity": true
  }
]

Oryginalny dokument:

Po otwarciu:

1.0.0 (obowiązująca dokumentacja)

  • Dodanie hook'a

1.0.1 (obowiązująca dokumentacja)

  • Dodanie obsługi błędów, wyświetlanie tekstu pod kodem kreskowym, definiowanie tła dla znaku wodnego w formie tekstu

1.0.2

  • Dodanie parametru "removePDFSecurity" obsługującego zabezpieczone hasłem pliki

← Return to the list of hooks

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

Available from version: 1.0.0

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.

   - documentClassId
   - watermark
       - type
       - text
	   - alignment
       - anchor 
	   - positionX%
       - positionY%
       - opacity
	   - clockwiseAngle
       - watermarkBarcode
            - format
            - codeWidth
            - codeHeight
            - textUnderBarcode
       - watermarkText
            - fontSize
			- fontType
			- fontColor
            - encoding
            - backgroundColor
   - permissions
       - groups
   -errorHandling
   -removePDFSecurity

Plugin version 1.0.0 is incompatible with newer versions. Installing plugin version 1.0.1 or later will run the Upgrader, which will update the JSON configuration file to match plugin version 1.0.1.

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

 

type*

(watermark)

 

1.0.0

Specifies what type of watermark is.

Text
ValueDescription
BARCODEEncodes 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.
TEXTThe value of the text parameter is applied to the document as an explicit, unencoded watermark.

text*

(watermark)

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

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

alignment*

(watermark)

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.

 

More information...

Text

Pay attention to the corresponding values of the positionX% 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*

(watermark)

1.0.0

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 positionX% and positionY%.

 

More information...

Text
Available values
TOP_LEFT
TOP_MIDDLE
TOP_RIGHT
CENTER_LEFT
CENTER_MIDDLE
CENTER_RIGHT
BOTTOM_LEFT
BOTTOM_MIDDLE
BOTTOM_RIGHT

positionX%*

(watermark)

1.0.0 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 Value between 0 and 100.

positionY%*

(watermark)

1.0.0 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 Value between 0 and 100.

opacity*

(watermark)

1.0.0Specifies the degree of visibility of the inserted watermark. Float
  •  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).

clockwiseAngle*

(watermark)

1.0.0Watermark rotation.Float 

format*

 (watermark.watermarkBarcode)

1.0.0

Specifies the barcode format.


More information...

 Text
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

codeWidth*

(watermark.watermarkBarcode)

1.0.0Defines the width of the barcode in pixels.IntegerSpecifies 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.

codeHeight*

(watermark.watermarkBarcode)

1.0.0Defines the height of the barcode in pixels.Integer 

textUnderBarcode*

(watermark.watermarkBarcode)

1.0.1Specifies whether to display the text encoded in the barcode below this barcode.BooleanThe text has a fixed font size of 11 and black color.

size*

(watermark.watermarkText)

1.0.0Text size.Float 

fontType*

(watermark.watermarkText)

1.0.0Text font type.Text
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

fontColor*

(watermark.watermarkText)

1.0.0Color of the text.Text
ValueDescription
WHITEWhite
LIGHT_GRAYLight gray
GRAYGray
DARK_GRAYDark gray
BLACKBlack
REDRed
PINKPink
ORANGEOrange
YELLOWYellow
GREENGreen
MAGENTAMagenta
CYANCyan
BLUEBlue

encoding*

(watermark.watermarkText)

1.0.0

Character encoding standard.

 

More information...

Text
Available values
CP1250
CP1252
CP1257
MACROMAN

backgroundColor

(watermark.watermarkText)

1.0.1Text background color. 

The parameter is optional. If it is not defined, the background for the watermark in the form of text will not be used.

ValueDescription
WHITEWhite
LIGHT_GRAYLight gray
GRAYGray
DARK_GRAYDark gray
BLACKBlack
REDRed
PINKPink
ORANGEOrange
YELLOWYellow
GREENGreen
MAGENTAMagenta
CYANCyan
BLUEBlue
errorHandling*1.0.1Error handling. Defines how the document preview window should behave in the event of any error, e.g. incorrect characters in the text used to encode the barcode for a specific barcode format.Text
 Value Description
 BLOCKAn HTML page is displayed with the error message. It is not possible to download the original (no watermark) document.
DISPLAY_ORIGINALThe original document is displayed and available for download.

The value of this parameter is taken into account after JSON deserialization (after entering the correct names and values of JSON configuration parameters in PCM), hence if an error occurs during the deserialization stage, the default BLOCK error handling will be used.

groups

(permissions)

1.0.0Permissions defining for which users logged in to the system the hook will be run when trying to open a document.Array of text valuesOptional parameter, when is not filled, everyone can see the watermark.
removePDFSecurity1.0.2Removes the file's password that protects it from being modified, which makes it possible to insert a watermark into the file. The resulting file 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.BooleanOptional, when undefined, defaults to false for backward compatibility.

Parameter*- field is required


 

[
  {
   "documentClassId": 5,
   "watermark": {
        "type": "TEXT",
        "text": "Case number: {10}, Registration date: {11}",
		"alignment": "TOP_LEFT",
        "anchor": "BOTTOM_LEFT",
		"positionX%": 5,
        "positionY%": 5,
        "opacity": 0.7,
        "clockwiseAngle": 0,
        "watermarkText":{
            "fontSize": 15,
			"fontType": "HELVETICA",
			"fontColor": "WHITE",
            "encoding": "CP1252",
            "backgroundColor": "BLACK"
        }
    },
   "permissions": {
       "groups": ["Users", "Administrators"]
    },
   "errorHandling": "BLOCK"
  },
  {
   "documentClassId": 5,
   "watermark": {
        "type": "BARCODE",
        "text": "{10}",
		"alignment": "TOP_LEFT",
        "anchor": "BOTTOM_LEFT",
        "positionX%": 80,
        "positionY%": 10,
        "opacity": 0.5,
        "clockwiseAngle": 0,
        "watermarkBarcode":{
            "format": "CODE_128",  
            "codeWidth": 50,
            "codeHeight": 15,
            "textUnderBarcode": false
        }
    },
   "permissions": {
       "groups": ["Users", "Administrators"]
    },
   "errorHandling": "BLOCK",
   "removePDFSecurity": true
  }
]
[
  {
   "documentClassId": 5,
   "watermark": {
        "type": "TEXT",
        "text": "Case number: {10}, Registration date: {11}",
		"alignment": "TOP_LEFT",
        "anchor": "BOTTOM_LEFT",
		"positionX%": 5,
        "positionY%": 5,
        "opacity": 0.7,
        "clockwiseAngle": 0,
        "watermarkText":{
            "fontSize": 15,
			"fontType": "HELVETICA",
			"fontColor": "LIGHT_GRAY",
            "encoding": "CP1252",
        }
    },
   "permissions": {
       "groups": ["Users", "Administrators"]
    },
   "errorHandling": "BLOCK"
  },
  {
   "documentClassId": 5,
   "watermark": {
        "type": "BARCODE",
        "text": "{10}",
		"alignment": "TOP_LEFT",
        "anchor": "BOTTOM_LEFT",
        "positionX%": 80,
        "positionY%": 10,
        "opacity": 0.5,
        "clockwiseAngle": 0,
        "watermarkBarcode":{
            "format": "CODE_128",  
            "codeWidth": 50,
            "codeHeight": 15,
            "textUnderBarcode": false
        }
    },
   "permissions": {
       "groups": ["Users", "Administrators"]
    },
   "errorHandling": "BLOCK"
  }
]

Original document:

 After opening:

[
  {
   "documentClassId": 5,
   "watermark": {
        "type": "TEXT",
        "text": "Case number: {10}, Registration date: {11}",
		"alignment": "TOP_LEFT",
        "anchor": "BOTTOM_LEFT",
		"positionX%": 5,
        "positionY%": 5,
        "opacity": 0.7,
        "clockwiseAngle": 0,
        "watermarkText":{
            "fontSize": 15,
			"fontType": "HELVETICA",
			"fontColor": "WHITE",
            "encoding": "CP1252",
            "backgroundColor": "BLACK"
        }
    },
   "permissions": {
       "groups": ["Users", "Administrators"]
    },
   "errorHandling": "BLOCK"
  },
  {
   "documentClassId": 5,
   "watermark": {
        "type": "BARCODE",
        "text": "{10}",
		"alignment": "TOP_LEFT",
        "anchor": "BOTTOM_LEFT",
        "positionX%": 80,
        "positionY%": 10,
        "opacity": 0.9,
        "clockwiseAngle": 0,
        "watermarkBarcode":{
            "format": "CODE_128",  
            "codeWidth": 50,
            "codeHeight": 15,
            "textUnderBarcode": true
        }
    },
   "permissions": {
       "groups": ["Users", "Administrators"]
    },
   "errorHandling": "BLOCK",
   "removePDFSecurity": true
  }
]

Original document:

After opening:

 

1.0.0 (applicable documentation)

  • Hook adding

1.0.1 (applicable documentation)

  • Adding error handling, displaying text under the barcode, defining the background for the watermark as text

1.0.2

  • Adding "removePDFSecurity" parameter for password-protected files