LocalYear
Returns the value for the year for the local date.
The LocalYear function does not consider parameter when used in picklist.
Syntax
LocalYear(utcDateTime, 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 |
---|---|
utcDateTime | (Optional) The DateTime value for which to find the year. |
timeZone |
(Optional) The time zone, in IANA format. If you do not specify a time zone, the application uses the time zone associated with the current session. |
Return Value
Four digit number, between 1970 and 2099.
Example
$(LocalYear())
If today is Wednesday April 10, 2014 at 13:45:26 in the current time zone, this function returns 2014.
$(LocalYear(CreatedDateTime))
Returns the year in the current time zone when the incident was created.
$(LocalYear(CreatedDateTime, "Antarctica/South_Pole"))
Returns the year of the day in the Antarctica time zone when the incident was created.