Page History

Polish

Panel

bgColor	white
titleBGColor	light
title	Podstawowe informacje

Pakiet: com.suncode.plugin.tools.scheduledtask.ArchiveEncryptionTask

Dostępna od wersji: 1.0.25

Panel

bgColor	white
titleBGColor	light
title	Opis

Zadanie szyfruje niezaszyfrowane pliki w wybranej klasie dokumentów w archiwum. Do poprawnego działania, klasa w archiwum musi mieć włączoną opcje szyfrowania. Wyszukiwanie plików jest ograniczone do podanego przedziału dat (daty utworzenia pliku). Zadanie ma wbudowany ogranicznik czasowy, po którym przerywa działanie. Ogranicznik czasowy można ustawić za pomocą parametru, podając wartość liczbową określającą maksymalny czas działania zadania w godzinach. Logi z procesu deszyfracji są zapisywane w tabeli systemowe Tab_4 pm_encryption_task_log

Więcej informacji na temat szyfrowania można znaleźć na stronie Szyfrowanie elementów w systemie

Panel

bgColor	white
titleBGColor	ligth
title	Parametry konfiguracyjne

Nazwa parametru	od wersji	Opis	Typ parametru	Uwagi i ograniczenia
Nazwa klasy*	1.0.25	Nazwa klasy, w której będą szyfrowane pliki.	Tekst	Klasa musi mieć ustawione opcje szyfrowania.
Data utworzenia pliku (od)*	1.0.25	Minimalna data utworzenia pliku.	Data	Data liczona jest od godziny 00:00:00 np jeśli wybierzemy od 2021-09-01 to znajduję wszystkie pliku od 2021-09-01 00:00:00
Data utworzenia pliku (do)*	1.0.25	Maksymalna data utworzenia pliku.	Data	Data liczona jest do godziny 00:00:00 np jeśli wybierzemy od 2021-09-01 to znajduję wszystkie pliku do 2021-09-01 00:00:00
Maksymalny czas działania zadania (w godzinach)*	1.0.25	Zadanie zaplanowane zostanie przerwane po przekroczenie czasu wykonania podanego w godzinach.	Liczba
Maksymalna liczba równolegle przetwarzanych plików*	1.0.25	Maksymalna ilość użytych wątków do przetwarzania plików. Wartość powinna być z zakresu 1 - 50.	Liczba	Im więcej wątków tym działanie jest szybsze, ale to też mocno obciąża serwer.
Interwał logowania progresu [sekundy]*	1.0.25	Czas pomiędzy logowaniem progresu przetwarzania plików liczony w sekundach. Log zostaję wyświetlany, jeżeli nastąpiła zmiana ilości przetwarzanych plików.	Liczba	Brana jest wartość bezwzględna danej liczby. Dla wartości 0 jest wstawiana 1 sekunda.
Wyłącz zadanie po zakończeniu przetwarzania*	1.0.29	Parametr pozwalający na wyłączenie zadania zaplanowanego po prawidłowym, pierwszym uruchomieniu. Przydatne w przypadku gdy uruchomienie zostanie zaplanowane w przyszłości i po pierwszym uruchomieniu chcemy je wyłączyć	Boolean	Wartość do ustawienia true/false
Indeksy	1.0.30	Ustawia wybrane indeksy w klasie dokumentów dla przetwarzanego pliku. Niezależnie którą wersja dokumentu jest przetwarzana. Jeżeli dokument posiada 5 wersji i jest znaleziony i przetwarzany tylko plik ze środkowej wersji (np. wersji 3). To indeksy na dokumencie się zaktualizują na podany. W skrócie: Jakikolwiek przetwarzany dokument zaktualizuje indeks na dokumencie.	Tekst	Format JSON w postaci {"nazwaIndeksu":"wartość"} przykład: {"status":"Szyfracja","numerek":"123","czas":"2022-01-12"}
Id źródła danych	1.0.31	Id źródła, do którego zostaną zapisane dane	Tekstowy
Wartości parametrów źródła	1.0.31	Obiekt JSON zawierający konfigurację wejściową źródła danych (w formacie {'x':'y',...}, gdzie x - id parametru źródła; y - wartość parametru). Korzystamy tutaj ze znaczników.	Tekstowy

Znaczniki wykorzystujemy do mapowania wartości w źródle danych.

Dostępne znaczniki:

Znacznik	Opis
Informacje o ostatnim czasie wykonania zadania
{timestamp}	trzynastocyfrowa liczba milisekund liczona od 01.01.1970 (timestamp)
{DD}	dwucyfrowa liczba reprezentująca dzień miesiąca
{MM}	dwucyfrowa liczba reprezentująca miesiąc
{YY}	dwucyfrowa liczba reprezentująca rok
{YYYY}	czterocyfrowa liczba reprezentująca rok
{hh}	dwucyfrowa liczba reprezentująca godzinę
{mm}	dwucyfrowa liczba reprezentująca minuty
{ss}	dwucyfrowa liczba reprezentująca sekundy
{nnn}	trzycyfrowa liczba reprezentująca nanosekundy
Informacje o obecnym czasie
{current_timestamp}	obecny czas w formie trzynastocyfrowej liczby milisekund liczonej od 01.01.1970
{current_DD}	dwucyfrowa liczba reprezentująca obecny dzień miesiąca
{current_MM}	dwucyfrowa liczba reprezentująca obecny miesiąc
{current_YY}	dwucyfrowa liczba reprezentująca obecny rok
{current_YYYY}	czterocyfrowa liczba reprezentująca obecny rok
{current_hh}	dwucyfrowa liczba reprezentująca obecną godzinę
{current_mm}	dwucyfrowa liczba reprezentująca obecne minuty
{current_ss}	wucyfrowa liczba reprezentująca obecne sekundy
{current_nn}	trzycyfrowa liczba reprezentująca obecne nanosekundy
Informacje o pliku
{id}	Id pliku
{name}	Nazwa pliku
{org_name}	Oryginalna nazwa pliku
{path}	Ścieżka do pliku
{cipher_algorithm}	Algorytm szyfrowania
{cipher_key}	Klucz algorytmu szyfrowania
{file_date}	Data dodania
{uploader}	Login użytkownika który dodał plik
{description}	Opis
{file_size}	Rozmiar pliku
{compressed}	Infromacja czy plik jest skompresowany
{encrypted}	Informacja czy plik jest zaszyfrowany
{doc_class_id}	Id klasy dokumentu
{doc_class_name}	Nazwa klasy dokumentu

