Versions Compared

Old Version 27

changes.mady.by.user Kamil Rogowski

Saved on

compared with

New Version 28

changes.mady.by.user Kamil Rogowski

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Polish
Info
Jeśli masz problem ze zrozumieniem jak działa akcja, sprawdź opisy: Akcja, Wykonanie warunkowe, Parametry komponentów
Panel
titlePodstawowe informacje

Kategoria: eSignature

Umiejscowienie akcji: Przycisk, Przycisk tabeli

Dostępna od wersji: 1.0.0

Panel
titleOpis

Akcja składa podpis elektroniczny dokumentom wykorzystując certyfikat przy użyciu modułu Szafir zawierającego narzędzia kryptograficzne. Wynikowe pliki z podpisem są podpisami łącznymi, czyli zawierają dane podpisane, które są dołączane do pliku z podpisem i zakodowane przy wykorzystaniu Base64. Akcja podpisując więcej niż jeden dokument nie przerywa swojego działania przy napotkaniu błędu z konkretnym dokumentem po stronie aplikacji Szafir - po zakończeniu operacji podpisywania w wyświetlanym oknie podsumowania widnieją informacje o liczbie dokumentów podpisanych prawidłowo oraz tych, których nie udało się podpisać. Podpisane dokumenty zapisywane są w archiwum systemu.

Warning
titleWymagania wstępne

Dla prawidłowego działania akcji, należy pobrać i zainstalować:

Panel
titleWywołanie akcji
Info

Pozostawienie pustego pola wykonania warunkowego jest jednoznaczne z ustawieniem go na "prawdę".

Umiejscowienie akcjiOd wersjiDziałanie parametru "Wykonanie warunkowe"Warunek wywołania akcji
Przycisk1.0.0

Uaktywnia akcję

Naciśnięcie przycisku

Przycisk tabeli1.0.0Uaktywnia akcję

Naciśnięcie przycisku

Panel
titleParametry konfiguracyjne
Nazwa parametruOd wersjiOpisTyp parametruWartość domyślnaRodzaj polaUwagi 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:

  1. Proces - pobierane są dokumenty podpięte do procesu.
  2. Archiwum - pobierane są dokumenty z archiwum, z określonej klasy dokumentów.
  3. Identyfikatory plików z archiwum - pobierane są z archiwum wyszczególnione pliki po identyfikatorze.
Tekst Lista wartości
Wartość wyświetlanaWartość przekazywana
ProcesPROCESS
ArchiwumARCHIVE
Identyfikatory plików z archiwumFILEIDS

W przypadku wybrania opcji "Proces" lub "Archiwum", zostanie pobrana najnowsza wersja dokumentu.

