Funkcje używane w regułach biznesowych

Ostatnia modyfikacja Maj 27, 2019

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.

Zanim jednak zajmiemy się funkcjami, proszę zapoznać się z opisem języka skryptowego AMODIT.


Sterowanie 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ść.
FieldIsRequired Ustawia wymagalność pola
FieldIsNotRequired Usuwa wymagalność pola
SetFieldAlias Chwilowo zmienia wyświetlaną na formularzu nazwę pola
SetFieldInfo Wyświetla komunikat pod polem
ToggleField Przełącza stan pola ukryte/widoczne w zależności od podanego warunku
FieldValueChanged Sprawdza, czy wartość pola zmieniła się w porównaniu z wartością w bazie danych.
FieldOriginalValue Zwraca wartość pola zapisaną w bazie danych, w odróżnieniu od bieżącej wartości w polu widocznej na formularzu.

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
CopyAndAssignCase
DeleteCase  Usuwa sprawę z systemu.
ForwardCase  Przekazuje sprawę do użytkownika lub grupy oraz zmienia etap/status sprawy
RedirectToCase Przekierowuje (otwiera dla użytkownika) formularz wskazanej sprawy
RedirectToUrl Przekierowuje (otwiera dla użytkownika) określoną stronę internetową
CaseProcessingTime

Funkcje związane z użytkownikami i grupami

 Nazwa funkcji  Znaczenie
CurrentUser Funkcja zwraca login bieżącego użytkownika
CaseOwner Funkcja zwraca login/nazwę grupy do której sprawa jest aktualnie przypisana
CaseCreator Funkcja zwraca login użytkownika, który utworzył sprawę
CaseForwarder Funkcja zwraca login użytkownika który przesłał sprawę
GetUserData Funkcja zwraca wskazane informacje dla podanego użytkownika
GetUserDataFromAD Funkcja zwraca wskazane informacje dla podanego użytkownika pobierając dane z AD
GetManager Funkcja zwraca przełożonego podanego użytkownika
GetSubordinate Funkcja sprawdza czy podany użytkownik jest podwładnym wskazanego managera.
FullName Funkcja zwraca imię  i nazwisko użytkownia
GetEmail Funkcja zwraca email użytkownika
IsGroupMember Sprawdza czy podany użytkownik jest członkiem wskazanej grupy
UsersOfGroup Zwraca listę loginów członków wskazanej grupy
UserIsExternal Zwraca informację czy wskazany użytkownik jest tzw. użytkownikiem zewnetrznym
GetAllUsers Zwraca loginy albo maile wszystkich aktywnych (posiadających licencje) użytkowników
IsCurrentUserOrDeputy Sprawdza, czy użytkownik określony w pierwszym parametrze jest bieżącym użytkownikiem lub zastępcą bieżącego użytkownika.
IsDeputyOf Sprawdza, czy użytkownik określony w pierwszym parametrze jest zastępcą dla użytkownika określonego w drugim parametrze

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
CurrentDateTime Zwraca bieżącą datę i czas
Today Zwraca bieżącą datę
DateTime Funkcja tworzy nową wartość daty w oparciu o podane wartości składowe
DateAdd Dodaje (lub odejmuje) określoną liczbę jednostek czasu do wskazanej daty.
DateDiff Oblicza różnicę pomiędzy dwiema datami i podaje ją w dniach, godzinach, minutach lub sekundach
DayDiff Zwraca liczbę pełnych dni pomiędzy wskazanymi datami
WorkDayDiff Zwraca liczbę dni roboczych pomiędzy wskazanymi datami
YearDiff Zwraca liczbę pełnych lat pomiędzy wskazanymi datami.
MonthDiff Zwraca liczbę pełnych miesięcy pomiędzy wskazanymi datami.
HourDiff Zwraca liczbę pełnych godzin pomiędzy wskazanymi momentami w czasie
DatePart Zwraca fragment daty (rok, miesiąc, dzień, godzinę, minuty, sekundy, dzień tygodnia, dzień roku, kwartał)

Funkcje związane z obsługą ciągu znaków (tekstu)

 Nazwa funkcji  Znaczenie
