Payroll Actions
Regulator|Payroll Actions
Generated from PayrollEngine.Client.Scripting — do not edit manually.
Case
| Action |
Description |
Cat. |
Parameters |
GetFieldValue |
Get case field value |
Case |
field String — The case field name |
HasFieldValue |
Test for case field value |
Case |
field String — The case field name |
Date
| Action |
Description |
Cat. |
Parameters |
Age |
Get persons age |
Date |
birthDate Date — The persons birth date
testDate Date — Reference date (default: utc-now) |
GetTimeSpan |
Get the timespan between two dates |
Date |
start Date — The start date
end Date — The end date |
SameDay |
Test for same date day |
Date |
left Date — The left date to compare
right Date — The right date to compare |
SameMonth |
Test for same date month |
Date |
left Date — The left date to compare
right Date — The right date to compare |
SameYear |
Test for same date year |
Date |
left Date — The left date to compare
right Date — The right date to compare |
YearDiff |
Get years between two dates |
Date |
start Date — The start date
end Date — The end date |
Lookup
| Action |
Description |
Cat. |
Parameters |
ApplyRangeLookupValue |
Apply a range value to the lookup ranges considering the lookup range mode |
Lookup |
lookup String — The lookup name
range Dec — The range value
field — The JSON value field name (optional) |
GetLookupValue |
Get lookup value by key and value field name |
Lookup |
lookup String — The lookup name
key — The lookup key
rangeValue — The lookup key or range value
field — The JSON value field name (optional) |
GetLookupValue |
Get lookup value by key or range value |
Lookup |
lookup String — The lookup name
keyOrRangeValue — The lookup key or range value
field — The JSON value field name (optional) |
HasLookupValue |
Test for lookup value by key |
Lookup |
lookup String — The lookup name
keyOrRangeValue — The lookup key or range value
field — The JSON value field name (optional) |
HasLookupValue |
Test for lookup value by key and range value |
Lookup |
lookup String — The lookup name
key String — The lookup key
rangeValue Num — The range value
field String — The JSON value field name (optional) |
Math
| Action |
Description |
Cat. |
Parameters |
Max |
Get the maximum value |
Math |
left Num Date TimeSpan — The left compare value
right Num Date TimeSpan — The right compare value |
Max |
Get the largest collection value |
Math |
values Num Date TimeSpan — Value collection |
Min |
Get the smallest collection value |
Math |
values Num Date TimeSpan — Value collection |
Min |
Get the minimum value |
Math |
left Num Date TimeSpan — The left compare value
right Num Date TimeSpan — The right compare value |
Range |
Ensure value is within a value range |
Math |
value Num Date TimeSpan — The value to limit
min Num Date TimeSpan — The minimum value
max Num Date TimeSpan — The maximum value |
Within |
Test value is within a value range |
Math |
value Num Date TimeSpan — The value to test
min Num Date TimeSpan — The minimum value
max Num Date TimeSpan — The maximum value |
String
| Action |
Description |
Cat. |
Parameters |
Concat |
Concat multiple strings |
String |
values String — Value collection |
Contains |
Test if value is from a specific value domain |
String |
source — The value to test
values Num Date String — Value collection |
System
| Action |
Description |
Cat. |
Parameters |
IfNull |
Returns the second value in case the first value is null |
System |
first — Value to return if defined
second — Value to return if first value is undefined |
IIf |
Returns one of two parts, depending on the evaluation of an expression |
System |
expression — Expression to evaluate
onTrue — Value or expression returned if expr is True
onFalse — Value or expression returned if expr is False |
IsNotNull |
Returns true whether the value is not Null |
System |
value — Value to test |
IsNull |
Returns true whether the value is Null |
System |
value — Value to test |
Log |
Log a message |
System |
message — Message to log
level — Log level (default: Information) |
SetNamespace |
Set namespace to a name |
System |
name — Name to be extended
namespace — Namespace to apply (default: regulation namespace) |