809 lines (717 loc) · 26.2 KB

PayrollEngine.Client.Scripting Actions

Assembly PayrollEngine.Client.Scripting, Version=0.9.0.0, Culture=neutral, PublicKeyToken=null

Date 2/18/2026 5:55 PM

Age


Description	Get persons age
Function type	`Payroll`
Categories	`Date`
Parameters	`birthDate` The persons birth date [`Date`] `testDate` Reference date (default: utc-now) [`Date`]

ApplyRangeLookupValue


Description	Apply a range value to the lookup ranges considering the lookup range mode
Function type	`Payroll`
Categories	`Lookup`
Parameters	`lookup` The lookup name [`String`] `range` The range value [`Dec`] `field` The JSON value field name (optional)

Concat


Description	Concat multiple strings
Function type	`Payroll`
Categories	`String`
Parameters	`values` Value collection [`String`]

Contains


Description	Test if value is from a specific value domain
Function type	`Payroll`
Categories	`String`
Parameters	`values` Value collection [`Num`, `Date`, `String`]

GetCollectorValue


Description	Get collector value
Function type	`WageType`
Categories	`WageType`
Parameters	`name` The collector name [`String`]

GetCycleCollectorValue


Description	Get collector year-to-date value
Function type	`Payrun`
Categories	`Collector`
Parameters	`name` The collector name [`String`]

GetCycleWageTypeValue


Description	Get wage type year-to-date value by wage type name
Function type	`Payrun`
Categories	`WageType`
Parameters	`name` The wage type name [`String`]

GetCycleWageTypeValue


Description	Get wage type year-to-date value by wage type number
Function type	`Payrun`
Categories	`WageType`
Parameters	`number` The wage type number [`Dec`]

GetFieldValue


Description	Get case field value
Function type	`Payroll`
Categories	`Case`
Parameters	`field` The case field name [`String`]

GetLookupValue


Description	Get lookup value by key and value field name
Function type	`Payroll`
Categories	`Lookup`
Parameters	`lookup` The lookup name [`String`] `key` The lookup key `rangeValue` The lookup key or range value `field` The JSON value field name (optional)

GetLookupValue


Description	Get lookup value by key or range value
Function type	`Payroll`
Categories	`Lookup`
Parameters	`lookup` The lookup name [`String`] `keyOrRangeValue` The lookup key or range value `field` The JSON value field name (optional)

GetPayrunResultValue


Description	Get payrun result value
Function type	`Payrun`
Categories	`Payrun`
Parameters	`name` The result name [`String`]

GetRuntimeValue


Description	Get payrun runtime value
Function type	`Payrun`
Categories	`Runtime`
Parameters	`key` The value key [`String`]

GetSourceFieldEnd


Description	Get the case relation source field end date
Function type	`CaseRelationBuild`
Categories	`RelationField`
Parameters	`field` The case field on the target case [`String`]

GetSourceFieldStart


Description	Get the case relation source field start date
Function type	`CaseRelationBuild`
Categories	`RelationField`
Parameters	`field` The case field on the target case [`String`]

GetSourceFieldValue


Description	Det the case relation source field value
Function type	`CaseRelationBuild`
Categories	`RelationField`
Parameters	`field` The case field on the source case [`String`]

GetTargetFieldEnd


Description	Get the case relation target field end date
Function type	`CaseRelationBuild`
Categories	`RelationField`
Parameters	`field` The case field on the target case [`String`]

GetTargetFieldStart


Description	Get the case relation target field start date
Function type	`CaseRelationBuild`
Categories	`RelationField`
Parameters	`field` The case field on the target case [`String`]

GetTargetFieldValue


Description	Get the case relation target field value
Function type	`CaseRelationBuild`
Categories	`RelationField`
Parameters	`field` The case field on the target case [`String`]

GetTimeSpan


Description	Get the timespan between two dates
Function type	`Payroll`
Categories	`Date`
Parameters	`start` The start date [`Date`] `end` The end date [`Date`]

GetWageTypeValueByName


Description	Get wage type value by name
Function type	`WageType`
Categories	`WageType`
Parameters	`name` The wage type name [`String`]

GetWageTypeValueByNumber


Description	Get wage type value
Function type	`WageType`
Categories	`WageType`
Parameters	`number` Get wage type value by number [`Dec`]

HasFieldValue


Description	Test for case field value
Function type	`Payroll`
Categories	`Case`
Parameters	`field` The case field name [`String`]

