Page History

Versions Compared

Old Version 11

changes.mady.by.user Iheb Kharab

Saved on Jan 06, 2022

compared with

New Version Current

changes.mady.by.user Iheb Kharab

Saved on Jan 06, 2022

Key

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

UI Text Box

size	medium
type	info

This function checks whether, a given timestamp (e.g. the due date of an issue) falls into a time frame defined in a JWT calendar specification.

Code Block

language	bash
title	Syntax
linenumbers	true

withinCalendar(timestamp, calendarName, timeZone) #Output: Boolean

UI Expand

title	Examples

Include Page

	DECADIS:_snip_my_schedule_calendar
	DECADIS:_snip_my_schedule_calendar

Parser expression Description

Code Block

language	bash
linenumbers	true

withinCalendar(2020/12/01 8:00, "my_calendar", LOCAL)

This example returns:

true

UI Text Box

type	info

December 1st of 2020 is a Tuesday.

Code Block

language	bash
linenumbers	true

withinCalendar(2020/12/01 17:00, "my_calendar", LOCAL)

This example returns:

false

UI Text Box

type	info

December 1st of 2020 is a Tuesday.

UI Expand

title	Additional information

Parameters used in this function

Parameter Input (data type) Description

timestamp

Status

subtle	true
title	number

The parameter must be valid timestamp. Usually this value is retrieved from a field (e.g. due date, created date).

calendarName

Status

subtle	true
title	text

The name of the used JWT calendar.

timeZone

Status

subtle	true
title	timezone

The time zone used for the calculation.

UI Expand

title	Output

This function returns a

Status


subtle	true
title	boolean

UI Text Box

size	medium
type	info

Variant of the function where you can define an additional JWT calendar specification.

Code Block

language	bash
title	Syntax
linenumbers	true

withinCalendar(timestamp, calendarName, additionalSpecifier, timeZone) #Output: Boolean

UI Expand

title	Examples

Include Page

	DECADIS:_snip_my_schedule_calendar
	DECADIS:_snip_my_schedule_calendar

Parser expression Description

Code Block

language	bash
linenumbers	true

withinCalendar(2020/12/04 9:00, "my_calendar", "2020/12/04 {;}", LOCAL)

This example returns:

false

UI Text Box

type	info

The additional specifier {;} excludes December 4th from the calendar.

UI Expand

title	Additional information

Parameters used in this function:

Parameter Input(data type) Description

timestamp

Status


subtle	true
title	number

The parameter must be valid timestamp. Usually this value is retrieved from a field (e.g. due date, created date).

calendarName

Status

subtle	true
title	text

The name of the used JWT calendar.

additionalSpecifier

Status

subtle	true
title	text

A text containing an additional JWT calendar specification.

timeZone

Status

subtle	true
title	timezone

The time zone used for the calculation.

UI Expand

title	Output

This function returns a

Status


subtle	true
title	boolean

UI Text Box

type	tip

This function is usually used in a validators or the conditional execution parameter of post functions.

Use cases and examples

Page properties report

firstcolumn	Use case
headings	JWT feature, Workflow function, Field type, Automated action, Parser functions
cql	label = "parser_func_withincalendar" and space = currentSpace()

Page properties

hidden	true
id	1

Parser function cloud
Map
Notes	Not possible because JWT's Calendars are not implemented in the Cloud version.

Page properties

hidden	true

Status

Tech review

Status

colour	Green
title	done

Style guide

Status

colour	Green
title	done

Status

title	todo

Status

colour	Yellow
title	Ready for review

Status

colour	Green
title	done

Status

colour	Red
title	flagged

Page properties

hidden	true

Short description

Checks whether a timestamp falls into a time frame defined in a JWT calendar specification.

Output

Status


subtle	true
title	boolean

Available since

Status


subtle	true
colour	Red
title	needs lookup

Label

Status


colour	Red
title	staff pick

Content

Space Tools

Versions Compared

Old Version 11

New Version Current

Key

Parameters used in this function

Parameters used in this function:

Use cases and examples