ToClientTime
This function will be deprecated in a future release, so use it with caution.
However, it is still supported for existing expressions, so it has not been removed from the application. Editing an expression using this function can cause an error message to appear.
Instead of this function, use ToLocal.
Converts a DateTime value from UTC time to the local time of the logged-in user. If you execute this function without the optional time parameter, returns the current local time associated with the current session.
Syntax
ToClientTime(time)
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 | Yes1 |
| Business Rules: Initialization Rules | Yes |
| Business Rules: Read Only Rules | No |
| Business Rules: Required Rules | Yes1 |
| Business Rules: Validation Rules | Yes |
| Client Expressions | No |
| Object Permissions | No |
| Services | Yes |
| LDAP | Yes |
| Mobile | Yes |
| Quick Actions (except UI Quick Actions) | Yes |
| UI Quick Actions | No |
| Reports | Yes |
| Search/Dashboard without field references | Yes |
| Search/Dashboard with field references | No |
| 1. Except when this field appears on a form or is triggered by such a field. |
Parameters
|
time |
(Optional) A UTC time to convert to local time. The default is the current time. |
Return Value
DateTime value.
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 Service Manager.
Example
$(ToClientTime(CurrentDateTime()))
The above example returns the current local time.
$(ToClientTime(HOPCalcTargetDate("Weekly HOP", CurrentDateTime(), ((12 * 60) * 60))))
If $(HOPCalcTargetDate("Weekly HOP", CurrentDateTime(), ((12 * 60) * 60))) returns 10/15/2014 8:22:03 PM and your time zone is UTC-7, this returns 10/15/2014 1:22:03 PM.