WFC70 ProcessMgrTKandSchedProgGuide

Workforce Central
Process Manager
Timekeeper and Scheduler
Programmer Guide
A guide to configuring the process
templates that Process Manager uses to
automate business processes.
Kronos Workforce Central suite version 7.0
The information in this document is subject to change without notice and should not be construed as a commitment
by Kronos Incorporated. Kronos Incorporated assumes no responsibility for any errors that may appear in this
manual. This document or any part thereof may not be reproduced in any form without the written permission of
Kronos Incorporated. All rights reserved. Copyright 2013.
Altitude, Altitude Dream, Cambridge Clock, CardSaver, Datakeeper, Datakeeper Central, eForce, Gatekeeper,
Gatekeeper Central, Imagekeeper, Jobkeeper Central, Keep.Trac, Kronos, Kronos InTouch, Kronos Touch ID, the
Kronos logo, My Genies, PeoplePlanner, PeoplePlanner & Design, Schedule Manager & Design, ShiftLogic,
ShopTrac, ShopTrac Pro, StarComm, StarPort, StarSaver, StarTimer, TeleTime, Timekeeper, Timekeeper Central,
TimeMaker, Unicru, Visionware, Workforce Accruals, Workforce Central, Workforce Decisions, Workforce Express,
Workforce Genie, and Workforce TeleTime are registered trademarks of Kronos Incorporated or a related company.
Altitude MPP, Altitude MPPXpress, Altitude Pairing, Altitude PBS, Comm.Mgr, CommLink, DKC/Datalink,
eDiagnostics, Experts at Improving the Performance of People and Business, FasTrack, Hireport, HR and Payroll
Answerforce, HyperFind, Kronos 4500 Touch ID, Kronos 4500, Kronos 4510, Kronos Acquisition, Kronos e-Central,
Kronos KnowledgePass, Kronos TechKnowledgy, KronosWorks, KVC OnDemand, Labor Plus, Momentum
Essentials, Momentum Online, Momentum, MPPXpress, Overall Labor Effectiveness, Schedule Assistant, Smart
Scheduler, Smart View, Start Quality, Start WIP, Starter Series, StartLabor, TeleStaff, Timekeeper Decisions,
Timekeeper Web, VisionPlus, Winstar Elite, WIP Plus, Workforce Absence Manager, Workforce Acquisition,
Workforce Activities, Workforce Analytics, Workforce Attendance, Workforce Central Portal, Workforce Connect,
Workforce Employee, Workforce ESP, Workforce Forecast Manager, Workforce HR, Workforce Leave, Workforce
Manager, Workforce MobileTime, Workforce Operations Planner, Workforce Payroll, Workforce Record Manager,
Workforce Recruiter, Workforce Scheduler, Workforce Smart Scheduler, Workforce Task Management, Workforce
Tax Filing, Workforce Timekeeper, Workforce View, and Workforce Worksheet are trademarks of Kronos
Incorporated or a related company.
The source code for Equinox is available for free download at www.eclipse.org.
All other trademarks or registered trademarks used herein are the property of their respective owners and are used
for identification purposes only.
When using and applying the information generated by Kronos products, customers should ensure that they comply
with the applicable requirements of federal and state law, such as the Fair Labor Standards Act. Nothing in this
Guide shall be construed as an assurance or guaranty that Kronos products comply with any such laws.
Published by Kronos Incorporated
297 Billerica Road, Chelmsford, Massachusetts 01824-4119 USA
Phone: 978-250-9800, Fax: 978-367-5900
Kronos Incorporated Global Support: 1-800-394-HELP (1-800-394-4357)
For links to information about international subsidiaries of Kronos Incorporated, go to
http://www.kronos.com
Document Revision History
Document Revision
Product Version
Release Date
Process Manager 7.0
June 2013
Contents
Chapter 1: Using Process Templates for Timekeeper and Scheduler

Implementing a process template .................................................................. 8
Time Off Request .......................................................................................... 9
Time Off Request (4500 and InTouch timeclock) ...................................... 12
Automatic Action ........................................................................................ 16
Sample instructional template ..................................................................... 17
Cancel Time Off Request ............................................................................ 19
Shift Swap ................................................................................................... 22
Sign Up for Open Shifts .............................................................................. 25
Request Open Shifts .................................................................................... 27
New Hire Decision/Announcement ............................................................. 29
Employee Awards ....................................................................................... 31
Disciplinary Action ..................................................................................... 33
Termination Announcement ........................................................................ 35
Training Registration ................................................................................... 38
Request to Cover ......................................................................................... 41
Request to Cover Shift ................................................................................. 43
Delegate AuthorityManager .................................................................... 45
Delegate AuthorityAdministration .......................................................... 47
Request Manager Cancel Time Off Request ............................................... 49
Previously Approved Request ..................................................................... 52
Previously Submitted Time Off Request ..................................................... 55
Insufficient Balance Time Off Request ....................................................... 58
Chapter 2: Using Request Manager Process Templates
Request Manager Time Off Request ........................................................... 63
Request Manager Time Off Request (4500 timeclock) ............................... 65
Request Manager Cancel Time Off Request ............................................... 68
Request Manager Overtime Request ........................................................... 70
Contents
Request Manager Shift Swap .......................................................................72

Request Manager Sign Up for Open Shifts ..................................................75
Request Manager Request Open Shifts ........................................................77
Request Manager New Hire Decision/Announcement ................................79
Request Manager Employee Awards ...........................................................81
Request Manager Disciplinary Action .........................................................83
Request Manager Termination Announcement ...........................................86
Request Manager Training Registration ......................................................89
Request Manager Request to Cover .............................................................92
Request Manager Request to Cover Shift ....................................................94
Request Manager Delegate AuthorityAdministration ..............................97
Request Manager Delegate AuthorityManager ......................................100
Modifying accrual attributes ......................................................................102
Updating process templates for Request Manager .....................................104
Selecting the template ..........................................................................104
Adding columns in Request Manager with template information .......104
Viewing a Request Date in Request Manager .....................................105
Exposing form actions in Request Manager ........................................106
Removing the welcome and thank you forms .....................................107
Getting an approver for forms .............................................................107
Chapter 3: Timekeeper and Scheduler Extensions
to Process Designer
Timekeeper and Scheduler API tasks ........................................................110
Accruals API task ................................................................................110
Eligible Jobs API task .........................................................................111
Jobs API task ......................................................................................112
Lead Time API task .............................................................................113
Open Shift Volunteer API task ...........................................................114
Pay Code Edits API task .....................................................................116
Request to Cover API task .................................................................123
Qualified Employees API task ...........................................................128
Resume API task .................................................................................129
Schedule API tasks .............................................................................130
Shift Builder API task ........................................................................138
Contents
Shift Validation API task ................................................................... 139

Skills & Certs API task ...................................................................... 141
Timekeeper API tasks ........................................................................ 142
Timekeeper and Scheduler Processor tasks ............................................... 174
Contents
Chapter 1
Using Process Templates for Timekeeper and

Scheduler
This chapter contains the following sections:
Implementing a process template on page 8
Time Off Request on page 9
Time Off Request (4500 and InTouch timeclock) on page 12
Automatic Action on page 16
Sample instructional template on page 17
Cancel Time Off Request on page 19
Shift Swap on page 22
Sign Up for Open Shifts on page 25
Request Open Shifts on page 27
New Hire Decision/Announcement on page 29
Employee Awards on page 31
Disciplinary Action on page 33
Termination Announcement on page 35
Training Registration on page 38
Request to Cover on page 41
Request to Cover Shift on page 43
Delegate AuthorityManager on page 45
Delegate AuthorityAdministration on page 47
Chapter 1
Using Process Templates for Timekeeper and Scheduler
Implementing a process template

Use the following procedure to implement a process template in the suite:
Step
1 Use Process Designer to open and modify a
process template:
Document
The Process Manager Programmers Guides
that shipped with your product.
Check for Process Designer extensions.

Make required modifications to tasks, forms,
and resources to ensure that the template
supplied with the product maps exactly to your
business process.
Make optional modifications to further tailor
the process template to the needs of your
organization.
2 Use Process Designer to deploy the finished

Deploying a Process Template in Chapter 4
process template to a server, to make that template of the Process Manager Programmers Guide.
available for use in the system.
3 In the suite application, use the Process Templates Activating a Process Template in Chapter 4
editor to activate the process template.
of the Process Manager Programmers Guide.
4 In the suite application, use the Process Profiles
editor to add the process template to a process
profile.
Adding a Template to a Process Profile in

Chapter 4 of the Process Manager
Programmers Guide.
Assigning the Process Profile and

Specifying Person and Job Assignment
Assign the process profile to the appropriate
employees and managers in the organization. Information in Chapter 4 of the Process
Enter a managers name in the Reports To field Manager Programmers Guide.
for each employee.
Enter an e-mail address (if external e-mail will
be used for messages and notifications) for
each employee.
5 In the suite application, use the People Editor to:
6 In the suite application, use the Process

Viewing the Status of All Processes in the
Administrator to manage processes as they execute System Administrators Guide for Workforce
in the system.
Central.
Time Off Request
Time Off Request

Use TimeOffRequest.template.xml to automate the process that allows
employees who log in to Timekeeper via the Web client to request time off for a
vacation day, personal day, floating holiday, or related events. Employees can
make this request from their Actions list.
Note: This process template includes advanced features that are available to sites
running Scheduler. An employees request form will be verified to ensure no rules
have been violated before the manager approves the form.
Description
How this process template works:
1. An employee submits a form requesting time off.
2. If there are no accrual violations, or if your site is not running Scheduler, the
employee either receives a message that the form has been successfully
submitted, or a form appears that asks the employee to specify his or her
unavailable period. After the Unavailability form is completed, the employee
receives a message that the form has been successfully submitted The
manager receives a message that the request has been submitted by the
employee.
If there are accrual violations, a form appears that shows those violations. If
your site is running Scheduler, schedule rule violations are shown as well.
3. The manager uses the main suite window or manager self-service window to
open the Time Off Request form from the employee and then either approves
or rejects the request. In Scheduler, the manager may be presented with any
rules violations.
If the request is approved, the manager specifies Override Shift and

Display Start Time (when the employeess shift begins). The employees
schedule is updated and a confirmation message is sent to the employee.
If the request is rejected, the manager provides comments and sends a

message to the employee.
Chapter 1
Required modifications
Before you deploy this process template, you must make a few required
modifications to ensure that the template works correctly for your organization.
Note: After you finish these changes to the template, review the Modifications
Required for All Templates in the basic Process Manager Programmers Guide
for required modifications before deploying the template.
Modify accrual attributes
If your organization uses different accrual codes for time off or does not use
certain ones at all, you must change attributes in the properties sheet for the
process template so that the correct accrual names are used in the forms and
notification messages.
1. With the template open in Process Designer, select Edit > Process
Properties.
2. On the Attributes tab, replace the values in the Default Value column with the
values that your organization uses, for the following attributes:
AccrualName1
AccrualName2
AccrualName3
i18n.Time_Off_Request_form.label.AccrualLabel1
For example, if your organization uses Sick instead of Personal, change the
Default Value entry for AccrualLabel2 and AccrualName2 from Personal to
Sick. Press Enter after each entry.
Note: Be sure that the accrual name exactly matches the accrual code name
used by your organization. If an Accrual Rule is configured for the accrual
code, and you have selected the Transactions in increments check box on
the Taking Rules tab, make sure that the increments value on the employee
request form matches the increments value on the Taking Rules tab.
10
Time Off Request
3. If your organization does not use certain accrual codes, select the rows with
the unneeded accrual code and accrual label and click Remove. Removing the
accrual codes and associate attributes for unnecessary accrual codes reduces
the amount of space required to store this process in the database.
Note: If you remove attributes, be sure to remove any references to the
attributes in Form tasks.
4. Click OK.
Remove accrual codes from K-Mail task
If your organization does not use one or more of the accrual codes listed
previously, after you remove references to them from the forms, remove
references to them from the Manager K-Mail task. Use Edit > Process Properties
> Localizer to edit the messages as appropriate.
11
Chapter 1
Time Off Request (4500 and InTouch timeclock)

Use TimeOffRequest_4500.template.xml to automate the process that
allows employees to use their 4500 or InTouch timeclock to request time off. This
process template uses the Smart View transaction capability, which is delivered
with the timeclock. For more information about configuring Smart View
transactions, see the System Administrators Guide for Device Manager.
Note: When using the Process Templates editor to activate this template in the
suite, the administrator must select the Hide button (instead of Show) for the
Action List option. This ensures that this template does not appear in the
employees Actions list, because this process template cannot be launched from
the Actions list. For more information about the Process Templates editor, see the
core Process Manager Programmers Guide.
Description
1. An employee uses the 4500 or InTouch timeclock to submit a request for time
off and specifies dates as well as the number of days.
2. The employee receives a message that the request from the timeclock has
been successfully submitted. The manager receives a message that the
employee has submitted a request.
open the Time Off Request (4500 or InTouch) form from the employee and
then either approves or rejects the request.
12
If the request is approved, the manager specifies Override Shift and

schedule is updated and a confirmation message is sent to the employee,
which the employee can read on the timeclock.

message to the employee, which the employee can read on the timeclock.
Required for All Templates in the core Process Manager Programmers Guide for
required modifications before deploying the template.
Properties.
AccrualName1, AccrualIncrement1, and AccrualLabel1
Sick. Press Enter after each entry.
Be sure that the accrual name exactly matches the accrual code name used by
your organization. If an Accrual Rule is configured for the accrual code, and
you have selected the Transactions in increments check box on the Taking
Rules tab, make sure that the increments value in the template matches the
increments value on the Taking Rules tab.
3. If your organization does not use certain accrual codes, select the row with the
unneeded accrual code and click Remove. Removing the accrual codes and
associate attributes for unnecessary accrual codes reduces the amount of space
required to store this process in the database.
13
Chapter 1

4. Click OK.
previously, after you remove references to them from the form, you must remove
references to them from the Manager K-Mail task.
Optional modification
If you have multiple labor levels (locations), you can add branches to the template
for each labor level, as shown in the following example:
14
For each labor level Branch task, click the Rule Editor tab, and specify the rule for
the home labor account (the attribute listed in Process Properties). Specify a
HyperFind query or person number in the corresponding K-Mail task to send the
time off approval message to the appropriate administrator for that labor level.
If the labor level does not match any of the labor levels specified in the Branch
task rules, a notification message is sent to the employees manager notifying him
or her of the invalid labor level.
The timeclocks at your site must be configured to allow employees to perform a
Time Off Request (4500 and InTouch).
15
Chapter 1
Automatic Action
Use AutomaticAction.template.xml to automatically approve or reject
requests when a reviewer has not taken any action on the request for a specific
time period. The time to wait (Delay time -in days) before automatically
approving or rejecting the action can be configured on the Approval Settings page
in Setup. This template also sends recipients Generic Notifications, which can be
configured on the Approval Settings page. The message data for generic
notifications can be configured in the Workflow Notifications area in Setup.
Description
This is how the Process Manager template works:
1. If there is an automatic action configured to approve or reject a request, and
the configured number of days (delay time) has expired, then the automatic
action is performed. This action occurs only if the reviewer for the request did
not take any action before the delay time expired. Approval actions can be
configured in Setup > Employee Self Service.
2. After the automatic action is taken on the request, generic notification
messages are sent to the recipients that were specified on the request. The
recipients can be one or more of the following:
The Requester
The Approver
The Also Notify recipient