HasLookupValue


Description	Test for lookup value by key and range value
Function type	`Payroll`
Categories	`Lookup`
Parameters	`lookup` The lookup name [`String`] `key` The lookup key [`String`] `field` The JSON value field name (optional)

HasLookupValue


Description	Test for lookup value by key
Function type	`Payroll`
Categories	`Lookup`
Parameters	`lookup` The lookup name [`String`] `keyOrRangeValue` The lookup key or range value `field` The JSON value field name (optional)

HiddenField


Description	Hide all field inputs
Function type	`CaseChange`
Categories	`FieldInput`, `Field`
Parameters	`field` The target field [`String`]

IIf


Description	Returns one of two parts, depending on the evaluation of an expression
Function type	`Payroll`
Categories	`System`
Parameters	`expression` Expression to evaluate `onTrue` Value or expression returned if expr is True `onFalse` Value or expression returned if expr is False

IfNull


Description	Returns the second value in case the first value is null
Function type	`Payroll`
Categories	`System`
Parameters	`first` Value to return if defined `second` Value to return if first value is undefined

IsNotNull


Description	Returns true whether the value is not Null
Function type	`Payroll`
Categories	`System`
Parameters	`value` Value to test

IsNull


Description	Returns true whether the value is Null
Function type	`Payroll`
Categories	`System`
Parameters	`value` Value to test

Log


Description	Log a message
Function type	`Payroll`
Categories	`System`
Parameters	`message` Message to log `level` Log level (default: Information)

Max


Description	Get the maximum value
Function type	`Payroll`
Categories	`Math`
Parameters	`left` The left compare value [`Num`, `Date`, `TimeSpan`] `right` The right compare value [`Num`, `Date`, `TimeSpan`]

Max


Description	Get the largest collection value
Function type	`Payroll`
Categories	`Math`
Parameters	`values` Value collection [`Num`, `Date`, `TimeSpan`]

Min


Description	Get the minimum value
Function type	`Payroll`
Categories	`Math`
Parameters	`left` The left compare value [`Num`, `Date`, `TimeSpan`] `right` The right compare value [`Num`, `Date`, `TimeSpan`]

Min


Description	Get the smallest collection value
Function type	`Payroll`
Categories	`Math`
Parameters	`values` Value collection [`Num`, `Date`, `TimeSpan`]

Range


Description	Ensure value is within a value range
Function type	`Payroll`
Categories	`Math`
Parameters	`value` The value to limit [`Num`, `Date`, `TimeSpan`] `min` The minimum value [`Num`, `Date`, `TimeSpan`] `max` The maximum value [`Num`, `Date`, `TimeSpan`]

RemoveRuntimeValue


Description	Remove payrun runtime value
Function type	`Payrun`
Categories	`Runtime`
Parameters	`key` The value key [`String`]

SameDay


Description	Test for same date day
Function type	`Payroll`
Categories	`Date`
Parameters	`left` The left date to compare [`Date`] `right` The right date to compare [`Date`]

SameMonth


Description	Test for same date month
Function type	`Payroll`
Categories	`Date`
Parameters	`left` The left date to compare [`Date`] `right` The right date to compare [`Date`]

SameYear


Description	Test for same date year
Function type	`Payroll`
Categories	`Date`
Parameters	`left` The left date to compare [`Date`] `right` The right date to compare [`Date`]

SetFieldAttachmentExtensions


Description	Set field attachments file extensions
Function type	`CaseChange`
Categories	`FieldInput`, `Field`
Parameters	`field` The target field [`String`] `extensions` The file extensions [`String`]

SetFieldAttachmentMandatory


Description	Set field mandatory file attachments
Function type	`CaseChange`
Categories	`FieldInput`, `Field`
Parameters	`field` The target field [`String`]

SetFieldAttachmentNone


Description	Set field without file attachments
Function type	`CaseChange`
Categories	`FieldInput`, `Field`
Parameters	`field` The target field [`String`]

SetFieldAttachmentOptional


Description	Set field optional file attachments
Function type	`CaseChange`
Categories	`FieldInput`, `Field`
Parameters	`field` The target field [`String`]

SetFieldCheck


Description	Set field boolean as checkbox
Function type	`CaseChange`
Categories	`FieldInput`, `FieldValue`
Parameters	`field` The target field [`String`]

SetFieldCulture


