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

Kategoria: eSignature

Umiejscowienie akcji: Przycisk, Przycisk tabeli

Dostępna od wersji: 1.0.0

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. Podpisane dokumenty zapisywane są w archiwum systemu.

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

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

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.

Klasy dokumentów [Proces]1.0.0Nazwy klas dokumentów, z których pobierane są dokumenty.Tablica wartości tekstowych Lista wartościW przypadku pustej tablicy nazw klas dokumentów (nieuzupełnienia parametru), zostaną pobrane wszystkie dokumenty podłączone do procesu.
Klasa dokumentów [Archiwum]*1.0.0Nazwa 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 edytowalneLista 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.0Opcjonalne filtrowanie po indeksach wybranej klasy dokumentów. W tym parametrze określana jest wartość indeksu.Tablica wartości tekstowych Pole edytowalne 
Identyfikatory plików1.0.0Identyfikatory plików do pobrania z archiwum.Tablica liczb całkowitych Pole 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.

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 wersje 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 
Niepoprawnie przetworzone fileIds1.0.0Zwraca tablicę identyfikatorów plików, przy których wystąpił błąd w trakcie wstawiania podpisu.Zmienna Pole edytowalne 
Opis błędu1.0.0Zwraca tablicę opisów błędu dotyczących błędnie przetworzonych plików z parametru Niepoprawnie przetworzone fileIds.Zmienna Pole edytowalne 
Zapis 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 
Klasa dokumentów [Zapis]1.0.0Nazwa klasy dokumentów, w której zostanie zapisany plik z podpisem.Tekst Lista wartości 
Nazwa indeksu [Zapis]1.0.0Nazwa indeksu 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 Klasa dokumentów [Zapis] jest użyta zmienna lub funkcja, to pole tego parametru stanie się polem edytowalnym.
Wartość indeksu [Zapis]1.0.0Wartość indeksu z wybranej klasy dokumentów.Tablica wartości tekstowych Pole edytowalne 
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 

Parametr*- pole wymagane

Przykład działania dla powyższej przykładowej konfiguracji akcji.

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.

1.0.0

  • Dodanie komponentu

 

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

Category: Database

Action location: Form, Button, Variable

Previous names: Perform a query from the database

Available from version: 1.0.4

The action retrieves the SQL query from the database, executes it and assigns the results to variables whose identifiers correspond to the column aliases in the database.

Places in the database query, where the values from parameters defined by us are to be marked, are marked with "?" If several parameters are defined, the order in which the parameters are defined determines where each value will go.

It should be remembered that writing data to the dynamic table is possible only after passing the table identifier in the last parameter.

In the absence of data returned from the database, the component sets no value.

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

Action location

From version

Conditional execution parameter action

Action call-up condition

Form

1.0.32

Call-up action

The "Conditional execution" parameter will return "true"

Variable1.0.4Activates actionChange the value of the variable on which the action is located

Button

1.0.4

Activates action

Pressing the button

Parameter name

From version

Description

Paremeter type

Default value

Field type

Comments and restrictions

Database

1.0.4

The configuration name defined in the data explorer settings.

Text

 

Editable field

 

Table with queries1.0.4

The name of the table in which queries triggered by the application are stored.
The table should contain the columns query_name (query ID) and query (query only). First, the action tries to search for a table from the system base. If the search fails, a search is made in the defined database.

Text Editable fieldThe parameter is optional. If we do not complete it, the question is taken from here: Table with database queries
Query Name*1.0.4ID of the query stored in the database.Text Editable field 
Parameters for the query1.0.4An array of text values storing variables / constants for query parameters and type information. An example parameter is "value type" for constants and "@id_variable" for variables. When we want to pass a constant value that has more than one word, we write it in quotation marks "" or "'. Supported types are: string, integer and float.An array of text values Editable fieldSince version 1.0.24 it is possible not to pass any parameters to the query.
Target Variables*1.0.4Array of variables into which the values from the database are to reach. Binding based on the variable id and returned alias from the database.Array of variables Editable field 
Dynamic table id1.0.4An optional parameter conditioning the saving of result data to a dynamic table.Text Editable field 
Multiple value support1.0.11An optional parameter that allows handling of many values returned by the database dedicated to one header variable.Text Drop-down list

Possible parameter values:

Displayed ValueValue transmitted
Throw an exceptionBLOCK
Get the first valueFIRST
Get unique values separated by a semicolonUNIQUE
Way of adding data*1.0.83

Parameter that allows you to specify the way of adding data. There are 3 types to choose from:

  • Overwrite entire table- all values in the table are overwritten,
  • Overwrite updated columns- all values in the column specified in the query are overwritten,
  • Add values- values taken from DB are added to the existing ones.
TextAdd valuesDrop-down list 

Parameter*- mandatory field 

 

1.0.4

  • Adding a component