| Nazwa parametru | Od wersji | Opis | Typ parametru | Wartość domyślna | Rodzaj pola | Uwagi i ograniczenia |
|---|
| Źródło pobierania plików* | 1.0.0 | Określa z jakiego źródła mają być pobierane pliki przeznaczone do podpisania. Dostępne są 3 opcje: - Proces - pobierane są dokumenty podpięte do procesu.
- Archiwum - pobierane są dokumenty z archiwum, z określonej klasy dokumentów.
- Identyfikatory plików z archiwum - pobierane są z archiwum wyszczególnione pliki po identyfikatorze.
| Tekst | | Lista wartości | | Wartość wyświetlana | Wartość przekazywana |
|---|
| Proces | PROCESS | | Archiwum | ARCHIVE | | Identyfikatory plików z archiwum | FILEIDS |
W przypadku wybrania opcji "Proces" lub "Archiwum", zostanie pobrana najnowsza wersja dokumentu. |
| Źródłowe klasy dokumentów [Proces/Identyfikatory plików z archiwum]* | 1.0.0 | Nazwy klas dokumentów, z których pobierane są pliki do podpisu. Wynikowe pliki z podpisem są wersjonowane we wskazanych klasach dokumentów, jeśli parametr Zapisz jako nowa wersja jest ustawiony na Tak. | Tablica wartości tekstowych | | Lista wartości | Nazwy klas dokumentów w kolumnie nie mogą się powtarzać. |
| Docelowe klasy dokumentów [Proces/Identyfikatory plików z archiwum]* | 1.0.3 | Wskazuje podłączonym do procesu plikom z określonych źródłowych klas dokumentów miejsce do zapisu ich odpowiadających plików z podpisem w wybranych docelowych klasach dokumentów. | Tablica wartości tekstowych | | Lista wartości | Parametr jest dostępny, gdy parametr Zapisz jako nowa wersja jest ustawiony na Nie. |
| Źródłowa klasa dokumentów [Archiwum]* | 1.0.0 | Nazwa klasy dokumentów, z której pobierane są pliki do podpisu. Wynikowe pliki z podpisem są wersjonowane we wskazanej klasie dokumentów, jeśli parametr Zapisz jako nowa wersja jest ustawiony na Tak. | Tekst | | Lista wartości | |
| Nazwy indeksów [Filtrowanie po indeksach - Archiwum] | 1.0.0 | Opcjonalne filtrowanie po indeksach wybranej klasy dokumentów. W tym parametrze określana jest nazwa indeksu. | Tablica wartości tekstowych | | Lista wartości / pole edytowalne | Lista indeksów do wyboru po wybraniu określonej klasy dokumentów. Jeśli w parametrze Źródłowa Klasa dokumentów [Archiwum] jest użyta zmienna lub funkcja, to pole tego parametru stanie się polem edytowalnym. |
| Wartości indeksów [Filtrowanie po indeksach - Archiwum] | 1.0.0 | Opcjonalne filtrowanie po indeksach wybranej klasy dokumentów. W tym parametrze określana jest wartość indeksu. | Tablica wartości tekstowych | | Pole edytowalne | |
| Identyfikatory plików* | 1.0.0 | Identyfikatory plików do pobrania z archiwum. Wynikowe pliki z podpisem są wersjonowane we wskazanych identyfikatorach dokumentów z archiwum, jeśli parametr Zapisz jako nowa wersja jest ustawiony na Tak. | Tablica liczb całkowitych | | Pole edytowalne | |
| Zapisz jako nowa wersja* | 1.0.0 | Ustawienie na Tak powoduje, że plik z podpisem zostanie zapisany jako nowa wersja wejściowego dokumentu. W przypadku ustawienia na "Nie", plik z podpisem zostanie zapisany w określonej klasie dokumentów i indeksami jako nowy dokument. | Logiczny | Tak | Pole edytowalne | |
| Klasy dokumentów [Mapowanie indeksów - Proces/Identyfikatory plików z archiwum] | 1.0.3 | Nazwy klas dokumentów, w których zostanie zapisany plik z podpisem. | Tablica wartości tekstowych | | Lista wartości | W parametrze mogą zostać wykorzystane tylko te klasy dokumentów, które zostały wcześniej zdefiniowane w parametrze Docelowe klasy dokumentów [Proces/Identyfikatory plików z archiwum]. W przypadku, gdy w jednej z wartości parametru Docelowe klasy dokumentów [Proces/Identyfikatory plików z archiwum] występuje funkcja lub zmienna, reguła nie jest stosowana. |
| Nazwy indeksów [Mapowanie indeksów - Proces/Identyfikatory plików z archiwum] | 1.0.3 | Nazwy indeksów z wybranych klas dokumentów. | Tablica wartości tekstowych | | Lista wartości | |
| Wartości indeksów [Mapowanie indeksów - Proces/Identyfikatory plików z archiwum] | 1.0.3 | Nazwy indeksów z wybranych klas dokumentów. Możliwość skorzystania ze słów kluczowych SOURCE_FILE_ID oraz SOURCE_DOCUMENT_CLASS_NAME pełniących role mapowania informacji o źródłowym identyfikatorze pliku i źródłowej klasie dokumentów, z której pochodzi dokument przekazany do podpisu. | Tablica wartości tekstowych | | Pole edytowalne | Słowa kluczowe są zwykłym pisanym tekstem - nie wybiera się ich z listy zmiennych tak jak w przypadku np. zmiennych kontekstowych. |
| Docelowa klasa dokumentów [Archiwum]* | 1.0.0 | Nazwa klasy dokumentów, do której będą mogły zostać zapisane podpisane już pliki ze wskazanej klasy dokumentów z archiwum. | Tekst | | Lista wartości | |
| Nazwy indeksów [Mapowanie indeksów - Archiwum] | 1.0.0 | Nazwy indeksów z wybranej klasy dokumentów. | Tablica wartości tekstowych | | Lista wartości / pole edytowalne | Lista indeksów do wyboru po wybraniu określonej klasy dokumentów. Jeśli w parametrze Docelowa klasa dokumentów [Archiwum] jest użyta zmienna lub funkcja, to pole tego parametru stanie się polem edytowalnym. |
| Wartości indeksów [Mapowanie indeksów - Archiwum] | 1.0.0 | Wartości indeksów z wybranej klasy dokumentów. Możliwość skorzystania ze słów kluczowych SOURCE_FILE_ID oraz SOURCE_DOCUMENT_CLASS_NAME pełniących role mapowania informacji o źródłowym identyfikatorze pliku i źródłowej klasie dokumentów, z której pochodzi dokument przekazany do podpisu. | Tablica wartości tekstowych | | Pole edytowalne | Słowa kluczowe są zwykłym pisanym tekstem - nie wybiera się ich z listy zmiennych tak jak w przypadku np. zmiennych kontekstowych. |
| Dodaj dokument do procesu | 1.0.0 | Dołącza plik z podpisem do procesu. | Logiczny | Nie | Pole edytowalne | |
| Wywołanie akcji w klasie dokumentów | 1.0.0 | Wywołuje akcje, które mają ustawione źródło akcji na "Dodanie nowego dokumentu z poziomu archiwum". | Logiczny | Nie | Pole edytowalne | |
| Zapisz formularz po zakończeniu akcji | 1.0.3 | Zapisuje formularz po pomyślnym wykonaniu akcji. | Logiczny | Nie | Pole edytowalne | |
| Tryb działania* | 1.0.0 | Określa sposób działania aplikacji Szafir. Tryb "Okno Szafir" umożliwia realizację składania podpisu przy użyciu natywnego graficznego interfejsu użytkownika. Natomiast tryb "Okno z kodem PIN i opcjonalnym wyborem certyfikatu" realizuje składanie podpisu z wykorzystaniem okna dialogowego, w którym podaje się PIN do urządzenia kryptograficznego i opcjonalnie plik z certyfikatem. | Tekst | | Lista wartości | | Wartość wyświetlana | Wartość przekazywana |
|---|
| Okno Szafir | SZAFIR_WINDOW | | Okno z kodem PIN i opcjonalnym wyborem certyfikatu | PIN_AND_CERTIFICATE_WINDOW |
Wybór wartości "Okno Szafir" skutkuje pojawieniem się parametru Certyfikat, a wybranie "Okno z kodem PIN i opcjonalnym wyborem certyfikatu" pojawieniem się parametru Certyfikat i Użytkownik wybiera certyfikat. |
| Certyfikat* | 1.0.0 | Nazwa pliku zawierająca konfigurację certyfikatu, który pochodzi z panelu zarządzania konfiguracjami wtyczek (PCM - Plugin Configuration Manager). Parametr przedstawia listę wszystkich utworzonych plików z konfiguracją certyfikatu. UWAGA: Id konfiguracji PCM podajemy bez rozszerzenia (np. "(JSON)", "(XML)") | Tekst | | Lista wartości | |
| Użytkownik wybiera certyfikat | 1.0.0 | Określa, czy użytkownik na formularzu może wybrać plik z certyfikatem pochodzący z panelu zarządzania konfiguracjami wtyczek (PCM - Plugin Configuration Manager). Wybór jest możliwy z poziomu okna dialogowego, które pojawia się w trakcie działania aplikacji Szafir i obejmuje certyfikaty określone w parametrze Dostępne certyfikaty. | Logiczny | Nie | Pole edytowalne | Ustawienie parametru na "Tak" powoduje pojawienie się parametru Dostępne certyfikaty i ukrycie parametru Certyfikat, a ustawienie na "Nie" pozostawia Certyfikat widoczny. |
| Dostępne certyfikaty | 1.0.0 | Określa możliwe do wyboru przez użytkownika na formularzu pliki z certyfikatem z poziomu okna dialogowego. Parametr przedstawia listę wszystkich utworzonych plików z konfiguracją certyfikatu. | Tablica wartości tekstowych | | Lista wartości | |
| Wersja podpisu* | 1.0.0 | Określa wersję podpisu. Więcej informacji... | Tekst | | Lista wartości | | Wartość wyświetlana | Wartość przekazywana |
|---|
| BES | BES | | T | T | | LTV/A | LTV_A |
|
| Format podpisu* | 1.0.0 | Określa format podpisu. Parametr przedstawia listę dostępnych formatów w zależności od wybranej wersji podpisu. Więcej informacji... | Tekst | | Lista wartości | | Wartość wyświetlana | Wartość przekazywana |
|---|
| ASIC-S-CAdES-BES | ASIC_S_CADES_BES | | ASIC-S-XAdES-BES | ASIC_S_XADES_BES | | CAdES-BES | CADES_BES | | EPO-XAdES-BES | EPO_XADES_BES | | PAdES-BES | PADES_BES | | PKCS#7 | PKCS7 | | XAdES-BES | XADES_BES |
| Wartość wyświetlana | Wartość przekazywana |
|---|
| ASIC-S-CAdES-T | ASIC_S_CADES_T | | ASIC-S-XAdES-T | ASIC_S_XADES_T | | CAdES-T | CADES_T | | EPO-XAdES-T | EPO_XADES_T | | PAdES-T | PADES_T | | PKCS#7 with Time | PKCS7_WITH_TIME | | PKCS#7-T | PKCS7_T | | XAdES-T | XADES_T |
| Wartość wyświetlana | Wartość przekazywana |
|---|
| EPO-XAdES-A | EPO_XADES_A | | EPO-XAdES-A-REFRESH | EPO_XADES_A_REFRESH | | PAdES-LTV | PADES_LTV | | PAdES-LTV-REFRESH | PADES_LTV_REFRESH | | XAdES-A | XADES_A | | XAdES-A-REFRESH | XADES_A_REFRESH |
|
| Automatyczne wstawianie elementu graficznego | 1.0.3 | Określa, czy dołączyć do dokumentu z podpisem PAdES element graficzny zawierający informacje o podmiocie świadczącym usługi zaufania, osobie podpisującej oraz dacie złożenia podpisu. | Logiczny | Nie | Pole edytowalne | Ustawienia wstawiania elementu graficznego są widoczne wtedy, gdy Format podpisu zawiera jedną z następujących wartości: PAdES-BES, PAdES-T, PAdES-LTV, PAdES-LTV-REFRESH. |
| Wstaw plik graficzny | 1.0.3 | Określa, czy do tekstowych informacji związanych z podpisem ma zostać dodana grafika, do której dostęp definiuje się przez ścieżkę do pliku. | Logiczny | Nie | Pole edytowalne | |
| Ścieżka do pliku graficznego | 1.0.3 | Absolutna ścieżka do pliku graficznego w formacie .jpg. Istnieje możliwość skorzystania ze słowa kluczowego DEFAULT_IMAGE, które oznacza, że zostanie wstawiony domyślny plik graficzny znajdujący się we wtyczce. | Tekst | DEFAULT_IMAGE | Pole edytowalne | Parametr jest widoczny wtedy, gdy Wstaw plik graficzny jest ustawiony na Tak. Słowo kluczowe jest zwykłym pisanym tekstem - nie wybiera się go z listy zmiennych tak jak w przypadku np. zmiennych kontekstowych. |
| Numer strony dokumentu | 1.0.3 | Definiuje numer strony dokumentu, na której ma zostać zamieszczony element graficzny. Chcąc umieścić element graficzny na końcu dokumentu, należy użyć wartości ujemnej wskazującej na numer strony liczony od ostatniej. | Tekst | | Pole edytowalne | |
| Odległość od lewej krawędzi dokumentu% | 1.0.3 | Określa współrzędne umieszczenia elementu graficznego na dokumencie. Punktem zaczepienia (zakotwiczenie) na grafice, czyli punktem, od którego jest ustawiane położenie grafiki jest lewy dolny róg grafiki. Odległość od lewej krawędzi jest podawana w procentach. | Całkowity | | Pole edytowalne | |
| Odległość od dolnej krawędzi dokumentu% | 1.0.3 | Określa współrzędne umieszczenia elementu graficznego na dokumencie. Punktem zaczepienia (zakotwiczenie) na grafice, czyli punktem, od którego jest ustawiane położenie grafiki jest lewy dolny róg grafiki. Odległość od dolnej krawędzi jest podawana w procentach. | Całkowity | | Pole edytowalne | |
| Wysokość% | 1.0.3 | Definiuje wysokość elementu graficznego w procentach. | Całkowity | | Pole edytowalne | Minimalna wysokość procentowa do wyświetlenia domyślnej ikony to 6. |
| Szerokość% | 1.0.3 | Definiuje wysokość elementu graficznego w procentach. | Całkowity | | Pole edytowalne | Minimalna szerokość procentowa do wyświetlenia domyślnej ikony to 6. |
| Tryb debug | 1.0.0 | Otwiera okno konsoli aplikacji SzafirHost w trakcie działania akcji. | Logiczny | Nie | Pole edytowalne | |
| Zapisz informacje o podpisywanych plikach | 1.0.3 | Określa, czy zapisywać w kolumnach tabeli informacje dotyczące rezultatu podpisywanych plików. Na informacje mogą składać się identyfikatory i nazwy źródłowych plików, identyfikatory podpisanych plików, statusy przetworzenia i opisy błędów. | Logiczny | Nie | Pole edytowalne | |
| Tryb zapisu informacji w tabeli | 1.0.3 | Określa tryb zapisu informacji o wynikach podpisywanych plików w tabeli. Dostępne są trzy tryby: - Nadpisz - nadpisuje całą tabelę informacjami z ostatniego wywołania akcji.
- Dopisz - dopisuje informacje do tabeli nie naruszając istniejących wierszy.
- Aktualizuj - aktualizuje i dopisuje wartości do tabeli. Kluczem, po którym są aktualizowane wartości, jest parametr Identyfikatory źródłowych plików. Tryb aktualizacji działa na zasadzie UPSERT.
| Tekst | | Lista wartości | | Wartość wyświetlana | Wartość przekazywana |
|---|
| Nadpisz | OVERWRITE | | Dopisz | ADD | | Aktualizuj | UPDATE |
|
| Identyfikatory źródłowych plików | 1.0.2 | Parametr, w którym wskazuje się kolumnę, w której są zapisywane identyfikatory (fileIds) źródłowych plików stanowiących dokumenty przekazane do podpisu. Parametr jest uzupełniany po zakończeniu operacji podpisu na wszystkich plikach. | Zmienna | | Pole edytowalne | Parametr jest jednym z pięciu możliwych parametrów do zdefiniowania składających się na tabelę w sekcji Podsumowanie informacji o wynikach podpisywanych plików. Tabela jest czyszczona za każdym razem po wywołaniu mechanizmu wstawiania podpisu niezależnie od tego ile kolumn posiada. Tabela przechowuje informacje ostatniego wywołania akcji. |
| Nazwy źródłowych plików | 1.0.2 | Parametr, w którym wskazuje się kolumnę, w której są zapisywane nazwy źródłowych plików stanowiących dokumenty przekazane do podpisu. Parametr jest uzupełniany po zakończeniu operacji podpisu na wszystkich plikach. | Zmienna | | Pole edytowalne | Parametr jest jednym z pięciu możliwych parametrów do zdefiniowania składających się na tabelę w sekcji Podsumowanie informacji o wynikach podpisywanych plików. Tabela jest czyszczona za każdym razem po wywołaniu mechanizmu wstawiania podpisu niezależnie od tego ile kolumn posiada. Tabela przechowuje informacje ostatniego wywołania akcji. |
| Identyfikatory podpisanych plików | 1.0.2 | Parametr, w którym wskazuje się kolumnę, w której są zapisywane identyfikatory (fileIds) podpisanych, wynikowych plików. Parametr jest uzupełniany po zakończeniu operacji podpisu na wszystkich plikach. | Zmienna | | Pole edytowalne | Parametr jest jednym z pięciu możliwych parametrów do zdefiniowania składających się na tabelę w sekcji Podsumowanie informacji o wynikach podpisywanych plików. Tabela jest czyszczona za każdym razem po wywołaniu mechanizmu wstawiania podpisu niezależnie od tego ile kolumn posiada. Tabela przechowuje informacje ostatniego wywołania akcji. Gdy dla danego pliku źródłowego operacja podpisu zakończy się niepowodzeniem, komórka w kolumnie będzie pusta. |
| Statusy przetworzenia plików | 1.0.2 | Parametr, w którym wskazuje się kolumnę, w której są zapisywane statusy wykonywania operacji podpisu na plikach. Dostępne są dwie wartości statusu: OK - w przypadku pomyślnie wykonanego podpisu, ERROR - w przypadku napotkania błędu. Parametr jest uzupełniany po zakończeniu operacji podpisu na wszystkich plikach. | Zmienna | | Pole edytowalne | Parametr jest jednym z pięciu możliwych parametrów do zdefiniowania składających się na tabelę w sekcji Podsumowanie informacji o wynikach podpisywanych plików. Tabela jest czyszczona za każdym razem po wywołaniu mechanizmu wstawiania podpisu niezależnie od tego ile kolumn posiada. Tabela przechowuje informacje ostatniego wywołania akcji. |
| Opisy błędów | 1.0.2 | Parametr, w którym wskazuje się kolumnę, w której są zapisywane opisy błędów występujących przy próbach podpisu plików wskazanych w parametrze Identyfikatory źródłowych plików. Wartość parametru jest wypełniana, tylko gdy status przetworzenia dla danego pliku ma wartość ERROR. Parametr jest uzupełniany po zakończeniu operacji podpisu na wszystkich plikach. | Zmienna | | Pole edytowalne | Parametr jest jednym z pięciu możliwych parametrów do zdefiniowania składających się na tabelę w sekcji Podsumowanie informacji o wynikach podpisywanych plików. Tabela jest czyszczona za każdym razem po wywołaniu mechanizmu wstawiania podpisu niezależnie od tego ile kolumn posiada. Tabela przechowuje informacje ostatniego wywołania akcji. Jeśli pomyślnie zostanie podpisany określony plik źródłowy, komórka w kolumnie będzie pusta. |