Description	Set field value culture
Function type	`CaseChange`
Categories	`FieldInput`, `FieldValue`
Parameters	`field` The target field [`String`] `culture` The culture (https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-lcid/a9eac961-e77d-41a6-90a5-ce1a8b0cdb9c) [`String`]

SetFieldEndFormat


Description	Set field end format
Function type	`CaseChange`
Categories	`FieldInput`, `FieldEnd`
Parameters	`field` The target field [`String`] `format` The format (https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings) [`String`]

SetFieldEndHelp


Description	Set field end help
Function type	`CaseChange`
Categories	`FieldInput`, `FieldEnd`
Parameters	`field` The target field [`String`] `help` The field end help [`String`]

SetFieldEndLabel


Description	Set field end label
Function type	`CaseChange`
Categories	`FieldInput`, `FieldEnd`
Parameters	`field` The target field [`String`] `label` The field end label [`String`]

SetFieldEndPickerOpenDay


Description	Set field end day date picker
Function type	`CaseChange`
Categories	`FieldInput`, `FieldEnd`
Parameters	`field` The target field [`String`]

SetFieldEndPickerOpenMonth


Description	Set field end month date picker
Function type	`CaseChange`
Categories	`FieldInput`, `FieldEnd`
Parameters	`field` The target field [`String`]

SetFieldEndPickerOpenYear


Description	Set field end year date picker
Function type	`CaseChange`
Categories	`FieldInput`, `FieldEnd`
Parameters	`field` The target field [`String`]

SetFieldEndPickerTypeDateTime


Description	Set field end time picker
Function type	`CaseChange`
Categories	`FieldInput`, `FieldEnd`
Parameters	`field` The target field [`String`]

SetFieldEndReadOnly


Description	Set field end read only
Function type	`CaseChange`
Categories	`FieldInput`, `FieldEnd`
Parameters	`field` The target field [`String`]

SetFieldEndRequired


Description	Set field end required
Function type	`CaseChange`
Categories	`FieldInput`, `FieldEnd`
Parameters	`field` The target field [`String`]

SetFieldFormat


Description	Set field value format
Function type	`CaseChange`
Categories	`FieldInput`, `FieldValue`
Parameters	`field` The target field [`String`] `format` The value format (https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings) [`String`]

SetFieldLineCount


Description	Set field text line count
Function type	`CaseChange`
Categories	`FieldInput`, `FieldValue`
Parameters	`field` The target field [`String`] `count` The line count [`Int`]

SetFieldMaxLength


Description	Set field maximum text length
Function type	`CaseChange`
Categories	`FieldInput`, `FieldValue`
Parameters	`field` The target field [`String`] `length` The length [`Int`]

SetFieldMaxValue


Description	Set field maximum value
Function type	`CaseChange`
Categories	`FieldInput`, `FieldValue`
Parameters	`field` The target field [`Num`] `max` The maximum value

SetFieldMinValue


Description	Set field minimum value
Function type	`CaseChange`
Categories	`FieldInput`, `FieldValue`
Parameters	`field` The target field [`Num`] `min` The minimum value

SetFieldStartFormat


Description	Set field start format
Function type	`CaseChange`
Categories	`FieldInput`, `FieldStart`
Parameters	`field` The target field [`String`] `format` The format (https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings) [`String`]

SetFieldStartHelp


Description	Set field start help
Function type	`CaseChange`
Categories	`FieldInput`, `FieldStart`
Parameters	`field` The target field [`String`] `help` The field start help [`String`]

SetFieldStartLabel


Description	Set field start label
Function type	`CaseChange`
Categories	`FieldInput`, `FieldStart`
Parameters	`field` The target field [`String`] `label` The field start label [`String`]

SetFieldStartPickerOpenDay


Description	Set field start day date picker
Function type	`CaseChange`
Categories	`FieldInput`, `FieldStart`
Parameters	`field` The target field [`String`]

SetFieldStartPickerOpenMonth


Description	Set field start month date picker
Function type	`CaseChange`
Categories	`FieldInput`, `FieldStart`
Parameters	`field` The target field [`String`]

SetFieldStartPickerOpenYear


Description	Set field start year date picker
Function type	`CaseChange`
Categories	`FieldInput`, `FieldStart`
Parameters	`field` The target field [`String`]

SetFieldStartPickerTypeDateTime


Description	Set field start picker date time
Function type	`CaseChange`
Categories	`FieldInput`, `FieldStart`
Parameters	`field` The target field [`String`]

SetFieldStartReadOnly


