Versions Compared

Key

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


Page properties
hiddentrue



Status
Tech review

Status
titletodo

Style guide

Status
titletodo

Status
titletodo
Status
colourYellow
titleReady for review
Status
colourGreen
titledone
Status
colourRed
titleflagged



Page properties
hiddentrue


Short description

Returns any given date in text form

Output

Status
subtletrue
titletext




UI Text Box
sizemedium
typeinfo

Returns any given date in text form


UI Text Box
typetip

This function is useful in the Update Field Action to represent as a text the result of a time expression.


Code Block
languagebash
titleSyntax
linenumberstrue
dateTimeToString(timestamp, timeZone, language) #Output: Text


UI Expand
titleExamples



UI Expand
titleAdditional information

Parameters used in this function

ParameterInput (data type)Description
timestamp

Status
subtletrue
titlenumber

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

Status
subtletrue
titletimezone

The time zone used for the translation. 

language

Status
subtletrue
titleLanguage

Parameter description.



UI Expand
titleOutput

The function returns a

Status
subtletrue
titletext




UI Text Box
sizemedium
typeinfo

The function returns a

Status
subtletrue
titletext
representing the date-time value at t with a certain custom format defined by date_time_pattern text parameter, using a certain language for months, days of the week, etc.


Code Block
languagebash
titleSyntax
linenumberstrue
 dateTimeToString(number t, string date_time_pattern , language) #Output: Text


UI Expand
titleExample


Parser expressionDescription


Code Block
languagebash
linenumberstrue
dateTimeToString(2011-03-25 11:30, "yyyy.MM.dd 'at' HH:mm:ss", USER_LANG)


The function will return a

Status
subtletrue
titletext
: "2011.03.25 at 11:30:00"




UI Expand
titleAdditional information

Parameters used in this function

ParameterInput (data type)Description
timestamp

Status
subtletrue
titlenumber

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

Status
subtletrue
titledata type

Parameter description.

<parameter>

Status
subtletrue
titledata type

Parameter description.


UI Text Box
typetip

Work days might depend on the time zone - it might be Sunday on the west coast of the US while at the same time it's already Monday in Australia. 



UI Expand
titleOutput

The function returns a

Status
subtletrue
titletext




UI Text Box
sizemedium
typeinfo

The function returns a

Status
subtletrue
titletext
representing the date-time value at t with a certain custom format defined by date_time_pattern text parameter, in a certain time_zone using a certain language for months, days of the week, etc.


Code Block
languagebash
titleSyntax
linenumberstrue
 dateTimeToString(number t, string date_time_pattern , timeZone time_zone, language) #Output: Text


UI Expand
titleExamples


Parser expressionDescription


Code Block
languagebash
linenumberstrue
dateTimeToString(0, "yyyy.MM.dd 'at' HH:mm:ss", GMT, USER_LANG)


The function will return a

Status
subtletrue
titletext
: "1970.01.01 at 00:00:00"


Code Block
languagebash
linenumberstrue
dateTimeToString(0, "yyyy.MM.dd 'at' HH:mm:ss", MST, USER_LANG)


The function will return a

Status
subtletrue
titletext
: "1969.12.31 at 17:00:00"



UI Expand
titleAdditional information

Parameters used in this function

ParameterInput (data type)Description
timestamp

Status
subtletrue
titlenumber

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

Status
subtletrue
titledata type

Parameter description.
timeZone

Status
subtletrue
titletimezone

The time zone used for the calculation. 

Expand
titleLearn more about timezones

Excerpt Include
Dates, times and time zones
Dates, times and time zones
nopaneltrue


<parameter>

Status
subtletrue
titledata type

Parameter description.


UI Text Box
typetip

Work days might depend on the time zone - it might be Sunday on the west coast of the US while at the same time it's already Monday in Australia. 



UI Expand
titleOutput

The function returns a

Status
subtletrue
titletext