Polish |
---|
← Powrót do listy dostępnych hook'ów 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.X17 |
Panel |
---|
| 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.X17 | documentClassId | Klasa dokumentów wskazuje dla których dokumentów mają być brane pod uwagę parametry wstawiania znaku wodnego. | Całkowity | | Typ | 1.0.X17 | type | Określa jakiego typu jest znak wodny.
| Tekstowy | Wartość | Znaczenie |
---|
BARCODE | Kod kreskowy |
| Format | 1.0.X17 | format | Określa standard kodów kreskowych w postaci jednowymiarowej (zapis informacji w jednej linii, w formie kresek). | Tekstowy | Wartość | Znaczenie |
---|
CODE_39 | Kod Jednowymiarowy kod kreskowy zawierający znaki alfanumeryczne o zmiennej długości, pozwalające 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 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 | 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 | | |
Image Added
| 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 | | |
Image Added
| CODE_128 | Kod alfanumeryczny o zmiennej długości i wysokiej gęstości. Potrafi kodować znaki z całego zakresu ASCII. Image Added
|
| Identyfikator indeksu | 1.0.X17 | 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.X17 | 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.X17 | codeHeight | Definiuje długość znaku wodnego w pikselach. | Całkowity | | Umiejscowienie | 1.0.X17 | 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.X17 | 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.X17 | opacity | Określa przezroczystość wstawianego znaku wodnego na stronach dokumentu. | Zmiennoprzecinkowy | Wartość z przedziału 0-1. | Uprawnienia | 1.0.X17 | 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 |
---|
| "type": "BARCODE", "format": "CODE_128", "groups": ["Users", "Administrators"] "type": "BARCODE", "format": "CODE_128", |
|
|
English |
---|
← ← Return to the list of applicationshooks Panel |
---|
| Category: GeneralAvailable from version: 1.0.217
|
Panel |
---|
| 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 | Paremeter type | Default value | Field type | 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*
| 17 | 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 |
---|
|
|
1.0.2
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
...
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 | | |
Image Added
| 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 | | |
Image Added
| CODE_128 | Variable length, high density alphanumeric code. It can encode characters from the entire ASCII range. Image Added
|
| 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 | |
|
Panel |
---|
title | Configuration example |
---|
| Image Added
Info |
---|
title | Example JSON configuration |
---|
| "type": "BARCODE", "format": "CODE_128", "groups": ["Users", "Administrators"] "type": "BARCODE", "format": "CODE_128", |
|
Panel |
---|
| 1.0.17 1.0.26 (applicable documentation) - Fix the situation where there is no user context
1.0.X - Adding a @Deprecated Annotation
|
|