ExecuteAction()

Zastosowanie

Funkcja ExecuteAction uruchamia w formularzu sprawy zdefiniowaną akcję JavaScript na dokumencie dołączonym do sprawy. Dokument może być w polu typu dokument albo na liście załączników sprawy. Akcję i jej cel opisujesz w obiekcie actionObject (szczegóły w sekcjach „Argumenty” i „Przykłady”).

Dostępne akcje i wymagane atrybuty:

• signDocument (wymaga fieldName);
• showDocumentSignatures (wymaga fieldName albo attachmentName);
• download (wymaga fieldName albo attachmentName);
• openTrustCenterUrl (wymaga fieldName albo attachmentName);
• openTrustCenterRepresentativeUrl (wymaga fieldName albo attachmentName);
• uploadfile (wymaga fieldName);
• refreshReport (wymaga fieldName pola typu raport).

Pozostałe akcje z tabeli w sekcji „Argumenty” działają na pliku w polu albo w załączniku.

Zobacz też: Funkcja ExecuteAction – jak działa

Efekt działania

Po wykonaniu reguły formularz uruchamia wybraną akcję, np. pobiera plik, otwiera okno przesłania pliku albo pokazuje podpisy dokumentu.

Składnia

ExecuteAction(actionObject);

Argumenty

Argument actionObject przyjmuje następujące atrybuty:

Atrybut	Typ	Wymagany	Opis
action	tekst	Tak	Akcja do wykonania. Dozwolone wartości: signDocument, signDocumentInSelectedArea, showDocumentSignatures, download, openTrustCenterUrl, openTrustCenterRepresentativeUrl, uploadfile, signDocumentSimplySign, openTrustCenterSignerUrl, refreshReport. Akcja refreshReport działa tylko dla pola typu raport. Wielkość liter nie ma znaczenia.
attachmentName	tekst	Nie	Nazwa pliku załącznika, na którym ma zostać wykonana akcja.
fieldName	tekst	Nie	Nazwa pola typu dokument, na którym ma zostać wykonana akcja. Jeżeli podasz fieldName i attachmentName, funkcja użyje fieldName.
caseId	tekst albo liczba	Nie	Identyfikator powiązanej sprawy (wiersza tabeli w formularzu), na której ma zostać wykonana akcja.

Atrybut fieldName albo attachmentName jest wymagany zależnie od akcji (lista w sekcji „Zastosowanie”).

Zwracana wartość

Funkcja zwraca true albo kończy regułę błędem z informacją o przyczynie.

Przykłady

Przykład 1: pobranie pliku z pola

Funkcja wykonuje akcję download na pliku w polu typu dokument Document scan.

actionObject.action = "download";
actionObject.fieldName = "Document scan";
ExecuteAction(actionObject);

Przykład 2: przesłanie pliku do pola

Funkcja wykonuje akcję uploadfile dla pola typu dokument Document scan.

actionObject.action = "uploadfile";
actionObject.fieldName = "Document scan";
ExecuteAction(actionObject);

Przykład 3: przesłanie pliku do wiersza tabeli

Funkcja wykonuje akcję uploadfile dla pola typu dokument Document scan w powiązanym wierszu tabeli o identyfikatorze 12.

actionObject.action = "uploadfile";
actionObject.fieldName = "Document scan";
actionObject.caseId = 12;
ExecuteAction(actionObject);

Dobre praktyki

• Przed wywołaniem funkcji ustaw w actionObject wszystkie atrybuty wymagane przez wybraną akcję.
• attachmentName podawaj jako dokładną nazwę pliku, z rozszerzeniem i tą samą wielkością liter.

Typowe błędy

• Brak akcji w actionObject.action. Reguła zakończy się błędem. Podaj jedną z dozwolonych akcji.
• Brak fieldName i attachmentName. Funkcja zwróci true, ale żadna akcja się nie wykona. Ustaw atrybut wymagany przez wybraną akcję.
• Akcja, której nie można wykonać dla pola, np. download dla pustego pola albo uploadfile dla pola, w którym jest już plik. Reguła zakończy się błędem. Sprawdź stan pola przed wywołaniem funkcji.
• Nazwa pola z błędem. Reguła zakończy się błędem, bo funkcja nie znajdzie pola. Sprawdź nazwę pola przed wywołaniem funkcji.

Powiązane funkcje

• Funkcja ExecuteAction – jak działa