This recipient is a person who is not part of the review process, but is
notified about the request status.
There are no specific modifications required for this template other than the
procedures described in the section Modifications Required for All Templates
in the Process Manager Programmer's Guide.
16
Sample instructional template
Sample instructional template

The following sample instructional template demonstrates how you can use the
four new Approval Sequencing API tasks, along with other existing tasks, to
create a customized template to retrieve information specific to reviewer lists.
This template also shows how to manipulate the returned List values from the
tasks to extract specific details.
Template name:
SampleReviewerListRetrievalServices.template.xml
Prerequisites
Before using this template, perform the following:
1. Create a Reviewer List with the name Sample Reviewer List on the
Reviewer Lists page in Setup.
2. (Optional) Create a Reviewer Purpose with the name Sample Purpose on
the Reviewer Purposes page in Setup.
3. Configure an employee in the system that has access to the sample template.
4. (Optional) Assign the sample reviewer list and sample purpose to this
employee in People Editor.
5. Configure a Generic Notification with the name Sample Generic
Notification on the Workflow Notification page in Setup.
The message content for the generic notification should be:
Reviewer List Information:
<Reviewers Reviewer List>
Valid reviewers:
<Reviewers Employee>
Non-valid reviewers:
<Reviewers Non-Valid Reviewer>
The contents in the < > are custom tags.
Four new API tasks are used in this template:
17
Chapter 1
RetrieveReviewerListByRequestPurposeNameAPITask.xml
RetrieveNextReviewersByReviewerListNameAPITask.xml
RetrieveListenersByReviewerListNameAPITask.xml
RetrieveAllPotentialReviewersForStepByReviewerListNam
eAPITask.xml
Template overview
If the prerequisites are configured properly, the following actions take place:
1. The template first calls the
RetrieveReviewerListByRequestPurposeName API task and
retrieves the Reviewer List Name and Step Count for the sample reviewer list.
2. For each step in the sample reviewer list, the template then calls the
RetrieveNextReviewersByReviewerListName and the
RetrieveAllPotentialReviewersForStepByReviewerListN
ame API tasks to retrieve valid and non-valid reviewer data.
3. The template calls the RetrieveListenersByReviewerListName
API task to retrieve information about valid and non-valid Also Notify
people.
4. The template sends a notification that was configured for the Sample Generic
Notification, containing all the retrieved data at each step, and for the Also
Notify.
18
Cancel Time Off Request

Use CancelTimeOffRequest.template.xml to automate the process
that allows employees to cancel a previously submitted Time Off Request from
their Actions list. Canceling from a 4500 or InTouch timeclock is not supported.
Description
1. An employee submits a form requesting to cancel time off that was previously
planned and approved. The employee provides the required information about
the Time Off Request.
2. The employee receives a message stating that the request has been
successfully submitted. The manager receives a message that the form has
been submitted by the employee.
open the Cancel Time Off request form from the employee and then either
approves or rejects the request.
If the request is approved, the employees schedule is updated and a

confirmation message is sent to the employee as well.

19
Chapter 1

Properties.
AccrualName1
AccrualName2
AccrualName3
Sick (be sure that the accrual name exactly matches the accrual code name
used by your organization). Press Enter after each entry.
4. Click OK.
20

previously, after you remove references to them from the forms, you must remove
> Localizer to edit the messages.
21
Chapter 1
Shift Swap
Use ShiftSwap.template.xml to automate the process that allows two
employees to swap shifts.
Description
1. Employee A starts the process by clicking a link in the Actions list and
selecting Swap Shift.
2. The system displays the My Shift version of the Shift Swap Request form.
Employee A specifies the date and length of the shift that he wants to swap
out and then clicks Next.
3. The system displays the Other Persons Shift version of the Shift Swap
Request form, which also includes the previously entered My Shift
information. Employee A specifies the date and length of the shift that he
wants to swap for, selects the name of an employee (Employee B) who is
qualified to swap shifts with Employee A, and then clicks Next.
Note: This process template uses the following criteria and restrictions to
calculate which employees (Employee B, the person who will receive the shift
swap request from Employee A) qualify to appear in the drop-down list that is
attached to the Name field of this request form:
22
If Employee A is a Scheduler employee, Employee Bs shift must include

Employee As primary job, or Employee As job transfer set must include
the job that is associated with Employee Bs shift.
If Employee A is a Timekeeper employee, Employee Bs shift must

include Employee As labor account, or Employee As labor level transfer
set must include the labor account that is associated with Employee Bs
shift.
Shift Swap
Both employees must have the same product licenses. For example, if
Employee A has a Scheduler license, Employee B must also have a
Scheduler license.
The shifts that are being swapped must be the same length. For example,
if Employee A wants to swap a 6-hour shift and Employee B has an
8-hour shift available on the selected day, Employee Bs name will not
appear in the drop-down list of employees who are qualified to receive the
request to swap shifts.
4. If there are validation errors, the system displays a form with that information
and gives Employee A the option of trying again, canceling the request, or
sending the request, depending on the type of rule violations. If there are no
validation errors, Employee A clicks Save & Close to continue the process.
5. Employee B receives a notification message requesting a shift swap and uses
a form to either accept or decline the request:
If Employee B accepts the request, a notification message is sent to the

manager and Employee A. Both of their schedules are then updated.
If Employee B accepts the request but that request contains rule

violations, the manager of both employees receives a notification
message. (If the two employees report to different managers, the process
template contains conditional logic and approval form tasks to
accommodate that scenario as well; both managers receive notifications.)
If Employee B declines the request, Employee A receives a notification

message.
6. If the manager (or managers) receives a notification that the shift swap
request contains rule violations, that manager uses a form to approve or reject
the request:
If the manager approves the request, both employees receive a

confirmation message. Their schedules are then updated.
If the manager rejects the request, both employees receive a rejection

message. The manager may indicate why their request was rejected.
23
Chapter 1
Implementation requirements
If shifts are created weekly instead of daily at your site, then this process template
may not be able to update the employee schedule. Check with the system
administrator to make sure the following property in the Global Values system
settings is set to 0:
Global.WtkScheduler.ShiftBuilderGovernor.Active
For Shift Swap, Request to Cover, and Request to Cover Shift, the shifts must be
populated in the employees schedules.
24
Sign Up for Open Shifts
Sign Up for Open Shifts

Use OpenShiftSignUp.template.xml to automate the process that allows
employees to apply for shifts during their unscheduled time.
Note: The OpenShiftSignup process creates a new shift for an employee who
requests one. The process is not aware of existing open shifts. If you are using
only Timekeeper, use this template.
If you are using Scheduler, use RequestOpenShifts.template.xml,
which checks schedule rules and returns any schedule rule violations. See
Request Open Shifts on page 27.
Description
1. An employee submits a form requesting to sign up for an open shift. The form
includes the following information:
Shift Date
Shift Start time
Shift End time
Comments
2. The employee receives a message confirming that the request is in the system.
3. The manager receives a form and either approves or rejects the shift sign-up
request.
4. If the manager approves the request, the employee receives a confirmation
message and that employees schedule is updated with the new shift
information.
If the manager rejects the request, the employee receives a message indicating
that the request was rejected and why.
25
Chapter 1
in the core Process Manager Programmers Guide.
26
Request Open Shifts
Request Open Shifts

Use RequestOpenShifts.template to automate the process that allows
employees to apply for open shifts. This template checks schedule rules and
returns any schedule rule violations. You can continue with your request or correct
the violations.
Note: This is the advanced version of OpenShiftSignup.template. It is
designed for sites running Scheduler. It checks the request for schedule rule
violations. If you are using only Timekeeper, use the OpenShiftSignUp
template.
Description
1. An employee submits a form requesting to sign up for an open shift. The form
Shift Date
Shift Start time
Shift End time
Comments
The system validates each employee selection and checks for rule violations.
If there are no open shifts available for the date or times, the request is not
processed and the employee is notified. If there are rule violations of Warning
or Information level, the employee has the option to submit the request with
the rule violations.
If there is a No Save rule violation, the system does not process the request
and the employee is notified. The employee can try another request or cancel.
2. If the system accepts the request, the manager and employee each receive a
message confirming that the request is in the system.
27
Chapter 1
3. The manager receives the request. At this point, the manager can recheck the
request for rule violations. If no No Save rule violations occur, the manager
can either approve or reject the open shift sign-up request.
If the manager approves the request, the employee receives a confirmation
message, and the system updates that employees schedule with the new shift
information. If the Remove Existing Shifts check box on the Approve Shift
dialog box is selected, the existing shift is removed from the schedule.
If the manager rejects the request, he or she can enter a reason for the
rejection, and the employee receives a message indicating that the request was
rejected and why.
28
New Hire Decision/Announcement
New Hire Decision/Announcement

Use NewHireDecisionandAnnouncement.template.xml to automate
the approval and implementation process for hiring a new employee.
Description
1. The hiring manager submits a request to the senior manager asking to hire a
new employee.
2. The senior manager either approves or rejects the request:
If the new hire request is rejected, the hiring manager receives a

notification.
If the request is approved, the hiring manager receives a notification of

the approval with comments from the senior manager. The Human
Resources (HR) contact receives a notification about the new hire request
and is assigned a corresponding task.
3. The hiring manager sends a form to the appropriate Human Resources

contact.
4. The HR contact sends a confirmation message to the hiring manager, which
includes the candidates start date, salary information, and comments.
If the candidate does not accept the offer, the hiring manager receives a
message with comments from HR, and the process finishes.
5. If the candidate accepts the offer, the hiring manager sends requests to the
Facilities Administrator and the IT Administrator to set up access profile to
applications, any hardware and software equipment, office configuration, and
badge/access cards. The actual addition of the new hire is done outside the
process.
6. Both the Facilities Administrator and the IT Administrator send messages
when they have completed their tasks.
29
Chapter 1
Before you deploy the template, specify the following individuals in the process
properties sheet: HR Administrator, IT Administrator, and Facilities
Administrator.
Properties.
2. On the Attributes tab, select the row for HRAdministrator.
3. In the Default Value column, enter the employee ID for the person who is
your HR Administrator and then press Enter.
4. Repeat steps 2 and 3 for the IT Administrator and Facilities Administrator.
5. Click OK.
Note: After you finish these changes to the template, review the section
Modifications Required for All Templates in the core Process Manager
Programmers Guide for required modifications before deploying the template.
The individuals identified as HR Administrator, IT Administrator and Facilities
Administrator must have access to the suite functions required for this process,
such as Inbox, My Actions, Actions, and Tasks. For more information, see
Configuring Process Manager in the core System Administrators Guide.
30
Employee Awards
Employee Awards
Use EmployeeAward.template.xml to automate the approval process that
allows managers to give company awards to employees.
Description
This is how this process template works:
1. A manager who wants to recommend an employee for a performance award
submits a form to a senior manager that includes the reason and suggested
amount of the award.
2. The manager receives a message stating that the request has been successfully
submitted.
3. The senior manager receives the form and either approves or rejects the
request:
If the senior manager approves the award, the HR Administrator and the
manager who submitted the request each receive a notification.
If the senior manager rejects the award request, the manager who
submitted the request receives a notification message with comments
from the senior manager.
31
Chapter 1
Edit list of awards

You must edit the list of awards found on the Employee Award Form task (with
the form title Pick Award for Chosen Employee, which is labeled Employee
Award Form on the Graphical View of the Process Designer) to reflect the names
of the awards that are specific to your organization.
Change HyperFind filters
This template uses a HyperFind task that specifies the managers All Home
HyperFind. You must change the filters for this HyperFind before you deploy the
template. See Modifications Required for All Templates in the core Process
Manager Programmers Guide for more information.
32
Disciplinary Action
Disciplinary Action
Use DisciplinaryAction.template.xml to automate the approval and
tracking process for initiating disciplinary action with an employee.
Description
1. The manager submits a disciplinary actions form to the senior manager.
submitted.
3. The senior manager receives the form and either approves or rejects the
request for disciplinary action:
If the senior manager approves the request, the HR Administrator and the
manager who submitted the request each receive a notification message.
If the senior manager rejects the request, the manager who submitted the
request receives a notification message with comments from the senior
manager.
4. If the request is approved, the HR Administrator receives the form and either
approves or rejects the request for disciplinary action:
If the HR Administrator approves the request, the manager receives a

notification message from the HR Administrator with the suggested
course of action (written or verbal disciplinary action, for example).
If the HR Administrator rejects the request, the manager receives a

notification message from the HR Administrator with reasons for the
rejection.
33
Chapter 1
Specify an HR administrator
Specify an HR Administrator to receive messages during the disciplinary actions
process:
Properties.
3. In the Default Value column, enter the employee ID for the person that is your
HR Administrator and then press Enter.
4. Click OK.
Edit list of disciplinary actions
Edit the list of disciplinary actions found on the Disciplinary Action Form task
(with form title Disciplinary Action for Employee) to reflect the names of the
disciplinary actions that are specific to your organization.
The individual identified as the HR Administrator must have access to the suite
functions required for this process, such as Inbox, Tasks, and Actions. For more
information, see Configuring Process Manager in the core System
Administrators Guide.
34
Termination Announcement
Use TerminationAnnouncement.template.xml to automate the
approval and tracking process for terminating an employee.
Description
1. he manager initiates the termination announcement process by clicking the
TerminationAnnouncement link in the managers suite or manager selfservice Actions list.
2. In the Termination Announcement Request form that opens, the manager
provides the following information and submits the form:
Employee name
Termination date
Reasons for the termination
3. After the manager submits the form:
A notification message is sent to the manager who submitted the

Termination Announcement Request form, stating that the Termination
Announcement Request has been sent to his or her manager.
A notification message is sent to the managers manager to request

approval or rejection of the termination request.
The managers manager or senior manager receives a task in his or her

task list called TerminationAnnouncment, Mgr Approve/Reject
Termination Announcement Form.
4. The managers manager or senior manager selects the task, opens the
corresponding form, either approves or rejects the termination request, and
submits the form.
5. The manager who submitted the Termination Announcement Request
receives a notification message stating whether the request was approved or
rejected by the senior manager and why.
35
Chapter 1
6. If the managers manager or senior manager approves the termination

announcement request:
The HR Administrator receives a notification message stating that a

manager has requested a termination announcement for a particular
employee.
The HR Administrator receives a notification message stating that the

senior manager has approved the Termination Announcement Request. A
task for the HR Approve/Reject Termination Announcement Form is sent
the HR Administrator task list.
7. The HR Administrator completes the termination paperwork with the

