ShiftEnd()

Format

ShiftEnd(Time [,Site] [,ShiftPattern])

Returns

Returns the time of the end of the shift occurring on or before the provided Time.

The site and shift patterns are optional inputs.  If these parameters are not specified, then the Default Site and the Default Shift Pattern of that site will be used. 

Inputs

Time: The time from which to calculate the end of the shift.
Behaviour: Required
Dimension: Collection, SingleValue, MultiCollection
Valid data types: DateTime, Decimal, Integer, String

Note: You can use the Time() function to use a valid DateTime argument.

Site: Name of the site which contains the shift pattern to use. If this parameter is null or empty string, the default site will be used.
Behaviour: Optional
Dimensions: SingleValue
Valid data types: Null, String

ShiftPattern: Name of the shift pattern to use. If this parameter is null or empty string, the default shift pattern will be used.
Behaviour: Optional
Dimensions: SingleValue
Valid data types: Null, String

How to format data types

Examples

Expression: ShiftEnd(Time())
Result: Returns the end time of the shift occurring on or before the provided Time using the default shift pattern of the default site.

Expression: ShiftEnd(Time(), 'Perth', 'Operations')
Result: Returns the end time of the shift occurring on or before the provided Time using the 'Operations' shift pattern of the 'Perth' site.

Expression: ShiftEnd(Time(), null, 'Operations')
Result: Returns the end time of the shift occurring on or before the provided Time using the 'Operations' shift pattern of the default site.

Release History

• ShiftEnd() 4.10.2
  • Added optional parameters to specify a site and shift pattern to be used in the calculation.
• ShiftEnd() 4.6.5
  • Changed Time parameter to support MultiCollection values.
• ShiftEnd() 4.0
  • Initial version