Professional Documents
Culture Documents
Configuration Guide
Date 10/01/2018
1.1 Introduction
The Attestation Tool Kit (ATK) consists of the Timecard Confirmation Tool,
MyTimeStamp (MTS), Time Review (Approval Compliance), My Approvals, Configuration
Import/Export and the Smart View™ Printing Tool.
These items are explained to some level in this document; however, this document may
also refer to the User or Installation Guides for this and other tools included in this kit.
Advanced Genie Column Editor Create detail Genie columns for ATK
exceptions.
Smart View Printing Admin Configuration area for Smart View Printing
MyTimeStamp MyTimeStamp
Managers that will need All My Approvals need the following URLs.
Note: managers who also interact with the system as an employee, should be assigned
the custom URLs for both employees and managers.
Note: if you are upgrading from a previous version, you will also see
site.ATTEST.com.kronos.kss.attestation.label.userdefin
edfield on the Attestation Tab. This value should be used to populate
the two fields above.
e. Note: WFC version 7.x and later supports up to a maximum of 40 fields, if
40 are already created, one must be replaced.
3 Language Settings
a. Language settings are contained in two properties files.
XXStrings.properties contains screen labels and error messages displayed
to employees. These are static text items, and do not depend on Puncher
configuration items (such as question and answer labels).
b. XXEditorStrings.properties contains screen labels, tooltips and error
messages displayed to the system administrator during configuration.
c. To support another language, make a copy of the XXStrings.properties
and XXEditorStrings.properties with the appropriate language extension.
For example MTSStrings.properties contains the screen labels and error
messages in English. To support French make a copy of this file with the
fr extension as MTSStrings_fr.properties. Ensure the appropriate language
pack is deployed on the application server.
d. To change these strings, an administrator must edit the relevant
properties file using a plain text editor (e.g. Notepad), then run Workforce
Central Configuration Manager to redeploy the WFC instance.
e. The directory where the files can be found is <installed
drive>\kronos\deployments\release\custom_APP_staging\app_server\appl
ications\APP\properties, where APP equals the application in question.
The application names use are: attestation, authcontroller, comp,
importer, kssapprovals, kssgenies, ksslibrary, mytimestamp, svp, trconf.
4. The group “Default” should be created for anyone who DOESN’T have an Attestation
Group assigned in the People Record. This field would then populate attestation
verbiage for anyone using the Timecard Confirmation Tool. The additional groups
would then be used for anyone who falls OUTSIDE that default grouping. The group
“Manager” is used for anyone approving ANOTHER EMPLOYEE’S time in a manager
function. There is only one possible Manager Profile, but many possible employee
profiles (approving one’s own time).
5. Select the default building blocks under building block assignment. (These are not
actually used for Timecard Confirmation.)
6 Notifications in ATK
There are two types of notification methods available in ATK. System Generated emails
can be sent to employees, managers and additional email recipients (identified in the
MyTimeStamp profile). These notifications are enabled within Missed Punch
Configuration (email manager) and Time Review configuration (Rejection requires
manager respond) in the Time Review Editor. In MyTimeStamp Answer configuration,
the option is enabled on the Notification tab (where the subject and body is also
defined). Within Puncher configuration, notifications may be enabled when using the
Test for Short Break functionality that allows employees to return early from a meal
break.
Note: notifications generated here are system notifications sent by Workforce Central.
These notifications can only be sent via e-mail and/or kmail. Use My Approvals
Configuration options to use Generic Workflow Notifications and to take advantage of
the delivery options available in Notification Profiles.
If system notifications are enabled here and generic workflow notifications are also
configured, then duplicate notifications will be sent out.
Provide a comma separate list of e-mail addresses to which to send notifications in the
Notify others fields.
• The three on rejection settings determine who will receive a notification when an
employee rejects a day or pay period in Time Review.
• Notify others on approval removal lists email address that will receive a
notification when an employee reapproves a day or pay period that has also
been approved by one or more managers, as this requires the manager
approvals to be removed.
• Select from the listed pay codes to choose pay codes for period and daily
approvals and rejections and enter the amount of the pay code to be added.
• Select a pay code to be used to sum overtime.
• Select which type of Hyperfind you want to display in the Hyperfind drop down.
• Select a Hyperfind to be used for Manager Smart Views.
• Include audit types. Provide a comma separated list of audit types to include in
the Time Review screen or enter All. To find out what the available audit types
are, temporarily use the value “All”, then view a few pay periods in Time Review.
Take careful note of the values that appear in the Type column of the audit
section. You can then return to the Time Review Editor and enter as many of
those audit types as you want, separated by commas. Some example values
include “Insert”, and “Delete”, referring to punches; “Insert PayCodeEdit”. The
values must be entered exactly as they appear in the audit section of Time
Review.
• Show Audits enables or disables the display of audits in Time Review.
• If Show Audits is enabled, the other Show… check boxes may be used to refine
what data to include in the audit event.
• Punch time changes only? Check this box to ignore punch edits that don’t change
the punch time, such as marking reviewed.
• Employee Groups. Select one or more available employee groups for ordinary
profiles. Leave blank for the Default and Manager profiles. When employees
open the Time Review screen, we look up their additional info field to see what
employee group they belong to. We then look for the profile that has that
employee group assigned to it. If no such profile exists, or the employee’s
additional info field is empty, then we use the Default profile.
8 MyTimeStamp Configuration
8.1 Overview
MyTimeStamp (MTS) is a highly configurable application to allow employees to enter
punches into Workforce Timekeeper. The application can provide multiple punch types
for employees to use at different times of the shift, for example:
• Start of shift
• Meal break in/out
• End of shift
Alternatively, a single punch button can be used for multiple punch events. Items that
can be assigned to punches include:
• Button label
• Punch override type
• Transfers
• Punch comments
• Short break options, e.g. lunch lockout
• Punch Attestations
• Follow up questions
• California meal penalty
• Manage notifications
• Receipt printing
Question label: this is the text that is displayed to the employee when a question is
asked. This should be no more than a single line in length, or the Question may
overlap answers on Mobile device transactions.
Question page title: this text is used in the page header as the title when the
employee is answering the question.
Suppress confirmation: selecting this box prevents the application from displaying
the question and the answer the employee selected in the confirmation dialog.
Add minutes to punch: If this question is displayed to the user, then the entered
number of minutes will be added to the punch (the negative numbers are also allowed
meaning the punch time will be the punch time minus entered negative number). This
configuration setting gives you the flexibility to specify the number of minutes to add to
the current time for the end-of-shift punch. This will allow the employee to review his
punches on company time when using List shift punches.
Please note: These minutes will not be added if the question is not displayed. Negative
value is not supported
This setting should be set to 0 when configuring questions for Missed Punch Punchers.
Abort entire process? If this option is selected, the punch process will end entirely.
Require manager response? If checked, when an employee selects this answer, a
manager will be required to respond. This option also enables the “Hold for approval”
option on the punch and pay code tabs.
Cancel Deduct: If selected, when the employee selects this answer, the selected
automatic deduction will be cancelled for the shift.
Note: Cancel Deduct will NOT cancel any deductions if the corresponding punch is held
for manager approval.
Approve day? If this option is checked, then WFC approvals will be added to the
current day when the answer is selected, and the punch is inserted into the timecard.
This will use the pay code selected for Daily Approvals on the General Tab in Time
Review Editor in the profile assigned to the employee.
Apply shift start transfer? If checked, this option applies a work rule transfer on the
Shift Start punch. This option requires this Work rule prefix value be set in the Profile
for the employee. When the employee selects this answer, a work rule transfer to a will
be applied to the shift start punch. The work rule to which the employee will be
transferred is determined by prefixing the value found in the Work rule prefix field in
the employee’s profile to the employee’s existing work rule.
When “User defined” option is chosen, ensure the URL begins with "http://", "https://"
or "/applications/"
Note: the option is ignored when the puncher is used for missed punches.
Prevent main punch? Selecting this option will prevent the puncher from recording a
punch for this transaction.
Hold main punch until approved? This option is only available if the “Require
manager response” option is enabled on the General tab. Selecting this option prevents
the punch from being added to the employee’s timecard until after the manager has
approved it.
Cancel deduct: Select the automatic deduction you wish to cancel from the
employee’s shift when this answer is chosen.
Prompt for main punch: When selected, this option will allow employees to enter the
time of the punch instead of simply using the current time. This would normally be used
in combination with the “Require manager response” and “Hold main punch until
Pay Code Name: Select the name of the pay code to be added to the employee’s
timecard when this answer is chosen.
Pay Code Amount: Select whether the employee should be prompted to enter an
amount for the pay code or if a fixed amount should be used.
Add to: select whether the pay code should be added to the timecard or schedule.
Edit Start Time: When adding a pay code to the schedule, select this option to allow
the employee to set the start time of the pay code.
Prompt for Date: Select this option to allow the employee to change the date of the
pay code. Leaving this unselected will cause the pay code added on the same day as
the punch.
Limit to: Enter values to limit the number of days before and after the punch an
employee may enter a punch.
Hold pay code until approved: selecting this option will prevent the pay code from
being entered into the timecard until after the manager has approved it.
Comment: select a comment to be added to the pay code.
Note: indicate whether free form notes should be disabled, optional or required for
employees.
Note: For all numeric input fields in the above tabs, please do not enter values
exceeding 10 digits.
d. Choose options for the selected condition type. These options will be
described in the following sections.
ALWAYS CONDITION
The Always condition has no options. When attached to a question, it will trigger the
question every time the Puncher executes.
Options:
• Test for Equal/Not Equal. Triggers the associated question if the contents of the
employee’s selected additional info field matches (or doesn’t match) the supplied
text. Case is ignored.
• Additional Info Field Name. Choose one of the items in the list. These correspond
to all the available custom field labels defined in WFC system settings.
Options:
• Work rule search string. This text substring is used to indicate the
particular shift type, e.g “call”. The condition will search for this substring,
which is case-insensitive, in the work rule transfer assigned to the
scheduled shift.
• Return true if work rule is present/not present. If present is chosen, the
condition will return TRUE if a shift with the work rule transfer is found.
Not present reverses the result.
MINUTES ELAPSED CONDITION
This condition checks for the minutes elapsed since the first punch of the day. It does
not deduct time for breaks taken since that time.
Options:
Options:
• Test for Any-punch/IN-punch/OUT-punch. Look for exceptions that the time card
flags as IN or OUT or either.
• Within x before and y minutes after current time. Look for exceptions that fall
within the specified time range. For example, to specify a time span of the last
24 hours, you would enter 1440 and 0, respectively.
PERIODIC QUESTION CONDITION
This condition checks whether a specific question has been answered by the employee
recently or at all. It uses the MyTimeStamp audit tables to make the determination
(database tables, KSSMTSAUDIT and KSSMTSAUDITQA).
Usually, the question used in the test is the same question that is triggered by the
condition. This allows you to ask a question if it hasn’t been answered this week, for
example.
Options:
• Is/is not. Determines whether the condition returns TRUE when on a specific
platform or when NOT on a specific platform.
• Platforms:
• 4500
• InTouch
• Mobile View
• Mobile Home Screen (Mini Browser)
• Web Browser (Full Browser, Navigator)
• Quick Time Stamp
Options:
• Test for Shift exists. Returns TRUE if the employee has a scheduled shift such
that any part of that shift is contained in the specified time range. The time
range is specified as a number of minutes after and before the current punch
time. Both numbers can be positive, zero or negative. For example, to test if
there is a shift that overlaps the previous hour, this would be expressed as
“Within punch time plus -60 minutes to punch time plus 0 minutes”.
• Test for No shift. This returns the opposite result of the above Shift exists test.
• Test for Shift start time. After locating the shift nearest to the current punch
time, we return TRUE if the start time of that shift falls within the specified time
range. You must specify at least one of the two sub-options (“Punch time is
before/after shift start plus x minutes”). The numbers may be positive, zero or
negative. If no scheduled shift is found, this condition returns FALSE.
Options:
• Test for
o Any punch. Returns TRUE if there is at least one IN or OUT punch in the
specified time frame, with the specified comment, if any.
o No punches. Returns TRUE if there are no such punches.
o IN-punch. Returns TRUE if there is at least one IN punch in the specified
time frame, with the specified comment, if any.
Options:
• Test for Punch exists/No punch. Use the Punch exists option to return TRUE if
the time elapsed since the last OUT-punch falls within the specified time frame.
Use No punch to return TRUE if there is no recorded OUT-punch for the current
shift or no OUT-punch falls within the specified time frame.
• Between x and y minutes (inclusive) before current time. Specify the time frame,
expressed as minutes before the current time, in which we will look for OUT-
punches.
Options:
• Previous Pay Period Approval. Tests whether the employee’s previous pay period
has been approved in ATK. This test does not consider whether a manager has
edited the time card after the employee’s approval. It simply looks at the most
recent ATK approval audit action.
• Daily Approval. Tests whether there are pending approval actions required by the
employee. This test is equivalent to viewing the employee’s Time Review, Daily
screen and returning TRUE if there are any missed punches or dates awaiting
approval.
• Test for Approved/Not approved. If Approved is selected, the test evaluates to
TRUE if the chosen period has no outstanding approvals required. Not approved
reversed the result.
Options:
• Sum of minutes in pay code. This drop-down menu is a list of all pay
code names. Select the one you want to sum.
• During time frame. Select “most recent worked day” or “current pay
period”.
• Is less than/greater than. Enter a number of minutes and choose whether
to trigger the question when the sum is less than or greater than the
entered number.
The Add New Conditional Question dialog appears and allows you to select one
question to select one or more conditions. Use CTRL key to select multiple conditions.
If there happens to be more than one puncher with the same label, the puncher to be
used is indeterminate. It is not recommended practice to have two punchers with the
same name.
This option will refuse a punch when the employees attempts to return early from a
punched break.
Break Margin: The full length of the break.
Break restriction: Window of time prior to the end of the break when the employee
is not allowed to punch back in. In the example above, an employee could punch out
for lunch, and return within 9 minutes and punch back in. If 10 minutes had passed,
the employee would now be in the restricted window and not able to punch back in
until the end of the full break.
Punch blocked message: The message displayed to the employee when attempting
to punch in during the restricted window.
Allow short breaks with warning
DISPLAY PROFILE
The employee's display profile must have the option to use short names enabled.
Note: When the valid labor account short name is very long, the short name is
truncated on the InTouch and 4500. The user can use arrow keys to scroll on the 4500.
FEATURE AVAILABILITY
This feature is available on all platforms (Mobile View, InTouch, 4500, my timestamp,
Mobile Home screen and QuickTimeStamp)
Buttons are the labels that are presented to employees when punching. They are
associated with a puncher within profiles. When using MyTimeStamp punchers with
conditions and questions, if the application is offline, no conditions can be evaluated
Create a single answer called “Hold Missed Punch”. Be sure to check “Require Manager
Response” on the General Tab and “Hold Punch until Approved” on the Approval Tab.
Add this question as the first question in any Missed Punch Punchers.
When configuring questions for Missed Punch Punchers, it is recommended that you
include the %d (date) variable in the questions and answers to remind the employee
they are answering questions about a missed and not the current shift.
PROFILE EXAMPLE
a. Sign in as an administrator and click on “MyTimeStamp Editor” under My
Links.
g. If the answer is “yes” the button label is configured on the General Tab.
l. The button name and all the bonuses and deductions on the timecard
could be cancelled for the shift if configured on the general tab.
n. The sign in button will display with a label “Sign-In” and when offline the
functionality will be like the sign in puncher.
p. Using the settings below, all the above punchers and buttons will become
associated with the “default” profile.
q. The profile settings come from the global settings for MyTimeStamp.
c. By choosing “allow short breaks with warning” option you can let the
employee punch in prior to 30 minutes. This will be called a voluntary
early return. A comment can be attached to the out punch indicating
early return and the manager notified.
g. When the system is offline a simple punch will be inserted with the offline
comment as no checks can be performed when in offline mode.
i. The buttons can then be appropriately assigned to the profiles for the
employees that need meal In/Out punchers and separate button sets
created.
on the mobile view without hiding the bottom of the message or the answer buttons is
396 characters.
Note: When the button layout is “Two Button Dialog”, if the answers are too long, only
the second answer will be displayed in the mobile view on android devices.
d. Select Answer on which the redirect will be applied and select Edit.
g. Go to the Punchers tab. Select the puncher on which the question with
the redirect will be tied. It is recommended to use the redirect
functionality on IN PUNCH only. Select Edit.
3. This URL will provide an on-screen keyboard, for use with touch screen kiosks, for
example:
/applications/MTS/html/logonPunchAction.jsp?buttonset=1&useKeypad=yes&use
badge=yes
6. The layout of the buttons on the QuickTimeStamp page is controlled by the value in
the Property found on the MyTimeStamp tab in system settings
7. The Size and Color of time displayed on the screen can be changed under KSS
Globals tab. Change the color:red to color:white, if you do not want to display the
local time on the QuickTimeStamp screen.
Note: The Prompt Pay Code amount feature is not supported in offline mode in
all platforms.
2. Navigate to Set Up -> System Configuration -> System Settings ->COMP and set
the appropriate value in site.CSK.QTS.timereview.timeout. The default value is
20 seconds.
The screen shot below shows the result of the above the above configuration.
Note: The message area in the above screen has a limitation of 2000 characters. To
insert line breaks in the message, use the html <BR> tag. If <enter> key is used, then
the space will not be saved correctly in the database and a SQL exception may be
thrown.
10 My Approvals
My Approvals is about Exceptions. Exceptions occur in other applications like Time
Review and MTS. When the Exception occurs, the KSS Approvals application is called to
submit the Exception. There are various types of exceptions:
a. Missed Punch Exception: This exception is generated by Time Review when
the employee submits a missed punch request.
b. Day Rejection: This exception is generated by Time Review when the
employee rejects a day.
c. Pay Period Rejection: This exception is generated by Time Review when the
employee rejects a pay period.
d. MyTimeStamp Answer Exceptions: This exception is generated by MTS
when the employee chooses an answer to a question. Answer exceptions can be
further classified into subtypes, such as an Early In Exception.
e. Employee Exceptions: This type of exception has to be
acknowledged/responded by the employee as opposed to the manager.
Exceptions are displayed to the managers on the My Approval screen. Managers must
act on each Exception by selecting one of the buttons presented. Possible actions may
include:
a. Approve: This is used to approve the submitted request.
b. Rejection/Response: This is used to reject or respond to the submitted
request.
A description of the more notable items from both tabs follow. The meaning of
properties not listed below should be clear from the one line description in the system
settings tab.
• site.KSSAPPROVALS.beanuser – the user name of a power user that has the
ability to make changes to employee time cards in response to approvals and
rejections. The user’s password does not need to be stored.
• site.KSSAPPROVALS.HyperFindName – the name of a HyperFind query that
is used to retrieve employees whose exceptions a manager should be able to see
on the All My Approvals screen. This can be overridden by the Navigator context.
• site.KSSAPPROVALS.email.customdatadefid – this is used when
notification type on the General Info tab of the My Approvals Configuration Editor
is set to E-Mail. In that case, this property identifies the employee’s Additional
Information field that contains a list of email addresses to receive notifications
when the exception is created (see section 10.6).
• site.KSSAPPROVALS.lookbackdays and lookforwarddays – these limit the
exceptions shown on the manager’s All My Approvals screen based on a date
range relative to today. This date range may be overridden by that configured in
the Navigator context.
• site.KSSAPPROVALS.maxpendingrequests – a hard limit on the number of
exceptions that can be loaded on the manager’s All My Approvals screen.
• site.KSSAPPROVALS.QTS.approval.timeout – this timeout is used if
employees have been forwarded to the All My Approvals screen from the Quick
Time Stamp screen at a kiosk.
• kss.global.approvals.approveSelf – with the default value of true, if a
manager belongs to his/her own employee group, that manager will be able to
b. There are four Request types configured by default in the Approval Configuration
screen below. By default, there is no MyTimeStamp Answer Exceptions. This type
of exception appears on the Approvals Configuration screen after ‘Require
manager response’ checkbox is selected for an answer.
d. APPROVAL:
- If the Reasons Type is set to Enter text, then the user can enter
a list of ad hoc reasons.
b. Ensure that Notification Profiles have been created and assigned to users.
Reviewer Lists
ONLY Step 1 reviewers are supported in this release. You may have as many users
assigned as Reviewers in Step 1 as desired. Additional Steps and Also Notify are not
supported.
12 My Genies
ATK Genie columns display data related to items that require a manager response. My
Approval responses (Approval, Rejection, Respond, etc.) can be displayed in detail
Genies, as well as MyTimeStamp answers comments. My Genies provide the ability to
add columns to an existing detail Genie column sets or to create new Genie column sets
to show the ATK Exception Type, Status, Manager Response as well as to count
comments or groups of comments.
Advanced Genie column editor provides the administrator the ability to define advanced
genie columns that can be added to any genie. To define a genie column, click on the
Advanced Genie Column Editor my link menu.
In the above screen define the column name and select the comments from the list of
available comments. When this column is added to a genie, then the genie can report
on the count of comment occurrences defined for this column.
For example, you may wish to create two Genie columns to track employee reasons for
missed punched. One column would be called Badge Issues and contain the comments
Lost Badge, Damaged Badge, Forgot Badge. The other column would be called Clock
Issues and contain the comments Clock Offline, Clock Obstructed.
The following screen shot shows the configuration of the above Genie column set.
13 Authentication Controller
This module is used to provide login functionality to ATK QuickTimeStamp to log into
workforce. This module also provides the ability for third party authentication systems
like M2Sys to authenticate the user and log them into Workforce. Refer to the
Installation Guide for details in installing the Authentication Controller, either when you
are installing ATK, or at a separate time.
Note: you must be using a fully qualified domain name if you are using the
Authentication Controller. E.g., instance.yourcompany.com.
15.1 Overview
Language settings for ATK can be used to localize many of the features in ATK to many
languages with in one instance of WFC. Some basic customization can be completed
with button names, labels, questions, answers, and attestation messages as part of the
standard configuration of the product.
In addition to these items, static text items, which do not depend on Puncher
configuration items, such as Backspace and enter keys, may also be localized. This is
done by the addition of language properties files, in the manner described in the
following “configuration” section.
Each properties file contains screen labels and error messages displayed to employees
as they use each product. The table below shows these properties files that can be
copied and modified to include localized text.
These files can be found in
<Installed_Drive>/Kronos/Deployments/release/<custom_”Product”_staging and
should be copied to all Web and Mobile servers after modification.
French(Canada) Canada fr
Portuguese(Brazil) Brazil pt
Dutch Netherlands nl
German Germany de
i. Click Save