manager. (This is outside the business process.) The HR Administrator then
selects the TerminationAnnouncement, HR Approve/Reject Termination
Announcement Form from his or her Tasks list and either approves or rejects
the request.
8. The manager who submitted the termination request receives a notification
message stating that the HR Administrator has either approved or rejected the
termination announcement request.
9. If the HR Administrator approves the request for termination announcement,
then a notification message is sent to the manager and to the Facilities
Administrator, IT Administrator, and Payroll Administrator. The message
tells each administrator to review his or her task list for a termination
announcement request task that each must complete.
10. The HR Administrator and the manager who submitted the initial Termination
Announcement Request Form each receive a notification message notifying
them that the Payroll Administrator, the IT Administrator, and the Facilities
Administrator have completed their termination of employment activities.
36
Before you deploy this process template, specify an HR Administrator, Facilities
Administrator, IT Administrator, and Payroll Administrator to receive messages.
Properties.
4. Repeat steps 2 and 3 for the Facilities, IT, and Payroll administrators.
5. Click OK.
37
Chapter 1
Training Registration
Use TrainingRegistration.template.xml to automate the approval
process for employees who want to sign up for training.
Description
1. An employee who wants to attend a training course submits a request for
approval form to the manager.
2. The manager receives the form and either approves or rejects the training
request:
If the manager approves the request, the training coordinator receives a

notification message.
If the manager rejects the request, the employee receives a notification

message with comments.
3. The training coordinator either approves or rejects the training request:
38
If the training coordinator approves the request (for example, the course
has not reached capacity), the employee receives a confirmation message
and the employees schedule is updated.
If the training coordinator rejects the request (for example, the course has
reached capacity), the employee receives a notification message.
Training Registration
Specify a Training Administrator
You must specify a Training Administrator to receive notifications during the
process:
Properties.
2. On the Attributes tab, select the row for TrainingAdministrator.
your Training Administrator and then press Enter.
4. Click OK.
Modify the LeaveType attribute
You must change the LeaveType attribute in the properties sheet for the process
template so that the correct Leave Type names are used in the forms and
notification messages. If you do not set the LeaveType to the pay code that will be
used to track the training time, the process will fail.
Properties.
2. On the Attributes tab, replace the value in the Default Value column for the
LeaveType attribute with the value that your organization uses.
3. Click OK.
39
Chapter 1
40
Request to Cover
Request to Cover
Use RequestToCover.template.xml to automate the process that allows
one employee to work another employees shift to provide coverage if an
employee cannot work.
Note: The advanced version of this template for sites running Scheduler is
RequestToCoverShift.template.xml.
Description
1. Employee A submits forms specifying the date, shift, and name of Employee
B, requesting that Employee B cover Employee As shift. A confirmation
notification message is sent to Employee A.
2. Employee B receives the request to cover Employee As shift in his or her
Inbox and either accepts or declines the request:
If the request is accepted, the form is sent to the manager.
If the request is declined, Employee A receives a message stating that the

request was declined.
3. If both employees have the same manager, that manager receives the shift
coverage request form and either approves or rejects the swap. (The template
supplied with the product is configured for one manager.)
(The process template contains conditional logic and approval form tasks for
the possibility of the employees reporting to different managers, as well.)
4. If the manager or managers approve the request, both employees receive a
confirmation message and their schedules get updated with the new shift
information.
If the manager or managers reject the request, both employees receive a
message indicating why the coverage request was rejected.
41
Chapter 1
42
Request to Cover Shift
Request to Cover Shift

Use RequestToCoverShift.template to automate the process that allows
one employee to work another employees shift to provide coverage if an
employee cannot work. This template checks schedule rules and returns any
schedule rule violations. You can continue the request or correct the violations.
Note: This is the version of the template for sites running Scheduler. It checks the
request for schedule rule violations. If you are using only Timekeeper, use
RequestToCover.template.
Description
1. Employee A fills out a form requesting that Employee B cover Employee As
shift. The system validates that the selected open shift exists and that
Employee B is qualified to work the shift.
The system also checks for rule violations. If there are rule violations of
Warning or Information level, the employee has the option to submit the
request with the rule violations.
2. Employee B receives the request to cover Employee As shift and either
approves or rejects the request:
If employee B rejects the request, Employee A receives a message stating

that the request was rejected. Employee A has the option to submit
another request or exit.
If employee B approves the request, the form is sent to the manager or

managers of both employees.
coverage request form with the relevant information about the two employees
and either approves or rejects the request to cover. If each employee has a
43
Chapter 1
different manager, each manager receives the shift coverage request form.
(The template supplied with the product is configured for one manager. To
modify the template to add a second manager, see Adding a Second
Approver in the core Process Manager Programmers Guide.)
4. If the manager approves the request, both employees receive a confirmation
message and the system updates their schedules with the new shift
information.
If the manager rejects the request, both employees receive a message
indicating why the coverage request was rejected.
Manager Programmers Guide.
44
Delegate AuthorityManager
Delegate AuthorityManager
Use the Mgr_Delegation.template to implement the business process that
allows a manager to delegate one or more roles (the Switch Roles feature) to other
individuals in Timekeeper.
The manager, or delegator, uses this template to create a delegation, which
consists of the name of an individual, or delegate, a duration of time for the
delegation, and the role that has been assigned to the delegate.
Description
1. A manager selects this template from the Actions list.
2. The system displays a form that allows the manager to either create a new
delegation or delete an existing delegation.
a. If the manager chooses to delete an existing delegation, the system
displays a form with a list of existing delegations that the manager can
select and delete. The system then displays a confirmation message and
sends a notification message to the delegate who is associated with the
deleted delegation.
b. If the manager chooses to create a new delegation, the system displays a
form in which the manager can select the name of a delegate from a
drop-down list, assign a role to the delegate, and specify the range of time
(start and end dates) during which the delegate will be authorized to
perform the tasks that are associated with the assigned role.
3. If the manager creates a new delegation, the system does the following:
a. Sends a notification message to the delegate and adds the delegation
request (to accept or decline the delegation) to the tasks list in the
delegates Inbox.
b. Adds a delegation cancellation task to the managers Inbox. The manager
can use this task to cancel the delegation request if the delegate has not
yet accepted it. If the manager opens this task and completes the form, the
45
Chapter 1
system sends a notification message about the cancellation to the delegate

and removes the delegation request from tasks list in the delegates Inbox.
4. The delegate opens the delegation request task in the Inbox and uses the form
to either accept or decline the request:
a. If the delegate accepts the request, the system sends a notification
message to the manager and will display the Switch Roles option on the
main suite window of the delegates browser when that delegation
becomes active (based on the start date).
b. If the delegate declines the request, the system sends a notification
message to the manager and removes the delegation request from the
tasks list in the delegates Inbox.
Note: If the delegate does not respond to the delegation request within three
days, the system sends a notification message to the manager who initiated the
request.
See the core System Administrators Guide and online Help for additional
information about setting up and using the Delegate Authority feature.
There are no required modifications.
There are no specific implementation requirements other than to deploy and
activate the template in the system.
46
Delegate AuthorityAdministration
Delegate AuthorityAdministration
Use the Admin_Delegation.template to implement the business process
that allows an administrator to delegate one or more of a managers roles (the
Switch Roles feature) to other individuals in Timekeeper. The administrator can
use the managers existing delegates or can add new ones to the managers list.
The administrator, acting as the manager (or delegator), uses this template to
create a delegation, which consists of the name of an individual, or delegate, a
duration of time for the delegation, and the role that has been assigned to the
delegate.
Description
1. An administrator selects this template from the Actions list.
2. The system displays a form that contains a drop-down list of all managers in
the system. The administrator selects a manager, or delegator, on whose
behalf the administrator will create, cancel, or delete delegations.
3. The system displays a form that allows the administrator to either create a
new delegation or delete an existing delegation.
a. If the administrator chooses to delete an existing delegation, the system
displays a form with a list of existing delegations that the administrator
can select and delete. The system then displays a confirmation message
and sends notification messages to both the delegate who is associated
with the deleted delegation and the manager of that delegate.
b. If the administrator chooses to create a new delegation, the system
displays a form in which the administrator can select the name of a
delegate from a drop-down list, assign a role to the delegate, and specify
the range of time (start and end dates) during which the delegate will be
authorized to perform the tasks that are associated with the assigned role.
4. If the administrator creates a new delegation, the system does the following:
47
Chapter 1
a. Sends notification messages to both the delegate and the delegates

manager, and adds the delegation request (to accept or decline the
delegation) to the tasks list in the delegates Inbox.
b. Adds a delegation cancellation task to the administrators Inbox. The
administrator can use this task to cancel the delegation request if the
delegate has not yet accepted it. If the administrator opens this task and
completes the form, the system sends a notification message about the
cancellation to the delegate and removes the delegation request from the
tasks list in the delegates Inbox.
5. The delegate opens the delegation request task in the Inbox and uses the form
to either accept or decline the request:
a. If the delegate accepts the request, the system sends notification messages
to both the administrator and the delegates manager, and will display the
Switch Roles option on the main suite window of the delegates browser
when that delegation becomes active (based on the start date).
b. If the delegate declines the request, the system sends notification
messages to both the administrator and the delegates manager, and
removes the delegation request from the tasks list in the delegates Inbox.
days, the system sends a notification message to the administrator who
initiated the request.
activate this template in the system.
48
Request Manager Cancel Time Off Request

Use RM_CancelTimeOffRequest.template.xml to automate the
process that allows employees to cancel a previously submitted Time Off Request
from their Actions list. Canceling from a 4500 or InTouch timeclock is not
supported.
RM_CancelTimeOffRequest.template.xml includes the columns LeaveStartDate,
LeaveEndDate, and Leave Type. Also, the Approve and Reject actions appear in
Request Manager.
Description
1. An employee submits a form requesting to cancel time off that was previously
planned and approved. The employee provides the required information about
the Time Off Request.
successfully submitted. The manager sees the request in Request Manager.
3. The manager uses Request Manager to open the Cancel Time Off request
form from the employee and then either approves or rejects the request.
If the request is approved, the employees schedule is updated and a

confirmation message is sent to the employee as well.

49
Chapter 1

Properties.
AccrualName1
AccrualName2
AccrualName3
Sick (be sure that the accrual name exactly matches the accrual code name
used by your organization). Press Enter after each entry.
4. Click OK.
50

previously, after you remove references to them from the forms, you must remove
51
Chapter 1
Previously Approved Request

Use PreviouslyApproved_GTOR_VAL.template.xml to verify that an
employees global time-off request has not already been approved. If a previous
approved request is found, feedback is instantaneously sent back to the employee.
There is a time limit placed on the additional validation to ensure system
efficiency. You configure how the request is handled if the timeout is reached.
Description
2. If previously approved request is found, feedback is sent back to the employee
on the request UI. The employee can then edit the request and resubmit.
3. If a previously approved request is not found, the request is moved on to the
first reviewer, which in most cases is the manager.
4. There is a time limit placed on the validation to ensure system efficiency. You
configure how the request is handled if the timeout is reached.
Implementation Requirements
Defining the new process management template
To specify the process manager template settings:
1. As the system administrator, go to Setup > Process Management > Process
Templates.
2. Highlight the template you want to use and click Edit.
3. Use the table below to complete the fields.
52
For
Enter, Select or Check
Start Effective
The date you want to start the additional validations.
End Effective
Forever or the date you want to end the validations.
Previously Approved Request
For
Description
A brief description of the template.
Status
Active - to activate the template.

Inactive - to make the template inactive.
Action List
Select whether to Show or Hide the template in the

employees or managers My Actions list.
Display Name
The visible name of the template <<where is it visible?>>.
Max Pool Size
The maximum pool size for the template. Use a pool to avoid
the time it takes to initiate a process. If you do not want to use
a pool, enter a 0 (zero).
Template Categories
Validation to make the template available for the request

subtype.
4. Click Save.
For more information, see Using Request Manager Process Templates on page
61 or Activating a process template on page 134.
Adding violation settings to the Global Time-Off Request
1. Select Setup > Employee Self Service > Request Subtypes.
2. Check the Global Time-off Request subtype you are using and click Edit, or
create a new request subtype Configuring global time-off requests on page
542.
3. Enter information in the following fields:
Validation Process Template - select the process manager template you

want to use.
Validation Timeout (seconds) - enter the maximum amount of time you

want to spend processing the validation.Valid values are 0-999. The
default is 1 second and is defined in global.gtor.Validation.Timeout in
system settings.
Fail Validation on Timeout - check to display an error message when the

timeout occurs.
Uncheck to skip the extra validation and send the request to the first
reviewer when the timeout occurs.
53
Chapter 1
4. Click Save.
54
Previously Submitted Time Off Request

Use PreviouslySubmitted_GTOR_VAL.template.xml to verify that
an employees global time-off request has not already been submitted. If a
previous request is found, feedback is instantaneously sent back to the employee.
The employee can then make adjustments to the request before the request is sent
to the manager.
Description
2. If previously submitted request is found, feedback is sent back to the
employee on the request UI. The employee can then edit the request and
resubmit.
3. If a previously submitted request is not found, the request is moved on to the
first reviewer, which in most cases is the manager.
Templates.
55
Chapter 1

For
Start Effective
End Effective
Description
Status

Action List

Display Name
Max Pool Size
Template Categories

subtype.
4. Click Save.
542.
56

want to use.

system settings.

timeout occurs.
4. Click Save.
57
Chapter 1
Insufficient Balance Time Off Request

Use InsufficientBalance_GTOR_VAL.template.xml to verify that
an employee has enough time accrued to support a time off request. If an
insufficient balance is found, feedback is instantaneously sent back to the
employee. The employee can then make adjustments to the request before the
request is sent to the manager.
Description
2. If an insufficient balance is found, feedback is sent back to the employee on
the request UI. The employee can then edit the request and resubmit.
3. If the accrued time off is equal to or more than the time reqeusted, the request
is moved on to the first reviewer, which in most cases is the manager.
Templates.
58
Insufficient Balance Time Off Request

For
Start Effective
End Effective
Description
Status

Action List

Display Name
Max Pool Size
Template Categories

subtype.
4. Click Save.
542.

want to use.

system settings.
59
Chapter 1

timeout occurs.
4. Click Save.
60
Chapter 2
Using Request Manager Process Templates
Request Manager enables managers to review and act on employee requests,

including:
Time-off, overtime, and open shift sign-up requests from Process Manager.
Time off and open shift from My Requests.
Some of the default Timekeeper and platform Process Manager templates were
modified to support the workflow for the requests that appear in Request
Manager. Although the new templates are essentially the same as the default
templates of the same name, the following changes were made in the Request
Manager templates:
An RM_ADDINFO attribute has been added. It lists all the attributes from the
template that appear as columns in Request Manager.
An RM_ACTIONS attribute has been added to expose actions that are

available in the form. These actions appear as buttons in Request Manager.
An RM_START_DATE attribute has been added so that a Request Date

