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. |
Klasy dokumentów [Proces] | 1.0.0 | Nazwy klas dokumentów, z których pobierane są dokumenty. | Tablica wartości tekstowych | | Lista wartości | W przypadku pustej tablicy nazw klas dokumentów (nieuzupełnienia parametru), zostaną pobrane wszystkie dokumenty podłączone do procesu. |
Klasa dokumentów [Archiwum]* | 1.0.0 | Nazwa klasy dokumentów, z której pobierane są dokumenty. | Tekst | | Lista wartości | |
Nazwa indeksu [Odczyt] | 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 Klasa dokumentów [Archiwum] jest użyta zmienna lub funkcja, to pole tego parametru stanie się polem edytowalnym. |
Wartość indeksu [Odczyt] | 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. | Tablica liczb całkowitych | | 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 |
|
Tryb debug | 1.0.0 | Otwiera okno konsoli aplikacji SzafirHost w trakcie działania akcji. | Logiczny | Nie | Pole edytowalne | |
Identyfikatory źródłowych plików | 1.0.0 | 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.0 | 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. |
Zapis 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 | |
Klasa dokumentów [Zapis] | 1.0.0 | Nazwa klasy dokumentów, w której zostanie zapisany plik z podpisem. | Tekst | | Lista wartości | |
Nazwa indeksu [Zapis] | 1.0.0 | Nazwa indeksu 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 Klasa dokumentów [Zapis] jest użyta zmienna lub funkcja, to pole tego parametru stanie się polem edytowalnym. |
Wartość indeksu [Zapis] | 1.0.0 | Wartość indeksu 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 | |