The Event Template tab on the Ad Hoc Templates form is used to add a Meal or Break event to an Ad Hoc Template. You can also define events that may not be used, such as when an employee is not allowed to take a break or a meal.
If the Meal or Break is configured to post automatically, the automatic event posting is triggered when the employee posts an event after the time of the scheduled automatic event. For example, if the automatic lunch is from 12:00 p.m. to 12:30 p.m., when the employee stops labor at 12:05 p.m., the automatic lunch will post. If you want to allow a punched meal or break to override an automatic one, see Meal/Break Override for the configurations needed. If you want to allow a punched meal or break to override an automatic one, see "Meal/Break Override" in your help file for the configurations needed.
See Also:
Event Template Field Descriptions
Modify or Delete an Event Template
Template ID
This is the unique identifier of the record.
Event
Select an event from the following available options:
ATTENDANCE:MEAL: Select this option for meal breaks such as lunch.
ATTENDANCE:BREAK: Select this option for any other kind of break within the schedule.
Posting Basis
Select from the following options to determines when the Event posts:
STRICT: The Event has a specific start and stop time, regardless when the person clocks in or out. The start and stop times are defined in the Start Day, Start Time, End Day, and End Time fields.
OFFSET: The Event posts for a specified number of hours after the raw timestamp of the most recent clock in, based on the Start Hours Offset and End Hours Offset. For example, the employee's schedule is 7 a.m. to 3:30 p.m. with an automatic half-hour lunch. The Posting Basis for the lunch is OFFSET, Start Hours Offset is 4, and End Hours Offset is 4.5. The employee clocks in at 6:45 a.m., which rounds to 7 a.m. based on his Rounding Policy. The OFFSET for the lunch event is based on the raw clock-in time, which is 6:45 a.m. Therefore the lunch posts from 10:45 a.m. to 11:15 a.m.
Start Day, End Day
Start Timestamp, End Timestamp
When you add or modify an Event Template, and the Posting Basis is STRICT, the Start Day, End Day, Start Timestamp, and End Time fields will display. These four fields are used to define the date and time when the Event can post.
Start Day and End Day can be set to TODAY, YESTERDAY, or TOMORROW. For example, a schedule is from 10 PM Today to 7 AM Tomorrow. An automatic meal event is scheduled to post from 2 AM to 3 AM; both the Start Day and End Day are set to TOMORROW.
Start Time, End Time
These columns display in the grid section on the Event Template form. If the Posting Basis is STRICT, these fields show the date and time when the Event can start and end. The Start Time and End Time are defined by the Start Day, End Day, Start Timestamp, and End Timestamp fields when you add or modify an Event Template.
Start Hours Offset, End Hours Offset
When the Posting Basis is OFFSET, these fields define the number of hours after the raw timestamp of the most recent clock in when the Event will start and end. For example, the Meal event has a Start Hours Offset of 4 and an End Hours Offset of 5. If the employee's raw clock-in time is 8 a.m., the Meal event will be posted from 12 p.m. to 1 p.m.
Start Early Margin
Number of minutes before the Meal or Break start that a person can leave for the Meal or Break without receiving a violation notice. Margins are only used when Auto Event is set to PUNCH or OVERRIDE.
You can enter a value in minutes, seconds, or hours (based on the Unit setting - see below) but the Event Template tab will always display in minutes.
When you modify a Margin value, the form will use the largest possible Unit (Hours, Minutes, Seconds) for which all the values can be expressed as integers. For example, you enter 120 Seconds for a Margin value and click Save. The Event Template tab will display the value as 2 Minutes. When you modify the record, it will also display as 2 minutes. If you enter 90 seconds for a Margin value and click Save, the Event Template tab will display the value as 1.5 minutes but when you modify the record it will display as 90 Seconds.
Start Late Margin
Number of minutes after the Meal or Break start that a person can leave for the Meal or Break without receiving a violation notice. Margins are only used when Auto Event is set to PUNCH or OVERRIDE.
You can enter a value in minutes, seconds, or hours (based on the Unit setting - see below) but the Event Template tab will always display in minutes.
When you modify a Margin value, the form will use the largest possible Unit (Hours, Minutes, Seconds) for which all the values can be expressed as integers. For example, you enter 120 Seconds for a Margin value and click Save. The Event Template tab will display the value as 2 Minutes. When you modify the record, it will also display as 2 minutes. If you enter 90 seconds for a Margin value and click Save, the Event Template tab will display the value as 1.5 minutes but when you modify the record it will display as 90 Seconds.
End Early Margin
Number of minutes before the Meal or Break end that a person can return from the Meal or Break without receiving a violation notice. Margins are only used when Auto Event is set to PUNCH or OVERRIDE.
You can enter a value in minutes, seconds, or hours (based on the Unit setting - see below) but the Event Template tab will always display in minutes.
When you modify a Margin value, the form will use the largest possible Unit (Hours, Minutes, Seconds) for which all the values can be expressed as integers. For example, you enter 120 Seconds for a Margin value and click Save. The Event Template tab will display the value as 2 Minutes. When you modify the record, it will also display as 2 minutes. If you enter 90 seconds for a Margin value and click Save, the Event Template tab will display the value as 1.5 minutes but when you modify the record it will display as 90 Seconds.
End Late Margin
Number of minutes after the Meal or Break end that a person can return from the Meal or Break without receiving a violation notice. Margins are only used when Auto Event is set to PUNCH or OVERRIDE.
You can enter a value in minutes, seconds, or hours (based on the Unit setting - see below) but the Event Template tab will always display in minutes.
When you modify a Margin value, the form will use the largest possible Unit (Hours, Minutes, Seconds) for which all the values can be expressed as integers. For example, you enter 120 Seconds for a Margin value and click Save. The Event Template tab will display the value as 2 Minutes. When you modify the record, it will also display as 2 minutes. If you enter 90 seconds for a Margin value and click Save, the Event Template tab will display the value as 1.5 minutes but when you modify the record it will display as 90 Seconds.
Unit
Unit of time used to define the Start Early Margin, Start Late Margin, End Early Margin, and End Late Margin. Select HOURS, MINUTES, or SECONDS.
The Event Template tab always displays the value in minutes.
When you modify an Event Template, the form will display these values using the largest possible Unit (Hours, Minutes, Seconds) for which all the margin values can be expressed as integers. For example, you enter 120 Seconds for the margin values and click Save. When you modify the record, the margin values will display as 2 Minutes. If you enter 90 seconds for the margin values and click Save, the form will display the values as 90 Seconds when you click Modify.
Auto Event
Select from the following options to define how the Event posts:
AUTO: The Event posts automatically according to the Start Time and End Time or the Start Hours Offset and End Hours Offset.
OVERRIDE: The Event posts automatically unless the employee posts it manually. For example, an employee is scheduled to work from 7:00 a.m. to 3:30 p.m. with a lunch break from 11:30 a.m. to 12:00 p.m. that is set to OVERRIDE. The employee works from 7:00 a.m. to 10:30 a.m. and then punches out for lunch. The employee returns from lunch at 12:30 p.m. The automatic lunch (11:30 – 12:00) will not post and the punched lunch (10:30 – 12:30) will remain. See Meal/Break Override for more information.
PUNCH: The Event posts only when the employee posts it manually.
Note: If you are using the Smart Clock feature, make sure you set Auto Event to PUNCH.
Required
Select from the following options to determine if the event is required for an employee:
MANDATORY: The employee is expected to post the Event.
OPTIONAL: The employee may post the Event but there will not be a violation if the Event is not posted.
PROHIBITED: The employee is not allowed to post the Event.
When Auto Event is set to AUTO or OVERRIDE, the Required field is always set to MANDATORY.
When Auto Event is set to PUNCH, you can select MANDATORY, OPTIONAL, or PROHIBITED.
Click Main Menu > Administration > Schedules > Ad Hoc Templates and select the template to which you want to add a Meal or Break.
Click the Event Template tab and click Add.
Select the Event, Posting Basis, Required, and Auto Event settings.
If the Posting Basis is STRICT, select the Start Day, Start Timestamp, End Day, and End Timestamp for the Event.
If the Posting Basis is OFFSET, select the Start Hours Offset and End Hours Offset for the Event.
If Auto Event is set to PUNCH or OVERRIDE, select the Start Early Margin, Start Late Margin, End Early Margin, End Late Margin, and Margin Unit.
Click Save.
Click Administration > Schedules > Ad Hoc Templates.
Click the Event Template tab and select the event you want to duplicate.
Click Copy.
Modify the fields as necessary and click Save.
Click Main Menu > Administration > Schedules > Ad Hoc Templates and select the template for which you want to modify or delete a Meal or Break.
Click the Event Template tab and select the event you want to modify or delete.
Click Modify to change all the Event's settings.
Click Save when you are done.
Click Delete to delete the event from the template.