column can be populated with the applicable request date. For certifications
maintenance, the request date is the date that the certification started.
Welcome and thank you forms have been removed so that one-click approvals
or rejections are possible.
This chapter provides a brief description of the following templates that were
modified for Request Manager:
Request Manager Time Off Request on page 63
Request Manager Time Off Request (4500 timeclock) on page 65
Request Manager Cancel Time Off Request on page 68
Request Manager Overtime Request on page 70
Chapter 2
Request Manager Shift Swap on page 72
Request Manager Sign Up for Open Shifts on page 75
Request Manager Request Open Shifts on page 77
Request Manager New Hire Decision/Announcement on page 79
Request Manager Employee Awards on page 81
Request Manager Disciplinary Action on page 83
Request Manager Termination Announcement on page 86
Request Manager Training Registration on page 89
Request Manager Request to Cover on page 92
Request Manager Request to Cover Shift on page 94
Request Manager Delegate AuthorityAdministration on page 97
Request Manager Delegate AuthorityManager on page 100
For information about making changes to templates for Request Manager, see
Updating process templates for Request Manager on page 104.
For information about implementing templates, see Implementing a process
template on page 8.
62
Request Manager Time Off Request
Request Manager Time Off Request

Use RM_TimeOffRequest.template.xml to automate the process that
allows employees to request time off for a vacation day, personal day, floating
holiday, or related events. Employees can make this request from their Actions
list.
running Scheduler. An employees request form is verified to ensure no rules have
been violated before the manager approves the form.
Description
2. If there are no accrual violations, or if your site is not running Scheduler, the
employee either receives a message that the form has been successfully
submitted or a form appears that asks the employee to specify his or her
unavailable period. After the Unavailability form is completed, the employee
receives a message that the form has been successfully submitted The
manager sees the request listed in the Request Manager Alerts icon Request
list or when the Time Off Request list in the Request Manager grid is
refreshed.
If there are accrual violations, a form appears that shows those violations. If
your site is running Scheduler, schedule rule violations are shown as well.
3. The manager uses Request Manager to open the Time Off Request form from
the employee and then either approves or rejects the request. In Scheduler, the
manager might be presented with any rules violations.
The manager can approve the request and specify an Override Shift and
schedule is updated and a confirmation message is sent to the employee.
The manager can reject the request, provide comments, and send a
63
Chapter 2
Modifications for Request Manager
The following columns were added to this template for Request Manager:
EndDate
Hours Per Day
Request Type
The Approve and Reject actions were exposed.
Before you deploy this process template, you might need to make some
modifications for accruals to ensure that the template works correctly for your
organization. See Modifying accrual attributes on page 102.
64
Request Manager Time Off Request (4500 timeclock)

Use RM_TimeOffRequest_4500.template.xml to automate the process
that allows employees to use the 4500 timeclock to request time off. This process
template uses the Smart View transaction capability, which is delivered with the
4500 timeclocks. For more information about configuring Smart View
transactions, see the System Administrators GuideD ata Collection.
Note: When you activate this template in the suite, you must select Hide (instead
of Show) for the Action List option. This ensures that this template does not
appear in the employees Actions list, because it cannot be launched from the
Actions list. For more information about the Process Templates editor, see the
core Process Manager Programmers Guide.
Description
1. An employee submits a request for time off on a 4500 timeclock and specifies
dates as well as the number of days.
2. The employee receives a message that the request has been successfully
submitted. The manager sees the request in Request Manager.
3. In Request Manager, the manager opens the time off request.
The manager can approve the request and specify an Override Shift and
schedule is updated and a confirmation message is sent to the employee
(which the employee can read on the 4500 timeclock).
The manager can reject the request, add comments about the rejection,
and send a message to the employee, which the employee can read on the
4500 timeclock.
65
Chapter 2
Leave Type
To Date
Hours Type
Comment
The Yes and No actions were exposed.
Modify the RM_TimeOffRequest_4500.template.xml template so that
it has the same name as the original template. The 4500 timeclock will not accept
a name other than TimeOffRequest_4500.template.xml.
Before you deploy this template:
1. Move the original template to another directory.
2. Rename the RM template from
RM_TimeOffRequest_4500.template.xml to
TimeOffRequest_4500.template.xml.
3. Save the template and then deploy it.
In addition, the RM_TimeOffRequest_4500.template.xml template
uses a default value for theScheduleDisplayStartTime attribute in the Managers
form. (This was done so that Request Manager can use Single Click Approve.)
You might want to set your own default value for the ScheduleDisplayTime
attribute.
Before you deploy this process template, you might also need to make some
Required for All Templates in the core Process Manager Programmers Guide
66
Optional modifications
For information about optional modifications, see Optional modification on
page 14.
67
Chapter 2

Use RM_CancelTimeOffRequest.template.xml to automate the
process that allows employees to cancel a previously submitted Time Off Request
and remove if from their Actions list. Canceling from a 4500 timeclock is not
supported.
Description
How this process works:
1. An employee submits a request to cancel time off that was previously planned
and approved. The employee provides the required information about the
request.
successfully submitted. The manager sees the request in Request Manager.
3. The manager uses Request Manager to open the Cancel Time Off request.
If the manager approves the request, the employees schedule is updated

and a confirmation message is sent to the employee.
If the manager rejects the request, the manager provides comments and
sends a message to the employee.
68
The following columns were added in Request Manager:
Leave Start Date and Leave End Date
Leave Type
Required for All Templates in the core Process Manager Programmers Guide
69
Chapter 2
Request Manager Overtime Request

Use RM_OvertimeRequest.template.xml to automate the process that
allows employees to request overtime from one or more approvers.
Description
1. An employee submits a form requesting overtime approval.
2. The employee receives a message that the form has been successfully
submitted, or an error message indicating that there are no approvers in his or
her People record. The request process ends.
3. The first (or only) approving manager sees the request listed in the Request
Manager Alerts icon Request list or when the Overtime Request list is
refreshed in the Request Manager. (The manager also receives an Inbox
message that the request has been added to his or her task list.)
4. The approving manager opens the overtime request in Request Manager.
The manager can simply approve the request or view the request details,
modify the approved hours, add approver notes, and then approve the
request. The employees schedule is updated and a confirmation message
is sent to the employee.
The manager can reject the request, provide comments, and send a
5. If there is more than one approval required, the request goes to the next
approving managers request list in Request Manager. The employee is
notified that the message was approved by the first approving manager and
has gone to the next.
70
The following columns were added to this template for Request Manager.
Start Time
Amount
Request Manager Overtime Request
71
Chapter 2
Request Manager Shift Swap

Use RM_ShiftSwap.template.xml to automate the process that allows two
employees to swap shifts.
Description
1. Employee A starts the process by selecting Swap Shift in the Actions list.
2. The system displays the My Shift version of the Shift Swap Request form.
Employee A specifies the date and length of the shift to swap out and then
clicks Next.
3. The system displays the Other Persons Shift version of the Shift Swap
Request form, which also includes the previously entered My Shift
information. Employee A specifies the date and length of the shift that he or
she wants to swap for, selects the name of an employee (Employee B) who is
qualified to swap shifts with Employee A, and then clicks Next.
Note: This process template uses the following criteria and restrictions to
calculate which employees (Employee B, the person who will receive the shift
swap request from Employee A) qualify to appear in the drop-down list that is
attached to the Name field of this request form:
72
If Employee A is a Scheduler employee, Employee Bs shift must include

Employee As primary job, or Employee As job transfer set must include
the job that is associated with Employee Bs shift.
If Employee A is a Timekeeper employee, Employee Bs shift must

include Employee As labor account, or Employee As labor level transfer
set must include the labor account that is associated with Employee Bs
shift.
Request Manager Shift Swap
Both employees must have the same product licenses. For example, if
Employee A has a Scheduler license, Employee B must also have a
Scheduler license.
The shifts that are being swapped must be the same length. For example,
if Employee A wants to swap a 6-hour shift and Employee B has an
8-hour shift available on the selected day, Employee Bs name will not
appear in the drop-down list of employees who are qualified to receive the
request to swap shifts.
4. If there are validation errors, the system displays a form with that information
and gives Employee A the option of trying again, canceling the request, or
sending the request, depending on the type of rule violations. If there are no
validation errors, Employee A clicks Save & Close to continue the process.
5. Employee B receives a notification message requesting a shift swap and uses
a form to either accept or decline the request:
If Employee B accepts the request, a notification message is sent to the

manager and Employee A. Both of their schedules are then updated.
If Employee B accepts the request but that request contains rule

violations, the manager of both employees receives a notification
message. (If the two employees report to different managers, the process
template contains conditional logic and approval form tasks to
accommodate that scenario as well; both managers receive notifications.)
If Employee B declines the request, Employee A receives a notification

message.
6. If the manager (or managers) that a shift swap request contains rule violations,
the manager approves or rejects the request in Request Manager.

confirmation message. Their schedules are then updated.
If the manager rejects the request, both employees receive a rejection

message. The manager can add a comment about why their request was
rejected.
73
Chapter 2
Employee Name
Date
Start Time and End Time
Employee Name (2)
Start Time (2) and End Time (2)
might not be able to update the employee schedule. Check with the system
74
Request Manager Sign Up for Open Shifts
Request Manager Sign Up for Open Shifts

Use RM_OpenShiftSignUp.template.xml to automate the process that
allows employees to apply for shifts during their unscheduled time.
Note: The OpenShiftSignup process creates a new shift for an employee who
requests one. The process is not aware of existing open shifts. If you are using
only Timekeeper, use this template.
If you are using Scheduler, use RequestOpenShifts.template.xml,
which checks schedule rules and returns any schedule rule violations. See
Request Manager Request Open Shifts on page 77.
Description
1. An employee submits a request to sign up for an open shift. The request form
Shift Date
Shift Start time
Shift End time
Comments
2. The employee receives a message confirming that the request is in the system.
3. The manager receives the request in Request Manager.
If the manager approves the request, the employee receives a

confirmation message and that employees schedule is updated with the
new shift information.
If the manager rejects the request, the employee receives a message

indicating that the request was rejected and why.
75
Chapter 2
Shift Start Time
Shift End Time
76
Request Manager Request Open Shifts
Request Manager Request Open Shifts

Use RM_RequestOpenShifts.template to automate the process that
allows employees to apply for open shifts. This template checks schedule rules
and returns any schedule rule violations. You can continue with your request or
correct the violations.
Note: This is the advanced version of the
RM_OpenShiftSignup.template. It is designed for sites running
Scheduler. It checks the request for schedule rule violations. If you are using only
Timekeeper, use the OpenShiftSignUp template.
Description
1. An employee submits a request to sign up for an open shift. The request form
Shift Date
Shift Start time
Shift End time
Comments
The system validates each employee selection and checks for rule violations.
If there are no open shifts available for the date or times, the request is not
processed and the employee is notified. If there are rule violations of Warning
or Information level, the employee has the option to submit the request with
the rule violations.
2. If the system accepts the request, the employee each receives a message
confirming that the request is in the system, and the manager sees the request
in Request Manager.
77
Chapter 2
3. The manager opens the request. The manager can recheck the request for rule
violations. If no No Save rule violations occur, the manager can either
approve or reject the open shift sign-up request.
If the manager approves the request, the employee receives a confirmation
message, and the system updates that employees schedule with the new shift
information. If the Remove Existing Shifts check box on the Approve Shift
dialog box is selected, the existing shift is removed from the schedule.
If the manager rejects the request, he or she can enter a reason for the
rejection, and the employee receives a message indicating that the request was
rejected and why.
Open Shift
Shift Job
Start Time and End Time
End Date
78
Request Manager New Hire Decision/Announcement
Request Manager New Hire Decision/Announcement

Use RM_NewHireDecisionandAnnouncement.template.xml to
automate the approval and implementation process for hiring a new employee.
Description
1. The hiring manager submits a request to the senior manager asking to hire a
new employee.
2. The senior manager either approves or rejects the request:
If the new hire request is rejected, the hiring manager receives a

notification.
If the request is approved, the hiring manager receives a notification of

the approval with comments from the senior manager. The Human
Resources (HR) contact receives a notification about the new hire request
and is assigned a corresponding task.
3. The hiring manager sends a form to the appropriate Human Resources

contact.
4. The HR contact sends a confirmation message to the hiring manager, which
includes the candidates start date and salary information plus comments.
If the candidate does not accept the offer, the hiring manager receives a
message with comments from HR, and the process finishes.
5. If the candidate accepts the offer, the hiring manager sends requests to the
Facilities Administrator and the IT Administrator to set up access profile to
applications, any hardware and software equipment, office configuration, and
badge/access cards. The actual addition of the new hire is done outside the
process.
6. Both the Facilities Administrator and the IT Administrator send messages
when they have completed their tasks.
79
Chapter 2
Applicants Last Name
Applicants First Name
Before you deploy the template, specify the following individuals in the process
properties sheet: HR Administrator, IT Administrator, and Facilities
Administrator.
Properties.
4. Repeat steps 2 and 3 for the IT Administrator and Facilities Administrator.
5. Click OK.
The individuals identified as HR Administrator, IT Administrator and Facilities
Administrator must have access to the suite functions required for this process,
such as Inbox, My Actions, Actions, and Tasks. For more information, see
Configuring Process Manager in the core System Administrators Guide.
80
Request Manager Employee Awards
Request Manager Employee Awards

Use RM_EmployeeAward.template.xml to automate the approval process
that allows managers to give company awards to employees.
Description
1. A manager who wants to recommend an employee for a performance award
submits a form to a senior manager that includes the reason and the suggested
type of award.
submitted.
3. The senior manager opens the request in Request Manager.
If the senior manager approves the award, the HR Administrator and the
manager who submitted the request each receive a notification.
If the senior manager rejects the award request, the manager who
submitted the request receives a notification message with comments
from the senior manager.
Employee Chosen
Award Chosen
Type of Award
81
Chapter 2
Edit list of awards
Edit the list of awards found on the Employee Award Form task to reflect the
names of the awards that are specific to your organization. (Right-click on the
Employee Award form in the Graphical View and select Task Properties.)
82
Request Manager Disciplinary Action

Use RM_DisciplinaryAction.template.xml to automate the approval
and tracking process for initiating disciplinary action with an employee.
Description
1. The manager submits a disciplinary actions form to the senior manager.
submitted.
3. The senior manager reviews the request in Request Manager.
If the senior manager approves the request, the HR Administrator and the
manager who submitted the request each receive a notification message.
If the senior manager rejects the request, the manager who submitted the
request receives a notification message with comments from the senior
manager.
4. If the request is approved, the HR Administrator receives the form and

reviews the request.
If the HR Administrator approves the request, the manager receives a

notification message from the HR Administrator with the suggested
course of action (written or verbal disciplinary action, for example).
If the HR Administrator rejects the request, the manager receives a

notification message from the HR Administrator with reasons for the
rejection.
Employee
Action Chosen
83
Chapter 2
Specify an HR administrator
Specify an HR Administrator to receive messages during the disciplinary actions
process:
1. Open the template in Process Designer, and then select Edit > Process
Properties.
3. In the Default Value column, enter the employee ID for the HR Administrator,
and then press Enter.
4. Click OK.
Edit list of disciplinary actions
Edit the list of disciplinary actions to reflect the names of the disciplinary actions
that are specific to your organization. (In the Graphical View, right-click on
form_DisciplinaryActionForm, and then select Process Properties. On the Forms
tab, select Disciplinary_Action_for_Employee, and then click Edit to make the
changes.)
84

85
Chapter 2
Request Manager Termination Announcement

