Funkcje używane w regułach biznesowych
Jak korzystać z tego artykułu
Ten artykuł jest punktem wejścia do dokumentacji funkcji używanych w regułach biznesowych.
Najpierw wybierz grupę funkcji, potem przejdź do artykułu konkretnej funkcji. Pełny dotychczasowy katalog zostaje niżej jako bezpieczna ścieżka przejściowa.
Grupy funkcji
- Formularz, pola i sekcje – Widoczność, wymagania i zachowanie formularza. Przykłady: HideSection, ShowSection, HideField, ShowField.
- Obieg sprawy i etapy – Tworzenie, przekazywanie, zamykanie i prowadzenie sprawy. Przykłady: AssignProcedure, ChangeStage, CloseCase, CopyCase.
- Uprawnienia i role w sprawie – Role, obserwatorzy, współpracownicy i dostęp do sprawy. Przykłady: AddCC, AddCON, AddUserToRole, ClearCC.
- Daty i terminy – Operacje na datach, godzinach i terminach. Przykłady: CheckOverlappingDates, CheckOverlappingDatesTables, CurrentDateTime, DateAdd.
- Słowniki i dane referencyjne – Słowniki, pozycje słownikowe i dane pomocnicze. Przykłady: AddDictionaryPosition, CheckDictionaryItem, GetDictionaryDescription, GetDictionaryId.
- Tabele, obliczenia i pętle – Praca na wierszach tabel, agregacjach i iteracji. Przykłady: AddTableRow, ConditionalGet, ConditionalMax, ConditionalMin.
- Załączniki, dokumenty i podpisy – Załączniki, PDF, OCR, kody i podpisy elektroniczne. Przykłady: AddBarcode, AttachmentsCount, ChangeAttachmentName, CheckConnected.
- Teksty, walidacja i formatowanie – Operacje na tekście, walidacji i prezentacji wartości. Przykłady: FormatValue, IsEmpty, IsValidFieldValue, Length.
- Użytkownicy, grupy i organizacja – Dane o użytkownikach, grupach i strukturze organizacyjnej. Przykłady: FullName, GetEmail, GetManager, GetSubordinate.
- Wyszukiwanie, filtrowanie i dane – Wyszukiwanie spraw, filtry i bezpośredni dostęp do danych. Przykłady: ExecuteSQL, GetJSON, XPath, XmlEncode.
- Komunikacja i powiadomienia – E-mail, komunikaty, wysyłka i kanały komunikacji. Przykłady: AddComment, AddNews, MailHeaderValue, SendCasePrintMail.
- Integracje i moduły specjalne – Integracje zewnętrzne i funkcje modułów specjalistycznych. Przykłady: AddCaseToRepository, AddTransfer, CheckVATID, CheckVATWhitelistStatus.
Dotychczasowy katalog funkcji
Poniżej zostaje zachowany dotychczasowy pełny wykaz funkcji. Dzięki temu porządkowanie struktury nie powoduje utraty treści ani zerwania istniejących dojść.
Platforma AMODIT wyposażona została w silnik reguł biznesowych. Pozwala on precyzyjnie sterować przepływem procesów. Sterowanie odbywa się za pomocą licznych funkcji, których zastosowanie opisano poniżej. Każda funkcja ma też swój opis dostępny bezpośrednio na Platformie AMODIT w miejscu gdzie tworzy się reguły. Poniższy opis może się różnić od tego dostępnego w AMODIT np liczbą przykładów, odnośnikami do innych podobnych funkcji. Ponadto tu zgromadzono funkcje tematycznie np te do obsługi ukrywania i pokazywania pól, albo takie które wiążą się z obsługą dat. Powinno to ułatwić odszukanie właściwej funkcji.
Funkcje sterowania zachowaniem się pól i sekcji na formularzu
| Nazwa funkcji | Znaczenie |
| HideSection | Ukrywa sekcję na formularzu. |
| ShowSection | Pokazuje sekcję na formularzu |
| HideField | Ukrywa pole na formularzu |
| ShowField | Pokazuje pole na formularzu |
| DisableField | Wyłącza pole na formularzu |
| EnableField | Włącza pole na formularzu |
| FieldIsIncorrect | Pozwala podświetlić pole, gdy zawiera niepożądaną wartość |
| FieldIsCorrect | Pozwala usunąć efekt podświetlenia pola, gdy pole zawiera prawidłową wartość. |
| FieldValueChanged | |
| SetAttachmentFieldSettings | |
| SetTemplate | |
| ExpandSection | |
| SaveCase | |
| SetFieldAlias | |
| CollapseSection | |
| SetFieldInfo | |
| FieldIsRequired | |
| FieldOriginalValue | |
| ToggleSection | |
| FieldIsNotRequired | |
| ToggleField |
Funkcje sterowania przepływem sprawy
| Nazwa funkcji | Znaczenie |
| AssignProcedure | Przypisanie lub zmiana typu procedury. |
| ChangeStage | Zmienia etap bez zmiany właściciela. |
| CloseCase | Zamyka sprawę. |
| CopyCase | Tworzy kopię sprawy |
| CreateCase | Tworzy nową sprawę we wskazanym procesie. |
| CurrentStage | Funkcja zwraca nazwę aktualnego etapu |
| CurrentUser | Funkcja zwraca login bieżącego użytkownika |
| DeleteCase | Usuwa sprawę z systemu. |
| ForwardCase | Przekazuje sprawę do użytkownika lub grupy oraz zmienia etap/status sprawy |
| RedirectToCase | |
| RedirectToUrl | |
| AddCaseEvent | |
| ChangeDeadline | |
| forcase | |
| CaseStatusId | |
| GrantTemporaryAccessToCase | |
| CopyAndAssignCase | |
| TerminateTemporaryAccessToCase |
Funkcje związane z obsługą uprawnień
| Nazwa funkcji | Znaczenie |
| AddCC | Dodaje użytkownika lub grupę w polu „DW – do wiadomości” (CC – carbon copy) |
| AddCON | Dodaje użytkownika lub grupę w polu „Wsp. – Współpracownik” (CON – contributors) |
| AddUserToRole | Dodaje użytkownika do roli dla danej sprwy |
| ClearCC | Usuwa wszystkich użytkowników z roli obserwatorów dla konkretnej sprawy |
| ClearCON | Usuwa wszystkich użytkowników z roli Współpracowników dla danej sprwy |
| GetCC | Zwraca listę użytkowników przypisanych do roli Obserwatorów dla danej sprawy |
| GetCON | Zwraca listę użytkowników przypisanych do roli Współpracowników dla danej sprawy. |
| RemoveCON | Usuwa użytkownika lub grupę z listy współpracowników w sprawie. |
| RemoveCC | Usuwa użytkownika lub grupę z listy obserwatorów w sprawie. |
| RemoveUserFromRole | Usuwa użytkownika lub grupę z określonej roli dla sprawy |
Funkcje związane z obsługą dat
| Nazwa funkcji | Znaczenie |
| CheckOverlappingDates | |
| CheckOverlappingDatesTables | |
| CurrentDateTime | |
| DateAdd | |
| DateDiff | |
| DatePart | |
| DateTime | Zwraca obiekt typu data/czas na podstawie zadanych parametrów. |
| DayDiff | |
| GetDeadline | |
| HourDiff | |
| MonthDiff | |
| SetReminder | Ustawia datę i czas przypomnienia/terminu na danej sprawie. |
| Today | Zwraca bieżącą datę bez części czasowej, a dokładnie to zwraca północ (godzinę 00:00:00) bieżącego dnia. |
| WorkDayDiff | Pozwala na wyliczenie ilości dni pracujących między dwoma datami. |
| YearDiff |
Funkcje związane z obsługą słowników
| Nazwa funkcji | Znaczenie |
| AddDictionaryPosition | Dodaje nową pozycję do słownika połączonego z polem na formularzu. |
| CheckDictionaryItem | |
| GetDictionaryDescription | |
| GetDictionaryId | |
| SetDictionaryDescription | |
| FillTableWithDictionary | |
| GetDictionaryItem | |
| SetDictionaryFilter | |
| GetDictionaryItemData |
Funkcje związane z obsługą tabel na formularzu
| Nazwa funkcji | Znaczenie |
| AddTableRow | Dodaje wiersz do tabeli. |
| ConditionalGet | |
| ConditionalMax | |
| ConditionalMin | |
| ConditionalSet | |
| ConditionalSetTableRowsSum | |
| ConditionalSum | |
| CountRows | |
| DisableRow | |
| EnableRow | |
| Get | |
| Length | |
| Max | |
| Min | |
| RemoveTableRow | |
| Set | |
| Sum | |
| CopyTableData | |
| forrow | |
| HideRow | |
| GetFromPrevRow | |
| ShowRow | |
| SortTable |
Funkcje związane z obsługą załączników
Pozostałe funkcje