BeginningOfMonth
Returns the UTC date and time for the beginning of the local month based on the local date and time of the current session.
Syntax
BeginningOfMonth(numMonths, baseDateTime, timeZone)
Enabled For
For a description of the business object categories, see Notes on "Enabled For".
Business Object Category | Yes/No |
---|---|
Business Rules: Before-Save Rules | Yes |
Business Rules: Calculation Rules (After Save, with or without Also Recalculate on Load) | Yes |
Business Rules: Calculation Rules (Before Save or Always, without Also Recalculate On Load) | Yes |
Business Rules: Calculation Rules (Before Save or Always, with Recalculate On Load) | Yes |
Business Rules: Editing Rules | Yes |
Business Rules: Initialization Rules | Yes |
Business Rules: Read Only Rules | Yes |
Business Rules: Required Rules | Yes |
Business Rules: Validation Rules | Yes |
Client Expressions | Yes |
Object Permissions | Yes |
Services | Yes |
LDAP | Yes |
Mobile | Yes |
Quick Actions (except UI Quick Actions) | Yes |
UI Quick Actions | Yes |
Reports | Yes |
Search/Dashboard without field references | Yes |
Search/Dashboard with field references | Yes |
Parameters
Parameter | Description |
---|---|
numMonths |
(Optional) The number of intervals. If not specified, uses the default interval which is 0. Can be either a positive integer, to indicate months in the future, or a negative integer, to indicate months in the past. |
baseDateTime | (Optional) The base date for the function. If not specified, uses the default date which is the current date and time. |
timeZone |
(Optional) The time zone, in IANA format. |
Return Value
DateTime value in UTC time.
•If the application has to display the return value, it implicitly converts it to text, thereby allowing the display format to change depending on your culture code. See Available Languages and Cultures for a list of the culture codes used by Neurons for ITSM.
•In this release of Neurons for ITSM, there is a known issue, where if the time zone offset between the current date and time and the DateTime value returned by the function is different, the return value is off by one hour. This happens when the current date is before daylight savings time and the DateTime value that is returned is after daylight savings time, or vice versa.
Example
$(BeginningOfMonth(0))
If today is August 10, 2014 and your time zone is Pacific time (which is UTC-7 during daylight savings time and UTC-8 during standard time), this function returns August 1, 2014 at 07:00:00 AM UTC time.