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ść | ZnaczenieOpis |
---|
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%.
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. WartośćDostępne wartości | Znaczenie |
---|
TOP_LEFT | Pozycja znaku wodnego względem górnego lewego rogu. Image Removed
| TOP_RIGHT | Pozycja znaku wodnego względem górnego prawego rogu. Image Removed
| BOTTOM_LEFT | Pozycja znaku wodnego względem dolnego lewego rogu. Image Removed
| BOTTOM_RIGHT | Pozycja znaku wodnego względem dolnego prawego rogu. Image Removed
|
|
anchor* (watermark) | 1.0.0 | Określa pozycję znaku wodnego względem odpowiedniego rogu znaku wodnego. | Tekstowy | Wartość | Znaczenie |
---|
TOP_LEFT | Pozycja znaku wodnego względem lewego górnego rogu znaku wodnego. Image Removed
| TOP_MIDDLE | Pozycja znaku wodnego względem górnego środka znaku wodnego. Image Removed
| TOP_RIGHT | Pozycja znaku wodnego względem prawego górnego rogu znaku wodnego. Image Removed
| CENTER_LEFT | Pozycja znaku wodnego względem lewego środka wodnego. Image Removed
| CENTER_MIDDLE | Pozycja znaku wodnego względem środka znaku wodnego. Image Removed
| CENTER_RIGHT | Pozycja znaku wodnego względem prawego środka znaku wodnego. Image Removed
| BOTTOM_LEFT | Pozycja znaku wodnego względem lewego dolnego rogu znaku wodnego. Image Removed
| BOTTOM_MIDDLE | Pozycja znaku wodnego względem dolnego środka znaku wodnego. Image Removed
| BOTTOM_RIGHT | Pozycja znaku wodnego względem prawego dolnego rogu znaku wodnego. Image Removed
|
| 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.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 stopień widoczności (nieprzezroczystość) wstawianego znaku wodnego. | Zmiennoprzecinkowy | Element jest w pełni przezroczysty (niewidoczny). - Wartość z przedziału (0, 1)
Element jest częściowo przezroczysty. Element jest w pełni nieprzezroczysty (jednolity). |
clockwiseAngle* (watermark.watermarkText) | 1.0.0 | Rotacja znaku wodnego zgodnie z kierunkiem ruchu wskazówki zegara. | Zmiennoprzecinkowy | |
format* (watermark.watermarkBarcode) | 1.0.0 | Określa standard kodów kreskowych w postaci jednowymiarowej (zapis informacji w jednej linii, w formie kresek).kodu kreskowego.
Więcej informacji... | Tekstowy | WartośćDostępne wartościZnaczenie |
---|
AZTEC | CODABAR | 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. | DATA_MATRIX | EAN_8 | EAN_13 | ITF | PDF_417 | QR_CODE | UPC_A | UPC_E |
|
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 | |
sizetextUnderBarcode* (watermark.watermarkBarcode) | 1.0.0 | Określa, czy ma być wyświetlany pod kodem kreskowym tekst, który został w nim zakodowany. | | |
fontSize* (watermark.watermarkText) | 1.0.0 | Rozmiar tekstu. | Zmiennoprzecinkowy | |
fontType* (watermark.watermarkText) | 1.0.0 | Rodzaj czcionki tekstu. | Tekstowy | Wartość | ZnaczenieOpis |
---|
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 | Wartość | ZnaczenieOpis |
---|
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.
Więcej informacji... | Tekstowy | WartośćDostępne wartości | 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. |
|
errorHandling* | 1.0.0 | Sposób obsługi 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ść | ZnaczenieOpis |
---|
BLOCK | Wyświetlana jest strona HTML z informacją o błędzie. Nie ma możliwości pobrania oryginalnego (bez znaku wodnego) dokumentu. | DISPLAY_ORIGINAL | Wyświetlany jest oryginalny dokument i jest on możliwy do pobrania. |
Warning |
---|
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.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. |