Źródłowe klasy dokumentów [Proces]*1.0.0Nazwy 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ściNazwy klas dokumentów w kolumnie nie mogą się powtarzać.
Docelowe klasy dokumentów [Proces]*1.0.XWskazuje 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ściParametr jest dostępny, gdy parametr Zapisz jako nowa wersja jest ustawiony na Nie.
Źródłowa klasa dokumentów [Archiwum]*1.0.0Nazwa 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 
Nazwa indeksu [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 edytowalneLista 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ść indeksu [Filtrowanie po indeksach - Archiwum]1.0.0Opcjonalne 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.0Identyfikatory 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.0Ustawienie 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.LogicznyTakPole edytowalne 
Klasy dokumentów [Mapowanie indeksów - Proces]1.0.XNazwy klas dokumentów, w których zostanie zapisany plik z podpisem.Tablica wartości tekstowych Lista wartościW parametrze mogą zostać wykorzystane tylko te klasy dokumentów, które zostały wcześniej zdefiniowane w parametrze Docelowe klasy dokumentów [Proces]. W przypadku, gdy w jednej z wartości parametru Docelowe klasy dokumentów [Proces] występuje funkcja lub zmienna, reguła nie jest stosowana.
Nazwy indeksów [Mapowanie indeksów - Proces]1.0.XNazwy indeksów z wybranych klas dokumentów.Tablica wartości tekstowych Lista wartości 
Wartości indeksów [Mapowanie indeksów - Proces]1.0.XNazwy 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 edytowalneSł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 / Identyfikatory plików z archiwum]1.0.0Nazwa klasy dokumentów, do której będą mogły zostać zapisane podpisane już pliki ze wskazanej klasy dokumentów z archiwum lub na podstawie wybranych identyfikatorów plików.Tekst Lista wartości 
Nazwy indeksów [Mapowanie indeksów - Archiwum / Identyfikatory plików z archiwum]1.0.0Nazwy indeksów z wybranej klasy dokumentów.Tablica wartości tekstowych Lista wartości / pole edytowalneLista indeksów do wyboru po wybraniu określonej klasy dokumentów. Jeśli w parametrze Docelowa klasa dokumentów [Archiwum / Identyfikatory plików z archiwum] jest użyta zmienna lub funkcja, to pole tego parametru stanie się polem edytowalnym.
Wartości indeksów [Mapowanie indeksów - Archiwum / Identyfikatory plików z archiwum]1.0.0Wartoś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 edytowalneSłowa kluczowe są zwykłym pisanym tekstem - nie wybiera się ich z listy zmiennych tak jak w przypadku np. zmiennych kontekstowych.
Dodaj dokument do procesu1.0.0Dołącza plik z podpisem do procesu.LogicznyNiePole edytowalne 
Wywołanie akcji w klasie dokumentów1.0.0Wywołuje akcje, które mają ustawione źródło akcji na "Dodanie nowego dokumentu z poziomu archiwum".LogicznyNiePole edytowalne 
Tryb działania*1.0.0Okreś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świetlanaWartość przekazywana
Okno SzafirSZAFIR_WINDOW
Okno z kodem PIN i opcjonalnym wyborem certyfikatuPIN_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 certyfikat1.0.0Okreś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.LogicznyNiePole edytowalneUstawienie parametru na "Tak" powoduje pojawienie się parametru Dostępne certyfikaty i ukrycie parametru Certyfikat, a ustawienie na "Nie" pozostawia Certyfikat widoczny.
Dostępne certyfikaty1.0.0Okreś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świetlanaWartość przekazywana
BESBES
TT
LTV/ALTV_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
  • BES
Wartość wyświetlanaWartość przekazywana
ASIC-S-CAdES-BESASIC_S_CADES_BES
ASIC-S-XAdES-BESASIC_S_XADES_BES
CAdES-BESCADES_BES
EPO-XAdES-BESEPO_XADES_BES
PAdES-BESPADES_BES
PKCS#7PKCS7
XAdES-BESXADES_BES
  • T
Wartość wyświetlanaWartość przekazywana
ASIC-S-CAdES-TASIC_S_CADES_T
ASIC-S-XAdES-TASIC_S_XADES_T
CAdES-TCADES_T
EPO-XAdES-TEPO_XADES_T
PAdES-TPADES_T
PKCS#7 with TimePKCS7_WITH_TIME
PKCS#7-TPKCS7_T
XAdES-TXADES_T
  • LTV/A
Wartość wyświetlanaWartość przekazywana
EPO-XAdES-AEPO_XADES_A
EPO-XAdES-A-REFRESHEPO_XADES_A_REFRESH
PAdES-LTVPADES_LTV
PAdES-LTV-REFRESHPADES_LTV_REFRESH
XAdES-AXADES_A
XAdES-A-REFRESHXADES_A_REFRESH
Tryb debug1.0.0Otwiera okno konsoli aplikacji SzafirHost w trakcie działania akcji.LogicznyNiePole edytowalne 
Identyfikatory źródłowych plików1.0.0Parametr, 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 edytowalneParametr 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ów1.0.2Parametr, 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 edytowalneParametr 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ów1.0.2Parametr, 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ów1.0.2Parametr, 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 edytowalneParametr 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ów1.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.

Parametr*- pole wymagane

Panel
titlePrzykładowa konfiguracja

Image RemovedImage Added

Panel
titlePrzykład działania
Expand
titleTryb działania "Okno Szafir"

Przykład działania na podstawie poniższej konfiguracji akcji.

Image RemovedImage Added

 

Podpisywany jest jeden dokument o podanych wartościach indeksów i jego zawartość z podpisem zostanie zapisana jako nowa wersja dokumentu. Po kliknięciu w przycisk na formularzu, pod którym zdefiniowana jest akcja, otworzy się natywne okno aplikacji Szafir.

 

