Versions Compared

Key

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

Polish

Strona zawiera spis wszystkich wbudowanych funkcji. Funkcje te można wykorzystywać m.in. do:

  • wstępnego przetwarzania parametrów (np. akcji formularza)
  • tworzenia warunków wywołania (np. walidatory)
Tip

W parametrach każdej z funkcji możemy użyć stałej, zmiennej ( $id_zmiennej ) lub innej funkcji ( #nazwa_funkcji() ) np:

#round( #sum( [$var1, $var2] ), 2)

Table of Contents
outlinetrue

Ogólnego przeznaczenia

Funkcje ogólne działające na danych różnego typu.

NazwaLokalizacjaDostępność funkcji w komponentachOpisWarianty funkcji

 eq

System PlusworkflowWszystkie komponentySprawdza czy podane wartości są sobie równe.

eq(v1, v2) : boolean

v1 : object | object[]

Dowolna pierwsza wartość

 v2 : object | object[]

Dowolna druga wartość

Wynik:

True jeżeli podane wartości są sobie równe

Code Block
// równe
eq( 1, 1.00 )
eq( "tekst", "tekst" )
 
// nie równe
eq( 1, 1.01 )
eq( "tekst", "Tekst" )

ieq 

System PlusworkflowWszystkie komponentySprawdza równość podanych parametrów ignorując wielkość liter.

ieq(v1, v2) : boolean

v1 : string|string[]

Porównywany tekst

v2 string|string[]

Porównywany tekst

Wynik:

True jeżeli podane teksty są sobie równe bez uwzględnienia wielkości liter

Code Block
równe
ieq( "tekst", "tekst" )
 
// nie równe
ieq( "tekst", "Tekst" )

 empty

System PlusworkflowWszystkie komponenty

Sprawdza, czy podana wartość jest pusta, bądź posiada jeden pusty element.

empty(value) : boolean

value : object|object[]

Sprawdzana wartość dowolnego typu

Wynik:

True jeżeli wartość jest pusta lub posiada jeden pusty element

Code Block
// puste
empty( null ) 
empty( "" )
empty( [] )
empty( $var1 )
empty( [""] )
empty( [null] )  
// nie puste
empty( "tekst" )
empty( [1, 2] )

anyEq

System PlusworkflowWszystkie komponentySprawdza. czy jakakolwiek wartość z listy jest równa podanej wartości

anyEq(v1[], v2) : boolean

v1 : object[]

Dowolna tablica wartości

v2 : object

Wartość tego samego typu co wartości z tabeli v1

Wynik:

True jeżeli którakolwiek z wartości w v1 jest równa v2

Code Block
languagejs
themeEclipse
titlePrzykład
// prawda
anyEq([1,2],1)
anyEq([3,2,1],1)
anyEq([1],1)

// fałsz
anyEq([3,2,1],5)

Tekstowe

 Funkcje do pracy z tekstem.

NazwaLokalizacjaDostępność funkcji w komponentachOpisWarianty funkcji

concat

System PlusworkflowWszystkie komponenty

Łączy podane fragmenty tekstu.

concat(strings) : string

strings : string[]

Tablica zawierająca fragmenty tekstu

Wynik:

Tekst powstały z połączenia podanych fragmentów

Code Block
// zwróci "tekst"
concat(["te", "kst"])

join

System PlusworkflowWszystkie komponenty

Łączy podane fragmenty tekstu używając podanego separatora.

Aktualizacja od wersji 3.2.48 - dodano obsługę nowych typów parametrów (liczby, wartości logiczne, daty, daty z czasem)

join(fragments, [separator] ) : string

fragments : object[]

Tablica zawierająca fragmenty tekstu/liczby/wartości logiczne/daty/daty z czasem

separator : string

Znak którym zostaną połączone wszystkie fragmenty. Domyślnie " " (spacja).

Wynik:

Tekst powstały z połączenia podanych fragmentów separatorem

Code Block
// zwróci "Jan Kowalski"
join(["Jan", "Kowalski"])
 
// zwróci "1;2;3"
join([1, 2, 3], ";")

// zwroci ";"
join(["", ""], ";");

// zwróci "2;;3"
join([2,null,3], ";");

capitalize

System PlusworkflowWszystkie komponentyZamienia pierwszą znak podanego tekstu na wielką literę.

capitalize(text) : string

text : string

Tekst wejściowy

Wynik:

Tekst z pierwszą dużą literą

Code Block
// zwróci "Tekst"
capitalize("tekst")

lowerCase

System PlusworkflowWszystkie komponenty

Zamienia wszystkie znaki w podanym tekście na małe litery.

lowerCase(text) : string

text : string

Tekst wejściowy

Wynik:

Tekst zapisany tylko małymi literami

Code Block
// zwróci "tekst"
lowerCase("TEKST")

upperCase

System PlusworkflowWszystkie komponenty

Zamienia wszystkie znaki w podanym tekście na duże litery.

upperCase(text) : string

text : string

Tekst wejściowy

Wynik:

Tekst zapisany tylko dużymi literami

Code Block
// zwróci "Tekst"
lowerCase("tekst")

substring

System PlusworkflowWszystkie komponenty

Zwraca tekst powstały z wydzielenia części podanego tekstu zgodnie z parametrami.

substring(text, start, [length]) : string

text : string

Tekst wejściowy

start : integer

Index startowy

length : integer [opcjonalny]

Długość wydzielonego podtekstu (domyślnie do końca tekstu wejściowego).

Wynik:

Tekst stanowiący część tekstu wejściowego.

Code Block
// zwróci "ekst"
substring("tekst", 1)
 
// zwróci "ek"
substring("tekst", 1, 2)

matchesRegexp

System PlusworkflowWszystkie komponenty

Sprawdza, czy podany tekst jest zgodny z podanym wyrażeniem regularnym.

matchesRegex(text, regexp) : boolean

text : string

Sprawdzany tekst

regexp : string

Wyrażenie regularne które musi spełniać tekst.

Wynik:

True jeżeli podany tekst pasuje do podanego wyrażenia regularnego.

Code Block
// spełnia
matchesRegexp("tekst", "t.*")
 
// nie spełnia
matchesRegexp("tekst", "t")

replace

System PlusworkflowWszystkie komponenty

Zamienia wszystkie wystąpienia podanego tekstu w tekście wejściowym.

replace(text, pattern, replacement) : string

text : string

Tekst wejściowy

pattern : string

Wzorzec

replacement : string

Zamiennik

Wynik:

Tekst z zamienionymi wszystkimi wystąpieniami wzorca w tekście wejściowym.

Code Block
// zwraca "Dzisiaj jest 2016-01-01"
replace("Dzisiaj jest _data_",
"_data_", #currentDate())

Niewydane replaceDiacritics

CUF components od wersji x.xWszystkie komponentyFunkcja zastępuje znaki diakrytyczne na ich łacińskie odpowiedniki.

replaceDiacritics(text) : string

text: string

Tekst wejściowy

Wynik:

Tekst z zamienionymi znakami diakrytycznymi na ich łacińskie odpowiedniki.

Code Block
//Zestaw znaków diakrytycznych i ich łacińskie odpowiedniki 
	
	A: 'ÀÁÂÃÄÅĀĄ' 			a: 'àáâãäåāą'  
  	C: 'ÇĆČ' 				c: 'çćč' 
  	D: 'ĐĎ' 				d: 'đď'	
  	E: 'ÈÉÊËĚĒĘ' 			e: 'èéêëěēę'
  	I: 'ÌÍÎÏĪ' 				i: 'ìíîïī'	
  	L: 'Ł'  				l: 'ł'	
  	N: 'ÑŇŃ'  				n: 'ñňń'
  	O: 'ÒÓÔÕÕÖØŌ'  			o: 'òóôõöøō'
  	R: 'Ř'  				r: 'ř'	
  	S: 'ŠŚ'   				s: 'šś'	
  	T: 'Ť'  				t: 'ťŤ'
  	U: 'ÙÚÛÜŮŪ'  			u: 'ùúûüůū'
  	Y: 'ŸÝ'  				y: 'ÿý'	
  	Z: 'ŽŻŹ'  				z: 'žżź'

Niewydane replaceMany

CUF components od wersji x.xWszystkie komponentyFunkcja zastępuje niedozwolony zestaw znaków dla nazw w systemie Windows, Linux lub zestaw znaków zdefiniowanych przez użytkownika.

replaceMany(originalString, replaceOptions, replaceFrom[], replaceTo) : string

originalString: string

Tekst wejściowy

replaceOptions: string

Zamień dla- lista wartości Systemu Windows, Systemu Linux, Wartości własnych.

replaceFrom[]: string[]

Zamień dla- parametr pojawia się w przypadku wyboru opcji "Wartości własnych" z parametru "Zamień dla".

replaceTo: string

Zamiennik.

Wynik:

Tekst z zamienionymi wartościami przekazanymi w parametrze replaceTo, w tekście wejściowym.

 

Code Block
// zwraca "XbcXe"
replaceRegexp(":bc!e", "WINDOWS", "X")

Niedozwolone znaki dla nazw w systemie Windows- < > : " / | \ ? *

Niedozwolony znak dla nazw w systemie Linux- /

replaceRegexp

System PlusworkflowWszystkie komponentyZamienia wszystkie wystąpienia tekstu spełniającego podane wyrażenie regularne w tekście wejściowym.

replaceRegexp(text, regex, replacement) : string

text : string

Tekst wejściowy

regex : string

Wyrażenie regularne

replacement : string

Zamiennik

Wynik:

Tekst z zamienionymi wszystkimi spełniającymi przekazane wyrażenie regularne wystąpieniami w tekście wejściowym.

Code Block
// zwraca "XbcXe"
replaceRegexp("abcde", "[ad]", "X")

trim

System PlusworkflowWszystkie komponenty

Usuwa wszystkie białe znaki z początku i końca podanego tekstu.

trim(text) : string

text : string

Tekst wejściowy

Wynik:

Tekst wejściowy z usuniętymi białymi znakami z początku i końca

Code Block
// zwraca "przykładowy tekst"
trim(" przykładowy tekst  ")

emptyString

System PlusworkflowWszystkie komponentyZwraca pusty łańcuch znaków

emptyString() : string

Wynik:

Tekst w postaci: ""

Code Block
// zwraca pusty łańcuch znaków
emptyString()

format

System PlusworkflowWszystkie komponentyFormatuje liczbę wg. podanych separatorów i liczby miejsc po przecinku.

format(value, decimalLen, decimalSeparator, thousandSeparator) : string

value : float/integer

Wartość liczbowa do sformatowania

decimalLen : integer

Liczba miejsc po przecinku

decimalSeparator : string

Separator ułamkowy

thousandSeparator : string

Separator tysięczny (w przypadku pustego łańcucha znaków separator nie pojawi się)

Wynik:

Sformatowana wartość liczbowa w postaci tekstowej

Code Block
// zwraca "9 999,1230"
format(9999.123, 4, ",", " ")

// zwraca "9,999.1230"
format( 9999.123, 4, ".", "," )

// zwraca "10000"
format(10000.123, 0, ",", "")

// zwraca "149,13"
format(149.125, 2, ",", " ")

formatText

System PlusworkflowWszystkie komponentyFormatuje ciąg znaków wg. podanego schematu

formatText(schema, parameters, [customRegex]) : string

schema : string

Schemat, w którym kolejne znaki #(lub podane jako opcjonalny parametr customRegex) zostaną zastąpione przez kolejne znaki z parameters.

parameters : string[]

Parametry tekstowe, których kolejne znaki zostaną wpisane do schematu

customRegex : string

Parametr, który zmienia domyślnie podmieniany znak "#" w schemacie, na inny, dowolny

Wynik:

Łańcuch znaków sformatowany według schematu

Code Block
// zwraca AAA-BBB-123
formatText("###-BBB-###", ["AA", "A123"])

// zwraca #1234BB
formatText("#ZZZZZZ", ["1234BB"], "Z")

substringLast

System PlusworkflowWszystkie komponentyZwraca n ostatnich znaków ciągu znaków

substringLast(s, nChars) : string

s : string

Oryginalna wartość tekstowa.

nChars : integer

Ilość znaków.

Wynik:

Ciąg znaków o zdefiniowanej długości lub krótszy, jeżeli oryginalny ciąg jest krótszy niż pożądana liczba zwróconych znaków (wtedy funkcja zwraca oryginalny ciąg).

Code Block
// zwraca cd
substringLast("abcd", 2)

// zwraca ab
substringLast("ab", 3)

length

 

System PlusworkflowWszystkie komponentyZwraca długość podanego tekstu

length(text) : integer

text : string

Tekst

Wynik:

Długość tekstu

Code Block
titlePrzykład
// zwraca 0
length(null)
length("")

// zwraca 11
length("text - text")

indexOf

System PlusworkflowWszystkie komponenty

Zwraca nr wystąpienia ciągu znaku w podanym tekście. Szuka od początku do końca podanego tekstu.

Gdy nie znajdzie zwraca -1;

Pierwsza pozycja w tekście ma index 0

indexOf(text,searchText) : integer

indexOf(text,searchText,start) : integer

text : string

Tekst do przeszukania

searchText : string

Szukany ciąg znaków

start : integer

Pozycja początkowa - pozycja w tekście od której ma zacząc przeszukiwać

Wynik:

Długość tekstu

Code Block
titlePrzykład
// zwraca 7
indexOf("Ala ma kota, kot ma ale, i wszytko kończy się happy endem.","ko")
// zwraca 13
indexOf("Ala ma kota, kot ma ale, i wszytko kończy się happy endem.","ko",10)
 

lastIndexOf

System PlusworkflowWszystkie komponenty

Zwraca nr wystąpienia ciągu znaku w podanym tekście. Szuka od końca do początku podanego tekstu.

Gdy nie znajdzie zwraca -1;

Pierwsza pozycja w tekście ma index 0

lastIndexOf(text,searchText) : integer

lastIndexOf(text,searchText,start) : integer

text : string

Tekst do przeszukania

searchText : string

Szukany ciąg znaków

start : integer

Pozycja początkowa - pozycja w tekście od której ma zacząc przeszukiwać

Wynik:

Długość tekstu

Code Block
titlePrzykład
// zwraca 35
lastIndexOf("Ala ma kota, kot ma ale, i wszytko kończy się happy endem.","ko")

// zwraca 7
lastIndexOf("Ala ma kota, kot ma ale, i wszytko kończy się happy endem.","ko",10)
 

split

System PlusworkflowWszystkie komponenty

Rozdziela tekst na tablice za pomocą podanego wzorca (tekst lub wyrażenie regularne)

 

split(text,regexp):string[]

text : string

Tekst wejściowy

regex : string

Wzorzec (wyrażenie regularne lub tekst)

Code Block
titlePrzykład
// zwraca ["Ala ma kota" , "kot ma ale"]
split("Ala ma kota, kot ma ale",",")

// zwraca ["Ala" , "kota, kot" , "ale"]
split("Ala ma kota, kot ma ale","ma")
// zwraca ["Ala", "Ewa", "Marta"]
split("Ala12423423Ewa1234Marta","\d+")
 

newLine

System PlusworkflowWszystkie komponenty

Wstawia znak nowego wiersza

newLine() : string

Wynik:

Tekst w postaci: "\r\n"

 

Code Block
// zwraca znak nowego wiersza
newLine()

Matematyczne

Funkcje do wykonywania działań matematycznych.

NazwaLokalizacjaDostępność w komponentachOpisWarianty funkcji

abs

System Plusworkflow

Wszystkie komponentyOblicza wartość bezwzględną z podanej liczby.

abs(value) : integer|float

value : integer|float

Dowolna liczba

Wynik:

Wartość bezwzględna z podanej liczby

Code Block
//zwraca 1.23
sum( -1.23 )

calc

System Plusworkflow

Wszystkie komponentyOblicza wynik działania matematycznego.

calc(num1, operator, num2) : integer|float

num1 : integer|float

Dowolna liczba

operator : string

Operator:

  • +: dodawanie
  • -: odejmowanie
  • *: mnożenie
  • /: dzielenie

num2 : integer|float

Dowolna liczba

Wynik:

Wynik działania zgodny z podanym operatorem

Code Block
// dodawanie
expr( 2, '+', 2 )
// odejmowanie
expr( 2, '-', 2 )
// mnożenie
expr( 2, '*', 2 )
// dzielenie
expr( 2, '/', 2 )

le

System Plusworkflow

Wszystkie komponentySprawdza czy liczba jest mniejsza lub równa podanej liczbie.

le(num1, num2) : boolean

num1 : integer|float

Dowolna liczba

num2 : integer|float

Dowolna liczba

Wynik:

True jeżeli liczba num1 jest mniejsza od lub równa liczbie num2.

Code Block
// 'false'
le(11, 10)
// 'true'
le(10, 10)
// 'true'
le(9, 10)

lt

System Plusworkflow

Wszystkie komponentySprawdza czy liczba jest mniejsza od podanej liczby.

lt(num1, num2) : boolean

num1 : integer|float

Dowolna liczba

num2 : integer|float

Dowolna liczba

Wynik:

True jeżeli liczba num1 jest mniejsza od liczby num2.

Code Block
// 'false'
lt(11, 10)
// 'false'
lt(10, 10)
// 'true'
lt(9, 10)

ge

System Plusworkflow

Wszystkie komponentySprawdza czy liczba jest większa lub równa podanej liczbie.

ge(num1, num2) : boolean

num1 : integer|float

Dowolna liczba

num2 : integer|float

Dowolna liczba

Wynik:

True jeżeli liczba num1 jest większa od lub równa liczbie num2.

Code Block
// 'true'
ge(11, 10)
// 'true'
ge(10, 10)
// 'false'
ge(9, 10)

gt

System Plusworkflow

Wszystkie komponentySprawdza czy liczba jest większa od podanej liczby.

gt(num1, num2) : boolean

num1 : integer|float

Dowolna liczba

num2 : integer|float

Dowolna liczba

Wynik:

True jeżeli liczba num1 jest większa od liczby num2.

Code Block
// 'true'
gt(11, 10)
// 'false'
gt(10, 10)
// 'false'
gt(9, 10)

ceil

System Plusworkflow

Wszystkie komponentyZaokrąglanie w górę. Zwraca najmniejszą liczbę całkowitą większą od lub równą podanej liczbie.

ceil(value) : integer

value : float

Zaokrąglana liczba

Wynik:

Najmniejsza liczba całkowita większa lub równa podanej liczbie.

Code Block
//zwraca 3
ceil( 3 )
ceil( 2.11 )

floor

System Plusworkflow

Wszystkie komponentyZaokrąglanie w dół. Zwraca największą liczbę całkowitą mniejszą od lub równą podanej liczbie.

floor(value) : integer

value : float

Zaokrąglana liczba

Wynik:

Najmniejsza liczba całkowita mniejsza od lub równa podanej liczbie.

Code Block
//zwraca 2
ceil( 2 )
ceil( 2.65 )

round

System Plusworkflow

Wszystkie komponentyZaokrągla liczbę do podanej liczby miejsc po przecinku.

round(value, [places]) : float

value : float

Zaokrąglana liczba

places : integer [opcjonalny]

Liczba miejsc po przecinku do których zaokrąglamy. Domyślnie zaokrąglanie do części całkowitej (0) .

Wynik:

Liczba zaokrąglona do podanej liczby miejsc po przecinku

Code Block
//zwraca 12
round( 12.236 )
 
//zwraca 12.24
round( 12.236, 2 )

min

System Plusworkflow

Wszystkie komponentyZwraca najmniejszą z podanych liczb.

min(numbers) : integer|float

numbers : integer[]|float[]

Tablica liczb

Wynik:

Zwraca najmniejszą z podanych liczb.

Code Block
//zwraca 1
min( [1, 10, 5] )

max

System Plusworkflow

Wszystkie komponentyZwraca największą z podanych liczb.

max(numbers) : integer|float

numbers : integer[]|float[]

Tablica liczb

Wynik:

Zwraca największą z podanych liczb.

Code Block
//zwraca 10
min( [1, 10, 5] )

sum

System Plusworkflow

Wszystkie komponentyZwraca sumę z wszystkich podanych liczb.

sum(numbers) : float

numbers : integer[]|float[]

Tablica liczb

Wynik:

Zwraca sumę wszystkich podanych liczb.

Code Block
//zwraca 6
sum( [1, 10, -5] )

anyLe

System Plusworkflow

Wszystkie komponentySprawdza czy jakakolwiek liczba z tablicy jest mniejsza lub równa podanej liczbie.

anyLe(num1[], num2) : boolean

num1[] : integer|float

Dowolna tabela liczb

num2 : integer|float

Liczba tego samego typu co liczby w tabeli num1

Wynik:

True jeżeli jakakolwiek liczba z num1 jest mniejsza lub równa liczbie num2.

Code Block
// zwraca true
anyLe([1,2,3],1)
anyLe([0,2,3],1)

// zwraca false
anyLe([2,2,3],1)

anyLt

System Plusworkflow

Wszystkie komponentySprawdza czy jakakolwiek liczba z tablicy jest mniejsza od podanej liczby.

anyLt(num1[], num2) : boolean

num1[] : integer|float

Dowolna tabela liczb

num2 : integer|float

Liczba tego samego typu co liczby w tabeli num1

Wynik:

True jeżeli jakakolwiek liczba z num1 jest mniejsza od num2.

Code Block
// zwraca true
anyLt([0,2,3],1)

// zwraca false
anyLt([1,2,3],1)
anyLt([2,2,3],1)

anyGe

System Plusworkflow

Wszystkie komponentySprawdza czy jakakolwiek liczba z tablicy jest większa lub równa podanej liczbie.

anyGe(num1[], num2) : boolean

num1[] : integer|float

Dowolna tabela liczb

num2 : integer|float

Liczba tego samego typu co liczby w tabeli num1

Wynik:

True jeżeli jakakolwiek liczba z num1 jest większa lub równa liczbie num2.

Code Block
// zwraca true
anyGe([1,2,3],1)
anyGe([2,2,3],1)

// zwraca false
anyLt([0,0,-1],1)

anyGt

System Plusworkflow

Wszystkie komponentySprawdza czy jakakolwiek liczba z tablicy jest większa od podanej liczby.

anyGt(num1[], num2) : boolean

num1[] : integer|float

Dowolna tabela liczb

num2 : integer|float

Liczba tego samego typu co liczby w tabeli num1

Wynik:

True jeżeli jakakolwiek liczba z num1 jest większa od num2.

Code Block
// zwraca true
anyLt([1,0,3],1)
// zwraca false
anyLt([1,0,1],1)
anyLt([0,0,-2],1)

Logiczne

Operatory logiczne są przydatne przede wszystkim w warunkach uruchomienia akcji, walidatora itp.

 

Tip

Możemy dzięki nim tworzyć skomplikowane warunki np. warunek wartość zmiennej 'var1' jest równa 'tak' lub wartość zmiennej 'var1' jest równa 'nie' i jednocześnie wartość zmiennej 'var2' jest równa 'tak':

#or( #eq( $var1, "tak" ), #and( #eq( $var1, "nie" ), #eq( $var2, "tak" ) ) )

NazwaLokalizacjaDostępność w komponentachOpisWarianty funkcji

not

System Plusworkflow

Wszystkie komponentyZwraca negację przekazanego parametru.

not(value) : boolean

value :boolean

Wartość logiczna

Wynik:

Zwraca negację przekazanej wartości.

Code Block
//zwraca false
not( true )

and

System Plusworkflow

Wszystkie komponentyIloczyn logiczny, zwraca true jeżeli wszystkie przekazane parametry są prawdziwe.

and(values) : boolean

values :boolean[])

Tablica wartości logicznych

Wynik:

Zwraca iloczyn logiczny wszystkich przekazanych wartości

Code Block
//zwraca true
and( true, true )
 
//zwraca false
and( false, true )
 
//zwraca false
and( false, false )

or

System Plusworkflow

Wszystkie komponentySuma logiczna, zwraca true jeżeli co najmniej jeden z przekazanych parametrów jest prawdziwy.

or(values) : boolean

values (boolean[])

Tablica wartości logicznych

Wynik:

Zwraca sumę logiczną wszystkich przekazanych wartości

Code Block
//zwraca true
or( true, true )
 
//zwraca true
or( false, true )
 
//zwraca false
or( false, false )

Data i czas

Funkcje do przetwarzania daty i czasu.

NazwaLokalizacjaDostępność w komponentachOpisWarianty funkcji

currentYear

CUF components od wersji 1.0.1Wszystkie komponentyZwraca aktualny rok.

currentYear() : integer

Wynik: 

Pełny rok, np. 2017.

calculateDaysDifference

CUF components od wersji 1.0.2Wszystkie komponenty

Oblicza różnicę w dniach między dwoma datami.

 

calculateDaysDifference() : integer

firstDate : date

Data pierwsza.

secondDate : date

Data druga.

includeFreeDays : boolean

Uwzględnienie dni wolnych. Jeśli uwzględnimy dni wolne, różnica będzie większa o liczbę dni wolnych wypadających między datami (uwzględniając te daty).

 

Funkcja ta bierze pod uwagę systemowy parametr "CustomHolidays" . Parametr ten zawiera listę dodatkowych dni wolnych oddzielonych średnikiem ( ; ). Daty mogą być wpisane w formie pełnej (2018-05-02) lub skróconej (05-02). np: 2018-05-02;05-04 

Wynik:

Ilość dni wynikająca z obustronnie domkniętego przedziału wyznaczanego przez dwie daty. Jako że przedział jest domknięty obustronnie, w przypadku podania dwóch sąsiednich dni spełniających kryterium, funkcja zwróci wartość 2.

calculateTimeDifference

CUF components od wersji 1.0.XWszystkie komponentyOblicza różnicę czasu między dwoma datami. Wynik zwracany jako liczba zmiennoprzecinkowa.

calculateDaysDifference() : integer

Pierwsza data(firstDate) : datetime

Data pierwsza.

Druga data (secondDate) : datetime

Data druga.

Uwzględnij dni wolne(includeFreeDays) : boolean

Uwzględnienie dni wolnych. Jeśli uwzględnimy dni wolne, różnica będzie większa o liczbę dni wolnych wypadających między datami (uwzględniając te daty).

Uwzględnij zmianę czasu(timeShift): boolean

Uwzględnia w obliczeniach zmianę czasu z zimowego na letni i odwrotnie

Typ zwracanych danych(returnType) : String (Lista wyboru)

Typ zwracanych danych. Określa w jakiej jednostce czasu zwracany jest wynik [Sekundy, Minuty, Godziny, Miesiące, Tygodnie, Lata]

Funkcja ta bierze pod uwagę systemowy parametr "CustomHolidays" . Parametr ten zawiera listę dodatkowych dni wolnych oddzielonych średnikiem ( ; ). Daty mogą być wpisane w formie pełnej (2018-05-02) lub skróconej (05-02). np: 2018-05-02;05-04. 

Wynik:

Ilość czasu zwracanego między dwoma datami. W zależności od typu zwracanego, reprezentacja jest w innych jednostkach czasu np.

dla 2020-05-01 10:00:30 i 2020-06-01 10:00:30 z uwzględnieniem dni wolnych i zmiany czasu. Wyniki dla poszczególnych jednostek czasu

Typ zwracanyWynik
Sekundy2678400
Minuty44640
Godziny744
Dni31
Tygodnie4
Miesiące1
Lata0

calcDateWorkingDays

CUF components od wersji 1.0.86Wszystkie komponentyOblicza datę na podstawie przekazanej daty początkowej i dni roboczych. Umożliwia dodawanie/odejmowanie od podanej daty dni roboczych. Funkcja bierze pod uwagę tylko dni robocze, co wiąże się z pominięciem weekendów, dni ustawowo wolnych od pracy, świąt oraz dni urlopowych. Jeśli datą wejściową jest dzień wolny od pracy, to w przypadku podania dodatniej liczby całkowitej w parametrze "Dni robocze", termin zostanie liczony od pierwszego najbliższego dnia roboczego (gdy podano ujemną liczbę dni roboczych, termin rozpocznie naliczanie od ostatniego dnia roboczego).

calcDateWorkDays(date, workingDays) : date

date : date

Data wejściowa

workingDays : integer

Dni robocze

Wynik:

Obliczona data

Code Block
// data początkowa:
 
//zwraca 2020-01-09
calcDateWorkingDays(2019-12-06, 20);
 
//zwraca 2019-12-18
calcDateWorkingDays(2019-12-27, -5);
 
//zwraca 2019-12-23
calcDateWorkingDays(2019-12-25, -1);

currentDate

System PlusworkflowWszystkie komponenty Zwraca aktualną datę.

currentDate() : date

Wynik:

Aktualna data.

Code Block
//zwraca aktualną datę
//np. 2016-01-01
currentDate()

currentDateTime

System PlusworkflowWszystkie komponentyZwraca aktualną datę z czasem.

currentDateTime() : datetime

Wynik:

Aktualna data wraz z czasem.

Code Block
//zwraca aktualną datę z czasem
//np. 2016-01-01 12:30:45
currentDateTime()

formatDate

System PlusworkflowWszystkie komponenty

Formatuje podaną datę do postaci tekstowej zgodnie z podanym formatem.

formatDate(date, format) : string

date : date|datetime

Formatowana data

format : string

Format daty. Dostępne są formaty wbudowane:

  • datetime np. 2015-12-31 12:33:44
  • date np. 2015-12-31
  • time np. 12:33:44
  • year np. 1991
  • month np. 06
  • day np. 12

Wynik:

Aktualna data wraz z czasem.

Code Block
// 2015-12-31 12:33:44
 
//zwraca "2015-12-31"
formatDate(#currentDateTime(), "date")

calcDate

System PlusworkflowWszystkie komponenty

Oblicza datę na podstawie przekazanych parametrów. Umożliwia dodawanie/odejmowanie od podanej daty lat, miesięcy, dni etc.

calcDate(date, interval, unit) : date

date : date

Data bazowa

interval : integer

Okres czasu który zostanie dodany/odjęty od podanej daty

unit : string

Jednostka czasu, jedna z:

  • y lub year - rok
  • m lub month - miesiąc
  • w lub week - tydzień
  • d lub day - dzień

Wynik:

Obliczona data

Code Block
// 2015-12-31
 
//zwraca 2015-12-32
calcDate(#currentDate(), 1, "day");
 
//zwraca 2014-12-32
calcDate(#currentDate(), -1, "y");

calcDateTime

System PlusworkflowWszystkie komponentyOblicza datę i czas na podstawie przekazanych parametrów. Umożliwia dodawanie/odejmowanie od podanej daty lat, miesięcy, dni, godzin, minut etc.

calcDateTime(date, interval, unit) : datetime

date : datetime

Data bazowa

interval : integer

Okres czasu który zostanie dodany/odjęty od podanej daty

unit : string

Jednostka czasu, jedna z:

  • y lub year - rok
  • m lub month - miesiąc
  • w lub week - tydzień
  • d lub day - dzień
  • h lub hour - godzina
  • i lub minute - minuta
  • s lub second - sekunda

Wynik:

Obliczona data

Code Block
// 2015-12-31 12:33:44
 
//zwraca 2015-12-32 12:33:44
calcDate(#currentDateTime(), 1, "day");
 
//zwraca 2014-12-32 12:33:44
calcDate(#currentDateTime(), -1, "y");

le

System PlusworkflowWszystkie komponentySprawdza czy data przekazana w pierwszym parametrze jest mniejsza lub równa od daty przekazanej w drugim parametrze

le(date1, date2) : boolean

date1 : date/datetime

Pierwsza data do porównania

date2 : date/datetime

Druga data do porównania

Wynik:

Prawda lub fałsz

Code Block
// data1 to obiekt LocalDate o wartości "2016-12-24"
// data2 to obiekt LocalDate o wartości "2016-12-24"
// zwraca true
le(data1, data2)

// data1 to obiekt LocalDateTime o wartości "2016-12-24T12:35:22"
// data2 to obiekt LocalDate o wartości "2016-12-24T12:35:22"
// zwraca true
le(data1, data2)

// data1 to obiekt LocalDateTime o wartości "2016-12-24T12:35:22"
// data2 to obiekt LocalDate o wartości "2016-12-24T12:35:23"
// zwraca true
le(data1, data2)

// data1 to obiekt LocalDateTime o wartości "2016-12-24T12:35:22"
// data2 to obiekt LocalDate o wartości "2016-12-24T12:35:21"
// zwraca false
le(data1, data2)

lt

System PlusworkflowWszystkie komponentySprawdza czy data przekazana w pierwszym parametrze jest mniejsza od daty przekazanej w drugim parametrze

lt(date1, date2) : boolean

date1 : date/datetime

Pierwsza data do porównania

date2 : date/datetime

Druga data do porównania

Wynik:

Prawda lub fałsz

Code Block
// data1 to obiekt LocalDate o wartości "2016-12-24"
// data2 to obiekt LocalDate o wartości "2016-12-24"
// zwraca false
lt(data1, data2)

// data1 to obiekt LocalDateTime o wartości "2016-12-24T12:35:22"
// data2 to obiekt LocalDateTime o wartości "2016-12-24T12:35:22"
// zwraca false
lt(data1, data2)

// data1 to obiekt LocalDateTime o wartości "2016-12-24T12:35:22"
// data2 to obiekt LocalDateTime o wartości "2016-12-24T12:35:23"
// zwraca true
lt(data1, data2)

// data1 to obiekt LocalDateTime o wartości "2016-12-24T12:35:22"
// data2 to obiekt LocalDateTime o wartości "2016-12-24T12:35:21"
// zwraca false
lt(data1, data2)

ge

System PlusworkflowWszystkie komponentySprawdza czy data przekazana w pierwszym parametrze jest większa lub równa od daty przekazanej w drugim parametrze

ge(date1, date2) : boolean

date1 : date/datetime

Pierwsza data do porównania

date2 : date/datetime

Druga data do porównania

Wynik:

Prawda lub fałsz

Code Block
// data1 to obiekt LocalDate o wartości "2016-12-24"
// data2 to obiekt LocalDate o wartości "2016-12-24"
// zwraca true
ge(data1, data2)

// data1 to obiekt LocalDateTime o wartości "2016-12-24T12:35:22"
// data2 to obiekt LocalDateTime o wartości "2016-12-24T12:35:22"
// zwraca true
ge(data1, data2)

// data1 to obiekt LocalDateTime o wartości "2016-12-24T12:35:22"
// data2 to obiekt LocalDateTime o wartości "2016-12-24T12:35:23"
// zwraca false
ge(data1, data2)

// data1 to obiekt LocalDateTime o wartości "2016-12-24T12:35:22"
// data2 to obiekt LocalDateTime o wartości "2016-12-24T12:35:21"
// zwraca true
ge(data1, data2)

gt

System PlusworkflowWszystkie komponentySprawdza czy data przekazana w pierwszym parametrze jest wieksza od daty przekazanej w drugim parametrze

gt(date1, date2) : boolean

date1 : date/datetime

Pierwsza data do porównania

date2 : date/datetime

Druga data do porównania

Wynik:

Prawda lub fałsz

Code Block
// data1 to obiekt LocalDate o wartości "2016-12-24"
// data2 to obiekt LocalDate o wartości "2016-12-24"
// zwraca false
gt(data1, data2)

// data1 to obiekt LocalDateTime o wartości "2016-12-24T12:35:22"
// data2 to obiekt LocalDateTime o wartości "2016-12-24T12:35:22"
// zwraca false
gt(data1, data2)

// data1 to obiekt LocalDateTime o wartości "2016-12-24T12:35:22"
// data2 to obiekt LocalDateTime o wartości "2016-12-24T12:35:23"
// zwraca false
gt(data1, data2)

// data1 to obiekt LocalDateTime o wartości "2016-12-24T12:35:22"
// data2 to obiekt LocalDateTime o wartości "2016-12-24T12:35:21"
// zwraca true
gt(data1, data2)

anyLe

System PlusworkflowWszystkie komponentySprawdza czy jakakolwiek z dat w tablicy jest mniejsza lub równa niż data przekazana w drugim parametrze.

anyLe(dates[], date2) : boolean

dates[] : date/datetime

Tablica dat do porównania

date2 : date/datetime

Druga data do porównania

Wynik:

Prawda lub fałsz

Code Block
// dates to obiekt LocalDate o wartości ["2016-12-25", "2016-12-26"]
// data2 to obiekt LocalDate o wartości "2016-12-24"
// zwraca false
anyLe(dates, data2)
 
// dates to obiekt LocalDateTime o wartości ["2016-12-25T12:35:22", "2016-12-26T12:35:22"]
// data2 to obiekt LocalDateTime o wartości "2016-12-24T12:35:22"
// zwraca false
anyLe(dates, data2)

// dates to obiekt LocalDateTime o wartości ["2016-12-24T12:35:22", "2016-12-26T12:35:22"]
// data2 to obiekt LocalDateTime o wartości "2016-12-24T12:35:23"
// zwraca true
anyLe(dates, data2)

// dates to obiekt LocalDateTime o wartości ["2016-12-23T12:35:22", "2016-12-26T12:35:22"]
// data2 to obiekt LocalDateTime o wartości "2016-12-24T12:35:21"
// zwraca true
anyLe(dates, data2)

anyLt

System PlusworkflowWszystkie komponentySprawdza czy jakakolwiek z dat w tablicy jest mniejsza niż data przekazana w drugim parametrze.

anyLt(dates[], date2) : boolean

dates[] : date/datetime

Tablica dat do porównania

date2 : date/datetime

Druga data do porównania

Wynik:

Prawda lub fałsz

Code Block
// dates to obiekt LocalDate o wartości ["2016-12-25", "2016-12-26"]
// data2 to obiekt LocalDate o wartości "2016-12-24"
// zwraca false
anyLt(dates, data2)

// dates to obiekt LocalDateTime o wartości ["2016-12-25T12:35:22", "2016-12-26T12:35:22"]
// data2 to obiekt LocalDateTime o wartości "2016-12-24T12:35:22"
// zwraca false
anyLt(dates, data2)

// dates to obiekt LocalDateTime o wartości ["2016-12-23T12:35:22", "2016-12-26T12:35:22"]
// data2 to obiekt LocalDateTime o wartości "2016-12-24T12:35:21"
// zwraca true
anyLt(dates, data2)

anyGe

System PlusworkflowWszystkie komponentySprawdza czy jakakolwiek z dat w tablicy jest większa lub równa niż data przekazana w drugim parametrze.

anyGe(dates[], date2) : boolean

dates[] : date/datetime

Tablica dat do porównania

date2 : date/datetime

Druga data do porównania

Wynik:

Prawda lub fałsz

Code Block
// dates to obiekt LocalDate o wartości ["2016-12-22", "2016-12-23"]
// data2 to obiekt LocalDate o wartości "2016-12-24"
// zwraca false
anyGe(dates, data2)

// dates to obiekt LocalDateTime o wartości ["2016-12-22T12:35:22", "2016-12-23T12:35:22"]
// data2 to obiekt LocalDateTime o wartości "2016-12-24T12:35:22"
// zwraca false
anyGe(dates, data2)

// dates to obiekt LocalDateTime o wartości ["2016-12-22T12:35:22", "2016-12-24T12:35:22"]
// data2 to obiekt LocalDateTime o wartości "2016-12-24T12:35:23"
// zwraca true
anyGe(dates, data2)

// dates to obiekt LocalDateTime o wartości ["2016-12-22T12:35:22", "2016-12-26T12:35:22"]
// data2 to obiekt LocalDateTime o wartości "2016-12-24T12:35:21"
// zwraca true
anyGe(dates, data2)

anyGt

System PlusworkflowWszystkie komponentySprawdza czy jakakolwiek z dat w tablicy jest większa niż data przekazana w drugim parametrze.

anyGt(dates[], date2) : boolean

dates[] : date/datetime

Tablica dat do porównania

date2 : date/datetime

Druga data do porównania

Wynik:

Prawda lub fałsz

Code Block
// dates to obiekt LocalDate o wartości ["2016-12-22", "2016-12-23"]
// data2 to obiekt LocalDate o wartości "2016-12-24"
// zwraca false
anyGt(dates, data2)

// dates to obiekt LocalDateTime o wartości ["2016-12-22T12:35:22", "2016-12-23T12:35:22"]
// data2 to obiekt LocalDateTime o wartości "2016-12-24T12:35:22"
// zwraca false
anyGt(dates, data2)

// dates to obiekt LocalDateTime o wartości ["2016-12-23T12:35:22", "2016-12-26T12:35:22"]
// data2 to obiekt LocalDateTime o wartości "2016-12-24T12:35:21"
// zwraca true
anyGt(dates, data2)

Działania na tablicach

Funkcje realizujące podstawowe działania na tablicach

Nazwa

LokalizacjaDostępność funkcji w komponentach

Opis

Warianty funkcji

item

System PlusworkflowWszystkie komponenty

Zwraca element tablicy o podanym indeksie. 

item(index, array) : object

index : integer

Indeks elementu

array : object[]

Tablica dowolnego typu

Wynik:

Element z podanego indeksu

Code Block
//zwraca  "b"
 item(1, ["a", "b"]);

length

System PlusworkflowWszystkie komponenty

 Zwraca długość tablicy. W przypadku sprawdzania, czy długość tablicy wynosi 0 należy używać funkcji emptyArray, ponieważ length zwraca niepoprawny wynik dla tablic o długości 0.

length(array) : integer

array : object[]

Tablica dowolnego typu

Wynik:

Długość tablicy

Code Block
 //zwraca 2 
length(["a", "b"]);

formatArray

System PlusworkflowWszystkie komponentyFormatuje liczbę wg. podanych separatorów i liczby miejsc po przecinku dla każdej wartości w tablicy.

format(value[], decimalLen, decimalSeparator, thousandSeparator) : string[]

value : float[]/integer[]

Tablica wartości liczbowych do sformatowania

decimalLen : integer

Liczba miejsc po przecinku

decimalSeparator : string

Separator ułamkowy

thousandSeparator : string

Separator tysięczny (w przypadku pustego łańcucha znaków separator nie pojawi się)

Wynik:

Sformatowana wartość liczbowa w postaci tablicy tekstowej

Code Block
// zwraca ["9 999,1230","1 234,0000", "4 234,1234"]
format([9999.123 , 1234 , 4321.12345], 4, ",", " ")

// zwraca ["9,999.1230"]
format( [9999.123], 4, ".", "," )

// zwraca ["10000"]
format([10000.123], 0, ",", "")

// zwraca ["149,13"]
format([149.125], 2, ",", " ")

formatTextArray

System PlusworkflowWszystkie komponentyFormatuje ciąg znaków wg. podanego schematu dla każdej wartości w tablicy.

formatText(schema[], parameters, [customRegex]) : string[]

schema : string[]

Tablica schematów, w którym kolejne znaki #(lub podane jako opcjonalny parametr customRegex) zostaną zastąpione przez kolejne znaki z parameters.

parameters : string[]

Parametry tekstowe, których kolejne znaki zostaną wpisane do schematu

customRegex : string

Parametr, który zmienia domyślnie podmieniany znak "#" w schemacie, na inny, dowolny

Wynik:

Tablica łańcuchów znaków sformatowany według schematu

Code Block
// zwraca ["AAA-BBB-123","ACAFA123"]
formatText(["###-BBB-###","#C#F####"], ["AA", "A123"])

// zwraca ["#1234BB","12034##BB"]
formatText("#ZZZZZZ",ZZ0ZZ##ZZ ["1234BB"], "Z")

intersect

Cuf-components od wersji 1.0.30Wszystkie komponenty

Wspólna część dwóch tablic. Zwraca elementy, które znajdują się zarówno w pierwszej, jak i w drugiej tablicy, bez powtórzeń.

intersect(arr1, arr2) : object[]

arr1 : string[] | integer[] | float[] | date[]

Pierwsza tablica wartości

arr2 : string[] | integer[] | float[] | date[]

Druga tablica wartości

Wynik:

Tablica wartości (wspólna część tablic) o typie zależnym od wybranych parametrów.

Code Block
// Zwraca ["aaa"]
intersect(["aaa", "ccc"], ["aaa", "bbb"])

// Zwraca [5]
intersect([null, 4, 5], [5, 1])

// Zwraca []
intersect([true], [false, null])

except

Cuf-components od wersji 1.0.30Wszystkie komponenty

Różnica dwóch tablic. Zwraca elementy, które znajdują się w pierwszej, ale nie znajdują w drugiej tablicy, bez powtórzeń.

except(arr1, arr2) : object[]

arr1 : string[] | integer[] | float[] | date[]

Pierwsza tablica wartości

arr2 : string[] | integer[] | float[] | date[]

Druga tablica wartości

Wynik:

Tablica wartości (różnica tablic) o typie zależnym od wybranych parametrów.

Code Block
// Zwraca ["ccc"]
except(["aaa", "ccc"], ["aaa", "bbb"])

// Zwraca [null, 4]
except([null, 4, 5], [5, 1])

// Zwraca [true]
except([true], [false, null])

union

Cuf-components od wersji 1.0.30Wszystkie komponenty

Suma dwóch tablic. Zwraca elementy, które znajdują się w pierwszej lub w drugiej tablicy, bez powtórzeń.

union(arr1, arr2) : object[]

arr1 : string[] | integer[] | float[] | date[]

Pierwsza tablica wartości

arr2 : string[] | integer[] | float[] | date[]

Druga tablica wartości

Wynik:

Tablica wartości (suma tablic) o typie zależnym od wybranych parametrów.

Code Block
// Zwraca ["aaa", "ccc", "bbb"]
union(["aaa", "ccc"], ["aaa", "bbb"])

// Zwraca [null, 4, 5, 1]
union([null, 4, 5], [5, 1])

// Zwraca [true, false, null]
union([true], [false, null])

symmetricDifference

Cuf-components od wersji 1.0.30Wszystkie komponenty

Różnica symetryczna dwóch tablic. Zwraca elementy, które nie znajdują się jednocześnie w pierwszej i drugiej tablicy, bez powtórzeń.

symmetricDifference(arr1, arr2) : object[]

arr1 : string[] | integer[] | float[] | date[]

Pierwsza tablica wartości

arr2 : string[] | integer[] | float[] | date[]

Druga tablica wartości

Wynik:

Tablica wartości (różnica symetryczna tablic) o typie zależnym od wybranych parametrów.

Code Block
// Zwraca ["ccc", "bbb"]
symmetricDifference(["aaa", "ccc"], ["aaa", "bbb"])

// Zwraca [null, 4, 1]
symmetricDifference([null, 4, 5], [5, 1])

// Zwraca [true, false, null]
symmetricDifference([true], [false, null])

unionAll

Cuf-components od wersji 1.0.30Wszystkie komponenty

Suma dwóch tablic. Tworzy nową tablicę scalając dwie tablice przekazane w parametrze.

unionAll(arr1, arr2) : object[]

arr1 : string[] | integer[] | float[] | date[]

Pierwsza tablica wartości

arr2 : string[] | integer[] | float[] | date[]

Druga tablica wartości

Wynik:

Tablica wartości (suma tablic) o typie zależnym od wybranych parametrów.

Code Block
// Zwraca ["aaa","ccc", "aaa", "bbb"]
unionAll(["aaa", "ccc"], ["aaa", "bbb"])

// Zwraca [null, 4, 5, 5, 1]
unionAll([null, 4, 5], [5, 1])

// Zwraca [true, false, null]
unionAll([true], [false, null])

distinct

Cuf-components od wersji 1.0.30Wszystkie komponenty

Funkcja zwracająca tablicę wartości bez powtórzeń z tabeli przekazanej w parametrze.

distinct(array) : object[]

array :string[] | integer[] | float[] | date[]

Tablica wartości

Wynik:

Tablica z wartościami o typie zależnym od typu przekazanego w parametrze

Code Block
// Zwraca ["aaa", "bbb"]
distinct(["aaa", "bbb", "aaa"]) 

// Zwraca [null, 4, 5]
distinct([null, 4, 5, null, 4)

// Zwraca [true, false]
distinct([true, true, true, false, false])

filter

 

Cuf-components od wersji 1.0.55Wszystkie komponenty

Funkcja filtrująca elementy tablicy wg podanych kryteriów. Pozostawia te wartości, które spełnią wszystkie z filtrów. Filtr może być pojedyńczy lub tablicowy.

Filtry pojedyncze porównują wartości z pola Kolumny do filtrowania z wartością w polu Wartości filtrujące.

Filtry tablicowe porównują wartości z pola Kolumny do filtrowania z odpowiadającymi im (pod względem kolejności) wartościami podanymi w polu Kolumny filtrujące.

filter(array, singleVariables, singleFilterTypes, singleFilter, multiVariables, multiFilterTypes multiFilter) : string[] | integer[] | float[] | date[]

array : string[] | integer[] | float[] | date[]

Tablica wartości

singleVariables : variable[]
Kolumny do filtrowania (dla pojedyńczych wartości)

singleFilterTypes : string[]

Rodzaj filtrowania

singleFilter : string[]

Wartości filtrujące

multiVariables : variable[]

Kolumny do filtrowania (dla wartości tabelarycznych)

multiFilterTypes : string[]

Rodzaj filtrowania

multiFilter : variable[]

Kolumny filtrujące

subArray

System PlusworkflowWszystkie komponentyZwraca cześć tablicy z podanego przedziału. Indeksy liczone są od 0. W momencie podania indeksu "Od" mniejszego od 0 jest ustawiany 0 indeks. Dla parametru "Do" wiekszego od długości tablicy podstawiana jest wartość równa długości tablicy.

subArray(array,from,to) : string[] | integer[] | float[] | date[] | datetime[] | boolean[]

Tablica(array) : string[] | integer[] | float[] | date[] | datetime[] | boolean[]

Taablica oryginalnej wielkości

Od(from) : integer

Indeks początkowy (z tym indeksem)

Do(to) : integer

Indeks końcowy (bez tego indeksu)

Wynik:

Tablica stanowiąca cześć orginalnej tablicy wejściowej

Code Block
// zwróci [2]
subArray([1,2,3], 1,2)
 
// zwróci [2,3]
subArray("[1,2,3], 1,6)
 
// zwróci [1,2]
subArray("[1,2,3], -1,2)

Niewydane getSelectedRowNo

Cuf-components od wersji x.xTylko komponenty przeglądarkoweFunkcja zwracająca indeks zaznaczonego wiersza.

getSelectedRowNo(tableId) : integer

tableId: string

Tekst wejściowy

Wynik:

Liczba całkowita

Code Block
// zwróci 2
getSelectedRowNo("id_tabeli")

Konwersja typów

Funkcje umożliwiające konwersję typów

NazwaLokalizacjaDostępność funkcji w komponentachOpisWarianty funkcji

toString

System Plusworkflow

Wszystkie komponenty

Konwertuje podaną wartość do jej domyślnej postaci tekstowej. Możliwa jest konwersja z:

  • wartości logicznej (boolean)
    • true = "true"
    • false = "false"
  • liczby całkowitej (integer)
    • 123 = "123"
  • liczby zmiennoprzecinkowej
    • 123.12 = "123.12"
  • datyformatuje datę używając domyślnego formatu "yyyy-MM-dd"
    • 2016-01-01 = "2016-01-01"
  • daty i czasu (datetime) - formatuje datę używając domyślnego formatu "yyyy-MM-dd HH:mm:ss"
    • 2016-01-01 12:11:22 = "2016-01-01 12:11:22"

toString(value) : string

value : boolean|integer|float|date|datetime

Konwertowana wartość

Wynik:

Tekst reprezentujący wartość

Code Block
//zwraca "false"
toString(false);

toStringArray

System Plusworkflow

Wszystkie komponentyKonwertuje podaną tablicę wartości do tablicy wartości tekstowych. Zasady konwersji są takie same jak w przypadku funkcji toString.

toStringArray(array) : string[]

array : variable|boolean[]|integer[]|float[]|date[]|datetime[]

Konwertowana tablica wartości

Wynik:

Tablica wartości tekstowych

Code Block
//zwraca ["false", "true"]
toStringArray([false, true]);

toBoolean

System Plusworkflow

Wszystkie komponenty Konwertuje podaną wartość do wartości logicznej. Możliwa jest konwersja z:
  • wartości tekstowej (string)
    • "true" = true
    • "false" = false
  • liczby całkowitej (integer)
    • 0 = false reszta true
  • liczby zmiennoprzecinkowej (float)
    • 0.0 = false reszta true

toBoolean(value) : boolean

value : string|integer|float

Konwertowana wartość

Wynik:

Wartość logiczna

Code Block
//zwraca true
toBoolean("true");

toBooleanArray

System Plusworkflow

Wszystkie komponentyKonwertuje podaną tablicę wartości do tablicy wartości logicznych. Zasady konwersji są takie same jak w przypadku funkcji toBoolean.

toBooleanArray(array) : boolean[]

 array : string[]|integer[]|float[]

Konwertowana tablica wartości

Wynik:

Tablica wartości logicznych

Code Block
//zwraca [false, true]
toBooleanArray([0, 1]);

toInteger

System Plusworkflow

Wszystkie komponenty

Konwertuje podaną wartość do liczby całkowitej. Możliwa jest konwersja z:

  • wartości logicznej (boolean)

    • true = 1

    • false = 0

  • wartości tekstowej (string)

    • "123" = 123

  • liczby zmiennoprzecinkowej (float) - zaokrąglanie do najbliższej liczby całkowitej

    • 123.56 = 124

toInteger(value) : integer

value : boolean|string|float

Konwertowana wartość

Wynik:

Liczba całkowita

Code Block
//zwraca 123
toInteger("123");

toIntegerArray

System Plusworkflow

Wszystkie komponentyKonwertuje podaną tablicę wartości do tablicy liczb całkowitych. Zasady konwersji są takie same jak w przypadku funkcji toInteger.

toIntegerArray(array) : integer[]

array : variable|boolean[]|string[]|float[]

Konwertowana tablica wartości

Wynik:

Tablica liczb całkowitych

Code Block
//zwraca [1, 2]
toIntegerArray(["1", "2"]);

toFloat

System Plusworkflow

Wszystkie komponenty

Konwertuje podaną wartość do liczby zmiennoprzecinkowej. Możliwa jest konwersja z:

  • wartości logicznej (boolean)

    • true = 1.0

    • false = 0.0

  • wartości tekstowej (string)

    • "123.123" = 123.123

  • liczby całkowitej (integer)

    • 123 = 123.0

toFloat(value) : float

 value : boolean|string|integer

Konwertowana wartość

Wynik:

Liczba zmiennoprzecinkowa

Code Block
//zwraca 123.123
toFloat("123.123");

toFloatArray

System Plusworkflow

Wszystkie komponentyKonwertuje podaną tablicę wartości do tablicy liczb zmiennoprzecinkowych. Zasady konwersji są takie same jak w przypadku funkcji toFloat.

toFloatArray(array) : float[]

array : boolean[]|string[]|integer[] | variable

Konwertowana tablica wartości

Wynik:

Tablica liczb zmiennoprzecinkowych

Code Block
//zwraca [1.0, 2.3]
toFloatArray(["1", "2.3"]);

toDate

System PlusworkflowWszystkie komponenty

Konwertuje podaną wartość tekstową do daty. Formaty przyjmowane przez funkcję:

"Y-M-d", "Y.M.d", "d-M-Y", "d.M.Y"

toDate(value) : date

value: string

Wartość tekstowa

Wynik:

Data uzyskana z tekstu

Code Block
// zwraca obiekt LocalDate z datą 1991-06-12
toDate("1991-06-12");
// zwraca null
toDate("");
toDate(null);

toDateArray

System PlusworkflowWszystkie komponentyKonwertuje podaną tablicę wartości tekstowych do tablicy wartości datowych. Zasady konwersji są takie same jak w przypadku funkcji toDate.

toDateArray(values) : date[]

values - string[] | variable

Tablica wartości tekstowych / zmiennych

Wynik:

Tablica dat uzyskana z tablicy wartości tekstowych

Code Block
// Zwraca tablice obiektów LocalDate
toDateArray(["1991-06-12", "1991-06-13"] );
// zwraca pustą tablicę
toDateArray([])

toDateTime

System PlusworkflowWszystkie komponenty

Konwertuje podaną wartość tekstową do daty z czasem. Formaty przyjmowane przez funkcję:

"Y-M-d", "Y.M.d", "d-M-Y", "d.M.Y",
"Y-M-d H:m:s", "Y.M.d H:m:s", "d-M-Y H:m:s", "d.M.Y H:m:s"


toDateTime(value) : datetime

value - string

Wartość tekstowa

Wynik:

Data i czas z wartości tekstowej

Code Block
// zwraca obiekt LocalDateTime z datą 1991-06-12 11:09:22
toDateTime("1991-06-12 11:09:22");
// zwraca null
toDateTime("");
toDateTime(null);

toDateTimeArray

System PlusworkflowWszystkie komponentyKonwertuje podaną tablicę wartości tekstowych do tablicy wartości datowych z czasem. Zasady konwersji są takie same jak w przypadku funkcji toDateTime.

toDateTimeArray(values) : datetime[]

values - string[]

Tablica wartości tekstowych

Wynik:

Tablica wartości z datą i czasem stworzona z tablicy wartości tekstowych

Code Block
// zwraca tablicę wartości LocalDateTime
toDateTimeArray(["1991-06-12 11:09:12", "1991-06-13 11:09:11"] );
// zwraca pustą tablicę
toDateTimeArray([])

Funkcje kontekstowe

Funkcje wykorzystujące konteksty do odczytu danych związanych z aktualnie wykonywaną akcją.

NazwaLokalizacjaDostępność w komponentachOpisWarianty funkcji

currentUser

 

 

System PlusworkflowWszystkie komponenty

Zwraca login aktualnego użytkownika.

currentUser() : string

Wynik:

Login aktualnego użytkownika.

Code Block
// np. "admin"
currentUser()

currentUser

System PlusworkflowWszystkie komponenty Zwraca informacje o aktualnym użytkowniku - podaną właściwość jedną z:
  • username: login
  • firstname: imię
  • lastname: nazwisko
  • fullname: pełna nazwa (imię + nazwisko)
  • email: adres email
  • number: numer użytkownika

currentUser(property) : string

property : string

Nazwa zwracanej właściwości użytkownika

Wynik:

Wartość podanej właściwości aktualnego użytkownika

Code Block
// np. "admin@suncode.pl"
currentUser("email")

currentUserGroups

System PlusworkflowWszystkie komponenty

Zwraca listę nazw grup aktualnego użytkownika.

currentUserGroups() : string[]

Wynik:

Tablica nazw grup do których należy użytkownik

Code Block
// np. ["pracownik", "administrator"]
currentUserGroups()

currentUserInGroup

System Plusworkflow

Wszystkie komponenty

Sprawdza, czy aktualny użytkownik należy do grupy o podanej nazwie.

currentUserInGroup(group) : boolean

group : string

Nazwa grupy

Wynik:

true jeżeli użytkownik należy do podanej grupy

Code Block
// true jeżeli należy do grupy
currentUserGroups("pracownik")

currentUserPositions

System PlusworkflowWszystkie komponentyZwraca symbole wszystkich stanowisk aktualnego użytkownika.

currentUserPositions() : string[]

Wynik:

Tablica symboli stanowisk użytkownika

Code Block
// np. ["p01", "d02"]
currentUserPositions()

currentUserPositionNames

System PlusworkflowWszystkie komponentyZwraca nazwy wszystkich stanowisk aktualnego użytkownika.

currentUserPositionNames() : string[]

Wynik:

Tablica nazw stanowisk użytkownika

Code Block
// np. ["Pracownik1", "Akceptujący"]
currentUserPositionNames() 

currentUserHasPosition

System Plusworkflow

Wszystkie komponenty

Sprawdza, czy aktualny użytkownik posiada stanowisko o podanym symbolu.

currentUserHasPosition(symbol) : boolean

symbol : string

Symbol stanowiska

Wynik:

true jeżeli użytkownik jest przypisany do podanego stanowiska

Code Block
 // true jeżeli jest przypisany do stanowiska
currentUserHasPostition("p01")

currentUserUnits

System PlusworkflowWszystkie komponentyZwraca symbole wszystkich jednostek organizacyjnych aktualnego użytkownika.

currentUserUnits() : string[]

Wynik:

Tablica symboli jednostek organizacyjnych do których należy użytkownik

Code Block
 // np. ["kadry", "it"]
currentUserUnits()

currentUserUnitNames

System PlusworkflowWszystkie komponentyZwraca nazwy wszystkich jednostek organizacyjnych aktualnego użytkownika.

currentUserUnitNames() : string[]

Wynik:

Tablica nazw jednostek organizacyjnych do których należy użytkownik

Code Block
 // np. ["Kadry", "Dział IT"]
currentUserUnitNames()

currentUserInUnit

System Plusworkflow

Wszystkie komponenty

Sprawdza, czy aktualny użytkownik należy do jednostki organizacyjnej o podanym symbolu.

currentUserInUnit(symbol) : boolean

symbol : string

Symbol jednostki organizacyjnej

Wynik:

true jeżeli użytkownik należy do podanej jednostki organizacyjnej

Code Block
// true jeżeli należy do jednostki
currentUserInUnit("it")

currentUserHigherPositions

System PlusworkflowWszystkie komponentyZwraca symbole wszystkich stanowisk nadrzędnych aktualnego użytkownika.

currentUserHigherPostitions() : string[]

Wynik:

Tablica symboli stanowisk nadrzędnych użytkownika

Code Block
 // np. ["kp"]
currentUserHigherPositions()

currentUserHigherPositionNames

System PlusworkflowWszystkie komponentyZwraca nazwy wszystkich stanowisk nadrzędnych aktualnego użytkownika.

currentUserHigherPostitionNames() : string[]

Wynik:

Tablica nazw stanowisk nadrzędnych użytkownika

Code Block
// np. ["Kierownik Produkcji"]
currentUserHigherPositionNames() 

currentUserSupervisors

System PlusworkflowWszystkie komponentyZwraca loginy wszystkich bezpośrednich przełożonych (z nadrzędnych stanowisk) aktualnego użytkownika.

currentUserSupervisors() : string[]

Wynik:

Tablica loginów wszystkich bezpośrednich przełożonych aktualnego użytkownika

Code Block
// np. ["akowalski"]
currentUserSupervisors() 

currentUserHasSupervisor

System Plusworkflow

Wszystkie komponenty

Sprawdza, czy osoba o podanym loginie jestprzełożonym aktualnego użytkownika.

currentUserSupervisors(username) : boolean

username : string

Login użytkownika

Wynik:

true jeżeli podany użytkownik jest bezpośrednim przełożonym aktualnego użytkownika

Code Block
// true jeżeli "akowalski" jest
// przełożonym użytkownika
currentUserHasSupervisor("akowalski")

isMobile

System PlusworkflowTylko komponenty przeglądarkoweSprawdza, czy formularz jest uruchomiony w aplikacji mobilnej PlusWorkflow Mobile

isMobile() : boolean

Wynik:

true jeżeli formularz jest uruchomiony w aplikacji mobilnej PlusWorkflow Mobile

Code Block
// true jeżeli formularz jest uruchomiony 
// w aplikacji mobilnej PlusWorkflow Mobile
isMobile()

Niewydane getFullName

Cuf-components od wersji x.xTylko komponenty serweroweZwraca imię i nazwisko użytkownika na podstawie podanego loginu.

getFullName(userName) : string

userName : string

 

Login użytkownika

Wynik:

Wartość tekstowa.

Code Block
// zwróci Jan Kowalski
getFullName("jkowalski")

Niewydane getFullNames

Cuf-components od wersji x.xTylko komponenty serweroweZwraca tablicę imion i nazwisk użytkowników na podstawie podanych loginów.

getFullNames(userNames) : string[]

userNames : string[]

 

Loginy użytkowników

Wynik:

Tablica wartości tekstowych.

Code Block
// zwróci ["Jan Kowalski", "Piotr Nowak"]
getFullNames(["jkowalski", "pnowak"])

Funkcje warunkowe

Funkcje zawracające dany parametr po spełnieniu określonego warunku

NazwaLokalizacjaDostępność funkcji w komponentachOpisWarianty funkcji

ifFn

 

 

System PlusworkflowWszystkie komponenty

Funkcja warunkowa (if) - zwraca dany parametr w zależności od warunku

parametry trueParam i falseParam muszą być tego samego typu.

ifFn( condition , trueParam , falseParam ) : integer/float/string/date/datetime/boolean/integer[]/float[]/string[]/date[]/datetime[]/boolean[]

condition : boolean

Warunek funkcji

trueParam : integer/float/string/date/datetime/boolean/integer[]/float[]/string[]/date[]/datetime[]/boolean[]

Wartość zwracana, gdy warunek prawdziwy

falseParam : integer/float/string/date/datetime/boolean/integer[]/float[]/string[]/date[]/datetime[]/boolean[]

Wartość zwracana, gdy warunek nie prawdziwy

Wynik:

Wynikiem jest parametr trueParam lub falseParam w zależności od spełnienia warunku

Code Block
// zwraca 2
ifFn(true,2,3);
// zwraca "NIE"
ifFn(false,"TAK", "NIE");
// zwraca ["a","b"]
ifFn(false,["AA","BB","CC"], ["a","b"]);


ifFnString

System PlusworkflowWszystkie komponentyFunkcja zwraca wartość pierwszej lub drugiej funkcji - w zależności od warunku

ifFnString( condition , trueParam , falseParam ) : string

condition : boolean

Warunek funkcji

trueParam : string

Wartość zwracana, gdy warunek prawdziwy

falseParam : string

Wartość zwracana, gdy warunek nie prawdziwy

Wynik:

Wartość tekstowa, będąca wynikiem jednej z funkcji przekazanych w parametrze

ifFnStringArray

System PlusworkflowWszystkie komponentyFunkcja zwraca wartość pierwszej lub drugiej funkcji - w zależności od wyniku funkcji warunkowej

ifFnStringArray( condition , trueParam , falseParam ) : string[]

condition : boolean

Warunek funkcji

trueParam : string[]

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca prawdę. Musi zwracać typ Tablica wartości tekstowych

falseParam : string[]

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca fałsz. Musi zwracać typ Tablica wartości tekstowych

Wynik:

Tablica wartości tekstowych, będąca wynikiem jednej z funkcji przekazanych w parametrze

ifFnInteger

System PlusworkflowWszystkie komponentyFunkcja zwraca wartość pierwszej lub drugiej funkcji - w zależności od wyniku funkcji warunkowej

ifFnInteger( condition , trueParam , falseParam ) : integer

condition : boolean

Warunek funkcji

trueParam : integer

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca prawdę. Musi zwracać typ Całkowity

falseParam : integer

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca fałsz. Musi zwracać typ Całkowity

Wynik:

Wartość całkowita, będąca wynikiem jednej z funkcji przekazanych w parametrze

ifFnIntegerArray

System PlusworkflowWszystkie komponentyFunkcja zwraca wartość pierwszej lub drugiej funkcji - w zależności od wyniku funkcji warunkowej

ifFnIntegerArray( condition , trueParam , falseParam ) : integer[]

condition : boolean

Warunek funkcji

trueParam : integer[]

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca prawdę. Musi zwracać typ Tablica wartości całkowitych

falseParam : integer[]

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca fałsz. Musi zwracać typ Tablica wartości całkowitych

Wynik:

Tablica wartości całkowitych, będąca wynikiem jednej z funkcji przekazanych w parametrze

ifFnFloat

System PlusworkflowWszystkie komponentyFunkcja zwraca wartość pierwszej lub drugiej funkcji - w zależności od wyniku funkcji warunkowej

ifFnFloat( condition , trueParam , falseParam ) : float

condition : boolean

Warunek funkcji

trueParam : float

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca prawdę. Musi zwracać typ Zmiennoprzecinkowy

falseParam : float

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca fałsz. Musi zwracać typ Zmiennoprzecinkowy

Wynik:

Wartość zmiennoprzecinkowa, będąca wynikiem jednej z funkcji przekazanych w parametrze

ifFnFloatArray

System PlusworkflowWszystkie komponentyFunkcja zwraca wartość pierwszej lub drugiej funkcji - w zależności od wyniku funkcji warunkowej

ifFnIntegerArray( condition , trueParam , falseParam ) : float[]

condition : boolean

Warunek funkcji

trueParam : float[]

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca prawdę. Musi zwracać typ Tablica wartości zmiennoprzecinkowych

falseParam : float[]

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca fałsz. Musi zwracać typ Tablica wartości zmiennoprzecinkowych

Wynik:

Tablica wartości zmiennoprzecinkowych, będąca wynikiem jednej z funkcji przekazanych w parametrze

ifFnDate

System PlusworkflowWszystkie komponentyFunkcja zwraca wartość pierwszej lub drugiej funkcji - w zależności od wyniku funkcji warunkowej

ifFnDate( condition , trueParam , falseParam ) : date

condition : boolean

Warunek funkcji

trueParam : date

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca prawdę. Musi zwracać typ Datowy

falseParam : date

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca fałsz. Musi zwracać typ Datowy

Wynik:

Wartość datowa, będąca wynikiem jednej z funkcji przekazanych w parametrze

ifFnDateArray

System PlusworkflowWszystkie komponentyFunkcja zwraca wartość pierwszej lub drugiej funkcji - w zależności od wyniku funkcji warunkowej

ifFnDateArray( condition , trueParam , falseParam ) : date[]

condition : boolean

Warunek funkcji

trueParam : date[]

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca prawdę. Musi zwracać typ Tablica wartości datowych

falseParam : date[]

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca fałsz. Musi zwracać typ Tablica wartości datowych

Wynik:

Tablica wartości datowych, będąca wynikiem jednej z funkcji przekazanych w parametrze

ifFnDateTime

System PlusworkflowWszystkie komponentyFunkcja zwraca wartość pierwszej lub drugiej funkcji - w zależności od wyniku funkcji warunkowej

ifFnDateTime( condition , trueParam , falseParam ) : datetime

condition : boolean

Warunek funkcji

trueParam : datetime

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca prawdę. Musi zwracać typ Datowy z czasem

falseParam : datetime

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca fałsz. Musi zwracać typ Datowy z czasem

Wynik:

Wartość datowa z czasem, będąca wynikiem jednej z funkcji przekazanych w parametrze

ifFnDateTimeArray

System PlusworkflowWszystkie komponentyFunkcja zwraca wartość pierwszej lub drugiej funkcji - w zależności od wyniku funkcji warunkowej

ifFnDateTimeArray( condition , trueParam , falseParam ) : datetime[]

condition : boolean

Warunek funkcji

trueParam : datetime[]

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca prawdę. Musi zwracać typ Tablica wartości datowych z czasem

falseParam : datetime[]

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca fałsz. Musi zwracać typ Tablica wartości datowych z czasem

Wynik:

Tablica wartości datowych z czasem, będąca wynikiem jednej z funkcji przekazanych w parametrze

ifFnBoolean

System PlusworkflowWszystkie komponentyFunkcja zwraca wartość pierwszej lub drugiej funkcji - w zależności od wyniku funkcji warunkowej

ifFnBoolean( condition , trueParam , falseParam ) : boolean

condition : boolean

Warunek funkcji

trueParam : boolean

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca prawdę. Musi zwracać typ Logiczny

falseParam : boolean

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca fałsz. Musi zwracać typ Logiczny

Wynik:

Wartość logiczny, będąca wynikiem jednej z funkcji przekazanych w parametrze

ifFnBooleanArray

System PlusworkflowWszystkie komponentyFunkcja zwraca wartość pierwszej lub drugiej funkcji - w zależności od wyniku funkcji warunkowej

ifFnBooleanArray( condition , trueParam , falseParam ) : boolean[]

condition : boolean

Warunek funkcji

trueParam : boolean[]

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca prawdę. Musi zwracać typ Tablica wartości logicznych

falseParam : boolean[]

Funkcja, której wynik jest zwracany w przypadku, gdy warunek zwraca fałsz. Musi zwracać typ Tablica wartości logicznych

Wynik:

Tablica wartości logicznych, będąca wynikiem jednej z funkcji przekazanych w parametrze

Tłumaczenia

 Funkcje umożliwiające pobieranie tłumaczeń.

NazwaLokalizacjaDostępność funkcji w komponentachOpisWarianty funkcji

translate

 

 

System PlusworkflowWszystkie komponenty

Zwraca tłumaczenie dla podanego klucza. Jeżeli tłumaczenie nie zostanie odnalezione, zwracany jest podany klucz. Pod uwagę brane są serwerowe (scope = SERVER) klienckie translatory oraz tłumaczenia z wtyczek.

translate(text) : string

text : string

Klucz do przetłumaczenia

Wynik: 

Przetłumaczony klucz wyszukany ze wszystkich dostępnych translatorów. 

Code Block
// np. "Tak", jeżeli użytkownik ma
// ustawiony język polski
translate("yes")

translate


 
System PlusworkflowWszystkie komponentyZwraca tłumaczenie dla podanego klucza. Jeżeli tłumaczenie nie zostanie odnalezione, zwracany jest podany klucz. Pod uwagę brane są serwerowe (scope = SERVER) klienckie translatory oraz tłumaczenia z wtyczek.

translate(text,translatorName) : string

text : string

Klucz do przetłumaczenia

translatorName : string

Nazwa translatora

Wynik:

Przetłumaczony klucz wyszukany w podanym translatorze.

Code Block
// np. "Faktury", jeżeli stworzony został kliencki
// translator lub tłumaczenie zostało dodane do wtyczki
// o takim id
translate("invoices", "customTranslatorName")
Info
titleOd wersji 3.2.156

Aby skorzystać z tłumaczeń Custom messages należy użyć nazwy translatora: custom-messages

Przykład:

Code Block
translate("customKey", "custom-messages")

translate

System PlusworkflowWszystkie komponentyZwraca tłumaczenie dla podanego klucza. Jeżeli tłumaczenie nie zostanie odnalezione, zwracany jest podany klucz. Pod uwagę brane są serwerowe (scope = SERVER) klienckie translatory oraz tłumaczenia z wtyczek.

translate(text, args, translatorName) : string

text : string

Klucz do przetłumaczenia

args : string[]

Parametry przekazywane do translatora. Podstawiane za znaczniki {0}, {1} itd.

translatorName : string

Nazwa translatora

Wynik:

Przetłumaczony klucz wyszukany w podanym translatorze z podstawionymi parametrami

Code Block
// np. dla translatora o nazwie "customTranslatorName" i klucza
// invoice=Faktura nr {0} z {1}
translate("invoice", ["123", "1000"], "customTranslatorName")
// wynik "Faktura nr 123 z 1000
Info

Preferowane jest użycie funkcji z podaną nazwą translatora, gdyż jednoznacznie wskazuje ona na tłumaczenie spośród wszystkich translatorów załadowanych w systemie.

Użytkownik

NazwaLokalizacjaDostępność funkcji w komponentachOpisWarianty funkcji

usersFromGroup

CUF components 1.0.16Tylko komponenty serweroweFunkcja serwerowa, która zwraca użytkowników z danej grupy.

usersFromGroup(groupName) : string[]

groupName (string)

Nazwa grupy

Wynik:

Tablica loginów użytkowników

usersFromGroup

CUF components 1.0.16Tylko komponenty serweroweFunkcja serwerowa, która zwraca użytkowników z danej grupy i jednostki organizacyjnej.

usersFromGroup(groupName, ou) : string[]

groupName (string)

Nazwa grupy

ou (string)

Symbol jednostki organizacyjnej

Wynik:

Tablica loginów użytkowników

usersWithRole

CUF components 1.0.16Tylko komponenty serweroweFunkcja serwerowa, która zwraca użytkowników o danej roli

usersWithRole(roleId) : string[]

roleId (string)

Rola

Wynik:

Tablica loginów użytkowników

usersWithRole

CUF components 1.0.16Tylko komponenty serweroweFunkcja serwerowa, która zwraca użytkowników o danej roli i jednostki organizacyjnej.

usersWithRole(roleId, ou) : string[]

roleId (string)

Rola

ou (string)

Jednostka organizacyjna (symbol)

Wynik:

Tablica loginów użytkowników

userSuperiors

CUF components 1.0.29Tylko komponenty serweroweFunkcja serwerowa zwracająca przełożonych użytkownika. Zwracana jest tablica wartości, a nie tekst.

userSuperiors(userName) : string[]

userName : string

Nazwa użytkownika

usersFromOU

CUF components 1.0.29Tylko komponenty serwerowe

Funkcja serwerowa pobierająca loginy użytkowników z jednostki organizacyjnej o podanej nazwie

 

usersFromOU(ou) : string[]

ou : string

Nazwa jednostki organizacyjnej

Wynik:

Tablica z loginami użytkowników

usersFromOU

CUF components 1.0.29Tylko komponenty serwerowe

Funkcja serwerowa pobierająca loginy użytkowników z jednostki organizacyjnej o podanej nazwie i (opcjonalnie) użytkowników z jednostek podrzędnych do niej.

usersFromOU(ouName, includeSubUnits ) : string[]

ouName : string

Nazwa jednostki organizacyjnej

includeSubUnits : boolean

Dodaj użytkowników z jednostek podrzędnych

Wynik:

Tablica z loginami użytkowników

usersFromOUSymbol

 

CUF components 1.0.29Tylko komponenty serwerowe

Funkcja serwerowa pobierająca loginy użytkowników z jednostki organizacyjnej o podanym symbolu

usersFromOUSymbol(ousymbol) : string[]

ouSymbol : string

Symbol jednostki organizacyjnej

Wynik:

Tablica z loginami użytkowników

usersFromOUSymbol

 

CUF components 1.0.29Tylko komponenty serwerowe

Funkcja serwerowa pobierająca loginy użytkowników z jednostki organizacyjnej o podanym symbolu i (opcjonalnie) użytkowników z jednostek podrzędnych do niej.

usersFromOUSymbol(ousymbol, includeSubUnits) : string[]

ouSymbol : string

Symbol jednostki organizacyjnej

includeSubUnits : boolean

Dodaj użytkowników z jednostek podrzędnych

Wynik:

Tablica z loginami użytkowników

usersWithPosition

CUF components 1.0.29 do 1.0.53Tylko komponenty serwerowe

(została zastąpiona przez userWithPosition)

Funkcja serwerowa pobierająca loginy użytkowników ze stanowiskiem o podanym symbolu

usersWithPosition(position) : string[]

postition : string

Nazwa stanowiska

Wynik:

Tablica z loginami użytkowników

usersWithPositionSymbol

CUF components 1.0.29 do 1.0.53Tylko komponenty serwerowe

(została zastąpiona przez userWithPosition)

Funkcja serwerowa pobierająca loginy użytkowników ze stanowiskiem o podanej nazwie

usersWithPositionSymbol(position) : string[]

postitionSymbol : string

Symbol stanowiska

Wynik:

Tablica z loginami użytkowników

userWithPosition

CUF components 1.0.53Tylko komponenty serwerowe

Funkcja serwerowa pobierająca login użytkownika ze stanowiskiem o podanej nazwie

userWithPosition(position) : string

postition : string

Nazwa stanowiska

Wynik:

Login użytkownika

userWithPositionSymbol

CUF components 1.0.53Tylko komponenty serwerowe

Funkcja serwerowa pobierająca login użytkownika ze stanowiskiem o podanym symbolu

userWithPositionSymbol(positionSymbol) : string

postitionSymbol : string

Symbol stanowiska

Wynik:

Login użytkownika

usersWithPositions

CUF components 1.0.54Tylko komponenty serwerowe

Funkcja serwerowa pobierająca loginy użytkowników ze stanowiskami o podanych nazwach

usersWithPositions(positions) : string[]

postition : string[]

Nazwy stanowisk

Wynik:

Loginy użytkowników

usersWithPositionsSymbols

CUF components 1.0.54Tylko komponenty serwerowe

Funkcja serwerowa pobierająca loginy użytkowników ze stanowiskami o podanych symbolach

userWithPositionSymbol(positionsSymbols) : string[]

postitionsSymbols : string[]

Symbole stanowisk

Wynik:

Loginy użytkowników

Dokumenty

NazwaLokalizacjaDostępność funkcji w komponentachOpisWarianty funkcji

numberOfDocumentsFromCurrentProcess

CUF components 1.0.73

Tylko komponenty serwerowe

Zwraca liczbę dokumentów podpiętych do aktualnego procesu

numberOfDocuments() : integer

Wynik:

Liczba dokumentów

numberOfDocumentsFromCurrentProcess

CUF components 1.0.73

Tylko komponenty serwerowe

Zwraca liczbę dokumentów podpiętych do aktualnego procesu z podanej klasy dokumentów

numberOfDocuments(className) : integer

className : string

Nazwa klasy dokumentów

Wynik:

Liczba dokumentów

Funkcje generujące losowe wartości

NazwaLokalizacjaDostępność funkcji w komponentachOpisWarianty funkcji

generateUniqueCode

CUF components od wersji 1.0.84

Wszystkie komponenty

Zwraca 11-znakowy, unikatowy kod alfanumeryczny.

generateUniqueCode() : string

Wynik:

Tekst zawierający kod alfanumeryczny, np. oYWz3wVp1pj

 

Funkcje grupujące

NazwaLokalizacjaDostępność funkcji w komponentachOpisWarianty funkcji

groupBy

CUF components od wersji 1.0.xWszystkie komponenty

Grupuje i agreguje dane z tabeli (na wzór SQL-owej funkcji groupBy).

Szczegółowy opis funkcji.

groupBy(agregateFunctions, rawColumns, concatSeparator, groupByColumns) : string

Wynik:

Obiekt TableStore.

Generujące JSON'a

NazwaLokalizacjaDostępność funkcji w komponentachOpisWarianty funkcji

toJsonObject

CUF components od wersji 1.0.95

Wszystkie komponenty

Generuje ciąg tekstowy JSON w postaci obiektu.

Szczegółowy opis

toJsonObject(keys, values, types) : string

Wynik:

Ciąg tekstowy JSON reprezentujący obiekt.

Code Block
// np. dla kluczy: imię, nazwisko
dla wartości: Adam, Pastewski
dla typów: Wartość tekstowa, Wartość tekstowa 
// wynik: {"imię":"Adam", "Nazwisko":"Pastewski"}

toJsonArray

CUF components od wersji 1.0.95Wszystkie komponenty

Generuje ciąg tekstowy JSON w postaci tablicy.

Szczegółowy opis 

toJsonArray(values, type) : string

Wynik:

Ciąg tekstowy JSON reprezentujący tablicę.

Code Block
// np. dla wartości: 5, 10, 15 
dla typu: Wartość całkowita 
// wynik: [5,10,15]

toJsonArrayIterator

CUF components od wersji 1.0.95Wszystkie komponenty

Generuje ciąg tekstowy JSON w postaci tablicy obiektów, która może odzwierciedlać zawartość tabeli dynamicznej, dzięki zastosowaniu iteracji.

Szczegółowy opis 

toJsonArrayIterator(function, maxTableLength, counter, type) : string

Wynik:

Ciąg tekstowy JSON z możliwością reprezentowania tablicy obiektów.

 

Funkcje TableStore - szczegółowy opis funkcji TableStore 

 

 


trim(text) : string

text : string

...