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

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

Panel

title	Parametry konfiguracyjne

Nazwa parametru

Od wersji

Nazwa parametru w konfiguracji JSON

Opis

Typ parametru

Uwagi i ograniczenia

Identyfikator klasy dokumentów

1.0.X

documentClassId

Klasa dokumentów wskazuje dla których dokumentów mają być brane pod uwagę parametry wstawiania znaku wodnego.

Całkowity

Typ

1.0.X

type

Określa jakiego typu jest znak wodny.

Tekstowy

Wartość	Znaczenie
BARCODE	Kod kreskowy

Format

1.0.X

format

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

Tekstowy

Wartość	Znaczenie
CODE_39	Kod kreskowy zawierający znaki alfanumeryczne o zmiennej długości, pozwalający zapisać 43 różne znaki. Każdy ze znaków składa się z 9 elementów (słupki jasne i ciemne), z których 3 są znacząco szersze. Ten format pozwala na zakodowanie liczb, wielkich liter i znaków (-, ., (spacja), $, /, +, %, *).
CODE_93	Kod kreskowy będący udoskonaleniem formatu CODE_39. Podobnie jak swój pierwowzór przechowuje 43 znaki alfanumeryczne, ale dodatkowo posiada 4 znaki sterujące (($), (%), (/), (+)). Kod przyjmuje wyłącznie wielkie litery.
CODE_128	Kod alfanumeryczny o zmiennej długości i wysokiej gęstości. Potrafi kodować znaki z całego zakresu ASCII.

Identyfikator indeksu

1.0.X

indexId

Wskazuje na indeks, z którego jest pobierana wartość do zakodowania w znaku wodnym.

Całkowity

Wartość indeksu musi być typu tekstowego.

Szerokość znaku wodnego

1.0.X

codeWidth

Definiuje szerokość znaku wodnego w pikselach.

Całkowity

Parametr nie definiuje maksymalnej szerokości kodu kreskowego - w przypadku, gdy podstawiana wartość okaże się zbyt długa, szerokość automatycznie zostanie zwiększona.

Wysokość znaku wodnego

1.0.X

codeHeight

Definiuje długość znaku wodnego w pikselach.

Całkowity

Umiejscowienie

1.0.X

position

Pozycjonuje znak wodny w odpowiedniej części strony. Do wykorzystania jest 9 predefiniowanych pozycji.

Tekstowy

Wartość	Znaczenie
TOP_RIGHT	Górny prawy róg.
TOP_LEFT	Górny lewy róg.
BOTTOM_RIGHT	Dolny prawy róg.
BOTTOM_LEFT	Dolny lewy róg.
TOP	U góry na środku.
BOTTOM	Na dole na środku.
LEFT	Na środku po lewej stronie.
RIGHT	Na środku po prawej stronie.
CENTER	Na środku.

Margines

1.0.X

margin

Definiuje odstęp znaku wodnego od określonej krawędzi strony w zależności od wartości parametru Umiejscowienie np. gdy wspomniany parametr ma wartość TOP, to margines odnosi się do górnej krawędzi strony dokumentu.

Zmiennoprzecinkowy

Przezroczystość

1.0.X

opacity

Określa przezroczystość wstawianego znaku wodnego na stronach dokumentu.

Zmiennoprzecinkowy

Wartość z przedziału 0-1.

Uprawnienia

1.0.X

permissions

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

Obiekt

Parametr opcjonalny, gdy nie jest uzupełniony to znak wodny widzą wszyscy.

groups

Wskazuje na grupy użytkowników systemowych.

Tablica tekstowa

Panel

title	Przykładowa konfiguracja

Info

title	Przykładowa konfiguracja JSON

[
  {
   "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
    }
  }
]

Panel

title	Change log

1.0.X

Dodanie hook'a

English

← ← Return to the list of applicationshooks

Info
If you have a problem understanding how the action hook works, check: Automatic tasks, Conditional execution, Components params Hook's mechanism

Panel

title	Basic information

Category: General

Available from version: 1.0.

2

X

Panel

title	Description

Application Hook places a watermark on the document as it is displayed. This hook is implemented based on the set of variables checks whether there is another process in the system having the same set of values for these variables.

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

Panel

title	Configuration parameters

Parameter name	From version	Parameter name in JSON configuration	Description	Default value	Comments and restrictions
Input variables Document Class ID	1.0.2	A set of variables based on which uniqueness is determined	Array of variables	Editable field	Target variable*	X	documentClassId	The document class indicates for which documents the watermark insertion parameters are to be considered.	Integer
Type	1.0.2	Variable to which the output of the application is saved.	Variable	Editable field
Variables that exclude potential duplicates	x.x	Variables whose values from the adjacent parameter exclude the given process from evaluation.	Array of variables	Editable list
Values for exclusion variables	x.x	An array of values, each of which decides to exclude a potential duplicate from evaluation.	Array of Strings	Editable field
Positive value (duplicate detected)*	1.0.2	The value to be entered into the target variable if a duplicate is found.	Text	Editable field
Negative value (the process is unique)*	1.0.2	Value to be entered into the target variable if no duplicate is found.	Text	Editable field

Parameter*- mandatory field

Panel

title	Configuration example

Image Removed

Panel

title	Change log

1.0.2

Component adding

1.0.9

Error on the first task in the process

1.0.25

Improved throwing exceptions

1.0.41

Solved the problem of checking logical values on Oracle

x.x (current documentation)

Adding "Variables that exclude potential duplicates" and "Values for exclusion variables" parameters

X

type

Specifies what type of watermark is.

Text

Value	Meaning
BARCODE	Barcode

Format

1.0.X

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), $, /, +,%, *).
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.
CODE_128	Variable length, high density alphanumeric code. It can encode characters from the entire ASCII range.

Index ID

1.0.X

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

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

codeHeight

Defines the height of the watermark in pixels.

Text

Position

1.0.X

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

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

opacity

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

Float

Value in the range 0-1.

Permissions

1.0.X

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

Panel

title	Configuration example

Image Added

Info

title	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
    }
  }
]

Panel

title	Change log

1.0.X

Hook adding

Versions Compared

Old Version 12

New Version 13

Key

Dostępny od: 1.0.X

Category: General

Available from version: 1.0.

X