Use RM_TerminationAnnouncement.template.xml to automate the
approval and tracking process for terminating an employee.
Description
1. he manager initiates the termination announcement process by clicking the
TerminationAnnouncement link in the managers suite or manager selfservice Actions list.
2. In the Termination Announcement Request form, the manager provides the
following information and then submits the form:
Employee name
Termination date
Reasons for the termination
3. After the manager submits the form:
A notification message is sent to the manager who submitted the form,

stating that the Termination Announcement Request has been sent to his
or her manager.
The managers manager or senior manager receives a request in Request

Manager called TerminationAnnouncment.
4. The managers manager or senior manager selects the request, reviews the
details, either approves or rejects the termination request, which removes it
from the request list.
5. The manager who submitted the Termination Announcement Request
receives a notification message stating whether the request was approved or
rejected by the senior manager and why.
86
Request Manager Termination Announcement
6. If the managers manager or senior manager approves the termination

announcement request:
The HR Administrator receives a notification message stating that a

manager has requested a termination announcement for a particular
employee.
The HR Administrator receives a notification message stating that the

senior manager has approved the Termination Announcement Request. A
task for the HR Approve/Reject Termination Announcement Form is sent
the HR Administrator task list.
7. The HR Administrator completes the termination paperwork with the

manager. (This is outside the business process.) The HR Administrator then
selects the TerminationAnnouncement, HR Approve/Reject Termination
Announcement Form from his or her Tasks list and either approves or rejects
the request.
8. The manager who submitted the termination request receives a notification
message stating that the HR Administrator has either approved or rejected the
termination announcement request.
9. If the HR Administrator approves the request for termination announcement,
then a notification message is sent to the manager and to the Facilities
Administrator, IT Administrator, and Payroll Administrator. The message
tells each administrator to review his or her task list for a termination
announcement request task that each must complete.
10. The HR Administrator and the manager who submitted the initial Termination
Announcement Request Form each receive a notification message notifying
them that the Payroll Administrator, the IT Administrator, and the Facilities
Administrator have completed their termination of employment activities.
The following column was added to this template for display in Request
Manager:
Employee Chosen
87
Chapter 2
Before you deploy this process template, specify an HR Administrator, Facilities
Administrator, IT Administrator, and Payroll Administrator to receive messages.
Properties.
4. Repeat steps 2 and 3 for the Facilities, IT, and Payroll administrators.
5. Click OK.
88
Request Manager Training Registration

Use RM_TrainingRegistration.template.xml to automate the
approval process for employees who want to sign up for training.
Description
1. An employee who wants to attend a training course submits a request for
approval form to the manager.
2. The manager receives the training request in Request Manager.
If the manager approves the request, the training coordinator receives a

notification message.
If the manager rejects the request, the employee receives a notification

message with comments.
3. The training coordinator either approves or rejects the training request:
If the training coordinator approves the request (for example, the course
has not reached capacity), the employee receives a confirmation message
and the employees schedule is updated.
If the training coordinator rejects the request (for example, the course has
reached capacity), the employee receives a notification message.
Training Course Name
Course End Date
Skills Gained
Course Hours Per Day
Course Cost
Certification to be Gained
89
Chapter 2
Specify a Training Administrator
To specify a training administrator to receive notifications during the process:
Properties.
2. On the Attributes tab, select the row for TrainingAdministrator.
your Training Administrator and then press Enter.
4. Click OK.
Modify the LeaveType attribute
You must change the LeaveType attribute so that the correct Leave Type names
are used in the forms and notification messages. If you do not set the LeaveType
to the pay code that will be used to track the training time, the process will fail.
1. With the template open in Process Designer, select Edit > Process Properties
from the menu bar.
2. On the Attributes tab, replace the value in the Default Value column for the
LeaveType attribute with the value that your organization uses.
3. Click OK.
90
91
Chapter 2
Request Manager Request to Cover

Use RM_RequestToCover.template.xml to automate the process that
allows one employee to work another employees shift to provide coverage if an
employee cannot work.
Note: The advanced version of this template for sites running Scheduler is
RequestToCoverShift.template.xml.
Description
1. Employee A submits forms specifying the date, shift, and name of Employee
B, requesting that Employee B cover Employee As shift. A confirmation
notification message is sent to Employee A.
2. Employee B receives the request to cover Employee As shift in his or her
Inbox and either accepts or declines the request:
If the request is accepted, the form is sent to the manager.
If the request is declined, Employee A receives a message stating that the

request was declined.
coverage request in Request Manager and either approves or rejects the swap.
(The template supplied with the product is configured for one manager.)
(The process template contains conditional logic and approval form tasks for
the possibility of the employees reporting to different managers, as well.)
4. If the manager or managers approve the request, both employees receive a
confirmation message and their schedules get updated with the new shift
information.
If the manager or managers reject the request, both employees receive a
message indicating why the coverage request was rejected.
92
Request Manager Request to Cover
Shift Date
Shift Start Time and Shift End Time
Hours Type
93
Chapter 2
Request Manager Request to Cover Shift

Use RM_RequestToCoverShift.template to automate the process that
allows one employee to work another employees shift to provide coverage if an
employee cannot work. This template checks schedule rules and returns any
schedule rule violations. You can continue the request or correct the violations.
Note: This is the version of the template for sites running Scheduler. It checks the
request for schedule rule violations. If you are using only Timekeeper, use
RM_RequestToCover.template.xml.
Description
1. Employee A fills out a form requesting that Employee B cover Employee As
shift. The system validates that the selected open shift exists and that
Employee B is qualified to work the shift.
The system also checks for rule violations. If there are rule violations of
Warning or Information level, the employee can submit the request with the
rule violations.
2. Employee B receives the request to cover Employee As shift.
If employee B rejects the request, Employee A receives a message stating

that the request was rejected. Employee A has the option to submit
another request or exit.
If employee B approves the request, the form is sent to the manager or

managers of both employees.
coverage request in Request Manager, reviews the relevant information about
the two employees.
If each employee has a different manager, each manager receives the shift
coverage request (If both managers are configured to use Request Manager).
94
Request Manager Request to Cover Shift
(The default template is configured for one manager. To modify the template
to add a second manager, see Adding a Second Approver in the core
Process Manager Programmers Guide.)

confirmation message and the system updates their schedules with the
new shift information.
If the manager rejects the request, both employees receive a message

indicating why the coverage request was rejected.
Shift Date
Shift Start Time and Shift End Time
Hours Type
Manager Programmers Guide.
95
Chapter 2
might not be able to update the employee schedule.
Check with the system administrator to make sure the following property in the
Global Values system settings is set to 0:
96
Request Manager Delegate AuthorityAdministration

Use RM_Admin_Delegation.template to implement the business process
that allows an administrator to delegate one or more of a managers roles (the
Switch Roles feature) to other individuals in Timekeeper. The administrator can
use the managers existing delegates or can add new ones to the managers list.
The administrator, acting as the manager (or delegator), uses this template to
create a delegation, which consists of the name of an individual, or delegate, a
duration of time for the delegation, and the role that has been assigned to the
delegate.
Description
1. An administrator selects this template from the Actions list.
2. The system displays a form that contains a drop-down list of all managers in
the system. The administrator selects a manager, or delegator, on whose
behalf the administrator will create, cancel, or delete delegations.
3. The system displays a form that allows the administrator to either create a
new delegation or delete an existing delegation.
a. If the administrator chooses to delete an existing delegation, the system
displays a form with a list of existing delegations that the administrator
can select and delete. The system then displays a confirmation message
and sends notification messages to both the delegate who is associated
with the deleted delegation and the manager of that delegate.
b. If the administrator chooses to create a new delegation, the system
displays a form in which the administrator can select the name of a
delegate from a drop-down list, assign a role to the delegate, and specify
the range of time (start and end dates) during which the delegate will be
authorized to perform the tasks that are associated with the assigned role.
4. If the administrator creates a new delegation, the system does the following:
97
Chapter 2
a. Sends notification messages to both the delegate and the delegates

manager, and adds the delegation request (to accept or decline the
delegation) to the tasks list in the delegates Inbox and Request Manager.
b. The administrator can use Request Manager to cancel the delegation
request if the delegate has not yet accepted it. If the administrator cancels
the task in Request Manager, the system sends a notification message
about the cancellation to the delegate and removes the delegation request
from the tasks list in the delegates Inbox and the administrators Request
Manager grid.
5. The delegate opens the delegation request task in Request Manager and either
accepts or declines the request:
a. If the delegate accepts the request, the system sends notification messages
to both the administrator and the delegates manager, and displays the
Switch Roles option on the main suite window of the delegates navigator
when that delegation becomes active (based on the start date).
b. If the delegate declines the request, the system sends notification
messages to both the administrator and the delegates manager, and
removes the delegation request from the tasks list in the delegates Inbox.
days, the system sends a notification message to the administrator who
initiated the request.
Requirements for Request Manager
98
Delegator
Delegate
Role
End Date
The Accept Delegation and Decline Delegation actions were exposed.
activate this template in the system.
99
Chapter 2
Request Manager Delegate AuthorityManager

Use RM_Mgr_Delegation.template to implement the business process
that allows a manager to delegate one or more roles (the Switch Roles feature) to
other individuals in Timekeeper.
The manager, or delegator, uses this template to create a delegation, which
consists of the name of an individual, or delegate, a duration of time for the
delegation, and the role that has been assigned to the delegate.
Description
1. A manager selects this template from the Actions list.
2. The system displays a form that allows the manager to either create a new
delegation or delete an existing delegation.
If the manager chooses to delete an existing delegation, the system

displays a form with a list of existing delegations that the manager can
select and delete. The system then displays a confirmation message and
sends a notification message to the delegate who is associated with the
deleted delegation.
If the manager chooses to create a new delegation, the system displays a

form in which the manager can select the name of a delegate from a
drop-down list, assign a role to the delegate, and specify the range of time
(start and end dates) during which the delegate will be authorized to
perform the tasks that are associated with the assigned role.
3. If the manager creates a new delegation, the system does the following:
100
Sends a notification message to the delegate and adds the request (to
accept or decline the delegation) to the tasks list in the delegates Inbox
and Request Manager.
Adds a delegation cancellation task to the managers Inbox and in

Request Manager. The manager can cancel the delegation request if the
delegate has not yet accepted it. If the manager cancels the request, the
system sends a notification message about the cancellation to the delegate
Request Manager Delegate AuthorityManager
and removes the delegation request from tasks list in the delegates Inbox
and in Request Manager.
4. The delegate opens the delegation request in Request Manager and either
accepts or declines the request:
If the delegate accepts the request, the system sends a notification

message to the manager and displays the Switch Roles option in the
delegates navigator (based on the start date).
If the delegate declines the request, the system sends a notification

message to the manager and removes the delegation request from the
request list in Request Manager.
Note: If the delegate does not respond to the request within three days, the
system sends a notification message to the manager who initiated the request.
The following columns were added for Request Manager:
Delegate
Role
End Date
The Accept Delegation and Decline Delegation actions were exposed.
activate the template in the system.
101
Chapter 2
Modifying accrual attributes

Properties.
AccrualName1
AccrualName2
AccrualName3
Sick. Press the Enter key after each entry.
Note: Be sure that the accrual name exactly matches the accrual code name
used by your organization. If an Accrual Rule is configured for the accrual
code, and you have selected the Transactions in increments check box on
the Taking Rules tab, make sure that the increments value on the employee
request form matches the increments value on the Taking Rules tab.
3. If your organization does not use certain accrual codes, select the rows with
the unneeded accrual code and accrual label and click Remove. Removing the
accrual codes and associate attributes for unnecessary accrual codes reduces
the amount of space required to store this process in the database.
102
Modifying accrual attributes
4. Click OK.
previously, after you remove references to them from the forms, remove
103
Chapter 2
Updating process templates for Request Manager

Use Process Designer to modify default Process Manager templates for use with
Request Manager. Modifying a template involves the following steps.
Selecting the template
Adding columns in Request Manager with template information
Viewing a Request Date in Request Manager
Exposing form actions in Request Manager
Removing welcome and thank you forms to ensure one-click approval/

rejection/etc.
Getting an approver for forms
Selecting the template

1. Log into Process Designer.
2. Select File > Open to open the appropriate template.
Adding columns in Request Manager with template information

1. Right-click on a blank space in the template workflow, and then select
Process Properties.
2. Click the Attributes tab.
3. Enter an attribute with the Attribute Name RM_ADDINFO and the Type
String.
4. Note: The name must be RM_ADDINFO exactly.
5. Click Add.
6. In the Default Value field, enter the additional fields that you want to appear
as columns in Request Manager.
a. To find available fields, right-click a manager form, and then select Task
Properties. View the form name.
104
b. Right-click on a blank space, and select Process Properties, and then

select the form you viewed.
c. Click Edit.
d. From Table - data_layout_table, drill down to Table - data_table
e. Find the folders with the attributes you want. Select that folder.
f.
Copy the Message Key field value in the Label section this is the
attribute key.
g. Copy the Name field value in the Text Field section this is the attribute
name.
7. Paste the copied attribute names into the Default Value field of
RM_ADDINFO.
The format of the fields in the Default Value field should be:
name:key;name:key;name:key
For example:
LeaveStartDate:i18n.Time_Off_Evaluation_form.label.label6;LeaveEndDate:
i18n.Time_Off_Evaluation_form.label.label7;LeaveType:i18n.Time_Off_Ev
aluation_form.label.label5)
8. After you add the fields needed for the additional columns, click Apply in the
Process Properties box to save your updates.
Viewing a Request Date in Request Manager

The Request Date field should represent the date on which the request is
applicable. For example, with a time-off request, the request date is the date on
which the employee has requested time off.
Note: The Request Date column is visible by default, but the Request date might
not be applicable to all templates. If the column is not applicable to the selected
template, an administrator can hide the Request Date column from view.
1. Right-click in a blank space in the template, and then select Process
Properties.
105
Chapter 2
2. Click the Attributes tab.

3. Find and copy the attribute name that best fits Requested Date.
4. Create a new attribute of Type String called RM_START_DATE.
5. Paste the copied attribute name into this field.
6. Click Apply, and then click OK.
Exposing form actions in Request Manager

1. Right-click a Manager Form. (You do not need to do this for Employee forms,
but you must do this for ALL manager forms.)
2. Select Task Properties. View the form name, and then click Cancel.
3. Right-click in any blank space in the template workflow and then select
Process Properties.
4. Click the form name that you just viewed, and then click Edit.
5. Expand Table - data_layout table, the drill down to and expand Table data_table.
6. Find the rows for the group of action buttons.
7. Find and copy the radio button control for the managers decision (such as
Decide, Mgr 1 Action, and so on).
8. Copy text from the keys for the labels of the action button as well.
9. In the Manager forms Task Properties, click the Attributes tab.
10. Add an attribute with the Name RM_ACTIONS with a Type of String.
11. Enter the name of the group of action buttons with equals. Then enter each
action name with the key for the action. Separate the actions with semicolons.
For example:
Decide=Approve:i18n.Time_Off_Evaluation_form.label.label19;Reject:i18n.
Time_Off_Evaluation_form.label.label20)
Note: If the actions include Recheck Rules, remove the Recheck Rules.
106
Removing the welcome and thank you forms