Description	Set field start read only
Function type	`CaseChange`
Categories	`FieldInput`, `FieldStart`
Parameters	`field` The target field [`String`]

SetFieldStartRequired


Description	Set field start required
Function type	`CaseChange`
Categories	`FieldInput`, `FieldStart`
Parameters	`field` The target field [`String`]

SetFieldStepSize


Description	Set field numeric step size
Function type	`CaseChange`
Categories	`FieldInput`, `FieldValue`
Parameters	`field` The target field [`Int`] `size` The step size

SetFieldValueAdornment


Description	Set field value adornment
Function type	`CaseChange`
Categories	`FieldInput`, `FieldValue`
Parameters	`field` The target field [`String`] `adornment` The adornment text [`String`]

SetFieldValueHelp


Description	Set field value help
Function type	`CaseChange`
Categories	`FieldInput`, `FieldValue`
Parameters	`field` The target field [`String`] `help` The help text [`String`]

SetFieldValueLabel


Description	Set field value label
Function type	`CaseChange`
Categories	`FieldInput`, `FieldValue`
Parameters	`field` The target field [`String`] `label` The label text [`String`]

SetFieldValueMask


Description	Set field value mask
Function type	`CaseChange`
Categories	`FieldInput`, `FieldValue`
Parameters	`field` The target field [`String`] `mask` The value mask (https://learn.microsoft.com/en-us/dotnet/api/system.windows.forms.maskedtextbox.mask) [`String`]

SetFieldValuePickerOpenDay


Description	Set field value day date picker
Function type	`CaseChange`
Categories	`FieldInput`, `FieldValue`
Parameters	`field` The target field [`String`]

SetFieldValuePickerOpenMonth


Description	Set field value month date picker
Function type	`CaseChange`
Categories	`FieldInput`, `FieldValue`
Parameters	`field` The target field [`String`]

SetFieldValuePickerOpenYear


Description	Set field value year date picker
Function type	`CaseChange`
Categories	`FieldInput`, `FieldValue`
Parameters	`field` The target field [`String`]

SetFieldValueReadOnly


Description	Set field value read only
Function type	`CaseChange`
Categories	`FieldInput`, `FieldValue`
Parameters	`field` The target field [`String`]

SetFieldValueRequired


Description	Set field value required
Function type	`CaseChange`
Categories	`FieldInput`, `FieldValue`
Parameters	`field` The target field [`String`]

SetNamespace


Description	Set namespace to a name
Function type	`Payroll`
Categories	`System`
Parameters	`name` Name to be extended `namespace` Namespace to apply (default: regulation namespace)

SetPayrunResultValue


Description	Set payrun result value
Function type	`Payrun`
Categories	`Payrun`
Parameters	`name` The result name [`String`] `value` The value to set `type` The value type (default: Money), [StringType]

SetRuntimeValue


Description	Set payrun runtime value
Function type	`Payrun`
Categories	`Runtime`
Parameters	`key` The value key [`String`] `value` The value to set

SetTargetFieldEnd


Description	Set the case relation target field change end date
Function type	`CaseRelationBuild`
Categories	`RelationField`
Parameters	`field` The case field on the target case [`String`] `end` The end date to set [`Date`]

SetTargetFieldStart


Description	Set the case relation target field change start date
Function type	`CaseRelationBuild`
Categories	`RelationField`
Parameters	`field` The case field on the target case [`String`] `start` The start date to set [`Date`]

SetTargetFieldValue


Description	Set the case relation target field value
Function type	`CaseRelationBuild`
Categories	`RelationField`
Parameters	`field` The case field on the target case [`String`] `value` The value to set

ShowFieldDescription


Description	Show field description
Function type	`CaseChange`
Categories	`FieldInput`, `Field`
Parameters	`field` The target field [`String`]

VisibleField


Description	Show all field inputs
Function type	`CaseChange`
Categories	`FieldInput`, `Field`
Parameters	`field` The target field [`String`]

Within


Description	Test value is within a value range
Function type	`Payroll`
Categories	`Math`
Parameters	`value` The value to test [`Num`, `Date`, `TimeSpan`] `min` The minimum value [`Num`, `Date`, `TimeSpan`] `max` The maximum value [`Num`, `Date`, `TimeSpan`]

YearDiff


Description	Test for same date year
Function type	`Payroll`
Categories	`Date`
Parameters	`start` The start date [`Date`] `end` The end date [`Date`]