Event Manager

The Event Manager page lists the events currently scheduled in the system. Schedule new events or work with existing events. Scheduled events contains a list of existing events along with information about each event that you created or that was assigned to you.

To access Event Manager from the Main Menu, select Administration > Application Setup and then select Common Setup > Event Manager.

To act on an event, highlight the row that contains the event and select the appropriate menu item.

Event Manager contains default events that support other application components.

The Shift Builder event creates schedules into the future for employees that are assigned shift patterns. It is a default system event scheduled to run once a week and with no end date. The system administrator is the only person with access rights to this event by default.

The default setting for Shift Builder is to create shifts 270 days into the future. Therefore, six days after the event executes, shifts will exist 264 days into the future. To meet your organization’s scheduling requirements, you can change both the frequency of the Shift Builder event and the number of days into the future that shifts are created.

To change the number of days into the future that shifts are created, edit the value of the Days for pattern rollout setting in Application Setup > Scheduler Setup > Shift Builder Criteria.

Note: Editing a shift pattern assigned to an employee also creates new shifts into the future for those employees. The number of days into the future that shifts are created is also determined by the Days for pattern rollout setting.

See the Scheduler online Help for more information about shift patterns.

The Stop Retro event stops group processing of Historical Edits with Retroactive Pay Calculations, easing the load on the Background Processor. This event is configured to run only when you choose to run it.

To restart the group processing of Historical Edits with Retroactive Pay Calculations, run the Restart Retro event.

The Restart Retro event restarts group processing of Historical Edits with Retroactive Pay Calculations after processing has been stopped with the Stop Retro event. This event is configured to run only when you choose to run it.

This event reruns a Hyperfind to determine if there are changes in the list of employees included in the Employee Visibility Periods.

This event reruns the team definition (with the same Hyperfind, Reports to Manager, or Schedule Group used in the definition) to ensure that the list of employees for the team is accurate.

When a Schedule Builder task fails, this event reruns the task.

This event cleans up the Schedule Builder results from the database table.

This event examines the existing Scheduling KPI data tables and triggers the processing of any missing or stale data. This event should be run whenever performance degradation is reported where the root cause is missing or stale Scheduling KPIs. This event can only be run manually; it cannot be scheduled.

This event examines the existing Schedule Score data tables and triggers the processing of any missing data. This event should be run whenever performance degradation is reported where the root cause is missing Schedule Scores. This event can only be run manually; it cannot be scheduled.

This event examines the existing Scheduling KPI data tables and triggers the reprocessing of all Scheduling KPI values. This event should be run whenever corrupted data in the Scheduling KPI is reported. This event can only be run manually; it cannot be scheduled.

This event examines the existing Schedule Score data tables and triggers the reprocessing of all Schedule Score values. This event should be run whenever corrupted data in the Schedule Score is reported. This event can only be run manually; it cannot be scheduled.

This event cleans up the transactional caches in the Schedule Builder.

This event examines all existing business structure nodes and checks links between all org nodes below sites and already existing or newly created generic categories. Where needed, it creates or repairs links. This event should be run whenever a location in an existing business structure has been created, renamed, moved, copied, deleted, or end-dated.

This event examines all existing business structure nodes and checks links between all department nodes and already existing or newly created generic departments. Where needed, it creates or repairs links. This event should be run whenever a location in an existing business structure has been created, renamed, moved, copied, deleted, or end-dated.

This event cleans up all invalid generic departments and categories.

This event triggers the labor constraint engine for all sites.

Note: The Process Missing Scheduling KPI and Reprocess Scheduling KPI tasks, which are disabled, are also listed. Do not run these tasks unless directed to do so by your UKG Representative.

This event is used by the Scheduling KPI component to create the monthly sharded tables it needs in the database and to delete the expired tables. By default, the Scheduling KPI creates tables for each month up to a year in the past and up to the populated through date in the future, plus 1 month of buffer. The event runs every week to ensure the Scheduling KPI creates the next table on time.

This event is used by the Schedule Score component to create the monthly sharded tables it needs in the database and to delete the expired tables. By default, the Scheduling Score component creates tables for each month up to a year in the past and up to the populated through date in the future, plus 1 month of buffer. This event should be run whenever tables need to be updated due to errors. This event can be scheduled to run weekly.