W tym oknie widnieje podgląd pliku przeznaczonego do podpisania oraz panel z informacjami na temat certyfikatu. W sekcji "Certyfikat do podpisywania" klikając w "Wybierz" ukazuje się okno z listą certyfikatów do wyboru, w przypadku gdy dostawca kryptografii ma więcej niż jeden certyfikat. Jednym z wariantów dostawców kryptografii może być urządzenie kryptograficzne pod postacią karty kryptograficznej przechowującej certyfikaty i komunikującej się z modułem Szafir z wykorzystaniem interfejsu PKCS#11. Do prawidłowego przedstawiania informacji o certyfikatach w oknie aplikacji Szafir, musi uprzednio zostać w sposób prawidłowy zdefiniowany plik konfiguracyjny z certyfikatem / certyfikatami (w tym przykładzie plik o nazwie settings_cryptoproviders) w PCM (Plugin Configuration Manager).

 

Po kliknięciu w głównym oknie "Podpisz" pojawi się okno do wprowadzenia PINu do klucza.

 

W ostatniej czynności zachodzi podpis dokumentu i pojawia się okno z podsumowaniem operacji. Po kliknięciu OK aplikacja Szafir się zamyka.

 

W tle działania okna Szafir, uruchamia się również konsola aplikacji SzafirHost.

Expand
titleTryb działania "Okno z kodem PIN i opcjonalnym wyborem certyfikatu"

Przykład działania na podstawie poniższej konfiguracji akcji.

Image RemovedImage Added

 

Podpisywany jest jeden dokument o podanych wartościach indeksów i jego zawartość z podpisem zostanie zapisana jako nowa wersja dokumentu. Po kliknięciu w przycisk na formularzu, pod którym zdefiniowana jest akcja, otworzy się okno dialogowe do wprowadzenia kodu PIN i wybrania certyfikatu. W polu "Certyfikat" znajdują się do wyboru dwie pozycje konfiguracji certyfikatów na podstawie skonfigurowanego w akcji parametru "Dostępne certyfikaty".


Po zatwierdzeniu wykonywany jest podpis dokumentu. W tym trybie nie otwiera się natywne okno aplikacji Szafir. Operacja podpisu opiera się w całości na zawartości pliku z konfiguracją certyfikatu. Po zakończeniu działania akcji pojawia się okno podsumowujące operacje podpisu.


W trakcie działania akcji, uruchamia się konsola aplikacji SzafirHost.

 

Panel
titleChange log

1.0.0 (obowiązująca dokumentacja)

  • Dodanie komponentu

1.0.1

  • Obsługa klawiszy ENTER i ESC w oknie z PINem oraz zaktualizowanie certyfikatów i bibliotek

1.0.2 (obowiązująca dokumentacja)

  • Dodanie parametrów Identyfikatory źródłowych plików, Nazwy źródłowych plików, Identyfikatory podpisanych plików i Statusy przetworzenia plików. Usuwanie wierszy w tabeli z błędami przy każdym wstawieniu podpisu. Dodanie słów kluczowych "SOURCE_FILE_ID" oraz "SOURCE_DOCUMENT_CLASS_NAME" w ramach parametru Wartość indeksu [Zapis]

1.0.X

  • Umożliwienie podpisywania załączonych dokumentów do procesu z wielu klas dokumentów i zapisywanie ich plików z podpisem do wielu docelowych klas dokumentów
Panel
titlePakiet z przykładowym formularzem wykorzystującym akcję

View file
nameplus_esignature_polski 2021-12-16 13_48_45 Development.zip
height250

English
Info

If you have a problem understanding how the action works, check: Action, Conditional execution, Components parameters

Panel
titleBasic information

Category: eSignature

Action location: Button, Table button

Available from version: 1.0.0

Panel
titleDescription

The action places an electronic signature on documents using a certificate using the Szafir module containing cryptographic tools. The resulting signature files are cumulative signatures, i.e. they contain signed data that is attached to the signature file and encoded using Base64. The action, when signing more than one document, does not stop its operation when it encounters an error with a specific document on the side of the Szafir application - after completing the signing operation, the displayed summary window shows information on the number of correctly signed documents and those that could not be signed. Signed documents are saved in the system archive.

Warning
titlePrerequisites

For the action to work properly, download and install:

Panel
titleAction call-up
Info

Leaving an empty conditional field is equal to setting it to "true".

Action location

From version

Conditional execution parameter action

Action call-up condition

Button

1.0.0

Activates action

Pressing the button

Table button1.0.0Activates actionPressing the button
Panel
titleConfiguration parameters
Parameter nameFrom versionDescriptionParemeter typeDefault valueField typeComments and restrictions
Files download source*1.0.0