StartsWith Sprawdza, czy tekst zaczyna się od określonego wzorca
EndsWith Sprawdza, czy tekst kończy się określonym wzorcem
Length Zwraca liczbę znaków w tekście wliczając w to spacje
IndexOf Zwraca miejsce wystąpienia tekstu w innym tekście
ReplaceRegionalLetters Zastępuje wszystkie polskie znaki z podanego ciągu odpowiednikami ze standardowego zestawu znaków.
StringContains Zwraca wartość wskazującą, czy określony tekst występuje w innym tekście
StringReplace Zwraca nowy tekst, w którym wszystkie wystąpienia określonego ciągu znaków w bieżącej instancji są zastępowane innym określonym ciągiem znaków
Substring Zwraca fragment tekstu zaczynając od wskazanego indeksu
ToNumber Konwertuje tekst reprezentujący liczbę na liczbę dziesiętną.
Trim Usuwa spacje z początku i końca tekstu
NextNumber Ta funkcja zwraca ciąg znaków reprezentujących kolejną liczbę obliczoną na podstawie określonego wzorca.
ToLower Zwraca ciąg przekonwertowany na małe litery.
ToUpper Zwraca ciąg przekonwertowany na wielkie litery.
StripHTML Ta funkcja usuwa wszystkie znaczniki HTML z określonego tekstu

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
SetDictionaryDescription
SetDictionaryFilter
GetDictionaryItem
SetDictionaryItem
GetDictionaryItemData
GetDictionaryId

Funkcje związane z obsługą tabel na formularzu

 Nazwa funkcji  Znaczenie
AddTableRow Dodaje wiersz do tabeli.
RemoveTableRow Usuwa wiersz tabeli
CountRows Zlicza liczbę wierszy w tabeli
Get Pobiera wartość z pola
Set Ustawia wartość pola
DisableRow Wyłącza usuwanie wiersza
EnableRow Przywraca możliwość usunięcia wiersza
foreachrow() pętla pozwalająca na obsługę wszystkich wierszy w tabeli
CopyTableData Kopiuje dane z jednej tabeli do drugiej w tej samej sprawie lub do tabeli w innej sprawie.
ConditionalSetTabelRowsSum
SortTable
FillTableWithDictionary
ConditionalGet
ConditionalMax
ConditionalMin
ConditionalSet
ConditionalSum
Max
Min
Sum
 CheckOverlappingDates

Funkcje związane z obsługą załączników

 Nazwa funkcji  Znaczenie
AddAttachmentFromTemplate
AddFileToSharepoint
 AddBarcode Nakłada kod kreskowy na załączniki typu PDF.
 AttachmentsCount
 ChangeAttachmentName
 CheckConnected
 ConditionalMax
 ConditionalMin
 ConditionalSetTabelRowsSum
 ConditionalSum
 CountDocuments
 GetBarcodes
 GetQRcodes
 Max
 Min
 Sum
DeleteAttachmentFromOCR
GetAttachmentContent
GetAttachmentData
GetOfficeOnlineServerLink
HideAllTemplates
HideTemplate
SendAttachmentToOCR
SetTemplate
ShowTemplate

Funkcje związane z integracją/wymianą danych

 Nazwa funkcji  Znaczenie
ExecuteSQL Ta funkcja wykonuje zapytanie SQL przy użyciu źródła danych ODBC i zwraca pojedynczą wartość lub objekt typu Json
foreachobject Wykonuje kod dla każdego obiektu json w danej tablicy json
JsonPath Zwraca wartość właściwości dla określonego json’a
CallRest  
CallWebSite  
GetXML Ta funkcja zwraca bieżącą sprawę w xml. Jeśli podano nazwę szablonu xslt, to zwracany xml jest przekształcany za pomocą tego xslt.
ERP_PutDocumentInBufor
ERP_GetDocumentExportStatus
FillFromSkanujTo
GetSystemParameterValue
FillDataFromOCR
AddFileToSharepoint

Funkcje związane z VAT i NIP

Nazwa funkcji Znaczenie
ValidatePLNIPOnline
ValidatePLNIP
CheckVATID

 

Pozostałe funkcje

 Nazwa funkcji  Znaczenie
 AddComment Dodaje komentarz do bieżącej sprawy
 AddNews Tworzy nowy ogólny komunikat (Aktualności)
 CancelSignature
 CheckAllRequiredParams
 CheckCaseRequirementsComplied
 CollectAcceptances
 CollectSignatures
 CollectFieldsSignatures
 CountConnectedOpen
 CountConnectedClosed
 ERP_PutDocumentInBufor
 ExecuteSQL
 FillFieldsFromString
 FillFromSkanujTo
FireRules
ForEach
ForEachLine
FormatValue
GetComments
GetSystemParameterValue
HasChilds
IsEmpty
IsFormValid
IsUniqueValue
IsValidFieldValue
NumberToMoneyText
RegExp
Round
SendCasePrintMail
SendMessage
ShowMessage
SignCase
SignField
SetDeadline
GetDeadline
WriteToSystemLog
FillDataFromOCR