To ensure one-click approval/rejection:
1. Remove all Manager forms that contain Welcome, Thank You, Goodbye, etc.,
which have no data and would be superfluous in Request Manager. Do not
remove employee Welcome and Thank You forms.
2. To ensure that the workflow completes successfully, edit each of the last set of
forms (one or more forms, all at the same level, comprise a set). To edit the
last set of forms:
a. Right click on each Manager form, and then select Task Properties.
b. Select the Submit button mapping, and then click Edit.
c. Delete the handler, Save & Chain to Next.
d. Add the handler, Save, Set Task Done & Close Window.
e. Click Apply, and then click OK.
Getting an approver for forms

1. Find all Get Approver scripts.
2. Check all other scripts for references to Welcome or Thank You forms.
Note: You need to get a resource from Manager forms because the Welcome
Form is removed.
Use the following script to find approver if the Manager Welcome form is
removed from the TimeOffRequest template. It basically tries to find the
resource ID from four possible forms. Each template needs different code.
import com.dralasoft.workflow.*;
Workflow w = thisTask.getWorkflow();
Resource approver = w.getTask("Mgr Form - Specific
Hours - Reject/Recheck").getResource(); //Here you are
107
Chapter 2
getting the resource from the first manager form, Mgr Form Specific Hours
Reject/Recheck. Replace that name with whatever manager form you are
using.
if(approver == null){approver = w.getTask("Mgr Form
- Non Specific Hours - Reject/
Recheck").getResource(); //Here, replace the name with the next
manager form, and so on.
}
if(approver == null){
approver = w.getTask("Mgr Form Specific Hrs - Approve/Reject/
Recheck").getResource();
}
if(approver == null){
approver = w.getTask("Mgr Form - Non
Specific Hrs - Aprov/Reject/Recheck").getResource();
}
if (approver != null) {
w.setAttribute("Approver", approver.getName(),
java.lang.String.class);
w.setAttribute("ApproverId", approver.getId(),
java.lang.String.class);
}
Note: In forms that require two managers, make sure you are not linking
Manager 1 to Manager 2s tasks or vice versa.
108
Chapter 3
Timekeeper and Scheduler Extensions

to Process Designer
This chapter provides information about referencing the suite data retrieved by the
tasks used in the Timekeeper and Scheduler process templates.
This chapter contains the following sections:
Timekeeper and Scheduler API tasks on page 110
Timekeeper and Scheduler Processor tasks on page 174
Chapter 3
Timekeeper and Scheduler Extensions to Process Designer
Timekeeper and Scheduler API tasks

When you select File > Check for Extensions in Process Designer after installing
Timekeeper and Scheduler, the tasks listed in this chapter will be added to the
tasks available in Process Designer.
Accruals API task

The Accruals API task uses the AccrualData XML API tag to provide accrual
information. The following tables describe the Custom tab on the Accruals API
Properties Sheet. For more information about the AccrualData XML API tag, see
the Developers Toolkit Reference Guide for Timekeeper.
Accruals API task action: Get Accrual Data
The Load action returns one summary for each accrual code for the specified
employee and date.
Input for this action:
Employee
Description
Input Parameter
Current User
Person Number
Identifies the currently logged on user.

Person number of the current user.
Balance_Date
Balance_Date
Person_Number
Output for this action:

Output
XML Property
Accrual_Balance
AccrualBalances
Note: The AccrualBalances XML property contains a list of properties.

Consult the Developers Toolkit Reference Guide for Timekeeper for the complete
list. Example: The property is ProjectedVestedBalanceInTime. To get
the accrual balance for an employee:
${AccrualBalances[AccrualCodeName=${AccrualName1}].
ProjectedVestedBalanceInTime}
110
Eligible Jobs API task

The Eligible Jobs API task uses the EligibleJobs XML API tag to get all
open shifts for a specified date range.
The following tables describe the Custom tab on the Eligible Jobs API Properties
Sheet. For more information about the AccrualData XML API tag, see the
Developers Toolkit Reference Guide for Scheduler.
Eligible Jobs API task action: Load All
The LoadAll action returns all open shifts in the employees transfer set for the
specified date range.
Inputs for this action:
Employee
Description
Input Parameter
Current User
Start_Date
Person Number
Start_Date
Person_Number
Badge Number
Badge number of the current user.
Start_Date
Badge_Number
Employee Key
Employee database key of the current user.
Start_Date
Employee_Key
Person Key
Person database key of the current user.
Start_Date
Person_Key
User Key
Database key of the current user.
Start_Date
User_Key

Output
XML Property
Location_Item
LocationItem
111
Chapter 3
Jobs API task

The Jobs API task uses the SwapShiftJobs XML API tag to return the jobs
list for a shift.
The following tables describe the Custom tab on the Jobs API Properties Sheet.
For more information about the SwapShiftJobs XML API tag, see the
Jobs API task action: LoadJobs
The LoadJobs action returns one or more jobs for the shift within the specified
date and time span.
112
Employee
Description
Input Parameter
Current User
Query_Date
StartTime
EndTime
Person Number
Query_Date
StartTime
EndTime
Person_Number
Badge Number
Query_Date
StartTime
EndTime
Badge_Number
Employee Key
Employee database key of the current user. Query_Date

StartTime
EndTime
Employee_Key
Person Key
Query_Date
StartTime
EndTime
Person_Key
Employee
Description
Input Parameter
User Key
Query_Date
StartTime
EndTime
User_Key

Output
XML Property
OrgJob
OrgJob
Lead Time API task

The Lead Time API task uses the MinimumHoursNoModification XML
API tag to determine whether a swap shift is requested at an acceptable time. In
order to swap a shift, you must make your request before the shift start time. The
minimum number of hours in advance of the shift is determined according to
organizational rules. For example, if the minimum number of hours is 72, your
request must be made at least 72 hours before the start time of the shift.
The following tables describe the Custom tab on the Lead Time API Properties
Sheet. For more information about the MinimumHoursNoModification
XML API tag, see the Developers Toolkit Reference Guide for Scheduler.
Lead Time API task action: Load
The Load action returns whether the request is made at an acceptable time.
Query_Date
StartTime
113
Chapter 3

Output
XML Property
MinimumHoursNoModification
MinimumHoursNoModification
Open Shift Volunteer API task

The Open Shift Volunteer API task uses the OpenShiftVolunteer XML API
tag to assign a Scheduler licensed employee to an open shift.
The following tables describe the Custom tab on the Open Shift Volunteer API
Properties Sheet. For more information about the OpenShiftVolunteer
XML API tag, see the Developers Toolkit Reference Guide for Scheduler.
Open Shift Volunteer API task action: Get Open Shifts For Job
The GetOpenShiftsForJob action returns all open shifts for a specified job
within a specified date range.
QueryDate
OrgJobPath
Output
XML Property
OpenShiftItem
OpenShiftItem
Open Shift Volunteer API task action: Assign Open Shift Volunteer
The AssignOpenShiftVolunteer action assigns a person to an open shift.
The specified open shift must be a valid open shift. The specified employee must
be an active employee.
114

Employee
Description
Input Parameter
Current User
Identifies the currently QueryDateTimeSpan

logged on user.
PartialStartDate
PartialEndDate
PartialStartTime
PartialEndTime
OrgJobPath
IsSaveData
IsCheckRules
Person Number
Person number of the

current user.
QueryDateTimeSpan
PartialStartDate
PartialEndDate
PartialStartTime
PartialEndTime
OrgJobPath
IsSaveData
IsCheckRules
Person_Number
Badge Number
Badge number of the

current user.
QueryDateTimeSpan
PartialStartDate
PartialEndDate
PartialStartTime
PartialEndTime
OrgJobPath
IsSaveData
IsCheckRules
Badge_Number
Employee Key
Employee database key QueryDateTimeSpan

of the current user.
PartialStartDate
PartialEndDate
PartialStartTime
PartialEndTime
OrgJobPath
IsSaveData
IsCheckRules
Employee_Key
115
Chapter 3
Employee
Description
Input Parameter
Person Key
Person database key of QueryDateTimeSpan

the current user.
PartialStartDate
PartialEndDate
PartialStartTime
PartialEndTime
OrgJobPath
IsSaveData
IsCheckRules
Person_Key
User Key
Database key of the

current user.
QueryDateTimeSpan
PartialStartDate
PartialEndDate
PartialStartTime
PartialEndTime
OrgJobPath
IsSaveData
IsCheckRules
User_Key

Output
XML Property
RuleViolationItem
RuleViolationItem
Pay Code Edits API task

The Pay Code Edits API task uses the ScheduleHours XML API tag to
provide information about a schedule shift for a person, and allows it to be
overridden.
The following tables describe the Custom tab on the Pay Code Edits API
Properties Sheet. For more information about the ScheduleHours XML API
tag, see the Developers Toolkit Reference Guide for Scheduler.
116
Pay Code Edits API task action: AddOnly

The AddOnly action adds the pay code edit to the schedule, or overrides existing
scheduled hours with a pay code edit.
Employee
Description
Input Parameter
Current User
Identifies the currently logged Schedule_Start_Date

on user.
Schedule_End_Date
Pay_Code_Name
AmountInTime
DisplayTime
IsAllDays
IsCreateOpenShift
IsOverride
IsSaveData
IsCheckRules
UnavailableDuration
UnavailableStartTime
Person Number
Person number of the current

user.
Schedule_Start_Date
Schedule_End_Date
Pay_Code_Name
AmountInTime
DisplayTime
IsAllDays
IsCreateOpenShift
IsOverride
IsSaveData
IsCheckRules
UnavailableDuration
Person_Number
117
Chapter 3
118
Employee
Description
Input Parameter
Badge Number
Badge number of the current

user.
Schedule_Start_Date
Schedule_End_Date
Pay_Code_Name
AmountInTime
DisplayTime
IsAllDays
IsCreateOpenShift
IsOverride
IsSaveData
IsCheckRules
UnavailableDuration
Badge_Number
Employee Key
Employee database key of the Schedule_Start_Date

current user.
Schedule_End_Date
Pay_Code_Name
AmountInTime
DisplayTime
IsAllDays
IsCreateOpenShift
IsOverride
IsSaveData
IsCheckRules
UnavailableDuration
Employee_Key
Employee
Description
Input Parameter
Person Key
Person database key of the

current user.
Schedule_Start_Date
Schedule_End_Date
Pay_Code_Name
AmountInTime
DisplayTime
IsAllDays
IsCreateOpenShift
IsOverride
IsSaveData
IsCheckRules
UnavailableDuration
Person_Key
User Key
Database key of the current

user.
Schedule_Start_Date
Schedule_End_Date
Pay_Code_Name
AmountInTime
DisplayTime
IsAllDays
IsCreateOpenShift
IsOverride
IsSaveData
IsCheckRules
UnavailableDuration
User_Key
119
Chapter 3

Output
XML Property
RuleViolation
RuleViolation
AccrualViolation
AccrualViolation
ScheduleHoursDailyStatus
ScheduleHoursException
ScheduleHoursException
Pay Code Edits API task action: Cancel Time Off

The CancelTimeOff action removes the specified pay code edit.
120
Employee
Description
Input Parameter
Current User
Identifies the currently logged on Schedule_Start_Date

user.
Schedule_End_Date
Pay_Code_Name
AmountInTime
DisplayTime
IsAllDays
IsCreateOpenShift
IsOverride
IsSaveData
IsCheckRules
UnavailableDuration
Employee
Description
Input Parameter
Person Number
Person number of the current

user.
Schedule_Start_Date
Schedule_End_Date
Pay_Code_Name
AmountInTime
DisplayTime
IsAllDays
IsCreateOpenShift
IsOverride
IsSaveData
IsCheckRules
UnavailableDuration
Person_Number
Badge Number
Badge number of the current user. Schedule_Start_Date

Schedule_End_Date
Pay_Code_Name
AmountInTime
DisplayTime
IsAllDays
IsCreateOpenShift
IsOverride
IsSaveData
IsCheckRules
UnavailableDuration
Badge_Number
121
Chapter 3
122
Employee
Description
Input Parameter
Employee Key
Employee database key of the

current user.
Schedule_Start_Date
Schedule_End_Date
Pay_Code_Name
AmountInTime
DisplayTime
IsAllDays
IsCreateOpenShift
IsOverride
IsSaveData
IsCheckRules
UnavailableDuration
Employee_Key
Person Key
Person database key of the

current user.
Schedule_Start_Date
Schedule_End_Date
Pay_Code_Name
AmountInTime
DisplayTime
IsAllDays
IsCreateOpenShift
IsOverride
IsSaveData
IsCheckRules
UnavailableDuration
Person_Key
Employee
Description
Input Parameter
User Key
Database key of the current user. Schedule_Start_Date

Schedule_End_Date
Pay_Code_Name
AmountInTime
DisplayTime
IsAllDays
IsCreateOpenShift
IsOverride
IsSaveData
IsCheckRules
UnavailableDuration
User_Key

Output
XML Property
Request to Cover API task

The Request To Cover API task uses the RequestToCover XML API tag to
load all shifts for a specified employee and a query date.
The following tables describe the Custom tab on the Request To Cover API
Properties Sheet. For more information about the RequestToCover XML API
tag, see the Developers Toolkit Reference Guide for Scheduler.
Request to Cover API task action: Load Shifts
The LoadShifts action returns all shifts for a specified employee and a query
date.
123
Chapter 3

Employee
Description
Input Parameter
Current User
QueryDate
Person Number
QueryDate
Person_Number
Badge Number
QueryDate
Badge_Number
Employee Key
QueryDate
Employee_Key
Person Key
QueryDate
Person_Key
User Key
QueryDate
User_Key

Output
XML Property
RequestToCoverItem
RequestToCoverItem
Request to Cover API task action: Load Eligible Employees

The LoadEligibleEmployees action returns the names of eligible
employees who can work for the specified shift.
124

Employee
Description
Input Parameter
Current User
QueryDateTimeSpan
Person Number Person number of the current user.
QueryDateTimeSpan
Person_Number
Badge Number Badge number of the current user.
QueryDateTimeSpan
Badge_Number
Employee Key Employee database key of the current user. QueryDateTimeSpan

Employee_Key
Person Key
QueryDateTimeSpan
Person_Key
User Key
QueryDateTimeSpan
User_Key

Output
XML Property
Person
Person
Request to Cover API task action: Assign Cover Shift

The AssignCoverShift action assigns an employee to cover another shift.
125
Chapter 3
126
Employee
Description
Input Parameter
Current User
Identifies the currently

logged on user.
QueryDateTimeSpan
PartialStartDate
PartialEndDate
PartialStartTime
PartialEndTIme
IsSaveData
IsCheckRules
Covering_Employee_Person_Number
Person_Number
Person Number Person number of the

current user.
QueryDateTimeSpan
PartialStartDate
PartialEndDate
PartialStartTime
PartialEndTIme
IsSaveData
IsCheckRules
Person_Number
Badge Number Badge number of the

current user.
QueryDateTimeSpan
PartialStartDate
PartialEndDate
PartialStartTime
PartialEndTIme
IsSaveData
IsCheckRules
Badge_Number
Employee
Description
Input Parameter
Employee Key Employee database key of QueryDateTimeSpan

the current user.
PartialStartDate
PartialEndDate
PartialStartTime
PartialEndTIme
IsSaveData
IsCheckRules
Employee_Key
Person Key
Person database key of

the current user.
QueryDateTimeSpan
PartialStartDate
PartialEndDate
PartialStartTime
PartialEndTIme
IsSaveData
IsCheckRules
Person_Key
User Key
Database key of the

current user.
QueryDateTimeSpan
PartialStartDate
PartialEndDate
PartialStartTime
PartialEndTIme
IsSaveData
IsCheckRules
User_Key

Output
XML Property
RuleViolationItem
RuleViolationItem
127
Chapter 3
Qualified Employees API task

The Qualified Employees API task uses the SwapShiftEmployees XML API
tag to find employees who are qualified to work an open shift or to swap a shift
with another person.
The following tables describe the Custom tab on the Shift Builder API Properties
Sheet. For more information about the EligibleJobs XML API tag, see the
Qualified Employees API task action: Load Eligible Employees
The LoadEligibleEmployees action returns names of employees who are
qualified to work the selected shift.
128
Employee
Description
Input Parameter
Current User
QueryDate
StartTime
EndTine
ShiftSwapDate
Person Number
QueryDate
StartTime
EndTine
ShiftSwapDate
Person_Number
Badge Number
QueryDate
StartTime
EndTine
ShiftSwapDate
Badge_Number
Employee Key
QueryDate
StartTime
EndTine
ShiftSwapDate
Employee_Key
Employee
Description
Input Parameter
Person Key
QueryDate
StartTime
EndTine
ShiftSwapDate
Person_Key
User Key
QueryDate
StartTime
EndTine
ShiftSwapDate
User_Key

Input
XML Property
Response
Response
Resume API task

The Resume API task allows users to resume a suspended Global Time Off
request. This API is used exclusively for requests that have been configured to
invoke a custom Process Designer template between two states in the Global Time
Off request workflow. After the custom process completes, the Resume API
action allows the Global Time Off request to continue its workflow.
Resume API task action: Resume Request
The Resume Request action transitions a request from the Suspended state to
the next workflow state, according to the Request Transitions configuration..
Request Id The ID of the Global Time Off request in the database
QueryDateSpan The date range of the request.
PersonNumber The PERSONNUM identifier of the employee requesting the
time off.
129
Chapter 3

None
Schedule API tasks

The Schedule API provides the following tasks:
Schedule API task action: Schedule Pay Code Edit RangeAdd Schedule
Items on page 130
Schedule API task action: Schedule Pay Code Edit RangeRemove

Schedule Items on page 133
Schedule API task action: Swap Shifts on page 135
Schedule API task action: Cover Shift on page 136
Schedule API task action: Add Shift Segment on page 137
Schedule API task action: Schedule Pay Code Edit RangeAdd Schedule Items
The Add Schedule Items action of the Schedule Pay Code Edit Range API task
uses the Schedule API tag to add the specified items into the schedule for the
identified people and time period.
The following tables describe the Custom tab on the Schedule API Properties
Sheet. For more information about the Schedule XML API tag, see the
130

Group or
Employee
Description
Input Parameter
Group
Group associated with schedule.
Schedule_Start_Date
Schedule_End_Date
Pay_Code_Name
Display_Time
LaborAccountName
OrgJobPath
CommentText
OverrideShift
{Time | Currency}
Schedule_Group_Name
Current User
Schedule_Start_Date
Schedule_End_Date
Pay_Code_Name
Display_Time
LaborAccountName
OrgJobPath
CommentText
OverrideShift
{Time | Currency}
Schedule_Start_Date
Schedule_End_Date
Pay_Code_Name
Display_Time
LaborAccountName
OrgJobPath
CommentText
OverrideShift
{Time | Currency}
Person_Number
131
Chapter 3
Group or
Employee
Description
Input Parameter
Schedule_Start_Date
Schedule_End_Date
Pay_Code_Name
Display_Time
LaborAccountName
OrgJobPath
CommentText
OverrideShift
{Time | Currency}
Badge_Number
Employee Key Employee database key of the current user. Schedule_Start_Date

Schedule_End_Date
Pay_Code_Name
Display_Time
LaborAccountName
OrgJobPath
CommentText
OverrideShift
{Time | Currency}
Employee_Key
Person Key
132
Schedule_Start_Date
Schedule_End_Date
Pay_Code_Name
Display_Time
LaborAccountName
OrgJobPath
CommentText
OverrideShift
{Time | Currency}
Person_Key
Group or
Employee
Description
Input Parameter
User Key
Schedule_Start_Date
Schedule_End_Date
Pay_Code_Name
Display_Time
LaborAccountName
OrgJobPath
CommentText
OverrideShift
{Time | Currency}
User_Key

Output
XML Property
Response
Response
Schedule API task action: Schedule Pay Code Edit RangeRemove Schedule
Items
The Remove Schedule Items action of the Schedule Pay Code Edit Range API
task uses the Schedule API tag to remove the specified items for the identified
time period.
133
Chapter 3

Group or
Employee
Description
Input Parameter
Group
Group associated with schedule.
Schedule_Start_Date
Schedule_End_Date
Pay_Code_Name
Display_Time
{Time | Currency}
Schedule_Group_Name
Current User
Schedule_Start_Date
Schedule_End_Date
Pay_Code_Name
Display_Time
{Time | Currency}
Schedule_Start_Date
Schedule_End_Date
Pay_Code_Name
Display_Time
{Time | Currency}
Person_Number
Schedule_Start_Date
Schedule_End_Date
Pay_Code_Name
Display_Time
{Time | Currency}
Badge_Number
Employee Key Employee database key of the current user. Schedule_Start_Date

Schedule_End_Date
Pay_Code_Name
Display_Time
{Time | Currency}
Employee_Key
134
Group or
Employee
Description
Input Parameter
Person Key
Schedule_Start_Date
Schedule_End_Date
Pay_Code_Name
Display_Time
{Time | Currency}
Person_Key
User Key
Schedule_Start_Date
Schedule_End_Date
Pay_Code_Name
Display_Time
LaborAccountName
OrgJobPath
CommentText
OverrideShift
{Time | Currency}
User_Key

Output
XML Property
Response
Response
Schedule API task action: Swap Shifts

The Swap Shifts API task uses the ProcessSchedule API tag to swap the
employee assignments for the two specified shifts.
Sheet. For more information about the ProcessSchedule XML API tag, see
the Developers Toolkit Reference Guide for Scheduler.
Person_Number1
Schedule_Start_Date1
135
Chapter 3
Schedule_Start_Time1
Schedule_End_Time1
CommentText1
Person_Number2
Schedule_End_Time2
CommentText2
IsSaveData
IsCheckRules
Output
XML Property
RuleViolationItem
RuleViolationItem
Schedule API task action: Cover Shift

The Cover Shifts API task uses the ProcessSchedule API tag to assign an
employee to cover a shift for another employee.
Sheet. For more information about the ProcessSchedule XML API tag, see
the Developers Toolkit Reference Guide for Scheduler.
Person_Number1
Schedule_End_Time1
CommentText1
Person_Number2
136

Output
XML Property
Response
Response
Schedule API task action: Add Shift Segment

The Add Shift Segment API task uses the Update action of the Schedule API tag
to replace the add a shift segment to the schedule period.
Person_Number
Schedule_Start_Date
Schedule_Start_Time
Schedule_End_Time
CommentText
Output
XML Property
Response
Response
Schedule API task action: Add Shift Segment - v2

The Add Shift Segment API task uses the Update action of the Schedule API
tag to replace the add a shift segment to the schedule period, for a shift that spans
the day divide.
137
Chapter 3

Person_Number
Schedule_Start_Date
Schedule_Start_Time
Schedule_End_Time
CommentText
Start_Day_Number
End_Day_Number
Segment_Type_Name
Output
XML Property
Response
Response
Shift Builder API task

The Shift Builder API task uses the ShiftBuilder XML API tag to return the
populated-through date: that is, the date up to which the Shift Builder has
populated shifts from employee and group data patterns.
The following tables describe the Custom tab on the Shift Builder API Properties
Sheet. For more information about the ShiftBuilder XML API tag, see the
Shift Builder API task action: Load Populated Through Date
The LoadPopulatedThroughDate action returns the ShiftBuilder tag.
None.
138

Output
XML Property
ShiftBuilder
ShiftBuilder
Shift Validation API task

The Shift Validation API task uses the ShiftValidation XML API tag to
determine whether a specified shift exists in the database.
The following tables describe the Custom tab on the Shift Validation API
Properties Sheet. For more information about the ShiftValidation XML
API tag, see the Developers Toolkit Reference Guide for Scheduler.
Shift Validation API task action: Load
The Load action returns the ShiftValidation tag. The IsShiftExists
property will have a value of True if the shift exists.
139
Chapter 3

Employee
Description
Input Parameter
Current User
QueryDate
StartTime
EndTime
Person Number
QueryDate
StartTime
EndTime
Person_Number
Badge Number
QueryDate
StartTime
EndTime
Badge_Number
Employee Key
QueryDate
StartTime
EndTime
Employee_Key
Person Key
QueryDate
StartTime
EndTime
Person_Key
User Key
QueryDate
StartTime
EndTime
User_Key
140
Output
XML Property
ShiftValidation
ShiftValidation
Skills & Certs API task

Skills & Certs API task action: Load All Person Skills
The Load All Person Skills action uses the PersonSkillAssign XML API
tag, LoadAll action, to return employees who are qualified to work the
organizational job and who have the skills required for the shift. The following
tables describe the Custom tab on the Skills & Certs API Properties Sheet. For
more information about the PersonSkillAssign XML API tag, see the
PersonNumber
Output
XML Property
PersonSkills
PersonSkills
Skills & Certs API task action: Load All Person Certifications
The Load All Person Certifications action uses the
PersonCertificationAssign XML API tag, LoadAll action, to return
employees who are qualified to work the organizational job and who have the
certifications required for the shift.
The following tables describe the Custom tab on the Skills & Certs API Properties
Sheet. For more information about the PersonCertificationAssign
XML API tag, see the Developers Toolkit Reference Guide for Scheduler
PersonNumber
141
Chapter 3

Output
XML Property
PersonCerts
PersonCerts
Notes:
Skills Use this format to reference this data:

${SkillsTargetAttribute.Name}
where SkillsTargetAttribute is the name (PersonSkillsList, for
example) entered as the target attribute for the PersonSkills result object of the
Load All Person Skills API action.
Certifications Use this format to reference this data:

${CertsTargetAttribute.Name}
where CertsTargetAttribute is the name (PersonCertsList, for
example) entered as the target attribute for the PersonCerts result object of the
the Load All Certifications API action.
Timekeeper API tasks

The Timekeeper API provides the following tasks:
142
Timekeeper API task action: Historical PayCode EditAdd Comment on

page 143
Timekeeper API task action: Historical PayCode EditAdd on page 145
Timekeeper API task action: Historical PayCode EditDelete on page 147
Timekeeper API task action: Historical PayCode MoveAdd Comment on

page 149
Timekeeper API task action: Historical PayCode MoveAdd on page 151
Timekeeper API task action: Historical PayCode MoveDelete on page

153
Timekeeper API task action: Non-Cancelling PayCode EditAdd

Comment on page 155
Timekeeper API task action: Non-Cancelling PayCode EditAdd on page

157
Timekeeper API task action: Non-Cancelling PayCode EditDelete on

page 159
Timekeeper API task action: Load All PayCodes on page 160
Timekeeper API task action: PayCode Edit RangeAdd Comment on page

162
Timekeeper API task action: PayCode Edit RangeAdd on page 163
Timekeeper API task action: PayCode Edit RangeDelete on page 165
Timekeeper API task action: PayCode MoveAdd Comment on page 167
Timekeeper API task action: PayCode MoveAdd on page 169
Timekeeper API task action: PayCode MoveDelete on page 170
Timekeeper API task action: PayCode Profile on page 172
This topic describes each of these subtasks. For more information about the
associated XML tags, see the Developers Toolkit Reference Guide for
Timekeeper.
Timekeeper API task action: Historical PayCode EditAdd Comment
The AddComment action of the Historical PayCode Edit API task uses the
HistoricalPayCodeEdit API tag to add a comment to the set of comments
associated with the existing historical pay code edit. Acceptable values can be
found in the Setup Application.
The following tables describe the Custom tab on the Timekeeper API Properties
Sheet. For more information about the HistoricalPayCodeEdit XML API
tag, see the Developers Toolkit Reference Guide for Timekeeper.
143
Chapter 3

Employee
Description
Input Parameter
Current User
AmountInTimeOrCurrency
Date
FromLaborAccountName
FromPayCodeName
HistoricalDate
PayCodeName
CommentText
Date
FromPayCodeName
HistoricalDate
PayCodeName
CommentText
Person_Number
Date
FromPayCodeName
HistoricalDate
PayCodeName
CommentText
Badge_Number
Employee Key Employee database key of the current user. AmountInTimeOrCurrency

Date
FromPayCodeName
HistoricalDate
PayCodeName
CommentText
Employee_Key
144
Employee
Description
Input Parameter
Person Key
Date
FromPayCodeName
HistoricalDate
PayCodeName
CommentText
Person_Key
User Key
Date
FromPayCodeName
HistoricalDate
PayCodeName
CommentText
User_Key

Output
XML Property
Response
Response
Timekeeper API task action: Historical PayCode EditAdd

The Add action of the Historical PayCode Edit API task uses the AddOnly
action of the HistoricalPayCodeEdit API tag to add a new historical pay
code edit for the specified employee. There is no limit to the number of historical
pay code edits that an employee can have.
145
Chapter 3

Employee
Description
Input Parameter
Current User
Date
FromPayCodeName
HistoricalDate
PayCodeName
Date
FromPayCodeName
HistoricalDate
PayCodeName
Person_Number
Date
FromPayCodeName
HistoricalDate
PayCodeName
Badge_Number

Date
FromPayCodeName
HistoricalDate
PayCodeName
Employee_Key
Person Key
146
Date
FromPayCodeName
HistoricalDate
PayCodeName
Person_Key
Employee
Description
Input Parameter
User Key
Date
FromPayCodeName
HistoricalDate
PayCodeName
User_Key

Output
XML Property
Response
Response
Timekeeper API task action: Historical PayCode EditDelete

The Delete action of the Historical PayCode Edit API task uses the
HistoricalPayCodeEdit API tag to mark for deletion all historical pay
code edits for this employee, matching the given date, time, and labor account.
147
Chapter 3

Employee
Description
Input Parameter
Current User
Date
FromPayCodeName
HistoricalDate
PayCodeName
Date
FromPayCodeName
HistoricalDate
PayCodeName
Person_Number
Date
FromPayCodeName
HistoricalDate
PayCodeName
Badge_Number

Date
FromPayCodeName
HistoricalDate
PayCodeName
Employee_Key
Person Key
148
Date
FromPayCodeName
HistoricalDate
PayCodeName
Person_Key
Employee
Description
Input Parameter
User Key
Date
FromPayCodeName
HistoricalDate
PayCodeName
User_Key

Output
XML Property
Response
Response
Timekeeper API task action: Historical PayCode MoveAdd Comment

The AddComment action of the Historical PayCode Move API task uses the
HistoricalPayCodeMove API tag to add a comment to the set of comments
associated with the existing historical pay code move.
Sheet. For more information about the HistoricalPayCodeMove XML API
149
Chapter 3

Employee
Description
Input Parameter
Current User
Date
FromPayCodeName
HistoricalDate
PayCodeName
CommentText
Date
FromPayCodeName
HistoricalDate
PayCodeName
CommentText
Person_Number
Date
FromPayCodeName
HistoricalDate
PayCodeName
CommentText
Badge_Number

Date
FromPayCodeName
HistoricalDate
PayCodeName
CommentText
Employee_Key
150
Employee
Description
Input Parameter
Person Key
Date
FromPayCodeName
HistoricalDate
PayCodeName
CommentText
Person_Key
User Key
Date
FromPayCodeName
HistoricalDate
PayCodeName
CommentText
User_Key

Output
XML Property
Response
Response
Timekeeper API task action: Historical PayCode MoveAdd

The Add action of the Historical PayCode Move API task uses the AddOnly
action of the HistoricalPayCodeMove API tag to add a new historical pay
code move for the specified employee.
151
Chapter 3

Employee
Description
Input Parameter
Current User
Date
FromPayCodeName
HistoricalDate
PayCodeName
Date
FromPayCodeName
HistoricalDate
PayCodeName
Person_Number
Date
FromPayCodeName
HistoricalDate
PayCodeName
Badge_Number

Date
FromPayCodeName
HistoricalDate
PayCodeName
Employee_Key
Person Key
152
Date
FromPayCodeName
HistoricalDate
PayCodeName
Person_Key
Employee
Description
Input Parameter
User Key
Date
FromPayCodeName
HistoricalDate
PayCodeName
User_Key

Output
XML Property
Response
Response
Timekeeper API task action: Historical PayCode MoveDelete

The Delete action of the Historical PayCode Move API task uses the
HistoricalPayCodeMove API tag to mark for deletion all historical pay
code moves for this employee, matching the given date, time, and labor account.
153
Chapter 3

Employee
Description
Input Parameter
Current User
Date
FromPayCodeName
HistoricalDate
PayCodeName
Date
FromPayCodeName
HistoricalDate
PayCodeName
Person_Number
Date
FromPayCodeName
HistoricalDate
PayCodeName
Badge_Number

Date
FromPayCodeName
HistoricalDate
PayCodeName
Employee_Key
Person Key
154
Date
FromPayCodeName
HistoricalDate
PayCodeName
Person_Key
Employee
Description
Input Parameter
User Key
Date
FromPayCodeName
HistoricalDate
PayCodeName
User_Key

Output
XML Property
Response
Response
Timekeeper API task action: Non-Cancelling PayCode EditAdd Comment

The AddComment action of the Non-Cancelling PayCode Edit API task uses the
NonCancellingPayCodeEdit API tag to add a comment to each pay code
edit associated with the specified employee.
Sheet. For more information about the NonCancellingPayCodeEdit XML
API tag, see the Developers Toolkit Reference Guide for Timekeeper.
155
Chapter 3

Employee
Description
Input Parameter
Current User
Date
PayCodeName
CommentText
Date
PayCodeName
CommentText
Person_Number
Date
PayCodeName
CommentText
Badge_Number

Date
PayCodeName
CommentText
Employee_Key
156
Person Key
Date
PayCodeName
CommentText
Person_Key
User Key
Date
PayCodeName
CommentText
User_Key

Output
XML Property
Response
Response
Timekeeper API task action: Non-Cancelling PayCode EditAdd

The Add action of the Non-Cancelling PayCode Edit API task uses the AddOnly
action of the NonCancellingPayCodeEdit API tag to add a new pay code
edit with the specified properties.
157
Chapter 3

Employee
Description
Input Parameter
Current User
Date
PayCodeName
Date
PayCodeName
Person_Number
Date
PayCodeName
Badge_Number

Date
PayCodeName
Employee_Key
Person Key
Date
PayCodeName
Person_Key
User Key
Date
PayCodeName
User_Key
158
Output
XML Property
Response
Response
Timekeeper API task action: Non-Cancelling PayCode EditDelete

The Delete action of the Non-Cancelling PayCode Edit API task uses the
NonCancellingPayCodeEdit API tag to mark for deletion all pay code
edits for the employee with matching properties.
159
Chapter 3

Employee
Description
Input Parameter
Current User
Date
PayCodeName
Date
PayCodeName
Person_Number
Date
PayCodeName
Badge_Number

Date
PayCodeName
Employee_Key
Person Key
Date
PayCodeName
Person_Key
User Key
Date
PayCodeName
User_Key

Output
XML Property
Response
Response
Timekeeper API task action: Load All PayCodes

The Load All PayCodes API task uses the PayCode API tag to return a list of all
160
paycodes.
Sheet. For more information about the PayCode XML API tag, see the
Developers Toolkit Reference Guide for Timekeeper.
PayCodeHoldsType
IncludeCombinedFlag
IncludeManagerPayCodesFlag
IncludeEmployeePayCodesFlag
Output
XML Property
Paycodes
Paycodes
Note the following when specifying the input parameters:

Input Parameter
Source Attribute
PayCodeHoldsType
Hours (Required in the template supplied with the

product)
Currency
All
IncludeCombinedFlag
True
False (for most implementations)
IncludeManagerPayCodesFlag
TrueIf you have manager access to pay codes

FalseIf you do not have manager access to pay
codes (you have employee access instead)
IncludeEmployeePayCodesFlag
TrueIf you have employee access to pay codes

FalseIf you do not have employee access to pay
codes (you have manager access instead)
161
Chapter 3
Timekeeper API task action: PayCode Edit RangeAdd Comment

The AddComment action of the PayCode Edit Range API task uses the
PayCodeEdit API tag to add a comment to each pay code edit associated with
the specified employee.
Sheet. For more information about the PayCodeEdit XML API tag, see the
162
Employee
Description
Input Parameter
Current User
Date_Start
Date_End
PayCodeName
LaborAccountName
OrgJobName
CommentText
Date_Start
Date_End
PayCodeName
LaborAccountName
OrgJobName
CommentText
Person_Number
Date_Start
Date_End
PayCodeName
LaborAccountName
OrgJobName
CommentText
Badge_Number
Employee
Description
Input Parameter
Employee Key Employee database key of the current user. Date_Start

Date_End
PayCodeName
LaborAccountName
OrgJobName
CommentText
Employee_Key
Person Key
Date_Start
Date_End
PayCodeName
LaborAccountName
OrgJobName
CommentText
Person_Key
User Key
Date_Start
Date_End
PayCodeName
LaborAccountName
OrgJobName
CommentText
User_Key

Output
XML Property
Response
Response
Timekeeper API task action: PayCode Edit RangeAdd

The Add action of the PayCode Edit Range API task uses the AddOnly action of
the PayCodeEdit API tag to add a new pay code edit with the specified
properties.
163
Chapter 3
Employee
Description
Input Parameter
Current User
Date_Start
Date_End
PayCodeName
LaborAccountName
OrgJobName
CommentText
Date_Start
Date_End
PayCodeName
LaborAccountName
OrgJobName
CommentText
Person_Number
Date_Start
Date_End
PayCodeName
LaborAccountName
OrgJobName
CommentText
Badge_Number

Date_End
PayCodeName
LaborAccountName
OrgJobName
CommentText
Employee_Key
164
Employee
Description
Input Parameter
Person Key
Date_Start
Date_End
PayCodeName
LaborAccountName
OrgJobName
CommentText
Person_Key
User Key
Date_Start
Date_End
PayCodeName
LaborAccountName
OrgJobName
CommentText
User_Key

Output
XML Property
Response
Response
Timekeeper API task action: PayCode Edit RangeDelete

The Delete action of the PayCode Edit Range API task uses the
PayCodeEdit API tag to mark for deletion all pay code edits for the employee
with matching properties.
165
Chapter 3

Employee
Description
Input Parameter
Current User
Date_Start
Date_End
PayCodeName
LaborAccountName
OrgJobName
Date_Start
Date_End
PayCodeName
LaborAccountName
OrgJobName
Person_Number
Date_Start
Date_End
PayCodeName
LaborAccountName
OrgJobName
Badge_Number

Date_End
PayCodeName
LaborAccountName
OrgJobName
Employee_Key
Person Key
166
Date_Start
Date_End
PayCodeName
LaborAccountName
OrgJobName
Person_Key
Employee
Description
Input Parameter
User Key
Date_Start
Date_End
PayCodeName
LaborAccountName
OrgJobName
User_Key

Output
XML Property
Response
Response
Timekeeper API task action: PayCode MoveAdd Comment

The AddComment action of the PayCode Move API task uses the
PayCodeMove API tag to add a comment to the set of comments associated with
the existing pay code move item.
Sheet. For more information about the PayCodeMove XML API tag, see the
Employee
Description
Input Parameter
Current User
Identifies the currently logged on

user.
Date
FromPayCodeName
PayCodeName
CommentText
167
Chapter 3
Employee
Description
Input Parameter
Person Number Person number of the current user. AmountInTimeOrCurrency

Date
FromPayCodeName
PayCodeName
CommentText
Person_Number
168
Date
FromPayCodeName
PayCodeName
CommentText
Badge_Number
Employee Key Employee database key of the

current user.
Date
FromPayCodeName
PayCodeName
CommentText
Employee_Key
Person Key
Person database key of the current AmountInTimeOrCurrency

user.
Date
FromPayCodeName
PayCodeName
CommentText
Person_Key
User Key
Date
FromPayCodeName
PayCodeName
CommentText
User_Key

Output
XML Property
Response
Response
Timekeeper API task action: PayCode MoveAdd

The Add action of the PayCode Move API task uses the AddOnly action of the
PayCodeMove API tag to add a new pay code move item with the specified
properties.
Employee
Description
Input Parameter
Current User
Date
FromPayCodeName
PayCodeName
Date
FromPayCodeName
PayCodeName
Person_Number
Date
FromPayCodeName
PayCodeName
Badge_Number
169
Chapter 3
Employee
Description
Input Parameter

Date
FromPayCodeName
PayCodeName
Employee_Key
Person Key
Date
FromPayCodeName
PayCodeName
Person_Key
User Key
Date
FromPayCodeName
PayCodeName
User_Key

Output
XML Property
Response
Response
Timekeeper API task action: PayCode MoveDelete

The Delete action of the PayCode Move API task uses the PayCodeMove API
tag to mark for deletion an existing pay code move item.
170

Employee
Description
Input Parameter
Current User
Date
FromPayCodeName
PayCodeName
Date
FromPayCodeName
PayCodeName
Person_Number
Date
FromPayCodeName
PayCodeName
Badge_Number

Date
FromPayCodeName
PayCodeName
Employee_Key
Person Key
Date
FromPayCodeName
PayCodeName
Person_Key
171
Chapter 3
Employee
Description
Input Parameter
User Key
Date
FromPayCodeName
PayCodeName
User_Key

Output
XML Property
Response
Response
Timekeeper API task action: PayCode Profile

The PayCode Profile API task uses the PayCodeProfile API tag to return the
specified paycode profile(s).
Sheet. For more information about the PayCodeProfile XML API tag, see the
172

Action
Description
Input Parameter
LoadByName
Returns a pay code profile, based on

PayCodeProfileName.
PayCodeProfileName
LoadById
Returns a pay code profile, based on

PayCodeProfileId.
PayCodeProfileId
LoadAll
Returns a list of all pay code profiles in the None

system.

Output
XML Property
Profile
Profile
173
Chapter 3
Timekeeper and Scheduler Processor tasks

When you select File > Tasks in Process Designer after installing Timekeeper and
Scheduler, the following tasks appear in the list, along with the basic tasks that
ship with Process Designer.
Task
Description
Rule Violation
Processor
Routes processes based on whether any business rules are

violated by invoking XML APIs.
Accrual Violation
Processor
Routes processes based on whether any accrual rules are violated

by invoking XML APIs.
Daily Schedule Stat

Processor
Routes processes based on schedule hours daily status.
Schedule Exceptions Routes processes based on exceptions to the schedule.

Processor
174

WFC70 ProcessMgrTKandSchedProgGuide

Caricato da

Informazioni sul documento

Descrizione originale:

Titolo originale

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

WFC70 ProcessMgrTKandSchedProgGuide

Caricato da

Copyright:

Formati disponibili

Workforce Central

Kronos Workforce Central suite version 7.0

Process Manager 7.0

Chapter 1: Using Process Templates for Timekeeper and Scheduler

Request Manager Shift Swap .......................................................................72

Shift Validation API task ................................................................... 139

Using Process Templates for Timekeeper and

This chapter contains the following sections:

Implementing a process template on page 8

Time Off Request on page 9

Time Off Request (4500 and InTouch timeclock) on page 12

Automatic Action on page 16

Sample instructional template on page 17

Cancel Time Off Request on page 19

Shift Swap on page 22

Sign Up for Open Shifts on page 25

Request Open Shifts on page 27

New Hire Decision/Announcement on page 29

Employee Awards on page 31

Disciplinary Action on page 33

Termination Announcement on page 35

Training Registration on page 38

Request to Cover on page 41

Request to Cover Shift on page 43

Delegate AuthorityManager on page 45

Delegate AuthorityAdministration on page 47

Using Process Templates for Timekeeper and Scheduler

Implementing a process template

Check for Process Designer extensions.

2 Use Process Designer to deploy the finished

Adding a Template to a Process Profile in

Assigning the Process Profile and

5 In the suite application, use the People Editor to:

6 In the suite application, use the Process

Time Off Request

Time Off Request

If the request is approved, the manager specifies Override Shift and

If the request is rejected, the manager provides comments and sends a

Using Process Templates for Timekeeper and Scheduler

Time Off Request

Using Process Templates for Timekeeper and Scheduler

Time Off Request (4500 and InTouch timeclock)

If the request is approved, the manager specifies Override Shift and

If the request is rejected, the manager provides comments and sends a

Time Off Request (4500 and InTouch timeclock)

AccrualName1, AccrualIncrement1, and AccrualLabel1

AccrualName2, AccrualIncrement2, and AccrualLabel2

AccrualName3, AccrualIncrement3, and AccrualLabel3

Using Process Templates for Timekeeper and Scheduler

Note: If you remove attributes, be sure to remove any references to the

Time Off Request (4500 and InTouch timeclock)

Using Process Templates for Timekeeper and Scheduler

The Also Notify recipient

Sample instructional template

Sample instructional template

Using Process Templates for Timekeeper and Scheduler

Cancel Time Off Request

Cancel Time Off Request

If the request is approved, the employees schedule is updated and a

If the request is rejected, the manager provides comments and sends a

Using Process Templates for Timekeeper and Scheduler

Modify accrual attributes