Specifies the source from which the files to be signed are to be downloaded. There are 3 options:

  1. Process - documents attached to the process are downloaded.
  2. Archive - documents are downloaded from the archive, from a specified class of documents.
  3. File identifiers from the archive - specified files by identifier are downloaded from the archive.
Text Uneditable drop-down list
Displayed valuePassed value
ProcessPROCESS
ArchiveARCHIVE
File identifiers from the archiveFILEIDS

If you select "Process" or "Archive", the latest version of the document will be downloaded.

Document classes [Process]1.0.0The names of the classes of documents from which the documents are retrieved.Text values array Uneditable drop-down listIn case of an empty document class names table (parameter not completed), all documents attached to the process will be downloaded.
Document class [Archive]*1.0.0Name of the document class from which the documents are retrieved.Text Uneditable drop-down list 
Index name [Read]1.0.0

Optional filtering by indexes of the selected document class. This parameter specifies the name of the index.

Text values array Uneditable drop-down list / editable fieldList of indexes to choose from after selecting a specific class of documents. If a variable or function is used in the Document class [Archive] parameter, the field of this parameter becomes an editable field.
Index value [Read]1.0.0Optional filtering by indexes of the selected document class. This parameter specifies the index value.Text values array Editable field 
File identifiers1.0.0IDs of files to be downloaded from the archive.Integer values array Editable field 
Mode of operation*1.0.0Defines how the Szafir application works. The "Szafir window" mode enables the creation of a signature using the native graphical user interface. On the other hand, the "Window with PIN code and optional certificate selection" mode performs the signing with the use of a dialog in which the PIN for the cryptographic device and optionally the certificate file are entered.Text Uneditable drop-down list
Displayed valuePassed value
Szafir windowSZAFIR_WINDOW
Window with PIN code and optional certificate selectionPIN_AND_CERTIFICATE_WINDOW

Selecting the "Szafir window" value results in the appearance of the Certificate parameter, and selecting "Window with PIN code and optional certificate selection" - the Certificate parameter and the User selects certificate.

Certificate*1.0.0

File name containing the certificate configuration, which comes from the Plugin Configuration Manager (PCM) panel. The parameter presents a list of all created files with the certificate configuration.

Text Uneditable drop-down list 
User selects certificate1.0.0Specifies whether the user on the form can select the certificate file from the Plugin Configuration Manager (PCM) panel. The selection is possible from the level of the dialog box that appears while the Szafir application is running and includes the certificates specified in the Available certificates parameter.BooleanNieEditable fieldSetting the parameter to "Yes" causes the appearance of the Available certificates parameter and hides the Certificate parameter, while setting the parameter to "No" leaves the Certificate visible.
Available certificates1.0.0It defines the files with the certificate that can be selected by the user on the form from the level of the dialog box. The parameter presents a list of all created files with the certificate configuration.Text values array Uneditable drop-down list 
Signature version*1.0.0

Specifies a signature version.

 

More information...

Text Uneditable drop-down list
Displayed valuePassed value
BESBES
TT
LTV/ALTV_A
Signature format*1.0.0

Specifies the signature format. The parameter presents the list of available formats depending on the selected signature version.

 

More information...

Text Uneditable drop-down list
  • BES
Displayed valuePassed value
ASIC-S-CAdES-BESASIC_S_CADES_BES
ASIC-S-XAdES-BESASIC_S_XADES_BES
CAdES-BESCADES_BES
EPO-XAdES-BESEPO_XADES_BES
PAdES-BESPADES_BES
PKCS#7PKCS7
XAdES-BESXADES_BES
  • T
Displayed valuePassed value
ASIC-S-CAdES-TASIC_S_CADES_T
ASIC-S-XAdES-TASIC_S_XADES_T
CAdES-TCADES_T
EPO-XAdES-TEPO_XADES_T
PAdES-TPADES_T
PKCS#7 with TimePKCS7_WITH_TIME
PKCS#7-TPKCS7_T
XAdES-TXADES_T
  • LTV/A
Displayed valuePassed value
EPO-XAdES-AEPO_XADES_A
EPO-XAdES-A-REFRESHEPO_XADES_A_REFRESH
PAdES-LTVPADES_LTV
PAdES-LTV-REFRESHPADES_LTV_REFRESH
XAdES-AXADES_A
XAdES-A-REFRESHXADES_A_REFRESH
Debug mode1.0.0Opens the console window of the SzafirHost application while the action is running.BooleanNoEditable field 
Source file identifiers1.0.0A parameter where the column is indicated for saving source file identifiers (fileIds) which correspond to documents submitted for signature. The parameter is completed after the signature operation is finished.Variable Editable fieldThe parameter is one of the five possible parameters to define that make up the table in the Summary information about the results of signed files section. The table is cleared every time the signature insertion mechanism is called, no matter how many columns it has. The table stores information about the last action invocation.