Panel

title	Przykładowa konfiguracja

Panel

bgColor	white
titleBGColor	light
title	Change log

1.0.25 (obowiązująca dokumentacja)

Utworzenie zadania zaplanowanego

1.0.29 (obowiązująca dokumentacja)

Dodanie parametru Wyłącz zadanie po zakończeniu przetwarzania*
Dodanie tabeli z logami

1.0.30 (obowiązująca dokumentacja)

Dodanie parametru Indeksy

1.0.31

Dodanie parametru Id źródła danych i Wartości parametrów źródła

English

Panel

bgColor	white
titleBGColor	light
title	Basic information

Package: com.suncode.plugin.tools.scheduledtask.ArchiveEncryptionTask

Available from version: 1.0.25

Panel

bgColor	white
titleBGColor	light
title	Description

The task encrypts unencrypted files in the selected document class in the archive. For correct operation, the class in the archive must have the encryption options enabled. The search for files is limited to the given date range (file creation date). The task has a built-in timer after which it stops running. The time limiter can be set using the parameter, giving a numerical value that specifies the maximum duration of the task in hours. Logs from the decryption process are saved in the system table Tab_4 "pm_encryption_task_log"

Panel

bgColor	white
titleBGColor	ligth
title	Configuration parameters

Parameter name	from version	Description	The type of the parameter	Notes and Restrictions
Document class name*	1.0.25	The name of the class in which the files will be encrypted	String	The class must have encryption options set
File creation date (from)*	1.0.25	Minimum file creation date	Date
File creation date (until)*	1.0.25	Maximum file creation date	Date
Maximum task runtime (in hours)*	1.0.25	The scheduled task will be terminated after exceeding the specified hours execution time	Number
Maximum number of files processed in parallel*	1.0.25	Maximum number of threads used to process files. The value should be in the range 1 - 50.	Number	The more threads, the faster the operation, but it also places a heavy load on the server
Progress logging interval [seconds]*	1.0.25	The time between logging file processing progress, counted in seconds. The log is displayed if the number of processed files has changed.	Number	The absolute value of a given number is taken. For value 0, 1 second is inserted.
Turn off the task when finished*	1.0.29	A parameter that allows you to disable a scheduled task after it is properly run for the first time. Useful when the launch is scheduled in the future and we want to disable it after the first launch	Boolean	Values: true/false
Index Mapping	1.0.30	Sets the selected indexes in the document class for the file being processed. Regardless of which version of the document is being processed. If a document has 5 versions and only the middle version file (e.g. version 3) is found and processed. The indexes on the document will update to the specified version. In short: Any document being processed will update the index on the document.	String	JSON format in the form {"indexname": "value"} example: {"status":"Encrypt","number":"123","time":"2022-01-12"}
Data source id	1.0.31	Id of the source to which the data will be written	String
Source calling parameters	1.0.31	JSON object containing the input configuration of the data source (in the format {'x': 'y', ...}, where x - source parameter id; y - parameter value). We use tags here.	String

Tags	Description
Information about the last time the task was performed
{timestamp}	thirteen-digit number of milliseconds from 01.01.1970 (timestamp)
{DD}	two-digit number representing the day of the month
{MM}	two-digit number representing the month
{YY}	two-digit number representing the year
{YYYY}	four-digit number representing the year
{hh}	two-digit number representing hour
{mm}	two-digit number representing minutes
{ss}	two-digit number representing seconds
{nnn}	three-digit number representing nanoseconds
Information about actual time
{current_timestamp}	thirteen-digit number of milliseconds from 01.01.1970 (timestamp)
{current_DD}	two-digit number representing the day of the month
{current_MM}	two-digit number representing the month
{current_YY}	two-digit number representing the year
{current_YYYY}	four-digit number representing the year
{current_hh}	two-digit number representing hour
{current_mm}	two-digit number representing minutes
{current_ss}	two-digit number representing seconds
{current_nn}	three-digit number representing nanoseconds
Information about file
{id}	File id
{name}	File name
{org_name}	Original file name
{path}	Path to file
{cipher_algorithm}	Cipher algorithm
{cipher_key}	Cipher algorithm key
{file_date}	File date
{uploader}	Login of user who upload file
{description}	Description
{file_size}	File size
{compressed}	Information whether file is compressed
{encrypted}	Information wherher file is encrypted
{doc_class_id}	Document class id
{doc_class_name}	Document class name