WorkflowCalendar data type

Official Content
This documentation is valid for:

Provides methods for working with calendars.

Properties

Property Type Access Description
Id Numeric Read Internal calendar’s identifier
Name Character Read Calendar’s name
Description Character Read Calendar’s description

Methods

IsHoliday

Evaluates if a date corresponds to a holiday according to the calendar.

IsHoliday (date): Boolean

Name Type Movement Description
date Date Input Date to be evaluated

 

IsWeekend

Evaluates if a date corresponds to a weekend according to the calendar.

IsWeekend (date): Boolean

Name Type Movement Description
date Date Input Date to be evaluated

 

IsWorkday

Evaluates if a date corresponds to a working day according to the calendar.

IsWorkDay (date): Boolean

Name Type Movement Description
date Date Input Date to be evaluated

 

FirstWorkdayInMonth

Returns the date of the first working day for a sepcified month and year according to the calendar.

FirstWorkdayInMonth (month, year): Date

Name Type Movement Description
month Numeric Input Month
year Numeric Input Year

 

LastWorkdayInMonth

Returns the date of the last working day for a sepcified month and year according to the calendar.

LastWorkdayInMonth (month, year): Date

Name Type Movement Description
month Numeric Input Month
year Numeric Input Year

 

NextWorkday

Returns the date of the next working day from a given start date according to the calendar.

NextWorkday (startDate): Date

Name Type Movement Description
startDate Date Input Initial date

 

Workday

Returns the date resulting from adding a number of working days to a given initial date.

Workday (startDate, days): Date

Name Type Movement Description
startDate Date Input Initial date
days Numeric Input Amount of working days

 

Worktime

It returns the date and time resulting from adding a number of working seconds to a given initial date and time.

Worktime (startTime, seconds): DateTime

Name Type Movement Description
startTime DateTime Input Initial Date time
seconds Numeric Input Amount of working seconds

 

WorkdayDuration

Return the duration, in working seconds, of a given date according to the calendar.

WorkdayDuration (date): Numeric

Name Type Movement Description
date Date Input Date of the journal day

 

WorkdaysBetweenDates

Returns work days between two dates.

WorkdaysBetweenDates (startDate, endDate): Numeric

Name Type Movement Description
startDate
 
Date Input Initial date range
endDate
 
Date
 
Input Final date range
 

 

Load

Allows to load a calendar from the identifier.

Load (calendarId)

Name Type Movement Description
Id Numeric Input Calendar Id

 

LoadByName

Allows to load a calendar from the name.

LoadByName (name)

Name Type Movement Description
name Character Input Calendar name

See also

Workflow Error Codes



Was this page helpful?
What Is This?
Your feedback about this content is important. Let us know what you think.