Source file names

1.0.2A parameter where the column is indicated for saving source file names which correspond to documents submitted for signature. The parameter is completed after the signature operation is finished.Variable Editable fieldThe parameter is one of the five possible parameters to define that make up the table in the Summary information about the results of signed files section. The table is cleared every time the signature insertion mechanism is called, no matter how many columns it has. The table stores information about the last action invocation.
Identifiers of signed files1.0.2A parameter where the column is indicated for saving identifiers of signed and result files (fileIds). The parameter is completed after the signature operation is finished.   

The parameter is one of the five possible parameters to define that make up the table in the Summary information about the results of signed files section. The table is cleared every time the signature insertion mechanism is called, no matter how many columns it has. The table stores information about the last action invocation.

When the signature operation fails for a given source file, the cell in the column will be blank.

File processing statuses1.0.2A parameter where the column is indicated for saving statuses of performing operations on file signatures. Two status values are available: OK - in case of a successful signature, ERROR - in case of an error. The parameter is completed after the signature operation is finished.   The parameter is one of the five possible parameters to define that make up the table in the Summary information about the results of signed files section. The table is cleared every time the signature insertion mechanism is called, no matter how many columns it has. The table stores information about the last action invocation.
Error descriptions1.0.0

A parameter where the column is indicated for saving error descriptions occurring during file signature attempts for files from Source file identifiers. The parameter value is populated only when the processing status for the given file is ERROR. The parameter is completed after the signature operation is finished.

Variable Editable field

The parameter is one of the five possible parameters to define that make up the table in the Summary information about the results of signed files section. The table is cleared every time the signature insertion mechanism is called, no matter how many columns it has. The table stores information about the last action invocation.

If the specified source file is successfully signed, the cell in the column will be blank.

Save as new version*1.0.0If set to "Yes", the signature file will be saved as a new version of the input document. If set to "No", the signature file will be saved in the specified document class and indices as a new document.BooleanYesEditable field 
Document class [Save]1.0.0The name of the document class where the file with the signature will be saved.Text Uneditable drop-down list 
Index name [Save]1.0.0The name of the index from the selected document class.Text values array Uneditable drop-down list / editable fieldList of indexes to choose from after selecting a specific class of documents. If a variable or function is used in the Document class [Save] parameter, the field of this parameter becomes an editable field.
Index value [Save]1.0.0Index value from the selected document class.Text values array Editable field 
Add document to process1.0.0Attaches a signature file to the process.BooleanNoEditable field 
Execute actions in the document class1.0.0It calls actions which have the source of action set to "Add new document in archive".BooleanNoEditable field 

Parametr*- mandatory field

Panel
titleConfiguration example

Panel
titleExample of operation
Expand
titleMode of operation "Window with PIN code and optional certificate selection"

An example of operation based on the action configuration below.

 

One document with the given index values is signed and its content with the signature will be saved as a new version of the document. After clicking on the button on the form under which the action is defined, a dialog box for entering the PIN code and selecting the certificate will open. In the "Certificate" field, you can choose from two certificate configuration items based on the "Available certificates" parameter configured in this action.

 

After approval, the document is signed. In this mode, the native Szafir application window does not open. The signature operation is entirely based on the contents of the certificate configuration file. After the action is completed, the signature operation summary window appears. During the action, the console of the SzafirHost application is launched.

Panel
titleChange log

1.0.0 (applicable documentation)

  • Adding a component

1.0.1

  • Support for ENTER and ESC keys in the PIN window. Libraries and certificates update.

1.0.2 (applicable documentation)

  • Support for ENTER and ESC keys in the PIN window. Adding parameters Source file identifiers, Source file names, Identifiers of signed files and File processing statuses, deleting lines in the table with errors each time the signature is inserted. Adding keywords "SOURCE_FILE_ID" and "SOURCE_DOCUMENT_CLASS_NAME" under the Index value [Save] parameter.
Panel
titlePackage with a sample form using the action

View file
nameplus_esignature_english 2021-12-16 13_49_07 Development.zip
height250