All non-batch events are created from either an application component that allows scheduling or by duplicating an existing event within Event Manager and saving it with modified settings.

  • To create an event from a component that allows scheduling, click the Schedule menu selection from within that component’s menu bar.
  • To duplicate an existing event, select the event in the Scheduled Events list within the Event Manager page and clickDuplicate.

Batch events include a batch command and are typically created by system administrators only.

  1. Enter or change the name and description of the event.
  2. Select a user from the Username drop-down box. The user defaults to the currently logged on user.
  3. Select a manager role from the Role Assignment drop-down box. This selection will run the event with the selected manager's role attributes. The event details list the run as user with the selected role in brackets.

Enter the email of the people who will be notified of the event.

  1. From the Schedule drop-down list, select Monthly, Weekly, Daily, Hourly, or Once.
  2. In the Type section, select the timeframe during which you want the event to be active by entering a start date and time and an end date and time.

The Event Schedule page displays the entries used to schedule the event. Enter any additional information required by the schedule type as described in step 2.

Note:

The default end date for all schedule types (with the exception of Now) is Forever. Events with an end date of Forever are active until you modify the Forever setting, disable the event, or delete the event. To change the Forever setting, enter an end date and time. To return back to the Forever setting, select the Forever check box.

Event Manager tasks are viewed and saved in the time zone of the server, not the time zone of the browser. For example, if you schedule an event to run at 3 p.m. in your time zone, the event will run at 3 p.m. in the server's time zone. This means that if the server is in Eastern Standard Time and you are in Central Standard Time and you schedule an event to run at 3 p.m., the event will actually run at 2 p.m. in your time zone (which is 3 p.m. in the server's time zone).

All events are either enabled or disabled. A disabled event does not run according to schedule. Disable an event instead of deleting it if you plan to use it again in the future.

  1. Select the event within the Scheduled Events list.
  2. Click Disable.

To enable the event later, select the event and click Enable.

Note: To delete an event, select the event in the Scheduled Events list and click Delete.

To run an event off-schedule without changing the schedule settings for the event, select the event in the Scheduled Events list and click Run.

The event runs using the settings that are used when it runs according to schedule. The event runs as expected at the next scheduled time.

Note: If a scheduled event was missed because of a power failure or server downtime, do not run the event as described here.

Click Properties in the Scheduled Events list to view the following information about an event:

  • Event name
  • Job ID
  • Last run date
  • Next run on
  • Date modified and modified by
  • Last Manual run
  • Error text

You might want certain events to run on the last day of each month, regardless of what day the last day is. However, given how events are scheduled, you need to take special steps to set up this type of schedule:

  1. Create an event as you normally would.
  2. After setting the Event Details and Event Output for the event, click the drop-down arrow in the Schedule Type list box and select class="label">Monthly.
  3. In the Day of Month text box, type 31.
  4. In the Months section, select only the months with 31 days and clear the rest. The months with 31 days are: January, March, May, July, August, October, and December.
  5. Set the Start and End dates and times just as you would any other event and save the event.
  6. Duplicate the event that you just created.
  7. Give the event a unique name and in the Day of Month text box, type 30.
  8. In the Months section, check only the months with 30 days and uncheck the rest. Then, save the event.
  9. The months with 30 days are: April, June, September, and November.
  10. Duplicate the event that you created, name the event, and set the event to run on February 28th. Save the event.
  11. Duplicate the event that you created, name the event, and set the event to run on February 29th. Save the event.

You now have four scheduled events for the same action. One for months that end on the 31st. One for months that end on the 30th. And two for February—one for leap years and one for standard-length years. The event will run exactly 12 times in one year, on the last day of each month. During a leap year, you can disable the February 28th event, or the February event runs twice that year - on the 28th and the 29th.

Because of power failures or server downtime, scheduled events do not run. If an event is missed, you can run it manually from within the Event Manager page.

Note: Missed events are not reported in the Event Manager. You might be able to determine a problem by checking the last run date in the Event Properties dialog box.

  1. Select Administration > Application Setup > Common Setup > Event Manager.
  2. On the Event Manager page, select an event that was scheduled to run during the downtime, then click Properties to determine if the event was missed.
  3. If an event was missed, click Run to run it manually.