Escolar Documentos
Profissional Documentos
Cultura Documentos
Altitude, Cambridge Clock, CardSaver, Datakeeper, Datakeeper Central, eForce, Gatekeeper, Gatekeeper Central,
Imagekeeper, Jobkeeper Central, Keep.Trac, Kronos, Kronos Touch ID, the Kronos logo, My Genies,
PeoplePlanner, PeoplePlanner & Design, Schedule Manager & Design, ShopTrac, ShopTrac Pro, StarComm,
StarPort, StarSaver, StarTimer, TeleTime, Timekeeper, Timekeeper Central, TimeMaker, 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 Dream, Altitude Pairing, Altitude
PBS, Comm.Mgr, CommLink, DKC/Datalink, FasTrack, HR and Payroll Answerforce, HyperFind, Improving the
Performance of People and Business, Kronos 4500, Kronos 4500 Touch ID, Kronos e-Central, KronosWorks, KVC
On Demand, Labor Plus, Momentum, Momentum Essentials, Momentum Online, Schedule Assistant, Smart
Scheduler, Smart View, StartLabor, Start Quality, Start WIP, Starter Series, Timekeeper Decisions, Timekeeper Web,
VisionPlus, Winstar Elite, WIP Plus, Workforce Activities, Workforce Attendance, Workforce Connect, Workforce
Employee, Workforce HR, Workforce Leave, Workforce Manager, Workforce MobileTime, Workforce Payroll,
Workforce Record Manager, Workforce Recruiter, Workforce Scheduler, Workforce Scheduler with Optimization,
Workforce Smart Scheduler, Workforce Tax Filing, Workforce Timekeeper, and Workforce View are trademarks of
Kronos Incorporated or a related company.
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.
Chapter 1: Introduction
Using the tag descriptions ........................................................................... 20
4 Kronos Incorporated
Contents
6 Kronos Incorporated
Contents
8 Kronos Incorporated
Contents
10 Kronos Incorporated
Contents
12 Kronos Incorporated
Contents
Index
14 Kronos Incorporated
About This Guide
This reference guide defines and describes the Kronos XML API for Version 5.1
of the Kronos® Workforce Central® suite.
This preface contains the following sections:
• “Organization of this guide” on page 16
• “Abbreviations and terms” on page 17
About This Guide
16 Kronos Incorporated
Abbreviations and terms
Abbreviation Term
API Application Program Interface
DTK Developer’s Toolkit
HTML Hypertext Markup Language
HTTP Hypertext Transfer Protocol
HTTPS Hypertext Transfer Protocol Secure
RDBMS Relational Database Management System
TCP/IP Transmission Control Protocol/Internet Protocol
URL Universal Resource Locator
XML Extensible Markup Language
18 Kronos Incorporated
Chapter 1
Introduction
This introduction explains the XML tag and syntax formats that are used in the
Kronos XML API reference documentation.
Chapter 1 Introduction
The XML tag name includes the technical name, or how the tag is referenced in
code, and the non-technical name, or how the tag is referenced in the XML Import
and Export Programmer Guides and the user interface.
Example technical name: CheckAdvice
Example non-technical name: Earnings History
XML tag description
The XML tag description gives an overview of what the XML tag is used for, and
specifies whether it is used by another XML tag. The description also includes tag
level validations, if they are not standard validations. For example, standard date
validation is not mentioned, but if the date must fall during the last week of a
month, the information is included.
Function access control point
The function access control point identifies the access point in the function access
profile that must be enabled to make an XML tag available to the user who made
the request.
Example: API.Timecard means that the user must have access to Timecard.
To validate whether you have the appropriate access rights, complete these steps
in Workforce Central Setup. Contact your system administrator if you do not have
access to Workforce Central Setup:
1. Click Access Profiles.
2. Select Function Access Profiles from the list on the left. Double-click the
function access profile that is associated with the client application’s access
right to the tag on the right; for example, IS.
3. The Edit Function Access Profile window opens. Expand the API and API
Beans entries to see all the function access control points.
20 Kronos Incorporated
Using the tag descriptions
4. Find the specified function access control point on the list and verify that it is
specified as Allowed.
Versions
The “introduced” version specifies the Workforce Central version number when
the tag was introduced. If the tag was modified since it was introduced, the
version when it was last changed is specified. If it has been modified in this
release and you are already using this tag, check your XML code to make sure it is
up-to-date.
If the tag has been marked for deprecation, this information is specified. A
deprecated item will be removed from the API in the next major release, or
after one year, whichever date is later.
Syntax
This section describes the abstract syntax for the XML tag. XML tag names,
action names, action parameters, and property names are case sensitive.
Example:
Request -->
<Request Action = Actions
Parameters >
Properties
</Request>
Actions --> "AddComment" | "AddOnly" | "Delete"
Parameters -->
[ AccrualOverride = Boolean ]
[ allowAdHoc = Boolean ]
[ EchoData = Boolean ]
Properties -->
<PayCodeMove
AmountInTimeOrCurrency = String
[ CommentText = String ]
Date = Date
( EnteredOnDate = Date )
( EnteredOnTime = Time )
[ FromLaborAccountName = String ]
FromPayCodeName = String
[ LaborAccountName = String ]
[ ManagerName = String ]
OrgJobId = String
[ OrgJobName = String ]
PayCodeName = String >
( <Comments>
<Comment>*
</Comments> )
<Employee>
<CurrentUser> | <PersonIdentity>
</Employee>
</PayCodeMove>
Conventions
22 Kronos Incorporated
Using the tag descriptions
• Contained API tags—If the syntax of the primary XML tag requires another
XML tag, which is not assigned to any property within the primary tag, a
container API tag is used to specify a placeholder for the other tag.
Action descriptions
The property description describes all of the properties specified for an XML tag.
• The property name includes the technical name, or how the property is
referenced in code; and the non-technical name, or how the property is
referenced in the XML Import and Export Programmer Guides and the user
interface.
• The description describes each property, including validation rules.
• Allowed Values identifies a predefined set of allowable values for the
property.
• The Default Value item identifies a default value, where appropriate.
• The Contributes to Uniqueness item identifies properties that are required as
part of the unique identification of an instance of a tag.
• Groups of Mutually Exclusive Properties specifies if any of the properties in a
tag are mutually exclusive. For example, in the EarnedAccruals tag, you can
specify the AmountInTime or the AmountInCurrency property, but not both.
• The “introduced” version specifies the Workforce Central version number
when the property was introduced. If the property was modified since it was
introduced, the version when it was last changed is specified. If it has been
modified in this release and you are already using this property, check your
XML code to make sure it is up-to-date.
If the property has been marked for deprecation, this information is specified.
A deprecated item will be removed from the API in the next major release,
or after one year, whichever date is later.
24 Kronos Incorporated
Chapter 2
XML API Tag Definitions
This chapter lists and describes the XML API tags, in alphabetical order.
Chapter 2
AccessAssignment Tag
Access Rights
The AccessAssignment tag enables you to specify access rights for a person.
Access rights can also be displayed and edited online in the People Editor. The
user of this tag must have access rights to view or edit the specified data.
Used by: PersonInformation
Dependency: Access to this information is controlled through the Role View
access control point. The user must have view or add access rights to retrieve or
modify the information in this tag.
Function Access Control Point: API.Person
Introduced in v4; last changed in v5.1
Syntax
Properties→
<AccessAssignment
[ AccessProfileName = String ]
[ AvailabilityPatternName = String ]
[ GroupScheduleName = String ]
[ ManagerAccessSetName = String ]
[ ManagerPayCodeName = String ]
[ ManagerTransferSetName = String ]
[ ManagerWorkRuleName = String ]
[ PreferenceProfileName = String ]
[ ProfessionalPayCodeName = String ]
[ ProfessionalTransferSetName = String ]
[ ProfessionalWorkRuleName = String ]
[ ReportName = String ]
[ SchedulePatternName = String ]
[ ShiftCodeName = String ]
[ TimeEntryTypeName = String ]
[ TransferEmployeeFlag = Boolean ] />
Property Descriptions
AccessProfileName
Function access profile
26 Kronos Incorporated
AccessAssignment Tag
The name of the person's function access profile. The function access profile
contains a set of permissions and restrictions that determine which components
users can access and the types of functions they can perform. For information
about function access profiles and related concepts, see the online help.
Type: String
Optional
Maximum length: 50 characters
Dependency: Only specify for a person who has a manager's license
Default Value: The Empty Data Access Profile
Introduced in v5.0; last changed in v5.1
ManagerAccessSetName
Employee group profile
The name of the labor level set that is the manager's employee group when an
individual is in a manager role. This gives the manager access to the records of
those individuals whose primary accounts are in that labor level set.
Workforce provides the following predefined data values:
• &ALL_LABOR_ACCOUNTS
• &EMPTY
Dependency: ManagerAccessSetName is only used for an employee who has a
user account.
Type: String
Optional
Maximum length: 30 characters
28 Kronos Incorporated
AccessAssignment Tag
Must have a labor account set type of Employee Groups (Manager) or All Sets
(Both Manager and Transfer)
Introduced in v4; last changed in v5.1
ManagerPayCodeName
Pay codes profile - manager
The name of the pay code profile that applies to an individual when in a manager
role. A pay code profile identifies those pay codes that the manager can select.
Workforce provides the following predefined data values:
• &ALL_PAY_CODES
• &EMPTY
Type: String
Optional
Maximum length: 50 characters
Dependency: Only specify for a person who has a manager's license.
Introduced in v4; last changed in v5.1
ManagerTransferSetName
Labor level transfer set - manager
The name of the labor level transfer set that applies to an individual when in a
manager role. A labor level transfer set is a group of labor level entries that a
manager or employee can use to transfer time or money.
Workforce provides the following predefined data values:
• &ALL_LABOR_ACCOUNTS
• &EMPTY
Type: String
Optional
Maximum length: 30 characters
Must be identified as a labor account set and have a Type of Employee Groups
(Manager) or All Sets (Both Manager and Transfer)
30 Kronos Incorporated
AccessAssignment Tag
32 Kronos Incorporated
AccessAssignment Tag
SchedulePatternName
Pattern template profile
Contains the name of a manager's pattern template profile. Pattern templates
contain a series of shifts that managers can assign to multiple employees. This
pattern template profile identifies those pattern templates that the individual can
select when in a manager's role.
Workforce provides the following predefined data values:
• &ALL_SCHEDULE_PATTERNS
• &EMPTY
Type: String
Optional
Maximum length: 50 characters
Dependency: Only specify for a person who has a manager license.
You can find values in the Workforce Timekeeper Setup Application.
Default Value: The Empty Data Access Profile
Introduced in v5.0; last changed in v5.1
ShiftCodeName
Shift template profile
The name of the shift template profile that an individual can use when in a
manager's role. A shift template is a shift with all its segments that a manager can
assign to multiple employees and reuse as needed, and a shift template profile is a
group of shift templates.
Workforce provides the following predefined data values:
• &ALL_SHIFT_CODES
• &EMPTY_PROFILE
Type: String
Optional
Maximum length: 50 characters
Dependency: Only specify for a person who has a manager license
34 Kronos Incorporated
AccessProfile Tag
AccessProfile Tag
Access Profile
The AccessProfile tag provides information about access controls. Use it to check
a specific access control prior to attempting to perform an action, such as edit.
Access profiles are created in Workforce Central Setup and are assigned to people
in the online People Editor.
The tag provides the following types of information:
• Access Control Points identify the types of access that can be made available;
for example, whether access can be made available for HomeLaborAccount.
• Actions identify what a user can do with data; for example, edit.
• Suite Products identify components of the system that can be made available;
for example, DCM.
Function Access Control Point: API.AccessProfile
Introduced in v4; last changed in v5.0
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Actions→
"IsPermitted" |
"Load" |
"LoadAllAccessControlPointNames" |
"LoadAllActionNames" |
"LoadAllowedPermissions" |
"LoadAllSuiteProductNames"
Parameters→
AccessControlPointName = String
ActionName = String
[ PersonNumber = String ]
SuiteProductName = String
Properties→
<AccessProfile
[ AccessProfileName = String ]
( Description = String ) />
Action Descriptions
IsPermitted
Returns a value that denotes whether the specified combination of person, access
control point, action, and suite product has access rights.
Returns either True or False
Return Value Type: SimpleValue tag
Access Control Point Name: View
Introduced in v4
Action Parameters
Load
Returns the access profile name and description for the specified access profile.
If the access profile name is specified, it must exist in the system. If the access
profile name is not specified, the default access profile is used.
Return Value Type: AccessProfile tag
36 Kronos Incorporated
AccessProfile Tag
Property Descriptions
AccessProfileName
Access profile name
The name of the person's function access profile. The function access profile
determines the Workforce Timekeeper components that users can access and the
types of functions that users can perform within Workforce Timekeeper, based on
their assigned roles.
For example, access profiles for Managers can include permission to edit
schedules and timecards. The same profile can be assigned to a group of similar
users, such as managers in the same department. The system administrator creates
the access profiles in Workforce Central Setup. Refer to the Workforce Central
System Administrator's Guide-Timekeeping for an explanation of the roles.
Workforce Timekeeper provides the following predefined data values:
• &OTHER_MANAGER
• &PAYROLL_MANAGER
• &IS
• &TIMESTAMP_EMPLOYEE
• &WORKFORCE_EMPLOYEE
• &DEFAULT
Type: String
Optional,
Maximum length: 50 characters
Default Value: As specified in the Access Profile editor of the Workforce Central
Setup
Contributes to Uniqueness: Yes
Introduced in v4; last changed in v5.0
Description
Description
Describes the access profile.
Type: String
38 Kronos Incorporated
AccessProfile Tag
Output Only
Maximum length: 250 characters
Introduced in v4
AccrualBalanceLimit Tag
Accrual Balance Limit (unsupported)
THIS TAG IS NOT SUPPORTED FOR THIRD-PARTY USE INCLUDING
WORKFORCE CONNECT. This tag represents an accrual balance test
condition. The left side of the expression is an accrual code. The operator is a
normal mathematical equality operator and the right side of the expression
represents a limiting value. If the balance associated with the accrual code does
not meet the limiting criteria, the test fails.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Properties→
<AccrualBalanceLimit
AccrualCode = String
Limit = TimeDuration
Operator = String />
Property Descriptions
AccrualCode
Accrual code
The name of an accrual code.
Type: String
Required
The name must match an exiting Accrual Code defined in Workforce Central
Setup.
Introduced in v5.0.a
Limit
Limit
An amount of time in days.
40 Kronos Incorporated
AccrualBalanceLimit Tag
Type: TimeDuration
Required
Introduced in v5.0.a; last changed in v5.1
Operator
Operator
The comparison operator to use when comparing the actual balance in the given
Accrual Code versus the Limit.
Type: String
Required
Valid values are Less than, Less than or equal to, Equal to, More than or equal to,
More than, Not equal to.
Only Allowed Values: Less than, Less than or equal to, Equal to, More than or
equal to, More than, Not equal to
Sample values: Less than
Introduced in v5.0.a
AccrualBalanceSummary Tag
Accrual Balance for a Person
The AccrualBalanceSummary tag returns data about an accrual balance for one
person.
Used by: AccrualData, EmployeeSummary
Function Access Control Point: API.Accruals
Introduced in v4; last changed in v5.1
Syntax
Properties→
<AccrualBalanceSummary
( AccrualCodeId = Long )
( AccrualCodeName = String )
( AccrualType = Long )
( EncumberedBalanceInCurrency = Currency )
( EncumberedBalanceInTime = TimeDuration )
( HoursPerDay = TimeDuration )
( ProbationaryBalanceInCurrency = Currency )
( ProbationaryBalanceInTime = TimeDuration )
( ProjectedBalanceInCurrency = Currency )
( ProjectedBalanceInTime = TimeDuration )
( ProjectedDate = Date )
( ProjectedGrantAmountInCurrency = Currency )
( ProjectedGrantAmountInTime = TimeDuration )
( ProjectedProbationaryBalanceInCurrency = Currency )
( ProjectedProbationaryBalanceInTime = TimeDuration )
( ProjectedTakingAmountInCurrency = Currency )
( ProjectedTakingAmountInTime = TimeDuration )
( ProjectedVestedBalanceInCurrency = Currency )
( ProjectedVestedBalanceInTime = TimeDuration )
( VestedBalanceInCurrency = Currency )
( VestedBalanceInTime = TimeDuration ) />
Property Descriptions
AccrualCodeId
Accrual code Id
42 Kronos Incorporated
AccrualBalanceSummary Tag
44 Kronos Incorporated
AccrualBalanceSummary Tag
ProjectedGrantAmountInCurrency
Projected grant amount, in currency
The amount of money scheduled for future grants between the selected date and
the furthest projected grant date.
Type: Currency
Output Only
Contains a value if the accrual is a monetary type
Introduced in v4; last changed in v5.1
ProjectedGrantAmountInTime
Projected grant amount, in time
The amount of time scheduled for future grants between the selected date and the
furthest projected grant date.
Type: TimeDuration
Output Only
Contains a value if the accrual is a time type
Introduced in v4; last changed in v5.1
ProjectedProbationaryBalanceInCurrency
Projected probationary balance, in currency
The projected probationary balance expressed as an amount of money. A
probationary amount is one that cannot be taken or paid out. A balance that is
given to a person for a probationary period can be transferred as a vested amount
once the person has worked through the probationary period.
Type: Currency
Output only
Introduced in v5.0; last changed in v5.1
ProjectedProbationaryBalanceInTime
Projected probationary balance, in time
The projected probationary balance expressed as an amount of time. A
probationary amount is one that cannot be taken or paid out. A balance that is
46 Kronos Incorporated
AccrualBalanceSummary Tag
ProjectedVestedBalanceInTime
Projected vested balance, in time
The current vested balance of time minus all projected takings and plus all
projected vested credits up through the furthest projected taking date. This
balance includes any scheduled resets.
Type: TimeDuration
Output only
Introduced in v5.0; last changed in v5.1
VestedBalanceInCurrency
Vested balance, in currency
The amount of money that is vested in the employee's account. A vested amount is
one that can be taken or paid out.
Type: Currency
Output Only
Contains a value if the accrual is a monetary type
Introduced in v4; last changed in v5.1
VestedBalanceInTime
Vested balance, in time
The amount of time that is vested in the employee's account. A vested amount is
one that can be taken or paid out.
Type: TimeDuration
Output Only
Contains a value if the accrual is a time type
Introduced in v4; last changed in v5.1
48 Kronos Incorporated
AccrualCode Tag
AccrualCode Tag
Accrual Code
The AccrualCode tag defines details about an accrual code. Accrual codes
identify categories of time or money that employees earn, such as vacation, sick
time, and bonus. Amounts can be hours, days, or money.
Function Access Control Point: API.Accruals
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "LoadAllAccrualCodes"
Properties→
<AccrualCode
( Abbreviation = String )
( AccrualCodeName = String )
( DisplayType = String )
( HoursPerDay = TimeDuration ) />
Action Descriptions
LoadAllAccrualCodes
Returns information for all accrual codes
Return Value Type: Zero or more AccrualCode tags
Access Control Point Name: View
Introduced in v4; last changed in v5.1
Property Descriptions
Abbreviation
The abbreviation of the accrual code, which can be up to three characters. This
abbreviation may appear on selected reports.
Abbreviation of the accrual code name.
Type: String
Output Only
Introduced in v4
AccrualCodeName
Accrual code name
A named account identifying a category of time or money that employees earn.
Type: String
Output Only
You can find values in the Workforce Timekeeper Setup Application.
Sample values: Vacation, Sick
Introduced in v4; last changed in v5.1
DisplayType
The type of accrual code, which can be money, hours, or days.
Suggested display type of the value.
Type: String
Output Only
Only Allowed Values: Hours, Days, Currency
Introduced in v4
HoursPerDay
The number of hours per day that constitutes a day of this accrual code. This value is
used to convert hours to days.
Number of hours in an accrual day.
Type: TimeDuration
Output Only
50 Kronos Incorporated
AccrualCode Tag
AccrualData Tag
Accrual Data for Employee
The AccrualData tag gets accrual balance information for the specified employee
on the specified date.
Used by: EmployeeSummary
Function Access Control Point: API.Accruals
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Load"
Properties→
<AccrualData
BalanceDate = Date >
( <AccrualBalances>
<AccrualBalanceSummary>∗
</AccrualBalances> )
<Employee>
<CurrentUser> | <PersonIdentity>
</Employee>
</AccrualData>
Action Descriptions
Load
Returns one summary for each accrual code for the specified employee and date.
Only returns one employee
Return Value Type: AccrualData tag
Required Properties: Employee, BalanceDate
Access Control Point Name: View
52 Kronos Incorporated
AccrualData Tag
Introduced in v4
Property Descriptions
AccrualBalances
The balance amounts in all accrual codes for the specified employee
One or more sets of accrual summaries that represent all accrual codes found for
the employee at the specified date.
Type: Zero or more AccrualBalanceSummary tags
Output Only
Introduced in v4; last changed in v5.1
BalanceDate
The date specified for the accrual balances being retrieved. Balance date is required.
The date specified for the accrual balances. The vested balance is as of this date.
Type: Date
Required,
Contributes to Uniqueness: Yes
Introduced in v4; last changed in v5.1
Employee
The employee whose accrual data is being retrieved. Employee is required.
The employee whose accrual data is being retrieved. Employee is required and
must be an existing and active employee, as specified in a PersonIdentity or
CurrentUser tag.
Type: Either CurrentUser or PersonIdentity tag
Required
Must uniquely identify an existing and active employee.
Contributes to Uniqueness: Yes
Introduced in v4
AccrualMove Tag
Accrual Move
The AccrualMove tag moves an accrued amount from one accrual code to
another. For example, depending on your companyís policies and the user's access
rights, a user might be able to move an employeeís accrued sick time to the
employee's vacation time.
Dependency: All rules related to applying an accrual move apply to this tag and its
actions.
Function Access Control Point: API.Accruals
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Update"
Properties→
<AccrualMove
AmountInCurrency = Currency
AmountInTime = TimeDuration
Date = Date
GivingEmployeeAccrualCodeName = String
TakingEmployeeAccrualCodeName = String >
<GivingEmployee>
<CurrentUser> | <PersonIdentity>
</GivingEmployee>
<TakingEmployee>
<CurrentUser> | <PersonIdentity>
</TakingEmployee>
</AccrualMove>
Action Descriptions
54 Kronos Incorporated
AccrualMove Tag
Update
Moves an accrual amount from one employee accrual code to another.
The amount of the accrual is also required. Specify either an AmountInCurrency
or an AmountInTime.
Return Value Type: None
Required Properties: GivingEmployeeAccrualCodeName,
TakingEmployeeAccrualCodeName, Date, GivingEmployee, TakingEmployee
Access Control Point Name: Edit
Introduced in v4
Property Descriptions
AmountInCurrency
Amount of accrual, in currency
An accrual amount expressed as money.
Type: Currency
See group( Amount)
Maximum length: 30 characters
Introduced in v4; last changed in v5.1
AmountInTime
Amount of pay code, in time
A pay code amount, expressed as time.
Type: TimeDuration
See group( Amount)
The accrual amount that should be assigned to the employee if the accrual code is
an hour or daily accrual code.
Introduced in v4; last changed in v5.1
Date
Effective date
The date when the accrual move takes effect.
Type: Date
Required
Introduced in v4; last changed in v5.1
GivingEmployee
Employee who is giving
One employee, as specified in a PersonIdentity or CurrentUser tag, from whom
the accrual will be deducted.
Type: Either CurrentUser or PersonIdentity tag
Required
Must uniquely identify an existing and active employee
Contributes to Uniqueness: Yes
Introduced in v4
GivingEmployeeAccrualCodeName
Accrual code the accrual is moved from
Accrual code (such as sick or vacation) that you want to move to another accrual
code.
Type: String
Required
Maximum length: 50 characters
You can find values in the Workforce Timekeeper Setup Application. Use a value
that is assigned to the employee, as specified in the accrual profile.
Introduced in v4; last changed in v5.1
TakingEmployee
Employee who is taking
One employee, as specified in a PersonIdentity or CurrentUser tag, to whom the
accrual will be assigned. This employee can be the same as the GivingEmployee,
or it can be a different employee.
Type: Either CurrentUser or PersonIdentity tag
Required
56 Kronos Incorporated
AccrualMove Tag
AccrualPatternElement Tag
Accrual Pattern Element
The AccrualPatternElement tag represents a schedule day allocated to a specific
accrual code.
Used by: ScheduleAccrualPattern
Function Access Control Point: API.Schedule
Introduced in v4; last changed in v5.0
Syntax
Properties→
<AccrualPatternElement
DayNumber = Integer />
Property Descriptions
DayNumber
Day number in the pattern
Specifies the day of the pattern.
Type: Integer
Required
Must be greater than zero
Introduced in v4
58 Kronos Incorporated
AccrualProfile Tag
AccrualProfile Tag
Accrual Profile
The AccrualProfile tag provides information about the accrual profile assigned to
a group of employees. The accrual profile defines a set of accrual rules that apply
to the employees to which the accrual profile is assigned. For example, one profile
can be assigned to all full-time employees and another can be assigned to all part-
time employees.
Function Access Control Point: API.Accruals
Introduced in v4; last changed in v4.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
Load
Returns an accrual profile.
Name should be valid
Return Value Type: AccrualProfile tag
Required Properties: AccrualProfileName
Access Control Point Name: View
Introduced in v4
LoadAllAccrualProfiles
Returns all accrual profiles in the system.
Return Value Type: Zero or more AccrualProfile tags
Access Control Point Name: View
Introduced in v4
LoadById
Returns an accrual profile, based on the specified AccrualProfileId.
Return Value Type: AccrualProfile tag
Required Properties: AccrualProfileID
Access Control Point Name: View
Introduced in v4
Property Descriptions
AccrualProfileId
Accrual profile Id
A unique identifier for the accrual profile.
Type: Integer
Optional
Introduced in v4
AccrualProfileName
Accrual profile
The accrual profile to be used for a person or group. Accrual profiles are based on
your companyís accrual rules and policies that apply to similar groups of
employees. The rules determine how employees accrue their time or money, or
both. When an employee uses accrued time or money, specified amounts are
deducted from the balance. When an employee receives or earns time or money,
specified amounts are credited to the balances.
Type: String
Optional
60 Kronos Incorporated
AccrualProfile Tag
AdHocLaborAccount Tag
Ad Hoc Labor Account
The AdHocLaborAccount tag enables the creation of an ad hoc labor level
account.
An ad hoc labor level account can be created only if it does not already exist, and
if at least one of the labor level entries needs to be created.
Function Access Control Point: API.LaborLevel
Introduced in v4; last changed in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "CreateAdHoc"
Properties→
<AdHocLaborAccount
FieldDefinitionName = String
LaborAccountName = String />
Action Descriptions
CreateAdHoc
Adds an ad hoc labor account
Return Value Type: None
Required Properties: LaborAccountName
Access Control Point Name: Edit
Introduced in v4
Property Descriptions
62 Kronos Incorporated
AdHocLaborAccount Tag
FieldDefinitionName
Field definition name
Activity form substep's field definition name.
Type: String
Required
Must match an existing field definition name
Introduced in v5.0
LaborAccountName
Labor account
Name of the labor level account to be created ad hoc.
Enter data for labor accounts in the same format as they appear in the database.
For example, if you have a seven-level labor account, specify a value for each
labor level: 101/202/303/404/504/603/702.
Do not specify labor levels that are not changing.
If any of the labor levels are the same as the employeeís primary labor account,
you can enter @H for those labor levels instead of entering the labor entry names.
Type: String
Required
Maximum length: 356 characters
The user and labor level account must allow ad hoc access
Introduced in v4
AppendShifts Tag
Append shifts
The AppendShifts tag adds time to the beginning or end of a given shift.
Function Access Control Point: API.Schedule
Introduced in v5.1
Syntax
Properties→
<AppendShifts
AppendDurationAmount = TimeDuration
AppendToBeginOrEnd = Boolean
EffectiveDate = Date
[ LaborAccountName = String ]
[ OrgJobPath = String ]
[ WorkRuleName = String ] />
Property Descriptions
AppendDurationAmount
Amount of time to be appended
AppendDurationAmount
Type: TimeDuration
Required
Introduced in v5.1
AppendToBeginOrEnd
Append to the beginning?
AppendToBeginOrEnd property.
Type: Boolean
Required
Introduced in v5.1
64 Kronos Incorporated
AppendShifts Tag
EffectiveDate
Effective date
EffectiveDate property
Type: Date
Required
Introduced in v5.1
LaborAccountName
Labor account
LaborAccountName property.
Type: String
Optional
Introduced in v5.1
OrgJobPath
Organizational job path
OrgJobPath property.
Type: String
Optional
Introduced in v5.1
WorkRuleName
Work rule
WorkRuleName property.
Type: String
Optional
Introduced in v5.1
ApprovalStatus Tag
Approval Status
This tag describes the Approval Status of a leave case.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update" |
"UpdateOnly"
Properties→
<ApprovalStatus
DefaultSwitch = Boolean
[ Description = String ]
IsActive = Boolean
Name = String
OrderNumber = Integer />
Action Descriptions
AddOnly
Adds an Approval Status.
Return Value Type: None
Required Properties: Name, IsActive, OrderNumber, DefaultSwitch
66 Kronos Incorporated
ApprovalStatus Tag
Property Descriptions
DefaultSwitch
default flag
Indicates whether the Approval Status is used as the default.
Type: Boolean
Required
Default Value: false
Sample values: true
68 Kronos Incorporated
ApprovalStatus Tag
Introduced in v5.1
Description
description
Description of the status. It can be up to 250 characters long.
Type: String
Optional
Sample values: Description of the status.
Introduced in v5.1
IsActive
Active Flag
Indicates whether the Approval Status is active.
Type: Boolean
Required
Default Value: true
Sample values: true
Introduced in v5.1
Name
Name
The name of the Approval Status.
Type: String
Required
The max string length is 50. The name is unique.
Introduced in v5.1
OrderNumber
Order Number
The order number of the Approval Status.
Type: Integer
Required
70 Kronos Incorporated
ApproveSignoff Tag
ApproveSignoff Tag
Approve Timecard
The ApproveSignoff tag enables the user to manage the approval and signoff
aspects of a timecard.
Function Access Control Point: API.Timecard
Introduced in v4
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"Approve" |
"PeriodIsApproved" |
"PeriodIsSignedOff" |
"RemoveApproval" |
"RemoveOthersApproval" |
"RemoveSignOff" |
"SignOff"
Properties→
<ApproveSignoff
[ DataSource = String ]
[ UserName = String ] >
<Employee>
<CurrentUser> | <PersonIdentity>
</Employee>
[ <Period>
<TimeFramePeriod>
</Period> ]
</ApproveSignoff>
Action Descriptions
Approve
Approves the specified employee's timesheet.
72 Kronos Incorporated
ApproveSignoff Tag
Property Descriptions
DataSource
Data source
The data source that identifies the user who performed a timecard approval.
This value is only relevant for the RemoveOthersApproval action.
Type: String
Optional
Maximum length: 10 characters
Introduced in v4
Employee
Employee
One employee whose time is to be approved or signed off, as specified in a
PersonIdentity or CurrentUser tag.
74 Kronos Incorporated
Attribute Tag
Attribute Tag
Attribute for process or task
The Attribute tag identifies an attributes for either a process or a task.
Used by: Process, ProcessTask
Function Access Control Point: com.kronos.wfc.business.workflow.Kattribute
Introduced in v5.1
Syntax
Properties→
<Attribute
Name = String
Value = String />
Property Descriptions
Name
Attribute name
Name of the attribute. Each attribute must contain both a name and a value.
Type: String
Required
Maximum length: 255 characters
Sample values: HRAdministrator
Contributes to Uniqueness: Yes
Introduced in v5.1
Value
Attribute value
The value for the attribute. Each attribute must contain both a name and a value.
Type: String
Required
76 Kronos Incorporated
AuthenticationType Tag
AuthenticationType Tag
Authentication Type
The AuthenticationType tag retrieves all AuthenticationType objects.
Function Access Control Point: API.People
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "RetrieveAll"
Properties→
<AuthenticationType
( AuthTypeName = String ) />
Action Descriptions
RetrieveAll
Retrieves all AuthenticationType objects from the database.
None
Return Value Type: Zero or more AuthenticationType tags
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
AuthTypeName
Authentication type
Name of the authentication type.
Type: String
Output only
Introduced in v5.1
78 Kronos Incorporated
BadgeAssignment Tag
BadgeAssignment Tag
Badge Assignment
The BadgeAssignment tag assigns a badge number to an employee.
Used by: PersonInformation
Function Access Control Point: API.Person
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "LoadBadgeAssignments"
Properties→
<BadgeAssignment
BadgeNumber = String
EffectiveDate = DateTime
[ ExpirationDate = DateTime ] >
[ <Identity>
<CurrentUser> | <PersonIdentity>
</Identity> ]
[ <Period>
<TimeFramePeriod>
</Period> ]
</BadgeAssignment>
Action Descriptions
LoadBadgeAssignments
Assigns a badge number to a person for a specified time period. If no time period
is specified, the time period begins with the current date and time and continues
indefinitely. An empty tag (with only the Identity and Period properties) results
when no data for the person or period is found.
The person must exist and the user must have access to that person.
Property Descriptions
BadgeNumber
Badge number
The badge number that you want to assign to the employee.
The system can be configured to allow multiple badges for employees using the
global.BadgeAssignment.allowsOverlap property. For information, see the
System Settings information in online help. If an employee is assigned multiple
badge numbers, each badge number and associated information is added in a
separate request. If an employee is assigned multiple badge numbers and you
want to remove one of the badge numbers, first remove all existing badge
numbers and then reassign the badge number that you want to keep.
Type: String
Required
Maximum length: 25 characters
Must be unique for the specified date span. Validation is done after a person is
associated with a badge, using the PersonInformation tag.
Introduced in v4; last changed in v5.1
EffectiveDate
Effective date and time
The date and time when the badge number assignment becomes effective. If this is
blank, the current date and time are used.
Type: DateTime
Required
Must occur before the expiration date
80 Kronos Incorporated
BadgeAssignment Tag
Default Value: If only the date is specified, the time defaults to 12:00am; that is,
midnight.
Introduced in v4; last changed in v5.1
ExpirationDate
Expiration date and time
The date and time when the badge number assignment expires. If this is blank, the
badge number assignment continues indefinitely.
Type: DateTime
Optional
Must occur after the effective date
If only the date is specified, the time defaults to 12:00am; that is, midnight.
Default Value: January 1, 3000
Introduced in v4; last changed in v5.1
Identity
Identity
The person to whom the badge number is assigned, as specified in a
PersonIdentity or CurrentUser tag.
Type: Either CurrentUser or PersonIdentity tag
Optional
Must uniquely identify a person.
Contributes to Uniqueness: Yes
Introduced in v5.0; last changed in v5.1
Period
Time period
The time span that is associated with the badge assignments.
Type: TimeFramePeriod tag
Optional
The specified identity is used when the time frame requires an association with a
person.
82 Kronos Incorporated
Bid Tag
Bid Tag
Bid
This is an abstract bid bean that describes the generic bid which the employee
submits, once the manager sends on a bid request.
The validate method validates the contents of the bean. When it returns normally,
the bean is believed to be valid for posting to the database.
For Action BidGroupItem AddBids, the vacation bid BidGroupItemId property
should match the BidGroupItem BidGroupItemId property.
Function Access Control Point: API.Bid
Introduced in v5.0.a
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<Bid
BidGroupItemId = Long
BidId = Long
Priority = Integer
( Status = String ) >
[ <BidNotes>
<BidNote>∗
</BidNotes> ]
</Bid>
Action Descriptions
ApplyBidNotes
Applies the specified bid notes to the bid specified by the bid id. Existing bid
notes are deleted and the specified ones are inserted.
For the ApplyBidNotes Action, the BidId property and the BidNotes property
MUST be defined.
Return Value Type: None
Required Properties: BidId, BidNotes
Access Control Point Name: Edit
Introduced in v5.0; last changed in v5.0.a
DeleteBidNotes
Deletes all bid notes associated with the bid represented by this bid bean.
For the DeleteBidNotes Action, the BidId property MUST be defined.
Return Value Type: None
Required Properties: BidId
Access Control Point Name: Edit
Introduced in v5.0; last changed in v5.0.a
Property Descriptions
BidGroupItemId
Bid Group Item Id
Id of the bid group item that this bid belongs to.
Type: Long
Required
If the property is defined for an Action, the BidGroupItemId cannot be null. The
BidGroupItemId MUST be defined for the VacationBid element in the
BidGroupItem BidList for adding bids.
Sample values: <VacationBid BidGroupItemId="3" Priority="5" StartDate="04/
01/2004 00:00:00" EndDate="05/01/2004 11:48:56" HoursPerDay="288000"
CreateOpenShift="false">
</VacationBid>
Contributes to Uniqueness: Yes
Introduced in v5.0; last changed in v5.0.a
84 Kronos Incorporated
Bid Tag
BidId
Bid Id
Unique identifier for this bid.
Type: Long
Required
If defined for an Action, the BidId property cannot be null. The BidId property
MUST NOT be specified for the BidGroupItem AddBids Action. The BidId
property MUST be defined for the ApplyBidNotes, DeleteBidNotes,
BidGroupItem RemoveBids Actions.
Contributes to Uniqueness: Yes
Introduced in v5.0; last changed in v5.0.a
BidNotes
Bid Notes
List of BidNotes to add a specific bid.
Type: Zero or more BidNote tags
Optional
If defined for an Action, the BidNotes property cannot be null. The contents of the
BidNotes list cannot be null. The BidNotes property MUST contain one or more
BidNote elements. The BidNotes property MUST be specified for the
ApplyBidBNotes Action.
Sample values: <VacationBid Id="501">
<BidNotes>
<BidNote Sequence="1" Text="For vacation bid with Id=501"></BidNote>
</BidNotes>
</VacationBid>
Introduced in v5.0; last changed in v5.0.a
Priority
Bid Priority
Bid priority. Also known as rank.
Type: Integer
Required
If the Priority property is defined for an action, the Priority property cannot be
null. The Priority cannot be less than 1.
Sample values: <VacationBid BidGroupItemId="3" Priority="1" StartDate="04/
01/2004 00:00:00" EndDate="05/01/2004 11:48:56" HoursPerDay="288000"
CreateOpenShift="false">
</VacationBid>
Introduced in v5.0; last changed in v5.0.a
Status
Bid status
The status of the bid, which may be 1 of 3 states : Submitted, Approved, Rejected.
Type: String
Output only
The BidStatus property cannot be defined for any BidGroupItem, Bid, or Vacation
Bid Action.
Only Allowed Values: Submitted - 0, Approved - 1, Rejected - 2
Default Value: Submitted, 0
Sample values: Submitted - 0, Approved - 1, Rejected - 2
Introduced in v5.0; last changed in v5.0.a
86 Kronos Incorporated
BidGroup Tag
BidGroup Tag
Bid Group
This tag identifies the bidding group where one or more employees may belong
to.
The validate method validates the contents of the bean. When this method returns
normally, the bean is believed to be valid for posting to the database.
Function Access Control Point: API.BidGroup
Introduced in v5.0.a
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"Load" |
"LoadByBidRequest" |
"Update" |
"UpdateOnly"
Properties→
<BidGroup
BidGroupId = Long
BidRequestId = Long
CloseDate = DateTime
[ Description = String ]
Name = String
[ NotificationText = String ]
OpenDate = DateTime
ShiftOverride = Boolean />
Action Descriptions
AddOnly
Adds a new bid group.
For the AddOnly Action, the BidRequestId property, the Name property, the
OpenDate property, the CloseDate property, and the ShiftOverride property
MUST be specified and valid values. The BidGroupId MUST NOT be specified
for the AddOnly Action.
Return Value Type: BidGroup tag
Required Properties: BidRequestId, Name, OpenDate, CloseDate, ShiftOverride
Optional Properties: NotificationText
Access Control Point Name: Edit
Introduced in v5.0.a
Delete
Deletes a bid group.
For the Delete Action, the BidGroupId MUST be specified and set to a valid
BidGroupId value.
Return Value Type: None
Required Properties: BidGroupId
Access Control Point Name: Edit
Introduced in v5.0.a
Load
Loads bid group given the specific BidGroupID.
For the Load Action, the BidGroupId MUST be specified and set to a valid
BidGroupId value.
Return Value Type: BidGroup tag
Required Properties: BidGroupId
Access Control Point Name: View
Introduced in v5.0.a
LoadByBidRequest
Loads all bid groups for a given bid request.
88 Kronos Incorporated
BidGroup Tag
Property Descriptions
BidGroupId
Bid Group Id
Identifies a unique bid group.
Type: Long
Required
If defined for an Action, the BidGroupId cannot be null. The BidGroupId MUST
be equal to or greater than 1. The BidGroupId MUST NOT be defined for
AddOnly Action. The BidGroupId MUST be defined for Delete, Load, Update,
and UpdateOnly Actions.
Contributes to Uniqueness: Yes
Introduced in v5.0.a
BidRequestId
Bid Request Id
Identifies the parent bid request.
Type: Long
Required
If defined for an Action, the BidRequestId cannot be null. If the BidRequestId
property is defined for an Action, it MUST be a valid id for a specific Bid
Request. The BidRequestId MUST be defined for AddOnly, LoadByBidRequest,
and Update Actions.
Contributes to Uniqueness: Yes
Introduced in v5.0.a
CloseDate
Close Date
Date on which bidding closes.
Type: DateTime
Required
90 Kronos Incorporated
BidGroup Tag
If defined for an Action, the CloseDate property cannot be null. The CloseDate
property must be defined for AddOnly and Update Actions.
Sample values: "04/20/2004 11:48:56"
Introduced in v5.0.a
Description
Bid Group Description
Description for bid group.
Type: String
Optional
If defined for an Action, the Description property cannot be null.
Introduced in v5.0.a
Name
Bid Group Name
Name for bid group.
Type: String
Required
If defined for an Action, the Name property cannot be null. The Name value
MUST be less than or equal to 250 characters. The Name property MUST be
specified for the AddOnly Action.
Introduced in v5.0.a
NotificationText
Notification Text
Text of the notification sent when the parent bid request is sent to the bidding
participants.
Type: String
Optional
If defined for an Action, the NotificationText property cannot be null. The
NotificationText property MUST be less than or equal to 4000 characters in
length.
Introduced in v5.0.a
OpenDate
Open Date
Date on which bidding opens.
Type: DateTime
Required
If defined for an Action, OpenDate property cannot be null. The OpenDate
property MUST be specified for the AddOnly and Update Actions.
Sample values: "04/20/2004 00:00:00"
Introduced in v5.0.a
ShiftOverride
Shift Override
Whether to override shifts when posting to schedule.
Type: Boolean
Required
If defined for an Action, the ShiftOverride property cannot be null. The
ShiftOverride property MUST be defined for the AddOnly Action.
Default Value: "false"
Sample values: "true" OR "false"
Introduced in v5.0.a
92 Kronos Incorporated
BidGroupItem Tag
BidGroupItem Tag
Bid Group Item
The BidGroupItem tag assigns one or more person(s) into a specific bid group.
Each person is identified by a specific person id and each bid group is identified
by a specific bid group id.
The BidSubmissionStatus may not be specified for any action.
All Actions are validated. The validate method validates the contents of the bean.
When the validation method returns normally, the bean is believed to be valid for
posting to the database.
Function Access Control Point: API.BidGroupItem
Introduced in v5.0.a
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"AddBids" |
"AddOnly" |
"Delete" |
"Load" |
"LoadByBidGroupAndPerson" |
"RemoveBids"
Properties→
<BidGroupItem
BidGroupId = Long
BidGroupItemId = Long
[ BidReceived = DateTime ]
( BidSubmissionStatus = String )
[ LastSubmitted = DateTime ]
PersonId = Long >
[ <BidList>
<VacationBid>∗
</BidList> ]
</BidGroupItem>
Action Descriptions
AddBids
Adds bids to an existing bid group item given the BidGroupItemId.
For the AddBids Action, the BidGroupItemId property and the BidList property
MUST be specified.
Return Value Type: BidGroupItem tag
Required Properties: BidGroupItemId
Optional Properties: BidGroupId, PersonId, LastSubmitted, BidReceived
Access Control Point Name: Edit
Introduced in v5.0; last changed in v5.0.a
AddOnly
Adds a new bid group item.
For AddOnly Action, the BidGroupItemId and the BidSubmissionStatus should
not be specified. The BidGroupId and PersonId should be valid id values and
specified for the AddOnly Action.
Return Value Type: BidGroupItem tag
Required Properties: BidGroupId, PersonId
Optional Properties: LastSubmitted, BidReceived
Access Control Point Name: Edit
Introduced in v5.0; last changed in v5.0.a
Delete
Deletes a bid group item given its BidGroupItemId.
For the Delete Action, the BidGroupItemId MUST be specified.
Return Value Type: None
Required Properties: BidGroupItemId
Optional Properties: BidGroupId, PersonId, LastSubmitted, BidReceived
Access Control Point Name: Edit
94 Kronos Incorporated
BidGroupItem Tag
Property Descriptions
BidGroupId
Bid Group Id
The id value for a specific bidding group. The BidGroupId is the id of the bid
group this bid group item belongs to.
Type: Long
Required
If defined for an Action, the BidGroupId MUST not be null. The BidGroupId
MUST be a valid id value which is able to retrieve a specific BidGroup bean. The
BidGroupId MUST be specified for AddOnly and LoadByBidGroupAndPerson
Actions.
Contributes to Uniqueness: Yes
Introduced in v5.0
BidGroupItemId
Bid Group Item Id
The specific id value for each bid group item. The BidGroupItemId identifies a
unique bid group item.
Type: Long
Required
If defined for an Action, BidGroupItemId cannot be null. The BidGroupItemId
property MUST not be defined for AddOnly Action, but MUST be defined for
Delete, Load, AddBids, and RemoveBids Actions. The BidGroupItemId cannot
be less than 1.
Contributes to Uniqueness: Yes
Introduced in v5.0; last changed in v5.0.a
BidList
Bid List
List of Bids to add to the bid group item.
Type: Zero or more VacationBid tags
Optional
96 Kronos Incorporated
BidGroupItem Tag
If defined for AddBids or RemoveBids Actions, the BidList cannot contain null
values. The BidList property may only be defined for the AddBids and
RemoveBids Actions.
Introduced in v5.0
BidReceived
Date Bid Received
The date on which the bid request was last received by the employee. If null, the
bid request associated with this bid group item was not received by the employee.
Type: DateTime
Optional
If defined for an Action, the BidReceived property cannot be null.
Sample values: "04/20/2004 11:48:56"
Introduced in v5.0
BidSubmissionStatus
Bid Submission Status
The bidding submission status value: Not Submitted, Submitted, or Declined To
Submit.
Type: String
Output only
The BidSubmissionStatus can only have values for Not Submitted, Submitted, or
Declined To Submit. The BidSubmissionStatus cannot be defined for AddOnly
Action.
Only Allowed Values: 1 - Not Submitted, 2 - Submitted, 3 - Declined To Submit
Default Value: Not Submitted
Introduced in v5.0; last changed in v5.0.a
LastSubmitted
Date Last Submitted
The date on which the bids associated with this bid group item were last
submitted. If null, the bid associated with this bid group item has not been
submitted.
Type: DateTime
Optional
If defined for an Action, the LastSubmitted property cannot be null.
Sample values: "04/20/2004 00:00:00"
Introduced in v5.0
PersonId
Person Id
The specific id value of person. The PersonId is the id of the person this bid group
item belongs to.
Type: Long
Required
If defined for an Action, the PersonId cannot be null. The PersonId cannot be less
than 1. The PersonId MUST be defined for AddOnly and
LoadByBidGroupAndPerson Actions.
Contributes to Uniqueness: Yes
Introduced in v5.0; last changed in v5.0.a
98 Kronos Incorporated
BidNote Tag
BidNote Tag
Bid Note
These are the bid notes associated with a specified bid.
The validate method validates the contents of the bean. When it returns normally,
the bean is believed to be valid for posting to the database.
Function Access Control Point: API.BidNote
Introduced in v5.0.a
Syntax
Properties→
<BidNote
Sequence = Integer
Text = String />
Property Descriptions
Sequence
Sequence Number
Sequence number for a bid note in the set of bid notes for a given bid.
Type: Integer
Required
If defined for a BidNote, the Sequence property cannot be null. The Sequence
property MUST be defined for a BidNote within BidNotes list when running the
Bid or VacationBid ApplyBidNotes Action. The Sequence value cannot be less
than 1.
Sample values: <BidNotes>
<BidNote Sequence="1" Text="This text is for vacation bid with Id=501"></
BidNote>
</BidNotes>
Introduced in v5.0; last changed in v5.0.a
Text
Bid Note Text
Text for the bid note.
Type: String
Required
If defined for a BidNote, the Text property cannot be null. The Text MUST be a
string value less than or equal to 255 characters. The Text property MUST be
defined for a BidNote.
Introduced in v5.0; last changed in v5.0.a
BidRequest Tag
Bid Request
The Bid Request tag can be used to submits a bidding request. Typically, the
manager will send out or submit a bidding request to his or her employees, so that
the employees may be able to submit bids for specific vacation time.
The validate method validates the contents of the bean.
Function Access Control Point: API.BidRequest
Introduced in v5.0.a
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"Load" |
"LoadByManager" |
"PostToSchedule" |
"SendToParticipants" |
"Update" |
"UpdateOnly"
Properties→
<BidRequest
BidRequestId = Long
[ Description = String ]
GroupScheduleProfileName = String
[ MaxBids = Integer ]
[ Name = String ]
[ NotificationDate = DateTime ]
[ PeriodEndDate = DateTime ]
[ PeriodStartDate = DateTime ]
SchedulePatternProfileName = String
ShfitCodeProfileName = String
( Status = String )
Type = String
VacationPayCodeName = String >
<Manager>
<PersonIdentity>
</Manager>
</BidRequest>
Action Descriptions
AddOnly
Adds a bid request.
For the AddOnly Action, the Manager Property, the PeriodStartDate Property, the
PeriodEndDate Property, the Name Property, and the Type Property, and the
specific pay code profile name based on the Type property MUST be specified.
Return Value Type: BidRequest tag
Required Properties: Manager, PeriodStartDate, PeriodEndDate, Name, Type,
Either VacationPayCodeName, ShiftCodeProfileName,
SchedulePatternProfileName, GroupScheduleProfileName
Optional Properties: Description, NotificationDate
Access Control Point Name: Edit
Introduced in v5.0.a
Delete
Deletes a bid request given the BidRequestId.
For the Delete Action, the BidRequestId property MUST be specified.
Return Value Type: None
Required Properties: BidRequestId
Access Control Point Name: Edit
Introduced in v5.0.a
Load
Retrieves a bid request given the BidRequestId. Properties other than the
BidRequestId property, if specified, are ignored.
For the Load Action, the BidRequestId property MUST be specified.
Update
Updates or inserts a bid request depending respectively on whether a bid request
having the specified BidRequestId, already exists or not. When the update implies
addition of a new bid request, the BidRequestId, if any is specified, is ignored.
For the Update Action, you must specify the following properties: Manager,
PeriodStartDate, PeriodEndDate, Name, MaxBids, Type, based on Type specify
either VacationPayCodeName, ShiftCodeProfileName,
SchedulePatternProfileName, GroupScheduleProfileName.
Return Value Type: None
Required Properties: BidRequestId, Manager, PeriodStartDate, PeriodEndDate,
Name, MaxBids, Type, Either VacationPayCodeName, ShiftCodeProfileName,
SchedulePatternProfileName, or GroupScheduleProfileName
Optional Properties: Description, NotificationDate
Access Control Point Name: Edit
Introduced in v5.0.a
UpdateOnly
Updates the bid request given the BidRequestId.
For the UpdateOnly Action, the BidRequestId property MUST be specified. If
you specify the Type property, based on Type specified you MUST specify either
VacationPayCodeName, ShiftCodeProfileName, SchedulePatternProfileName, or
GroupScheduleProfileName.
Return Value Type: None
Required Properties: BidRequestId
Optional Properties: Manager, PeriodStartDate, PeriodEndDate, Name,
Description, MaxBids, NotificationDate, Type and Either
VacationPayCodeName, ShiftCodeProfileName, SchedulePatternProfileName,
GroupScheduleProfileName
Access Control Point Name: Edit
Introduced in v5.0.a
Property Descriptions
BidRequestId
Bid Request Id
Identifies a unique bid request.
Type: Long
Required
If defined for an Action, the BidRequestId property cannot be null. The
BidRequestId property MUST be greater than or equal to 1. The BidRequestId
property MUST be specified for every BidRequest Action, except
LoadByManager & AddOnly Action.
Contributes to Uniqueness: Yes
Introduced in v5.0.a
Description
Bid Request Description
Description for bid request.
Type: String
Optional
If defined for an Action, the Description property cannot be null. The Description
property MUST be less than or equal to 255 characters in length.
Introduced in v5.0.a
GroupScheduleProfileName
Group Schedule Profile Name
Name of Access Profile that governs the set of Group Schedules from which
bidding participants can choose. Applies only to bidding type 'Shift By Group
Schedule'.
Type: String
Required
If defined for an Action, the GroupScheduleProfileName cannot be null. If the
Type property is set to the shift by group schedule bidding tye, then the
GroupScheduleProfileName MUST be defined, and the VacationPayCodeName
and other 2 Profile Names NOT.
Optional
If defined for an Action, the Name property cannot be null. The Name property
MUST be less than or equal to 30 characters. The Name property MUST be
specified for the AddOnly Action.
Introduced in v5.0.a
NotificationDate
Notification Date
Date on which notification about this bid request was last sent to bidding
participants.
Type: DateTime
Optional
If defined for an Action, the Notification cannot be null.
Sample values: "04/20/2004 11:48:56"
Introduced in v5.0.a
PeriodEndDate
Period End Date
Bid End Date for target bidding period.
Type: DateTime
Optional
If defined for an Action, the PeriodEndDate cannot be null. The PeriodEndDate
MUST be specified for the AddOnly Action.
Sample values: "04/20/2004 11:48:56"
Introduced in v5.0.a
PeriodStartDate
Bid Period Start Date
Start Date for the target bidding period.
Type: DateTime
Optional
BulkAccruals Tag
Set of Accruals for Employees
The BulkAccruals tag identifies a set of accruals for one or more employees
during a specified time period.
Function Access Control Point: API.BulkSummary
Introduced in v4; last changed in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "LoadAccruals"
Properties→
<BulkAccruals
AccrualCodeNames = String >
<Employees>
<PersonIdentity>
</Employees>
<Period>
<TimeFramePeriod>
</Period>
</BulkAccruals>
Action Descriptions
LoadAccruals
Returns detailed data about the specified set of accruals. This action uses the
EmployeeSummary tag, which in turn uses the AccrualBalanceSummary tag to
list details about the specified accruals.
Return Value Type: Zero or more EmployeeSummary tags
Required Properties: Employees, AccrualCodeNames, Period
Access Control Point Name: View
Introduced in v4
Property Descriptions
AccrualCodeNames
Accrual code names
A comma-separated list of accrual code names. The accrual codes are created in
Workforce Timekeeper and must be assigned to the employee before you can
import data against them.
Type: String
Required
Maximum length: Limited by your system environment settings
You can find values in the Workforce Timekeeper Setup Application.
Sample values: Vacation, Sick
Introduced in v4
Employees
Employees
One or more people, as specified in a PersonIdentity tag, for whom accruals are
requested.
Type: PersonIdentity tag
Required
Introduced in v4
Period
Time period
Two timeframes are supported:
• 1 or Current_Pay_Period
• 13 or Today
Type: TimeFramePeriod tag
Required
Only Allowed Values: 1, 13
BulkTotals Tag
Bulk Totals
The BulkTotals tag identifies a list of employees, a list of pay code names, and a
time period.
Function Access Control Point: API.BulkSummary
Introduced in v4; last changed in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "LoadPayCodeTotals"
Properties→
<BulkTotals
PayCodeNames = String >
<Employees>
<PersonIdentity>
</Employees>
<Period>
<TimeFramePeriod>
</Period>
</BulkTotals>
Action Descriptions
LoadPayCodeTotals
Returns totals for a given list of employees in their respective current pay periods.
Return Value Type: Zero or more EmployeeSummary tags
Required Properties: Employees, PayCodeNames, Period
Access Control Point Name: View
Introduced in v4
Property Descriptions
Employees
Employees
One or more people, as specified in a PersonIdentity tag, for whom totals are
requested.
Type: PersonIdentity tag
Required
Introduced in v4
PayCodeNames
Pay codes
A comma-separated list of pay code names
Type: String
Required
Introduced in v4
Period
Time period
Two timeframes are supported:
• 1 or Current_Pay_Period
• 13 or Today
Type: TimeFramePeriod tag
Required
Default Value: 1, 13
Introduced in v4; last changed in v5.0
CancelDeductions Tag
Cancel Deductions
The CancelDeductions tag denotes a request from Data Collection Manager
(DCM) to cancel all deductions for a specified date and time.
You can use the Update action to locate the nearest shift overlapping or prior to
the given date and time, as long as it is within a twenty-four-hour period. If found,
the shift will be flagged as if its auto-deductions are canceled.
This action is comparable to flagging a punch in the Timecard editor and
canceling all deductions.
Function Access Control Point: API.Timecard
Introduced in v4; last changed in v5.0.a
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Update"
Properties→
<CancelDeductions
Date = Date
[ ManagerName = String ]
Time = Time >
<Employee>
<CurrentUser> | <PersonIdentity>
</Employee>
</CancelDeductions>
Action Descriptions
Update
Flags the indicated shift so that automatic deductions are not applied to the totals
for that shift.
Return Value Type: None
Property Descriptions
Date
Date of cancelation
The date of the cancelation.
Type: Date
Required
Introduced in v4
Employee
Employee
One employee whose deductions are being canceled, as specified in a
PersonIdentity or CurrentUser tag.
Type: Either CurrentUser or PersonIdentity tag
Required
Must uniquely identify an existing and active employee
Introduced in v4
ManagerName
Manager name
The name used to replace the user name in audit.
Type: String
Optional
Maximum length: 70 characters
Introduced in v5.0.a
Time
Time of cancelation
The time of the cancelation. The Time and Date form a timestamp. If a shift
overlaps the 23:59 preceding this timestamp, auto-deductions will be canceled for
that shift. Otherwise, the cancelation has no effect.
Type: Time
Required
Introduced in v4
CertificationItem Tag
Certification Item
The CertificationItem tag defines an item in the certification.
Used by: PersonCertificationAssign
Function Access Control Point: API.Schedule
Introduced in v5.0
Syntax
Properties→
<CertificationItem
[ Abbreviation = String ]
[ IsActive = Boolean ]
Name = String />
Property Descriptions
Abbreviation
Abbreviation for the certification item
Abbreviation for the certification
Type: String
Optional
Maximum length: 5 characters
Introduced in v5.0
IsActive
Is the rule type active?
If True, the specified rule type is active.
Type: Boolean
Optional
Only Allowed Values: True, False
Introduced in v5.0
Name
Certification item name
The unique name of the certification item
Type: String
Required
Maximum length: 40 characters
Introduced in v5.0
CheckAdvice Tag
Earnings History
The CheckAdvice tag provides earnings history information for the specified
employee.
Function Access Control Point: API.PayrollAddOns
Introduced in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "AddOnly"
Properties→
<CheckAdvice
CheckDate = Date
CheckNumber = String
[ Deductions = String ]
EndDate = Date
[ GrossPay = String ]
NetPay = String
PaymentType = String
StartDate = Date
[ Taxes = String ]
[ TotalHours = String ] >
[ <DeductionsList>
<CheckAdviceDetailDeductions>∗
</DeductionsList> ]
[ <DirectDepositList>
<CheckAdviceDetailDirectDeposit>∗
</DirectDepositList> ]
<Employee>
<CurrentUser> | <PersonIdentity>
</Employee>
[ <GrossPayList>
<CheckAdviceDetailGrossPay>∗
</GrossPayList> ]
[ <TaxesList>
<CheckAdviceDetailTaxes>∗
</TaxesList> ]
</CheckAdvice>
Action Descriptions
AddOnly
Adds a pay stub to the database. If one already exists with the same key, it is
overwritten by the new one.
Dates must be valid dates
Return Value Type: None
Required Properties: Employee, CheckNumber, CheckDate, NetPay, StartDate,
EndDate, PaymentType
Access Control Point Name: Edit
Introduced in v5.0
Property Descriptions
CheckDate
Date of check
Payment date
Type: Date
Required
Introduced in v5.0
CheckNumber
Check number
The check number for this transaction
Type: String
Required
Maximum length: 50 characters
Contributes to Uniqueness: Yes
Introduced in v5.0
Deductions
Total of all deductions
The total amount of deductions that applied to the payment
Type: String
Optional
Maximum length: 50 characters
Introduced in v5.0
DeductionsList
List of deductions
One or more deductions that were applied to the payment.
Type: Zero or more CheckAdviceDetailDeductions tags
Optional
If there are any values in DeductionsList, then Deductions must be specified.
Introduced in v5.0
DirectDepositList
Direct deposit details
Details about the direct deposit of the check
Type: Zero or more CheckAdviceDetailDirectDeposit tags
Optional
Introduced in v5.0
Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag.
Type: Either CurrentUser or PersonIdentity tag
Required
Must uniquely identify an existing and active employee
Introduced in v5.0
EndDate
End date of pay period
The end date for the pay period for which the check is drawn
Type: Date
Required
Introduced in v5.0
GrossPay
Gross pay
The amount of the check before adjustments are made
Type: String
Optional
Maximum length: 50 characters
Introduced in v5.0
GrossPayList
List of gross pay details
Details about the gross payment for the check. May not be specified if GrossPay
property is not specified.
Type: Zero or more CheckAdviceDetailGrossPay tags
Optional
Introduced in v5.0
NetPay
Net pay
The gross pay with adjustments, such as deductions and taxes, applied
Type: String
Required
Maximum length: 50 characters
Introduced in v5.0
PaymentType
Method of payment
The method of payment
Type: String
Required
Maximum length: 50 characters
Sample values: Direct Deposit, Check
Introduced in v5.0
StartDate
Start date of pay period
The start of the pay period for which the check is drawn
Type: Date
Required
Introduced in v5.0
Taxes
Taxes
Total amount of taxes for items identified as detail taxes that is deducted from the
gross payment
Type: String
Optional
Maximum length: 50 characters
Introduced in v5.0
TaxesList
List of taxes
Details about the taxes applied to the check.
Dependency: May not be specified if the Taxes property is not specified.
Type: Zero or more CheckAdviceDetailTaxes tags
Optional
Introduced in v5.0
TotalHours
Total hours
The total number of hours for which the employee is being paid
Type: String
Optional
Maximum length: 50 characters
Introduced in v5.0
CheckAdviceDetailDeductions Tag
Earnings History - Deduction
The CheckAdviceDetailDeductions tag describes a deduction in the employee's
earnings history.
Used by: CheckAdvice
Function Access Control Point: API.PayrollAddOns
Introduced in v5.0
Syntax
Properties→
<CheckAdviceDetailDeductions
Amount = String
AmountYTD = String
Description = String
EmployeePaid = String
EmployeePaidYTD = String />
Property Descriptions
Amount
Amount of deduction
Amount of the specified deduction
Type: String
Required
Introduced in v5.0
AmountYTD
Year to date total
A cumulative year to date amount for this deduction
Type: String
Required
Introduced in v5.0
Description
Description
An explanation of the deduction
Type: String
Required
Introduced in v5.0
EmployeePaid
Portion paid by employee
The portion of the deduction that is paid by the employee
Type: String
Required
Introduced in v5.0
EmployeePaidYTD
Year to date total paid by employee
The year to date portion of the deduction that is paid by the employee
Type: String
Required
Introduced in v5.0
CheckAdviceDetailDirectDeposit Tag
Earnings History - Direct Deposit
The CheckAdviceDetailDirectDeposit tag describes details about a direct deposit.
Used by: CheckAdvice
Function Access Control Point: API.PayrollAddOns
Introduced in v5.0; last changed in v5.1
Syntax
Properties→
<CheckAdviceDetailDirectDeposit
AccountNumber = String
Amount = String
Description = String
RoutingNumber = String />
Property Descriptions
AccountNumber
Account number
The account number to which the direct deposit is posted.
Type: String
Required
Introduced in v5.0; last changed in v5.1
Amount
Amount of deposit
Amount of the direct deposit
Type: String
Required
Introduced in v5.0
Description
Description
An explanation of the item listed for the direct deposit
Type: String
Required
Introduced in v5.0
RoutingNumber
Routing number
The routing number of the bank to which the direct deposit is posted.
Type: String
Required
Introduced in v5.0; last changed in v5.1
CheckAdviceDetailGrossPay Tag
Earnings History - Gross Pay
The CheckAdviceDetailGrossPay tag identifies a gross pay detail.
Used by: CheckAdvice
Function Access Control Point: API.PayrollAddOns
Introduced in v5.0
Syntax
Properties→
<CheckAdviceDetailGrossPay
Amount = String
AmountYTD = String
Date = Date
Description = String
Hours = String
Rate = String />
Property Descriptions
Amount
Amount of gross pay
Gross pay amount
Type: String
Required
Introduced in v5.0
AmountYTD
Year to date total
Gross year to date pay amount
Type: String
Required
Introduced in v5.0
Date
Date of check
Date of the check
Type: Date
Required
Introduced in v5.0
Description
Description
The explanation that the specified amount is the gross pay
Type: String
Required
Introduced in v5.0
Hours
Hours paid
Number of hours for which payment is made
Type: String
Required
Must match an existing field definition name
Introduced in v5.0
Rate
Pay rate
Rate at which payment was made
Type: String
Required
Introduced in v5.0
CheckAdviceDetailTaxes Tag
Earnings History - Taxes
The CheckAdviceDetailTaxes tag describes details about a tax that is part of the
employee's earnings history.
Used by: CheckAdvice
Function Access Control Point: API.PayrollAddOns
Introduced in v5.0
Syntax
Properties→
<CheckAdviceDetailTaxes
Amount = String
Description = String
TaxableWages = String
TaxesYTD = String />
Property Descriptions
Amount
Amount of tax
Amount of the specified tax
Type: String
Required
Introduced in v5.0
Description
Description
An explanation of the specified tax
Type: String
Required
Introduced in v5.0
TaxableWages
Taxable wages
Wages for which taxes are paid
Type: String
Required
and/or a list of values
Introduced in v5.0
TaxesYTD
Year to date total for taxes
The cumulative year to date taxes for this taxable item reported with this check
Type: String
Required
Introduced in v5.0
Comment Tag
Comment
The Comment tag denotes additional text assigned to a punch, pay code edit, or
other timekeeping tags. The Comment and WSAComment tags refer to the same
database object.
Function Access Control Point: API.Audit
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<Comment
[ CommentCategory = String ]
( CommentText = String ) />
Action Descriptions
LoadActiveComments
Returns a list of active comments.
Return Value Type: Zero or more Comment tags
Access Control Point Name: View
Introduced in v4
LoadCommentCategories
Returns a list of comment beans with CommentCategory properties set to all
categories available in the system.
Return Value Type: Zero or more Comment tags
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
CommentCategory
Comment category
Specify the comment category name string. Only the comments for the given
category will be loaded. If unspecified, all active comments will be loaded. If the
name is invalid, an empty result will be return (no error).
Type: String
Optional
None
Default Value: null
Sample values: SHIFTS
Introduced in v5.0
CommentText
Comment text
A comment that can be attached to another record. Comments can be returned for
a specified category or for all categories.
Type: String
Output Only
Maximum length: 254 characters
Introduced in v4
ConnectToSchedule Tag
Schedule Import
The ConnectToSchedule tag imports an employee's scheduled shifts from another
application into the scheduler.
Function Access Control Point: API.Schedule
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Update"
Properties→
<ConnectToSchedule >
<ConnectToScheduleItems>
<ConnectToScheduleItem>∗
</ConnectToScheduleItems>
</ConnectToSchedule>
Action Descriptions
Update
Adds the specified items into schedule period
Return Value Type: None
Required Properties: ConnectToScheduleItems
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
ConnectToScheduleItems
Schedule items to import
One or more ConnectToScheduleItem tags. Taken together, these items define the
values that form a shift.
Type: One or more ConnectToScheduleItem tags
Required
Introduced in v5.1
ConnectToScheduleItem Tag
Schedule Import Items
The ConnectToScheduleItem tag contains schedule import elements that are used
by another application to import shifts into the Workforce scheduler.
Function Access Control Point: API.Schedule
Introduced in v5.1
Syntax
Properties→
<ConnectToScheduleItem
[ CommentText = String ]
[ Duration = TimeDuration ]
EmployeeId = String
[ LaborAccountName = String ]
[ OrgJobPath = String ]
RequestCode = Integer
[ StartDate = Date ]
[ StartTime = Time ]
[ WorkRuleName = String ] />
Property Descriptions
CommentText
Comment
A comment about the shift
Type: String
Optional
Maximum length: 255 characters
Introduced in v5.1
Duration
Time duration of shift
The duration of the shift
Type: TimeDuration
Optional
Introduced in v5.1
EmployeeId
Employee Id
The unique employee id
Type: String
Required
Must identify an existing and active employee
Contributes to Uniqueness: Yes
Introduced in v5.1
LaborAccountName
Labor account
The labor account for the schedule shift being imported
Type: String
Optional
LaborAccountName and OrgJobPath are mutually exclusive.
Introduced in v5.1
OrgJobPath
Location of job in the organization
The fully qualified path name for an organizational job
Type: String
Optional
OrgJobPath and LaborAccountName are mutually exclusive.
Introduced in v5.1
RequestCode
RequestCode
CoverShiftStatus Tag
Cover Shift Status
This tag represents result of daily status.
Function Access Control Point: API.Schedule
Introduced in v5.1
Syntax
Properties→
<CoverShiftStatus
( Date = Date )
( IsShiftCovered = Boolean )
( IsShiftExists = Boolean ) >
( <RequestToCoverItems>
<RequestToCoverItem>∗
</RequestToCoverItems> )
</CoverShiftStatus>
Property Descriptions
Date
Date
The date of the daily status.
Type: Date
Output only
Introduced in v5.1
IsShiftCovered
Is the shift covered?
This property holds the result of whether the shift has been covered.
Type: Boolean
Output only
Introduced in v5.1
IsShiftExists
Does the shift exist?
This property holds the result of whether is the shift existing.
Type: Boolean
Output only
Introduced in v5.1
RequestToCoverItems
Date and time span of the shift
This property contains a set of shift's date time span information.
Type: Zero or more RequestToCoverItem tags
Output only
Introduced in v5.1
CurrentUser Tag
Currently Logged On User
The CurrentUser tag identifies the currently logged on user.
This is a special instance of the PersonIdentity tag. It can be used wherever a
PersonIdentity is allowed and CurrentUser is appropriate. However, if you specify
CurrentUser, do not specify any property. When you specify the CurrentUser tag,
the properties are all provided by the system. CurrentUser always represents the
person making the request.
Function Access Control Point: API.Common
Introduced in v4; last changed in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "LoadIdentities"
Properties→
<CurrentUser
BadgeNumber = String
EmployeeKey = Long
PersonKey = Long
PersonNumber = String
UserKey = Long />
Action Descriptions
LoadIdentities
Returns current user information for the logged on user.
Return Value Type: CurrentUser tag
Required Properties: None
Access Control Point Name: View
Introduced in v4
Property Descriptions
BadgeNumber
Badge number
Contains an employee badge number that is assigned to the employee.
The system can be configured to allow multiple badges for employees. Specify
whether to allow multiple badge assignments in Workforce Timekeeper > System
Configuration > System Settings > Global Values >
global.BadgeAssignment.allowsOverlap = Yes.
If an employee is assigned multiple badge numbers, each badge number and
associated information is added in a separate request.
If you want to remove a badge number, remove all existing badge numbers. Then
reassign the valid number that you want to keep.
Type: String
See group( Identifier)
Maximum length: 25 characters
Must be unique for the specified date span. Validation is done after a person is
associated with a badge, using the PersonInformation tag.
Introduced in v4
EmployeeKey
Employee database key
The employee database key for the current user
Type: Long
See group( Identifier)
Maximum value = 2,147,488, 848
Must identify only one person
Introduced in v4; last changed in v5.0
PersonKey
Person database key
The person database key for the current user
Type: Long
See group( Identifier)
Maximum value = 2,147,488, 848
Must identify only one person
Introduced in v4; last changed in v5.0
PersonNumber
Person number
Person number of the specified person
Type: String
See group( Identifier)
Maximum length: 15 characters
Introduced in v4
UserKey
User database key
The database key for the current user
Type: Long
See group( Identifier)
Maximum value = 2,147,488, 848
Must identify only one person
Introduced in v4; last changed in v5.0
Group includes:
PersonNumber,BadgeNumber,PersonKey,EmployeeKey,UserKey
CustomData Tag
Custom Data
The CustomData tag lets you specify information for individuals, such as a social
security number or an alternate name. This function is the same as the Additional
Information workspace in the People Editor.
Function Access Control Point: API.Person
Introduced in v4; last changed in v5.1
Syntax
Properties→
<CustomData
CustomDataTypeName = String
Text = String />
Property Descriptions
CustomDataTypeName
Type of custom data
The customer-defined label for custom string types. You must define the custom
data type first using the Workforce Central Setup Application. Then you can use
this property to specify custom strings.
Type: String
Required
Maximum length: 30 characters
Values for CustomDataTypeName are added to the system through the Workforce
Central Setup Application.
A maximum of ten custom strings can be included for a person.
Sample values: seniority number, motherís maiden name, Social Security Number
Contributes to Uniqueness: Yes
Introduced in v4
Text
Text
The text of the custom string
Type: String
Required
Maximum length: 80 characters
Introduced in v4
CustomDate Tag
Custom Date
The CustomDate tag denotes Date type information for a site-specified Date
category that can be assigned to a person.
Used by: PersonInformation
Function Access Control Point: API.Person
Introduced in v4; last changed in v5.0
Syntax
Properties→
<CustomDate
CustomDateTypeName = String
Date = Date />
Property Descriptions
CustomDateTypeName
Date name
Contains the name of a person-specific date for an employee
Type: String
Required
Maximum length: 50 characters
You can find values in the Workforce Timekeeper user interface.
Sample values: 401K Enrollment Date
Contributes to Uniqueness: Yes
Introduced in v4
Date
Date
Specifies a custom date field to be used by the Person tag.
Type: Date
Required
Introduced in v4
DataSource Tag
Data Source
The DataSource tag identifies the location and meaning of a Timesheet item.
Function Access Control Point: API.Audit
Introduced in v4
Syntax
Properties→
<DataSource
( ClientName = String )
( FunctionalAreaCode = Integer )
( ServerName = String )
( UserName = String ) />
Property Descriptions
ClientName
Client name
Name that specifies the client's identity
Type: String
Output Only
Introduced in v4
FunctionalAreaCode
Code number of functional area
Code that specifies the function change being performed
Type: Integer
Output Only
Introduced in v4
ServerName
Server name
DateTotals Tag
Totals for a Date
The DateTotals tag returns a summary of totals for a particular date.
Used by: Timesheet
Function Access Control Point: API.Timecard
Introduced in v4
Syntax
Properties→
<DateTotals
( Date = Date ) >
( <Totals>
<TotalSummary>
</Totals> )
</DateTotals>
Property Descriptions
Date
Date to which the totals apply
The date on which totals apply
Type: Date
Output only
Introduced in v4
Totals
Set of Totals
A list of totals for this date, broken out by labor account and pay code
Type: TotalSummary tag
Output only
Introduced in v4
DeductRule Tag
Deduct Rule
The DeductRule tag provides information about deduct rules. The DeductRule
and WSABonusDeductRule tags refer to the same database object.
Function Access Control Point: API.Rules
Introduced in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "LoadAllDeductRules"
Properties→
<DeductRule
( DeductRuleName = String ) />
Action Descriptions
LoadAllDeductRules
Returns all deduct rules in the system.
Return Value Type: Zero or more DeductRule tags
Access Control Point Name: View
Introduced in v5.0
Property Descriptions
DeductRuleName
Deduct rule name
Name of the deduct rule
Type: String
Output only
Maximum length: 50 characters
Must be unique
Introduced in v5.0
DeviceGroup Tag
Device Group
The DeviceGroup tag represents all of the data collection devices that an
employee can access.
Function Access Control Point: API.Employee
Introduced in v4
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
Load
Returns information about the specified device group, based on
DeviceGroupName.
Return Value Type: DeviceGroup tag
Required Properties: DeviceGroupName
Access Control Point Name: View
Introduced in v4
LoadAllDeviceGroups
Returns all device groups in the system.
Return Value Type: Zero or more DeviceGroup tags
Property Descriptions
DeviceGroupId
Device group ID
A unique identifier for a device group
Type: Integer
Optional
Introduced in v4
DeviceGroupName
Group of devices that the employee can use
The name of the group of devices that the employee is authorized to use
Type: String
Optional
Maximum length: 50 characters
You can find values in the Workforce Timekeeper Setup Application.
Introduced in v4
Document Tag
Document
The Document tag is the document template root.
Function Access Control Point: API.WorkforceLeave.config
Introduced in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update" |
"UpdateOnly"
Parameters→
[ NewName = String ]
Properties→
<Document
[ Description = String ]
[ Domain = String ]
[ IsActive = Boolean ]
Name = String />
Action Descriptions
Add
Adds a new document or updates it if it already exists.
Introduced in v5.1
RetrieveAllNames
Returns the names of all of the documents.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the document with the specified name. Used by Setup Data Manager.
Return Value Type: Document tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the document if it already exists, or adds it if it does not.
Return Value Type: None
Required Properties: Name, Domain
Optional Properties: Description, IsActive
Access Control Point Name: Edit
Introduced in v5.1
Action Parameters
UpdateOnly
Updates an existing Document.
Return Value Type: None
Required Properties: Name, Domain
Optional Properties: Description, IsActive
Access Control Point Name: Edit
Introduced in v5.1
Action Parameters
Default Value:
Property Descriptions
Description
Description
DocumentDueDate Tag
Document Due Date
The DocumentDueDate tag is used by the LeaveTypeDocumentAssignment tag to
assign documents to a leave type (LeaveType tag). It has no actions of its own.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Properties→
<DocumentDueDate
AmountUnit = String
[ CustomDateType = String ]
DateOperator = String
DueDateAmt = Integer
[ DueDateType = String ] />
Property Descriptions
AmountUnit
Amount unit
The amount unit is the unit of the amount for the document due date used for
assignment to a Leave Type.
Type: String
Required
The valid values are "Day(s)", "Week(s)", and "Month(s)".
Sample values: Day(s)
Introduced in v5.1
CustomDateType
Custom date type
The custom date type is the name of a custom date type for the document due date
used for assignment to a Leave Type.
Type: String
Optional
Introduced in v5.1
DateOperator
Date operator
The date operator is the operator of the date for the document due date used for
assignment to a Leave Type.
Type: String
Required
The valid values are "Before" and "After".
Sample values: Before
Introduced in v5.1
DueDateAmt
Due date amount
The due date amount is the amount of units for the document due date used for
assignment to a Leave Type.
Type: Integer
Required
Sample values: 1
Introduced in v5.1
DueDateType
Due date type
The due date type is the type of the due date for the document due date used for
assignment to a Leave Type.
Type: String
Optional
The valid values are "Initial Leave Request Date", "Leave Start Date", and "Leave
End Date".
Sample values: Leave Start Date
Introduced in v5.1
DocumentReminder Tag
Document Reminder
The DocumentReminder tag is used by the LeaveDocumentReminder tag which
assigns a LeaveDocument to a Leave Document Reminder and has no actions of
its own.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Properties→
<DocumentReminder
AmountUnit = String
ReminderAmt = Integer
ReminderType = String />
Property Descriptions
AmountUnit
Amount unit
The amount unit is the amount of the unit for the document reminder used for
assignment to a Leave Type.
Type: String
Required
The valid values are "Day(s)", "Week(s)", and "Month(s)".
Sample values: Day(s)
Introduced in v5.1
ReminderAmt
Reminder amount
The reminder amount is the amount units for the document reminder used for
assignment to a Leave Type.
Type: Integer
Required
Sample values: 1
Introduced in v5.1
ReminderType
Reminder type
The reminder type is the type of the reminder used for assignment to a Leave
Type.
Type: String
Required
The valid values are "Before Due Date" and "After Due Date".
Sample values: Before Due Date
Introduced in v5.1
DocumentStatus Tag
Document Status
The Document Status tag stores status of the document.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update" |
"UpdateOnly"
Parameters→
[ NewName = String ]
Properties→
<DocumentStatus
[ Description = String ]
[ IsActive = Boolean ]
Name = String
OrderNumber = Integer
RemovePastDueSwitch = Boolean />
Action Descriptions
AddOnly
Adds the document status.
RetrieveForUpdate
Returns the document status with the specified name.
Return Value Type: DocumentStatus tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the document status if it exists, or adds it if it does not.
Return Value Type: None
Required Properties: Name
Optional Properties: Description, IsActive, RemovePastDueSwitch,
OrderNumber
Access Control Point Name: Edit
Introduced in v5.1
Action Parameters
Default Value:
UpdateOnly
Updates an existing document status.
Return Value Type: None
Required Properties: Name
Optional Properties: Description, IsActive, RemovePastDueSwitch,
OrderNumber
Access Control Point Name: Edit
Introduced in v5.1
Action Parameters
Default Value:
Property Descriptions
Description
Description
Description of the document status.
Type: String
Optional
Length must be between 0 and 250 characters.
Introduced in v5.1
IsActive
is active
Determines whether the document status is active. True means active, false means
inactive.
Type: Boolean
Optional
Default Value: true
Introduced in v5.1
Name
Name
Name of the document status.
Type: String
Required
Length must be between 1 and 50 characters.
EarnedAccrual Tag
Earned Accrual
This tag adds or subtracts an amount of time or money for a specified accrual code
and employee.
If you want to replace the current balance (rather than add or subtract a specific
amount), use the ResetAccrual tag.
All rules associated with adding earned accruals apply to the EarnedAccrual tag
and associated actions.
Function Access Control Point: API.Accruals
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Update"
Properties→
<EarnedAccrual
AccrualCodeName = String
AmountInCurrency = Currency
AmountInTime = TimeDuration
AmountInTimeOrCurrency = String
Date = Date >
<Employee>
<CurrentUser> | <PersonIdentity>
</Employee>
</EarnedAccrual>
Action Descriptions
Update
Updates an accrual amount for a specified employee. If the accrual code does not
exist for the employee, this action adds it.
The type of the accrual code determines the amount that can be specified: either a
time duration, or a currency.
The format of the accrual amount must match the type of the accrual code.
Return Value Type: None
Required Properties: AccrualCodeName, Date, Employee, One member of the
AccrualAmount group
Access Control Point Name: Edit
Introduced in v4; last changed in v5.0
Property Descriptions
AccrualCodeName
Accrual code name
The name of an accrual code that exists and is assigned to the specified employee
Type: String
Required
Maximum length: 50 characters
You can find values in the Workforce Timekeeper Setup Application.
Sample values: Vacation, Sick
Introduced in v4; last changed in v5.1
AmountInCurrency
Amount of accrual, in currency
TThe amount of money to be added to the current balance for the specified accrual
code and employee. Use a negative number to decrement the current balance.
Type: Currency
See group( AccrualAmount)
Maximum length: 30 characters
AmountInCurrency belongs to the AccrualAmount group. To specify a currency
value, use either the AmountInCurrency or the AmountInTimeOrCurrency
property.
EffectiveWorkload Tag
Workload Type
The EffectiveWorkload tag defines a workload type.
Used by: WorkloadPlan
Function Access Control Point: API.Schedule
Introduced in v5.0
Syntax
Properties→
<EffectiveWorkload
( AnchorDate = Date )
( EffectiveDate = Date )
( ExpirationDate = Date )
OrgJobPath = String
[ PatternDurationType = String ]
WorkloadPatternType = String
WorkloadPlanType = String
( WorkloadType = String ) >
<HeadcountPatterns>
<HeadcountPattern>∗
</HeadcountPatterns>
</EffectiveWorkload>
Property Descriptions
AnchorDate
Base start date of workload pattern
Specifies the date on which the workload pattern is scheduled to start
Type: Date
Output only
Introduced in v5.0
EffectiveDate
Effective start date in workload pattern
The effective start date within the workload pattern
Type: Date
Output only
Introduced in v5.0
ExpirationDate
End date for workload pattern
The end date for the workload pattern
Type: Date
Output only
Introduced in v5.0
HeadcountPatterns
Daily staffing patterns
One or more instances of staffing data patterns
Type: One or more HeadcountPattern tags
Required
Introduced in v5.0
OrgJobPath
Location of job in the organization
The fully qualified path name for an organizational job
Type: String
Required
Maximum length: 1000 characters
The LocationOrgNodePath in the WorkloadPlan tag, which represents the fully
qualified path name for the organization node on the organization tree, must be the
parent of the OrgJobPath.
Sample values: If the LocationOrgNodePath path is A/B/C, then the OrgJobPath
is A/B/C/D.
Introduced in v5.0
PatternDurationType
Pattern duration type (weekly, daily)
The workload duration
Dependency: PatternDurationType is required, and can be Weekly or Daily if the
value of WorkloadPlanType is Regular. You must specify Weekly to import the
normal Baseline and Adjusted patterns that appear in the Pattern Tab of the
Workload Planner user interface.
Dependency: PatternDurationType is optional if the WorkloadPlanType is
Holiday, but if specified, it must be specified as "Daily"
Type: String
Optional
Only Allowed Values: Weekly, Daily
Introduced in v5.0
WorkloadPatternType
Type of workload pattern
The type of workload pattern
Type: String
Required
Sample values: Baseline, Adjusted
Introduced in v5.0
WorkloadPlanType
Type of workload plan
The type of workload plan
Dependency: If WorkloadPlanType is specified as Holiday, then
PatternDurationType must be specified as Daily and DayOfWeek in the
Headcount tag must be specified as Anyday.
Dependency: If WorkloadPlanType is specified as Regular, PatternDurationType
must be specified as Weekly to import the normal Baseline and Adjusted patterns
that appear in the Pattern Tab of the Workload Planner user interface.
EligibilityAnswer Tag
Eligibility Answer
Eligibility Answer indentifies the answer for an eligibility question that is
associated with a leave case.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Properties→
<EligibilityAnswer
OkSw = Boolean
QuestionText = String />
Property Descriptions
OkSw
OK switch
The answer for a YES/NO question. True means YES.
Type: Boolean
Required
Sample values: true
Introduced in v5.1
QuestionText
Question text
This is the eligibility question associated with the answer.
Type: String
Required
The maximum length is 255 characters.
Sample values: Do more than 75 employees work at this location?
Introduced in v5.1
EligibilityEvaluation Tag
Eligibility Evaluation
This tag identifies the Eligibility Evaluations for a leave case.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Properties→
<EligibilityEvaluation
EligibilityRequirement = String
EligibilitySwitch = Boolean
[ EmployeeTenureSwitch = Boolean ]
EnableSwitch = Boolean
LeaveType = String >
[ <EligibilityAnswers>
<EligibilityAnswer>∗
</EligibilityAnswers> ]
</EligibilityEvaluation>
Property Descriptions
EligibilityAnswers
Eligibility answers
The answers for Eligibility Questions.
Type: Zero or more EligibilityAnswer tags
Optional
Introduced in v5.1
EligibilityRequirement
Eligibility requirement
The name of an eligibility requirement.
Type: String
Required
LeaveType
Leave type
The name of leave type which is being evaluated for eligibility.
Type: String
Required
This must be the name of an existing Leave Type. The maximum length is 50
characters.
Introduced in v5.1
EligibilityQuestion Tag
Eligibility Question
This tag describes the Eligibility Question.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Properties→
<EligibilityQuestion
QuestionText = String />
Property Descriptions
QuestionText
Question text
A Yes/No question.
Type: String
Required
The max string length is 255.
Sample values: Do you have a car?
Introduced in v5.1
EligibilityRequirement Tag
Eligibility Requirement
This tag describes the eligibility for a leave case.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update" |
"UpdateOnly"
Parameters→
Name = String
Properties→
<EligibilityRequirement
Category = String
[ Description = String ]
IsActive = Boolean
Name = String
Operator = String >
[ <ActiveEmployeeTenure>
<EmployeeTenure>
</ActiveEmployeeTenure> ]
[ <EmployeeTenure>
<EmployeeTenure>
</EmployeeTenure> ]
<HoursWorked>
<WorkHour>
</HoursWorked>
[ <Questions>
<EligibilityQuestion>∗
</Questions> ]
</EligibilityRequirement>
Action Descriptions
AddOnly
Creates an Eligibility Requirement with the given name.
The name must be unique.
Return Value Type: None
Required Properties: Name, Category, IsActive
Access Control Point Name: Edit
Introduced in v5.1
Delete
Deletes an Eligibility Requirement.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Action Parameters
Retrieve
Retrieves an Eligibility Requirement by name.
RetrieveAll
Finds all Eligibility Requirements.
Return Value Type: Zero or more EligibilityRequirement tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Retrieves names of all EligibilityRequirement objects.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Retrieves the given EligibilityRequirement by name. This method is used by
Setup Data Manager.
Return Value Type: EligibilityRequirement tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Tries to update an existing EligibilityRequirement; if the Eligibility Requirement
does not exist, then creates one.
Return Value Type: None
Required Properties: Name, Category, IsActive
Access Control Point Name: Edit
Introduced in v5.1; last changed in v5.0.a
Action Parameters
UpdateOnly
Updates an existing Eligibility Requirement only.
The named Eligibility must exist.
Return Value Type: None
Required Properties: Name, Category, IsActive
Access Control Point Name: Edit
Introduced in v5.1
Action Parameters
Property Descriptions
ActiveEmployeeTenure
Active employee tenure
The required tenure for the active employee.
Type: EmployeeTenure tag
Optional
Introduced in v5.1
Category
Leave category
The name leave category that an Eligibility Requirement belongs to.
Type: String
Required
This must be the name of an existing Leave Category. The maximum length is 50
characters.
Introduced in v5.1
Description
Description
The description of an Eligibility Requirement.
Type: String
Optional
The string length must be less then 250.
Sample values: A description of the requirement.
Introduced in v5.1
EmployeeTenure
Employee tenure
The requirement for the Employee Tenure.
Type: EmployeeTenure tag
Optional
Introduced in v5.1
HoursWorked
Hours worked
The Hours Worked requirement for the Eligibility.
Type: WorkHour tag
Required
Introduced in v5.1
IsActive
Active flag
The Active flag indicates whether the Eligibility Requirement is active.
Type: Boolean
Required
Default Value: true
Sample values: true
Introduced in v5.1
Name
Name
The name of the Eligibility Requirement. It must be less than 50 characters long.
Type: String
Required
Sample values: Elig
Introduced in v5.1
Operator
Operator
Must be "All questions must be answered Yes to be eligible for a leave type" or
"At least one question must be answered Yes to be eligible for a leave type".
Type: String
Required
Sample values: All questions must be answered Yes to be eligible for a leave type
Introduced in v5.1
Questions
Eligibility requirement questions
A list of Eligibility Question.
Type: Zero or more EligibilityQuestion tags
Optional
Introduced in v5.1
EligibleJobs Tag
EligibleJobs
This tag will get all open shifts for a specified date range.
Function Access Control Point: API.Schedule
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "LoadAll"
Properties→
<EligibleJobs
[ EndDate = Date ]
StartDate = Date >
<Employee>
<PersonIdentity>
</Employee>
</EligibleJobs>
Action Descriptions
LoadAll
The LoadAll action gets all open shifts in the employee's transfer set for the
specified date range.
The specified employee must be an active employee.
Return Value Type: Zero or more LocationItem tags
Required Properties: Employee, StartDate
Optional Properties: EndDate
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
Employee
Employee
This property represents the employee who requests the action.
Type: PersonIdentity tag
Required
It must be an active employee.
Contributes to Uniqueness: Yes
Introduced in v5.1
EndDate
End Date
EndDate is the ending date of query date span.
Instead of using KDateSpan, the start date & end date is more a convenience way
for process manager.
Type: Date
Optional
It must be a valid end date for property StartDate.
Introduced in v5.1
StartDate
Start Date
StartDate is the beginning date of query date span.
Instead of using KDateSpan, the start date & end date is more a convenience way
for process manager.
Type: Date
Required
It must be a valid date.
Introduced in v5.1
EmailAddress Tag
Email Address
The EmailAddress tag specifies an e-mail address of the given e-mail address
type.
Used by: PersonInformation
Function Access Control Point: API.Person
Introduced in v4; last changed in v5.0
Syntax
Properties→
<EmailAddress
Address = String
ContactTypeName = String />
Property Descriptions
Address
Email address for employee
The employee's electronic mail address
Type: String
Required
Maximum length: 50 characters
Introduced in v4
ContactTypeName
Type of contact
The name of the contact category
Type: String
Required
Maximum length: 30 characters
EmployeeGroupAssign Tag
Employee Group Assignments
The EmployeeGroupAssign tag is used to assign a list of employees to one or
more schedule groups.
Function Access Control Point: API.Schedule
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
Load
Load action loads employee's group assignment information. PeriodDateSpan is
an optional tag. If it hasn't been defined, load employee's group assignment
information; start from today to "forever".
Person Number shouldn't be null
Return Value Type: String
Required Properties: PersonNumber
Property Descriptions
EmployeeGroupItems
Employee group items
A list of EmployeeGroupItem tags.
Type: One or more EmployeeGroupItem tags
Required
Introduced in v5.1
Employees
Employees
A list of schedule employees
Type: Either CurrentUser or PersonIdentity tag
Required
Introduced in v5.1
PersonNumber
Person number
PersonNumber is a required property for load action only.
Type: Integer
Output only
Introduced in v5.1
EmployeeGroupItem Tag
Employee Group Item
The EmployeeGroupItem tag contains information about the the group
information to which the employee is being assigned.
Function Access Control Point: API.Schedule
Introduced in v5.1
Syntax
Properties→
<EmployeeGroupItem
EffectiveDate = Time
ExpirartionDate = Time
Name = String />
Property Descriptions
EffectiveDate
Effective date
The effective date on which an employee will be assigned to a schedule group.
Type: Time
Required
Introduced in v5.1
ExpirartionDate
Expiration date
The expiration date which employee will be disassociated from a schedule group.
Type: Time
Required
Introduced in v5.1
Name
Name of employee group item
EmployeeGroupProfile Tag
Group Profile for Employee Assignment
The employee group is a collection of labor level entries assigned to a manager
that defines the employee information to which the manager has access. A
manager who is assigning a new employee to an employee group can only grant
the new employee the labor level sets in his or her own employee group or a
subset of that group. The manager cannot assign groups that are outside of his or
her employee group.
Function Access Control Point: API.Employee
Introduced in v4
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<EmployeeGroupProfile
[ EmployeeGroupProfileId = Integer ]
[ EmployeeGroupProfileName = String ] />
Action Descriptions
Load
Returns the specified employee group profile, based on
EmployeeGroupProfileName.
Return Value Type: EmployeeGroupProfile tag
Required Properties: EmployeeGroupProfileName
Access Control Point Name: View
Introduced in v4
LoadAllEmployeeGroupProfiles
Returns all employee group profiles in the system.
Return Value Type: Zero or more EmployeeGroupProfile tags
Access Control Point Name: View
Introduced in v4
LoadById
Returns the specified employee group profile, based on EmployeeGroupProfileId.
Return Value Type: EmployeeGroupProfile tag
Required Properties: EmployeeGroupProfileId
Access Control Point Name: View
Introduced in v4
Property Descriptions
EmployeeGroupProfileId
Employee group profile ID
A unique identifier for the employee group profile
Type: Integer
Optional
Introduced in v4
EmployeeGroupProfileName
Employee group profile name
Name of the employee group profile
Type: String
Optional
Introduced in v4
EmployeeSummary Tag
Employee Summary
The EmployeeSummary tag contains either accruals or totals for an employee.
Used by: BulkAccruals, BulkTotals
Function Access Control Point: API.Accruals
Introduced in v4
Syntax
Properties→
<EmployeeSummary >
( <Accruals>
<AccrualBalanceSummary>∗
</Accruals> )
( <Employee>
<PersonIdentity>
</Employee> )
( <Totals>
<Total>∗
</Totals> )
</EmployeeSummary>
Property Descriptions
Accruals
Accruals
One or more accruals for the specified employee, as requested by the
BulkAccruals tag.
Type: Zero or more AccrualBalanceSummary tags
Output Only
Introduced in v4
Employee
Employee
EmployeeTenure Tag
Employee Tenure
This tag describes the employee tenure information.
Function Access Control Point: wfl.config.api
Introduced in v5.1
Syntax
Properties→
<EmployeeTenure
[ ActiveDays = Boolean ]
AmtOperator = String
[ CustomDateType = String ]
TenureAmount = Integer
TenureAmtUnit = String
TenureRefDateType = String />
Property Descriptions
ActiveDays
Active day switch
The Boolean flag that indicates whether or not this EmployeeTenure is an active
days condition.
Type: Boolean
Optional
Default Value: false
Introduced in v5.1
AmtOperator
Amount operator
The name of an operator
Type: String
Required
For english version the possible values are: Less than, Less than or equal to,Equal
to,More than or equal to,More than,Not equal to.
Sample values: Less than
Introduced in v5.1
CustomDateType
Custom date type
The custom date type
Type: String
Optional
Sample values: Union Hire Date
Introduced in v5.1
TenureAmount
Tenure amount
The required amount for the Employee Tenure.
Type: Integer
Required
Sample values: 365
Introduced in v5.1
TenureAmtUnit
Tenure amount unit
The unit of the tenure amount.
Type: String
Required
Calendar days, Scheduled days
Sample values: Calendar days
Introduced in v5.1
TenureRefDateType
Tenure reference date type
EmploymentStatus Tag
Employment Status
This tag sets the employment status of a person identified in the
PersonInformation tag for the specified time frame. The employment status can be
Active, Inactive, or Terminated. For more information, see the online help.
Used by: PersonInformation
Function Access Control Point: API.Person
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "LoadEmploymentStatuses"
Properties→
<EmploymentStatus
[ EffectiveDate = Date ]
EmploymentStatusName = String
[ ExpirationDate = Date ] >
[ <Identity>
<CurrentUser> | <PersonIdentity>
</Identity> ]
[ <Period>
<TimeFramePeriod>
</Period> ]
</EmploymentStatus>
Action Descriptions
LoadEmploymentStatuses
Returns information associated with the employment status for one person over
the specified period of time.
If the period of time is not specified, the current date through January 1, 3000 is
used.
The information returned for the Identity and Period properties is added to the first
tag in the resulting list.
If no data for the person is found, the value returned consists of just the Identity
and Period properties.
The person must exist and the user must have access to that person.
Return Value Type: Zero or more EmploymentStatus tags
Required Properties: Identity
Optional Properties: Period
Access Control Point Name: View
Introduced in v5.0
Property Descriptions
EffectiveDate
Effective date
The beginning date of the employment status that this tag sets.
Type: Date
Optional
Must occur before the expiration date
Default Value: The date of the import
Introduced in v4; last changed in v5.1
EmploymentStatusName
Employment status name
Indicates the current status of the employee.
Values can be:
• 0 for not applicable
• 1 for an active employee
• 2 for an inactive employee
• 3 for a terminated employee
Error Tag
Error
An Error tag represents a processing, validation, or persistence error that occurred
while processing the XML or executing an action
Function Access Control Point: API.Common
Introduced in v4; last changed in v5.0
Syntax
Properties→
<Error
[ ActionName = String ]
[ BeanName = String ]
ErrorCode = Integer
[ ErrorData = Collection ]
Message = String
[ ParameterName = String ]
[ ParameterType = String ]
[ ParameterValue = String ]
[ PropertyName = String ]
[ PropertyType = String ]
[ PropertyValue = String ] >
[ <DetailErrors>
<Error>∗
</DetailErrors> ]
</Error>
Property Descriptions
ActionName
Action being used when error occurred
Identifies the action in which the error occurred
Type: String
Optional
Introduced in v4
BeanName
Tag being used when error occurred
The external name of the tag in which the error occurred
Type: String
Optional
Introduced in v4
DetailErrors
Error Details
A list of other errors that may have caused the primary error
Type: Zero or more Error tags
Optional
Introduced in v4
ErrorCode
Error code
A unique code that identifies the error
Type: Integer
Required
Introduced in v4
ErrorData
Other data related to the error
Other data about the error. Each entry is of the form name=value.
Type: Collection
Optional
Introduced in v4
Message
Error message
An error message that describes the error
Type: String
Required
Introduced in v4
ParameterName
Parameter being used when error occurred
The name of the parameter in which the error occurred
Type: String
Optional
Introduced in v4
ParameterType
Data type of the parameter being used when the error occurred
The data type of the parameter in which the error occurred
Type: String
Optional
Introduced in v4
ParameterValue
Value of the parameter when the error occurred
The value of the parameter in which the error occurred
Type: String
Optional
Introduced in v4
PropertyName
Property being used when the error occurred
The name of the property in which the error occurred
Type: String
Optional
Introduced in v4
PropertyType
Data type of property being used when the error occurred
ExpectedHours Tag
Hours an Employee Is Expected to Work
The ExpectedHours tag contains the number of hours that the employee is
expected to work each day.
Used by: PersonInformation
Function Access Control Point: API.Person
Introduced in v4; last changed in v5.0
Syntax
Properties→
<ExpectedHours
Quantity = TimeDuration
TimePeriodTypeName = String />
Property Descriptions
Quantity
Number of hours
The number of hours the employee is expected to work for the time span
identified in TimePeriodTypeName.
Type: TimeDuration
Required
Maximum length: 6 characters
The value can be an integer or a decimal amount, such as 8, 8.0 or 8.5. Do not use
colons, for example, 8:00 to separate hours and minutes.
Introduced in v4; last changed in v5.0
TimePeriodTypeName
Time span associated with number of hours
The span of time associated with the number of hours reported in Quantity.
Type: String
Required
Maximum length: 10 characters
Only Allowed Values: Daily, Weekly, Monthly, Annually, Pay Period, Schedule
Period
Contributes to Uniqueness: Yes
Introduced in v4; last changed in v5.0
FailedXMLTransaction Tag
Failed XML Transaction
The FailedXMLTransaction tag provides information about an XML transaction
that has failed an attempt to process an XML request. It is used to retrieve or
modify failed XML transaction information.
Note: This tag provides information for the Transaction Assistant. It is primarily
used by Workforce Connect.
Function Access Control Point: API.FailedXMLTransaction
Introduced in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<FailedXMLTransaction
[ APIBeanName = String ]
[ BatchStatId = Long ]
[ ErrorCode = Integer ]
[ ErrorRecordNumber = Integer ]
[ ErrorText = String ]
[ PropertyName = String ]
[ PropertyValue = String ]
[ SourceDetails = String ]
[ SourceName = String ]
[ TransactionType = String ]
[ XMLRequestBeginDate = Date ]
[ XMLRequestBeginTime = Time ]
[ XMLRequestBodyText = String ]
[ XMLRequestEndDate = Date ]
[ XMLRequestEndTime = Time ]
[ XMLRequestHeaderText = String ] />
Action Descriptions
AddOnly
Adds a failed XML transaction error record to the database.
Does not replace an existing failed transaction
Return Value Type: None
Required Properties: SourceName, BatchStatId, XMLRequestEndDate,
XMLRequestEndTime, TransactionType, XMLRequestHeaderText,
XMLRequestBodyText
Access Control Point Name: Edit
Introduced in v5.0
Delete
Removes the failed transaction record with matching property values from the
database. SourceName or TransactionType must be specified.
Return Value Type: None
Required Properties: XMLRequestEndDate, XMLRequestEndTime
Access Control Point Name: Edit
Introduced in v5.0
Load
Returns all failed transactions for the specified SourceName and
TransactionType. You must specify at least one of these properties with the Load
action; if you do not, an error is returned.
Return Value Type: Zero or more FailedXMLTransaction tags
Optional Properties: SourceName, TransactionType
Access Control Point Name: Edit
Introduced in v5.0
Property Descriptions
APIBeanName
Name of failed XML tag
The API tag name for the failed XML transaction request
Type: String
Optional
Maximum length: 100 characters
Introduced in v5.0
BatchStatId
Batch status ID
The unique numeric value of an instance of a batch that contains a failed
transaction. The batch status Id is the value in the Import Batch Status tag that
was generated when the batch was created.
Type: Long
Optional
Maximum length: 10 characters
Contributes to Uniqueness: Yes
Introduced in v5.0
ErrorCode
Error code
A identification for the error that was returned
Type: Integer
Optional
Introduced in v5.0
ErrorRecordNumber
Record number for error
The unique number that is generated for the error
Type: Integer
Optional
Introduced in v5.0
ErrorText
Description of error
A description of the error that was returned
Type: String
Optional
Maximum length: 250 characters
Introduced in v5.0
PropertyName
Property that caused the error
The name of the property within the XMLRequestBody that caused the error
Type: String
Optional
Maximum length: 10 characters
Introduced in v5.0
PropertyValue
Value of property that caused the error
The value of the property in the XMLRequestBody that caused the error
Type: String
Optional
Maximum length: 2000 characters
Introduced in v5.0
SourceDetails
Details about the application
The source details including additional information about source
Type: String
Optional
Maximum length: 250 characters
Introduced in v5.0
SourceName
Name of application submitting the import
The name of the source system submitting an XML import
Type: String
Optional
Maximum length: 30 characters
Sample values: Connect, NameOfAThird PartyApplication, DCM
Introduced in v5.0
TransactionType
Transaction (import content) type
The XML Import transaction type for the failed transaction. If the type is "XML"
the XMLRequestBodyText is examined to determine the transaction type.
Type: String
Optional
Must be a valid import type
Sample values: Accrual Dates, Accruals, Activities, Activities People,
Availability Templates, Certifications, Customers, Labor Level Entries, Labor
Level Sets, Organizational Maps, Pay Code Edits, People, Punches, Results,
Schedule Assistant Criteria, Schedule Rules, Schedules, Skills, Staffing,
Workforce Activities, Workforce Scheduler
Introduced in v5.0
XMLRequestBeginDate
Start date of XML request
The date when the XML request was started
Type: Date
Optional
Introduced in v5.0
XMLRequestBeginTime
Start time of XML request
FunctionAccessProfile Tag
Function Access Profile
Returns a list of function access profiles.
A function access profile determines the components that users can access and the
functions that users can perform within the system. For example, the function
access profile for a manager can include permission to edit schedules and
timecards.
The FunctionAccessProfile and WSAFunctionAccessProfile tags refer to the
same database object.
Function Access Control Point: API.Employee
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
Load
Returns a function access profile, based on FunctionAccessProfileName.
Return Value Type: FunctionAccessProfile tag
Required Properties: FunctionAccessProfileName
Access Control Point Name: View
Introduced in v4
LoadAllFunctionAccessProfiles
Returns all function access profiles in the system.
Return Value Type: Zero or more FunctionAccessProfile tags
Access Control Point Name: View
Introduced in v4
LoadById
Returns a function access profile, based on FunctionAccessProfileId.
ID must be valid
Return Value Type: FunctionAccessProfile tag
Required Properties: FunctionAccessProfileId
Access Control Point Name: View
Introduced in v4
Property Descriptions
FunctionAccessProfileId
Function access profile ID
Uniquely identifies the function access profile in the database
Type: Integer
Optional
Introduced in v4
FunctionAccessProfileName
Function access profile name
The name of the person's function access profile. The function access profile
determines the Workforce Timekeeper components that users can access and the
types of functions that users can perform within Workforce Timekeeper, based on
their assigned roles.
For example, access profiles for Managers can include permission to edit
schedules and timecards. The same profile can be assigned to a group of similar
users, such as managers in the same department. The system administrator creates
GroupMembership Tag
Group Membership
The GroupMembership tag identifies employees who belong to a group during a
specified time period.
Used by: ScheduleGroup
Function Access Control Point: API.Schedule
Introduced in v4; last changed in v5.0
Syntax
Properties→
<GroupMembership
EffectiveDateSpan = DateSpan >
<Employee>
<CurrentUser> | <PersonIdentity>
</Employee>
</GroupMembership>
Property Descriptions
EffectiveDateSpan
Span of time when employee is member of group
The period of time when the specified employee belongs to the group
Type: DateSpan
Required
Introduced in v4
Employee
Employee
One employee who belongs to the group, as specified in a PersonIdentity or
CurrentUser tag.
Type: Either CurrentUser or PersonIdentity tag
Required
Headcount Tag
Daily Staffing Data
The Headcount tag defines the staffing data for a given day of the week in the date
range.
Used by: HeadcountPattern
Function Access Control Point: API.Schedule
Introduced in v5.0; last changed in v5.1
Syntax
Properties→
<Headcount
DayOfWeek = String
NumberOfStaffs = Integer />
Property Descriptions
DayOfWeek
Day of the week
Represents each day of the week
Dependency: Values that can be specified for this property depend on the value of
the PatternDurationType property in the EffectiveWorkload tag as follows:
If the value of PatternDurationType property is "Daily", the value of this property
must be "Anyday"
If the value of PatternDurationType property is "Weekly", seven Headcount tags
must be created. Each one must identify a different day of the week.
Type: String
Required
The value "Anyday" can only be used for holiday or daily workload patterns
You must use the English name for the day, even if your application server is
configured to use a different national language.
HeadcountPattern Tag
Daily Staffing Pattern
The HeadcountPattern tag defines the staffing data pattern for each day of the
week in the workload.
Used by: EffectiveWorkload
Function Access Control Point: API.Schedule
Introduced in v5.0
Syntax
Properties→
<HeadcountPattern
WorkloadSpanName = String >
<Headcounts>
<Headcount>∗
</Headcounts>
</HeadcountPattern>
Property Descriptions
Headcounts
Staffing data for pattern
Staffing data for specific days of the week
Dependency: The number of items in this list depends on the value of the
PatternDurationType property in the EffectiveWorkload tag.
• If the value of PatternDurationType is "Daily", then this list must contain one
item.
• If the value of PatternDurationType is "Weekly", then this list must contain
seven items.
Type: One or more Headcount tags
Required
Introduced in v5.0
WorkloadSpanName
Workload span
The workload span for the staffing data
Type: String
Required
Must match an existing shift name or zone name that is assigned to the location
Introduced in v5.0
HistoricalPayCodeEdit Tag
Historical Pay Code Edit
The HistoricalPayCodeEdit tag makes a pay code edit in a signed-off or locked
pay period. You can make historical edits only to pay code amounts.
Function Access Control Point: API.Timecard
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Parameters→
[ AccrualOverride = Boolean ]
[ allowAdHoc = Boolean ]
[ EchoData = Boolean ]
Properties→
<HistoricalPayCodeEdit
AmountInTimeOrCurrency = String
[ CommentText = String ]
Date = Date
( EnteredOnDate = Date )
( EnteredOnTime = Time )
HistoricalDate = Date
[ ImpactsAccrualsFlag = Boolean ]
[ LaborAccountName = String ]
[ PaidFlag = Boolean ]
PayCodeName = String
[ WorkRuleName = String ] >
( <Comments>
<Comment>∗
</Comments> )
<Employee>
<CurrentUser> | <PersonIdentity>
</Employee>
</HistoricalPayCodeEdit>
Action Descriptions
AddComment
Adds a comment to the set of comments associated with the existing historical pay
code edit.
Acceptable values can be found in the Setup Application.
Return Value Type: None
Required Properties: AmountInTimeOrCurrency, CommentText, Date,
HistoricalDate, Employee, PayCodeName
Access Control Point Name: Edit
Introduced in v4
AddOnly
Adds 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.
Return Value Type: HistoricalPayCodeEdit tag
Required Properties: AmountInTimeOrCurrency, Date, HistoricalDate,
Employee, PayCodeName
Access Control Point Name: Edit
Introduced in v4
Action Parameters
Delete
Marks for deletion all historical pay code edits for this employee, matching the
given date, time, and labor account.
At least one historical pay code edit must exist for the specified employee whose
required properties match the supplied properties.
Return Value Type: None
Required Properties: AmountInTimeOrCurrency, Date, HistoricalDate,
Employee, PayCodeName
Access Control Point Name: Edit
Introduced in v4
Property Descriptions
AmountInTimeOrCurrency
Amount of pay code, in time or currency
A value that can represent money or time, depending on the PayCodeName.
The value is a monetary amount if PayCodeName is a money type or time if
PayCodeName is a time type.
Type: String
Required,
Maximum of 30 characters.
Contributes to Uniqueness: Yes
Introduced in v4; last changed in v5.1
Comments
Comments
The set of comments currently associated with this timekeeping item
Type: Zero or more Comment tags
Output only
Introduced in v4
CommentText
Comment text
Text that is attached to the pay code amount or totaled amount.
Note: A comment entered as part of a historical amount is not used as part of the
criteria when an import delete is issued for the same historical amount.
Type: String
Optional
Maximum length: 254 characters
Must exactly match an applicable comment that already exists. The string
matching is case-sensitive.
You can find values in the Workforce Timekeeper Setup Application.
Introduced in v4
Date
Effective date of the edit
The date on which the pay code edit becomes effective
Type: Date
Required,
Contributes to Uniqueness: Yes
Introduced in v4
Employee
Employee
One employee for whom the edit applies, as specified in a PersonIdentity or
CurrentUser tag.
Type: Either CurrentUser or PersonIdentity tag
Required,
Must uniquely identify an existing and active employee
Contributes to Uniqueness: Yes
Introduced in v4
EnteredOnDate
Date on which the user performed the edit
The server date on which this edit was added to the database
Type: Date
Output only
Introduced in v4
EnteredOnTime
Time at which the user performed the edit
The server time at which this edit was added to the database
Type: Time
Output only
Introduced in v4
HistoricalDate
Date to which the edit applies
The date to which the historical edit is applied
Type: Date
Required,
The specified date must be within a locked pay period.
If any of the labor levels are the same as the employee's primary labor account,
you can enter @H for those labor levels instead of entering the labor entry names.
Type: String
Optional
Maximum length: 356 characters.
Default Value: Primary account for the employee
Introduced in v4; last changed in v5.0
PaidFlag
Included in employee's totals?
Determines whether the historical amount is tracked and included in the
employee's totals.
Value can be:
• False means that the amount supplied is tracked, but is not included in the
employee's totals for the current pay period.
• True means that the amount supplied is tracked and included in the
employee's totals for the current pay period.
Type: Boolean
Optional
Only Allowed Values: True, False
Default Value: False
Introduced in v4; last changed in v5.1
PayCodeName
Pay code
Identifies the name of the pay code that is being applied to an amount associated
with a historical amount.
A pay code represents an amount in time or ciurrency. It can represent one of the
following units:
• The hours accumulated during a pay period. A pay code that holds hours can
contain worked hours (such as regular, overtime, or second shift) or unworked
hours (such as vacation, sick, or personal).
• Money earned by employees during a pay period.
For example, if hours are allocated for J.D. Smith, who worked 8 regular and 4
overtime hours for a total of 12 hours, there will be two pay code edit entries:
• An entry with 8 regular hours
• An entry with 4 overtime hours
Type: String
Required,
Maximum length: 50 characters
Contributes to Uniqueness: Yes
Introduced in v4
WorkRuleName
Work rule
Name of the work rule. A work rule applies specific payrole rules to shifts that
determine how employee hours accrue.
Workforce provides the following predefined data values:
• &ALL_WORK_RULES
• &EMPTY
Type: String
Optional
Maximum length: 50 characters
You can find values in the Workforce Timekeeper Application Setup.
Introduced in v4
Deprecated in v5.0
HistoricalPayCodeMove Tag
Historical Pay Code Move
The HistoricalPayCodeMove tag moves historical amounts of time or money for
an individual employee or for a group of employees. When you move historical
amounts from one pay code to another, the historical date must be in a signed-off
or locked pay period.
Function Access Control Point: API.Timecard
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Parameters→
[ AccrualOverride = Boolean ]
[ allowAdHoc = Boolean ]
[ EchoData = Boolean ]
Properties→
<HistoricalPayCodeMove
AmountInTimeOrCurrency = String
[ CommentText = String ]
Date = Date
( EnteredOnDate = Date )
( EnteredOnTime = Time )
[ FromLaborAccountName = String ]
FromPayCodeName = String
HistoricalDate = Date
[ ImpactsAccrualsFlag = Boolean ]
[ LaborAccountName = String ]
PayCodeName = String
[ WorkRuleName = String ] >
( <Comments>
<Comment>∗
</Comments> )
<Employee>
<CurrentUser> | <PersonIdentity>
</Employee>
</HistoricalPayCodeMove>
Action Descriptions
AddComment
Adds a comment to the set of comments associated with this historical pay code
move.
Return Value Type: None
Required Properties: AmountInTimeOrCurrency, CommentText, Date,
FromLaborAccountName, FromPayCodeName, HistoricalDate, Employee,
PayCodeName
Access Control Point Name: Edit
Introduced in v4
AddOnly
Adds a new historical pay code edit with the specified properties for this
employee. There is no limit to the number of historical pay code edits that you can
add for an employee.
Return Value Type: HistoricalPayCodeMove tag
Required Properties: AmountInTimeOrCurrency, Date, FromLaborAccountName,
FromPayCodeName, HistoricalDate, Employee, PayCodeName
Access Control Point Name: Edit
Introduced in v4
Action Parameters
Delete
Marks all historical pay code edits for an employee that match a set of specified
requirements for deletion.
Return Value Type: None
Required Properties: AmountInTimeOrCurrency, Date, FromLaborAccountName,
FromPayCodeName, HistoricalDate, Employee, PayCodeName
Access Control Point Name: Edit
Introduced in v4
Property Descriptions
AmountInTimeOrCurrency
Amount of pay code, in time or currency
Amount of pay code, expressed as a time duration or a currency.
Type: String
Required,
Maximum length: 30 characters
Introduced in v4
Employee
Employee
The employee for whom the edit applies, as specified in a PersonIdentity or
CurrentUser tag.
Type: Either CurrentUser or PersonIdentity tag
Required,
Must uniquely identify an existing and active employee
Contributes to Uniqueness: Yes
Introduced in v4; last changed in v5.1
EnteredOnDate
Date on which the user performed the edit
The server date on which this edit was added to the database
Type: Date
Output Only
Introduced in v4
EnteredOnTime
Time at which the user performed the edit
The server time at which this edit was added to the database
Type: Time
Output Only
Introduced in v4
FromLaborAccountName
Labor account that the amount is moved from
If moving time from one labor account to another, the labor account from which
the amount is to be moved.
Type: String
Optional,
Holiday Tag
Holiday
The Holiday tag denotes a predefined holiday period. The Holiday and
WSAHoliday tags refer to the same database object.
Function Access Control Point: API.Schedule
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
Load
Returns the named holiday for the specified time span
Return Value Type: Holiday tag
Required Properties: Name, DateTimeSpan
Access Control Point Name: View
Introduced in v4; last changed in v5.1
LoadAllHolidaysInSpan
Returns all holidays that are effective within the specified date span
Return Value Type: Zero or more Holiday tags
Required Properties: DateTimeSpan
Property Descriptions
DateTimeSpan
Date and time span
Specifies the date and time span of the holiday
Type: DateTimeSpan
Required
Introduced in v4
Name
Holiday
The name of the holiday
Type: String
Optional
Introduced in v4; last changed in v5.0
HolidayEditHours Tag
Holiday Edit Hours
The HolidayEditHours tag is generated by the Callable Totalizer as a timesheet
item for a Holiday credit if the Holiday Credit Rule is identified as one of the three
credit types: fixed number of hours, hours from schedule, or average shift length.
Function Access Control Point: API.Timecard
Introduced in v4
Syntax
Properties→
<HolidayEditHours
( AmountInTimeOrCurrency = String )
( Date = Date )
( HolidayName = String )
( IsCurrencyFlag = Boolean )
( PayCodeName = String ) />
Property Descriptions
AmountInTimeOrCurrency
Amount of pay code, in time or currency
Amount of pay code amount, expressed as a time duration or a currency
Type: String
Output Only
Should always be TimeDuration for this tag
Introduced in v4
Date
Date to which the edit applies
The date on which the edit is credited
Type: Date
Output Only
HolidayEditWages Tag
Holiday Edit Wages
The HolidayEditWages tag is generated by the Callable Totalizer as a timesheet
item for a Holiday credit if the Holiday Credit Rule is identified as one of the three
credit types: fixed wages, percent of wages, or average wages.
Function Access Control Point: API.Timecard
Introduced in v4
Syntax
Properties→
<HolidayEditWages
( AmountInTimeOrCurrency = String )
( Date = Date )
( HolidayName = String )
( IsCurrencyFlag = Boolean )
( PayCodeName = String ) />
Property Descriptions
AmountInTimeOrCurrency
Amount of pay code, in time or currency
Amount of pay code, expressed as a time duration or a currency
Type: String
Output Only
Should always be Currency for this tag
Introduced in v4
Date
Date to which the edit applies
The date on which the edit is credited
Type: Date
Output Only
HomeAccount Tag
Home Account
The HomeAccount tag denotes the labor account assigned for the specified time
frame.
Used by: PersonInformation
Function Access Control Point: API.Person
Introduced in v4; last changed in v5.0
Deprecated in v5.0: Use the PrimaryLaborAccount tag instead.
Syntax
Properties→
<HomeAccount
EffectiveDate = Date
[ ExpirationDate = Date ]
LaborAccountName = String />
Property Descriptions
EffectiveDate
Effective date
The date when the home labor account status becomes effective
Type: Date
Required
Must occur before the expiration date
Introduced in v4; last changed in v5.0
Deprecated in v5.0: Use this property in the PrimaryLaborAccount tag instead.
ExpirationDate
Expiration date
The date when the home labor account expires
Type: Date
Optional
Must occur after the effective date
Default Value: January 1, 3000
Introduced in v4; last changed in v5.0
Deprecated in v5.0: Use this property in the PrimaryLaborAccount tag instead.
LaborAccountName
Primary labor account
This is the name of the primary labor account of the employee whose pay code
amount or totaled amount is being edited. LaborAccountName is optional when
adding a pay code edit, historical edit, or totaled amount. It is required when the
pay code edit, historical edit, or totaled amount being deleted or commented
contains an explicit value. This property need not be specified if the pay code
amount or totaled amount applies to the employeeís primary account.
Enter data for labor accounts in the same format as they appear in the Workforce
Timekeeper database. If you have a seven-level labor account, specify a value for
each labor level, using the following format: 101/202/303/404/504/603/702
Do not specify labor levels that are not changing.
If any of the labor levels are the same as the employeeís primary labor account,
you can enter @H for those labor levels instead of entering the labor entry names.
Type: String
Required
Maximum length: 356 characters
Contributes to Uniqueness: Yes
Introduced in v4; last changed in v5.0
Deprecated in v5.0: Use this property in the PrimaryLaborAccount tag instead.
HyperFindQuery Tag
Query
The HyperFindQuery tag specifies a HyperFind query that is used to return one or
more people as well as other data.
Used by: PersonIdentity
Function Access Control Point: API.Hyperfind
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
GetQueryCount
Returns the number of people that can be returned by the HyperFind query.
Return Value Type: SimpleValue tag
Required Properties: HyperFindQueryName, VisibilityCode, QueryDateSpan,
QueryPersonOrEmployee
Access Control Point Name: View
Introduced in v4
LoadAllQueries
Returns a list of all HyperFind queries.
Return Value Type: Zero or more HyperFindQuery tags
Required Properties: VisibilityCode
Access Control Point Name: View
Introduced in v4
RunQuery
Returns a list of people and associated information for the specified HyperFind
query.
Return Value Type: Zero or more HyperFindResult tags
Required Properties: HyperFindQueryName, VisibilityCode, QueryDateSpan,
QueryPersonOrEmployee
Access Control Point Name: View
Introduced in v4
Property Descriptions
Description
Description of query
Describes the HyperFind query
Type: String
Output Only
Introduced in v4; last changed in v5.0
HyperFindQueryName
HyperFind query name
Specifies the name of the HyperFind query. The query name and its visibility code
form a unique key to the HyperFind query.
Type: String
Optional
The names of HyperFind queries can be found in the Workforce Central user
interface.
Contributes to Uniqueness: Yes
Introduced in v4
QueryDateSpan
Span of dates for the query
The span of dates when the query is valid. Specifies the date span used to
determine access to and active status of the people returned in the result.
Type: DateSpan
Optional
Introduced in v4; last changed in v5.1
QueryIncludePersonFlag
Include person data?
Indicates whether to include information from the Person tag in the result
Type: Boolean
Optional
Only Allowed Values: True, False
Default Value: False
Introduced in v4; last changed in v5.0
QueryIncludeUserFlag
Include user account data?
Indicates whether to include information from the UserAccount tag in the result
Type: Boolean
Optional
Only Allowed Values: True, False
Default Value: False
Introduced in v4; last changed in v5.0
QueryIncludeWTKEmployeeFlag
Include employee data?
Indicates whether to include information from the WTKEmployee tag in the result
Type: Boolean
Optional
Only Allowed Values: True, False
Default Value: False
Introduced in v4; last changed in v5.0
QueryPersonOrEmployee
Category (person, employee, job assignment) for query
The type of person being requested in the query
Type: String
Optional
Only Allowed Values: Person, Employee, Job Assignment
Introduced in v4; last changed in v5.0
VisibilityCode
Visibility (public, private)
The visibility of the HyperFindQuery: public or private. Private queries are visible
only to the query owner; public queries are available to any user whose access
profile allows it. The query name and its visibility form a unique key to the
HyperFind query. Use Private when referring to a personal HyperFind query.
Type: String
Required
Note: For a Personal HyperFind, use the value Private.
Only Allowed Values: Public, Private
Contributes to Uniqueness: Yes
Introduced in v4; last changed in v5.1
HyperFindResult Tag
Result of Query
The HyperFindResult tag returns the result of running a HyperFind query.
Used by: HyperFindQuery
Function Access Control Point: API.Hyperfind
Introduced in v4; last changed in v5.1
Syntax
Properties→
<HyperFindResult
( FullName = String )
( PersonNumber = String ) >
( <PersonData>
<Person>
</PersonData> )
( <UserAccountData>
<UserAccount>
</UserAccountData> )
( <WTKEmployeeData>
<WTKEmployee>
</WTKEmployeeData> )
</HyperFindResult>
Property Descriptions
FullName
Full name
Name of the resulting person
Type: String
Output Only
Maximum length: 64 characters
Introduced in v4
PersonData
Person data
ImportBatchStatus Tag
Status of Import Batch
The Import Batch Status tag represents an import batch's details.
This tag is used to add, modify, or retrieve import batch name and batch statistics
information.
Function Access Control Point: API.ImportBatchStatus
Introduced in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
AddOnly
Adds a new batch status record, including the batch status identification.
If a record already exists in ImportBatch with the same name but of type Table,
the AddOnly action fails.
Property Descriptions
BatchDescription
Batch description
The BatchDescription contains the same value as BatchName.
Type: String
Output only
Maximum length: 30 characters
Introduced in v5.0
BatchName
Batch name
A user defined Import Batch name.
Type: String
Optional
Maximum length: 30 characters
Batch Name must uniquely identify an Import Batch. Existing batch names can be
found in the user interface.
Required: For an AddOnly action
Introduced in v5.0
BatchProcessStatus
Status of batch process
The status of the batch import process
Type: String
Optional
Maximum length: 30 characters
Must be one of the identified values
Only Allowed Values: IN PROCESS, COMPLETE, INTERRUPTED BY
USER, TERMINATED
Introduced in v5.0
BatchStatId
Batch status ID
The unique numeric value of an instance of a batch which has been run, or is in
the process of running.
Type: Long
Optional
You can find values in the Workforce Timekeeper user interface.
SuccessRecordCount
Number of records processed successfully
Indicates the total number of records that were successfully processed in the
batch. The user can provide the total record count at the beginning of the batch as
well as the success and failure counts, or the system can update for each record.
Type: Integer
Optional
Introduced in v5.0
TotalRecordCount
Total number of records in batch
The total number of records that were expected to be added in the batch. The user
can provide this information at the beginning of the batch and provide the success/
failure count at the conclusion or it can update for each record.
Type: Integer
Optional
Introduced in v5.0
TransactionType
Transaction type
The type of transaction
Type: String
Optional
If more than one transaction type is being imported in the batch, transaction type
is set to XML.
Sample values: Accrual Dates, Accruals, Activities, Activities People,
Availability Templates, Certifications, Customers, Labor Level Entries, Labor
Level Sets, Organizational Maps, Pay Code Edits, People, Punches, Result",
Schedule Assistant Criteria, Schedule Rules, Schedules, Skills, Staffing,
Workforce Activities, Workforce Scheduler, XML
Introduced in v5.0
JobAssignment Tag
Job Assignment
The JobAssignment tag specifies information about a person's job assignment. It
is used to import data.
Used by: Personality
Function Access Control Point: API.Person
Introduced in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Load"
Properties→
<JobAssignment
( HasPersonalOvertimeFlag = Boolean )
[ ScheduleGroupName = String ] >
[ <Identity>
<CurrentUser> | <PersonIdentity>
</Identity> ]
[ <JobAssignmentDetailsData>
<JobAssignmentDetails>
</JobAssignmentDetailsData> ]
[ <Period>
<TimeFramePeriod>
</Period> ]
[ <PersonalOvertimeAssignments>
<PersonalOvertimeAssignment>∗
</PersonalOvertimeAssignments> ]
[ <PrimaryLaborAccounts>
<PrimaryLaborAccount>∗
</PrimaryLaborAccounts> ]
</JobAssignment>
Action Descriptions
Load
Returns all information associated with the job and overtime assignments for the
specified person and period.
Return Value Type: JobAssignment tag
Required Properties: Identity
Optional Properties: Period
Access Control Point Name: View
Introduced in v5.0
Property Descriptions
HasPersonalOvertimeFlag
Is there personal overtime?
Indicates whether personal overtime assignments are associated with that person
Type: Boolean
Output only
Only Allowed Values: True, False
Introduced in v5.0
Identity
Identity
One employee, as specified in a PersonIdentity or CurrentUser tag.
Type: Either CurrentUser or PersonIdentity tag
Optional
Must uniquely identify a person.
Contributes to Uniqueness: Yes
Introduced in v5.0
JobAssignmentDetailsData
Job assignment details
General job, employee, and scheduling information that is associated with this job
assignment
Type: JobAssignmentDetails tag
Optional
Introduced in v5.0
Period
Time period
The specified time frame
Type: TimeFramePeriod tag
Optional
Must evaluate to a span of time. Identity is used when the time frame requires
association with a person.
Used for the Load action.
Default Value: From the current date until January 1, 3000
Introduced in v5.0
PersonalOvertimeAssignments
Personal overtime assignments
One or more rules that override the person's assigned overtime rule; that is,
specify one or more Overriding Personal Rules.
Type: Zero or more PersonalOvertimeAssignment tags
Optional
Each tag in the list must be a Personal Overtime Assignment tag
Introduced in v5.0
PrimaryLaborAccounts
Primary labor accounts
One or more Primary Labor Accounts
Type: Zero or more PrimaryLaborAccount tags
Optional
JobAssignmentDetails Tag
Job Assignment Details
The JobAssignmentDetails tag specifies certain job, employee, and schedule
information for a person.
Used by: JobAssignment
Function Access Control Point: API.Person
Introduced in v5.0; last changed in v5.1
Syntax
Properties→
<JobAssignmentDetails
[ BaseWageHourly = Currency ]
[ DeviceGroupName = String ]
[ PayRuleName = String ]
[ SeniorityRankDate = Date ]
[ SupervisorName = String ]
[ TimeZoneName = String ]
[ WageProfileName = String ]
[ WorkerTypeName = String ] />
Property Descriptions
BaseWageHourly
Base hourly wage
The base wage is the employeeís hourly wage without any premium values
(overtime, shift differential, and so on).
Type: Currency
Optional
Maximum length: 15 characters
If specified, this value must be greater than or equal to 0.0.
Default Value: 0.0
Introduced in v5.0; last changed in v5.1
DeviceGroupName
Device group
The Device Group represents all of the data collection devices that the employee
can access.
Type: String
Optional
Maximum length: 50 characters
You can find values in the Workforce Timekeeper Setup Application..
Introduced in v5.0; last changed in v5.1
PayRuleName
Pay rule
The name of the pay rule that is assigned to the employee. A pay rule contains
general payroll rules such as type of pay period (for example, weekly). A
complete pay rule controls such items as the pay period length, the day divide,
when punches link to schedules, when data collection devices accept and reject
punches, which holidays give holiday credits, and the order that hour types are
processed.
Type: String
Optional
Maximum length: 50 characters
Required: For a new Workforce Timekeeper Employee or Timekeeper Employee
that tracks their time in Workforce Central.
You can find values in the Workforce Timekeeper Setup Application.
Introduced in v5.0; last changed in v5.1
SeniorityRankDate
Seniority date
The date when the individual became qualified to work the job or was assigned to
the job.
Type: Date
Optional
Optional
Maximum length: 50 characters
Introduced in v5.0; last changed in v5.1
WorkerTypeName
Worker type
The worker type identifies the category of worker (for example, full-time, part-
time, or other types that your site might define).
Type: String
Optional
Maximum length: 50 characters
Introduced in v5.0; last changed in v5.1
Kronos_WFC Tag
Session Container
The Kronos_WFC tag is a container for all XML session information sent to and
from a client application. This tag is required to identify the context and version
for Workforce Central. It can contain any combination of XML API tags defined
in the Workforce Central XML API. All tags specified in the request
Kronos_WFC tags are echoed in the response.
The Kronos_WFC tag must appear prior to the first request in an XML session
with the version tag identifying the Kronos XML version. The response will also
contain this tag which shall include the version, WFCVersion, and TimeStamp
tags.
Function Access Control Point: API.XML
Introduced in v4; last changed in v5.0
Syntax
Properties→
<Kronos_WFC
[ TimeStamp = String ]
Version = String
( WFCVersion = String ) />
Contained API Tag+
</Kronos_WFC>
Property Descriptions
TimeStamp
Time stamp
The timestamp can refer to the request or the response. This value is ignored by
the API XML, but can be used for documenting request times. For a response, it is
set to the execution time.
Type: String
Optional
Introduced in v4
Version
Version of XML API
The XML API version
Type: String
Required
The value is validated against the versions supported by the XML server.
Introduced in v4
WFCVersion
Version of core timekeeping product
The WFC version on the server that the session was run on
Type: String
Output Only
Introduced in v4
KTimeZone Tag
Time Zone
The KTimeZone tag provides information about the Time Zones in the Workforce
Timekeeper system.
Function Access Control Point: API.Employee
Introduced in v4
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
Load
Returns time zone information, based on KTimeZoneName.
Name should be valid
Return Value Type: KTimeZone tag
Required Properties: KTimeZoneName
Access Control Point Name: View
Introduced in v4
LoadAllKTimeZones
Returns a list of all time zones in the system.
Return Value Type: Zero or more KTimeZone tags
Property Descriptions
KTimeZoneId
Time zone ID
Uniquely identifies the time zone in the database
Type: Integer
Optional
Sample values: 13011
Introduced in v4
KTimeZoneName
Time zone name
Identifies the time zone by name, for example, Eastern
Type: String
Optional
Sample values: (GMT -05:00) Eastern Time
Introduced in v4
LaborAccount Tag
Labor Account
The LaborAccount tag identifies the labor level entries in a labor level account.
Used by: PunchStatus
Function Access Control Point: API.LaborLevel
Introduced in v4; last changed in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<LaborAccount
( Description = String )
LaborAccountName = String >
( <LaborLevelEntries>
<LaborLevelEntry>∗
</LaborLevelEntries> )
</LaborAccount>
Action Descriptions
Load
Returns labor account information for the specified labor account
Return Value Type: LaborAccount tag
Optional Properties: LaborAccountName, LaborAccountId
Access Control Point Name: View
Introduced in v4
Update
Adds a new labor account or updates an existing one
Property Descriptions
Description
Description of labor account
Describes the labor account
Type: String
Output Only
Must contain only legal description characters
Introduced in v4
LaborAccountName
Labor account
The name of the labor account.
Enter data for labor accounts in the same format as they appear in the Workforce
Timekeeper database. If you have a seven-level labor account, specify a value for
each labor level, using the following format: 101/202/303/404/504/603/702
Do not specify labor levels that are not changing.
Type: String
Required
Maximum length: 356 characters
Each component in the name must correspond to the name and sort order position
of an existing labor level entry. The name must contain only legal naming
characters.
Contributes to Uniqueness: Yes
Introduced in v4
LaborLevelEntries
Set of labor level entries
One labor level entry is specified for each labor level in the specified labor
account.
Type: Zero or more LaborLevelEntry tags
Output Only
Introduced in v4
LaborAccountEntry Tag
Labor Account Entry
The LaborAccountEntry tag identifies one or more labor level entries that need to
be added, removed, or replaced in the labor account set.
The order of precedence is:
• Replace
• Add
• Remove
Used by: LaborAccountSet
Function Access Control Point: API.DataAccess
Introduced in v4; last changed in v5.0
Syntax
Properties→
<LaborAccountEntry
[ AddEntries = String ]
LaborLevelDefinitionName = String
[ RemoveEntries = String ]
[ ReplaceEntries = String ] />
Property Descriptions
AddEntries
Labor level entries added to the labor account set
A semicolon-delimited list of labor level entries that need to be added to the labor
account set for this labor level. Entries can contain wildcards.
Type: String
Optional
Maximum length: 146 characters
Each semicolon-delimited entry is validated against the labor level definitions
length requirements, and checked for invalid characters.
LaborAccountEntryData Tag
Entry Data for a Labor Account
The LaborAccountEntryData tag describes the labor account entry data in a labor
account set.
Function Access Control Point: API.DataAccess
Introduced in v5.0
Syntax
Properties→
<LaborAccountEntryData
( Adhoc = Boolean )
( Descriptions = String )
( Entries = String )
( LaborLevelDefinitionName = String ) />
Property Descriptions
Adhoc
Is ad hoc allowed?
True or False, based on whether ad hoc is allowed
Type: Boolean
Output only
Only Allowed Values: True, False
Introduced in v5.0
Descriptions
Description of labor account set
Describes the labor account set
Type: String
Output only
Introduced in v5.0
Entries
Labor level entries
The labor level entries
Type: String
Output only
Introduced in v5.0
LaborLevelDefinitionName
Labor level definition
The name of the labor level definition
Type: String
Output only
Introduced in v5.0
LaborAccountSet Tag
Labor Account Set
The LaborAccountSet tag describes the set of labor levels that comprise a labor
account.
This set is used by the access package to determine if a user can access a person or
the specified Labor Level.
Function Access Control Point: API.DataAccess
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"AddOnly" |
"Load" |
"LoadLaborAccountData" |
"LoadLaborAccountUpdateData" |
"Update" |
"UpdateOnly"
Properties→
<LaborAccountSet
[ Description = String ]
[ LaborAccountSetKey = String ]
LaborAccountSetName = String
[ LaborAccountSetTypeName = String ]
[ NewName = String ]
[ UpdatedDate = String ] >
[ <EntryList>
<LaborAccountEntry>∗
</EntryList> ]
</LaborAccountSet>
Action Descriptions
AddOnly
Adds a new labor account set
Return Value Type: None
Required Properties: LaborAccountSetName, LaborAccountSetTypeName
Access Control Point Name: Edit
Introduced in v4
Load
Returns information for the specified labor account set name
Return Value Type: LaborAccountSet tag
Required Properties: LaborAccountSetName
Access Control Point Name: View
Introduced in v4
LoadLaborAccountData
Returns all labor account set data for the specified labor account set key.
Return Value Type: Zero or more LaborAccountSet tags
Required Properties: LaborAccountSetKey
Access Control Point Name: View
Introduced in v5.0
LoadLaborAccountUpdateData
Returns a list of labor entries for the specified labor account set key that have been
updated or modified since the given reference date.
Return Value Type: LaborAccountSet tag
Required Properties: LaborAccountSetKey, UpdatedDate
Access Control Point Name: View
Introduced in v5.1
Update
Adds a new labor account set or updates an existing one
Return Value Type: None
Property Descriptions
Description
Summary of the labor level set
A brief summary of the labor level set
Type: String
Optional
Maximum length: 250 characters
Introduced in v4
EntryList
List of entries in the labor account set
Specifies the list of labor level account entries in the labor account set
Type: Zero or more LaborAccountEntry tags
Optional
Each labor level account entry in the list is validated individually.
Introduced in v4
LaborAccountSetKey
Key for the labor account set
Type: String
Optional
Maximum length: 1 character
Only Allowed Values: 1, 2, 3
Introduced in v4
NewName
New name of labor account set
The name to replace the existing name of a labor level set.
Type: String
Optional
Maximum length: 30 characters
Use the value @ to indicate that the existing name of the labor level set should be
retained.
Required: For an update of a labor level set.
Introduced in v4; last changed in v5.0
UpdatedDate
Updated Date
The date when the entries of thespecified labor accout set are updated
Type: String
Optional
Introduced in v5.1
LaborAccountSetProfile Tag
Set Profile for a Labor Account
The LaborAccountSetProfile tag provides information about valid labor account
set profiles. A labor account set profile specifies the labor level sets a manager or
employee can use when defining a labor account for transfer. To prevent access to
labor level transfer sets, select the empty profile.
Function Access Control Point: API.Employee
Introduced in v4
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<LaborAccountSetProfile
[ LaborAccountSetProfileId = Integer ]
[ LaborAccountSetProfileName = String ] />
Action Descriptions
Load
Returns a labor account set profile, based on LaborAccountSetProfileName.
Name should be valid
Return Value Type: LaborAccountSetProfile tag
Required Properties: LaborAccountSetProfileName
Access Control Point Name: View
Introduced in v4
LoadAllLaborAccountSetProfiles
Returns all labor account set profiles in the system.
Property Descriptions
LaborAccountSetProfileId
Id of set profile for labor account
Uniquely identifies the labor account set profile in the database
Type: Integer
Optional
Introduced in v4
LaborAccountSetProfileName
Set profile for labor account
The name for the common set of labor accounts that a group of users can access;
for example, F Snow Employees.
Type: String
Optional
Maximum length: 30 characters
Sample values: All Labor Account
Introduced in v4
LaborLevelDefinition Tag
Labor Level Definition
The LaborLevelDefinition tag describes the hierarchical labor levels that define a
job structure. The LaborLevelDefinition and WSALaborLevel tags refer to the
same database object.
Function Access Control Point: API.LaborLevel
Introduced in v4
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<LaborLevelDefinition
( AddAtTerminalFlag = Boolean )
( LaborLevelDefinitionName = String )
( MaxNameLength = Integer )
( MinNameLength = Integer )
( OverrideFlag = Boolean )
( ShortName = String )
( SortOrder = Integer ) />
Action Descriptions
GetNumberOfLaborLevels
Returns a count of labor level definitions
Return Value Type: SimpleValue tag
Access Control Point Name: View
Introduced in v4
LoadAllDefinitions
Returns all labor level definition names
Return Value Type: Zero or more LaborLevelDefinition tags
Access Control Point Name: View
Introduced in v4
Property Descriptions
AddAtTerminalFlag
Add labor level at a data collection device?
Specifies whether this labor level can be added at a Data Collection Manager
(DCM) device
Type: Boolean
Output Only
Only Allowed Values: True, False
Introduced in v4
LaborLevelDefinitionName
Labor level definition
The name of the labor level definition
Type: String
Output Only
You can find values in the Workforce Timekeeper Setup Application
Introduced in v4
MaxNameLength
Maximum length of name
Maximum length of a labor level entry name
Type: Integer
Output Only
Introduced in v4
MinNameLength
Minimum length of name
Minimum length of a labor level entry name
Type: Integer
Output Only
Introduced in v4
OverrideFlag
Override rules for name length?
Indicates whether the user is allowed to define a labor level entry name that does
not conform to the minimum or maximum length rules
Type: Boolean
Output Only
Only Allowed Values: True, False
Introduced in v4
ShortName
Short name for labor level definition
Short name of the labor level definition
Type: String
Output Only
Introduced in v4
SortOrder
Position of this labor level in labor account
A number representing the position of this definition in the labor account
Type: Integer
Output Only
Must be between 1 and the number of labor levels in the system
Introduced in v4
LaborLevelEntry Tag
Labor level entry
The LaborLevelEntry tag describes one labor level. Labor level entries usually
contain an entry name and description.
This tag is used by LaborAccount. The LaborLevelEntry and
WSALaborLevelEntry tags refer to the same database object.
The NewName property can only be specified to update an existing
LaborLevelEntry, using the Update or UpdateOnly action.
The LaborLevelEntryName can be the name or the description when locating an
existing labor level entry using the Load, Update, or UpdateOnly action.
Function Access Control Point: API.LaborLevel
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"GetCountByLaborLevelWithFilter" |
"GetCountsByLaborLevel" |
"Load" |
"LoadByWildcard" |
"Update" |
"UpdateOnly"
Parameters→
LaborLevelDefinitionName = String
Wildcard = String
Properties→
<LaborLevelEntry
[ Description = String ]
[ InactiveFlag = Boolean ]
[ LaborLevelDefinitionName = String ]
[ LaborLevelEntryName = String ]
[ NewName = String ] />
Action Descriptions
AddOnly
Adds a new labor level entry
Return Value Type: None
Required Properties: LaborLevelEntryName, LaborLevelDefinitionName
Access Control Point Name: Edit
Introduced in v4
GetCountByLaborLevelWithFilter
Returns the number of visible labor level entries for the specified level
Return Value Type: SimpleValue tag
Access Control Point Name: View
Introduced in v4
Action Parameters
GetCountsByLaborLevel
Returns the number of labor level entries for each labor level in the system
Return Value Type: Zero or more SimpleValue tags
Access Control Point Name: View
Introduced in v4
Load
Returns the specified labor level entry
Return Value Type: LaborLevelEntry tag
Required Properties: LaborLevelEntryName, LaborLevelDefinitionName
Access Control Point Name: View
Introduced in v4
LoadByWildcard
Returns the labor level entries that match the wildcard name or description pattern
for the specified labor level definition
Return Value Type: Zero or more LaborLevelEntry tags
Required Properties: None
Access Control Point Name: View
Introduced in v4
Action Parameters
Update
Adds a new labor level entry or updates an existing one
Return Value Type: None
Required Properties: LaborLevelEntryName, LaborLevelDefinitionName
Access Control Point Name: Edit
Introduced in v4
UpdateOnly
Updates an existing labor level entry
Property Descriptions
Description
Description
Contains text that describes the labor level entry specified in
LaborLevelEntryName. It is ignored when you inactivate or reactivate a labor
level entry.
Type: String
Optional
Maximum length: 250 characters
Introduced in v4
InactiveFlag
Is the labor level entry inactive?
Indicates whether the labor level entry is active. If True, the labor level entry is no
longer valid for this labor level.
Type: Boolean
Optional
Only Allowed Values: True, False
Introduced in v4
LaborLevelDefinitionName
Labor level definition
Identifies the labor level for which a labor level entry can be specified.
For example, if theLaborLevelDefinitionName is Job, a LaborLevelEntryName
might be 401 and have a corresponding Description value of Assembly.
Type: String
Optional
Maximum length: 50 characters
Contributes to Uniqueness: Yes
Introduced in v4; last changed in v5.0
LaborLevelEntryName
Labor level entry
The LaborLevelEntryName identifies the name of the labor level entry.
LaborLevelEntryName works in conjunction with LaborLevelDefinitionName,
which identifies the labor level that the labor level entry is a member of. The text
that describes the LaborLevelEntryName is entered in the Description column.
Although defined as a string, LaborLevelEntryName typically contains a number,
not text.
Example:
The Precision Auto factory uses the labor account format with the following labor
levels:
/Company/Division/Department/Job
The employees perform a variety of work, so the Job labor level has multiple
entries that represent the jobs that are performed. In this example, each job has a
different LaborLevelEntryName, as follows:
• LaborLevelEntryName 401 has a corresponding Description value of
Assembly
• LaborLevelEntryName 402 has a corresponding Description value of
Welding
• LaborLevelEntryName 403 has a corresponding Description value of
Painting
• LaborLevelEntryName 404 has a corresponding Description value of
Inspection
Type: String
Optional
Maximum length: 50 characters
LeaveCascader Tag
Leave Cascader
Allows the user to cascade or re-cascade a person's leave time.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Parameters→
BranchToCascade = String
EndDate = Date
Properties→
<LeaveCascader >
<Person>
<PersonIdentity>
</Person>
</LeaveCascader>
Action Descriptions
Cascade
Cascades an employee's leave time.
Return Value Type: None
Required Properties: Person
Access Control Point Name: View
Introduced in v5.1
Action Parameters
Recascade
Re-cascades an employee's leave time.
Return Value Type: None
Required Properties: Person
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
Person
Person
The person whose leave time is being cascaded.
Type: PersonIdentity tag
Required
Introduced in v5.1
LeaveCase Tag
Leave Case
Leave case tag identifies a leave case for a particular employee for a single reason.
The following properties are required for a Leave Case: ShortName, Category,
StartDate, EndDate, InitialLeaveRequestDate, CaseStatus,
CaseStatusAsOf,Frequency,FrequencyAsOf,EligibilityChecked, Person. The Start
Date must be on or before End Date. The FrequencyAsOf date must be between
StartDate and EndDate.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"CommitToBasicScheduler" |
"CommitToTimecard" |
"CommitToWorkforceScheduler" |
"CommitWithHistoricalTakingsToTimecard" |
"Delete" |
"DeleteAllLeaveTimes" |
"DeleteLeaveTimes" |
"Retrieve" |
"RetrieveAll" |
"RetrieveByCaseStatusAndPerson" |
"RetrieveByPerson" |
"RetrieveOpenCaseByPerson" |
"Uncommit" |
"Update" |
"UpdateOnly"
Parameters→
BranchToCommit = String
CaseStatus = String
CreateOpenShift = Boolean
DisplayTime = String
EffectiveDate = Date
EndDate = Date
ImpactsAccruals = Boolean
IncludeInTotals = Boolean
[ OrgJobNodePath = String ]
OverrideShift = String
ShortName = String
StartDate = Date
[ TransferName = String ]
[ UnavailableDuration = TimeDuration ]
[ UnavailableStartTime = Time ]
Properties→
<LeaveCase
ApprovalStatus = String
ApprovalStatusAsOf = DateTime
CaseStatus = String
CaseStatusAsOf = Date
Category = String
[ Detail = String ]
[ EligibilityCheckedDateTime = DateTime ]
EligibilityCheckType = String
EndDate = Date
Frequency = String
FrequencyAsOf = Date
InitialLeaveRequestDate = Date
[ PaidCommitDtm = DateTime ]
[ Reason = String ]
[ ReasonDetail = String ]
ShortName = String
StartDate = Date
[ UnpaidCommitDtm = DateTime ] >
[ <EligibilityEvaluations>
<EligibilityEvaluation>∗
</EligibilityEvaluations> ]
[ <LeaveCaseRuleAssignments>
<LeaveCaseRuleAssignment>∗
</LeaveCaseRuleAssignments> ]
[ <LeaveTimes>
<LeaveTime>∗
</LeaveTimes> ]
<Person>
<PersonIdentity>
</Person>
</LeaveCase>
Action Descriptions
AddOnly
Add a leave case.
The Start Date must be on or before End Date. The FrequencyAsOf date must be
between StartDate and EndDate.
Return Value Type: None
Required Properties: ShortName, Category, StartDate, EndDate,
InitialLeaveRequestDate, CaseStatus,
CaseStatusAsOf,Frequency,FrequencyAsOf,EligibilityCheckedType, Person.
Optional Properties: Detail, Reason,
ReasonDetail,EligibilityCheckedDateTime,LeaveTimes,LeaveCaseRuleAssignm
ents,EligibilityEvaluations
Access Control Point Name: Edit
Introduced in v5.1
CommitToBasicScheduler
Commits uncommitted LeaveTakings by a person ID and date range to the Basic
Schedule.
Return Value Type: None
Required Properties: StartDate, ShortName, Person
Access Control Point Name: Edit
Introduced in v5.1
Action Parameters
Default Value:
OverrideShift A flag to indicate None, partial or Introduced in v5.1
whole pay code override. Possible
values are: NO_PCE_OVERRIDE,
PARTIAL_PCE_OVERRIDE,
WHOLE_PCE_OVERRIDE,.
Default Value:
DisplayTime The time at which to start showing the Introduced in v5.1
leave time in the Scheduler.
CommitToTimecard
Commits uncommitted LeaveTakings selected by a person ID and date range to
the Timecard. The LeaveTakings are marked committed and the new
timesheetitem ID is added before the takings are updated.
Return Value Type: None
Required Properties: StartDate, ShortName, Person
Access Control Point Name: Edit
Introduced in v5.1
Action Parameters
CommitToWorkforceScheduler
Commits uncommitted LeaveTakings by a person ID and date range to the
Workforce Scheduler.
Return Value Type: None
Required Properties: StartDate, ShortName, Person
Access Control Point Name: Edit
Introduced in v5.1
Action Parameters
Default Value:
OverrideShift A flag to indicate None, partial or Introduced in v5.1
whole pay code override. Possible
values are: NO_PCE_OVERRIDE,
PARTIAL_PCE_OVERRIDE,
WHOLE_PCE_OVERRIDE.
CreateOpenShift This flag indicate whether to create a Introduced in v5.1
shift as an open shift.
Default Value:
DisplayTime The time at which to start showing the Introduced in v5.1
leave time in the scheduler.
Time format.
Default Value:
UnavailableStartTime The start time for the unavailable span Introduced in v5.1
Default Value: null
UnavailableDuration The duration of the unavailable span Introduced in v5.1
Default Value: null
CommitWithHistoricalTakingsToTimecard
Commits uncommitted LeaveTakings and Historical Leave Takings selected by
person ID and date range to the Timecard. The LeaveTakings are marked
committed and the new timesheetitem ID is added before the takings are updated.
Default Value:
IncludeInTotals Determines if the taking is historical Introduced in v5.1
and need to be applied against the
paid amount in the PCE to be created.
Default Value:
Delete
Delete will try to delete a leave case that matches the given StartDate, ShortName,
Person.
If there is more than one leave case that matches those parameters, Delete will
throw an exception. The import cannot uniquely identify the leave case. The edits
can be made using the user interface.
Return Value Type: None
Required Properties: Person
DeleteAllLeaveTimes
Deletes all the leave times (for this leave case) and their associated takings.
Return Value Type: None
Required Properties: StartDate, ShortName, Person
Access Control Point Name: Edit
Introduced in v5.1
DeleteLeaveTimes
Deletes all the leave times (specified by the LeaveTimes properties) and their
associated takings. LeaveTimes must be owned by this LeaveCase.
Return Value Type: None
Required Properties: StartDate, ShortName, Person
Optional Properties: LeaveTimes
Access Control Point Name: Edit
Introduced in v5.1
Retrieve
Retrieve will try to retrieve a LeaveCase that matches the given StartDate,
ShortName and Person.
If there is more than one LeaveCase that matches those parameters, Retrieve will
throw an exception because it could not uniquely identify the leave case. The user
can use the UI to make the shortName unique to solve this problem.
Return Value Type: LeaveCase tag
Required Properties: Person
Access Control Point Name: View
Introduced in v5.1
Action Parameters
RetrieveAll
Retrieves all leave cases.
Return Value Type: Zero or more LeaveCase tags
Access Control Point Name: View
Introduced in v5.1
RetrieveByCaseStatusAndPerson
Retrieves leave cases by CaseStatus and Person.
Return Value Type: Zero or more LeaveCase tags
Required Properties: Person
Access Control Point Name: View
Introduced in v5.1
Action Parameters
Default Value:
RetrieveByPerson
Retrieves leave cases by Person.
Return Value Type: Zero or more LeaveCase tags
Required Properties: Person
Access Control Point Name: View
Introduced in v5.1
RetrieveOpenCaseByPerson
This action retrieves a list of APILeaveCase for the person with the "open" status.
Return Value Type: Zero or more LeaveCase tags
Required Properties: Person
Access Control Point Name: View
Introduced in v5.1
Uncommit
Uncommits all the committed LeaveTakings for this LeaveCase.
Return Value Type: None
Required Properties: StartDate, ShortName, Person
Access Control Point Name: Edit
Introduced in v5.1
Action Parameters
Update
If the leave case is found, it will be updated; otherwise a leave case will be
created.
Return Value Type: None
Required Properties: ShortName, Category, StartDate, EndDate,
InitialLeaveRequestDate, CaseStatus,
CaseStatusAsOf,Frequency,FrequencyAsOf,EligibilityCheckType, Person.
Optional Properties: Detail, Reason,
ReasonDetail,EligibilityCheckedDateTime,LeaveTimes,LeaveCaseRuleAssignm
ents,EligibilityEvaluations
Access Control Point Name: Edit
Introduced in v5.1
Action Parameters
UpdateOnly
UpdateOnly will try to delete a leave case that matches the given StartDate,
ShortName and Person.
If there is more than one leave case that matches those parameters, UpdateOnly
will throw an exception because it could not uniquely identify the leave case. The
edits can be made using the user interface.
Default Value:
StartDate The start date of a leave case. Introduced in v5.1
Property Descriptions
ApprovalStatus
Approval status
The approval status of the leave case.
Type: String
Required
Sample values: ApprovalStatus = "Approved"
Introduced in v5.1
ApprovalStatusAsOf
Approval status as of date time
Defines the leave case approval status as of date and time.
Type: DateTime
Required
Date time format.
Introduced in v5.1
CaseStatus
Case status
The status of the leave case.
Type: String
Required
The value must be valid. It can be either Open or Closed.
Sample values: Open, Closed
Introduced in v5.1
CaseStatusAsOf
Case status as of date
The leave case status as of date.
Type: Date
Required
The date format must be valid.
Introduced in v5.1
Category
Leave category
Each leave case must belong to a leave category.
Type: String
Required
The Leave Category with the specified name must be preconfigured.
Sample values: Medical
Introduced in v5.1
Detail
Detail
Introduced in v5.1
EndDate
End date
The end date of the leave case.
Type: Date
Required
The date format must be correct.
Default Value: 1/1/3000
Introduced in v5.1
Frequency
Leave frequency
The frequency of a leave case.
Type: String
Required
Valid values are Continuous or Intermittent.
Only Allowed Values: Continuous, Intermittent
Sample values: Continuous
Introduced in v5.1
FrequencyAsOf
Leave frequency as of date
The leave frequency as of date.
Type: Date
Required
The date format must be correct.
Introduced in v5.1
InitialLeaveRequestDate
Initial leave request date
The date of the initial leave request.
Type: Date
Required
The date format must be correct.
Introduced in v5.1
LeaveCaseRuleAssignments
Leave case rule assignments
Specifies the effective-dated leave rules that are associated with the leave case.
Type: Zero or more LeaveCaseRuleAssignment tags
Optional
Sample values: <LeaveCaseRuleAssignments>
<LeaveCaseRuleAssignment Rule="TEST" EffectiveDate="10/2/2004" />
</LeaveCaseRuleAssignments>
Introduced in v5.1
LeaveTimes
Leave times
The leave times that are associated with the leave case.
Type: Zero or more LeaveTime tags
Optional
Introduced in v5.1
PaidCommitDtm
Paid commit date time
Defines date and time of the leave case paid commit.
Type: DateTime
Optional
date time format.
Introduced in v5.1
Person
Person
Type: String
Required
Sample values: case1
Introduced in v5.1
StartDate
Start date
The start date of leave case.
Type: Date
Required
The date format must be correct.
Introduced in v5.1
UnpaidCommitDtm
Unpaid commit date time
Defines the date and time of the leave case unpaid commit.
Type: DateTime
Optional
Date Time format
Introduced in v5.1
LeaveCaseRuleAssignment Tag
Leave Case Rule Assignment
This tag identifies the effectively dated rules assigned to a leave case.
Function Access Control Point: wfl.manager.api
Introduced in v5.1
Syntax
Properties→
<LeaveCaseRuleAssignment
EffectiveDate = Date
[ ExpirationDate = Date ]
Rule = String />
Property Descriptions
EffectiveDate
Effective date
The effective date of the leave rule assignment.
Type: Date
Required
The date format must be correct.
Introduced in v5.1
ExpirationDate
Expiration date
The expiration date for the leave case rule assignment.
Type: Date
Optional
Introduced in v5.1
Rule
Leave rule
LeaveCategory Tag
Leave Category
A category of leave, such as "Medical" or "Education". This is a named entity.
The type of leave.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update" |
"UpdateOnly"
Parameters→
[ NewName = String ]
Properties→
<LeaveCategory
[ DefaultSwitch = Boolean ]
[ Description = String ]
[ IsActive = Boolean ]
Name = String
[ OrderNumber = Integer ]
ShortName = String />
Action Descriptions
AddOnly
Adds a leave category
Return Value Type: None
Required Properties: Name, IsActive, OrderNumber, DefaultSwitch
Optional Properties: Description
Access Control Point Name: Edit
Introduced in v5.1
Delete
Deletes a leave category
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Retrieve
Retrieves a leave category by its name.
Return Value Type: LeaveCategory tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
RetrieveAll
Retrieves all leave categories.
Return Value Type: Zero or more LeaveCategory tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Retrieves the names of all leave categories.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Retrieves the leave category with the specified name. Used by Setup Data
Manager.
Return Value Type: LeaveCategory tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates a leave category if it exists, or adds it if it does not.
Return Value Type: None
Required Properties: Name, IsActive, OrderNumber, DefaultSwitch
Optional Properties: Description
Access Control Point Name: Edit
Introduced in v5.1
Action Parameters
Default Value:
UpdateOnly
Updates a leave category.
Return Value Type: None
Required Properties: Name, IsActive, OrderNumber, DefaultSwitch
Optional Properties: Description
Access Control Point Name: Edit
Introduced in v5.1
Action Parameters
Default Value:
Property Descriptions
DefaultSwitch
Default switch
This is true if this leave category is the default leave category.
Type: Boolean
Optional
Default Value: false
Introduced in v5.1
Description
Description
Description of the leave category. The description can be from 0 to 250
characters long.
Type: String
Optional
Introduced in v5.1
IsActive
Active flag
If the active flag is set to true, the leave category is active.
Type: Boolean
Optional
Default Value: true
Introduced in v5.1
Name
Name
Name of the category. The name can be from 1 to 50 characters.
Type: String
Required
Sample values: Medical
Contributes to Uniqueness: Yes
Introduced in v5.1
OrderNumber
Order number
The display order of the leave categories
Type: Integer
Optional
Introduced in v5.1
ShortName
Short name
Short name of the category. The name can be from 1 to 6 characters long.
Type: String
Required
Introduced in v5.1
LeaveDecisionNode Tag
Leave Decision Node (unsupported)
THIS TAG IS NOT SUPPORTED FOR THIRD-PARTY USE INCLUDING
WORKFORCE CONNECT. A LeaveDecisionNode is a decision test that
evaluates to either a Yes or a No value. These two possible out comes are
represented by two (and only two) PassThroughNode children.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Properties→
<LeaveDecisionNode
DisplayName = String >
[ <AccrualBalanceLimits>
<AccrualBalanceLimit>∗
</AccrualBalanceLimits> ]
[ <Children>
<LeaveDecisionNode>∗
<LeavePassThroughNode>∗
<LeaveRuleNode>∗
<LeaveTakingNode>∗
</Children> ]
<NoNode>
<LeavePassThroughNode>
</NoNode>
[ <WaitingCondition>
<WaitingPeriod>
</WaitingCondition> ]
<YesNode>
<LeavePassThroughNode>
</YesNode>
</LeaveDecisionNode>
Property Descriptions
AccrualBalanceLimits
Accrual balance limits
LeaveDocument Tag
Leave Document
A Leave Document generated for a particular leave case.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Properties→
<LeaveDocument
( Document = String )
( DocumentStatus = String )
( DocumentStatusAsOf = Date )
( DueDate = Date )
( GeneratedBy = String )
( GenerationDateTime = DateTime ) />
Property Descriptions
Document
Document
Name of the document.
Type: String
Output only
Introduced in v5.1
DocumentStatus
Document status
Name of the document status for this document.
Type: String
Output only
Introduced in v5.1
DocumentStatusAsOf
Document status as of date
Date when the document status changed to its current status.
Type: Date
Output only
Introduced in v5.1
DueDate
Due date
Date when the document is due.
Type: Date
Output only
Introduced in v5.1
GeneratedBy
Generated by
Name of the employee who generated the leave document.
Type: String
Output only
Introduced in v5.1
GenerationDateTime
Generation date time
Date and time that the leave document was generated.
Type: DateTime
Output only
Introduced in v5.1
LeaveDocumentReminder Tag
Leave Document Reminder
The LeaveDocumentReminder tag is used by the
LeaveTypeDocumentAssignment tag to assign documents to a leave type
(LeaveType tag). Ithas no actions of its own, but has a DocumentReminder
reminder associated with it
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Properties→
<LeaveDocumentReminder >
[ <DocumentReminder>
<DocumentReminder>
</DocumentReminder> ]
</LeaveDocumentReminder>
Property Descriptions
DocumentReminder
Document reminder
The LeaveDocumentReminder has an associated DocumentReminder
Type: DocumentReminder tag
Optional
Introduced in v5.1
LeaveDocumentTemplate Tag
Leave Document Template
A localized leave document template.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update" |
"UpdateOnly"
Parameters→
[ NewName = String ]
Properties→
<LeaveDocumentTemplate
[ Description = String ]
[ DocumentRoot = String ]
[ IsActive = Boolean ]
[ Language = String ]
Name = String />
Action Descriptions
Add
Adds a new leave document template, or updates it if it already exists.
Return Value Type: None
Required Properties: Name
Optional Properties: Description, IsActive, Language, DocumentRoot
Access Control Point Name: Edit
Introduced in v5.1
AddOnly
Adds a new leave document template.
Return Value Type: None
Required Properties: Name
Optional Properties: Description, IsActive, Language, DocumentRoot
Access Control Point Name: Edit
Introduced in v5.1
Delete
Deletes the leave document template with the given name.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Retrieve
Returns the leave document templates with the given name.
Return Value Type: LeaveDocumentTemplate tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
RetrieveAll
Returns all leave document templates (active and inactive).
Action Parameters
UpdateOnly
Updates the leave document template with the given name.
Return Value Type: None
Required Properties: Name
Optional Properties: Description, IsActive, Language, DocumentRoot
Access Control Point Name: Edit
Introduced in v5.1
Action Parameters
Property Descriptions
Description
Description
Description of the leave document template. The length must be between 0 and
250 characters.
Type: String
Optional
Introduced in v5.1
DocumentRoot
Document Root
The name of the root Document for this template.
Type: String
Optional
Introduced in v5.1
IsActive
Active flag
True means the document template is active. False means it is not active.
Type: Boolean
Optional
Default Value: true
Introduced in v5.1
Language
Language
The name of the language for this document.
Type: String
Optional
Introduced in v5.1
Name
Name
The name of the leave document template. The name can be from 1 to 50
characters long.
Type: String
Required
Contributes to Uniqueness: Yes
Introduced in v5.1
LeavePassThroughNode Tag
Leave Pass-Through Node (unsupported)
THIS TAG IS NOT SUPPORTED FOR THIRD-PARTY USE INCLUDING
WORKFORCE CONNECT. This node is a named junction to which other nodes
are attached.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Properties→
<LeavePassThroughNode
DisplayName = String >
[ <Children>
<LeaveDecisionNode>∗
<LeavePassThroughNode>∗
<LeaveRuleNode>∗
<LeaveTakingNode>∗
</Children> ]
</LeavePassThroughNode>
Property Descriptions
Children
Children
A list of nodes that are children of this node.
Type: Any combination of LeaveDecisionNode or LeavePassThroughNode or
LeaveRuleNode or LeaveTakingNode tags
Optional
Introduced in v5.1
DisplayName
Display name
The name of the node that is displayed in the user interface.
Type: String
Required
The maximum length is 50 characters.
Introduced in v5.1
LeaveProfile Tag
Leave Profile
A container for LeaveCategories assignments
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update" |
"UpdateOnly"
Parameters→
[ NewName = String ]
Properties→
<LeaveProfile
[ Description = String ]
[ IsActive = Boolean ]
Name = String >
[ <ProfileCategoryAssignments>
<LeaveProfileCategory>∗
</ProfileCategoryAssignments> ]
</LeaveProfile>
Action Descriptions
AddOnly
Adds a new leave profile
Return Value Type: None
Required Properties: Name, IsActive
Optional Properties: Description, ProfileCategoryAssignments
Access Control Point Name: View
Introduced in v5.1
Delete
Deletes a leave profile
Return Value Type: None
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Retrieve
Retrieves a leave profile
Return Value Type: LeaveProfile tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
RetrieveAll
Retrieves all leave profiles
Return Value Type: Zero or more LeaveProfile tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Retrieves the list names of all leave profiles (active and inactive).
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Retrieves a leave profile for updating
Return Value Type: LeaveProfile tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates a leave profile or adds it if it does not exist
Return Value Type: None
Required Properties: Name, IsActive
Optional Properties: Description, ProfileCategoryAssignments
Access Control Point Name: View
Introduced in v5.1
Action Parameters
UpdateOnly
Updates an existing leave profile.
Return Value Type: None
Required Properties: Name, IsActive
Optional Properties: Description, ProfileCategoryAssignments
Access Control Point Name: View
Introduced in v5.1
Action Parameters
Property Descriptions
Description
Description
The description of this leave profile.
Type: String
Optional
The maximum length is 250 characters.
Introduced in v5.1
IsActive
Active flag
The state that indicates whether this leave profile is enabled for use (true = active).
Type: Boolean
Optional
Introduced in v5.1
Name
Name
The name of this leave profile.
Type: String
Required
The maximum length is 50 characters.
Introduced in v5.1
ProfileCategoryAssignments
Profile category assignments
A list of APILeaveProfileCategory objects.
Type: Zero or more LeaveProfileCategory tags
Optional
Introduced in v5.1
LeaveProfileCategory Tag
Leave Profile Category
Represents the assignment of a category to a profile.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Properties→
<LeaveProfileCategory
Category = String >
[ <ProfileCategoryRuleAssignments>
<LeaveProfileCategoryRule>∗
</ProfileCategoryRuleAssignments> ]
[ <ProfileCategoryTypeAssignments>
<LeaveProfileCategoryType>∗
</ProfileCategoryTypeAssignments> ]
</LeaveProfileCategory>
Property Descriptions
Category
Category
The leave category name for this leave category profile
Type: String
Required
This must be the name of an existing leave category. The maximum length is 50
characters.
Introduced in v5.1
ProfileCategoryRuleAssignments
Profile category rule assignments
A list of APIProfileCategoryRule objects associated with this
LeaveProfileCategory
Type: Zero or more LeaveProfileCategoryRule tags
Optional
Introduced in v5.1
ProfileCategoryTypeAssignments
Profile category type assignments
A list of APIProfileCategoryRule objects associated with this
LeaveProfileCategory
Type: Zero or more LeaveProfileCategoryType tags
Optional
Introduced in v5.1
LeaveProfileCategoryRule Tag
Leave Profile Category Rule
Associates a LeaveRule to a LeaveProfile and a LeaveCategory pair.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Properties→
<LeaveProfileCategoryRule
LeaveRule = String />
Property Descriptions
LeaveRule
Leave Rule
The name of the leave rule associated with a leave profile category.
Type: String
Required
This must be the name of an existing Leave Rule. The maximum length is 50
characters.
Introduced in v5.1
LeaveProfileCategoryType Tag
Leave Profile Category Type
Represents the assignment of a LeaveType to a LeaveProfileCategory
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Properties→
<LeaveProfileCategoryType
[ EligibilityRequirement = String ]
LeaveType = String />
Property Descriptions
EligibilityRequirement
Eligibility
The name of the leave eligibility associated with this leave profile category type.
Type: String
Optional
This must be the name of an existing leave eligibility.
Introduced in v5.1
LeaveType
Leave type
The name of the leave type associated with the Leave profile category. This must
be the name of an existing Leave type. The maximum length is 50 characters.
Type: String
Required
Introduced in v5.1
LeaveReason Tag
Leave Reason
Reason for taking leave. Reasons are dependent on LeaveCategory.
Function Access Control Point: WorkforceLeave
Introduced in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames" |
"RetrieveByCategory" |
"RetrieveForUpdate" |
"Update" |
"UpdateOnly"
Parameters→
[ NewName = String ]
Properties→
<LeaveReason
Category = String
[ Description = String ]
[ IsActive = Boolean ]
Name = String
ShortName = String >
[ <LeaveTypeReasons>
<LeaveTypeReason>∗
</LeaveTypeReasons> ]
</LeaveReason>
Action Descriptions
AddOnly
Adds a leave reason.
Name must be unique. Category must be valid.
Return Value Type: None
Required Properties: Name, Category
Optional Properties: Description, ShortName, IsActive, LeaveTypeReasons
Access Control Point Name: Edit
Introduced in v5.1
Delete
Deletes the specified leave reason.
Name must be a valid LeaveReason
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Retrieve
Retrieves a leave reason by name.
Name must be a valid LeaveReason.
Return Value Type: LeaveReason tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
RetrieveAll
Retrieve all leave reasons.
Return Value Type: Zero or more LeaveReason tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Retrieves the names of all the leave reasons
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveByCategory
Retrieves a list of leave reasons by category name.
Return Value Type: Zero or more LeaveReason tags
Required Properties: Category
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Retrieves the named leave reason. Used by Setup Data Manager.
Return Value Type: LeaveReason tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified leave reason if it exists; otherwise the leave reason is added.
Name must be a valid LeaveReason.
Return Value Type: None
Required Properties: Name
Optional Properties: Description, ShortName, IsActive, Category,
LeaveTypeReasons
Access Control Point Name: Edit
Introduced in v5.1
Action Parameters
Default Value:
UpdateOnly
Updates a leave reason only if it exists.
Name must be a valid LeaveReason
Return Value Type: None
Required Properties: Name
Optional Properties: Description, ShortName, IsActive, Category,
LeaveTypeReasons
Access Control Point Name: Edit
Introduced in v5.1
Action Parameters
Default Value:
Property Descriptions
Category
Category
Name of an existing leave category associated with the leave reason.
Type: String
Required
Introduced in v5.1
Description
Description
Description of the leave reason. Length must be between 0 and 250 characters.
Type: String
Optional
Introduced in v5.1
IsActive
Active flag
Indicates if the leave reason is active.
Type: Boolean
Optional
Default Value: true
Introduced in v5.1
LeaveTypeReasons
Leave type reasons
List of leave type reasons.
Type: Zero or more LeaveTypeReason tags
Optional
Introduced in v5.1
Name
Name
Name of the leave reason. Length must be between 1 and 50 characters.
Type: String
Required
Contributes to Uniqueness: Yes
Introduced in v5.1
ShortName
Short name
LeaveRequest Tag
Leave Request
Request for time off on an existing Leave Case.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "AddOnly"
Properties→
<LeaveRequest
EndDate = Date
LeaveCaseShortName = String
LeaveCaseStartDate = Date
PerDayAmount = TimeDuration
RequestDTM = DateTime
StartDate = Date >
<Person>
<PersonIdentity>
</Person>
</LeaveRequest>
Action Descriptions
AddOnly
Creates a new leave request.
Return Value Type: None
Required Properties: EndDate, PerDayAmount, Person, RequestDTM, StartDate,
LeaveCaseShortName, LeaveCaseStartDate, Person
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
EndDate
End date
End date for the leave request.
Type: Date
Required
Introduced in v5.1
LeaveCaseShortName
Leave case short name
The short name of the leave case for which the employee is requesting leave.
Type: String
Required
Introduced in v5.1
LeaveCaseStartDate
Leave case start date
Start date for the leave case for which the employee is requesting leave.
Type: Date
Required
Introduced in v5.1
PerDayAmount
Per day amount
Amount of leave requested per day.
Type: TimeDuration
Required
Introduced in v5.1
Person
Person
Person requesting leave.
LeaveRule Tag
Leave Rule (unsupported)
THIS TAG IS NOT SUPPORTED FOR THIRD-PARTY USE INCLUDING
WORKFORCE CONNECT. The Leave Rule tag is a rule used by the
LeaveCascader to calculate leave takings.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update" |
"UpdateOnly"
Parameters→
[ NewName = String ]
Properties→
<LeaveRule
Category = String
[ Description = String ]
[ IsActive = Boolean ]
Name = String
[ UserOverride = Boolean ] >
[ <RootNode>
<LeaveRuleNode>
</RootNode> ]
</LeaveRule>
Action Descriptions
AddOnly
Adds a leave rule
Return Value Type: None
Required Properties: Name, IsActive, Category, RootNode
Optional Properties: Description, DisregardAccrualRules, UserOverride
Access Control Point Name: View
Introduced in v5.1
Delete
Deletes a leave rule
Return Value Type: None
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Retrieve
Retrieves a leave rule
Return Value Type: LeaveRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
RetrieveAll
Retrieves all leave rules
Return Value Type: Zero or more LeaveRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Retrieves the list names of all leave rules (active and inactive).
Return Value Type: Zero or more NameList tags
UpdateOnly
Updates a leave rule only if it already exists
Return Value Type: None
Required Properties: Name, IsActive, Category, RootNode
Optional Properties: Description, DisregardAccrualRules, UserOverride
Access Control Point Name: View
Introduced in v5.1
Action Parameters
Property Descriptions
Category
Category
The name of the Leave Category for which this Leave Rule is valid.
Type: String
Required
This must be the name of an existing Leave Category. The maximum length is 50
characters.
Introduced in v5.1
Description
Description
The description of this LeaveRule
Type: String
Optional
The maximum length is 250 characters.
Introduced in v5.1
IsActive
Is active
The state that indicates whether this LeaveRule is enabled for use (true = active)
Type: Boolean
Optional
Default Value: true
Introduced in v5.1
Name
Name
The name of this LeaveRule.
Type: String
Required
The maximum length is 50 characters.
Sample values: Maternity rule.
Introduced in v5.1
RootNode
Root node
The root node of the rule tree that eventually gets associated with a rule.
Type: LeaveRuleNode tag
Optional
Introduced in v5.1
UserOverride
User override
Sets whether or not this is a user custom rule (true=custom).
Type: Boolean
Optional
Default Value: false
Introduced in v5.1
LeaveRuleNode Tag
Leave Rule Node (unsupported)
THIS TAG IS NOT SUPPORTED FOR THIRD-PARTY USE INCLUDING
WORKFORCE CONNECT. LeaveRuleNode is the root node of the leave rule
tree.
It must have 2 children, both LeavePassThroughNodes. The nodes must be mark
Paid and Unpaid.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Properties→
<LeaveRuleNode
DisplayName = String >
[ <Children>
<LeaveDecisionNode>∗
<LeavePassThroughNode>∗
<LeaveRuleNode>∗
<LeaveTakingNode>∗
</Children> ]
<PaidNode>
<LeavePassThroughNode>
</PaidNode>
<UnpaidNode>
<LeavePassThroughNode>
</UnpaidNode>
</LeaveRuleNode>
Property Descriptions
Children
Children
A list of nodes that are children of the current node.
Type: Any combination of LeaveDecisionNode or LeavePassThroughNode or
LeaveRuleNode or LeaveTakingNode tags
Optional
Introduced in v5.1
DisplayName
Display name
The name of the node that is displayed in the user interface. The maximum length
is 50 characters.
Type: String
Required
Introduced in v5.1
PaidNode
Paid node
The node that represents the PAID branch off of the root node
(APILeaveRuleNode).
Type: LeavePassThroughNode tag
Required
Introduced in v5.1
UnpaidNode
Unpaid node
The node that represents the UNPAID branch off of the root node
(APILeaveRuleNode).
Type: LeavePassThroughNode tag
Required
Introduced in v5.1
LeaveTaking Tag
Leave Taking
Represents the proposed leave time for a specific accrual code for which there was
available (and accessible - e.g. passed balance limit checks) accrued time for a
person.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Properties→
<LeaveTaking
CommitType = String
Date = Date
Duration = TimeDuration
LeaveType = String />
Property Descriptions
CommitType
Commit type
The type that indicates where this taking was committed.
Type: String
Required
Must be either Timecard or Schedule.
Only Allowed Values: Timecard, Schedule
Default Value: Timecard
Introduced in v5.1
Date
Date
The date for which this taking applies.
Type: Date
Required
Introduced in v5.1
Duration
Duration
The amount of time (in seconds) this taking represents.
Type: TimeDuration
Required
Introduced in v5.1
LeaveType
Leave type
The leave type used to generate this taking.
Type: String
Required
This must be the name of an existing Leave Type. The maximum length is 50
characters.
Introduced in v5.1
LeaveTakingNode Tag
Leave Taking Node (unsupported)
THIS TAG IS NOT SUPPORTED FOR THIRD-PARTY USE INCLUDING
WORKFORCE CONNECT. These nodes evaluate the accrual balances and
produce LeaveTakings from the LeaveTimes being processed.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Properties→
<LeaveTakingNode
DisplayName = String
LeaveType = String >
[ <AccrualBalanceLimit>
<AccrualBalanceLimit>
</AccrualBalanceLimit> ]
[ <Children>
<LeaveDecisionNode>∗
<LeavePassThroughNode>∗
<LeaveRuleNode>∗
<LeaveTakingNode>∗
</Children> ]
</LeaveTakingNode>
Property Descriptions
AccrualBalanceLimit
Accrual balance limit
The accrual balance condition that determines the accrual balance limit this node
must meet before it can be used to generate leave takings.
Type: AccrualBalanceLimit tag
Optional
Introduced in v5.1
Children
Children
A list of nodes that are children of the current node.
Type: Any combination of LeaveDecisionNode or LeavePassThroughNode or
LeaveRuleNode or LeaveTakingNode tags
Optional
Introduced in v5.1
DisplayName
Display name
The name of the node that is displayed in the user interface. The maximum length
is 50 characters.
Type: String
Required
Introduced in v5.1
LeaveType
Leave type
The name of leave type for which this taking node performs taking operations.
Type: String
Required
This must be the name of an existing Leave Type. The maximum length is 50
characters.
Introduced in v5.1
LeaveTime Tag
Leave Time
Amount of time an employee will be on leave. A LeaveTime belongs to one
LeaveCase, and after processed by the LeaveCascader, will have 0 to many
LeaveTakings.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Properties→
<LeaveTime
Date = Date
Duration = TimeDuration
[ IsManualEdit = Boolean ]
[ IsPaidCommitted = Boolean ]
[ IsPaidProcessed = Boolean ]
[ IsUnpaidCommitted = Boolean ]
[ IsUnpaidProcessed = Boolean ] >
[ <LeaveTakings>
<LeaveTaking>∗
</LeaveTakings> ]
</LeaveTime>
Property Descriptions
Date
Date
Date the employee will be out on leave.
Type: Date
Required
Introduced in v5.1
Duration
Duration
Duration the employee will be out on leave.
Type: TimeDuration
Required
Introduced in v5.1
IsManualEdit
Manual edit flag
True if the leave time has been manually edited.
Type: Boolean
Optional
Default Value: false
Introduced in v5.1
IsPaidCommitted
Paid committed flag
True if the leave time's paid takings have been committed.
Type: Boolean
Optional
Default Value: false
Introduced in v5.1
IsPaidProcessed
Paid processed flag
True if the leave time has been cascaded for the Paid branch of the rule.
Type: Boolean
Optional
Default Value: false
Introduced in v5.1
IsUnpaidCommitted
Unpaid committed flag
True if the leave time's unpaid takings have been committed.
Type: Boolean
Optional
Default Value: false
Introduced in v5.1
IsUnpaidProcessed
Unpaid processed flag
True if the leave time has been cascaded for the unpaid branch of the rule.
Type: Boolean
Optional
Default Value: false
Introduced in v5.1
LeaveTakings
Leave takings
List of leave takings associated with this leave time.
Type: Zero or more LeaveTaking tags
Optional
Introduced in v5.1
LeaveType Tag
LeaveType
Leave types are essentially an accrual code/pay code pair. Leave types can also
contain a leave type document assignment, which assigns a document to a leave
yype.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update" |
"UpdateOnly"
Parameters→
[ NewName = String ]
Properties→
<LeaveType
AccrualCode = String
[ Description = String ]
Group = String
[ IsActive = Boolean ]
Name = String
PayCode = String
ShortName = String >
[ <LeaveTypeDocumentAssignments>
<LeaveTypeDocumentAssignment>∗
</LeaveTypeDocumentAssignments> ]
</LeaveType>
Action Descriptions
AddOnly
Adds a leave type.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Delete
Deletes a leave type.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Retrieve
Retrieves a leave type by name.
Return Value Type: LeaveType tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
RetrieveAll
Retrieves all leave types.
Return Value Type: Zero or more LeaveType tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Retrieves all leave types.
UpdateOnly
Updates a leave type only if it exists
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Action Parameters
Property Descriptions
AccrualCode
Accrual code
The name of an existing Accrual Code associated with the leave type.
Type: String
Required
Introduced in v5.1
Description
Description
Description of the leave type. Length must be between 0 and 250 characters.
Type: String
Optional
Introduced in v5.1
Group
Group
Identifies a group as paid or unpaid.
Type: String
Required
Sample values: Paid
Introduced in v5.1
IsActive
Active flag
True if the leave type is active.
Type: Boolean
Optional
Default Value: true
Introduced in v5.1
LeaveTypeDocumentAssignments
Leave type document assignments
The leave type document assignment contains documents and leave document
reminders which are associated with the leave type.
Type: Zero or more LeaveTypeDocumentAssignment tags
Optional
Introduced in v5.1
Name
Name
Name of the leave type. Length must be between 1 and 50 characters.
Type: String
Required
Contributes to Uniqueness: Yes
Introduced in v5.1
PayCode
Pay code
Name of an existing Pay Code associated with the leave type.
Type: String
Required
Introduced in v5.1
ShortName
Short name
Short name of the leave type. Length must be between 1 and 6 characters.
Type: String
Required
Introduced in v5.1
LeaveTypeDocumentAssignment Tag
Leave Type Document Assignment
The LeaveTypeDocumentAssignment tag is used to assign documents to a Leave
Type (LeaveType tag). It has no actions of its own.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Properties→
<LeaveTypeDocumentAssignment >
[ <Document>
<Document>
</Document> ]
[ <DocumentDueDate>
<DocumentDueDate>
</DocumentDueDate> ]
[ <LeaveDocumentReminders>
<LeaveDocumentReminder>∗
</LeaveDocumentReminders> ]
</LeaveTypeDocumentAssignment>
Property Descriptions
Document
Document
The Document tag is the document used by the Leave Type Document
Assignment to assign the Document to a Leave Type.
Type: Document tag
Optional
Introduced in v5.1
DocumentDueDate
Document due date
The DocumenDueDate tag is the document due date object used by the Leave
Type Document Assignment to assign the document to a Leave Type.
LeaveTypeReason Tag
Leave Type Reason
Associates leave types with leave reasons. This is a many-to-many relationship.
Function Access Control Point: WorkforceLeave
Introduced in v5.1
Syntax
Properties→
<LeaveTypeReason >
<LeaveType>
<LeaveType>
</LeaveType>
</LeaveTypeReason>
Property Descriptions
LeaveType
Leave type
The name of an exsiting leave type associated with a leave reason.
Type: LeaveType tag
Required
Contributes to Uniqueness: Yes
Introduced in v5.1
LicenseType Tag
License Type
The LicenseType tag identifies the available licenses within the system. This tag
contains category and count information for the specified license.
The license must already be defined. The license need not be assignable or active
to obtain its information.
Function Access Control Point: API.Person
Introduced in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<LicenseType
( AvailableCount = Integer )
( CategoryName = String )
( InUseCount = Integer )
[ LicenseTypeName = String ]
( LimitCount = Integer ) />
Action Descriptions
Load
Returns the category and count information associated with the specified license
type.
The license type name must be specified and identify an existing license within
the system.
Return Value Type: LicenseType tag
Required Properties: LicenseTypeName
Property Descriptions
AvailableCount
Number of unassigned licenses
The number of licenses still available to assign
Type: Integer
Output only
Introduced in v5.0
CategoryName
License type
The name of the license category
Type: String
Output only
Only Allowed Values: Product, Interactive
Introduced in v5.0
InUseCount
Number of assigned licenses
The number of licenses currently in use
Type: Integer
Output only
Introduced in v5.0
LicenseTypeName
License type name
The name or the Id of the license type.
There are a number of valid licenses, but not all are assignable to employees
The following license types can be assigned to employees:
• 1 or Workforce_Timekeeper_Employee
• 2 or Workforce_Professional_ Employee
• 3 or Workforce_Manager
• 5 or Workforce_Activities
• 9 or Workforce_Scheduler
• 10 or Workforce_Attendance_Employee
• 12 or Workforce_Leave_Employee
Type: String
Optional
Maximum length: 2 characters
Specify @ to make no change to the existing license type.
Only Allowed Values: @, 1, 2, 3, 5, 9, 10, 12
Contributes to Uniqueness: Yes
Introduced in v5.0
LimitCount
Maximum number of licenses allowed
The total number of licenses allowed
Type: Integer
Output only
Introduced in v5.0
LocationId Tag
Location Id of Node
The LocationId tag identifies the location of a node in the Organizational Map.
Used by: ScheduleZoneSet, StandardShiftSet
Function Access Control Point: API.Schedule
Introduced in v5.0
Deprecated in v5.0
Syntax
Properties→
<LocationId
NodeId = String />
Property Descriptions
NodeId
Node ID
An existing node in the Organizational Map
Type: String
Required
You can find values in the Workforce Timekeeper user interface.
Introduced in v5.0
LockedDataCorrection Tag
Adjust Signed-off Timesheet
The LockedDataCorrection tag describes a timesheet item generated by the
Callable Totalizer that represents a totalizer-generated adjustment credited to the
current pay period. The purpose of this edit is to make an adjustment to time in a
signed-off period.
Such an adjustment can be needed, for example, when an employee punches
across a day divide and the signoff date happens to occur on that day divide. If the
work rule specifies that hours count to the scheduled start day, then the "out"
punch must be credited to the period prior to the signoff. However, no punches or
other timekeeping events are permitted in the database prior to the signoff.
Therefore, a LockedDataCorrection is issued by the totalizer, crediting some
hours to the current pay period and noting the nature of this correction.
Used by: Timesheet
Function Access Control Point: API.Timecard
Introduced in v4; last changed in v5.0
Syntax
Properties→
<LockedDataCorrection
( Date = Date ) >
( <Employee>
<CurrentUser> | <PersonIdentity>
</Employee> )
( <Totals>
<Total>∗
</Totals> )
</LockedDataCorrection>
Property Descriptions
Date
Date
The date on which the edit is credited
Type: Date
Output Only
Sample values: 8:00 Vacation on 4/2/2001
Introduced in v4
Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, to whom the
amount is credited.
Type: Either CurrentUser or PersonIdentity tag
Output Only
Must uniquely identify an existing and active employee
Introduced in v4
Totals
Totals
The totals constituting the correction
Type: Zero or more Total tags
Output Only
Introduced in v4
LogonProfile Tag
Logon Profile
The LogonProfile tag provides information about valid logon profiles that are
defined within the system. A logon profile defines the settings for a user's
password and restrictions. The LogonProfile and WSALogonProfile tags are used
by the same database object.
Function Access Control Point: API.Employee
Introduced in v4; last changed in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<LogonProfile
[ LogonProfileId = Integer ]
[ LogonProfileName = String ] />
Action Descriptions
Load
Returns information for the specified logon profile, based on LogonProfileName.
Only logon profiles with a database key of -1 or greater will be returned.
Return Value Type: LogonProfile tag
Required Properties: LogonProfileName
Access Control Point Name: View
Introduced in v4; last changed in v5.0
LoadAllLogonProfiles
Returns all assignable logon profiles in the system.
Property Descriptions
LogonProfileId
Logon profile Id
Uniquely identifies the logon profile in the database
Type: Integer
Optional
Introduced in v4
LogonProfileName
Logon profile name
The Logon Profile column contains the name of the user's logon profile. The
logon profile provides rules for password behavior or provides rules for automatic
logout and lockout behavior.
Workforce provides the following predefined data values:
• &DEFAULT_LOGON
• &SUPER_USER_LOGON
• &XMLUSER_LOGON
• &IMPORT_LOGON_PROFILE
Type: String
Optional
Maximum length: 50 characters
Default Value: &DEFAULT_LOGON
Sample values: MobileTime Logon
Introduced in v4
ManagerRoleAvailabilityPatternProfile Tag
Availability Pattern Profile for Managers
The ManagerRoleAvailabilityPatternProfile tag contains a valid, existing
availability pattern Profile.
Function Access Control Point: API.Profile
Introduced in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
Load
Load the AvailabilityPattern profile from the database.
This property cannot be null and has to be valid.
Return Value Type: ManagerRoleAvailabilityPatternProfile tag
Required Properties: AvailabilityPatternProfileName
Access Control Point Name: View
Introduced in v5.0
LoadAll
Load all of the AvailabilityPattern profiles in the database.
Return Value Type: Zero or more ManagerRoleAvailabilityPatternProfile tags
Property Descriptions
AvailabilityPatternProfileName
Availability pattern profile name
The AvailabilityPatternProfile Name.
Type: String
Optional
Required: For a Load action
Contributes to Uniqueness: Yes
Introduced in v5.0
Description
Description
Description of the profile
Type: String
Output only
Maximum length: 250 characters
Introduced in v5.0
IsAllowAll
Does profile contain all permissions?
Indicates whether the profile contains all permissions.
Type: Boolean
Output only
Only Allowed Values: True, False
Introduced in v5.0
ManagerRoleScheduleGroupProfile Tag
Schedule Group Profile for Managers
The ManagerRoleScheduleGroupProfile tag contains a valid Schedule Group
Profile defined in Workforce Timekeeper.
Function Access Control Point: API.Profile
Introduced in v5.0; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
Load
Load the Schedule Group Profile from the database.
The ScheduleGroupProfileName property cannot be null and must be valid.
Return Value Type: ManagerRoleScheduleGroupProfile tag
Required Properties: ScheduleGroupProfileName
Access Control Point Name: View
Introduced in v5.0; last changed in v5.1
LoadAll
Load all of the Schedule Group Profiles in the database.
Return Value Type: Zero or more ManagerRoleScheduleGroupProfile tags
Property Descriptions
Description
Description
Description of the profile.
Type: String
Output only
Introduced in v5.0
IsAllowAll
Does profile contain all permissions?
Indicates whether the profile contains all permissions
Type: Boolean
Output only
Only Allowed Values: True, False
Introduced in v5.0
ScheduleGroupProfileName
Schedule group profile name
The name of a Workforce Manager's schedule group profile. This schedule group
profile identifies those schedule groups that the person can select.
Workforce Timekeeper provides the following predefined data values:
• &ALL_SCHEDULE_PATTERNS
• &EMPTY
Type: String
Optional
Maximum length: 50 characters
Contributes to Uniqueness: Yes
Introduced in v5.0
ManagerRoleSchedulePatternProfile Tag
Schedule Pattern Profile for Managers
The ManagerRoleSchedulePatternProfile tag contains a valid SchedulePattern
Profiles defined in Workforce Timekeeper.
Function Access Control Point: API.Profile
Introduced in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
Load
Load the SchedulePattern profile from the database.
The SchedulePatternProfileName property cannot be null and has to be valid.
Return Value Type: ManagerRoleSchedulePatternProfile tag
Required Properties: SchedulePatternProfileName
Access Control Point Name: View
Introduced in v5.0
LoadAll
Load all of the SchedulePattern profiles in the database.
Return Value Type: Zero or more ManagerRoleSchedulePatternProfile tags
Property Descriptions
Description
Description
Description of the profile
Required: For a load action
Type: String
Output only
Maximum length: 30 characters
Introduced in v5.0
IsAllowAll
Does profile contain all permissions?
Indicates whether the profile contains all permissions
Type: Boolean
Output only
Only Allowed Values: True, False
Introduced in v5.0
SchedulePatternProfileName
Schedule pattern profile name
The name of SchedulePatternProfile
Type: String
Optional
Maximum length: 250 characters
Contributes to Uniqueness: Yes
Introduced in v5.0
ManagerRoleShiftCodeProfile Tag
Shift Code Profile for Managers
The ManagerRoleShiftCodeProfile displays a valid shift code profile that already
exists.
Function Access Control Point: API.Profile
Introduced in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
Load
Load the ShiftCode profile from the database.
The ShiftCodeProfileName property cannot be null and has to be valid.
Return Value Type: ManagerRoleShiftCodeProfile tag
Required Properties: ShiftCodeProfileName
Access Control Point Name: View
Introduced in v5.0
LoadAll
Load all of the ShiftCode profiles in the database.
Return Value Type: Zero or more ManagerRoleShiftCodeProfile tags
Property Descriptions
Description
Description
Description of the profile
Type: String
Output only
Introduced in v5.0
IsAllowAll
Does profile contain all permissions?
Indicates whether the profile contains all permissions
Type: Boolean
Output only
Only Allowed Values: True, False
Introduced in v5.0
ShiftCodeProfileName
Shift code profile name
Name of the shift code profile
Required: For a load action
Type: String
Optional
Maximum value: 30 characters
Contributes to Uniqueness: Yes
Introduced in v5.0
MarkForTotalization Tag
Mark for Totalization
The MarkForTotalization tag identifies employee information that has changed
and must be recomputed.
Function Access Control Point: API.Timecard
Introduced in v4; last changed in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Update"
Properties→
<MarkForTotalization
[ RuleChangedFlag = Boolean ]
[ ScheduleChangedFlag = Boolean ] >
<Employee>
<CurrentUser> | <PersonIdentity>
</Employee>
</MarkForTotalization>
Action Descriptions
Update
Updates the specified flag or flags for the employee.
Return Value Type: None
Required Properties: Employee
Optional Properties: RuleChangeFlag, ScheduleChangedFlag
Access Control Point Name: Edit
Introduced in v4
Property Descriptions
Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, to be marked
for totalization
Type: Either CurrentUser or PersonIdentity tag
Required
Must uniquely identify an existing and active employee
Contributes to Uniqueness: Yes
Introduced in v4
RuleChangedFlag
Totalize if the pay rule changes?
Initiates a totalization for the employee as if the employee's pay rule has changed
Type: Boolean
Optional
Only Allowed Values: True, False
Default Value: False
Introduced in v4
ScheduleChangedFlag
Totalize if the schedule changes?
Initiates a totalization for the employee as if the employee's schedule has changed
Type: Boolean
Optional
Only Allowed Values: True, False
Default Value: False
Introduced in v4; last changed in v5.0
Menu Tag
Menu
The Menu tag identifies the list of menu items for one user. If no user is specified,
the default value is the logged-on user.
Function Access Control Point: API.Menu
Introduced in v4
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Load"
Properties→
<Menu >
( <MenuItems>
<MenuItem>∗
</MenuItems> )
[ <User>
<CurrentUser> | <PersonIdentity>
</User> ]
</Menu>
Action Descriptions
Load
Returns a list of menu items for the specified user or the currently logged-on user.
Return Value Type: Menu tag
Access Control Point Name: View
Introduced in v4
Property Descriptions
MenuItems
Menu items
A list of menu items for the user
Type: Zero or more MenuItem tags
Output Only
Introduced in v4
User
User
One person, as specified in a PersonIdentity or CurrentUser tag, to whom the
menu is assigned
Type: Either CurrentUser or PersonIdentity tag
Optional
Default Value: Logged on user
Contributes to Uniqueness: Yes
Introduced in v4
MenuItem Tag
Menu Item
The MenuItem tag denotes one entry in a Menu tag. You can use this tag to
display a menu item and follow its links.
Used by: Menu
Function Access Control Point: API.Menu
Introduced in v4
Syntax
Properties→
<MenuItem
( AccessControlPointName = String )
( Depth = Integer )
( ExternalFlag = Boolean )
( Label = String )
( MenuItemName = String )
( URL = String ) />
Property Descriptions
AccessControlPointName
Access control point name
A control, such as access to the HyperFind function, that determines how a user
can interact with a product feature
Type: String
Output Only
Introduced in v4
Depth
Depth of item within menu
Depth of this item in the menu
Type: Integer
Output Only
Must be greater than or equal to 0
Introduced in v4
ExternalFlag
Is this an external menu link?
Indicates whether this menu item points to a link that is part of the Workforce
Central application. If it points to an external link, the value is True.
Type: Boolean
Output Only
Only Allowed Values: True, False
Introduced in v4
Label
Label shown in menu
The label used when displaying this menu item
Type: String
Output Only
Introduced in v4
MenuItemName
Menu item
Name of the menu item
Type: String
Output Only
Introduced in v4
URL
URL for menu item
The URL of the menu item
Type: String
Output Only
Introduced in v4
MinimunHoursNoModification Tag
Minimun Allowable Hours before a Swap Shift
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 MinimunHoursNoModification tag is used to determine whether a swap shift
is requested at an acceptable time.
Function Access Control Point: API.Schedule
Introduced in v5.1Beta; last changed in v5.0.a
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Load"
Properties→
<MinimunHoursNoModification
( IsBeyondMinimunHours = Boolean )
( MinimunHoursRequired = Time )
QueryDate = Date
StartTime = Time />
Action Descriptions
Load
This action determines whether the request is made at an acceptable time.
Return Value Type: MinimunHoursNoModification tag
Required Properties: QueryDate, StartTime
Access Control Point Name: View
Introduced in v5.1Beta
Property Descriptions
IsBeyondMinimunHours
Is request submitted on time?
This value is true if your request has been submitted on time; false if is has not.
Type: Boolean
Output only
Only Allowed Values: true, false
Introduced in v5.0.a
MinimunHoursRequired
Hours required before the request
The minimum number of hours before a shift that a swap can be accepted
Type: Time
Output only
Sample values: 72.00
Introduced in v5.0.a
QueryDate
Start date
The date when the request is submitted
Type: Date
Required
Introduced in v5.1Beta
StartTime
Start time
The time of day when the shift begins
Type: Time
Required
Sample values: 7a
Introduced in v5.1Beta
NameList Tag
Name List
The NameList tag returns one or more items that are specified in a specific
request.
Function Access Control Point: API.Common
Introduced in v5.1
Syntax
Properties→
<NameList
( PropertyName = String ) >
( <Names>
<SimpleValue>∗
</Names> )
</NameList>
Property Descriptions
Names
Names
One or more names of the entities in the DB as instances of "SimpleValue"
Type: Zero or more SimpleValue tags
Output only
Introduced in v5.1
PropertyName
Property Name
This whole object represents the collection of names of all of the instances of a
particular type of business object within the target DB. This attribute holds the
name of the attribute which is used with one of the names within this collection to
retrieve a particular instance of this Business Object class from the database.
Type: String
Output only
Introduced in v5.1
Names Tag
Names of Rules
List of user-understandable names of all rules (i.e business entities).
Function Access Control Point: API.Common
Introduced in v5.1
Syntax
Properties→
<Names >
( <SimpleValues>
<SimpleValue>∗
</SimpleValues> )
</Names>
Property Descriptions
SimpleValues
Set of rule names
List of names returned as simple values.
Type: Zero or more SimpleValue tags
Output only
Introduced in v5.1
NonCancellingPayCodeEdit Tag
Non-Canceling Pay Code Edit
The NonCancellingPayCodeEdit tag adds or subtracts an amount to an existing
pay code edit.
If you want to override a scheduled pay code edit with a specified amount, use the
PayCodeEdit tag.
Function Access Control Point: API.Timecard
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Properties→
<NonCancellingPayCodeEdit
AmountInTimeOrCurrency = String
[ CommentText = String ]
Date = Date
( EnteredOnDate = Date )
( EnteredOnTime = Time )
( IsCurrencyFlag = Boolean )
[ LaborAccountName = String ]
PayCodeName = String >
( <Comments>
<Comment>∗
</Comments> )
<Employee>
<CurrentUser> | <PersonIdentity>
</Employee>
</NonCancellingPayCodeEdit>
Action Descriptions
AddComment
Adds a comment to each pay code edit associated with the specified employee.
The CommentText must exactly match an entry in the Comment table.
Return Value Type: None
Required Properties: AmountInTimeOrCurrency, CommentText, Date, Employee,
PayCodeName
Access Control Point Name: Edit
Introduced in v4
AddOnly
Adds a new pay code edit with the specified properties.
Return Value Type: PayCodeEdit tag
Required Properties: AmountInTimeOrCurrency, Date, Employee, PayCodeName
Access Control Point Name: Edit
Introduced in v4
Action Parameters
Delete
Marks for deletion all pay code edits for the employee with matching properties.
Return Value Type: None
Required Properties: AmountInTimeOrCurrency, Date, Employee, PayCodeName
Access Control Point Name: Edit
Introduced in v4
Property Descriptions
AmountInTimeOrCurrency
Amount of pay code, in time or currency
Amount to be added or subtracted from an existing pay code, expressed as a time
duration or money. To subtract an amount, use a negative number.
Type: String
Required,
Maximum length: 30 characters
Whether the value is expressed as a time duration or a currency depends on the
pay code.
LaborAccountName
Labor account
The name of the labor account. LaborAccountName is required when the pay
code edit, historical edit, or totaled amount being deleted or commented contained
an explicit value. It need not be specified if the pay code amount or totaled
amount applies to the employee's primary account.
Enter data for labor accounts in the same format as they appear in the Workforce
Timekeeper database. For example, if you have a seven-level labor account,
specify a value for each labor level, using the following format: 101/202/303/404/
504/603/702.
Do not specify labor levels that are not changing.
If any of the labor levels are the same as the employee's primary labor account,
you can enter @H for those labor levels instead of entering the labor entry names.
Type: String
Optional,
Maximum length: 356 characters
Default Value: Primary account for the employee
Contributes to Uniqueness: Yes
Introduced in v4; last changed in v5.0
PayCodeName
Pay code
The pay code to be edited.
Type: String
Required,
Must be assiciated with an hourly or monetary pay code edit
Contributes to Uniqueness: Yes
Introduced in v4; last changed in v5.1
OnCall Tag
On Call
The OnCall tag describes a timesheet item generated by the Callable Totalizer.
This read-only pay code edit corresponds to the amount of time in the scheduled
shift if the scheduled shift's work rule has been configured as a "Callin" work rule.
The scheduled shift may be a work rule transfer.
Used by: Timesheet
Function Access Control Point: API.Timecard
Introduced in v4; last changed in v5.0
Syntax
Properties→
<OnCall
( AmountInTime = TimeDuration )
( Date = Date )
( LaborAccountName = String ) >
( <Employee>
<CurrentUser> | <PersonIdentity>
</Employee> )
</OnCall>
Property Descriptions
AmountInTime
Amount of pay code, in time
Amount of pay code amount, expressed as a time duration
Type: TimeDuration
Output Only
Introduced in v4
Date
Date
The date on which the edit is credited
Type: Date
Output Only
Sample values: 4/2/2001
Introduced in v4
Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, to be credited
with the amount.
Type: Either CurrentUser or PersonIdentity tag
Output Only
Must uniquely identify an existing and active employee
Introduced in v4
LaborAccountName
Labor account
The labor account associated with the edit. If not specified in the PayCodeEdit
tag, the employee's primary account is used.
Type: String
Output Only
Maximum length:356 characters
Introduced in v4; last changed in v5.0
OpenShiftItem Tag
OpenShiftItem
This tag only contains an open shift's date time span information.
none
Function Access Control Point: API.Schedule
Introduced in v5.1
Syntax
Properties→
<OpenShiftItem
( DATE_TIME_SPAN = DateTimeSpan ) />
Property Descriptions
DATE_TIME_SPAN
date time span
This property contains an open shift's date time span.
Type: DateTimeSpan
Output only
Must be a valid date time span.
Introduced in v5.1
OpenShiftVolunteer Tag
OpenShiftVolunteer
This tag assigns a WFS licensed employee to an open shift.
Function Access Control Point: API.Schedule
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<OpenShiftVolunteer
[ IsCheckRules = Boolean ]
[ IsSaveData = Boolean ]
[ OrgJobPath = String ]
[ PartialEndDate = Date ]
[ PartialEndTime = Time ]
[ PartialStartDate = Date ]
[ PartialStartTime = Time ]
[ QueryDate = Date ]
[ QueryDateTimeSpan = DateTimeSpan ] >
<Employee>
<PersonIdentity>
</Employee>
( <OpenShiftItems>
<OpenShiftItem>∗
</OpenShiftItems> )
( <RuleViolations>
<RuleViolation>∗
</RuleViolations> )
</OpenShiftVolunteer>
Action Descriptions
AssignOpenShiftVolunteer
This action will assign a person to an open shift.
The specified open shift must be a vliad open shift. The specified employee must
be an active employee.
Return Value Type: Zero or more RuleViolation tags
Required Properties: QueryDateTimeSpan,OrgJobPath,Employee
Access Control Point Name: Edit
Introduced in v5.1
GetOpenShiftsForJob
This action will load all open shifts for a specified job within a specified date
range.
OrgJobPath must be a valid organization job path and QueryDate must be a valid
date.
Return Value Type: Zero or more OpenShiftItem tags
Required Properties: QueryDate, OrgJobPath
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
Employee
Employee
This property represents the employee who requests the action to cover an open
shift.
Type: PersonIdentity tag
Required
It must be an active employee.
Contributes to Uniqueness: Yes
Introduced in v5.1
IsCheckRules
Check validation rules?
This property indicates whether schedule validation rules will be checked.
Type: Boolean
Optional
none
Introduced in v5.1
IsSaveData
Save change data?
This property indicates whether the changes made will be persisted to the
database.
Type: Boolean
Optional
none
Introduced in v5.1
OpenShiftItems
Open Shift Items
This property contains a list of an open shift's date time span information.
Type: Zero or more OpenShiftItem tags
Output only
none
Introduced in v5.1
OrgJobPath
Organizational job path
This property represents an organization job for an open shift
Type: String
Optional
The specified jon must be a valid job
OptOutStatus Tag
Working Time Directive Opt Out Status
This tag shows an employee's opt in/out status for the Working Time Directive.
The Working Time Directive feature lets you plan, monitor, and track the amount
of time that employees are required to work. It also lets you ensure that employees
have appropriate rest periods.
A working time directive rule should be assigned only to those employees who
have working time limits. For more information, see the online help.
See parent WTDEmployeeAssignment.
Function Access Control Point: Working Time Directive
Introduced in v5.1
Syntax
Properties→
<OptOutStatus
[ EffectiveDate = DateTime ]
[ ExpirationDate = DateTime ]
[ In = Boolean ]
WtdEmployeeAssgnmntId = Long />
Property Descriptions
EffectiveDate
Effective Date
The date on which this status is effective.
Type: DateTime
Optional
Introduced in v5.1
ExpirationDate
Expiration Date
The date on which this status expires. Not used.
Type: DateTime
Optional
Introduced in v5.1
In
Opt Out/In Status
Indicates if the status is an opt in or out.
Type: Boolean
Optional
Sample values: True
Introduced in v5.1
WtdEmployeeAssgnmntId
WTD Employee Assignment Id
Set on object insert. No need to set.
Type: Long
Required
Sample values: 1
Introduced in v5.1
OptOutStatusList Tag
Working Time Directive Opt Out Status List
Extended from EffectiveDatedList it represents all of an employee's opt in/out
status for a Working Time Directive Rule.
See parent WTDEmployeeAssignment.
Function Access Control Point: Working Time Directive
Introduced in v5.1
Syntax
Properties→
<OptOutStatusList
[ WtdAssignmentId = Long ] >
[ <OptOutStatuses>
<OptOutStatus>∗
</OptOutStatuses> ]
</OptOutStatusList>
Property Descriptions
OptOutStatuses
Opt Out Statuses
The list of opt in/out statuses for an employee
Type: Zero or more OptOutStatus tags
Optional
Introduced in v5.1
WtdAssignmentId
WTD Assignment Id
Set on insertion into WTDEmployeeAssignment. Not necessary to set.
Type: Long
Optional
Sample values: 1
Introduced in v5.1
OrgJob Tag
Organizational Job
An organizational job is a job plus a location in the organizational map. An
organizational job is represented by an organizational path name.
Function Access Control Point: API.RetailSchedules
Introduced in v5.1Beta; last changed in v5.1
Syntax
Properties→
<OrgJob
( FullPath = String )
( NodeId = Long ) />
Property Descriptions
FullPath
Full path for organizational job
The full path for the task group organizational job
Type: String
Output only
Introduced in v5.1Beta
NodeId
Organizational node id
The id for the organizational node
Type: Long
Output only
Introduced in v5.1Beta
OrgLocation Tag
Location of Node in Organization
The OrgLocation tag describes a node in an organizational map (or tree). An
organizational map is a hierarchical representation of an organization that
represents where employees work, where they might be scheduled (locations), and
the jobs they perform at those locations.
Used by: OrgLocationsImport
The node must be unique under the parent node.
Function Access Control Point: API.Tree
Introduced in v5.0; last changed in v5.1
Syntax
Properties→
<OrgLocation
[ Description = String ]
[ EndEffectiveDate = Date ]
[ LLEntryName = String ]
[ LocationName = String ]
LocationNum = Long
[ LocationType = String ]
ParentLocationNum = Long
[ Seasonal = Boolean ]
[ StartEffectiveDate = Date ] />
Property Descriptions
Description
Description
Describes the node.
Type: String
Optional
You can find values in the Workforce Timekeeper Setup Application.
Sample values: Registered Nurse
Introduced in v5.0
EndEffectiveDate
Effective end date
The date when the node ceases to be effective.
Required: If an organizational location is being added.
Optional: If an organizational location is being updated.
Type: Date
Optional
The effectives date must be within the range of effective dates for the parent node.
A change in an effective date for a parent node automatically changes the
appropriate child node's effective date.
Default Value: 1/1/3000
Introduced in v5.0
LLEntryName
Labor level entry
The labor level name of the node.
Type: String
Optional
Maximum length: 50 characters
Introduced in v5.0
LocationName
Node in the organization
The name of the node.
Type: String
Optional
You can find values in the Workforce Timekeeper user interface.
Required: If you are adding a new node
Sample values: Lab
Introduced in v5.0
LocationNum
Node Id
A unique identifier for the node.
Type: Long
Required
Maximum length: 12
Sample values: 232
Contributes to Uniqueness: Yes
Introduced in v5.0
LocationType
Location type
The category of the node in the organization.
Type: String
Optional
You can find values in the Workforce Timekeeper user interface.
Required: If you add a new node, you must specify an already existing
LocationType.
Sample values: Facility, Job, Division
Introduced in v5.0
ParentLocationNum
Location of parent node
The unique identifier of the parent node to which this node is associated.
Type: Long
Required
Maximum length: 12 characters
Must be an integer
The ParentLocationNum must exist in the organizational tree.
OrgLocationsImport Tag
Nodes in Organizational Map
The OrgLocationsImport tag is used to import one or more nodes in the
organizational map (or tree). A node can be modified, moved to a different parent
node, or added.
Function Access Control Point: API.Tree
Introduced in v5.0; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Update"
Properties→
<OrgLocationsImport
ChangeDate = Date >
<OrgLocations>
<OrgLocation>∗
</OrgLocations>
</OrgLocationsImport>
Action Descriptions
Update
Imports one or more organizational tree nodes. If a specified node already exists,
it is updated. If it does not exist, it is added.
If you are adding a node, you must specify existing LocationType and
LocationName properties in the OrgLocation tag.
Return Value Type: None
Required Properties: ChangeDate, OrgLocations
Access Control Point Name: Edit
Introduced in v5.0
Property Descriptions
ChangeDate
Date of import
The date when the specified nodes are imported
Type: Date
Required
Introduced in v5.0
OrgLocations
Organization locations
One or more organization locations
Type: One or more OrgLocation tags
Required
Introduced in v5.0
OrgSet Tag
Organizational Set
The OrgSet tag describes the attributes of an organizational set. An organizational
set is a group of organizational jobs combined into a single entity for group edits
and other management tasks. Organizational sets contain one or more
organizational groups or job transfer sets, beginning with the managerís personal
root.
This tag identifies the area of the organizational map that a user can access. It also
retrieves a list of organizational sets of a particular type, such as job transfer sets.
Function Access Control Point: API.DataAccess
Introduced in v5.0; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"AddOnly" |
"Load" |
"Update" |
"UpdateOnly"
Properties→
<OrgSet
[ Description = String ]
[ NewName = String ]
( OrgSetId = Long )
OrgSetName = String
[ OrgSetTypeName = String ] >
[ <EntryList>
<OrgSetEntry>∗
</EntryList> ]
( <OrgSetJobList>
<OrgSetJob>∗
</OrgSetJobList> )
</OrgSet>
Action Descriptions
AddOnly
Adds a new organizational set.
Return Value Type: None
Required Properties: OrgSetName,OrgSetTypeName, EntryList
Access Control Point Name: Edit
Introduced in v5.0
Load
Returns information for all organization sets. When type is not specified, orgsetids
and effectiveDate are required when type is "orgJobs".
Return Value Type: Zero or more OrgSet tags
Required Properties: orgsetName
Optional Properties: TYPE, orgsetids, effectiveDate
Access Control Point Name: View
Introduced in v5.0
Update
Adds a new organizational set or updates an existing one. When adding a new
organizational set, Description, orgSetTypeName and EntryList are required.
Return Value Type: None
Required Properties: orgsetName
Optional Properties: Description, OrgSetTypeName, EntryList
Access Control Point Name: Edit
Introduced in v5.0
UpdateOnly
Updates information for an existing organization set.
Return Value Type: None
Required Properties: OrgSetName
Access Control Point Name: Edit
Introduced in v5.0
Property Descriptions
Description
Description
Describes the organization set, which consists of locations and jobs.
Type: String
Optional
You can find values in the Workforce Timekeeper user interface.
Introduced in v5.0
EntryList
All jobs in the set
This list contains all of the jobs in the set.
Type: Zero or more OrgSetEntry tags
Optional
Introduced in v5.0
NewName
New name of job set
A unique name used to rename the organization job set
Type: String
Optional
Introduced in v5.0
OrgSetId
Primary identifier for job set
The primary identifier for the organization job set
Type: Long
Output only
Maximum length: 10 characters
An integer value
Introduced in v5.0
OrgSetJobList
Jobs in set
One or more jobs in the organization job set
Type: Zero or more OrgSetJob tags
Output only
Introduced in v5.0
OrgSetName
Job sets with similarities
The name of the organizational set for the selected action.
Type: String
Required
Contributes to Uniqueness: Yes
Introduced in v5.0; last changed in v5.1
OrgSetTypeName
Job set type
Type of the organization job set
Type: String
Optional
Maximum length: 30 characters
Only Allowed Values: All Organizational Sets, Organizational Groups, Job
Transfer Sets
Introduced in v5.0
OrgSetEntry Tag
Jobs in Set
Use the OrgSetEntry tag to add or replace organizational jobs in an organizational
set.
Used by: OrgSet
Function Access Control Point: API.DataAccess
Introduced in v5.0; last changed in v5.1
Syntax
Properties→
<OrgSetEntry
[ AddEntries = String ]
EffectiveDate = Date
( OrgId = Long )
[ ReplaceEntries = String ] />
Property Descriptions
AddEntries
Locations for new jobs
A semicolon-delimited list of full pathnames for jobs. The jobs you list will be
added to the organizational set.
Type: String
Optional
Introduced in v5.0; last changed in v5.1
EffectiveDate
Effective date
The date when the specified jobs become effective
Type: Date
Required
Introduced in v5.0
OrgId
ID for job set entry
A unique identifier for the organization set entry
Type: Long
Output only
Introduced in v5.0
ReplaceEntries
Replacement jobs in set
A semicolon-delimited list of full pathnames for jobs. The jobs you list will
replace existing jobs in the organizational set.
Type: String
Optional
Introduced in v5.0; last changed in v5.1
OrgSetJob Tag
Job in Organizational Job Set
The OrgSetJob tag describes a job that is defined in the organizational set.
Used by: Org Set
Function Access Control Point: API.DataAccess
Introduced in v5.0
Syntax
Properties→
<OrgSetJob
( OrgJobId = String )
( OrgJobName = String ) />
Property Descriptions
OrgJobId
Job Id
A unique identifier for a job in the organization
Type: String
Output only
You must have Functional Access for Job Transfers. A node with this Id must
exist in the organizational structure.
Introduced in v5.0
OrgJobName
Job name
The full path of the job in the organization
Note: OrgJobName string matching is case-sensitive on a Workforce Central
server that connects to an Oracle database.
Type: String
Output only
OvertimeApproval Tag
Overtime Approval
The OvertimeApproval tag lets an individual approve overtime for an employee
on one specified day.
Use either the ApproveAll, ApproveSome, or ApproveNone action to approve the
appropriate amount of overtime.
Function Access Control Point: API.Timecard
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"AddComment" |
"ApproveAll" |
"ApproveNone" |
"ApproveSome"
Properties→
<OvertimeApproval
[ AmountInTime = TimeDuration ]
[ CommentText = String ]
Date = Date
( EnteredOnDate = Date )
( EnteredOnTime = Time ) >
( <Comments>
<Comment>∗
</Comments> )
<Employee>
<CurrentUser> | <PersonIdentity>
</Employee>
</OvertimeApproval>
Action Descriptions
AddComment
Adds a comment along with the action taken.
Return Value Type: None
Required Properties: Employee, Date, CommentText, AmountInTime
Access Control Point Name: Edit
Introduced in v4
ApproveAll
Approve all overtime for the specified day.
Return Value Type: None
Required Properties: Employee, Date
Access Control Point Name: Edit
Introduced in v4; last changed in v5.1
ApproveNone
Does not approve any overtime requested or submitted for the specified day.
Return Value Type: None
Required Properties: Employee, Date
Access Control Point Name: Edit
Introduced in v4; last changed in v5.1
ApproveSome
Approve only a portion of the overtime hours that the employee submitted or
requested.
Return Value Type: None
Required Properties: Employee, Date, AmountInTime
Access Control Point Name: Edit
Introduced in v4; last changed in v5.1
Property Descriptions
AmountInTime
Amount of approved overtime
This property is meaningful only when you use the ApproveSome action. Enter
the number of hours to be approved. When used with the AddComments action,
All or None can be specified, if appropriate.
Type: TimeDuration
Optional
Must not be negative
Introduced in v4; last changed in v5.1
Comments
Comments
The set of comments currently returned with this timekeeping item
Type: Zero or more Comment tags
Output Only
Introduced in v4
CommentText
Comment text
A comment
Type: String
Optional
Maximum length: 254 characters
The comment must match exactly an applicable comment that already exists in the
database. The string matching is case-sensitive.
You can find values in the Workforce Timekeeper Setup Application.
Introduced in v4
Date
Date of overtime
The date for which the overtime hours are being approved
Type: Date
Required
Contributes to Uniqueness: Yes
Introduced in v4
Employee
Employee
One employee for whom overtime hours are to be approved, as specified in a
PersonIdentity or CurrentUser tag.
Type: Either CurrentUser or PersonIdentity tag
Required
Must uniquely identify an existing and active employee
Contributes to Uniqueness: Yes
Introduced in v4
EnteredOnDate
Date of the edit
The server date on which the edit is added to the database
Type: Date
Output Only
Introduced in v4
EnteredOnTime
Time of the edit
The server time on which the edit is added to the database
Type: Time
Output Only
Introduced in v4
PasswordHistory Tag
Password History
The PasswordHistory tag returns an encrypted password for the specified date.
Used by: User
Function Access Control Point: API.Person
Introduced in v4; last changed in v5.1
Syntax
Properties→
<PasswordHistory
( EffectiveDateTime = DateTime )
( Password = Password ) />
Property Descriptions
EffectiveDateTime
Effective date and time
The date and time when the password becomes effective
Type: DateTime
Output Only
Introduced in v4
Password
Password
Encrypted password of the user account
Type: Password
Output Only
Introduced in v4; last changed in v5.0
PatternElement Tag
Schedule Pattern Element
The PatternElement tag describes a part of the schedule pattern that represents an
employee's schedule for a day.
Used by: SchedulePattern
Function Access Control Point: API.Schedule
Introduced in v4; last changed in v5.1
Syntax
Properties→
<PatternElement
AmountInCurrency = Currency
AmountInTime = TimeDuration
( CommentText = String )
DayNumber = Integer
[ DisplayTime = Time ]
PayCodeName = String
ShiftCodeName = String >
( <Comments>
<Comment>∗
</Comments> )
</PatternElement>
Property Descriptions
AmountInCurrency
Amount of pay code, in currency
An amount expressed as a currency
Only used if PayCodeName is specified and represents a monetary item.
Type: Currency
See group( AccrualAmount)
Must be greater than zero
Introduced in v4
AmountInTime
Amount of pay code, in time
A pay code amount, expressed as a time duration
Dependency: Only used if PayCodeName is specified and represents an hourly
pay code.
Type: TimeDuration
See group( AccrualAmount)
Must be greater than zero
Introduced in v4
Comments
Comments
User comments
Type: Zero or more Comment tags
Output only
Introduced in v5.0
CommentText
Comment text
A text string that is returned
Type: String
Output only
Maximum length: 254 characters
Introduced in v5.0
DayNumber
Day number in the pattern
Specifies the day of the pattern
Type: Integer
Required
Must be greater than zero
Introduced in v4
DisplayTime
Time to display in the user interface
The time displayed in the user interface
Type: Time
Optional
Introduced in v4
PayCodeName
Pay code for the day
The pay code allocated to that day. PayCodeName and ShiftCodeName are
mutually exclusive; one is required.
Type: String
See group( PatternElementCode)
A pay code can require either AmountInCurrency or AmountInTime. Must be a
valid pay code.
Introduced in v4
ShiftCodeName
Shift code for the day
The shift code allocated to the specified day. PayCodeName and ShiftCodeName
are mutually exclusive; one is required.
Type: String
See group( PatternElementCode)
You can find values in the Workforce Timekeeper user interface.
Introduced in v4
PayCode Tag
Pay Code
The PayCode tag provides information about a pay code. You can use this tag to
determine whether a user has permission to assign the pay code to himself/herself
or to other employees. The PayCode and WSAPayCode tags refer to the same
database object.
Function Access Control Point: API.Timecard
Introduced in v4; last changed in v4.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "LoadAllPayCodes"
Properties→
<PayCode
( DisplayOrder = Integer )
( ExcuseAbsenceFlag = Boolean )
( IsCombinedFlag = Boolean )
( IsCurrencyFlag = Boolean )
( IsVisibleFlag = Boolean )
( ManagerAccessFlag = Boolean )
( PayCodeName = String )
( ProfessionalAccessFlag = Boolean ) />
Action Descriptions
LoadAllPayCodes
Returns a list of all pay codes.
Return Value Type: Zero or more PayCode tags
Required Properties: None
Access Control Point Name: View
Introduced in v4
Property Descriptions
DisplayOrder
Order to display pay codes in the user interface
If another tag returns a list of PayCode tags, this specifies the sort order of this tag
in the list.
Type: Integer
Output Only
Introduced in v4
ExcuseAbsenceFlag
Can credited amounts excuse an absence?
Indicates whether amounts credited to this pay code can excuse an absence
Type: Boolean
Output Only
Only Allowed Values: True, False
Introduced in v4
IsCombinedFlag
Is the pay code combined?
Indicates whether the pay code is combined
Type: Boolean
Output Only
Only Allowed Values: True, False
Introduced in v4
IsCurrencyFlag
Is the pay code in currency?
True if the pay code represents a monetary item. False if it represents an hourly
pay code.
Type: Boolean
Output Only
Only Allowed Values: True, False
Introduced in v4
IsVisibleFlag
Can a user see the pay code?
Indicates whether the pay code is visible to the end user
Type: Boolean
Output Only
Only Allowed Values: True, False
Introduced in v4
ManagerAccessFlag
Can a manager access the pay code?
Indicates whether the pay code is accessible for manager functions
Type: Boolean
Output Only
Only Allowed Values: True, False
Introduced in v4
PayCodeName
Pay code
Name of the pay code
Type: String
Output Only
Introduced in v4
ProfessionalAccessFlag
Can an employee access the pay code?
Indicates whether the pay code is accessible for professional functions
Type: Boolean
Output Only
Only Allowed Values: True, False
Introduced in v4
PayCodeEdit Tag
Pay Code Edit
The PayCode Edit tag identifies a positive or negative amount that replaces a
scheduled pay code edit. To add a value rather than replace one, use the
NonCancellingPayCodeEdit tag.
Function Access Control Point: API.Timecard
Introduced in v4; last changed in v5.0.a
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Properties→
<PayCodeEdit
AmountInTimeOrCurrency = String
[ CommentText = String ]
Date = Date
( EnteredOnDate = Date )
( EnteredOnTime = Time )
( IsCurrencyFlag = Boolean )
[ LaborAccountName = String ]
[ ManagerName = String ]
OrgJobId = String
OrgJobName = String
PayCodeName = String
ScheduleAmountType = String >
( <Comments>
<Comment>∗
</Comments> )
<Employee>
<CurrentUser> | <PersonIdentity>
</Employee>
</PayCodeEdit>
Action Descriptions
AddComment
Adds a comment to each pay code edit associated with the specified employee.
Depending on the type of edit, you may need to specify LaborAccountName.
Return Value Type: None
Required Properties: AmountInTimeOrCurrency, CommentText, Date, Employee,
PayCodeName
Access Control Point Name: Edit
Introduced in v4
AddOnly
Adds a new pay code edit with the specified properties.
Return Value Type: PayCodeEdit tag
Required Properties: AmountInTimeOrCurrency, Date, Employee, PayCodeName
Access Control Point Name: Edit
Introduced in v4
Action Parameters
Delete
Marks for deletion all pay code edits for the employee with matching properties.
Return Value Type: None
Required Properties: AmountInTimeOrCurrency, Date, Employee, PayCodeName
Access Control Point Name: Edit
Introduced in v4
Property Descriptions
AmountInTimeOrCurrency
Amount, in time or currency
The value associated with the corresponding pay code amount or totaled amount.
This property is required for all request codes. Enter the value as follows:
• If PayCodeName holds money, specify an amount of money.
• If PayCodeName holds time, specify a duration of time.
ScheduleAmountType and AmountInTimeOrCurrency are mutually exclusive.
Type: String
Introduced in v4
Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, to be credited
with the amount.
Type: Either CurrentUser or PersonIdentity tag
Required,
Must uniquely identify an existing and active employee
Contributes to Uniqueness: Yes
Introduced in v4; last changed in v5.0
EnteredOnDate
Date of the edit
The date on which the edit is added to the database
Type: Date
Output Only
Introduced in v4
EnteredOnTime
Time of the edit
The time at which the edit is added to the database
Type: Time
Output Only
Introduced in v4
IsCurrencyFlag
Is the amount in currency or time?
True if the pay code represents a monetary item. False if it represents an hourly
pay code.
Type: Boolean
Output Only
OrgJobId
ID of job in organization
A unique identifier for a job in the organization
Type: String
See group( OrgJob)
Default Value: Null
Introduced in v5.0
OrgJobName
Job in the organization
The name of the organizational job path for the employee whose pay code amount
or totaled amount is being edited.
It is optional when you add a pay code, historical edit, or totaled amount. It is not
used if the punch applies to the employee's primary organizational job.
Enter data for OrgJobName in the same format as it appears in the database.
Note: OrgJobName string matching is case-sensitive on a Workforce Central
server that connects to an Oracle database.
Type: String
See group( OrgJob)
Maximum length: 1000 characters
You must have Functional Access for Job Transfers. A node with this Id must
exist in the organizational structure.
Default Value: Null
Introduced in v5.0
PayCodeName
Pay code
Identifies the name of the pay code that is being applied to an amount associated
with a pay code or to a historical amount. This is always required when importing
a pay code edit or a historical edit.
A pay code represents an amount in time or ciurrency. It can represent one of the
following units:
• The hours accumulated during a pay period. A pay code that holds hours can
contain worked hours (such as regular, overtime, or second shift) or unworked
hours (such as vacation, sick, or personal).
• Money earned by employees during a pay period.
For example, to allocate hours for J.D. Smith, who worked 8 regular and 4
overtime hours for a total of 12 hours, create two pay code edit entries:
• An entry with 8 regular hours
• An entry with 4 overtime hours
Type: String
Required,
Maximum length: 50 characters
Contributes to Uniqueness: Yes
Introduced in v4
ScheduleAmountType
Amount, based on the employee's schedule
ScheduleAmountType can be used instead of AmountInTimeCurrency to specify
an amount based on the employee's schedule. The amount of time actually saved
for the pay code edit will be calculated by the totalizer based on the employee's
schedule for the specified day, or zero if there is no schedule for the day.
If ScheduleAmountType is calculated, the value is based on the number of hours
that the employee is scheduled to work that day and whether the amount is a full
day or half day amount.
If specified, it must be one of the following:
• 1 to calculate the amount as a full-day scheduled amount.
• 2 to calculate the amount as a half-day scheduled amount
ScheduleAmountType and AmountInTimeOrCurrency are mutually exclusive.
Type: String
See group( Amount in Time)
PayCodeMove Tag
Pay Code Move
The PayCodeMove tag moves an amount of time or money to from one pay code
or labor account to another.
Function Access Control Point: API.Timecard
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Parameters→
[ AccrualOverride = Boolean ]
[ allowAdHoc = Boolean ]
[ EchoData = Boolean ]
Properties→
<PayCodeMove
AmountInTimeOrCurrency = String
[ CommentText = String ]
Date = Date
( EnteredOnDate = Date )
( EnteredOnTime = Time )
[ FromLaborAccountName = String ]
FromPayCodeName = String
[ LaborAccountName = String ]
[ ManagerName = String ]
OrgJobId = String
[ OrgJobName = String ]
PayCodeName = String >
( <Comments>
<Comment>∗
</Comments> )
<Employee>
<CurrentUser> | <PersonIdentity>
</Employee>
</PayCodeMove>
Action Descriptions
AddComment
Adds a comment to the set of comments associated with the pay code move item.
Return Value Type: None
Required Properties: AmountInTimeOrCurrency, CommentText, Date,
FromLaborAccountName, FromPayCodeName, PayCodeName
Access Control Point Name: Edit
Introduced in v4
AddOnly
Adds a new pay code move item with the specified properties.
Return Value Type: PayCodeMove tag
Required Properties: AmountInTimeOrCurrency, Date, FromLaborAccountName,
FromPayCodeName, PayCodeName
Access Control Point Name: Edit
Introduced in v4
Action Parameters
Delete
Marks for deletion an existing pay code move item.
Return Value Type: None
Required Properties: AmountInTimeOrCurrency, Date, FromLaborAccountName,
FromPayCodeName, PayCodeName
Access Control Point Name: Edit
Introduced in v4
Property Descriptions
AmountInTimeOrCurrency
Amount of pay code, in time or currency
Amount of pay code, expressed as a time duration or currency.
Type: String
Required,
Maximum length: 30 characters
Whether the value is expressed as a time duration or a currency depends on the
pay code.
If any of the labor levels are the same as the employee's primary labor account,
you can enter @H for those labor levels instead of entering the labor entry names.
Type: String
Optional
Maximum length: 356 characters
Default Value: Primary account for the employee
Introduced in v4; last changed in v5.0
ManagerName
Manager Name
The name to replace the user name in audit.
Type: String
Optional
Maximum length: 70 characters
Introduced in v5.0.a
OrgJobId
ID of job in organization
A unique identifier for a job in the organization
Type: String
See group( OrgJob)
Default Value: Null
Introduced in v5.0
OrgJobName
Job in the organization
The name of the organizational job path for the employee
If specified, enter data for OrgJobName in the same format as it appears in the
database.
Note: OrgJobName string matching is case-sensitive on a Workforce Central
server that connects to an Oracle database.
Type: String
Optional
Maximum length: 1000 characters
You must have Functional Access for Job Transfers. A node with this Id must
exist in the organizational structure.
Default Value: null
Introduced in v5.0
PayCodeName
Pay code
The pay code to be credited with the moved amount
Type: String
Required,
Maximum length: 50 characters
Contributes to Uniqueness: Yes
Introduced in v4
PayCodeProfile Tag
Pay Code Profile
The PayCodeProfile tag returns information about valid PayCode profiles defined
within the Workforce Timekeeper system. A Pay Code is a category that the
Workforce Timekeeper system uses to organize time and money. Time pay codes
accrue hours, while money pay codes accrue money.
Note: To assign a pay code profile to a person, use the ManagerPayCodeName or
ProfessionalPayCodeName property in the AccessAssignment tag.
Function Access Control Point: API.Employee
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"Load" |
"LoadAllPayCodeProfiles" |
"LoadById" |
"LoadPayCodesForProfileName"
Properties→
<PayCodeProfile
[ PayCodeProfileId = Integer ]
[ PayCodeProfileName = String ] />
Action Descriptions
Load
Returns a pay code profile, based on PayCodeProfileName.
Name should be valid
Return Value Type: PayCodeProfile tag
Property Descriptions
PayCodeProfileId
Id of Pay code profile
Uniquely identifies the pay code data access profile in the database
Type: Integer
Optional
Introduced in v4
PayCodeProfileName
Pay code profile name
The name for the common set of pay codes that can be accessed by a group of
users, for example, All Pay Codes.
Type: String
Optional
Introduced in v4
PayFromSchedule Tag
Pay from Schedule
The PayFromSchedule tag identifies a period of time during which an employee
can be paid from a predefined schedule. When the tag is used, the employee's
timecard is populated with punches and pay code edits, based on the personís
work schedule.
Function Access Control Point: API.Timecard
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<PayFromSchedule
[ CommentText = String ]
EndDate = Date
StartDate = Date >
<Employee>
<PersonIdentity>
</Employee>
</PayFromSchedule>
Action Descriptions
AddOnly
Adds a record to the timesheet that identifies an employee and a time period when
pay is based on a schedule.
The employee must exist.
Return Value Type: None
Required Properties: Employee, StartDate, EndDate
Property Descriptions
CommentText
Comment text
A comment
Type: String
Optional
Maximum length: 254 characters
Must match exactly an applicable comment that already exists in the database.
The string matching is case-sensitive.
You can find values in the Workforce Timekeeper Setup Application.
Introduced in v4
Employee
Employee
One employee who is paid from a schedule, as specified in a PersonIdentity tag.
Type: PersonIdentity tag
Required
Must uniquely identify an existing and active employee
Introduced in v4
EndDate
End date
The end date of the schedule period
Type: Date
Required
Introduced in v4
StartDate
Start date
The start date of the schedule period
Type: Date
Required
Introduced in v4
PayFromScheduleStopEvent Tag
Stop Payment from Schedule
The PayFromScheduleStopEvent tag stops a Pay from Schedule payment from
being posted for a specific date (for example, when an employee is absent).
Function Access Control Point: API.Timecard
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
AddOnly
Adds a record to the timesheet to stop an employee from being paid according to
the schedule when he or she is absent.
Only one entry can exist for the given employee and date.
Return Value Type: None
Required Properties: Employee, Date
Access Control Point Name: Edit
Introduced in v4
Delete
Marks the record to stop an employee from being paid according to the schedule
for deletion.
The employee must exist
Return Value Type: None
Required Properties: Employee, Date
Access Control Point Name: Edit
Introduced in v5.0
Property Descriptions
CommentText
Comment text
A comment
Type: String
Optional
Maximum length: 254 characters
Must match exactly an applicable comment that already exists in the database.
The string matching is case-sensitive.
You can find values in the Workforce Timekeeper Setup Application.
Introduced in v4
Date
Date of event
The date when the event occurred employee that caused payment to be stopped.
An example of such an event is an absence.
Type: Date
Required
Introduced in v4
Employee
Employee
One employee, as specified in a PersonIdentity tag, who is paid from schedule and
was absent.
Type: PersonIdentity tag
Required
Must uniquely identify an existing and active employee
Introduced in v4
PayRuleProfile Tag
Pay Rule Profile
The PayRuleProfile tag provides information about existing pay rules.
A pay rule contains general payroll rules, such as type of pay period (for example,
weekly). A complete pay rule controls such items as the pay period length, the day
divide, when punches are linked to schedules, when data collection devices accept
and reject punches, which holidays give holiday credits, and the order in which
hour types are processed.
Function Access Control Point: API.Employee
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
Load
Returns a pay rule profile, based on PayRuleProfileName.
Return Value Type: PayRuleProfile tag
Required Properties: PayRuleProfileName
Access Control Point Name: View
Introduced in v4
LoadAllPayRuleProfiles
Returns a list of all pay rule profiles in the system.
Return Value Type: Zero or more PayRuleProfile tags
Required Properties: None
Access Control Point Name: View
Introduced in v4
LoadById
Returns a pay rule profile, based on PayRuleProfileId.
Return Value Type: PayRuleProfile tag
Required Properties: PayRuleProfileId
Access Control Point Name: View
Introduced in v4
Property Descriptions
PayRuleProfileId
ID of pay rule profile
Uniquely identifies the pay rule in the system
Type: Integer
Optional
Introduced in v4
PayRuleProfileName
Pay rule profile
The name for the common set of general payroll rules that apply to a group of
employees
Type: String
Optional
Sample values: Full Time
Introduced in v4
PeriodTotals Tag
Period Totals
The PeriodTotals tag contains a summary of all hours and currency earned during
a range of days, disbursed by labor account and pay code. The amount associated
with each labor account and pay code pair is returned in a Total tag.
Used by: Timesheet
Function Access Control Point: API.Timecard
Introduced in v4
Syntax
Properties→
<PeriodTotals
( PeriodDateSpan = DateSpan ) >
( <Totals>
<TotalSummary>
</Totals> )
</PeriodTotals>
Property Descriptions
PeriodDateSpan
Span of dates
The start and end dates separated by a dash for the specified period; that is, the
period for which the totals apply.
Type: DateSpan
Output Only
Sample values: 04/03/2001-04/09/2001
Introduced in v4
Totals
Totals
A list of totals for this date, broken out by labor account and pay code
Type: TotalSummary tag
Output Only
The combination of pay code and labor account must be unique.
Introduced in v4
Permission Tag
Permission
The Permission tag denotes an action and its associated access control point. This
tag has no actions, but is accessed through the GetAllowedPermissions action of
the AccessProfile tag.
Function Access Control Point: API.AccessProfile
Introduced in v4; last changed in v5.0
Syntax
Properties→
<Permission
( AccessControlPointName = String )
( ActionName = String )
( ScopeName = String )
( SuiteProductName = String ) />
Property Descriptions
AccessControlPointName
Access control point name
A control, such as access to the HyperFind function, that determines how a user
can interact with a product feature
Type: String
Output Only
Introduced in v4
ActionName
Action name
Action for which the permission has been granted: add, edit, delete, or view.
Type: String
Output Only
Introduced in v4
ScopeName
Scope of action
Scope that is associated with the action and permission type.
Type: String
Output Only
Introduced in v4
SuiteProductName
Product name
Individual product that is protected by this access control point.
Type: String
Output Only
Only Allowed Values: WFA, WFP, WTK, WAC, WFE, WFS, DCM, WRM,
WMT, PLATFORM_SERVICES, EVENT_MGR, BGP, NOTIFICATION,
REPORTS_ENGINE, WHR, WPR, WCT, TID, TA, M8M
Introduced in v4
Person Tag
Name and Employment Data
The Person tag defines name and employment information for an employee.
Used by: HyperFindResult, PersonInformation
Because several properties are required to define an employee, property
validations are not done until the data is updated in the system.
Function Access Control Point: API.Person
Introduced in v4; last changed in v5.1
Syntax
Properties→
<Person
[ AccrualProfileName = String ]
[ BaseWageHourly = Currency ]
[ BirthDate = Date ]
[ EmployeeStandardHours = Double ]
[ FingerRequiredFlag = Boolean ]
[ FirstName = String ]
( FullName = String )
[ FullTimePercentage = Long ]
[ FullTimeStandardHours = Double ]
[ HireDate = Date ]
[ LastName = String ]
( ManagerSignoffThruDateTime = Date )
[ MiddleInitial = String ]
( PayrollLockoutThruDateTime = Date )
[ PersonNumber = String ]
[ ShortName = String ] />
Property Descriptions
AccrualProfileName
Accrual profile
The accrual profile to be used for a person or group. An accrual profile can
contain one or more accrual rules. Accrual profiles are assigned to similar groups
of employees. For example, all full-time employees might have the same accrual
profile.
Type: String
Optional
Maximum length: 50 characters
You can find values in the Workforce Timekeeper Setup Application.
Sample values: VAC and Sick Only
Introduced in v5.0; last changed in v5.1
BaseWageHourly
Base hourly wage
The base wage is the employeeís hourly wage without any premium values
(overtime, shift differential, and so on).
Type: Currency
Optional
Maximum length: 15 characters
If specified, this value must be greater than or equal to 0.0.
Default Value: 0.00
Introduced in v4; last changed in v5.1
Deprecated in v5.0: Use this property in the JobAssignmentDetails tag instead.
BirthDate
Birth date
The person's date of birth
Type: Date
Optional
Must occur before the hire date when the hire date is also specified
Introduced in v4
EmployeeStandardHours
Ratio - employee hours
Type: String
Optional
Maximum length: 30 characters
Introduced in v4
FullName
Full name
Name of the person. This name is usually listed in the browser.
Type: String
Output Only
Maximum length: 64 characters
This property is derived from other properties in the person tag.
Introduced in v4
FullTimePercentage
Percentage of full-time hours
FullTimePercentage sets the full-time equivalency for a part-time employee,
defining the equivalency as the percentage of full-time hours that the employee is
scheduled to work. The full-time equivalency is used to determine the rate at
which benefits accrue for an employee who is not scheduled to work a full
standard work week.
For example, suppose this employee is scheduled to work 20 hours, and a full-
time employee works 40 hours per week. The full-time percentage for this person
is therefore 50%.
To use this property for a part-time employee, use an integer value between 1 and
100.
You can alternatively specify the employee's full-time equivalency as a ratio of
scheduled hours to standard hours. To do this, use the EmployeeStandardHours
and FullTimeStandardHours properties. If you enter a value for
EmployeeStandardHours and FullTimeStandardHours, do NOT enter a value for
FullTimePercentage.
Type: Long
Optional
Maximum length: 15 characters, including decimals
It must be between 0 and 100.
Default Value: 100.0
Introduced in v4; last changed in v5.1
FullTimeStandardHours
Ratio - full time status
The EmployeeStandardHours and FullTimeStandardHours properties define the
full-time equivalency for a part-time employee, defining the equivalency as a ratio
of the employee's scheduled hours to the hours in a standard work week. Full-time
equivalency is used to determine the rate at which benefits accrue for an employee
who is not scheduled to work a full standard work week.
For example, suppose this employee is scheduled to work 30 hours, and a full-
time employee works 40 hours per week. You would enter a value of 30 for
EmployeeStandardHours and a value of 40 for FullTimeStandardHours.
You can alternatively specify the employee's full-time equivalency as the
percentage of full-time hours that the employee is scheduled to work. To do this,
use the FullTimePercentage property. If you enter a value for FullTimePercentage,
do NOT enter a value for EmployeeStandardHours or FullTimeStandardHours.
Type: Double
Optional
Maximum length: 15 characters, including decimals
This value is specified as part of the Employee to FullTime Standard Hours ratio.
It must be greater than 0.0.
Default Value: 40
Introduced in v4; last changed in v5.1
HireDate
Hire date
The date on which the person was hired.
Type: Date
Optional
If you provide a value, it must be later than the birth date.
Required: When adding a new employee.
Default Value: The date when the personís record is imported.
Introduced in v4; last changed in v5.0
LastName
Last name
The person's last name. A value for this column is required when adding a new
person.
Type: String
Optional
Maximum length: 30 characters
Introduced in v4
ManagerSignoffThruDateTime
Date of last manager signoff
Date of the last manager signoff
Type: Date
Output only
Introduced in v5.0
MiddleInitial
Middle initial
The person's middle initial
Type: String
Optional
Maximum length: 1 character
Introduced in v4
PayrollLockoutThruDateTime
Date of last payroll lockout
PersonAccessAssignment Tag
Access Assignment Data
The PersonAccessAssignment tag specifies an access assignment that is in effect
for an employee as of the effective date.
Used by: PersonInformation
Function Access Control Point: API.Person
Introduced in v5.0; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "LoadPersonAccessAssignments"
Properties→
<PersonAccessAssignment
[ EffectiveDate = Date ]
[ ExpirationDate = Date ]
[ ManagerAccessOrganizationSetName = String ]
[ ManagerTransferOrganizationSetName = String ]
[ ProfessionalTransferOrganizationSetName = String ] >
[ <Identity>
<CurrentUser> | <PersonIdentity>
</Identity> ]
[ <Period>
<TimeFramePeriod>
</Period> ]
</PersonAccessAssignment>
Action Descriptions
LoadPersonAccessAssignments
Returns information associated with person access assignments over the specified
time period.
If the period is not specified, the current date through January 1, 3000 is used.
The Identity and Period information associated with the request are added to the
item in the returned list. If there are no data for the person and time period, one list
item is returned containing only the Identity and Period properties.
The person must exist within the system and the user must have access to that
person.
Return Value Type: Zero or more PersonAccessAssignment tags
Required Properties: Identity
Optional Properties: Period
Access Control Point Name: View
Introduced in v5.0
Property Descriptions
EffectiveDate
Date when access becomes effective
The date the access assignment becomes effective for the person
Type: Date
Optional
Must occur before the expiration date
Default Value: The current system date
Introduced in v5.0
ExpirationDate
Expiration date for access
The date the person's access assignment expires
Type: Date
Optional
Must occur after the effective date
Default Value: January 1, 3000
Introduced in v5.0
Identity
Identity
One person, as specified in a PersonIdentity or CurrentUser tag.
Type: Either CurrentUser or PersonIdentity tag
Optional
Must uniquely identify a person.
Contributes to Uniqueness: Yes
Introduced in v5.0
ManagerAccessOrganizationSetName
Organizational group
An organizational group that a manager can use.
Type: String
Optional
Maximum length: 30 characters
Only Allowed Values: All Organizational Sets, Organizational Groups
Default Value: The Empty Organization Set
Introduced in v5.0
ManagerTransferOrganizationSetName
Job transfer set - manager
A job transfer set that a manager can use.
Type: String
Optional
Maximun length: 30 characters
Only Allowed Values: All Organizational Sets, Job Transfer Sets
Default Value: The Empty Organization Set
Introduced in v5.0; last changed in v5.1
Period
Time period
Personality Tag
Personality Data
Use the Personality tag to add a new person to the system, delete an existing
person from the system, or modify certain information about an existing person.
Function Access Control Point: API.Person
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"DeleteOnly" |
"Load" |
"Update" |
"UpdateOnly"
Properties→
<Personality >
[ <Identity>
<CurrentUser> | <PersonIdentity>
</Identity> ]
[ <JobAssignmentData>
<JobAssignment>
</JobAssignmentData> ]
[ <Period>
<TimeFramePeriod>
</Period> ]
[ <PersonInformationData>
<PersonInformation>
</PersonInformationData> ]
[ <UserData>
<User>
</UserData> ]
[ <WTKEmployeeData>
<WTKEmployee>
</WTKEmployeeData> ]
</Personality>
Action Descriptions
AddOnly
Adds a new person to the system.
Return Value Type: None
Required Properties: PersonInformationData
Access Control Point Name: Edit
Introduced in v4
Delete
Marks a person for deletion.
Return Value Type: None
Required Properties: Identity
Access Control Point Name: Edit
Introduced in v5.0
DeleteOnly
Marks a person for deletion.
Return Value Type: None
Required Properties: Identity
Access Control Point Name: Edit
Introduced in v4; last changed in v5.0
Deprecated in v5.0: Use the Delete action.
Load
Returns a person's demographic, user, and employee information.
Return Value Type: Personality tag
Required Properties: Identity
Access Control Point Name: View
Introduced in v4
Update
Adds information for a new person or updates an existing one.
Return Value Type: None
Required Properties: If Identity is not specified, PersonInformationData is
required, and a new person is added. If Identity is specified, the record is updated
or added, depending on whether it already exists.
Access Control Point Name: Edit
Introduced in v4
UpdateOnly
Updates an existing person.
Return Value Type: None
Required Properties: Identity
Access Control Point Name: Edit
Introduced in v4
Property Descriptions
Identity
Identity
One person, as specified in a PersonIdentity or CurrentUser tag.
Type: Either CurrentUser or PersonIdentity tag
Optional
Contributes to Uniqueness: Yes
Introduced in v4
JobAssignmentData
Job assignment data
The job assignment information for the person
Type: JobAssignment tag
Optional
Introduced in v5.0
Period
Time period
A span of time that may or may not be associated with a person
Type: TimeFramePeriod tag
Optional
Used for narrowing the effective date of the request
Default Value: From the current date until January 1, 3000
Introduced in v5.0
PersonInformationData
Person data
The person information of the person
Type: PersonInformation tag
Optional
Required: When creating a new person
Introduced in v4; last changed in v5.1
UserData
User data
The user information for the person
Type: User tag
Optional
Introduced in v4
WTKEmployeeData
Employee data
Specifies the WTKEmployee information for the person
Type: WTKEmployee tag
Optional
PersonalOvertimeAssignment Tag
Overtime Assignment for a Person
The PersonalOvertimeAssignment tag specifies an overtime assignment within a
range of dates for a person. It is used for importing data into the system.
Function Access Control Point: API.Person
Introduced in v5.0; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Load"
Properties→
<PersonalOvertimeAssignment
[ EffectiveDate = Date ]
[ ExpirationDate = Date ]
OvertimeLevel = Long
OvertimeTypeName = String
[ StopOvertimeFlag = Boolean ] >
[ <Identity>
<CurrentUser> | <PersonIdentity>
</Identity> ]
[ <Period>
<TimeFramePeriod>
</Period> ]
[ <PersonalOvertimeRuleData>
<PersonalOvertimeRule>
</PersonalOvertimeRuleData> ]
</PersonalOvertimeAssignment>
Action Descriptions
Load
Returns all personal overtime assignments for the specified person within the
specified time period. If the period is not specified, the current date through
January 1, 3000 is used.
The Identity and Period information associated with the request are added to the
item in the resulting list.
If no data are found for the person and time period, the first item on the list
contains only the Identity and Period properties.
The person must exist within the system.
Return Value Type: Zero or more PersonalOvertimeAssignment tags
Required Properties: Identity
Optional Properties: Period
Access Control Point Name: View
Introduced in v5.0
Property Descriptions
EffectiveDate
Effective date
The date when the personal overtime assignment becomes effective
Type: Date
Optional
Must occur before the expiration date
Default Value: Current system date
Introduced in v5.0
ExpirationDate
Expiration date
The date when the personal overtime assignment expires
Type: Date
Optional
PersonalOvertimeLimit Tag
Overtime Limit for a Person
The PersonalOvertimeLimit tag identifies personal overtime values that are
assigned to a personal overtime rule.
Used by: PersonalOvertimeRule
Function Access Control Point: API.Person
Introduced in v5.0
Syntax
Properties→
<PersonalOvertimeLimit
[ Amount = TimeDuration ]
[ MinimumAmount = TimeDuration ]
PersonalOvertimeAmountTypeName = String />
Property Descriptions
Amount
Time worked before overtime accrues
The amount of time before the overtime begins to accrue. This overrides the
amount in the limit rule.
Type: TimeDuration
Optional
Default Value: null
Introduced in v5.0
MinimumAmount
Overtime worked before overtime rate starts
The amount of overtime time that must be worked before the overtime rate is
applied
Type: TimeDuration
Optional
Default Value: null
Introduced in v5.0
PersonalOvertimeAmountTypeName
Type of overtime amount
The type that is associated with the amounts.
Type: String
Required
Maximum length: 30 characters
Only Allowed Values: &DAILY, &WEEKLY, &PAYPERIOD, &BI_WEEKLY,
&RANGE_OF_TIME, &SHIFT, &24HOUR_RULE, &NUMBER_OF_DAYS
Contributes to Uniqueness: Yes
Introduced in v5.0
PersonalOvertimeRule Tag
Overtime Rule for a Person
The PersonalOvertimeRule tag provides the amount information associated with a
personal overtime assignment. An overtime rule establishes the limits and reset
methods for accumulating overtime hours. When employees reach overtime goals
within specified time periods, they start to earn overtime hours. There is always
one personal overtime rule for each personal overtime assignment.
Used by: PersonalOvertimeAssignment
Function Access Control Point: API.Person
Introduced in v5.0; last changed in v5.1
Syntax
Properties→
<PersonalOvertimeRule
( PersonalOvertimeRuleDisplayName = String )
[ UseScheduleFlag = Boolean ] >
[ <PersonalOvertimeLimits>
<PersonalOvertimeLimit>∗
</PersonalOvertimeLimits> ]
</PersonalOvertimeRule>
Property Descriptions
PersonalOvertimeLimits
Personal overtime limits
The list of Personal Overtime Limit tags that are associated with the personal
overtime rule
Type: Zero or more PersonalOvertimeLimit tags
Optional
Introduced in v5.0
PersonalOvertimeRuleDisplayName
Personal overtime rule
The name of a personal overtime rule used for an external user
Type: String
Output only
Introduced in v5.0
UseScheduleFlag
Use schedule to determine overtime?
When true, the personal overtime rule uses the days in the schedule to determine
when overtime is allowed.
Type: Boolean
Optional
Only Allowed Values: True, False
Introduced in v5.0
PersonAuthenticationType Tag
Authentication Type
The PersonAuthenticationType tag contains information about an authentication
type relative to a specific person. There is a finite set of authentication types
recognized by the system and each person is either considered active or inactive
with respect to each of them. A person should be active with a single
authentication type at any given time.
For the ActiveFlag property data is expected to be either boolean true or false.
For the AuthenticationTypeName property data is expected to be one of the
following types recognized by the system: Kronos, NT, LDAP,
KRONOS_CUSTOM.
Function Access Control Point: API.Person
Introduced in v5.1
Syntax
Properties→
<PersonAuthenticationType
ActiveFlag = Boolean
AuthenticationTypeName = String />
Property Descriptions
ActiveFlag
Is this auth type active for this person?
Indicates whether or not the specified Authentication Type is active or inactive
with respect to the person. True means that this person will be authenticated in the
manner specified in AuthenticationTypeName when they attempt to log on to the
system.
Type: Boolean
Required
Sample values: true or false
Introduced in v5.1
AuthenticationTypeName
Name or ID of Authentication Type
The name or id of the AuthenticationType being activated or inactivated for this
person.
Type: String
Required
Sample values: Kronos, NT, LDAP, KRONOS_CUSTOM or 1,2,3,4
Introduced in v5.1
PersonCertificationAssign Tag
Certifications Assigned to Employees
The PersonCertificationAssign tag assigns one or more certifications to one or
more employees.
Function Access Control Point: API.Schedule
Introduced in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
LoadAll
Returns all certification assignments for an employee.
Return Value Type: PersonCertificationAssign tag
Required Properties: PersonNumber
Access Control Point Name: View
Introduced in v5.0
LoadCertificationAssignments
Returns certification assignments for an employee for the specified timeframe.
If Period is not specified, this action returns all assignments from the current date
to January 1, 3000
Return Value Type: PersonCertificationAssign tag
Required Properties: PersonNumber
Optional Properties: Period
Access Control Point Name: View
Introduced in v5.0
Update
Assigns certifications to one or more employees.
Return Value Type: None
Required Properties: PersonCertificationItems, Employees
Access Control Point Name: Edit
Introduced in v5.0
Property Descriptions
Employees
Employees
One or more employees, as specified in one or more PersonIdentity tags, for
whom the certification is assigned.
Type: Zero or more PersonIdentity tags
Optional
Each employee must have a WFS license.
Introduced in v5.0
Period
Time period
PersonCertificationItem Tag
Certification Assigned to Employees
The PersonCertificationItem tag identifies a certification that can be assigned to
one or more people.
Used by: PersonCertificationAssign
Function Access Control Point: API.Schedule
Introduced in v5.0
Syntax
Properties→
<PersonCertificationItem
[ CertificationNumber = String ]
EffectiveDate = Date
ExpirationDate = Date
Name = String
[ OldCertificationNumber = String ]
[ OldEffectiveDate = Date ]
[ OldExpirationDate = Date ] />
Property Descriptions
CertificationNumber
Certification number
Certification number
Type: String
Optional
Maximum length: 12 characters
Introduced in v5.0
EffectiveDate
Effective date
The date when the certification assignment becomes effective for the employee
previously specified
Type: Date
Required
Introduced in v5.0
ExpirationDate
Expiration date
The date when the assignment of this certification to the previously specified
employee expires
Type: Date
Required
Introduced in v5.0
Name
Certification name
The unique name of a legal certification
Type: String
Required
Maximum length: 40 characters
You can find values in the Workforce Timekeeper user interface.
Introduced in v5.0
OldCertificationNumber
Old certification number
The old certification number is the number that was previously assigned to a
person.
Dependency: If any one of OldCertificationNumber, OldEffectiveDate, or
OldExpirationDate is specified, the other two must also be specified.
To update a certification number, you must specify the certification number and
these three properties.
Type: String
Optional
Maximum length: 12 characters
Introduced in v5.0
OldEffectiveDate
Old effective date
The old effective date is the one that was previously specified for a person
certification assignment.
Dependency: If any one of OldCertificationNumber, OldEffectiveDate, or
OldExpirationDate is specified, the other two must also be specified.
Type: Date
Optional
Introduced in v5.0
OldExpirationDate
Old expiration date
The old expirtion date is the one that was previously specified for a person
certification assignment.
Dependency: If any one of OldCertificationNumber, OldEffectiveDate, or
OldExpirationDate is specified, the other two must also be specified.
Type: Date
Optional
Introduced in v5.0
PersonIdentity Tag
Person Identity Data
The PersonIdentity tag identifies one or more people. It is used by many import
transactions.
Function Access Control Point: API.Common
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "LoadIdentities"
Properties→
<PersonIdentity
BadgeNumber = String
EmployeeKey = Long
PersonKey = Long
PersonNumber = String
UserKey = Long >
[ <FilterQueryName>
<HyperFindQuery>
</FilterQueryName> ]
<PersonIdentityList>
<CurrentUser>∗
<PersonIdentity>∗
</PersonIdentityList>
</PersonIdentity>
Action Descriptions
LoadIdentities
Returns the person number, badge number, and database keys for the specified
person. The user must specify exactly one of BadgeNumber, PersonNumber,
PersonKey, EmployeeKey, or UserKey.
Property Descriptions
BadgeNumber
Badge number
Contains an employee badge number that is assigned to the employee.
The system can be configured to allow multiple badges for employees. Specify
whether to allow multiple badge assignments in Workforce Timekeeper > System
Configuration > System Settings > Global Values >
global.BadgeAssignment.allowsOverlap = Yes.
If an employee is assigned multiple badge numbers, each badge number and
associated information is added in a separate reqiest.
If you want to remove a badge number, remove all existing badge numbers. Then
reassign the valid number that you want to keep.
A member of the Identifier group. If you are importing data from another system,
this may be a convenient identifier to use.
Type: String
See group( Identifier)
Maximum length: 25 characters
Must be unique for the specified date span. Validation is done after a person is
associated with a badge, using the PersonInformation tag.
The effective date is the date of the server
Introduced in v4
EmployeeKey
Employee database key
The internal database key that identifies the employee. As an internal number, it is
not likely to be widely used for functions such as import transactions.
Type: Long
See group( Identifier)
Maximum value = 2,147,488, 848
Must identify just one person
A member of the Identifier group
Introduced in v4; last changed in v5.0
FilterQueryName
Query name
Specifies the name of an existing query that identifies one or more people.
Information is returned in the HyperFindResult tag.
Note: When importing person-related information that involves making changes
to an inactive or terminated employeeís status or information, specify the name of
a hyperfind query that includes all employees.
Type: HyperFindQuery tag
Optional
The default value, All Home, only returns Active employees.
Default Value: All Home
Introduced in v5.0
PersonIdentityList
Person identity list
One or more PersonIdentity and CurrentUser tags
Type: Any combination of CurrentUser or PersonIdentity tags
See group( Identifier)
Each person in the list is validated separately.
PersonIdentityList is a member of the Identifier group. However, you may not use
it if you are importing data.
Introduced in v4
PersonKey
Person database key
The internal database key that identifies the person. As an internal number, it is
not likely to be widely used for functions such as import transactions.
Type: Long
See group( Identifier)
Maximum value = 2,147,488, 848
Must identify just one person
A member of the Identifier group
Introduced in v4; last changed in v5.0
PersonNumber
Person number
The personís identification number.
A member of the Identifier group. If you are importing data from another system,
this may be a convenient identifier to use.
Type: String
See group( Identifier)
Maximum length: 15 characters
Non-numeric values are permitted.
Introduced in v4; last changed in v5.0
UserKey
User database key
The internal database key that identifies the user. As an internal number, it is not
likely to be widely used for functions such as import transactions.
Type: Long
See group( Identifier)
Maximum value = 2,147,488, 848
Must identify just one person
PersonInformation Tag
Person Information and Data
The PersonInformation tag contains demographic, employment, and system
information.
Used by: Personality
See the following tags for validation rules:
• AccessAssignment
• BadgeAssignment
• CustomData
• CustomDate
• EmailAddress
• EmploymentStatus
• ExpectedHours
• HomeAccount
• PersonIdentity
• Person
• PersonAccessAssignment
• PersonLicenseType
• PostalAddress
• Supervisor
• TelephoneNumber
• UserAccountStatus
Function Access Control Point: API.Person
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"Load" |
"LoadAllBadgeAssignments" |
"LoadAllEmploymentStatus" |
"LoadAllHomeAccounts" |
"LoadAllUserAccountStatus"
Properties→
<PersonInformation >
[ <AccessAssignmentData>
<AccessAssignment>
</AccessAssignmentData> ]
[ <BadgeAssignments>
<BadgeAssignment>∗
</BadgeAssignments> ]
[ <CustomDataList>
<CustomData>∗
</CustomDataList> ]
[ <CustomDates>
<CustomDate>∗
</CustomDates> ]
[ <EmailAddresses>
<EmailAddress>∗
</EmailAddresses> ]
[ <EmploymentStatusList>
<EmploymentStatus>∗
</EmploymentStatusList> ]
[ <ExpectedHoursList>
<ExpectedHours>∗
</ExpectedHoursList> ]
[ <HomeAccounts>
<HomeAccount>∗
</HomeAccounts> ]
<Identity>
<CurrentUser> | <PersonIdentity>
</Identity>
[ <PersonAccessAssignments>
<PersonAccessAssignment>∗
</PersonAccessAssignments> ]
[ <PersonAuthenticationTypes>
<PersonAuthenticationType>∗
</PersonAuthenticationTypes> ]
[ <PersonData>
<Person>
</PersonData> ]
[ <PersonLicenseTypes>
<PersonLicenseType>∗
</PersonLicenseTypes> ]
[ <PostalAddresses>
<PostalAddress>∗
</PostalAddresses> ]
[ <SupervisorData>
<Supervisor>
</SupervisorData> ]
[ <TelephoneNumbers>
<TelephoneNumber>∗
</TelephoneNumbers> ]
[ <UserAccountStatusList>
<UserAccountStatus>∗
</UserAccountStatusList> ]
</PersonInformation>
Action Descriptions
Load
Returns all demographic, employment, and system information for the specified
person.
Return Value Type: PersonInformation tag
Required Properties: Identity
Access Control Point Name: View
Introduced in v4
LoadAllBadgeAssignments
Returns all badge assignments for the specified person.
Return Value Type: Zero or more BadgeAssignment tags
Required Properties: Identity
Access Control Point Name: View
Introduced in v4; last changed in v5.0
Property Descriptions
AccessAssignmentData
Access rights
A set of access rights and preferences
Type: AccessAssignment tag
Optional
Introduced in v4
BadgeAssignments
Badge assignments
One or more badge numbers and associated time frames
Type: Zero or more BadgeAssignment tags
Optional
Introduced in v4
CustomDataList
Additional information
One or more sets of information for site-specified data categories
Type: Zero or more CustomData tags
Optional
Introduced in v4
CustomDates
Person dates
One or more sets of date type information for site-specified date categories that
can be assigned to a person
Type: Zero or more CustomDate tags
Optional
Introduced in v4
EmailAddresses
E-mail addresses
Identity
Identity
One person, as specified in a PersonIdentity or CurrentUser tag.
Type: Either CurrentUser or PersonIdentity tag
Required
Must uniquely identify an existing and active employee
Contributes to Uniqueness: Yes
Introduced in v4
PersonAccessAssignments
Access assignment dates
The access assignments for the person for the specified time frames
Type: Zero or more PersonAccessAssignment tags
Optional
Introduced in v5.0
PersonAuthenticationTypes
Authentication Types
The list of one or more authentication types, and the status (either active or
inactive) for each type, for the current person. Only one authentication type
should be active at a given time for each person. The authentication types include
the following: Kronos, NT, LDAP, KRONOS_CUSTOM.
Type: Zero or more PersonAuthenticationType tags
Optional
Default Value: Kronos
Introduced in v5.1
PersonData
Person data
Basic name and employment information for a person
Type: Person tag
Optional
Required: When creating a new person
Introduced in v4
PersonLicenseTypes
Status of licenses
The licenses for a specific person.
Type: Zero or more PersonLicenseType tags
Optional
Introduced in v4; last changed in v5.1
PostalAddresses
Postal addresses
Postal addresses for the specified address types
Type: Zero or more PostalAddress tags
Optional
Introduced in v4
SupervisorData
Supervisor data
The person who is logically defined as this person's supervisor
Type: Supervisor tag
Optional
Introduced in v4; last changed in v5.0
Deprecated in v5.0: Use the JobAssignmentDetails tag to assign a supervisor.
TelephoneNumbers
Telephone numbers
The telephone numbers for the given telephone number types
Type: Zero or more TelephoneNumber tags
Optional
Introduced in v4
UserAccountStatusList
User account statuses
The user account statuses for the specified time frames
Type: Zero or more UserAccountStatus tags
Optional
Introduced in v4
PersonLeaveProfileAssignment Tag
Person Leave Profile Assignment
This is the XML API that is used to assign persons to a leave profile.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<PersonLeaveProfileAssignment
[ LeaveProfile = String ] >
<Person>
<PersonIdentity>
</Person>
</PersonLeaveProfileAssignment>
Action Descriptions
Add
Assigns a person to a leave profile.
Return Value Type: None
Required Properties: LeaveProfile (name), PersonIdentity
Access Control Point Name: Edit
Introduced in v5.1
Delete
Deletes a person's assignment to a leave profile.
Return Value Type: None
Required Properties: PersonIdentity
Property Descriptions
LeaveProfile
Leave Profile
The name of the leave profile. This property is required only for the Add action.
Type: String
Optional
Sample values: LeaveProfile ="demoProfile"
Introduced in v5.1
Person
Person
The person who is assigned a leave profile.
Type: PersonIdentity tag
Required
Introduced in v5.1
PersonLicenseType Tag
License that is Assigned to a Person
The PersonLicenseType tag contains information about the license assigned to a
person.
Used by: PersonInformation
Function Access Control Point: API.Person
Introduced in v4; last changed in v5.0
Syntax
Properties→
<PersonLicenseType
ActiveFlag = Boolean
LicenseTypeName = String />
Property Descriptions
ActiveFlag
Is the license active?
Specifies the state of the license. True if the license is active for the person.
Type: Boolean
Required
Only Allowed Values: True, False
Introduced in v4
LicenseTypeName
Type of license
The name or the Id of the license type.
There are nine valid licenses, but not all are assignable to employees
The following license types can be assigned to employees:
• 1 or Workforce_Timekeeper_Employee
• 2 or Workforce_Professional_ Employee
• 3 or Workforce_Manager
• 5 or Workforce_Activities
• 9 or Workforce_Scheduler
Dependency: Every person with an active or inactive Employment status or Name
of user account status must have a license type of
Workforce_Timekeeper_Employee, Workforce_Professional_ Employee, or
Workforce_Manager.
Type: String
Required
Maximum length: 2 characters
Specify @ to make no change to the existing license type.
Only Allowed Values: @, 1, 2, 3, 5, 9
Contributes to Uniqueness: Yes
Introduced in v4; last changed in v5.0
PersonShiftTemplateAssignment Tag
Shift Template Profile Assigned to Person
The PersonShiftTemplateAssignment tag associates a shift template profile with a
person.
Function Access Control Point: API.Schedule
Introduced in v5.1Beta; last changed in v5.0.a
Deprecated in v5.0.a: should use ShiftTempalteAssignment instead.
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
Load
Returns the name of the shift template for the specified employee.
Return Value Type: PersonShiftTemplateAssignment tag
Required Properties: Employee
Access Control Point Name: View
Introduced in v5.1Beta
Update
Assigns a specified shift template to a specified employee.
Taken together, the shift template and employee must be unique in the system.
Return Value Type: None
Required Properties: Employee, ShiftTemplateProfileName
Access Control Point Name: Edit
Introduced in v5.1Beta
Property Descriptions
Employee
Employee
One employee, as specified in a PersonIdentity tag
Type: PersonIdentity tag
Required
Must uniquely identify an existing and active employee
Contributes to Uniqueness: Yes
Introduced in v5.1Beta; last changed in v5.0.a
ShiftTemplateProfileName
Shift template profile name
The name of a shift code profile name
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1Beta
PersonSkillAssign Tag
Skills Assigned to Employees
The PersonSkillAssign tag assigns one or more skills to one or more employees
for a specific period of time.
Function Access Control Point: API.Schedule
Introduced in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
LoadAll
Returns all skill assignments for an employee.
Return Value Type: PersonSkillAssign tag
Required Properties: PersonNumber
Access Control Point Name: View
Introduced in v5.0
LoadSkillAssignments
Returns skill assignments for an employee for the specified timeframe.
Return Value Type: PersonSkillAssign tag
Required Properties: PersonNumber
Access Control Point Name: View
Introduced in v5.0
Update
Assigns skills to one or more employees.
Return Value Type: None
Required Properties: PersonSkillItems, Employees
Access Control Point Name: Edit
Introduced in v5.0
Property Descriptions
Employees
Employees
One or more people, as specified in one or more PersonIdentity tags. The skills
that are specified in PersonSkillItems are assigned to this list of people.
Type: Zero or more PersonIdentity tags
Optional
Each employee must have a WFS license.
Introduced in v5.0
Period
Time period
The span of time during which the skill assignments are in effect for the specified
employees.
Type: TimeFramePeriod tag
Optional
Introduced in v5.0
PersonNumber
Person number
The person number of a person about whom information is returned.
Type: String
Optional
Maximum length: 15 characters
Introduced in v5.0
PersonSkillItems
Skill items assigned to employees
The skill items that are assigned to the employees specified in Employees.
Type: Zero or more PersonSkillItem tags
Optional
Introduced in v5.0
PersonSkillItem Tag
Skill that can be Assigned
The PersonSkillItem tag contains a skill that can be assigned to one or more
employees.
Used by: PersonSkillAssign
Function Access Control Point: API.Schedule
Introduced in v5.0
Syntax
Properties→
<PersonSkillItem
[ EffectiveDate = Date ]
( ExpirationDate = Date )
[ IsActive = Boolean ]
Name = String />
Property Descriptions
EffectiveDate
Effective date
The date when the skill becomes available for assignment
Type: Date
Optional
Introduced in v5.0
ExpirationDate
Expiration date
The date when the skill will no longer be available for assignment
Type: Date
Output only
Introduced in v5.0
IsActive
Is the skill active?
Specifies whether the skill is active
Type: Boolean
Optional
Only Allowed Values: True, False
Introduced in v5.0
Name
Skill name
The name of a skill
Type: String
Required
Maximum length: 40 characters
You can see the list of existing skills in the user interface.
Introduced in v5.0
PostalAddress Tag
Postal Address
The PostalAddress tag specifies address elements for a specified address type.
Used by: PersonInformation
Function Access Control Point: API.Person
Introduced in v4; last changed in v5.0
Syntax
Properties→
<PostalAddress
[ City = String ]
ContactTypeName = String
[ Country = String ]
[ PostalCode = String ]
[ State = String ]
[ Street = String ] />
Property Descriptions
City
City
The city or town portion of the person's address
Type: String
Optional
Maximum length: 25 characters
Introduced in v4
ContactTypeName
Category of the contact
The name of the contact category
Type: String
Required
Optional
Maximum length: 100 characters
Introduced in v4
PreferenceProfile Tag
Display Profile
The PreferenceProfile tag provides information about valid Preference Profiles
defined within the WTK system. The display profile determines the information
that the system displays to a user (for example, the Workforce Genies that appear
on the navigation bar).
Function Access Control Point: API.Employee
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<PreferenceProfile
[ PreferenceProfileId = Integer ]
PreferenceProfileName = String />
Action Descriptions
Load
Returns a preference profile, based on PreferenceProfileName.
Name should be valid
Return Value Type: PreferenceProfile tag
Required Properties: PreferenceProfileName
Access Control Point Name: View
Introduced in v4; last changed in v5.1
LoadAllPreferenceProfiles
Returns all preference profiles in the system.
Property Descriptions
PreferenceProfileId
Id of display profile
Uniquely identifies the preference profile in the database
Type: Integer
Optional
Introduced in v4
PreferenceProfileName
Display profile name
The name for the common set of display preferences applying to a group of users.
For example, Tuesday Manager. It includes the time formats and the Genie profile
for managers.
Type: String
Required
Introduced in v4
PrimaryLaborAccount Tag
Primary Labor Account
The PrimaryLaborAccount tag identifies the labor account and primary
organization job for a person's job assignment within a range of dates. If
organizational maps are in use, the primary account is comprised of a primary job
and a primary labor account. For those whose organizations do not use jobs, the
primary account is comprised solely of a primary labor account.
Used by: JobAssignment
Function Access Control Point: API.Person
Introduced in v5.0; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "LoadPrimaryLaborAccounts"
Properties→
<PrimaryLaborAccount
[ EffectiveDate = Date ]
[ ExpirationDate = Date ]
[ LaborAccountName = String ]
[ OrganizationPath = String ] >
[ <Identity>
<CurrentUser> | <PersonIdentity>
</Identity> ]
[ <Period>
<TimeFramePeriod>
</Period> ]
</PrimaryLaborAccount>
Action Descriptions
LoadPrimaryLaborAccounts
Loads information associated with the primary labor account for a specified
person over a specified period. If the period is not specified, the current date
through January 1, 3000 is used.
The Identity and Period information associated with the request is added to the
item in the list.
If no data is found, just the Identity and Period properties are returned.
Return Value Type: Zero or more PrimaryLaborAccount tags
Required Properties: Identity
Optional Properties: Period
Access Control Point Name: View
Introduced in v5.0
Property Descriptions
EffectiveDate
Effective date
The date when the primary labor account becomes effective
Type: Date
Optional
Must occur before the expiration date
Default Value: Current date
Introduced in v5.0
ExpirationDate
Expiration date
The date when the primary labor account expires
Type: Date
Optional
Must occur after the effective date
Default Value: January 1, 3000
Introduced in v5.0
Identity
Identity
One person, as specified in a PersonIdentity or CurrentUser tag.
Type: Either CurrentUser or PersonIdentity tag
Optional
Must uniquely identify a person
Contributes to Uniqueness: Yes
Introduced in v5.0
LaborAccountName
Labor account
The name of the employeeís primary labor account.
Type: String
Optional
Maximum length: 356 characters
Required for an employeeís primary labor account name.
You can find values in the Workforce Timekeeper user interface.
Sample values: The following is an example of a primary account name
(depending on how labor levels and accounts are defined in your system): 112/
222/332/401/501/601/701. You can use shorthand for the primary labor account in
any labor account entry if you are also importing an organizational path.
Introduced in v5.0
OrganizationPath
Primary job in the organization
The primary job information.
Dependency: This value is required only to import a Workforce Scheduler
Employee.
Enter values in the same format as they appear in the database. String matching is
case-sensitive on a Workforce Central server that connects to an Oracle database.
Note: The labor level entries within a labor account cannot overlap with the
organization-derived account. For example, in the labor account: 101//////701, the
entry 101 overlaps with Organization in the organization-derived account
Organization/Hospitals/Hosp A/Floor 1/ER/RN2.
The combining of an imported labor account and an organizational job path-
derived account must result in a fully qualified labor account. For example, the
labor account /////// and organization-derived account Organization/Hospitals/
Hosp A/Floor 1/ER/RN2 cannot result in a fully qualified labor account, because
the organization-derived account has only six labor level entries, not seven labor
level entries.
Type: String
Optional
Maximum length: 1000 characters
When shorthand notation is used, the person's current primary account must have
a primary organization assigned.
Required: For any person who has a scheduler license
Introduced in v5.0
Period
Time period
The period of time associated with the primary account
Type: TimeFramePeriod tag
Optional
Identity is used if a person is required in association with the time frame.
Used for the LoadPrimaryLaborAccounts action
Default Value: From the current date until January 1, 3000
Introduced in v5.0
Process Tag
Process
The Process tag specifies a process that resulted from a specific process template.
Function Access Control Point: com.kronows.wf.business.workflow.Kprocess
Introduced in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddWithWebForm" |
"DeleteOnly" |
"Retrieve" |
"UpdateOnly"
Parameters→
ResourceId = String
Properties→
<Process
AdminTemplateId = Integer
[ KProcessUniqueKey = String ]
ProcessId = Integer
ProcessName = String
ProcessState = String
ProcessStateCode = Integer >
[ <ProcessAttributes>
<Attribute>∗
</ProcessAttributes> ]
</Process>
Action Descriptions
Add
This action initiates or starts a process and supports the initialization of process
attributes. It does not add new process attributes, but can initialize existing
process attribute values. Any process attribute that has an attribute type of
"Object" or "java.lang.Object" cannot be updated or initialized. The ResourceID
is equivalent to the WTK Person Number or Person Id value. The ResourceId
must match the WFC person number, and it is important to note that trailing
blanks are significant and should not be included.
AdminTemplateId must be greater than 0. ResourceId must be greater than 1
character and less than or equal to 30 characters.
Return Value Type: Process tag
Required Properties: One of AdminTemplateId or KProcessUniqueKey is
required. ResourceId is a required action parameter.
Optional Properties: ProcessAttributes
Access Control Point Name: Edit
Introduced in v5.1
Action Parameters
AddWithWebForm
This action initiates or starts a process and supports the initialization of the
process attributes. This action initiates a process that contains a web form,
supports the initialization of process attributes, and returns the first task which
contains the web form. New process attributes cannot be added through this
action, but existing process attribute values can be initialized. Any process
attribute that has an attribute type of "Object" or "java.lang.Object" cannot be
updated or initialized. The ResourceID is equivalent to the WTK Person Number
or Person Id value. The ResourceId must match the WFC person number, and it is
important to note that trailing blanks are significant and should not be included.
AdminTemplateId must be greater than 0. ResourceId must be greater than 1
character and less than or equal to 30 characters.
Return Value Type: ProcessTask tag
Required Properties: One of AdminTemplateId or KProcessUniqueKey is
required. ResourceId is a required action parameter.
Optional Properties: ProcessAttributes
Access Control Point Name: Edit
Introduced in v5.1
Action Parameters
DeleteOnly
The DeleteOnly method deletes a single process specified by the process id.
The ProcessId must be greater than 0.
Property Descriptions
AdminTemplateId
Administrator Template Id
The identifier for the process template from which the process was created, used
for administration purposes.
Type: Integer
Required
The AdminTemplateId is a required property on the Process. The
AdminTemplateId must not be null and must be greater than 0. The
AdminTemplateId is an optional property on the Process Add and
AddWithWebForm actions.
Sample values: 559
Introduced in v5.1
KProcessUniqueKey
Process unique key
The exposed private_PMUniqueKey that can be used to instantiate or start a
process.
Type: String
Optional
KProcessUniqueKey must be 1 or more characters long.
Sample values: 95c73c96947cdca4:52fecf:101437b4fc1:-7ffd
Introduced in v5.1
ProcessAttributes
Process attributes
One or more process attributes. Each process attribute contains a name and a
value.
Type: Zero or more Attribute tags
Optional
Each Attribute within a Process Attributes list must contain a Name property and
Value property pair. The Name must be greater than 1 character. The Name has
maximum length of 255 characters.
ProcessProfile Tag
Process Profile
The ProcessProfile tag loads the specific information for one or more process
profiles.
For the Load Action, the ProcessProfileName MUST be specified. For the
LoadById Action, the ProcessProfileId property MUST be specified.
Function Access Control Point: API.WorkflowProfile
Introduced in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<ProcessProfile
ProcessProfileId = Long
[ ProcessProfileName = String ] />
Action Descriptions
Load
Loads the process profile from the database given the ProcessProfileName
property. An example of the ProcessProfileName may be "All Process
Templates".
The ProcessProfileName must already exist in the database, prior to calling the
Load action.
Return Value Type: WorkflowProfile tag
Required Properties: ProcessProfileName
Access Control Point Name: View
Introduced in v5.0
LoadAllProcessProfiles
Loads all process profiles in the database, returning a list of
APIWorkflowProfileBeans.
Return Value Type: Zero or more WorkflowProfile tags
Required Properties: None
Access Control Point Name: View
Introduced in v5.0
LoadById
Loads the Process Profile from the database given the ProcessProfileId property.
The ProcessProfileId which uniquely identifies a process profile must already
exist in the database, prior to calling the LoadById action.
Return Value Type: WorkflowProfile tag
Required Properties: ProcessProfileId
Access Control Point Name: View
Introduced in v5.0
Property Descriptions
ProcessProfileId
Process Profile Id
The Id of a specific process profile, which identifies a unique process profile.
Type: Long
Required
Contributes to Uniqueness: Yes
Introduced in v5.0
ProcessProfileName
Process Profile name
The Name of the Process Profile. The ProcessProfileName property MUST be
specified for the Load action.
Type: String
Optional
For the Load action, the ProcessProfileName property MUST be specified. The
ProcessProfileName must already exist in the database, prior to calling the Load
action.
Sample values: ProcessProfileName="All Process Templates"
Introduced in v5.0
ProcessSchedule Tag
Process Schedule
The ProcessSchedule tag is used to modify an existing employee schedule in
addition to what is already scheduled. With the ProcessSchedule tag, you can
swap shifts between employees or assign a new employee to cover a scheduled
shift for another employee.
Function Access Control Point: API.Schedule
Introduced in v5.0; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<ProcessSchedule
[ CheckRules = Boolean ]
QueryDateSpan = DateSpan
[ SaveData = Boolean ] >
<Employees>
<CurrentUser>∗
<PersonIdentity>∗
</Employees>
[ <ScheduleItems>
<ScheduleAccrualAmountEdit>∗
<ScheduleOff>∗
<SchedulePayCodeEdit>∗
<ScheduleShift>∗
<ScheduleShiftSwap>∗
<ScheduleUnavailable>∗
</ScheduleItems> ]
</ProcessSchedule>
Action Descriptions
CoverShift
Assign an employee to cover a shift for another employee, as specified by a
ScheduleShiftSwap tag in the ScheduleItems property.
The Employees list must contain exactly two employees. These must be the same
employees as those identified in the ScheduleShiftSwap tag.
The ScheduleItems list must contain exactly two shifts.
Return Value Type: Zero or more RuleViolation tags
Required Properties: Employees, QueryDateSpan, ScheduleItems
Optional Properties: SaveData, CheckRules
Access Control Point Name: Edit
Introduced in v5.0; last changed in v5.1
SwapShifts
Swap the employee assignments for the two specified shifts, as identified by
ScheduleShiftSwap tags in the ScheduleItems property.
The Employees list must contain exactly two employees. These must be the same
employees as those identified in the ScheduleShiftSwap tag.
The ScheduleItems list must contain exactly two shifts.
Return Value Type: Zero or more RuleViolation tags
Required Properties: Employees, QueryDateSpan, ScheduleItems
Optional Properties: SaveData, CheckRules
Access Control Point Name: Edit
Introduced in v5.0
Property Descriptions
CheckRules
Validate modified schedule?
Iindicates whether schedule validation will take place on the modified schedule
from an action
Type: Boolean
Optional
SaveData and CheckRules cannot both be false.
If CheckRules is True, any rule violations from employees or jobs that are
affected by the action are returned by the action. If it is False, then null is returned.
Default Value: False
Introduced in v5.0
Employees
Employees
One or more employees for whom the action will be processed, as specified in one
or more PersonIdentity or CurrentUser tags.
Type: Any combination of CurrentUser or PersonIdentity tags
Required
Contributes to Uniqueness: Yes
Introduced in v5.0
QueryDateSpan
Span of dates
The span of dates that are used
Type: DateSpan
Required
The span must fully encompass the dates of any shift that is specified in
ScheduleItems.
Contributes to Uniqueness: Yes
Introduced in v5.0
SaveData
Save the modified schedule?
SaveData indicates whether the schedule, modified by an action, will be saved.
Type: Boolean
Optional
ProcessTask Tag
Process Task
The ProcessTask tag relates a task within a process or worklow. A process task has
state and attribute values that can be retrieved and updated.
Function Access Control Point:
com.kronos.wfc.business.workflow.KProcessTask
Introduced in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveAllByProcessId" |
"RetrieveAllByResourceId" |
"UpdateOnly"
Parameters→
[ CategoryName = String ]
Properties→
<ProcessTask
EndDate = Date
[ Locations = String ]
[ PrevLocations = String ]
ProcessId = Integer
[ ProcessName = String ]
[ ResourceId = String ]
[ ResourceName = String ]
StartDate = Date
TaskId = Integer
TaskName = String
TaskState = String
TaskStateCode = Integer
[ TaskURL = String ] >
[ <TaskAttributes>
<Attribute>∗
</TaskAttributes> ]
</ProcessTask>
Action Descriptions
Retrieve
The Retrieve action returns the ProcessTask specified by the TaskId.
Return Value Type: ProcessTask tag
Required Properties: TaskId
Access Control Point Name: View
Introduced in v5.0.a
RetrieveAllByProcessId
This action returns a list of tasks for a given process. By specifying the ProcessId,
TaskStateCode, and ResourceId, you can retrieve a list of tasks by process id, or
by process id and task state, or by process id, task state and resource id, or by
process id and resource id. The ResourceID is equivalent to the WTK Person
Number or Person Id value. The ResourceId must match the WFC person number,
and it is important to note that trailing blanks are significant and should not be
included.
Return Value Type: Zero or more ProcessTask tags
Required Properties: ProcessId
Optional Properties: TaskStateCode, ResourceId
Access Control Point Name: View
Introduced in v5.1
RetrieveAllByResourceId
This action returns a list of tasks for a given process. By specifying the
ResourceId, TaskStateCode, CategoryName, you can retrieve a list of process
tasks by resource, or by resource id and task state, or by resource id, task state, and
category name, or by resource id and by category name. If you specify an active
task state with a TaskStateCode of 1, a list of all active tasks that are assiged to the
specified resource for all processes is returned. If you specify a CategoryName
and a specific ResourceId, a list of all tasks assigned to that resource and also
correspond to a process template that belong to the specified category will be
returned. If you specify an TaskStateCode of 1, a CategoryName, and a
ResourceId, a list of all active tasks assigned to the specified resource that
correspond to a process template that belongs to the specified CategoryName are
returned. The ResourceID is equivalent to the WTK Person Number or Person Id
value. The ResourceId must match the WFC person number, and it is important to
note that trailing blanks are significant and should not be included.
Return Value Type: Zero or more ProcessTask tags
Required Properties: ResourceId
Optional Properties: CategoryName - optional action parameter, TaskStateCode -
optional property
Access Control Point Name: View
Introduced in v5.1
Action Parameters
UpdateOnly
This action updates a specific task within a process by updating the task state and
task attributes. You cannot add any new task attributes. However, process task
attribute values can be updated. Any task attribute that has an attribute type of
"Object" or "java.lang.Object" cannot be updated or initialized.
Return Value Type: ProcessTask tag
Required Properties: TaskId
Property Descriptions
EndDate
End date
The date on which the process task ends
Type: Date
Required
EndDate is a required property on the ProcessTask. The EndDate must not be null
and must be a valid Date.
Introduced in v5.1
Locations
List of active tasks
A comma separated list of active tasks that indicate where you are in the process.
Type: String
Optional
Locations is an optional property on the ProcessTask.
Introduced in v5.1
PrevLocations
List of resources assigned to previous tasks
A comma separated list of resources assigned to one or more previous tasks. If a
resource name is not available, you can specify the resource identifier instead. If
the previous tasks have no assigned resources, an empty string is returned. This
can occur with synch tasks.
Type: String
Optional
Introduced in v5.1
ProcessId
Process identifier
The identifier of the process to which this process task belongs.
Type: Integer
Required
Must be greater than zero.
Sample values: 583
Introduced in v5.1
ProcessName
Process name
The name of the process to which this process task belongs.
Type: String
Optional
Maximum length: 50 characters and MinimumLength: 1 character
Sample values: EmployeeAward
Introduced in v5.1
ResourceId
Resource or person Id who owns the task
The identifier of the resource or person who owns the process task. The
ResourceID is equivalent to the WTK Person Number or Person Id value. The
ResourceId must match the WFC person number, and it is important to note that
trailing blanks are significant and should not be included.
Type: String
Optional
Maximum length: 30 characters
Sample values: 203
Introduced in v5.1
ResourceName
Resource or person who owns the task
The name of the resource or person who owns the process task
Type: String
Optional
Maximum length: 64 characters
Minimum length: 1 character
Sample values: Fryman, Christy
Introduced in v5.1
StartDate
Start date
The date the process task starts
Type: Date
Required
StartDate is a required property on the ProcessTask. The StartDate must not be
null and must be a valid Date.
Introduced in v5.1
TaskAttributes
Task attributes
One or more Attribute tags that identify who belongs to the process task. Each
TaskAttribute has a name and value pair.
Type: Zero or more Attribute tags
Optional
TaskAttributes list is an optional property on the ProcessTask and an optional
property on ProcessTask UpdateOnly action. For each task attribute specified, the
task attribute Name cannot be null and must be > 1 char and <= 255 chars in
length.
Sample values: <TaskAttributes>
<Attribute Name="roleAttribute" Value="${employee}.manager></Attribute>
</TaskAttributes>
Introduced in v5.1
TaskId
Task identifier
The identifier of the process task.
Type: Integer
Required
Must be greater than zero.
Sample values: 685
Contributes to Uniqueness: Yes
Introduced in v5.1
TaskName
Task name
The name of the process task
Type: String
Required
The TaskName is a required property on the ProcessTask. The TaskName must
not be null and must be greater than 1 character and less than 50 characters in
length.
Sample values: Approval Form
Introduced in v5.1
TaskState
Task state
The state of the process task
Type: String
Required
If specified, the TaskState must be one of the valid task states.
Sample values: "Ready","Active","Complete","Failed","Passive"
Introduced in v5.1
TaskStateCode
Task state code
The integer value representing the Process Task state.
Type: Integer
Required
0 for Ready task state, 1 for Active task state, 2 for Complete task state, 3 for
Failed task state, 4 for Passive task state
Only Allowed Values: 0, 1, 2, 3, 4
Introduced in v5.1
TaskURL
TaskURL
The url of the web task in a process
Type: String
Optional
Introduced in v5.1
ProcessTemplate Tag
Process Template
The ProcessTemplate tag represents the template for a process. A process template
can belong to one or more categories. A process template can be used to create a
process.
Function Access Control Point:
com.kronos.wfc.business.workflow.KProcessTemplate
Introduced in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Actions→
"Add" |
"DeleteOnly" |
"Retrieve" |
"RetrieveAll" |
"RetrieveAllByCategory" |
"RetrieveAllByResourceId" |
"RetrieveAllForEmployee" |
"RetrieveAllForManager" |
"RetrieveByDisplayName" |
"RetrieveByUniqueKey" |
"UpdateOnly"
Parameters→
[ CategoryName = String ]
GetHiddenActions = Boolean
[ IncludeTemplateData = Boolean ]
ResourceId = String
Properties→
<ProcessTemplate
ActionListSwitch = Integer
ActiveSwitch = Integer
AdminTemplateId = Long
AdminTemplateName = String
[ CategoryNames = String ]
[ CommentText = String ]
DisplayName = String
EffectiveDate = DateTime
ExpirationDate = DateTime
[ KProcessUniqueKey = String ]
[ MaxPoolSize = Integer ]
TemplateData = String
TemplateId = Long
[ UsedBy = String ]
Version = Integer />
Action Descriptions
Add
This action adds a new Process Template using the specified TemplateData.
Return Value Type: ProcessTemplate tag
Required Properties: DisplayName, EffectiveDate, ExpirationDate, TemplateData
Optional Properties: ActiveSwitch, ActionListSwitch, CommentText,
MaxPoolSize, CategoryNames
Access Control Point Name: Edit
Introduced in v5.1
DeleteOnly
This action deletes a process template specified by the AdminTemplateId.
Return Value Type: None
Required Properties: AdminTemplateId
Access Control Point Name: Edit
Introduced in v5.1
Retrieve
This action returns the process template for the specified template identifier.
The AdminTemplateId must be greater than 0.
RetrieveAllByResourceId
This method returns a combined list of all the process templates tha a specific
manager and employee can instantiate. This method gets a list of all actions from
the Employee and Manager Action lists, for the specified resource. The
GetHiddenActions parameter can be set to "true" or "false". If the
GetHiddenActions is set to "true", the process templates who's ActionListSwitch
is set to 0, will be returned along with those who's values is 1. If the
GetHiddenActions action parameter is set to "false", only process templates with
an ActionListSwitch set to 1 will be returned. The IncludeTemplateData action
parameter may be "true" or "false". If the IncludeTemplateData action parameter
is set to "true", the TemplateData property will be displayed for every process
template returned in the XML Response. If the IncludeTemplateData action
parameter is set to "false", the TemplateData property will not be displayed within
each process template returned within the XML Response. By default, the
IncludeTemplateData action parameter is set to "false". If you do not specify the
IncludeTemplateData action parameter, the value for for IncludeTemplateData
will be set to "false". Therefore, the TemplateData property will not be displayed
for each returned process template. The ResourceID is equivalent to the WTK
Person Number or Person Id value. The ResourceId must match the WFC person
number, and it is important to note that trailing blanks are significant and should
not be included.
The ResourceId, IncludeTemplateData are required parameters. The ResourceId
must be > 1 char & <= 30 chars in length. The GetHiddenActions action
parameter and the IncludeTemplateData action parameter can only be set to either
"true" or "false".
Return Value Type: Zero or more ProcessTemplate tags
Required Properties: ResourceId, GetHiddenActions - required action parameters
Optional Properties: IncludeTemplateData - optional action parameter
Access Control Point Name: View
Introduced in v5.1
Action Parameters
RetrieveAllForEmployee
This method returns a list of process templates that employees can instantiate. If
you do not specify the CategoryName, you will retrieve all process templates, that
a manager, specified by resourceId, can instantiate. If you specify a
CategoryName, you will get all process templates that belong to specific category,
specified by the given category name, that the specified manager can instantiate.
If the GetHiddenActions is set to "true", the process templates who's
ActionListSwitch is set to 0, will be returned along with those who's values is 1.
The IncludeTemplateData action parameter may be "true" or "false". If the
IncludeTemplateData action parameter is set to "true", the TemplateData property
will be displayed for every process template returned in the XML Response. If the
IncludeTemplateData action parameter is set to "false", the TemplateData
property will not be displayed within each process template returned within the
XML Response. By default, the IncludeTemplateData action parameter is set to
"false". If you do not specify the IncludeTemplateData action parameter, the
IncludeTemplateData will be set to "false" by default, and the TemplateData
property will not be displayed for each returned process template. The
ResourceID is equivalent to the WTK Person Number or Person Id value. The
ResourceId must match the WFC person number, and it is important to note that
trailing blanks are significant and should not be included.
Action Parameters
RetrieveAllForManager
This method returns a list of process templates that managers can instantiate. The
CategoryName is an optional action parameter. If you do not specify the
CategoryName, you will retrieve all process templates, that a manager, specified
by resourceId, can instantiate. If you specify a CategoryName, you will get all
process templates that belong to specific category, specified by the given category
name, that the specified manager can instantiate. If the GetHiddenActions is set to
"true", the process templates who's ActionListSwitch is set to 0, will be returned
along with those who's values is 1. The IncludeTemplateData action parameter
may be "true" or "false". If the IncludeTemplateData action parameter is set to
"true", the TemplateData property will be displayed for every process template
returned in the XML Response. If the IncludeTemplateData is set to "false", the
TemplateData property will not be displayed within each process template
returned within the XML Response. By default, the IncludeTemplateData action
parameter is set to "false". If the IncludeTemplateData action parameter is not
specified, the default value is set to "false", therefore the TemplateData property
will not be displayed for each returned process template. The ResourceID is
equivalent to the WTK Person Number or Person Id value. The ResourceId must
match the WFC person number, and it is important to note that trailing blanks are
significant and should not be included.
The ResourceId, GetHiddenActions are required parameters. The ResourceId
must be > 1 char & <= 30 chars in length. CategoryName, if given, must be > 1
char & <= 50 chars in length. GetHiddenActions can only be "true" or "false".
Return Value Type: Zero or more ProcessTemplate tags
Required Properties: ResourceId, GetHiddenActions - required action parameters
Optional Properties: CategoryName, IncludeTemplateData - optional action
parameters
Access Control Point Name: View
Introduced in v5.1
Action Parameters
RetrieveByDisplayName
This method returns a process template by specifying the process template display
name. The RetrieveByDisplayName action takes one required action parameter
called IncludeTemplateData, which can either be set to "true" or "false". If the
IncludeTemplateData action parameter is set to "true", the TemplateData property
will be displayed within the XML Response of the returned process template. If
the IncludeTemplateData action parameter is set to "false", the TemplateData
property will not be displayed within the returned process template as part of the
XML Response. By default, the IncludeTemplateData action parameter is set to
"false". If you do not specify the IncludeTemplateData action parameter, the
IncludeTemplateData is set to "false" and the TemplateData property will not be
displayed for each returned process template.
The DisplayName is a required property and must be greater than 1 character and
<= 50 characters in length. The IncludeTemplateData is an optional action
RetrieveByUniqueKey
This method returns a process template by specifying the Kronos Process Unique
Key. The action RetrieveByUniqueKey takes one action parameter called
IncludeTemplateData, which can either be set to "true" or "false". If the
IncludeTemplateData action parameter is set to "true", the TemplateData property
will be displayed within the returned process template within the XML Response.
If the IncludeTemplateData action parameter is set to "false", the TemplateData
property will not be displayed within the returned process template in the returned
XML Response. By default, the IncludeTemplateData action parameter is set to
"false". If you do not specify the IncludeTemplateData action parameter, the
UpdateOnly
This method updates a process template. The following ProcessTemplate
properties cannot be updated through this method: the TemplateId,
AdminTemplateId, AdminTemplateName, Version, UsedBy,
KProcessUniqueKey, and TemplateData properties. All other properties of the
Action Parameters
Property Descriptions
ActionListSwitch
Is the process visible in the action list?
The ActionListSwitch indicates whether this process is visible in the action list.
Type: Integer
Required
Only Allowed Values: 0, 1
Default Value: 1
Introduced in v5.1
ActiveSwitch
Is the process active?
The ActiveSwitch indicates whether this process is active.
Type: Integer
Required
Type: DateTime
Required
Must be a valid KDateTime
Sample values: 01/01/3000 00:00:00
Introduced in v5.1
KProcessUniqueKey
App. Unique Key
The exposed unique ID for the template, the private Kronos Unique Key. This ID
is created when you create a new process template in the Process Designer. You
can use this value to start a process.
Type: String
Optional
Maximun length: 255 characters
Introduced in v5.1
MaxPoolSize
Max processes in pool
The maximum number of processes that can be in a pool.
Type: Integer
Optional
Must be equal to or greater than zero. The MaxPoolSize cannot be greater than the
WFC System Settings Business Automation value for
"wba.processengine.server.maxpoolsize".
Default Value: 0
Introduced in v5.1
TemplateData
Template XML
A based-64 encoded string that represents the process template XML.
Type: String
Required
Punch Tag
Punch
The Punch tag adds a punch or a comment, deletes a punch, or removes the work
rule transfer from an existing punch,
Function Access Control Point: API.Timecard
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Actions→
"AddComment" |
"AddOnly" |
"Delete" |
"RemoveWorkRule"
Parameters→
[ AccrualOverride = Boolean ]
[ allowAdHoc = Boolean ]
[ EchoData = Boolean ]
Properties→
<Punch
[ CancelDeductRuleName = String ]
[ CommentText = String ]
[ Date = Date ]
[ DaylightSavingsFlag = Boolean ]
( EnteredOnDate = Date )
( EnteredOnTime = Time )
[ KronosTimeZone = String ]
[ LaborAccountName = String ]
[ ManagerName = String ]
OrgJobId = String
OrgJobName = String
[ OverrideTypeName = String ]
[ Time = Time ]
[ WorkRuleName = String ] >
( <Comments>
<Comment>∗
</Comments> )
<Employee>
<CurrentUser> | <PersonIdentity>
</Employee>
</Punch>
Action Descriptions
AddComment
Adds a comment to an existing punch.
Depending on the type of punch, you may need to specify one of the following
properties:
<ul>
<li>LaborAccountName
<li>WorkRuleName
<li>OverrideTypeName
<li>KronosTimeZone
</ul>
Return Value Type: None
Required Properties: CommentText, Date, Employee, Time
Access Control Point Name: Edit
Introduced in v4
AddOnly
Adds a new punch for an employee.
If no date or time are specified, this action uses a timestamp; a new punch is
created with the current system date and time, with the time adjusted for the
employee's default time zone.
If one of date or time is specified, the other must also be specified.
An employee can have at most one punch for a given date and time.
A punch cannot be added if the date and time precedes or exactly equals the
employee's Manager Signoff Date.
Return Value Type: Punch tag
Required Properties: Employee
Optional Properties: Date, Time
Access Control Point Name: Edit
Introduced in v4
Action Parameters
Delete
Marks an existing punch for deletion.
Return Value Type: None
Required Properties: Date, Employee, Time
Access Control Point Name: Edit
Introduced in v4
RemoveWorkRule
Removes the work rule transfer from an existing punch.
Return Value Type: Punch tag
Property Descriptions
CancelDeductRuleName
Deduct rule for cancelation override
Specifies the deduct rule to be used
Type: String
Optional
Cancel deduction rules can be found in the user interface. Either select one of
these, or type 'All' to cancel all deductions for the day.
Introduced in v4
Comments
Comments
The set of comments that are returned with this timekeeping item
Type: Zero or more Comment tags
Output Only
Introduced in v4
CommentText
Comment text
Use comment text to provide details about the punch.
It contains a comment string that is attached to the punch.
Type: String
Optional
Maximum length: 254 characters
Must match exactly an applicable comment that already exists in the database.
The string matching is case-sensitive.
You can find values in the Workforce Timekeeper Setup Application.
Introduced in v4
Date
Date of punch
Date contains one of the following entries:
• The date of a punch that is being added or deleted
• The date of a punch for which you are adding a comment
• The date of a punch for which the work rule is being cleared
If you are clearing a work rule transfer, use a different combined Date and Time
than was used for the work rule transfer. If you erroneously put in a work rule
transfer, delete the punch to clear it.
Type: Date
Optional
Dependency: If Date is specified, Time must also be specified.
Contributes to Uniqueness: Yes
Introduced in v4; last changed in v5.0
DaylightSavingsFlag
Is daylight-saving time in effect?
True if daylight saving time is in effect for the specified time zone.
Type: Boolean
Optional
Ignored if the time zone does not support Daylight Savings Time
Only Allowed Values: True, False
If the KronosTimeZone was specified when a punch was added, it must also be
used to perform another action such as delete, clear, or add a comment.
Type: String
Optional
Maximum length: 30 characters
For a list of values, see ìTime Zone Definitionsî in Appendix B in the Workforce
Timekeeper DTK Reference Guide.
Default Value: Time zone at the employee's server
Sample values: 13011, Eastern
Introduced in v4
LaborAccountName
Labor account name
The name of the labor account that is associated with the punch. This is optional
when adding a punch. It need not be specified if the punch applies to the
employee's primary account.
To specify a labor account name, enter it in the same format as it appears in the
database. For example, if you have a seven-level labor account in the Workforce
Timekeeper configuration, specify a value for each labor level, using the
following format: 101/202/303/404/504/603/702.
You can omit any labor levels that are not changing; for example, you can enter
the value 101//303////, indicating that only the first and third labor level entries are
different. If any of the labor levels should be the same as the employeeís primary
labor account, specify @H for those labor levels.
If your Workforce Timekeeper system is set up to allow you to create ad hoc labor
level entries when adding a punch, you can create the ad hoc entries when
specifying the labor account.
Type: String
Optional
Maximum length: 356 characters.
You can find values in the Workforce Timekeeper user interface.
Introduced in v4
ManagerName
Manager name
The name to replace the user name in audit.
Type: String
Optional
Maximum length: 70 characters
Introduced in v5.0.a
OrgJobId
ID of job in organization
A unique identifier for a job in the organization
Type: String
See group( OrgJob)
You must have Functional Access for Job Transfers. A node with this Id must
exist in the organizational structure
Default Value: Null
Introduced in v5.0
OrgJobName
Job in the organization
The primary organizational job information for the employee. You can optionally
specify OrgJobName or OrgJobId. You can leave this column blank if the punch
applies to the employee's primary organizational job.
Enter data for OrgJobName in the same format as it appears in the database. The
OrgJobName string matching is case-sensitive on a Workforce Central server that
connects to an Oracle database.
Type: String
See group( OrgJob)
Maximum length: 1000 characters
You must have Functional Access for Job Transfers. A node with this Id must
exist in the organizational structure
Default Value: Null
Introduced in v5.0
OverrideTypeName
Type of override
The type of override
Type: String
Optional
Maximum length: 30 characters
Only Allowed Values: In Punch, Out Punch, New Shift, or an associated Break
Rule name as defined in the Workforce Timekeeper Setup
Introduced in v4
Time
Time
Time contains one of the following items:
• The time when the punch is added or deleted
• The time when you are adding a comment for the punch
• The time of the punch for which the work rule is being cleared
If you add a punch with a work rule other than the employee's default work rule,
the work rule behaves like a transfer work rule. To change the work rule, delete
the punch; then add it and specify the new work rule.
Type: Time
Optional
The combination of Date and Time must be unique for all non-deleted punches for
an employee.
Dependency: If Date is specified, Time must also be specified.
Contributes to Uniqueness: Yes
Introduced in v4
WorkRuleName
Work rule
This is the work rule associated with the punch. A work rule applies a different set
of pay rules to the employeeís time. The application of these rules determines how
employee hours are calculated.
Dependency: Enter this value only when a work rule other than the employeeís
usual work rule is to be used.
Workforce provides the following predefined data values:
• &ALL_WORK_RULES
• &EMPTY
Type: String
Optional
Maximum length: 50 characters
You can find values in the Workforce Timekeeper Application Setup.
Sample values: Salaried, Part Time
Introduced in v4
PunchStatus Tag
Punch Status
The PunchStatus tag checks the employee's punch in/punch out status. It returns
punch-in time and labor account transfer, if the employee has punched in.
Function Access Control Point: API.Timecard
Introduced in v5.0; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "CheckStatus"
Properties→
<PunchStatus
[ DaylightSavingsFlag = Boolean ]
[ KronosTimeZone = Integer ]
[ Time = DateTime ] >
<Employee>
<PersonIdentity>
</Employee>
( <LaborAccountName>
<LaborAccount>
</LaborAccountName> )
</PunchStatus>
Action Descriptions
CheckStatus
Returns the status (In or Out) of the punch.
Return Value Type: PunchStatus tag
Required Properties: Employee
Access Control Point Name: View
Introduced in v5.0; last changed in v5.1
Property Descriptions
DaylightSavingsFlag
Is daylight-saving time in effect?
Whether daylight saving time is in effect for the specified date and time. When
returning within status, it is the daylight saving time associated with the punch.
Type: Boolean
Optional
Only Allowed Values: True, False
Default Value: False
Introduced in v5.0
Employee
Employee
One employee, as specified in a PersonIdentity tag.
Type: PersonIdentity tag
Required
Must uniquely identify an existing and active employee
Introduced in v5.0
KronosTimeZone
Time zone
The timezone associated with the date and time. When returning within status, it is
the timezone of the punch.
Type: Integer
Optional
For a list of values, see ìTime Zone Definitionsî in Appendix B in the Workforce
Timekeeper DTK Reference Guide.
Default Value: The application server timezone
Sample values: 13011
Introduced in v5.0
LaborAccountName
Labor account
If the punch status is in, returns the current labor account transfer
Type: LaborAccount tag
Output only
Maximum length:356 characters
Introduced in v5.0
Time
Date and time of punch
The date and time of a punch. When returned by the system, it contains the time
of the punch.
Type: DateTime
Optional
Default Value: Current time
Sample values: 06/17/2003 10:00AM
Introduced in v5.0
ReportProfile Tag
Report Profile
The ReportProfile tag shows the report profile assigned to a manager. A Report
Profile defines which reports the Workforce Manager can view or run.
Function Access Control Point: API.Employee
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
Load
Returns a report profile, based on ReportProfileName.
Name should be valid
Return Value Type: ReportProfile tag
Required Properties: ReportProfileName
Access Control Point Name: View
Introduced in v4
LoadAllReportProfiles
Returns a list of all report profiles in the system.
Return Value Type: Zero or more ReportProfile tags
Property Descriptions
ReportProfileId
Id of report profile
Uniquely identifies the report data access profile in the database
Type: Integer
Optional
Introduced in v4
ReportProfileName
Report profile name
The name for the common set of reports that a group of users can access. For
example, IS Reports.
Type: String
Optional
Introduced in v4
Request Tag
Request
The Request tag is a container for other XML tags. If an XML tag is actionable, it
is contained in a Request tag. If it is not actionable, a Request tag must not be
specified.
Note: There are contained API tags listed in the syntax that are not part of the
platform or WTK. These tags are in add-on products such as Workforce Activities
or Retail Schedules.
Function Access Control Point: API.XML
Introduced in v4; last changed in v5.1
Syntax
Properties→
<Request
Action = String
[ DataSource = String ]
[ FailureURL = String ]
[ Object = String ]
[ OnError = String ]
[ Password = Password ]
[ ProcessAsManager = Boolean ]
[ Sequence = String ]
[ SuccessURL = String ]
[ UserName = String ] />
Contained API Tag∗
</Request>
<ActivityCustomer> |
<ActivityEmployee> |
<ActivityExportStatus> |
<ActivityFieldDefinition> |
<ActivityForm> |
<ActivityFormProcess> |
<ActivityFormProfile> |
<ActivityFormProfileEntry> |
<ActivityFormStep> |
<ActivityPayCodeAction> |
<ActivityProfile> |
<ActivityResultCode> |
<ActivityResultCodeProfile> |
<ActivityResultCodeProfileEntry> |
<ActivitySettings> |
<ActivityStandard> |
<ActivityTeam> |
<ActivityUnitOfMeasure> |
<ActualVolume> |
<AdHocLaborAccount> |
<ApprovalStatus> |
<ApproveSignoff> |
<AssignedStaticDriver> |
<AuthenticationType> |
<AvailPattern> |
<AvailPatternTemplate> |
<BadgeAssignment> |
<BatchEvent> |
<BatchRequestStatus> |
<BatchTask> |
<Bid> |
<BidGroup> |
<BidGroupItem> |
<BidRequest> |
<BulkAccruals> |
<BulkTotals> |
<CancelDeductions> |
<CensusDataSegment> |
<Certification> |
<CheckAdvice> |
<Comment> |
<ConnectToSchedule> |
<ConsolidatedLaborForecast> |
<CurrentUser> |
<DeductRule> |
<DeviceGroup> |
<Document> |
<DocumentStatus> |
<DynamicScheduler> |
<DynamicSchedulerOptionSet> |
<EarnedAccrual> |
<EligibilityRequirement> |
<EligibleJobs> |
<EmployeeGroupAssign> |
<EmployeeGroupProfile> |
<EmployeeJobPreferences> |
<EmployeeMinor> |
<EmployeeRuleSet> |
<EmployeeRuleSetForHRMS> |
<EmployeeSchedulePreferences> |
<EmploymentStatus> |
<EngOptionSetDap> |
<EvalRule> |
<EvalRuleCategory> |
<EvalRuleOperatorType> |
<EvalRuleParameterType> |
<EvalRuleParameterValueType> |
<EvalRuleSeverity> |
<EvalRuleType> |
<EvalRuleWeight> |
<FailedXMLTransaction> |
<ForecastCategory> |
<ForecastCategoryProperty> |
<ForecastCategoryType> |
<ForecastEvent> |
<ForecastEventType> |
<ForecastMapDap> |
<FunctionAccessProfile> |
<HistoricalPayCodeEdit> |
<HistoricalPayCodeMove> |
<Holiday> |
<HoursOfOperation> |
<HoursOfOperationAssignment> |
<HyperFindQuery> |
<ImportBatchStatus> |
<JobAssignment> |
<KTimeZone> |
<LaborAccount> |
<LaborAccountSet> |
<LaborAccountSetProfile> |
<LaborBudget> |
<LaborForecastDetail> |
<LaborForecastLimit> |
<LaborForecastLimitAssignment> |
<LaborLevelDefinition> |
<LaborLevelEntry> |
<LaborStandard> |
<LeaveCascader> |
<LeaveCase> |
<LeaveCategory> |
<LeaveDocumentTemplate> |
<LeaveProfile> |
<LeaveReason> |
<LeaveRequest> |
<LeaveRule> |
<LeaveType> |
<LicenseType> |
<LinkedForecastCategory> |
<LocationRuleSet> |
<LogonProfile> |
<ManagerRoleAutoscheduleroptionsetProfile> |
<ManagerRoleAvailabilityPatternProfile> |
<ManagerRoleForecastMapProfile> |
<ManagerRoleScheduleGroupProfile> |
<ManagerRoleSchedulePatternProfile> |
<ManagerRoleSchoolCalendarProfile> |
<ManagerRoleShiftCodeProfile> |
<MarkForTotalization> |
<Menu> |
<MinimunHoursNoModification> |
<MinorRule> |
<MinorRuleDayType> |
<MinorRuleWeekType> |
<NonCancellingPayCodeEdit> |
<OpenShiftVolunteer> |
<OrgLocationsImport> |
<OrgSet> |
<OverrideHoursOfOperation> |
<OverrideHoursOfOperationAssignment> |
<OvertimeApproval> |
<PayCode> |
<PayCodeEdit> |
<PayCodeMove> |
<PayCodeProfile> |
<PayFromSchedule> |
<PayFromScheduleStopEvent> |
<PayRuleProfile> |
<PersonAccessAssignment> |
<Personality> |
<PersonalOvertimeAssignment> |
<PersonCertificationAssign> |
<PersonIdentity> |
<PersonInformation> |
<PersonLeaveProfileAssignment> |
<PersonShiftTemplateAssignment> |
<PersonSkillAssign> |
<PreferenceProfile> |
<PrimaryLaborAccount> |
<Process> |
<ProcessProfile> |
<ProcessSchedule> |
<ProcessTask> |
<ProcessTemplate> |
<ProductivityMonitor> |
<Punch> |
<PunchStatus> |
<ReportProfile> |
<RequestToCover> |
<ResetAccrual> |
<RuleSetEmployeeAssign> |
<RuleSetLocationAssign> |
<SchedBreakRuleSet> |
<Schedule> |
<ScheduleAccrualPattern> |
<ScheduleAssistantCriteria> |
<ScheduleAssistantCriteriaSet> |
<ScheduleBudget> |
<ScheduleGroup> |
<ScheduleGroupProfile> |
<ScheduleHours> |
<ScheduleMarkPosted> |
<SchedulePattern> |
<SchedulePeriod> |
<ScheduleZoneSet> |
<SchoolCalendar> |
<SchoolCalendarDap> |
<SchoolCalendarDayType> |
<ServerTime> |
<ShiftBuilder> |
<ShiftCode> |
<ShiftSetAssignment> |
<ShiftStartTimeBand> |
<ShiftTemplateAssignment> |
<ShiftValidation> |
<Skill> |
<StandardShiftSet> |
<StaticDriver> |
<SuiteProduct> |
<SwapShiftEmployees> |
<SwapShiftJobs> |
<SystemSettings> |
<Task> |
<TaskActionType> |
<TaskGroup> |
<TimeEntry> |
<TimeFramePeriod> |
<Timesheet> |
<TransferJobSeniorityDate> |
<TypeOverride> |
<User> |
<UserAccountStatus> |
<UserDefinedDriver> |
<UserDefinedDriverDataAssignment> |
<VacationBid> |
<Volume> |
<VolumeBudget> |
<VolumeDriver> |
<VolumeForecast> |
<VolumeForecastModel> |
<WageProfile> |
<WATEmpProfile> |
<WATEventTransaction> |
<WATPointBalanceAdjustment> |
<WATPointBalanceReset> |
<WATPolicy> |
<WATProfile> |
<WeekDay> |
<WfcJob> |
<WorkedDuration> |
<WorkerType> |
<WorkflowAccessAssignment> |
<WorkflowTemplateCategory> |
<WorkloadPlan> |
<WorkloadPlanner> |
<WorkloadPlannerProfile> |
<WorkRule> |
<WorkRuleProfile> |
<WSAAssignmentRule> |
<WSAAutoBreakPlacement> |
<WSAAvailabilityPatternDAP> |
<WSAAvailabilityPatternProfileItem> |
<WSABonusDeductRule> |
<WSABreakRule> |
<WSABreakTime> |
<WSACallInRule> |
<WSACombinationRule> |
<WSACombinedPayCodeRule> |
<WSAComment> |
<WSACommentType> |
<WSAContributingPayCodeRule> |
<WSAContributingShiftRule> |
<WSACoreHoursRule> |
<WSADaysOfWeek> |
<WSADisplayOrder> |
<WSADispOrdOptionalRule> |
<WSAEffectivePayRule> |
<WSAEffectiveWorkRule> |
<WSAExceptionRule> |
<WSAFixedRule> |
<WSAFunctionAccessProfile> |
<WSAHoliday> |
<WSAHolidayCreditRule> |
<WSAIntervalRoundRule> |
<WSALaborLevel> |
<WSALaborLevelEntry> |
<WSALogonProfile> |
<WSAMajorityRule> |
<WSAOptionalRule> |
<WSAOvertimeCombination> |
<WSAOvertimeRule> |
<WSAPatternTemplateDAP> |
<WSAPatternTemplateProfileItem> |
<WSAPayCode> |
<WSAPayCodeDAP> |
<WSAPayCodeDistribution> |
<WSAPayCodeProfileItem> |
<WSAPayDistributionAssociation> |
<WSAPayPeriod> |
<WSAPayRule> |
<WSAPayRuleHoliday> |
<WSAPermission> |
<WSAPunchRoundRule> |
<WSAReportDAP> |
<WSAReportProfileItem> |
<WSAScheduleDeviationRule> |
<WSAScheduledHoursType> |
<WSAScheduleGroupDAP> |
<WSAScheduleGroupProfileItem> |
<WSASequencedItem> |
<WSASequencerRule> |
<WSAShiftGuarantee> |
<WSAShiftLength> |
<WSAShiftTemplateDAP> |
<WSAShiftTemplateProfileItem> |
<WSASignOffRestriction> |
<WSATkTerminalRule> |
<WSAULLE> |
<WSAWageProfile> |
<WSAWageProfileLaborLevelLinkage> |
<WSAWageProfilePayCode> |
<WSAWorkHistoryQualifierRule> |
<WSAWorkRule> |
<WSAWorkRuleDAP> |
<WSAWorkRuleGeneral> |
<WSAWorkRulePCDistr> |
<WSAWorkRuleProfileItem> |
<WSAWPWageAdjustment> |
<WSAZone> |
<WSAZoneCombinationRule> |
<WSAZoneCombinationSpecificationRule> |
<WSAZoneCombinationZoneRule> |
<WSAZoneRule> |
<WSAZoneRuleHoliday> |
<WSAZoneRuleLimit> |
<WTDEmployeeAssignment> |
<WTDGlobal> |
<WTDRule> |
<WTKEmployee> |
<ZoneSetAssignment>
Property Descriptions
Action
Action for the request
The action to apply to the contained tags
Type: String
Required
Action must be supported by all contained tags
Introduced in v4
DataSource
Data source (application) submitting the request
Instantiates a DataSource in the thread state, creating it in the database if
necessary
Type: String
Optional
Introduced in v4
FailureURL
URL to display for a failed response
A URL used to redirect a failed response
Type: String
Optional
Introduced in v4
Object
Tag specified as an object of the Request
Object name of the contained tag
Type: String
Optional
Sequence
Sequence
A user-supplied sequence string that is returned in the corresponding Response
tag
Type: String
Optional
Maximum length: There is no maximum length other than what your operating
system can accommodate.
Introduced in v4
SuccessURL
URL to display for a successful response
A URL used to redirect a successful response
Type: String
Optional
Introduced in v4
UserName
User name
The logon user id
Type: String
Optional
Required: For logon Action
Introduced in v4
RequestToCover Tag
RequestToCover
This tag will provide all the needed actions to assign a shift to an employee to
cover another shift.
Function Access Control Point: API.Schedule
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<RequestToCover
[ IsCheckRules = Boolean ]
[ IsSaveData = Boolean ]
( IsShiftExists = Boolean )
[ PartialEndDate = Date ]
[ PartialEndTime = Time ]
[ PartialStartDate = Date ]
[ PartialStartTime = Time ]
[ QueryDate = Date ]
[ QueryDateTimeSpan = DateTimeSpan ] >
[ <Employee>
<Personality>
</Employee> ]
[ <Employees>
<PersonIdentity>∗
</Employees> ]
( <RequestToCoverItems>
<RequestToCoverItem>∗
</RequestToCoverItems> )
( <RequestToCoverStatus>
<CoverShiftStatus>
</RequestToCoverStatus> )
( <RuleViolations>
<RuleViolation>∗
</RuleViolations> )
</RequestToCover>
Action Descriptions
AssignCoverShift
AssignCoverShift assigns a shift to an employee to cover another shift.
Return Value Type: Zero or more RuleViolation tags
Required Properties: QueryDateTimeSpan, Employees
Optional Properties:
PartialStartDate,PartialEndDate,PartialStartTime,PartialEndTime,IsSaveData,IsC
heckRules
Access Control Point Name: Edit
Introduced in v5.1
LoadEligibleEmployees
LoadEligibleEmployees returns eligible employees who can work for the
specified shift.
Return Value Type: RequestToCover tag
Required Properties: QueryDateTimeSpan, Employee
Access Control Point Name: View
Introduced in v5.1
LoadShifts
The LoadShifts action will load all shifts for the specified employee and a query
date.
Return Value Type: RequestToCover tag
Required Properties: QueryDate,Employee
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
Employee
Employee
The employee who requests his/her shift to be covered.
Type: Personality tag
Optional
It must be an active employee.
Contributes to Uniqueness: Yes
Introduced in v5.1
Employees
Employees
This property represents 2 employees for whom one's shift is to be covered by the
other one.
Type: Zero or more PersonIdentity tags
Optional
The size must be 2.
Contributes to Uniqueness: Yes
Introduced in v5.1
IsCheckRules
Check rules?
This property indicates whether schedule rule validation should be checked.
Type: Boolean
Optional
Introduced in v5.1
IsSaveData
Save changes?
This property indicates whether the changes made by an action will be persisted to
the database.
Type: Boolean
Optional
Introduced in v5.1
IsShiftExists
Does the shift exist?
This property holds the result of whether is the shift existing.
Type: Boolean
Output only
Introduced in v5.1
PartialEndDate
End date of replacement shift
The end date of a shift which will override partial or full schedule of the open
shift.
Type: Date
Optional
Introduced in v5.1
PartialEndTime
End time of replacement shift
The end time of a shift which will override partial or full schedule of the open
shift.
Type: Time
Optional
Introduced in v5.1
PartialStartDate
Start date of replacement shift
The beginning date of a shift which will override partial or full schedule of the
open shift.
Type: Date
Optional
Introduced in v5.1
PartialStartTime
Start time of replacement shift
The beginning time of a shift which will override partial or full schedule of the
open shift.
Type: Time
Optional
Introduced in v5.1
QueryDate
QueryDate
The date to query for a specified employee's shifts.
Type: Date
Optional
It must be a valid date.
Introduced in v5.1
QueryDateTimeSpan
Schedule date and time span
This property represents the start date and time and end date and time of a
schedule.
Type: DateTimeSpan
Optional
It must be a valid date time span.
Introduced in v5.1
RequestToCoverItems
Date and time span
This property contains a shift's date time span information.
Type: Zero or more RequestToCoverItem tags
Output only
Introduced in v5.1
RequestToCoverStatus
Request To Cover Status
This property is the status of the result.
Type: CoverShiftStatus tag
Output only
Introduced in v5.1
RuleViolations
Rule violations generated
RuleViolations is the set of rule violations that was generated by the tag.
Type: Zero or more RuleViolation tags
Output only
Introduced in v5.1
RequestToCoverItem Tag
Request To Cover Item
This tag represents the result of execution of the OpenShifts tag.
Function Access Control Point: API.Schedule
Introduced in v5.1
Syntax
Properties→
<RequestToCoverItem
( DateTimeSpan = DateTimeSpan ) >
( <OrgJobPaths>
<LocationItem>∗
</OrgJobPaths> )
</RequestToCoverItem>
Property Descriptions
DateTimeSpan
Date and time span
This property represents a date and time span of a valid shift.
Type: DateTimeSpan
Output only
none
Introduced in v5.1
OrgJobPaths
Organization job paths
This property represents a set of valid organization jobs.
Type: Zero or more LocationItem tags
Output only
none
Introduced in v5.1
ResetAccrual Tag
Accrual Reset
The ResetAccrual tag specifies values to use when resetting amounts for a
specified accrual code and employee.
The accrual code determines whether an AmountInTime or AmountInCurrency
must be specified.
Function Access Control Point: API.Accruals
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Update"
Properties→
<ResetAccrual
AccrualCodeName = String
AmountInCurrency = Currency
AmountInTime = TimeDuration
AmountInTimeOrCurrency = String
Date = Date
ProbationAmountInCurrency = Currency
ProbationAmountInTime = TimeDuration >
<Employee>
<CurrentUser> | <PersonIdentity>
</Employee>
</ResetAccrual>
Action Descriptions
Update
Resets an accrual amount for the specified accrual code. The accrual code is used
to determine the amount types, time duration, or currency.
Updates information for one employee
Property Descriptions
AccrualCodeName
Accrual code name
The accrual code associated with the transaction.
Type: String
Required
Maximum length: 50 characters
The accrual code must be created in Workforce Timekeeper Setup Application
and assigned to the employee before you can import data against it.
Sample values: Vacation, Sick
Introduced in v4
AmountInCurrency
Amount of accrual, in currency
The new monetary value for the employee's accrual balance
Type: Currency
See group( Amount/Currency)
Maximum length: 30 characters
Default Value: 0.00
Introduced in v4
AmountInTime
Amount of accrual, in time
The new time span value for the employee's accrual balance
Type: TimeDuration
See group( Amount/Currency)
Maximum length: 30 characters
Default Value: 0.0 or 0:0
Introduced in v4; last changed in v5.0
AmountInTimeOrCurrency
Amount of accrual, in time or currency
The amount to be added or decremented to the current balance for a specified
accrual code and employee. This value can be formatted either as a time value or a
currency, depending on the format needed for the specified accrual code.
Type: String
Required
AmountInTimeOrCurrency belongs to the AccrualAmount group. Only one
member of the group can be used.
Introduced in v5.1
Date
Date
The date when the accrual transaction is effective
Type: Date
Required
Introduced in v4
Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag.
Type: Either CurrentUser or PersonIdentity tag
Required
Must uniquely identify an existing and active employee
Contributes to Uniqueness: Yes
Introduced in v4
ProbationAmountInCurrency
Probationary amount, in currency
The amount, expressed as a currency, in which accrual balances are earned but
cannot be taken or paid. This property is optional when resetting an accrual
balance. If you do not specify a value for ProbationaryAmountInCurrency or
ProbationaryAmountInTime, then the probation amount defaults to zero.
Dependency: If you specify a value for this property, you must also have a value
in AmountInCurrency.
Type: Currency
See group( Probation Amount/Currency)
Maximum length: 15 characters
Introduced in v4
ProbationAmountInTime
Probationary amount, in time
The amount, expressed as a time duration, in which accrual balances are earned
but cannot be taken or paid. This property is optional when resetting an accrual
balance. If you do not specify a value for ProbationaryAmountInCurrency or
ProbationaryAmountInTime, then the probation amount defaults to zero.
Dependency: If you specify a value for this property, you must also have a value
in AmountInTime.
Type: TimeDuration
See group( Probation Amount/Currency)
Maximum length: 15 characters
Introduced in v4
Required
Group includes: AmountInTimeOrCurrency,AmountInTime,AmountInCurrency
Probation Amount/Currency
Mutually Exclusive group for Probation AmountInCurrency and Probation
AmountInTime
Optional
Group includes: ProbationAmountInTime,ProbationAmountInCurrency
Response Tag
Response
The Response tag is a container for all response information that is sent back to
the client application. A Response tag corresponds to a Request tag, which can
contain any number of XML API tags.
All XML API tags specified in the request are echoed in the response, unless the
EchoData action parameter is specified as False for the tag.
Note: EchoData can not be specified for all XML API tags.
Function Access Control Point: API.XML
Introduced in v4; last changed in v5.0
Syntax
Properties→
<Response
( Message = String )
( Sequence = String )
( Status = String )
( TransactionSequence = String ) />
Property Descriptions
Message
Message if request fails
This message is generated if a failure occurs and explains the reason for the failure
Type: String
Output Only
Introduced in v4
Sequence
Sequence specified in request
A user-supplied sequence string returned in the corresponding Response tag
Type: String
Output Only
Introduced in v4
Status
Status of response
The status resulting from the corresponding Request
Type: String
Output Only
Only Allowed Values: Success, Failure
Introduced in v4
TransactionSequence
Transaction sequence specified in transaction
A user-supplied sequence string specified in the Transaction tag and returned in
the Response tags for every Request in the transaction
Type: String
Output Only
Introduced in v4
RuleSetEmployeeAssign Tag
Rule Sets Assigned to Employees
The RuleSetEmployeeAssign tag assigns one or more rule sets to one or more
employees.
Function Access Control Point: API.RuleEvaluation
Introduced in v5.0; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
Load
Returns the rule set assignments for an employee
Required Properties: PersonNumber
Access Control Point Name: View
Introduced in v5.0
Update
Assigns rule sets to one or more employees.
Property Descriptions
EmployeeRuleSetItems
Rules in the rule set
The rule sets that are assigned to the specified employees
Type: One or more EmployeeRuleSetItem tags
Required
Introduced in v5.0
Employees
Employees
One or more employees for whom the rule set is assigned, as specified in one or
more PersonIdentity tags.
Type: One or more PersonIdentity tags
Required
Each employee specified must have a WFS license.
Introduced in v5.0
PersonNumber
Person number
Person number of the person about whom information is returned
Type: String
Optional
Maximum length: 15 characters
This person must have WFS license.
Introduced in v5.0
Schedule Tag
Schedule
The Schedule tag contains information about all schedule activities for one
employee or group.
Function Access Control Point: API.Schedule
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"AddScheduleItems" |
"AddShiftRemovingOverlaps" |
"AppendShift" |
"AssignBreaks" |
"AssignOpenShift" |
"CheckRuleViolations" |
"Delete" |
"EditScheduleItems" |
"Load" |
"LockDays" |
"LockShifts" |
"RemoveScheduleItems" |
"RemoveSpecifiedScheduleItems" |
"ReplaceShift" |
"TransferEmployees" |
"UnLockDays" |
"UnlockShifts" |
"Update"
Properties→
<Schedule
[ CheckRules = Boolean ]
[ IsForeverPattern = Boolean ]
[ IsOpenShift = Boolean ]
[ OrgJobPath = String ]
QueryDateSpan = DateSpan
[ SaveData = Boolean ] >
[ <AppendShifts>
<AppendShifts>∗
</AppendShifts> ]
[ <Employees>
<CurrentUser>∗
<PersonIdentity>∗
</Employees> ]
[ <Locations>
<LocationItem>∗
</Locations> ]
[ <OpenShiftItems>
<ScheduleShiftSwap>∗
</OpenShiftItems> ]
[ <OrgJobPaths>
<LocationItem>∗
</OrgJobPaths> ]
[ <PartialShiftItems>
<ScheduleShiftSwap>∗
</PartialShiftItems> ]
[ <ScheduleCostSummaries>
<ScheduleCostSummary>∗
</ScheduleCostSummaries> ]
[ <ScheduleGroups>
<ScheduleGroup>∗
</ScheduleGroups> ]
[ <ScheduleItems>
<ScheduleAccrualAmountEdit>∗
<ScheduleOff>∗
<SchedulePayCodeEdit>∗
<ScheduleShift>∗
<ScheduleShiftSwap>∗
<ScheduleUnavailable>∗
</ScheduleItems> ]
[ <SchedulePatterns>
<SchedulePattern>∗
</SchedulePatterns> ]
[ <TransferEmployees>
<TransferEmployee>∗
</TransferEmployees> ]
</Schedule>
Action Descriptions
AddScheduleItems
Adds the specified items into the schedule for the identified people and time
period
Return Value Type: None
Required Properties: ScheduleItems, QueryDateSpan
Access Control Point Name: Edit
Introduced in v4
AddShiftRemovingOverlaps
Adds the specified shift item for an employee, and removes any existing shift item
that overlaps within the time span
QueryDateSpan must identify just one day.
Employees must specify just one employee.
ScheduleItems must contain just one ScheduleShift tag.
Return Value Type: Zero or more RuleViolation tags
Required Properties: QueryDateSpan, Employees, ScheduleItems
Optional Properties: SaveData, CheckRules
Access Control Point Name: Edit
Introduced in v5.0
AppendShift
Appends shift for specified employees. At lease one of the optional properties
must be present.
Return Value Type: None
Required Properties: AppendShifts, QueryDateSpan
Optional Properties: Employees, ScheduleGroups
Access Control Point Name: Edit
Introduced in v5.1
AssignBreaks
Assigns breaks, based on the break placement rules, to the shift identified by the
query date span and employee
The query date span and each employee, taken together, must identify an existing
shift
Return Value Type: None
Required Properties: QueryDateSpan, Employees
Access Control Point Name: Edit
Introduced in v5.0.a
AssignOpenShift
Assigns an open shift to a person
QueryDateSpan must identify exactly one day.
Employees must specify exactly one employee.
OpenShiftItems must contain exactly one ScheduleShiftSwap.
Return Value Type: Zero or more RuleViolation tags
Required Properties: QueryDateSpan, Employees, OrgJobPath, OpenShiftItems
Optional Properties: SaveData, CheckRules
Access Control Point Name: Edit
Introduced in v5.0; last changed in v5.1
CheckRuleViolations
Returns all rule violations that exist in the current schedule for the specified
employees and/or jobs. At least one of the optional properties must be present.
Return Value Type: Zero or more RuleViolation tags
Required Properties: QueryDateSpan
Optional Properties: Employees, OrgJobPath, OrgJobPaths
Access Control Point Name: View
Introduced in v5.0; last changed in v5.1
Delete
Marks all schedule items for deletion from the identified schedule period. At least
one of the optional properties must be present.
Return Value Type: None
Required Properties: QueryDateSpan
Optional Properties: Employees, ScheduleGroups
Access Control Point Name: Edit
Introduced in v4; last changed in v5.1
EditScheduleItems
Modifies one or more existing schedule items. At least one of the optional
properties must be present.
Return Value Type: None
Required Properties: ScheduleItems, QueryDateSpan
Optional Properties: Employees, ScheduleGroups
Access Control Point Name: Edit
Introduced in v5.0; last changed in v5.1
Load
Returns all schedule items and patterns for the specified people and time period.
Any item that is not currently active returns a value of True for the IsDeleted
property. At least one of the optional properties must be present.
Return Value Type: Schedule tag
Required Properties: QueryDateSpan
Optional Properties: Employees, ScheduleGroups, IsOpenShift
Access Control Point Name: View
Introduced in v4; last changed in v5.1
LockDays
Locks the days for specified employees. At least one of the optional properties
must be present.
Return Value Type: None
UnLockDays
UnLockDays for the specified employees. At least one of the optional properties
must be present.
Return Value Type: None
Required Properties: QueryDateSpan
Optional Properties: Employee, ScheduleGroups
Access Control Point Name: Edit
Introduced in v5.1
UnlockShifts
Locks schedule shifts can be used for the following cases:
Property Descriptions
AppendShifts
Append shifts
AppendShifts
Type: Zero or more AppendShifts tags
Optional
Introduced in v5.1
CheckRules
Validate modified schedule?
Iindicates whether schedule validation should be done on the modified schedule
Type: Boolean
Optional
If True, all rule violations from employees or jobs that are affected by the action
are returned. If False, null is returned.
Dependency: Only one of SaveData and CheckRules can be False.
Default Value: False
Introduced in v5.0
Employees
Employees
One or more employees for whom the schedule is valid, as specified in one or
more PersonIdentity or CurrentUser tags.
Type: Any combination of CurrentUser or PersonIdentity tags
Optional
Contributes to Uniqueness: Yes
Introduced in v4; last changed in v5.0
IsForeverPattern
Extend end date indefinitely?
Indicates whether the pattern end date is January 1, 3000
Type: Boolean
Optional
Only Allowed Values: True, False
Introduced in v4
IsOpenShift
Is this an open shift?
Specifies whether the shift is open. If True, the shift is open.
Type: Boolean
Optional
Only Allowed Values: True, False
Introduced in v5.0
Locations
Locations
Locations property is used to load the schedule for a specific locations into the
container that gets created. Used for locking/unlocking shifts
Type: Zero or more LocationItem tags
Optional
Introduced in v5.1
OpenShiftItems
Items in open shift
The set of items that define the open shift
Type: Zero or more ScheduleShiftSwap tags
Optional
Only one shift can be specified.
Introduced in v5.1
OrgJobPath
Location of job in the organization
The fully qualified organizational job
Type: String
Optional
Maximum length: 1000 characters
Only used if the IsOpenShift property is "True"
Introduced in v5.0
OrgJobPaths
Organizational jobs
OrgJobPaths specifies a list of OrgJobs. It is similar to multiple OrgJobPath
properties.
Type: Zero or more LocationItem tags
Optional
All items in the list must identity organizational jobs.
Introduced in v5.0
PartialShiftItems
Items in partial shift
The set of items that define a partial shift. The partial shift is assigned to an open
shift.
TransferEmployees
Transfer employees
TransferEmployees
Type: Zero or more TransferEmployee tags
Optional
Introduced in v5.1
ScheduleAccrualAmountEdit Tag
Accrual Amount Edit
The ScheduleAccrualAmountEdit tag represents a modification to the accrued
balance of an employee or group.
Used by: Schedule
Function Access Control Point: API.Schedule
Introduced in v4; last changed in v5.1
Syntax
Properties→
<ScheduleAccrualAmountEdit
AccrualCodeName = String
[ AmountInCurrency = Currency ]
AmountInTime = TimeDuration
( IsDeleted = Boolean )
[ ScheduleGroupName = String ]
Startdate = Date >
[ <Employee>
<CurrentUser> | <PersonIdentity>
</Employee> ]
</ScheduleAccrualAmountEdit>
Property Descriptions
AccrualCodeName
Accrual code name
The accrual code associated with the transaction. The accrual code must be
created in Workforce Timekeeper and assigned to the employee before you can
import data against it.
Type: String
Required
Maximum length: 50 characters
You can find values in the Workforce Timekeeper Setup Application.
Sample values: Vacation, Sick
Introduced in v4
AmountInCurrency
Amount of accrual, in currency
An accrual amount expressed as a currency
Type: Currency
Optional
Maximum length: 30 characters
Introduced in v4
AmountInTime
Amount of accrual, in time
An accrual amount, expressed in hours or days
Type: TimeDuration
See group( AccrualAmount)
Maximum length: 30 characters
Introduced in v4
Employee
Employee
One employee who is assigned to the shift, as specified in a PersonIdentity or
CurrentUser tag.
Type: Either CurrentUser or PersonIdentity tag
Optional
Must uniquely identify an existing and active employee
Introduced in v4
IsDeleted
Is the item inactive?
Indicates whether the item is active.
• If False, the item is active.
• If True, it is currently inactive.
An inactive shift is one that has been deleted from an inherited shift item or from a
pattern. It displays in the user interface with the text struck through; it can be
restored. This does not apply to an ad hoc shift item, which is deleted. It does not
display in the user interface and cannot be restored.
Type: Boolean
Output only
Only Allowed Values: True, False
Introduced in v5.0
ScheduleGroupName
Schedule group name
The name of the schedule group to which the person is currently assigned
Type: String
Optional
Maximum length: 30 characters
You can find values in the Workforce Timekeeper user interface.
Introduced in v4
Startdate
Start date
The start date for this item
Type: Date
Required
Must be within the span of the containing schedule
Introduced in v4
ScheduleAccrualPattern Tag
Create or Modify Accrual Pattern
The ScheduleAccrualPattern tag allows you to create or modify an accrual pattern
for a given employee or group.
Function Access Control Point: API.Schedule
Introduced in v4; last changed in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
Delete
Marks an existing accrual pattern from an employee or a group for deletion
The existing pattern anchor time must be within the query data span.
Return Value Type: None
Required Properties: AccrualCodeName
Access Control Point Name: Edit
Introduced in v4
Update
Adds a new pattern or updates an existing one for an employee or a group
Return Value Type: None
Required Properties: AccrualCodeName
Access Control Point Name: Edit
Introduced in v4
Property Descriptions
AccrualCodeName
Accrual code name
A named account containing a specific type of accrual balance
Type: String
Required
Maximum length: 50 characters
You can find values in the Workforce Timekeeper Setup Application.
Sample values: Vacation, Sick
Introduced in v4
AccrualPatternElements
Elements in accrual pattern
One or more elements that comprise the pattern. Each element corresponds to one
day in the pattern.
Optional
Must uniquely identify an existing and active employee
Introduced in v4
IsForeverPattern
Extend end date indefinitely?
Indicates whether the pattern's end date is January 1, 3000
Type: Boolean
Required
Only Allowed Values: True, False
Introduced in v4
PeriodCodeName
Units of time for accrual period
The unit of time used for the PeriodLength
Type: String
Optional
Maximum length: 30 characters
Only Allowed Values: Daily, Weekly, Monthly, Annually, Pay Period, Schedule
Period
Introduced in v4
PeriodLength
Number of units
The number of units in the availability pattern, as specified by the
PeriodCodeName. For example, if the PeriodCodeName is Weeks and
PeriodLength is 3, it specifies three weeks.
Type: Integer
Optional
Introduced in v4
PeriodLengthInDays
Number of days for pattern
The number of days to which the accrual pattern applies
Type: Integer
Output Only
Introduced in v4; last changed in v5.0
QueryDateSpan
Span of dates for schedule
The span of dates when the schedule is valid. If you are creating an accrual pattern
and want the pattern to last forever, set IsForeverPattern to True.
Type: DateSpan
Required
Contributes to Uniqueness: Yes
Introduced in v4
ScheduleGroups
Group assigned to the accrual
Identifies one or more group who are assigned to the accrual
Dependency: At least one of Employees or ScheduleGroups is required.
Type: Zero or more ScheduleGroup tags
Optional
Any group that is specified must exist
Introduced in v4
ScheduleCostPaycode Tag
Schedule Cost Paycode
The ScheduleCostPaycode tag contains the hours and wages for one pay code in
the schedule costing table.
Function Access Control Point: API.RetailSchedules
Introduced in v5.0.a
Syntax
Properties→
<ScheduleCostPaycode
( Hours = Time )
( Label = String )
( Wages = Currency ) />
Property Descriptions
Hours
Hours to earn wage
The hours worked to earn the wage.
Type: Time
Output only
Sample values: 41.00
Introduced in v5.0.a
Label
Paycode label
A label for the paycode
Type: String
Output only
none
Default Value: none
ScheduleCostResult Tag
Schedule Cost Result
This tag contains the the result tags for all paycodes under the given job or
account.
none
Function Access Control Point: API.RetailSchedules
Introduced in v5.0.a
Syntax
Properties→
<ScheduleCostResult
( Label = String ) >
( <Paycodes>
<ScheduleCostPaycode>∗
</Paycodes> )
</ScheduleCostResult>
Property Descriptions
Label
Job or account label
The fully qualified name for the selected job or account label
Type: String
Output only
Default Value: none
Sample values: Organization/Manufacturing/Bright Plant/Light Bulbs/Line 1/
ASSM
Introduced in v5.0.a
Paycodes
Paycodes for the job or account
One or more ScheduleCostPaycode tags for the job or account
ScheduleCostSummary Tag
Schedule Cost Summary
The ScheduleCostSummary tag contains information about the schedule cost.
Function Access Control Point: API.RetailSchedules
Introduced in v5.0; last changed in v5.0.a
Syntax
Properties→
<ScheduleCostSummary
Grouping = String
SummaryType = String
[ Updated = Boolean ] >
( <Results>
<ScheduleCostResult>∗
</Results> )
</ScheduleCostSummary>
Property Descriptions
Grouping
Job or account?
Specifies whether the results should be indexed by job or by account.
Type: String
Required
Only Allowed Values: job, account
Introduced in v5.0.a
Results
Results for a job or account
One or more ScheduleCostResult tags. Each ScheduleCostResult tags represents a
job or account.
Type: Zero or more ScheduleCostResult tags
Output only
Introduced in v5.0.a
SummaryType
Employee or location?
Specifies whether the output should be based on employee or location
Type: String
Required
Only Allowed Values: employee, location
Default Value: none
Introduced in v5.0.a
Updated
Request an update to schedule cost data?
This property is used to determine whether the system updates schedule cost data.
In a request, specify True to request an update. In a response, True means that the
data has been updated.
Type: Boolean
Optional
Only Allowed Values: True, False
Default Value: False
Introduced in v5.0.a
ScheduleGroup Tag
Schedule Group
The ScheduleGroup tag identifies employees who are grouped together for
scheduling purposes. Each employee's membership in a schedule group varies,
depending on the date span.
Used by: Schedule, ScheduleAccrualPatern
Function Access Control Point: API.Schedule
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"AddEmployees" |
"Delete" |
"Load" |
"LoadAllGroups" |
"RemoveEmployees" |
"RemoveEmployeesByDateSpan" |
"Update"
Properties→
<ScheduleGroup
[ IsOverrideConflict = Boolean ]
[ QueryDateSpan = DateSpan ]
[ ScheduleGroupName = String ] >
[ <GroupMemberships>
<GroupMembership>∗
</GroupMemberships> ]
</ScheduleGroup>
Action Descriptions
AddEmployees
Adds one or more employees to the existing group for the specified period of time
Introduced in v4
RemoveEmployeesByDateSpan
Removes one or more employees from the specified group for the specified date
range
All of the employees to be removed must be specified in the GroupMembership
list.
Return Value Type: None
Required Properties: GroupMemberships
Access Control Point Name: Edit
Introduced in v4
Update
Modifies the employee list for the specified group and date span
Return Value Type: None
Required Properties: ScheduleGroupName, QueryDateSpan
Access Control Point Name: Edit
Introduced in v4
Property Descriptions
GroupMemberships
List of group members
One or more employees who are part of the group
Type: Zero or more GroupMembership tags
Optional
Introduced in v4
IsOverrideConflict
Override schedule conflicts?
Indicates whether to override conflicts when adding group members
Type: Boolean
Optional
Only Allowed Values: True, False
Default Value: False
Introduced in v4; last changed in v5.1
QueryDateSpan
Date span for the schedule
The range of dates when the schedule is valid for the group members
Type: DateSpan
Optional
Introduced in v4
ScheduleGroupName
Schedule group name
The name of the schedule group to which the members of the group are assigned.
Type: String
Optional
Maximum length: 30 characters
You can find values in the Workforce Timekeeper user interface.
Introduced in v4; last changed in v5.0
ScheduleGroupProfile Tag
Profile for Schedule Group
The ScheduleGroupProfile tag provides information about valid ScheduleGroup
profiles defined within the system. A Schedule Group is a set of employees who
work the same shift.
Function Access Control Point: API.Employee
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<ScheduleGroupProfile
[ ScheduleGroupId = Integer ]
[ ScheduleGroupName = String ] />
Action Descriptions
Load
Returns a schedule group, based on ScheduleGroupName.
Name should be valid
Return Value Type: ScheduleGroupProfile tag
Required Properties: ScheduleGroupName
Access Control Point Name: View
Introduced in v4; last changed in v5.1
LoadAllScheduleGroupProfiles
Returns all schedule group profiles in the system.
Property Descriptions
ScheduleGroupId
Id of Schedule group
Uniquely identifies the schedule group in the database
Type: Integer
Optional
Introduced in v4
ScheduleGroupName
Schedule group name
The name of the schedule group to which the person is currently assigned
Type: String
Optional
Maximum length: 30 characters
You can find values in the Workforce Timekeeper user interface.
Introduced in v4
ScheduleHours Tag
Schedule Hours
The ScheduleHours tag provides information about a schedule shift for a person,
and allows it to be overridden.
Function Access Control Point: API.Schedule
Introduced in v5.0; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
AddOnly
This action either overrides existing scheduled hours with a pay code edit, or adds
the pay code edit to the schedule.
Property Descriptions
AmountInTime
Amount of pay code, in time
The amount of the pay code edit, expressed as a time value
Type: TimeDuration
Optional
Must be between 00:00 and 100:00
Dependency: If AmountInTime is used, DisplayTime must also be used.
Dependency: If AmountInTime is used, the pay code must be associated with
time, rather than currency.
Introduced in v5.0
DisplayTime
Time to display in the user interface
The start time of the scheduled pay code edit
Type: Time
Optional
Dependency: If DisplayTime is used, AmountInTime must also be used.
Introduced in v5.0
Employee
Employee
One employee, as specified in a PersonIdentity tag
Type: PersonIdentity tag
Required
Must uniquely identify an existing and active employee. If the employee has
a Workforce_Scheduler_Employee license and specifies True for
IsCreateOpenShift, you will be able to create open shifts. Otherwise
IsCreateOpenShift will have no effect.
Contributes to Uniqueness: Yes
Introduced in v5.0
IsAllDays
Apply Paycode edit applied to non-scheduled days?
This property identifies how AmountInTime and DisplayTime will be used. If
True, a pay code edit is created for non-scheduled days. If False, a pay code edit
is not applied to non-scheduled days.
Type: Boolean
Optional
Dependency: If True, AmountInTime and DisplayTime must be specified.
Default Value: False
Introduced in v5.0; last changed in v5.1
IsCheckRules
Validate modified schedule?
Iindicates whether schedule validation should be done on the modified schedule
Type: Boolean
Optional
If True, any rule violations for affected employees or jobs will be returned. If
False, null is returned.
Dependency: Only one of IsSaveData and IsCheckRules can be False.
Default Value: False
Introduced in v5.0
IsCreateOpenShift
Create open shifts?
Specifies whether open shifts should be created
Type: Boolean
Optional
Dependency: If IsCreateOpenShift is True, IsOverride must also be True.
Dependency: This property is only available to employees who have
Workforce_Scheduler_Employee licenses.
Default Value: True
Introduced in v5.0
IsOverride
Override scheduled hours?
Specifies whether the pay code edit should override the scheduled hours
Type: Boolean
Optional
Dependency: If IsCreateOpenShift is True, IsOverride must also be True.
Default Value: True
Introduced in v5.0
IsSaveData
Save modified schedule?
Indicates whether the modified schedule should be saved
Type: Boolean
Optional
There may be No Save severity rule violations in existence. If so, regardless of the
value of IsCheckRules, the Request will fail and the violations will be listed.
Dependency: Only one of IsSaveData and IsCheckRules can be False.
Default Value: True
Introduced in v5.0
PaycodeName
Pay code
The pay code that will override or add to the person scheduled hours
Type: String
Required
Maximum length: 50 characters
The pay code must be a monetary type.
Introduced in v5.0
QueryDateSpan
Date range of schedule
The range of dates for which the schedule is valid
Type: DateSpan
Required
Contributes to Uniqueness: Yes
Introduced in v5.0
UnavailableDuration
Time range when employee is unavailable
The period of time during a specific day when an employee is unavailable
Type: TimeDuration
Optional
Introduced in v5.0
UnavailableStartTime
Unavailable start time
If this property is specified, its value will be used as this persons unavailable start
Time.
Type: Time
Optional
Introduced in v5.1Beta
ScheduleHoursAccrualViolation Tag
Accrual Violations Message
The ScheduleHoursAccrualViolation tag contains a message about an accural
violation.
Used by: ScheduleHoursStatus
Function Access Control Point: API.Schedule
Introduced in v5.1Beta; last changed in v5.1
Syntax
Properties→
<ScheduleHoursAccrualViolation
( ViolationMessage = String ) />
Property Descriptions
ViolationMessage
Violation message
The violation message
Type: String
Output only
Cannot be null.
Introduced in v5.1Beta; last changed in v5.1
ScheduleHoursDailyStatus Tag
Daily Status for Schedule Hours
The ScheduleHoursDailyStatus tag returns daily information about schedule
hours.
Used by: ScheduleHoursStatus
Function Access Control Point: API.Schedule
Introduced in v5.1Beta
Syntax
Properties→
<ScheduleHoursDailyStatus
( Date = Date )
( IsPayCodeEditCreated = Boolean )
( ScheduledShiftExist = Boolean ) />
Property Descriptions
Date
Date for requested data
The date for which schedule information has been requested
Type: Date
Output only
Introduced in v5.1Beta
IsPayCodeEditCreated
Was pay code edit created?
This property returns true if a pay code edited was created; false if one has not.
Type: Boolean
Output only
Introduced in v5.1Beta
ScheduledShiftExist
Does scheduled shift exist?
This property returns true if the specified shift exists; false if it does not.
Type: Boolean
Output only
Introduced in v5.1Beta
ScheduleHoursException Tag
Exception Message for Schedule Hours
The ScheduleHoursException tag contains an exception message.
Used by: ScheduleHoursStatus
Function Access Control Point: API.Schedule
Introduced in v5.1Beta; last changed in v5.1
Syntax
Properties→
<ScheduleHoursException
( ViolationMessage = String ) />
Property Descriptions
ViolationMessage
Violation message
This is an output only property; it displays exception messages that will be used
by process manager.
Type: String
Output only
Cannot be null.
Introduced in v5.1Beta; last changed in v5.1
ScheduleHoursStatus Tag
Schedule Hours Status
The ScheduleHoursStatus tag contains all of the messages from the
ScheduleHoursAccrualViolation, ScheduleHoursDailyStatus, and
ScheduleHoursException tags, as well as violations identified in the
RuleViolations tag.
Information in this tag is returned by the CancelTimeOff action of the
ScheduleHours tag.
One ScheduleHoursStatus tag is returned for each date in the QueryDateSpan
range that is specified in the ScheduleHours tag.
Function Access Control Point: API.Schedule
Introduced in v5.1Beta
Syntax
Properties→
<ScheduleHoursStatus
( Date = Date ) >
( <AccrualViolation>
<ScheduleHoursAccrualViolation>
</AccrualViolation> )
( <DailyStatus>
<ScheduleHoursDailyStatus>∗
</DailyStatus> )
( <Exception>
<ScheduleHoursException>
</Exception> )
( <RuleViolations>
<RuleViolation>∗
</RuleViolations> )
</ScheduleHoursStatus>
Property Descriptions
AccrualViolation
Accural violation
An accrual violation as shown in the ScheduleHoursAccrualViolation tag
Introduced in v5.1Beta
ScheduleMarkPosted Tag
Schedules Marked As Posted
The ScheduleMarkPosted tag enables you to specify a date range and a set of jobs
for which all shifts are captured and marked as posted.
Note: These shifts can be modified and assigned to employees, but they cannot be
deleted.
Function Access Control Point: API.Schedule
Introduced in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Update"
Properties→
<ScheduleMarkPosted
OrgJobLocation = String
QueryDateSpan = DateSpan />
Action Descriptions
Update
Updates a mark posted period if one exists
Return Value Type: None
Required Properties: QueryDateSpan, OrgJobLocation
Access Control Point Name: Edit
Introduced in v5.0
Property Descriptions
OrgJobLocation
Set of jobs in the organization
A set of jobs for which all shifts will be marked as posted
Type: String
Required
Maximum length: 1000 characters
Introduced in v5.0
QueryDateSpan
Span of dates for schedule
The date range when the schedule is valid
Type: DateSpan
Required
Introduced in v5.0
ScheduleOff Tag
Employee On Call
The ScheduleOff tag describes a situation where an employee is on call. The
person may or may not actually be called in. Because the person may not come in,
a punch may not be recorded. Although the person is not paid for the shift, no
exception is generated.
Used by: Schedule
Dependency: A shift with this segment type must specify a transfer of labor level,
work rule, organizational job path, or any combination of these items.
Only one ScheduleOff segment can be specified.
Function Access Control Point: API.Schedule
Introduced in v4; last changed in v5.0
Syntax
Properties→
<ScheduleOff
[ CommentText = String ]
( IsDeleted = Boolean )
[ IsOpenShift = Boolean ]
ShiftCodeName = String
[ ShiftTypeName = String ]
StartDate = Date >
( <Comments>
<Comment>∗
</Comments> )
[ <Employee>
<CurrentUser> | <PersonIdentity>
</Employee> ]
<ShiftSegments>
<ShiftSegment>∗
</ShiftSegments>
</ScheduleOff>
Property Descriptions
Comments
Comments
The set of comments currently returned with this timekeeping item
Type: Zero or more Comment tags
Output only
Introduced in v5.0
CommentText
Comment text
A text string that is attached to the shift, rather than to a shift segment. The
comment must be applicable for this category.
Type: String
Optional
Maximum length: 254 characters
Must match exactly an applicable comment that already exists in the database.
The string matching is case-sensitive.
You can find values in the Workforce Timekeeper Setup Application.
Introduced in v5.0
Employee
Employee
One employee who is assigned to the shift, as specified in a PersonIdentity or
CurrentUser tag.
Type: Either CurrentUser or PersonIdentity tag
Optional
Must uniquely identify an existing and active employee
Introduced in v4
IsDeleted
Is the item inactive?
Indicates whether the item is active.
ShiftStartDate is required when you delete all scheduled shifts, import a shift,
insert a break, insert a transfer, import an off day, or import an off shift.
Type: Date
Required
Introduced in v4; last changed in v5.0
SchedulePattern Tag
Schedule Pattern
The SchedulePattern tag describes a schedule pattern.
Used by: Schedule
Function Access Control Point: API.Schedule
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"AddPatternElements" |
"Delete" |
"Load" |
"LoadAllPatterns" |
"LoadTemplatePatterns" |
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<SchedulePattern
[ AnchorDate = Date ]
[ Description = String ]
( EffectiveDateSpan = DateSpan )
( Employee = String )
[ IsTemplateFlag = Boolean ]
[ PeriodCodeName = String ]
[ PeriodLength = Integer ]
( PeriodLengthInDays = Integer )
( ScheduleGroupName = String )
SchedulePatternName = String >
[ <PatternElements>
<PatternElement>∗
</PatternElements> ]
</SchedulePattern>
Action Descriptions
AddPatternElements
Adds a list of specified pattern elements to an existing pattern or adds a new
pattern if one does not already exist
If a pattern is added, it must be a template pattern.
Return Value Type: None
Required Properties: SchedulePatternName
Access Control Point Name: Edit
Introduced in v4
Delete
Marks a pattern for deletion
Must be a template pattern
Return Value Type: None
Required Properties: SchedulePatternName
Access Control Point Name: Edit
Introduced in v4
Load
Returns a single pattern by name
Return Value Type: SchedulePattern tag
Required Properties: SchedulePatternName
Access Control Point Name: View
Introduced in v4
LoadAllPatterns
Returns a list of defined patterns, including templates
Return Value Type: Zero or more SchedulePattern tags
Required Properties: None
Property Descriptions
AnchorDate
Start date for pattern
Specifies the date on which the pattern is scheduled to start
Type: Date
Optional
Introduced in v4
Description
Description
Describes the named pattern. A pattern can be associated with an anchor date and
assigned to one or more employees or groups of employees.
Type: String
Optional
Introduced in v4
EffectiveDateSpan
Date and time span for the pattern
The span of time that is designated for an instance of the pattern that is starting on
a specific anchor date and associated with a specific employee
Type: DateSpan
Output only
Introduced in v5.0
Employee
Employee
The PersonNumber for the specified employee
Type: String
Output only
Must uniquely identify an existing and active employee
Introduced in v5.0
IsTemplateFlag
Is the pattern a template?
Indicates whether this pattern is a template
Type: Boolean
Optional
Only Allowed Values: True, False
Introduced in v4
PatternElements
Pattern elements
Lists the elements that comprise the pattern
Type: Zero or more PatternElement tags
Optional
Introduced in v4
PeriodCodeName
Units of time period (days or weeks)
The unit of time used for the PeriodLength
Type: String
Optional
Maximum length: 10 characters
Only Allowed Values: Days, Weeks
Introduced in v4
PeriodLength
Number of units
SchedulePayCodeEdit Tag
Schedule Pay Code Edit
The SchedulePayCodeEdit tag represents a planned transfer of time or money
between labor accounts.
Used by: Schedule
The ScheduleGroupName and the Employee are mutually exclusive. One must be
specified.
Function Access Control Point: API.Schedule
Introduced in v4; last changed in v5.1
Syntax
Properties→
<SchedulePayCodeEdit
AmountInCurrency = Currency
AmountInTime = TimeDuration
AmountInTimeOrCurrency = String
[ CommentText = String ]
DisplayTime = Time
( IsDeleted = Boolean )
[ IsOverride = Boolean ]
[ IsOverrideAccrual = Boolean ]
[ IsPartialOverride = Boolean ]
[ LaborAccountName = String ]
[ OrgJobPath = String ]
[ PayCodeName = String ]
[ StartDate = Date ]
[ UnavailableDuration = TimeDuration ]
[ UnavailableStartTime = Time ] >
( <Comments>
<Comment>∗
</Comments> )
[ <Employee>
<CurrentUser> | <PersonIdentity>
</Employee> ]
</SchedulePayCodeEdit>
Property Descriptions
AmountInCurrency
Amount of pay code, in currency
The amount of the pay code edit, expressed as currency.
Dependency: If AmountInCurrency is specified, the associated PayCodeName
must match.
Type: Currency
See group( AccrualAmount)
Must be between 0 and 999
Introduced in v4
AmountInTime
Amount of pay code, in time
The amount of the pay code edit, expressed as a time value. If AmountInTime is
specified, the associated PayCodeName must match.
Type: TimeDuration
See group( AccrualAmount)
Must be between 00:00 and 100:00
Introduced in v4
AmountInTimeOrCurrency
Amount of pay code
The amount of the pay code edit, in time or currency, expressed as string, and
convert the string to Timeduration or Currency based on amount type of pay code
Type: String
See group( AccrualAmount)
Introduced in v5.0; last changed in v5.0.a
Comments
Comments
The set of comments that are returned with this timekeeping item
Type: Zero or more Comment tags
Output Only
Introduced in v4
CommentText
Comment text
A comment string that is attached to the scheduled pay code edit.
Type: String
Optional
Maximum length: 254 characters
Must match exactly an applicable comment that already exists in the database.
The string matching is case-sensitive.
You can find values in the Workforce Timekeeper Setup Application.
Introduced in v4; last changed in v5.0
DisplayTime
Time to display in the user interface
The start time of the scheduled pay code edit.
Type: Time
Required
Introduced in v4; last changed in v5.0
Employee
Employee
Either a PersonIdentity or CurrentUser tag. Specifies the employee assigned to the
paycode edit.
Type: Either CurrentUser or PersonIdentity tag
Optional
Must uniquely identify an existing and active employee.
Introduced in v5.0
IsDeleted
Is the item inactive?
You do not have to enter values for any labor levels that are not changing. For
example, you can enter 101//303////, indicating that only the first and third labor
level entries are different.
If any of the labor levels should stay the same as the employeeís primary labor
account, you can enter @H for those labor levels instead of entering the labor
entry names.
Type: String
Optional
Maximum length: 356 characters.
Introduced in v4; last changed in v5.1
OrgJobPath
Location of job in the organization
The organizational job path of the employee whose scheduled pay code edit is
being imported.
Enter data for OrgJobPath in the same format as it appears in the database. The
OrgJobPath string matching is case-sensitive on a Workforce Central server that
connects to an Oracle database. @P is a short-hand of employee's primary job.
Required: If you are adding a comment to a scheduled pay code edit that had an
explicit value for OrgJobPath when it was imported
Type: String
Optional
Maximum length: 1000 characters
Dependency: This is required if the scheduled pay code edit applies to an
organizational job other than the employee's primary organizational job.
Introduced in v5.0
PayCodeName
Pay code
The pay code that is associated with the pay code edit
Type: String
Optional
SchedulePeriod Tag
Schedule Period
The SchedulePeriod tag defines the length of time to be used for the previous,
current, and next schedule periods.
Function Access Control Point: API.Schedule
Introduced in v5.0; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"Delete" |
"Load" |
"LoadAllPeriods" |
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<SchedulePeriod
[ Description = String ]
PeriodCodeName = String
PeriodLength = Integer
SchedulePeriodName = String
StartDate = Date />
Action Descriptions
Delete
Marks an existing schedule period for deletion
Return Value Type: None
Required Properties: SchedulePeriodName
Property Descriptions
Description
Description
Describes the schedule period
Type: String
Optional
Maximum length: 250 characters
Introduced in v5.0
PeriodCodeName
Units for time period (days or months)
The unit of time used for the PeriodLength
Type: String
Required
Only Allowed Values: Days, Weeks
Default Value: Days
Introduced in v5.0
PeriodLength
Number of units
ScheduleShift Tag
Shift from Schedule
The ScheduleShift tag represents a schedule item that has a contiguous span of
time for a single employee or group.
Used by: Schedule if you add it to the ScheduleItems property list
The ScheduleGroupName and the Employee are mutually exclusive. One must be
specified.
Function Access Control Point: API.Schedule
Introduced in v4; last changed in v5.0
Syntax
Properties→
<ScheduleShift
[ CommentText = String ]
( IsDeleted = Boolean )
[ IsOpenShift = Boolean ]
[ OrgJobPath = String ]
[ ScheduleGroupName = String ]
ShiftCodeName = String
[ ShiftTypeName = String ]
StartDate = Date >
( <Comments>
<Comment>∗
</Comments> )
[ <Employee>
<CurrentUser> | <PersonIdentity>
</Employee> ]
<ShiftSegments>
<ShiftSegment>∗
</ShiftSegments>
</ScheduleShift>
Property Descriptions
Comments
Comments
An inactive shift is one that has been deleted from an inherited shift item or from a
pattern. It displays in the user interface with the text stuck through; it can be
restored. This does not apply to an ad hoc shift item, which is deleted. It does not
display in the user interface and cannot be restored.
Type: Boolean
Output only
Only Allowed Values: True, False
Introduced in v5.0
IsOpenShift
Is this an open shift?
Specifies whether the shift is open. If True, the shift is open.
Type: Boolean
Optional
Only Allowed Values: True, False
Introduced in v5.0
OrgJobPath
Location of job in the organization
Contains the organizational job path to which the employee is transferring.
The OrgJobPath is case-sensitive if your Workforce Central data resides on an
Oracle database.
Required: When the pay code edits, historical edit, or totaled amount being
deleted or commented contained an explicit OrgJobName value
Required: When adding a shift that does not apply to the employee's primary
organizational job.
Dependency: When inserting a transfer within a shift or adding an off shift, you
must specify a value for LaborAccountName, WorkRuleName, or OrgJobPath.
Type: String
Optional
Maximum length: 1000 characters
Introduced in v5.0
ScheduleGroupName
Schedule group name
The name of the schedule group to which the members of the group are assigned.
Specify either ScheduleGroupName or Employee, but not both.
Type: String
Optional
Maximum length: 30 characters
You can find values in the Workforce Timekeeper user interface.
Introduced in v4
ShiftCodeName
Shift code name
The name of a shift template
Type: String
See group( ShiftCodeSegment)
Maximum length: 50 characters
Must be an existing shift code name
You can find values in the Workforce Timekeeper user interface.
Introduced in v4
ShiftSegments
Segments in shift
The set of segments that comprise the shift code schedule
Type: Zero or more ShiftSegment tags
See group( ShiftCodeSegment)
Introduced in v4
ShiftTypeName
Shift Type
How the shift is displayed
Type: String
Optional
Maximum length: 30 characters
Only Allowed Values: Work Shift, Displayed Unavailable Day, Hide this Shift,
Scheduled Pay Code Edit, Hidden Work Shift, Hidden Unavailable Day, Hidden
Pay Code Edit, Displayed Off Day, Hidden Off Day, Accrual Amount, Hidden
Accrual Amount
Introduced in v4
StartDate
Start date of shift
Contains information that depends on the action you are taking as follows:
• If the action is to delete all scheduled shifts, pay codes, and off days that begin
on the specified date, it contains the start date of the shift, pay code, or off day
being deleted.
• If the action is to begin importing a new shift, it contains the start date of the
shift being imported.
• If the action is to insert a break in a shift, it contains the start date of the break
being imported.
• If the action is to insert a transfer in a shift, it contains the start date of the
transfer being imported.
• If the action is to import a new off day, it contains the start date of the off day
being imported.
• If the action is to delete all scheduled shifts and off days that begin on the
specified date, it contains the start date of the shift or off day being deleted.
• If the action is to add an off shift (a shift for an off day on which a person is
available to work, if necessary), it contains the start date of the off shift being
imported.
Required: If you delete all scheduled shifts, import a shift, insert a break, insert a
transfer, import an off day, or import an off shift
Type: Date
Required
ScheduleShiftSwap Tag
Existing Shift
The ScheduleShiftSwap tag contains an existing shift for actions on schedules that
operate on shifts, but do not add new ones.
Used by: Process
Function Access Control Point: API.Schedule
Introduced in v5.0; last changed in v5.1
Syntax
Properties→
<ScheduleShiftSwap
EndDate = Date
EndTime = Time
StartDate = Date
StartTime = Time >
<Employee>
<CurrentUser> | <PersonIdentity>
</Employee>
</ScheduleShiftSwap>
Property Descriptions
Employee
Employee
One employee who is assigned to the shift, as specified in a PersonIdentity or
CurrentUser tag.
Type: Either CurrentUser or PersonIdentity tag
Required
Must uniquely identify an existing and active employee
Introduced in v5.0
EndDate
End date
End date for shift
Type: Date
Required
Introduced in v5.1
EndTime
End of the shift
The end of the identified shift
Type: Time
Required
Introduced in v5.0
StartDate
Start date for shift
The start date of the identified shift
Type: Date
Required
Introduced in v5.0
StartTime
Start time for shift
The time when the identified shift starts
Type: Time
Required
Introduced in v5.0
ScheduleUnavailable Tag
Unavailable Schedule Period
The ScheduleUnavailable tag is a schedule item that describes a schedule period
when a person or group is not available for work.
Used by: Schedule if you add it to the ScheduleItems property list
Function Access Control Point: API.Schedule
Introduced in v4; last changed in v5.0
Syntax
Properties→
<ScheduleUnavailable
[ CommentText = String ]
EndDate = Date
EndTime = Time
( IsDeleted = Boolean )
( IsLockedFlag = Boolean )
[ ScheduleGroupName = String ]
StartDate = Date
StartTime = Time >
( <Comments>
<Comment>∗
</Comments> )
[ <Employee>
<CurrentUser> | <PersonIdentity>
</Employee> ]
</ScheduleUnavailable>
Property Descriptions
Comments
Comments
The set of comments currently returned with this unavailable shift
Type: Zero or more Comment tags
Output only
Introduced in v5.0
CommentText
Comment text
A text string that is attached to the shift, rather than to a shift segment. The
comment must be applicable for this category.
Type: String
Optional
Maximum length: 254 characters
String matching is case-sensitive.
You can find values in the Workforce Timekeeper Setup Application.
Introduced in v5.0
Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, who is
unavailable.
Type: Either CurrentUser or PersonIdentity tag
Optional
Must uniquely identify an existing and active employee
Introduced in v4
EndDate
End date of unavailable period
The end date of the unavailable period
Type: Date
Required
StartDate must be less than or equal to EndDate
Introduced in v4
EndTime
End time of unavailable period
The end time associated with the EndDate of the unavailable period
Type: Time
Required
If StartDate is the same as EndDate, then StartTime must be less than EndTime
Introduced in v4
IsDeleted
Is the schedule item inactive?
Indicates whether the item is active.
• If False, the item is active.
• If True, it is currently inactive.
An inactive shift is one that has been deleted from an inherited shift item or from a
pattern. It displays in the user interface with the text stuck through; it can be
restored. This does not apply to an ad hoc shift item, which is deleted. It does not
display in the user interface and cannot be restored.
Type: Boolean
Output only
Only Allowed Values: True, False
Introduced in v5.0
IsLockedFlag
Is the schedule item locked?
True if the schedule item has been locked. A schedule might be locked because
the timecard has been signed off.
Type: Boolean
Output Only
Only Allowed Values: True, False
Introduced in v4; last changed in v5.0
ScheduleGroupName
Schedule group name
The name of the schedule group to which the person is currently assigned
Type: String
Optional
Maximum length: 30 characters
You can find values in the Workforce Timekeeper user interface.
Introduced in v4
StartDate
Start date
Contains information that depends on the action you are taking as follows:
• If the action is to delete all scheduled shifts, pay codes, and off days that begin
on the specified date, it contains the start date of the shift, pay code, or off day
being deleted.
• If the action is to begin importing a new shift, it contains the start date of the
shift being imported.
• If the action is to insert a break in a shift, it contains the start date of the break
being imported.
• If the action is to insert a transfer in a shift, it contains the start date of the
transfer being imported.
• If the action is to import a new off day, it contains the start date of the off day
being imported.
• If the action is to delete all scheduled shifts and off days that begin on the
specified date, it contains the start date of the shift or off day being deleted.
• If the action is to add an off shift (a shift for an off day on which a person is
available to work, if necessary), it contains the start date of the off shift being
imported.
Required: If you delete all scheduled shifts, import a shift, insert a break, insert a
transfer, import an off day, or import an off shift.
Type: Date
Required
Must be within the date span of the containing schedule.
Introduced in v4; last changed in v5.0
StartTime
Start time
Contains information that depends on the action being taken, as follows:
• If you begin importing a new shift, it contains the start time of the shift being
imported.
• If you insert a break in a shift, it contains the start time of the break being
imported.
• If you insert a transfer in a shift, it contains the start time of the transfer being
imported.
• If you import a new off day, the start time of the off day being imported.
• If you add an off shift (a shift for an off day on which a person is available to
work, if necessary), the start time of the off shift being imported.
This column is required whenever you import a shift, insert a break in a shift,
insert a transfer in a shift, or import an off shift. It is optional when importing an
off day. If you do not specify a value, the off day start time defaults to the start of
the day.
If you specify StartTime, you must have previously specified the
UserAccountStatusName in the UserAccountStatus tag.
Type: Time
Required
If StartDate is the same as EndDate, then StartTime must be less than EndTime.
Introduced in v4; last changed in v5.0
ScheduleZone Tag
Schedule Zone
The ScheduleZone tag identifies a period of time during a day for which coverage
is measured; for example, the Day schedule zone can be defined as 7 A.M. to 3
P.M.
Used by: ScheduleZoneSet
Function Access Control Point: API.Schedule
Introduced in v5.0
Syntax
Properties→
<ScheduleZone
BeginTime = Time
EndTime = Time
[ ZoneDescription = String ]
ZoneName = String />
Property Descriptions
BeginTime
Start time
The starting time for a zone time span
Type: Time
Required
Introduced in v5.0
EndTime
End time
The ending time for a zone time span
Type: Time
Required
Introduced in v5.0
ZoneDescription
Description of schedule zone
Describes the schedule zone
Type: String
Optional
Maximum length: 250 characters
Introduced in v5.0
ZoneName
Schedule zone name
The name of a schedule zone
Type: String
Required
Maximum length: 30 characters
You can find values in the Workforce Timekeeper user interface under the
Scheduler Setup Workload Setup menu.
Sample values: Morning, Evening, 7AM-3PM
Introduced in v5.0
ServerTime Tag
Server Date and Time
The ServerTime tag represents the date, time, and time zone of the Workforce
Timekeeper server.
Function Access Control Point: API.Audit
Introduced in v4
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "GetServerTime"
Properties→
<ServerTime
( DateTime = DateTime )
( KronosTimeZone = String ) />
Action Descriptions
GetServerTime
Returns the server's date, time, and timezone.
Return Value Type: ServerTime tag
Access Control Point Name: View
Introduced in v4
Property Descriptions
DateTime
Date and time at the server
The date and time of the server
Type: DateTime
Output Only
Introduced in v4
KronosTimeZone
Time zone at the server
Time zone at the server
Type: String
Output Only
Maximum length: 30 characters
For a list of values, see ìTime Zone Definitionsî in Appendix B in the Workforce
Timekeeper DTK Reference Guide.
Introduced in v4
ShiftBuilder Tag
Build Employee Schedule
The ShiftBuilder tag represents a schedule builder background process that uses
an employee's schedule pattern to populate future employee schedules.
Function Access Control Point: API.Schedule
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
BuildShifts
Invokes the shift builder process
Return Value Type: None
Access Control Point Name: Edit
Introduced in v4
LoadPopulatedThroughDate
To get the PopulatedThroughDate.
Return Value Type: None
Access Control Point Name: View
Introduced in v5.1Beta; last changed in v5.1
Property Descriptions
PopulatedThroughDate
Populated Through Date
The populated through date
Type: Date
Output only
none
Introduced in v5.1Beta
UserName
User name
The name of the user who starts the Schedule Builder
Type: String
Optional
Introduced in v4
ShiftCode Tag
Named Shift
The ShiftCode tag describes a named shift. It can be used for group or individual
shifts, or as a template for generating shifts.
Function Access Control Point: API.Schedule
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"Delete" |
"Load" |
"LoadAllShiftCodes" |
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<ShiftCode
[ Description = String ]
[ Label = String ]
ShiftCodeName = String >
[ <ShiftSegments>
<ShiftSegment>∗
</ShiftSegments> ]
</ShiftCode>
Action Descriptions
Delete
Marks the specified shift code for deletion
Return Value Type: None
Property Descriptions
Description
Description of Shift Code
Describes the shift code
Type: String
Optional
Maximum length: 100 characters
Introduced in v4
Label
Label for Shift Code
The shift code label that displays in the user interface
Type: String
Optional
Maximum length: 30 characters
Introduced in v4
ShiftCodeName
Shift code name
The shift that can be generated by the system
Type: String
Required,
Maximum length: 50 characters
Contributes to Uniqueness: Yes
Introduced in v4
ShiftSegments
Segments in shift
The set of segments that comprise the specified shift code
Type: Zero or more ShiftSegment tags
Optional
Introduced in v4
ShiftCountSpan Tag
Shift Count Exceptions
The ShiftCountSpan tag identifies exceptions to the default counting rules. An
exception occurs when a default counting rule is not used for a shift, but the
majority rule is used instead.
Function Access Control Point: API.Schedule
Introduced in v5.0
Syntax
Properties→
<ShiftCountSpan
BeginTime = Time
EndTime = Time />
Property Descriptions
BeginTime
Start time
The starting time for a shift count span
Type: Time
Required
Introduced in v5.0
EndTime
End time
The ending time for a shift count span
Type: Time
Required
Introduced in v5.0
ShiftSegment Tag
Shift Segment
The ShiftSegment tag represents shift-related information for a single time span.
Used by: ScheduleOff, ScheduleShift, and ShiftCode
Function Access Control Point: API.Schedule
Introduced in v4; last changed in v5.0
Syntax
Properties→
<ShiftSegment
EndDayNumber = Integer
EndTime = Time
[ LaborAccountName = String ]
[ OrgJobPath = String ]
[ SegmentTypeName = String ]
StartDayNumber = Integer
[ StartTime = Time ]
[ WorkRuleName = String ] />
Property Descriptions
EndDayNumber
Offset for end day in shift
The day offset of the segment end within its shift
Type: Integer
Required
StartDayNumber must be less than or equal to EndDayNumber
Introduced in v4
EndTime
End time
The segment end time within its end day
Type: Time
Required
If StartDayNumber is the same as EndDayNumber, then StartTime must be less
than EndTime.
Introduced in v4
LaborAccountName
Labor account
This is the name of the labor account to charge for this activity.
Enter data for labor accounts in the same format as they appear in the Workforce
Timekeeper database. If you have a seven-level labor account, specify a value for
each labor level, using the following format: 101/202/303/404/504/603/702
Do not specify labor levels that are not changing.
Type: String
Optional
Maximum length: 356 characters
Introduced in v4
OrgJobPath
Location of job in the organization
Contains the organizational job path to which the employee is transferring.
OrgJobPath is optional when you import a shift, insert a transfer, import an off
day, or import an off shift. When adding a shift, it can be left blank if the shift
being added applies to the employee's primary organizational job. When inserting
a transfer within a shift or adding an off shift, you must specify a value
LaborAccountName, WorkRuleName, or OrgJobPath.
Enter data for OrgJobPath in the same format as it appears in the database. The
OrgJobPath string matching is case-sensitive on a Workforce Central server that
connects to an Oracle database.
Type: String
Optional
Maximum length: 1000 characters
Introduced in v5.0
SegmentTypeName
Segment Type
The type of activity that the segment represents
Type: String
Optional
Maximum length: 30 characters
Only Allowed Values: Regular, Unavailable, Transfer, Break, Off, Regular
PCE, Availability PCE, Accrual Edit
Default Value: Regular
Introduced in v4
StartDayNumber
Offset for start day in shift
The day offset of the segment within its shift
Type: Integer
Required
StartDayNumber must be less than or equal to EndDayNumber
Introduced in v4
StartTime
Start time
Contains information that depends on the action being taken, as follows:
• If you begin importing a new shift, it contains the start time of the shift being
imported.
• If you insert a break in a shift, it contains the start time of the break being
imported.
• If you insert a transfer in a shift, it contains the start time of the transfer being
imported.
• If you import a new off day, the start time of the off day being imported.
• If you add an off shift (a shift for an off day on which a person is available to
work, if necessary), the start time of the off shift being imported.
This column is required whenever you import a shift, insert a break in a shift,
insert a transfer in a shift, or import an off shift. It is optional when importing an
off day. If you do not specify a value, the off day start time defaults to the start of
the day.
Type: Time
Optional
Maximum length: 15 characters
If StartDate is the same as EndDate, then StartTime must be less than EndTime.
Dependency: If you specify StartTime, you must have previously the
UserAccountStatusName in the UserAccountStatus tag.
Introduced in v4; last changed in v5.0
WorkRuleName
Work rule
Name of the work rule that describes the activity
Workforce provides the following predefined data values:
• &ALL_WORK_RULES
• &EMPTY
Type: String
Optional
Maximum length: 50 characters
You can find values in the Workforce Timekeeper Application Setup.
Introduced in v4
ShiftStartTimeBand Tag
Shift Start Time Band
The ShiftStartTimeBand tag describes a named start time of the shift.
Function Access Control Point: API.Schedule
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"addOnly" |
"deleteOnly" |
"retrieve" |
"retrieveAll" |
"update" |
"updateOnly"
Properties→
<ShiftStartTimeBand
[ ActiveSwitch = Boolean ]
DisplayName = String
Name = String
[ NewName = String ]
StartTime = Time />
Action Descriptions
addOnly
Stores shift start band in the database. Returns an error if object with the same
name exists
Validate all properties including optional
Return Value Type: Boolean
Property Descriptions
ActiveSwitch
Is the band active?
The active band flag.
Type: Boolean
Optional
Introduced in v5.1
DisplayName
Name to display in the user interface
The shift start time band display name
Type: String
Required
Can not be null and should contain between 1 and 50 characters.
Introduced in v5.1
Name
Name of band
The shift start time band name
Type: String
Required
The value can not be null and should contain from 1 to 50 characters.
Introduced in v5.1
NewName
New Name
The new name of the shift strt time band ( for update action only)
Type: String
Optional
Can not be null and should contain between 1 and 30 characters.
Introduced in v5.1
StartTime
Start Time
The shift start time (required for add, optional for update)
Type: Time
Required
Can not be null
Introduced in v5.1
ShiftTemplateAssignment Tag
Shift Template Profiles Assigned to Employees
The ShiftTemplateAssignment tag consists of one or more shift template profiles
for one employee who has been identified in the ShiftTemplateItem.
Function Access Control Point: API.Schedule
Introduced in v5.1Beta
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
Load
Returns all shift template profiles for the employee specified in the
ShiftTemplateItem tag.
All ShiftTemplateItem tags that are returned must identify the same existing
employee.
Return Value Type: ShiftTemplateAssignment tag
Required Properties: ShiftTemplateItems
Access Control Point Name: View
Introduced in v5.1Beta
LoadAll
Loads all shift template profiles in the system.
Return Value Type: Zero or more ShiftTemplateItem tags
Required Properties: none
Access Control Point Name: View
Introduced in v5.1Beta
Update
Updates a person's shift template profile.
Return Value Type: None
Required Properties: ShiftTemplateItems
Access Control Point Name: Edit
Introduced in v5.1Beta
Property Descriptions
ShiftTemplateItems
Shift template profile items
One or more shift template assignments, as shown in the ShiftTemplateItem tag.
Type: One or more ShiftTemplateItem tags
Required
Introduced in v5.1Beta
ShiftTemplateItem Tag
Shift Template Item
The ShiftTemplateItem tag defines an element of a shift template profile
assignment.
Function Access Control Point: API.Schedule
Introduced in v5.1Beta; last changed in v5.0.a
Syntax
Properties→
<ShiftTemplateItem
[ ShiftTemplateProfileName = String ] >
<Employee>
<PersonIdentity>
</Employee>
</ShiftTemplateItem>
Property Descriptions
Employee
Employee
The employee to whom the shift code template profile is assigned
Type: PersonIdentity tag
Required
Must be a unique and existing employee
Contributes to Uniqueness: Yes
Introduced in v5.1Beta
ShiftTemplateProfileName
Shift template profile name
The name of an existing shift code profile
Type: String
Optional
ShiftValidation Tag
Shift Validation
The ShiftValidation tag determines if a shift has been assigned to an identified
employee within a specified date and time range.
Function Access Control Point: API.Schedule
Introduced in v5.1Beta; last changed in v5.0.a
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Load"
Properties→
<ShiftValidation
EndTime = Time
( IsShiftExists = Boolean )
QueryDate = Date
StartTime = Time >
<Employee>
<PersonIdentity>
</Employee>
</ShiftValidation>
Action Descriptions
Load
The Load action returns the ShiftValidation tag. The IsShiftExists property will
have a value of True if the shift exists.
Return Value Type: ShiftValidation tag
Required Properties: QueryDate, StartTime, EndTime, Employee
Access Control Point Name: View
Introduced in v5.1Beta
Property Descriptions
Employee
Employee
One employee, as specified in a PersonIdentity tag
Type: PersonIdentity tag
Required
Must uniquely identify an existing and active employee
Contributes to Uniqueness: Yes
Introduced in v5.1Beta
EndTime
End time
The time when the shift ends
Type: Time
Required
Introduced in v5.1Beta
IsShiftExists
Is shift assigned to employee?
Indicates whether a shift as been assigned to the employee for the specified date
and time range. A value of true means there is such an assignment.
Type: Boolean
Output only
Introduced in v5.1Beta
QueryDate
Shift start date
The date when the shift starts
Type: Date
Required
Introduced in v5.1Beta
StartTime
Start time
The time when the shift begins
Type: Time
Required
Introduced in v5.1Beta
SimpleValue Tag
Simple Value
The SimpleValue tag contains a single primitive value. This tag is used mainly
when an action returns a primitive type, such as Integer or String.
Function Access Control Point: API.Common
Introduced in v4
Syntax
Properties→
<SimpleValue
Value = String />
Property Descriptions
Value
Value
A primitive value whose format depends on the action or property that returns it,
and can represent an alphanumeric string, an integer, or a boolean type.
Type: String
Required
This property represents one value.
Introduced in v4
StandardShift Tag
Standard Shift
The StandardShift tag describes a named time span.
Used by: StandardShiftSet
Function Access Control Point: API.Schedule
Introduced in v5.0
Syntax
Properties→
<StandardShift
BeginTime = Time
EndTime = Time
[ ShiftDescription = String ]
ShiftName = String />
Property Descriptions
BeginTime
Start time
The starting time for the shift
Type: Time
Required
Introduced in v5.0
EndTime
End time
The ending time for the shift
Type: Time
Required
Introduced in v5.0
ShiftDescription
Description
Describes the shift
Type: String
Optional
Maximum length: 250 characters
Introduced in v5.0
ShiftName
Shift name
The name of the shift
Type: String
Required
Maximum length: 30 characters
You can find values in the Workforce Timekeeper user interface under the
Scheduler Setup Workload Setup menu.
Introduced in v5.0
SuiteProduct Tag
Product in Suite
The SuiteProduct tag provides license information about products in the
Workforce Central suite.
The product that is specified must be defined to the system, but need not be
installed.
Function Access Control Point: API.Person
Introduced in v5.0; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<SuiteProduct
( IndependentProductSw = Boolean )
( InstalledSw = Boolean )
( LicensedSw = Boolean )
[ SuiteProductName = String ]
( Version = String ) />
Action Descriptions
LoadAll
Returns information about all suite products in the system.
Return Value Type: Zero or more SuiteProduct tags
Access Control Point Name: View
Introduced in v5.0
LoadByName
Returns information about the requested suite product.
Property Descriptions
IndependentProductSw
Is this a standalone product?
Specifies whether the product is part of Workforce Central or is independent
Type: Boolean
Output only
Only Allowed Values: True, False
Introduced in v5.0
InstalledSw
Is the product installed?
Specifies whether the product is installed
Type: Boolean
Output only
Only Allowed Values: True, False
Introduced in v5.0
LicensedSw
Is the product licensed?
Specifies whether the suite is licensed
Type: Boolean
Output only
Only Allowed Values: True, False
Introduced in v5.0
SuiteProductName
Suite product name
The name of the suite product for which information is requested
Type: String
Optional
Introduced in v5.0
Version
Version of suite product
The version of the suite product.
Type: String
Output only
Introduced in v5.0
Supervisor Tag
Person Employee Reports To
The Supervisor tag identifies the person who is defined as the supervisor for the
containing tag. This name specified in this tag is not related to any system rights.
Used by: PersonInformation
Function Access Control Point: API.Person
Introduced in v4; last changed in v5.1
Deprecated in v5.0: Use the SupervisorName property in the
JobAssignmentDetails tag instead.
Syntax
Properties→
<Supervisor
[ FullName = String ]
[ PersonNumber = String ] />
Property Descriptions
FullName
Full name
The name of the person's manager. Specify the name as last name, comma, space,
first name, space, middle initial.
Type: String
Optional
Maximum length: 64 characters
Introduced in v4; last changed in v5.1
Deprecated in v5.0: Use the SupervisorName property in the
JobAssignmentDetails tag instead.
PersonNumber
Person number
SwapShiftEmployees Tag
Employees Eligible for Swap Shifts
The SwapShiftEmployees tag contains information about an employee who can
swap a shift with another shift.
Must be an active employee.
The specified shift must be exist.
Function Access Control Point: API.Schedule
Introduced in v5.1Beta
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "LoadEligibleEmployees"
Properties→
<SwapShiftEmployees
EndTime = Time
QueryDate = Date
StartTime = Time >
<Employee>
<PersonIdentity>
</Employee>
</SwapShiftEmployees>
Action Descriptions
LoadEligibleEmployees
This action returns one or more employees who can swap with the specified shift.
Return Value Type: Zero or more Person tags
Required Properties: Employee, QueryDate, StartTime, EndTime
Access Control Point Name: View
Introduced in v5.1Beta
Property Descriptions
Employee
Employee
One employee, as specified in a PersonIdentity tag.
Type: PersonIdentity tag
Required
Must uniquely identify an existing and active employee. If the employee has
a Workforce_Scheduler_Employee license and specifies True for
IsCreateOpenShift, you will be able to create open shifts. Otherwise
IsCreateOpenShift will have no effect.
Introduced in v5.1Beta
EndTime
Shift end time
The end time for the shift that needs to be swapped
Type: Time
Required
Introduced in v5.1Beta
QueryDate
Shift start date
The start date for a shift that can be swapped.
Type: Date
Required
Introduced in v5.1Beta
StartTime
Shift start time
Start time for the shift that can be swapped.
Type: Time
Required
Introduced in v5.1Beta
SwapShiftJobs Tag
Jobs Eligible for Swap Shifts
This tag returns job list for a shift swap.
Function Access Control Point: API.Schedule
Introduced in v5.1Beta; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "LoadJobs"
Properties→
<SwapShiftJobs
EndTime = Time
QueryDate = Date
StartTime = Time >
<Employee>
<PersonIdentity>
</Employee>
( <OrgJobs>
<OrgJob>∗
</OrgJobs> )
</SwapShiftJobs>
Action Descriptions
LoadJobs
This action returns one or more jobs for the shift within the specified date and
time span.
Return Value Type: Zero or more OrgJob tags
Access Control Point Name: View
Introduced in v5.1Beta
Property Descriptions
Employee
Employee
One employee, as specified in a PersonIdentity tag.
Type: PersonIdentity tag
Required
Must uniquely identify an existing and active employee.
Introduced in v5.1Beta
EndTime
Shift end time
This property is the end time of a shift.
Type: Time
Required
Introduced in v5.1Beta
OrgJobs
Organization jobs
This property is a tag list property that represent a list of organization jobs.
Type: Zero or more OrgJob tags
Output only
Introduced in v5.1Beta; last changed in v5.1
QueryDate
Shift start date
This property is the start date of a shift.
Type: Date
Required
Introduced in v5.1Beta
StartTime
Shift start time
SystemSettings Tag
System Settings
The SystemSettings tag returns the value of system settings on the application
server. For a description of system settings, see the online help (System
Configuration > System Settings).
If the requested system settings do not exist, a list of null values is returned.
Function Access Control Point: APIBeans.COMMON
Introduced in v5.0; last changed in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Actions→ "Load"
Parameters→
KeyNames = String
Properties→
<SystemSettings
( Key = String )
( Value = String ) />
Action Descriptions
Load
Returns system settings that match parameter values. There can be more than one
system setting that matches a parameter. For example, a parameter of site.local
would return all site.local.* system settings.
Return Value Type: Zero or more SystemSettings tags
Access Control Point Name: View
Introduced in v5.0
Action Parameters
Property Descriptions
Key
Key for the the system setting
A unique key for a system setting
Type: String
Output only
Sample values: site.locale
Introduced in v5.0
Value
Value for the system setting
The value of a requested system setting.
Type: String
Output only
Introduced in v5.0; last changed in v5.1
TelephoneNumber Tag
Telephone Number
The TelephoneNumber tag defines a person's telephone number.
Used by: PersonInformation
Function Access Control Point: API.Person
Introduced in v4; last changed in v5.1
Syntax
Properties→
<TelephoneNumber
ContactTypeName = String
PhoneNumber = String />
Property Descriptions
ContactTypeName
Type of contact
The name of the contact category; up to three telephone numbers can be provided:
Home Phone, Work Phone, Mobile Phone.
Type: String
Required
Maximum length: 30 characters
Sample values: Home Phone, Work Phone, Mobile Phone
Contributes to Uniqueness: Yes
Introduced in v4
PhoneNumber
Phone number
The telephone number for the specified contact type
Type: String
Required
Maximum length: 35 characters
A maximum of three phone numbers can be specified for a person in Workforce
Timekeeper.
Introduced in v4
TimeEntry Tag
Time Entry
The TimeEntry tag returns information about valid time entries defined within the
system. The Time Entry Method determines how a Workforce Employee will see
time when entering data.
Function Access Control Point: API.Employee
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<TimeEntry
[ TimeEntryId = Integer ]
[ TimeEntryName = String ] />
Action Descriptions
Load
Returns a time entry, based on TimeEntryName.
Name should be valid
Return Value Type: TimeEntry tag
Required Properties: TimeEntryName
Access Control Point Name: View
Introduced in v4
LoadAllTimeEntries
Returns all time entries in the system.
Property Descriptions
TimeEntryId
Id of time entry
Uniquely identifies the TimeEntryProfile in the database
Type: Integer
Optional
Introduced in v4
TimeEntryName
Time entry name
The name for the common set of TimeEntries that a group of employees can select
Type: String
Optional
Only Allowed Values: Timestamp, Timestamp & Hourly View, Hourly View,
Project View
Introduced in v4
TimeFramePeriod Tag
Time Frame for a Period of Time
The TimeFramePeriod tag describes a period of time.
Used by: a number of other tags
Function Access Control Point: API.Common
Introduced in v4; last changed in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "LoadAllTimeFrames"
Properties→
<TimeFramePeriod
[ PeriodDateSpan = DateSpan ]
[ TimeFrameDate = Date ]
TimeFrameName = String />
Action Descriptions
LoadAllTimeFrames
Returns all time frames in the system.
Only TimeFrameName is returned
Return Value Type: Zero or more TimeFramePeriod tags
Required Properties: None
Access Control Point Name: View
Introduced in v4
Property Descriptions
PeriodDateSpan
Span of dates
The start and end dates, dash separated, for the specified period
Type: DateSpan
Optional
For input, the value is the time span for the period. For output, the value is the
time span for the resulting information.
Introduced in v4
TimeFrameDate
Reference date
A date for a time span that requires a reference date
Type: Date
Optional
If the value of the TimeFrameName is Specific-Date, this property contains the
value of that date.
Introduced in v4
TimeFrameName
Time frame name
The name of the time frame
Specify one of the following numbers to represent the data value:
• 0 for Previous_Payperiod
• 1 for Current_Payperiod
• 2 for Next_Payperiod
• 3 for Previous_SchedPeriod
• 4 for Current_SchedPeriod
• 5 for Next_SchedPeriod
• 6 for Week_to_Date
• 7 for Last_Week
• 8 for Yesterday
• 9 for Range_of_Dates
• 11 for Specific_Date
• 13 for Today
Type: String
Required
Maximum length: 1 character
Only Allowed Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 13
Introduced in v4; last changed in v5.0
TimekeepingException Tag
Timekeeping Exception
The TimekeepingException tag describes an exception that occurred as a result of
a timekeeping exception rule such as late, early, or missing punch.
Used by: TotaledSpan, WorkedDuration
Function Access Control Point: API.Timecard
Introduced in v4
Syntax
Properties→
<TimekeepingException
( ActualNumberOfActiveDays = Integer )
( AssociatedWithInPunchFlag = Boolean )
( DifferenceToLimit = TimeDuration )
( DurationOfException = TimeDuration )
( ExceptionTypeName = String )
( MinimumNumberOfActiveDays = Integer )
( MissedOutDateTime = DateTime )
( NumberOfWorkedDays = Integer ) />
Property Descriptions
ActualNumberOfActiveDays
Number of active days
Meaningful only for MinimumDaysActive and MinimumDaysEmployed
timekeeping exceptions
Type: Integer
Output Only
Introduced in v4
AssociatedWithInPunchFlag
Is the exception associated with an in-punch?
Output Only
You can find values in the Workforce Timekeeper user interface.
Sample values: Canceled Deduction, Core Hours Violation, Early
Introduced in v4
MinimumNumberOfActiveDays
Minimum number of active days
The configured minimum
Meaningful only for MinimumDaysActive and MinimumDaysEmployed
exceptions.
Type: Integer
Output Only
Introduced in v4
MissedOutDateTime
Date and time of missed out-punch
The computed missed out time. Meaningful only for a MissedOut exception.
Type: DateTime
Output Only
Introduced in v4
NumberOfWorkedDays
Number of worked days
This value is meaningful only for a WorkHistory exception
Type: Integer
Output Only
Introduced in v4
Timesheet Tag
Timesheet
The Timesheet tag represents a set of timekeeping items for an employee and a
given period of days. (This is also referred to as a Timecard.) These include
punches, edits, and worked durations, and totalization output such as per period
summary, per day summaries, and exceptions.
Function Access Control Point: API.Timecard
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<Timesheet
( LastTotalizationDateTime = DateTime )
( ManagerSignoffDateTime = DateTime )
( TotalsUpToDateFlag = Boolean ) >
( <DailyTotals>
<DateTotals>∗
</DailyTotals> )
<Employee>
<CurrentUser> | <PersonIdentity>
</Employee>
<Period>
<TimeFramePeriod>
</Period>
( <PeriodTotalData>
<PeriodTotals>
</PeriodTotalData> )
( <TotaledPayCodeEdits>
<HistoricalPayCodeEdit>∗
<HistoricalPayCodeMove>∗
<LockedDataCorrection>∗
<OnCall>∗
<PayCodeEdit>∗
<PayCodeMove>∗
<Punch>∗
</TotaledPayCodeEdits> )
( <TotaledSpans>
<TotaledSpan>∗
</TotaledSpans> )
( <TotaledWorkedDurations>
<WorkedDuration>∗
</TotaledWorkedDurations> )
( <UntotaledPunches>
<Punch>∗
</UntotaledPunches> )
( <UntotaledWorkedDurations>
<WorkedDuration>∗
</UntotaledWorkedDurations> )
</Timesheet>
Action Descriptions
Load
Returns a timesheet containing everything known about timekeeping events for
the specified period and employee.
Return Value Type: Timesheet tag
Required Properties: Employee, Period
Access Control Point Name: View
Introduced in v4
LoadDailyTotals
Returns a timesheet whose daily totals contain the most recent totalization for the
specified period and employee.
Return Value Type: Timesheet tag
Required Properties: Employee, Period
Access Control Point Name: View
Introduced in v4
LoadPeriodTotals
Returns a timesheet whose period totals contain totals for the specified period and
employee.
Return Value Type: Timesheet tag
Required Properties: Employee, Period
Access Control Point Name: View
Introduced in v4
Property Descriptions
DailyTotals
Set of daily totals
A list of DateTotals tags for the number of days in the requested period
Type: Zero or more DateTotals tags
Output Only
Contains the number of days in the requested period. Each item is an instance of
DateTotals, and represents a summary total for the specified day.
Introduced in v4
Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, for whom the
action is requested.
Type: Either CurrentUser or PersonIdentity tag
Required
Must uniquely identify an existing and active employee
Introduced in v4
LastTotalizationDateTime
Date and time of last totalization
A server timestamp for the most recent totalization
Type: DateTime
Output Only
Introduced in v4
ManagerSignoffDateTime
Date and time of manager signoff
The date and time of the most recent manager signoff. If the employee has not yet
been signed off, this property is not returned.
Type: DateTime
Output Only
Introduced in v4
Period
Time period
The time period for the data being retrieved
Type: TimeFramePeriod tag
Required
Introduced in v4
PeriodTotalData
Totals for time period
Totals for the requested period
Type: PeriodTotals tag
Output Only
Introduced in v4
TotaledPayCodeEdits
Total of pay code edits
One or more pay code edits credited for the requested period. These are specified
in the PayCodeEdit, PayCodeMove, HistoricalPayCodeEdit,
HistoricalPayCodeMove. LockedDataCorrection, and OnCall tags.
Note: The Employee property is omitted from these tags.
Type: Any combination of HistoricalPayCodeEdit or HistoricalPayCodeMove or
LockedDataCorrection or OnCall or PayCodeEdit or PayCodeMove or Punch tags
Output Only
Introduced in v4
TotaledSpans
Totals for time spans
A list of TotaledSpan tags credited towards the requested period. Each
TotaledSpan must contain one or two Punch tags defining the span, along with
any TimekeepingException tags relevant to the span.
Note: No Employee tag is returned in the Punch tags, because all of the punches in
a timesheet apply to the employee associated with the Timesheet tag. Each Punch
includes a list of Comment tags, if the punch is associated with one or more
Timekeeing Comments.
Type: Zero or more TotaledSpan tags
Output Only
Introduced in v4
TotaledWorkedDurations
Total of worked durations
A list of WorkedDuration tags credited towards the requested period, each of
which can include a list of Comment tags and a list of TimekeepingException
tags.
Note: No Employee tag is returned in the WorkedDuration tags, because all of the
worked durations in a given timesheet apply to the employee associated with the
timesheet.
Type: Zero or more WorkedDuration tags
Output Only
Introduced in v4
TotalsUpToDateFlag
Are totals up to date?
Indicates whether totals are up to date. This value is True only if no punches or
edits have been made since the last totalization.
Type: Boolean
Output Only
Only Allowed Values: True, False
Introduced in v4
UntotaledPunches
Untotaled punches
A list of Punch tags that have not been totalized
Type: Zero or more Punch tags
Output Only
Introduced in v4
UntotaledWorkedDurations
Untotaled worked durations
A list of WorkedDuration tags that have not been totalized
Type: Zero or more WorkedDuration tags
Output Only
Introduced in v4
Total Tag
Total
The Total tag describes a total for a PayCode and LaborAccount pair.
Used by: EmployeeSummary, TotalSummary
Function Access Control Point: API.Timecard
Introduced in v4; last changed in v5.0
Syntax
Properties→
<Total
( AmountInCurrency = Currency )
( AmountInTime = TimeDuration )
( IsCurrencyFlag = Boolean )
( LaborAccountDescription = String )
( LaborAccountId = Long )
( LaborAccountName = String )
( OrgJobDescription = String )
( OrgJobId = Long )
( OrgJobName = String )
( PayCodeId = Long )
( PayCodeName = String ) />
Property Descriptions
AmountInCurrency
Amount of pay code, in currency
A pay code amount, expressed as a currency
Type: Currency
Output Only
Introduced in v4
AmountInTime
Amount of pay code, in time
Amount of pay code amount, expressed as a time duration
Type: TimeDuration
Output Only
Introduced in v4
IsCurrencyFlag
Is the pay code in currency?
True if the pay code represents a monetary item. False if it represents an hourly
pay code.
Type: Boolean
Output Only
Only Allowed Values: True, False
Introduced in v4; last changed in v5.0
LaborAccountDescription
Description of labor account
The description associated with the labor account
Type: String
Output Only
Introduced in v4
LaborAccountId
Labor account ID
A unique identifier for the labor account to which this amount is applied. This is
intended for use by Kronos support personnel only. It is recommended that you
use the labor account name instead.
Type: Long
Output Only
Introduced in v4
LaborAccountName
Labor account
Name of the labor account to which this amount is applied
Type: String
Output Only
Maximum length: 356 characters
Each component in the name corresponds to the name and sort order position of
an existing labor level entry. The name must contain only legal naming characters.
Introduced in v4
OrgJobDescription
Description of organizational job
The description of the job in the organization.
Type: String
Output only
Introduced in v5.0
OrgJobId
Organizational job ID
A unique identifier for a job in the organization
Type: Long
Output only
Introduced in v5.0
OrgJobName
Organizational job
The full path of the job in the organization
Type: String
Output only
Maximum length: 1000 characters
Introduced in v5.0
PayCodeId
Pay code ID
The unique identifier of the pay code to which this amount is applied. Intended for
use by Kronos support personnel only. It is recommended that you use the
PayCodeName property instead.
Type: Long
Output Only
Introduced in v4
PayCodeName
Pay code
The pay code to which this amount is applied
Type: String
Output Only
Introduced in v4
TotaledScheduledPayCodeEdit Tag
Editable Scheduled Pay Code Edit that is Totaled
The TotaledScheduledPayCodeEdit tag is generated by the Callable Totalizer. It is
based on the Scheduled PayCodeEdit tag, and can be edited with the Timecard
Editor. For example, you can edit the Timecard Editor to add comments.
Function Access Control Point: API.Timecard
Introduced in v4; last changed in v5.0
Syntax
Properties→
<TotaledScheduledPayCodeEdit
( AmountInTimeOrCurrency = String )
( Date = Date )
( EnteredOnDate = Date )
( EnteredOnTime = Time )
( IsCurrencyFlag = Boolean )
( LaborAccountName = String )
( PayCodeName = String ) >
( <Comments>
<Comment>∗
</Comments> )
</TotaledScheduledPayCodeEdit>
Property Descriptions
AmountInTimeOrCurrency
Amount of pay code, in time or currency
Amount of pay code, expressed as a time duration or a currency.
Type: String
Output Only
Maximum length: 30 characters
Must be consistent with the given pay code
Introduced in v4
Comments
Comments
A list of comments currently returned with this timekeeping item
Type: Zero or more Comment tags
Output Only
Introduced in v4
Date
Date to which the edit applies
The date on which the edit is credited
Type: Date
Output Only
Sample values: 8:00 Vacation on 4/2/2001
Introduced in v4
EnteredOnDate
Date of the edit
The server date on which the edit is added to the database
Type: Date
Output Only
Introduced in v4
EnteredOnTime
Time of the edit
The server time at which the edit is added to the database
Type: Time
Output Only
Introduced in v4
IsCurrencyFlag
Is the pay code in currency?
True if the pay code represents a monetary item. False if it represents an hourly
pay code.
Type: Boolean
Output Only
Only Allowed Values: True, False
Introduced in v4
LaborAccountName
Labor account
This is the name of the labor account of the employee whose pay code amount or
totaled amount is being edited.
Type: String
Output Only
Maximum length: 356 characters
Default Value: Primary account for the employee
Introduced in v4; last changed in v5.0
PayCodeName
Pay code
The pay code to be credited with the amount
Type: String
Output Only
Must be assiciated with an hourly or monetary pay code edit
Introduced in v4
TotaledScheduledPayCodeEditUneditable Tag
Uneditable Scheduled Pay Code Edit that is Totaled
The TotaledScheduledPayCodeEditUneditable tag is generated by the Callable
Totalizer. "Uneditable" means that this pay code edit cannot be edited in a
timesheet. For example, you cannot use the timecard editor to add comments.
Function Access Control Point: API.Timecard
Introduced in v4; last changed in v5.0
Syntax
Properties→
<TotaledScheduledPayCodeEditUneditable
( AmountInTimeOrCurrency = String )
[ CommentText = String ]
( Date = Date )
( EnteredOnDate = Date )
( EnteredOnTime = Time )
( IsCurrencyFlag = Boolean )
( LaborAccountName = String )
( PayCodeName = String ) >
( <Comments>
<Comment>∗
</Comments> )
</TotaledScheduledPayCodeEditUneditable>
Property Descriptions
AmountInTimeOrCurrency
Amount of pay code, in time or currency
Amount of pay code, expressed as a time duration or a currency
Type: String
Output Only
Maximum length: 30 characters
An amount expressed as a TimeDuration or Currency depending on the pay code.
Must be consistent with the given pay code.
Introduced in v4
Comments
Comments
A list of comments currently returned with this timekeeping item
Type: Zero or more Comment tags
Output Only
Introduced in v4
CommentText
Comment text
A comment
Type: String
Optional
Maximum length: 254 characters
Must match exactly an applicable comment that already exists in the database.
The string matching is case-sensitive.
You can find values in the Workforce Timekeeper Setup Application.
Introduced in v4
Date
Date to which the edit applies
The date on which the edit is credited
Type: Date
Output Only
Sample values: 8:00 Vacation on 4/2/2001
Introduced in v4
EnteredOnDate
Date of the edit
The server date on which the edit is added to the database
Type: Date
Output Only
Introduced in v4
EnteredOnTime
Time of the edit
The server time at which the edit is added to the database
Type: Time
Output Only
Introduced in v4
IsCurrencyFlag
Is the pay code in currency?
False indicates that the pay code represents a monetary item
Type: Boolean
Output Only
Only Allowed Values: True, False
Introduced in v4
LaborAccountName
Labor account
This is the name of the labor account of the employee whose pay code amount or
totaled amount is being loaded. A seven-level labor account will appear using the
following format: 101/202/303/404/504/603/702.
Type: String
Output Only
Maximum length: 356 characters
Default Value: Primary account for the employee
Introduced in v4; last changed in v5.0
PayCodeName
Pay code
The pay code to be credited with the amount
Type: String
Output Only
Must be assiciated with an hourly or monetary pay code edit
Introduced in v4
TotaledScheduledWorkedDuration Tag
Amount of Scheduled Work in Shift
The TotaledScheduledWorkedDuration tag represents the amount of worked time
that is scheduled for the employee in a single shift of the employee's schedule.
This tag is generated by the Callable Totalizer only if the employee is configured
as an hourly employee; that is, the Timecard Editor shows the amount of time
worked by the employee, rather than punches. This timesheet item is not
generated for a non-hourly employee.
Function Access Control Point: API.Timecard
Introduced in v4
Syntax
Properties→
<TotaledScheduledWorkedDuration
( AmountInTime = TimeDuration )
( Date = Date )
( LaborAccountName = String )
( ScheduledLaborAccountName = String )
( WorkRuleName = String ) >
( <Employee>
<CurrentUser> | <PersonIdentity>
</Employee> )
( <Exceptions>
<TimekeepingException>∗
</Exceptions> )
</TotaledScheduledWorkedDuration>
Property Descriptions
AmountInTime
Amount of pay code, in time
Amount of pay code amount, expressed as a time duration
Type: TimeDuration
Output Only
Introduced in v4
Date
Date for the scheduled work
The date to be credited with this worked duration
Type: Date
Output Only
Introduced in v4
Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, to be credited
with the time.
Type: Either CurrentUser or PersonIdentity tag
Output Only
Must uniquely identify an existing and active employee
Introduced in v4
Exceptions
Timekeeping exceptions
A list of timekeeping exceptions.
Dependency: Returned only when the WorkedDuration tag is returned as part of a
Timesheet tag, and only if the most recent totalization detects one or more
timekeeping exceptions for this WorkedDuration.
Type: Zero or more TimekeepingException tags
Output Only
Introduced in v4
LaborAccountName
Labor account
The labor account associated with this worked duration. The duration is a transfer
to this labor account.
Type: String
Output Only
TotaledSpan Tag
Total for Time Span
The TotaledSpan tag is returned as a record of a Timesheet object. All
TotaledSpans in a Timesheet apply to the same employee.
Used by: Timesheet
Function Access Control Point: API.Timecard
Introduced in v4
Syntax
Properties→
<TotaledSpan
( LaborAccountName = String ) >
( <Exceptions>
<TimekeepingException>∗
</Exceptions> )
( <InPunch>
<Punch>
</InPunch> )
( <OutPunch>
<Punch>
</OutPunch> )
</TotaledSpan>
Property Descriptions
Exceptions
Exceptions associated with the totaled span
A list of all timekeeping exceptions associated, through totalization, with this
TotaledSpan. If no exceptions are associated with this totaled span, the property
will not be returned.
Type: Zero or more TimekeepingException tags
Output Only
Introduced in v4
InPunch
Punch associated with start of the span
The Punch object associated with the start of this span. When returned within a
TotaledSpan, the Punch object does not contain an Employee tag.
Type: Punch tag
Output Only
Introduced in v4
LaborAccountName
Labor account
The name of the labor account for which the span is charged
Type: String
Output Only
Maximum length:356 characters
Introduced in v4
OutPunch
Punch associated with end of the span
The Punch tag associated with the end of this span. When returned within a
TotaledSpan, the Punch tag does not contain an Employee tag.
Type: Punch tag
Output Only
Introduced in v4
TotalSummary Tag
Summary of Totals
The TotalSummary tag contains a set of Total tags, each of which records an
amount of time and/or currency to be credited to a labor account and pay code.
Used by: DateTotals, PeriodTotals
Function Access Control Point: API.Timecard
Introduced in v4
Syntax
Properties→
<TotalSummary >
( <Totals>
<Total>∗
</Totals> )
</TotalSummary>
Property Descriptions
Totals
Set of Totals
A list of totals, each of which reports an amount of time or currency for a unique
combination of labor account and pay code
Type: Zero or more Total tags
Output only
Introduced in v4
Transaction Tag
Transaction
The Transaction tag provides a means to specify atomic actions across multiple
Request tags. The Transaction tag can contain only a sequence number and one or
more Request tags. A Response with a Status of Failure generated from any
Request tag in the transaction causes all requests to roll back. After a failure,
processing continues with the next Transaction or Request tag.
Function Access Control Point: API.XML
Introduced in v4
Syntax
Properties→
<Transaction
[ TransactionSequence = String ] />
Contained API Tag+
</Transaction>
Property Descriptions
TransactionSequence
Transaction sequence
A number supplied by the client application that is returned in each Response tag
for the Transaction
Type: String
Optional
Introduced in v4
TransferEmployee Tag
Transfer Employee
TransferEmployee
Function Access Control Point: API.Schedule
Introduced in v5.1
Syntax
Properties→
<TransferEmployee
EffectiveDate = Date
[ LaborAccountName = String ]
[ OrgJobPath = String ]
TransferStartTime = Time
[ WorkRuleName = String ] >
[ <Comments>
<Comment>
</Comments> ]
</TransferEmployee>
Property Descriptions
Comments
Comments
Comments
Type: Comment tag
Optional
Introduced in v5.1
EffectiveDate
Effective date
EffectiveDate
Type: Date
Required
Introduced in v5.1
LaborAccountName
Labor account name
LaborAccountName
Type: String
Optional
Introduced in v5.1
OrgJobPath
Organization job path
OrgJobPath
Type: String
Optional
Introduced in v5.1
TransferStartTime
Transfer start time
TransferStartTime
Type: Time
Required
Introduced in v5.1
WorkRuleName
Work rule
WorkRuleName
Type: String
Optional
Introduced in v5.1
TransferJobSeniorityDate Tag
Seniority Date
The TransferJobSeniorityDate tag assigns a seniority date for an employee and an
organizational job, based on the employee's job transfer set, as of an effective
date.
Function Access Control Point: API.Schedule
Introduced in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<TransferJobSeniorityDate
EffectiveDate = Date
LocationOrgNodePath = String
PersonNumber = String
[ SeniorityDate = Date ] />
Action Descriptions
Load
Retrieves employee seniority information as of an effective date.
Return Value Type: Collection
Required Properties: PersonNumber, LocationOrgNodePath, EffectiveDate
Access Control Point Name: View
Introduced in v5.0
Update
Updates employee seniority information.
Property Descriptions
EffectiveDate
Effective date
The date when the job transfer set was assigned to the employee
Type: Date
Required
Job Transfer Set with OrgJobs must be defined and exist on the given effective
date.
Introduced in v5.0
LocationOrgNodePath
Full path for node location
The full path for the organizational node location
Type: String
Required
Maximum length: 1000
Introduced in v5.0
PersonNumber
Person number
Person number of the specified person
Type: String
Required
TypeOverride Tag
Override for Punch
The TypeOverride tag identifies the override that can be associated with a punch.
Function Access Control Point: API.Timecard
Introduced in v4
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Load"
Properties→
<TypeOverride
( OverrideRuleName = String ) />
Action Descriptions
Load
Returns information for each punch type override defined in the system.
Return Value Type: Zero or more TypeOverride tags
Access Control Point Name: View
Introduced in v4
Property Descriptions
OverrideRuleName
Override type name
The name of an override type that can be associated with a punch
Type: String
Output Only
User Tag
User
The User tag contains user account and related information.
Used by: Personality
See the validation rules for the PersonIdentity, PasswordHistory, UserAccount,
and UserAccountLockout tags.
Function Access Control Point: API.Person
Introduced in v4; last changed in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
Load
Returns the user account, password history, and lockout information for the
specified person.
Return Value Type: User tag
Required Properties: Identity
Access Control Point Name: View
Introduced in v4
LoadUserAccount
Returns user account information for the specified person.
Return Value Type: UserAccount tag
Required Properties: Identity
Access Control Point Name: View
Introduced in v4
Property Descriptions
Identity
Identity
One employee, as specified in a PersonIdentity or CurrentUser tag.
Type: Either CurrentUser or PersonIdentity tag
Required
Must uniquely identify an existing and active employee
Contributes to Uniqueness: Yes
Introduced in v4
PasswordHistories
Password histories
Encrypted passwords for the specified dates and times
Type: Zero or more PasswordHistory tags
Output Only
Introduced in v4
UserAccountData
User account data
The user's logon, name, and password information
Type: UserAccount tag
Optional
Required: When inserting a new user
Introduced in v4
UserAccountLockouts
User account lockouts
The user's lockouts for the specified dates, times, and reasons
Type: Zero or more UserAccountLockout tags
Output Only
Introduced in v4
UserAccount Tag
User Account
The UserAccount tag returns logon information for the specified person;
including the user's username and pasword.
Used by: HyperFindResult, User
Function Access Control Point: API.Person
Introduced in v4; last changed in v5.1
Syntax
Properties→
<UserAccount
( ConsecutiveBadLogons = Long )
( LockoutResetDateTime = DateTime )
[ LogonProfileName = String ]
( PasswordUpdatedDateTime = DateTime )
[ PasswordUpdateFlag = Boolean ]
[ RecordManagerLockoutFlag = Boolean ]
[ UserName = String ]
[ UserPassword = Password ] />
Property Descriptions
ConsecutiveBadLogons
Number of consecutive bad logons
Number of consecutive bad logon attempts the user is permitted before being
locked out of the system.
Type: Long
Output Only
Introduced in v4; last changed in v5.1
LockoutResetDateTime
Date and time when user lockout ends
The date and time after which a user who is currently locked out may log on to the
system.
Type: DateTime
Output Only
Introduced in v4; last changed in v5.1
LogonProfileName
User's logon profile
The Logon Profile column contains the name of the user's logon profile. The
logon profile provides rules for password behavior or provides rules for automatic
logout and lockout behavior.
Workforce provides the following predefined data values:
• Default
• Background Processor
• DCM Super Access
• Event Manager
• HR- Payroll
• MobileTime
• RecordManager- IS
• Super Access
• TeleTime Logon
• XML
The predefined data values that are available at a specific installation varies
according to the products that have been installed and licensed. To determine
which values are available, use the LogonProfile tag with the
LoadAllLogonProfiles action; the response will return the logon profiles that are
available.
Type: String
Optional
UserAccountLockout Tag
User Account Lockout
The UserAccountLockout tag returns the date and reason for a user being locked
out of the system.
Function Access Control Point: API.Person
Introduced in v4; last changed in v5.1
Syntax
Properties→
<UserAccountLockout
( EffectiveDateTime = DateTime )
( LockoutReasonName = String ) />
Property Descriptions
EffectiveDateTime
Date and time when the lockout starts
The date and time when the lockout becomes effective
Type: DateTime
Output Only
Introduced in v4
LockoutReasonName
Reason for lockout
Name of the lockout reason
Workforce provides the following predefined data values:
• 1 for Inactivity Lockout
• 2 for Password Lockout
• 3 for Maintenance Lockout
Type: String
Output Only
Only Allowed Values: 1, 2, 3
Introduced in v4; last changed in v5.0
UserAccountStatus Tag
User Account Status
The UserAccountStatus tag sets a user's account status to be active or inactive.
Used by: PersonInformation
Function Access Control Point: API.Person
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "LoadUserAccountStatuses"
Properties→
<UserAccountStatus
[ EffectiveDate = Date ]
[ ExpirationDate = Date ]
UserAccountStatusName = String >
[ <Identity>
<CurrentUser> | <PersonIdentity>
</Identity> ]
[ <Period>
<TimeFramePeriod>
</Period> ]
</UserAccountStatus>
Action Descriptions
LoadUserAccountStatuses
Returns information associated with the user account status for the specified
person over the period specified. If the period is not specified, the current date
through January 1, 3000 is used. The Identity and Period information associated
with the request will be added to the first tag in the resulting list. An empty tag
(with just the Identity and Period properties) will be returned when no data for the
person or period is found.
The person must exist within the system and the user must have access to that
person.
Return Value Type: Zero or more UserAccountStatus tags
Required Properties: Identity
Optional Properties: Period
Access Control Point Name: View
Introduced in v5.0
Property Descriptions
EffectiveDate
Date the user account becomes effective
The date when the user account becomes effective
Type: Date
Optional
Must occur before the expiration date
Default Value: The current system date
Introduced in v4; last changed in v5.0
ExpirationDate
Date when the user account expires
The end date for the status of the user account
Type: Date
Optional
Must occur after the effective date.
Default Value: January 1, 3000
Introduced in v4
Identity
Identity
One person, as specified in a PersonIdentity or CurrentUser tag.
Type: String
Required
Maximum length: 1 character
Introduced in v4
VacationBid Tag
Vacation Bid
The VacationBid tag specifies the vacation bids requested by an employee
whereas the employee bids for a specific vacation time.
All Actions are validated. The validate method validates the contents of the
vacation bid bean.
Function Access Control Point: API.VacationBid
Introduced in v5.0.a; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"Approve" |
"Load" |
"LoadByBidGroupItem" |
"Reject"
Properties→
<VacationBid
[ BidGroupItemId = Long ]
BidId = Long
CreateOpenShift = Boolean
EndDate = DateTime
HoursPerDay = TimeDuration
[ Priority = Integer ]
StartDate = DateTime
( Status = String ) >
[ <BidNotes>
<BidNote>∗
</BidNotes> ]
</VacationBid>
Action Descriptions
Approve
Approve the vacation bid specified by the vacation bid id and upon approval be
able to specify true or false value for creating an open shift or not.
For the Approve Action, the BidId property and the CreateOpenShift property
MUST be specified.
Return Value Type: None
Required Properties: BidId, CreateOpenShift
Access Control Point Name: Edit
Introduced in v5.0; last changed in v5.0.a
Load
Loads the vacation bid given the bid id value.
For the Load Action, the BidId property must be specified.
Return Value Type: VacationBid tag
Required Properties: BidId
Access Control Point Name: View
Introduced in v5.0; last changed in v5.0.a
LoadByBidGroupItem
Loads the vacation bid(s) given the bid group item id.
For the LoadBidGroupItemId, the BidGroupItemId property MUST be specified.
Return Value Type: Zero or more VacationBid tags
Required Properties: BidGroupItemId
Access Control Point Name: View
Introduced in v5.0; last changed in v5.0.a
Reject
Rejects the vacation bid specified by the vacation bid id.
For the Reject Action, the BidId property MUST be specified.
Return Value Type: None
Required Properties: BidId
Property Descriptions
BidGroupItemId
Bid Group Item ID
BidGroupItemId identifies a row in the WPMBIDGRPPRSNMM table, which
associates a person with a particular bid group.
Type: Long
Optional
The BidGroupItemId MUST be defined for the VacationBid element in the
BidGroupItem BidList for adding bids.
Sample values: <VacationBid BidGroupItemId="3" Priority="5" StartDate="04/
01/2004 00:00:00" EndDate="05/01/2004 11:48:56" HoursPerDay="288000"
CreateOpenShift="false">
</VacationBid>
Introduced in v5.1
BidId
Vacation Bid ID
BidId uniquely identifies a row in the WMPVACATIONBID table, which
contains information about vacation bids.
Type: Long
Required
If defined for an Action, the BidId property cannot be null. The BidId property
MUST NOT be specified for the BidGroupItem AddBids Action. The BidId
property MUST be defined for the ApplyBidNotes, DeleteBidNotes,
BidGroupItem RemoveBids Actions.
Sample values: 1
Contributes to Uniqueness: Yes
Introduced in v5.1
BidNotes
Bid Notes
List of Bid Notes to add a specific bid.
Type: Zero or more BidNote tags
Optional
If defined for an Action, the BidNotes property cannot be null. The contents of the
BidNotes list cannot be null. The BidNotes property MUST contain one or more
BidNote elements. The BidNotes property MUST be specified for the
ApplyBidBNotes Action.
Sample values: <VacationBid Id="501">
<BidNotes>
<BidNote Sequence="1" Text="For vacation bid with Id=501"></BidNote>
</BidNotes>
</VacationBid>
Introduced in v5.1
CreateOpenShift
Create Open Shift
Determines whether to create an open shift when this vacation bid is approved.
Type: Boolean
Required
If defined for an Action, the CreateOpenShift property cannot be null. The
CreateOpenShift property MUST be defined for the VacationBid element within
the BidGroupItem BidList when adding bids.
Default Value: "false"
Sample values: "true" or "false"
Introduced in v5.0; last changed in v5.1
EndDate
Bid End Date
Vacation Bidding End Date.
Type: DateTime
Required
If defined for an Action, the EndDate property cannot be null. The EndDate
property MUST be defined for the VacationBid element in the BidGroupItem
BidList when you adding bids.
Sample values: "05/01/2004 11:48:56"
Introduced in v5.0; last changed in v5.1
HoursPerDay
Hours Per Day
Hours Per Day towards this vacation bid.
Type: TimeDuration
Required
If defined for an Action, the HoursPerDay property cannot be null. The
HoursPerDay property MUST be defined for the VacationBid element within the
BidGroupItem BidList when adding bids.
Sample values: "288000"
Introduced in v5.0; last changed in v5.1
Priority
Bid Priority
Specifies the priority of a bid, also know as the bid rank.
Type: Integer
Optional
Priority cannot be less than 1. Required when adding vacation bids
Sample values: <VacationBid BidGroupItemId="3" Priority="1" StartDate="04/
01/2004 00:00:00" EndDate="05/01/2004 11:48:56" HoursPerDay="288000"
CreateOpenShift="false">
</VacationBid>
Introduced in v5.1
StartDate
Bid Start Date
Vacation bid start date.
Type: DateTime
Required
If the StartDate property is defined for an Action, StartDate cannot be null. The
StartDate property MUST be defined for the VacationBid element within the
BidGroupItem BidList when adding bids.
Sample values: "04/01/2004 00:00:00"
Introduced in v5.0; last changed in v5.1
Status
Bid Status
The status of the bid, which may be 1 of 3 states: Submitted, Approved, Rejected.
Type: String
Output only
The BidStatus property cannot be defined for any BidGroupItem, Bid, or Vacation
Bid Action.
Only Allowed Values: Submitted - 0, Approved - 1, Rejected - 2
Sample values: Submitted - 0, Approved - 1, Rejected - 2
Introduced in v5.1
WageProfile Tag
Wage Profile
The WageProfile tag returns a list of available wage profiles. The wage profile
enables you to assign multiple wage rates to the same employee to comply with
union regulations or company policy. For example, if people perform different
jobs, they might earn a different wage rate for each job.
The WageProfile and WSAWageProfile tags refer to the same database object.
Function Access Control Point: API.Employee
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<WageProfile
[ WageProfileId = Integer ]
[ WageProfileName = String ] />
Action Descriptions
Load
Returns a wage profile, based on WageProfileName.
Name should be valid
Return Value Type: WageProfile tag
Required Properties: WageProfileName
Access Control Point Name: View
Introduced in v4
LoadAllWageProfiles
Returns a list of all wage profiles in the system.
Return Value Type: Zero or more WageProfile tags
Required Properties: None
Access Control Point Name: View
Introduced in v4
LoadById
Returns a wage profile, based on WageProfileID.
ID must be valid
Return Value Type: WageProfile tag
Required Properties: WageProfileID
Access Control Point Name: View
Introduced in v4
Property Descriptions
WageProfileId
Id of wage profile
Uniquely identifies the wage profile in the database
Type: Integer
Optional
Introduced in v4
WageProfileName
Wage profile name
The name of the person's wage profile
Type: String
Optional
Maximum length: 50 characters
Introduced in v4
WaitingPeriod Tag
Waiting Period (unsupported)
THIS TAG IS NOT SUPPORTED FOR THIRD-PARTY USE INCLUDING
WORKFORCE CONNECT. The amount of time (in seconds) that must pass
before a leave decision node can be used in the cascade evaluation process.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Properties→
<WaitingPeriod
RelativeStartDateType = String
[ Units = String ]
WaitingPeriodDuration = TimeDuration />
Property Descriptions
RelativeStartDateType
Relative start date type
The name of the waiting period start date type.
Type: String
Required
Valid values include Leave Start Date, Initial Leave Request Date. It can also be
the name of existing Site-Wide dates or Person-specific Dates configured in
Calculated Accruals Setup. The maximum length is 50 characters.
Introduced in v5.1
Units
Units
The units by which the waiting period is defined.
Type: String
Optional
WeekDay Tag
Week Day
The WeekDay tag provides information about a week day as defined in the
system.
Function Access Control Point: API.Common
Introduced in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
Load
Returns information for the specified weekday.
Specify exactly one of Name or Description.
Return Value Type: WeekDay tag
Required Properties: Name, Description
Access Control Point Name: View
Introduced in v5.0
LoadAll
Returns all weekday information in the system.
No properties can be specified.
Property Descriptions
Description
Description
The localized description of the week day. This value is used as the display name
in the user interface.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.0
Name
Week day name
A day of the week
Type: String
Optional
You must use the English name for the day, even if your application server is
configured to use a different national language.
Only Allowed Values: Sunday, Monday, Tuesday, Wednesday, Thursday,
Friday, Saturday
Contributes to Uniqueness: Yes
Introduced in v5.0
WfcJob Tag
Job in Organization
Use the WfcJob tag to add, delete, or modify a job that can be attached to
locations in an organizational map.
Function Access Control Point: API.Hierarchies
Introduced in v5.0; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"LoadByName" |
"UpdateOnly"
Properties→
<WfcJob
[ InActiveSw = Boolean ]
[ JobCode = String ]
[ JobTitle = String ]
[ LLEDesc = String ]
[ LLEName = String ]
[ SortOrder = Long ]
[ WfcJobDesc = String ]
WfcJobName = String
[ WfcJobNewName = String ] />
Action Descriptions
AddOnly
Adds a new job to the job hierarchy.
Return Value Type: None
Property Descriptions
InActiveSw
Is the job inactive?
Indicates whether the job is inactive
Type: Boolean
Optional
Only Allowed Values: True, False
Default Value: False
Introduced in v5.0
JobCode
Job code
The job code name can be used to identify a job. It is often used when the job has
been imported from another system.
Type: String
Optional
Maximum length: 30 characters
Introduced in v5.0
JobTitle
Description of job code
This is a description of the job. It is often used when the job has been imported
from another system.
Type: String
Optional
Maximum length: 250 characters
Introduced in v5.0
LLEDesc
Description of labor level entry
The description of the labor level entry for the specified job
Type: String
Optional
Maximum length: 250 characters
Introduced in v5.0
LLEName
Labor level entry mapped to job
The name of the labor level entry that is mapped to the specified job.
Type: String
Optional
Maximum length: 30 characters
Required: If the job location type matches a labor level
Introduced in v5.0
SortOrder
Sort order
The sort order number controls the order in which the job appears in functions
such as Schedule Planner or Staff Planner.
Type: Long
Optional
Maximum length: 9 characters
Use only integers that are greater than zero.
Introduced in v5.0
WfcJobDesc
Job description
The description for the specified job
Type: String
Optional
Maximum length: 250 characters
Introduced in v5.0
WfcJobName
Job name
Job name
Type: String
Required
Maximum length: 30 characters
Must conform to the name property standards
Introduced in v5.0
WfcJobNewName
New name for job
The new job name for an existing job.
Used only for the Update action.
Type: String
Optional
Maximum length: 30 characters
The name must be unique.
Introduced in v5.0
WorkedDuration Tag
Amount of Time Worked
Use the WorkedDuration tag to add a time amount, to delete a time amount, or to
add a comment to a time amount for an employee.
Used by: Timesheet
Function Access Control Point: API.Timecard
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Parameters→
[ AccrualOverride = Boolean ]
[ allowAdHoc = Boolean ]
[ EchoData = Boolean ]
Properties→
<WorkedDuration
AmountInTime = TimeDuration
[ CommentText = String ]
Date = Date
( EnteredOnDate = Date )
( EnteredOnTime = Time )
[ LaborAccountName = String ]
[ NewShiftOverrideFlag = Boolean ]
OrgJobId = String
OrgJobName = String
[ ScheduledLaborAccountName = String ]
[ WorkRuleName = String ] >
( <Comments>
<Comment>∗
</Comments> )
<Employee>
<CurrentUser> | <PersonIdentity>
</Employee>
( <Exceptions>
<TimekeepingException>∗
</Exceptions> )
</WorkedDuration>
Action Descriptions
AddComment
Adds a comment for the specified worked durations for the specified employee.
Depending on the type of worked duration, you may need to specify one of the
following properties:
<ul>
<li>LaborAccountName
<li>WorkRuleName
</ul>
Return Value Type: None
Required Properties: AmountInTime, Date, Employee, CommentText
Access Control Point Name: Edit
Introduced in v4
AddOnly
Adds a new worked duration with the specified amount and date for the specified
employee. You can add multiple worked durations with identical amount and date
values, for the same employee.
Return Value Type: WorkedDuration tag
Required Properties: AmountInTime, Date, Employee
Access Control Point Name: Edit
Introduced in v4
Action Parameters
Delete
Marks for deletion all worked durations for the employee and the work duration.
Return Value Type: None
Required Properties: AmountInTime, Date, Employee
Access Control Point Name: Edit
Introduced in v4
Property Descriptions
AmountInTime
Amount of time worked, in time
The amount of time to be added or deleted, expressed as a duration.
Type: TimeDuration
Required
Maximum length: 30 characters
Introduced in v4; last changed in v5.1
Comments
Comments
The set of comments that are associated with worked durations in the timesheet.
Type: Zero or more Comment tags
Output Only
Introduced in v4
CommentText
Comment text
A text string that is attached to the pay code amount or totaled amount.
Type: String
Optional
Maximum length: 254 characters
Must match exactly an applicable comment that already exists in the database.
The string matching is case-sensitive.
You can find values in the Workforce Timekeeper Setup Application.
Introduced in v4
Date
Effective date
The date for which the added or deleted time duration is to be posted.
Type: Date
Required,
Contributes to Uniqueness: Yes
Introduced in v4; last changed in v5.1
Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, who is to be
credited with the time.
Type: Either CurrentUser or PersonIdentity tag
Required,
Must uniquely identify an existing and active employee
specify a value for each labor level, using the following format: 101/202/303/404/
504/603/702
Do not specify labor levels that are not changing.
If any of the labor levels are the same as the employeeís primary labor account,
you can enter @H for those labor levels instead of entering the labor entry names.
Type: String
Optional
Maximum length: 356 characters.
Introduced in v4
NewShiftOverrideFlag
Start a new shift?
The override type value, if any, that is being applied when adding a totaled
amount.
Values are:
• False for no new shift override
• True for a new shift override
Type: Boolean
Optional
Only Allowed Values: True, False
Introduced in v4
OrgJobId
Organizational job ID
A unique identifier for a job in the organization
Type: String
See group( OrgJob)
Default Value: Null
Introduced in v5.0
OrgJobName
Organizational job
The name of the organizational job path of the employee whose pay code amount
or totaled amount is being edited.
Enter data for OrgJobName in the same format as it appears in the database.
Note: OrgJobName string matching is case-sensitive on a Workforce Central
server that connects to an Oracle database.
Required: When the pay code edits, historical edit, or totaled amount being
deleted or commented contained an explicit OrgJobName value
Type: String
See group( OrgJob)
Maximum length: 1000 characters
You must have Functional Access for Job Transfers. A node with this Id must
exist in the organizational structure
Default Value: null
Introduced in v5.0
ScheduledLaborAccountName
Scheduled labor account
Denotes a labor account transfer entered by means of the scheduler application.
This property can only be specified for a Delete action..
Type: String
Optional
Introduced in v5.0
WorkRuleName
Work rule
The work rule for which the amount is being applied. If left blank, the employee's
default work rule is used.
Workforce provides the following predefined data values:
• &ALL_WORK_RULES
• &EMPTY
Type: String
Optional
Maximum length: 50 characters
You can find values in the Workforce Timekeeper Application Setup.
Introduced in v4; last changed in v5.1
WorkerType Tag
Worker Type
The WorkerType tag identifies an optional attribute, such as full-time or part-time,
that you can assign to a person. Use this tag to add, modify, delete, load, or
retrieve worker types.
Function Access Control Point: API.Common
Introduced in v5.0; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"Load" |
"LoadAll" |
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update" |
"UpdateOnly"
Properties→
<WorkerType
[ Name = String ] >
<WorkerTypeElements>
<WorkerTypeElement>∗
</WorkerTypeElements>
</WorkerType>
Action Descriptions
AddOnly
Adds a new worker type to the database.
Return Value Type: None
RetrieveAllNames
Returns the names of all worker types (SDM-required action).
Return Value Type: Zero or more KBusinessObjectNameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified worker type (SDM-required action).
Return Value Type: WorkerType tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Adds a new worker type or updates an existing one.
Return Value Type: None
Required Properties: WorkerTypeElements
Access Control Point Name: Edit
Introduced in v5.0
UpdateOnly
Updates an existing worker type value.
Return Value Type: None
Required Properties: WorkerTypeElements
Access Control Point Name: Edit
Introduced in v5.0
Property Descriptions
Name
Worker Type
The name of the worker type.
Type: String
Optional
Maximum length: 50 characters
Sample values: Full Time, Part Time, Per Diem
Contributes to Uniqueness: Yes
Introduced in v5.1
WorkerTypeElements
Set of worker type elements
A list of the elements that comprise the worker type. The elements are defined
using the WorkerTypeElement tag.
Type: One or more WorkerTypeElement tags
Required
Introduced in v5.0; last changed in v5.1
WorkerTypeElement Tag
WorkerType Elements
The WorkerTypeElement tag defines a worker type. It is used by WorkerType tag.
Function Access Control Point: API.Common
Introduced in v5.0
Syntax
Properties→
<WorkerTypeElement
[ IsActive = Boolean ]
[ NewName = String ]
WorkerTypeName = String />
Property Descriptions
IsActive
Is worker type active?
Specifies whether the worker type is active. If True, it is active.
Type: Boolean
Optional
Only Allowed Values: True, False
Introduced in v5.0
NewName
New name of worker type
You can specify a new name for the worker type if you are updating an existing
one.
Type: String
Optional
Maximum length: 50 characters
Contributes to Uniqueness: Yes
Introduced in v5.0
WorkerTypeName
Worker type name
The name of the worker type
Type: String
Required
Maximum length: 50 characters
Sample values: Full Time, Part Time, Per Diem
Contributes to Uniqueness: Yes
Introduced in v5.0
WorkflowAccessAssignment Tag
Process Profiles Assigned to a Person
The WorkflowAccessAssignment tag assigns a person to a specific employee
process profile and/or a manager process profile. Each person is identified
through the Identity property.
The Identity of a person must be specified as a property of the
WorkflowAcessAssignment tag. Either the EmployeeWorkflowProfileName and/
or the ManagerWorkflowProfileName must be specified to assign the specified
person to the a given employee process profile and manager process profile.
Function Access Control Point: API.WorkflowAccessAssignment
Introduced in v5.0
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<WorkflowAccessAssignment
[ EmployeeWorkflowProfileName = String ]
[ ManagerWorkflowProfileName = String ] >
<Identity>
<CurrentUser> | <PersonIdentity>
</Identity>
</WorkflowAccessAssignment>
Action Descriptions
Load
Retrieves a process profile access assignment given the Identity of a person. The
Identity property must be specified for the Load Action.
The Identity property must be specifie for the Load Action. The Person or the
Person Number specified in the Identity property must already exist in the
database, prior to calling the Load Action.
Return Value Type: WorkflowAccessAssignment tag
Required Properties: Identity
Access Control Point Name: View
Introduced in v5.0
UpdateOnly
Assigns a person to a specific employee process profile and/or a manager process
profile.
For the UpdateOnly action, the Identity property MUST be specified, and
EmployeeWorkflowProfileName and/or the ManagerWorkflowProfileName
MUST be specified.
Return Value Type: None
Required Properties: Identity, Either EmployeeWorkflowProfileName and/or
ManagerWorkflowProfileName
Access Control Point Name: Edit
Introduced in v5.0
Property Descriptions
EmployeeWorkflowProfileName
Process profile for employees
Name of employee process profile. The EmployeeWorkflowProfileName must be
specified as a property for the UpdateOnly Action, if you wish to assign a specific
process profile name as the employee process profile.
Type: String
Optional
If the EmployeeWorkflowProfileName is defined for an action, the
EmployeeWorkflowProfileName cannot be null. The
EmployeerWorkProfileName must be assigned a string value of a process profile
name that already exists in the database.
WorkflowTemplateCategory Tag
Workflow Template Category
The Process Template Category specifies the template categories. A process
template can be assigned to one or more categories of choice.
Function Access Control Point:
com.kronos.wfc.business.workflow.KTemplateCategory
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "RetrieveAllCategories"
Properties→
<WorkflowTemplateCategory
[ Description = String ]
Id = Long
Name = String
Originator = Integer />
Action Descriptions
RetrieveAllCategories
This action returns a list of the template categories.
Return Value Type: WorkflowTemplateCategory tag
Access Control Point Name: Edit
Introduced in v5.0.a
Property Descriptions
Description
Category description
A description of the category.
Type: String
Optional
Maximum Length: 250 characters
Introduced in v5.1
Id
Category identifier
The category's Id.
Type: Long
Required
Must be greater than zero
Contributes to Uniqueness: Yes
Introduced in v5.1
Name
Category name
The category's name.
Type: String
Required
Maximum Length: 50 characters
Introduced in v5.1
Originator
Category originator
The Category Orignator defines if the category was created by the system or if it
was created by a user. Thus, 0 - specifies a system category, 1 - specifies a user
defined category.
Type: Integer
Required
The Category Originator must be either 0 or 1.
Sample values: 0, 1
Introduced in v5.1
WorkHour Tag
Work Hour
The WorkHour tag defines a rule based on the number of hours that an employee
has worked.
Function Access Control Point: API.WorkforceLeave
Introduced in v5.1
Syntax
Properties→
<WorkHour
AmountOperator = String
[ CustomDateType = String ]
HourAmount = String
PayCode = String
TimePeriodDuration = String
[ WorkHireRefDateType = String ] />
Property Descriptions
AmountOperator
Amount operator
The amount operator is used to validate the actual amount and requirement
amount. The actual amount is on the left side of the operator. The requirement is
on the right side of the operator.
Type: String
Required
The operator must be valid.
Sample values: Less than, Less than or equal to, Equal to, More than or equal to,
More than, Not equal to
Introduced in v5.1
CustomDateType
Custom date type
WorkRule Tag
Work Rule
The WorkRule tag returns a set of work rules and information about who can
access them. A work rule is a set of parameters that apply specific payroll rules to
shifts. These rules determine how employee hours accrue (for example, for
breaks, overtime, and pay code distribution. Properties are defined to show
whether the user has permission to assign the work rule to himself or herself, or to
other employees.
The WorkRule and WSAWorkRule tags refer to the same database object.
Function Access Control Point: API.Accruals
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "LoadAllWorkRules"
Properties→
<WorkRule
( ManagerHasAccessFlag = Boolean )
( ProfessionalHasAccessFlag = Boolean )
( WorkRuleName = String ) />
Action Descriptions
LoadAllWorkRules
Returns a list of all work rules in the system
Return Value Type: Zero or more WorkRule tags
Required Properties: None
Access Control Point Name: View
Introduced in v4
Property Descriptions
ManagerHasAccessFlag
Do managers have access?
Boolean value that indicates, when True, that a manager can access the work rule.
Type: Boolean
Output Only
Only Allowed Values: True, False
Introduced in v4; last changed in v5.1
ProfessionalHasAccessFlag
Do professionals have access?
Boolean value that indicates, when True, that employees can access the work rule.
Type: Boolean
Output Only
Only Allowed Values: True, False
Introduced in v4; last changed in v5.1
WorkRuleName
Work rule name
Name of the work rule. The name is case-insensitive and must be unique.
Type: String
Output Only
Maximum length: 50 characters
Introduced in v4
WorkRuleProfile Tag
Work Rule Profile
The WorkRuleProfile tag returns information about work rule profiles. A work
rule profile is a set of rules that determine how employee hours accrue. Details
about how punches round, the types of overtime the employee can earn, which
pay codes hold what type of hours, and policies for meals and breaks are examples
of work rules that can be included in a work rule profile.
For more information, see the online help.
Function Access Control Point: API.Employee
Introduced in v4; last changed in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
Load
Returns a work rule profile, based on WorkruleProfileName.
Name should be valid
Return Value Type: WorkRuleProfile tag
Required Properties: WorkruleProfileName
Access Control Point Name: View
Introduced in v4
LoadAllWorkRuleProfiles
Returns a list of all work rule profiles in the system.
Return Value Type: Zero or more WorkRuleProfile tags
Required Properties: None
Access Control Point Name: View
Introduced in v4
LoadById
Returns a work rule profile, based on WorkruleProfileID.
ID should be valid
Return Value Type: WorkRuleProfile tag
Required Properties: WorkruleProfileID
Access Control Point Name: View
Introduced in v4
Property Descriptions
WorkRuleProfileId
Id of work rule profile
Uniquely identifies the work rule data access profile in the database
Type: Integer
Optional
Introduced in v4
WorkRuleProfileName
Work rule profile name
The name for the common set of work rules that a group of employees can select.
For example, Professional Employees.
Type: String
Optional
Introduced in v4
WSAAssignmentRule Tag
Assignment Rule
The Assignment Rule tag allows you to assign a work rule to a specific time
period. When employees qualify for an assigned shift, the assigned work rule
applies rather than their default work rule.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Retrieve"
Properties→
<WSAAssignmentRule
[ Friday = Boolean ]
[ Monday = Boolean ]
[ OrderNum = Integer ]
[ Saturday = Boolean ]
[ Scheduled = Boolean ]
[ ScheduleEndTime = Long ]
[ ScheduleStartTime = Long ]
[ ShiftMax = Long ]
[ ShiftMin = Long ]
[ Sunday = Boolean ]
[ Thursday = Boolean ]
[ Tuesday = Boolean ]
[ Unscheduled = Boolean ]
[ Wednesday = Boolean ]
[ WorkRuleName = String ] />
Action Descriptions
Retrieve
Returns the specified assignment rule for update.
Return Value Type: WSAAssignmentRule tag
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
Friday
Is the rule enabled for Friday?
Boolean value that, when True (the default), indicates that the assignment rule is
enabled for Friday.
Type: Boolean
Optional
Introduced in v5.1
Monday
Is the rule enabled for Monday?
Boolean value that, when True (the default), indicates that the assignment rule is
enabled for Monday.
Type: Boolean
Optional
Introduced in v5.1
OrderNum
Order of the rule
Order number of the assignment rules that are assigned to a particular pay rule.
Type: Integer
Optional
Introduced in v5.1
Saturday
Is the rule enabled for Saturday?
Boolean value that, when True (the default), indicates that the assignment rule is
enabled for Saturday.
Type: Boolean
Optional
Introduced in v5.1
Scheduled
Is the rule scheduled?
Boolean value that, when True (the default), allows scheduled employees to
qualify for this assignment shift.
Type: Boolean
Optional
Introduced in v5.1
ScheduleEndTime
Schedule End Time
End time in HH:mm AM|PM format. The end time closes the range of time that
allows in-punches to link to an assigned schedule. For scheduled employees to
qualify for the assigned shift, their scheduled start times must be before the end
time. For unscheduled employees to qualify for the assigned shift, their in-
punches must be before the end time.
Type: Long
Optional
Introduced in v5.1
ScheduleStartTime
Schedule Start Time
Start time in HH:mm AM|PM format. For scheduled employees to qualify for the
assigned shift, their scheduled start times must be before the end time. For
unscheduled employees to qualify for the assigned shift, their in-punches must be
before the end time.
Type: Long
Optional
Introduced in v5.1
ShiftMax
Maximum shift length
Maximum shift length allowed for an employee to qualify for the assignment rule.
Specify the length in in HH:mm format. The default is 99:59.
Type: Long
Optional
Introduced in v5.1
ShiftMin
Minimum shift length
Minimum shift length required for an employee to qualify for the assignment rule.
Specify the length in in HH:mm format. The default is 0:00 (no minimum is
required to qualify).
Type: Long
Optional
Introduced in v5.1
Sunday
Is the rule enabled for Sunday?
Boolean value that, when True (the default), indicates that the assignment rule is
enabled for Sunday.
Type: Boolean
Optional
Introduced in v5.1
Thursday
Is the rule enabled for Thursday?
Boolean value that, when True (the default), indicates that the assignment rule is
enabled for Thursday.
Type: Boolean
Optional
Introduced in v5.1
Tuesday
Is the rule enabled for Tuesday?
Boolean value that, when True (the default), indicates that the assignment rule is
enabled for Tuesday.
Type: Boolean
Optional
Introduced in v5.1
Unscheduled
Is the rule unscheduled?
Boolean value that, when True (the default), allows unscheduled employees to
qualify for this assignment shift.
Type: Boolean
Optional
Introduced in v5.1
Wednesday
Is the rule enabled for Wednesday?
Boolean value that, when True (the default), indicates that the assignment rule is
enabled for Wednesday.
Type: Boolean
Optional
Introduced in v5.1
WorkRuleName
Work Rule
Name of the work rule that applies to this shift.
Type: String
Optional
Introduced in v5.1
WSAAutoBreakPlacement Tag
Automatic Break Placement
The Automatic Break Placement tag enables you to specify automated break
placements in work rules. Note: Automated break placements are available only if
Workforce Scheduler is installed.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Retrieve"
Properties→
<WSAAutoBreakPlacement
[ MaxStartTimeForBreak = Long ]
[ MinStartTimeForBreak = Long ]
[ MinTimeBetweenBreaks = Long ]
[ Name = String ] >
[ <ShiftLengths>
<WSAShiftLength>∗
</ShiftLengths> ]
</WSAAutoBreakPlacement>
Action Descriptions
Retrieve
Returns the specified automated break placement.
Return Value Type: WSAAutoBreakPlacement tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
MaxStartTimeForBreak
Latest start time for a break
Number of hours that employees must work between the start of the last break and
the end of their shift. Valid values are from 0 (zero) to 99 hours. The default is 0
(zero) hours.
Type: Long
Optional
Introduced in v5.1
MinStartTimeForBreak
Earliest start time for a break
Number of hours employees must work before taking a break. Valid values are
from 0 (zero) to 99 hours. The default is 0 (zero) hours.
Type: Long
Optional
Introduced in v5.1
MinTimeBetweenBreaks
Minimum time between breaks
Minimum number of hours employees must work between breaks. Valid values
are from 0 (zero) to 99 hours.
Type: Long
Optional
Introduced in v5.1
Name
Name
Name of the automated break placement. The name can be up to 32 characters in
length, is case-insensitive, and must be unique.
Type: String
Optional
WSAAvailabilityPatternDAP Tag
Availability Pattern Data Access Profile
The Availability Pattern Data Access Profile tag enables you to specify the
availability templates to which users have access.
Function Access Control Point: WSA.AccessProfiles
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAAvailabilityPatternDAP
[ AllowAll = Boolean ]
[ Description = String ]
[ Name = String ] >
[ <ProfileItems>
<WSAAvailabilityPatternProfileItem>∗
</ProfileItems> ]
</WSAAvailabilityPatternDAP>
Action Descriptions
RetrieveAllForUpdate
Returns all availability pattern data access profiles for update.
Return Value Type: Zero or more WSAAvailabilityPatternDAP tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of all availability pattern data access profiles.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified availability pattern data access profile for update.
Return Value Type: WSAAvailabilityPatternDAP tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified availability pattern data access profile.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
AllowAll
Does the user have access to all availability templates?
Boolean value that, when True, indicates that the availability pattern data access
profile includes all availability patterns in the system.
Type: Boolean
Optional
Introduced in v5.1
Description
Description
WSAAvailabilityPatternProfileItem Tag
Availability Pattern Profile Item
This is a Worforce Setup Application tag that identifies availability pattern profile
items
Function Access Control Point: WSA.AccessProfiles
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
RetrieveAllForUpdate
Returns all availability pattern profile items for update.
Return Value Type: Zero or more WSAAvailabilityPatternProfileItem tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified availability pattern profile item for update.
Return Value Type: WSAPatternTemplateProfileItem tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
Name
Availability pattern profile item name
Name of the availability pattern profile item. The namecan be up to 32 characters
long, is case-insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSABonusDeductRule Tag
Bonus Deduct Rule
The WSABonusDeductRule tag enables you to list and update bonus and
deduction rules. The DeductRule and WSABonusDeductRule tags refer to the
same database object.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSABonusDeductRule
[ Amount = String ]
[ AtLeastSelected = Boolean ]
[ BonusQualify = String ]
[ BreakRule = String ]
[ Friday = Boolean ]
[ InWinEtime = Time ]
[ InWinStime = Time ]
[ IsCanceledInTimecard = Boolean ]
[ IsShiftRestriction = Boolean ]
[ Locator = TimeDuration ]
[ LocatorAtOrAfter = Time ]
[ LocatorBefore = Time ]
[ Monday = Boolean ]
[ Name = String ]
[ PayCode = String ]
[ PaycodeMax = TimeDuration ]
[ PaycodeMin = TimeDuration ]
[ QualifyPerShift = Boolean ]
[ Saturday = Boolean ]
[ ShfLenMax = TimeDuration ]
[ ShfLenMin = TimeDuration ]
[ ShiftReq = Integer ]
[ Sunday = Boolean ]
[ Thursday = Boolean ]
[ TimeOfDay = Time ]
[ TrigpaycodeName = String ]
[ Tuesday = Boolean ]
[ Type = String ]
[ Wednesday = Boolean ]
[ WeekStart = Integer ] />
Action Descriptions
RetrieveAllForUpdate
Returns all bonus and deduction rules for updating.
Return Value Type: Zero or more WSABonusDeductRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all bonus and deduction rules.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified bonus or deduction rule for updating.
Return Value Type: WSABonusDeductRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified bonus or deduction rule.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
Amount
Amount
The amount of the bonus or deduction that will be deducted from or added to
timecards. The Amount can be decimal or time. If you specify a pay code, the pay
code type determines the amount type. A money pay code indicates a decimal
amount. A time pay code indicates a time amount. The default is time in HH:mm
format (00:00).
Type: String
Optional
Introduced in v5.1
AtLeastSelected
At Least Selected
At Least Selected
Type: Boolean
Optional
Introduced in v5.1
BonusQualify
Bonus Qualify
When the trigger is PayCode (Type property is B), time frame during which the
activity in PayCode must occur for an employee to
qualify for this bonus or deduction. Valid values are: "shift", "week", and
"payPeriod". If you select "week", the Week start property can also be set. If you
select "week" or "payPeriod", the Qualify per Shift option propertycan also be set.
The default is "shift".
Type: String
Optional
Introduced in v5.1
BreakRule
Break Rule
Break rule specifying when a punch qualifies as a break and how these punches
round.
Type: String
Optional
Introduced in v5.1
Friday
Friday
Boolean value that, when True, indicates that the bonus or deduction rule applies
to Friday.
Type: Boolean
Optional
Introduced in v5.1
InWinEtime
In window end time
If a shift restriction exists on the bonus or deduction, earliest time that a shift may
end in order to qualify for
the bonus or deduction. This value is expressed in HH:mm AM|PM format.
Type: Time
Optional
Introduced in v5.1
InWinStime
In window start time
If a shift restriction exists on the bonus or deduction, time by which a shift must
begin for the shift to qualify
for the bonus or deduction. This value is expressed in HH:mm AM|PM format.
Type: Time
Optional
Introduced in v5.1
IsCanceledInTimecard
Is Canceled In Timecard
Boolean value that, when True (the default), allows this deduction or bonus to be
canceled when canceling all deductions in Timecard.
Type: Boolean
Optional
Introduced in v5.1
IsShiftRestriction
Is Shift Restriction
Boolean value that, when True, enables shift restriction. When shift restriction is
enabled, employees must start at or before InWinStime. Rounded out-punches are
compared to the Must Work Until time. Employees must end work at or after
InWinEtime. When thid value is False (the default), shift restriction is disabled,
employees are not required to meet specific time constraints to receive the bonus
or deduction.
Type: Boolean
Optional
Introduced in v5.1
Locator
Locator
When the trigger is length of shift (Type property is D), time (specified in HH:mm
format) at which the bonus or deduction occurs in the shift. If employees earn a
daily shift differential, the automatic bonus or deduction could affect the time
earned in that zone. When a locator is not specified, the bonus or deduction is
taken at the beginning of the shift. For example, the locator is 4:00, the daily shift
differential is 11:00 P.M. to 8:00 A.M., an employee punches in at 7:00 A.M. and
punches out at 4:00 P.M. The shift length is 8 hours and the employee earns 1 hour
of daily shift differential. The locator appears at 11:00 A.M. If the locator is 0:00,
the shift length is still 8:00, but the employee does not earn any shift differential.
The default locator is 4:00.
Type: TimeDuration
Optional
Introduced in v5.1
LocatorAtOrAfter
Locator At Or After
When the trigger is length of shift (Type property is D), time at or after which the
locator must occur for the shift to qualify for the bonus or deduction. The value is
expressed in HH:mm AM|PM format. LocatorAtOrAfter is the beginning of the
fixed range during which the locator must appear for the bonus or deduction to
occur. Along with LocatorBefore, this property restricts when a bonus or
deduction occurs; for example, just at lunch or dinner time. To determine the fixed
range, add the locator to the rounded in-punch. If the resulting time occurs at or
after the start of the range, and before the end of the range, the shift meets this
requirement. The default is 12:00 AM.
Type: Time
Optional
Introduced in v5.1
LocatorBefore
Locator Before
When the trigger is length of shift (Type property is D), time before which the
locator must occur for the shift to qualify for the bonus or deduction. This value is
expressed in seconds, starting at midnight. The LocatorBefore property specifies
the end of the fixed range during which the locator must appear for the bonus or
deduction to occur. Along with the LocatorAtOrAfter property, it restricts when a
bonus or deduction occurs; for example, just at lunch or dinner time. To determine
the fixed range, add the locator to the rounded in-punch. If the resulting time
occurs at or after the start of the range, and before the end of the range, the shift
meets this requirement.
Type: Time
Optional
Introduced in v5.1
Monday
Monday
Boolean value that, when True, indicates that the bonus or deduction rule applies
to Monday.
Type: Boolean
Optional
Introduced in v5.1
Name
Name
The bonus or deduction rule name. The name can be up to 32 characters long, is
case insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
PayCode
Pay Code
Pay code for the bonus or deduction.
Type: String
Optional
Introduced in v5.1
PaycodeMax
Pay code Max
When the trigger is pay code (Type property is B), maximum amount of time to
qualify for the bonus or deduction in HH:mm format. If employees work more
than the maximum, they do not earn the bonus or deduction. Their rounded shift
lengths are compared to the maximum amount. Employees may be eligible for
more than one bonus or deduction. The maximum option might eliminate a lower-
paying bonus in favor of a higher-paying bonus. The maximum amount should be
greater than the minimum amount. The default is 99:59.
Type: TimeDuration
Optional
Introduced in v5.1
PaycodeMin
Pay code Min
When the trigger is pay code (Type property is B), minimum amount of time (in
HH:mm format) required to qualify for the bonus or deduction. Employees must
work at least the shift minimum to earn the bonus or deduction. The rounded shift
length is compared to the minimum. The default is 0:00.
Type: TimeDuration
Optional
Introduced in v5.1
QualifyPerShift
Qualify Per Shift
Boolean value that, when True and trigger is time of day (Type property is F) and
BonusQualify is week or pay period, indicates that employees must work the
number of shifts specified by ShiftsRequired to qualify for the bonus or
deduction. By default, this option is False.
Type: Boolean
Optional
Introduced in v5.1
Saturday
Saturday
Boolean value that, when True, indicates that the bonus or deduction rule applies
to Saturday.
Type: Boolean
Optional
Introduced in v5.1
ShfLenMax
Maximum shift length
When the trigger is length of shift (Type property is D), maximum shift length to
trigger. This is the amount of time (specified in HH:mm format) that determines
the cancelation of the automatic bonus or deduction. The maximum amount
should be greater than the ShfLenMin. The default is 99:59.
Type: TimeDuration
Optional
Introduced in v5.1
ShfLenMin
Minimum shift length
When the trigger is length of shift (Type property is D), minimum shift length to
trigger. This is the least amount of time (specified in HH:mm format) that
employees are required to work to qualify for the bonus or deduction. The
rounded shift length is compared to the shift minimum. If the shift length equals
or is greater than the minimum, the shift qualifies for the bonus or deduction. The
default is 0:00.
Type: TimeDuration
Optional
Introduced in v5.1
ShiftReq
Shifts Required
Is the trigger is time of day (Type property is F) and BonusQualify is week or pay
period, number of shifts employees must work before they earn the bonus or
deduction. For a shift to qualify, it must meet the minimum and not exceed the
maximum shift length requirements. The default is 1.
Type: Integer
Optional
Introduced in v5.1
Sunday
Sunday
Boolean value that, when True, indicates that the bonus or deduction rule applies
to Sunday.
Type: Boolean
Optional
Introduced in v5.1
Thursday
Thursday
Boolean value that, when True, indicates that the bonus or deduction rule applies
to Thursday.
Type: Boolean
Optional
Introduced in v5.1
TimeOfDay
Time Of Day
When the trigger is time of day (Type property is F), time of day that triggers the
bonus or deduction in HH:mm format. The bonus or deduction applies when an
employeeís shift contains this time.
Type: Time
Optional
Introduced in v5.1
TrigpaycodeName
Trigger pay code name
When pay code is the trigger (Type property is B), pay code that triggers the
bonus or deduction. Apply this pay code to an hour type in the pay code
distribution. When employees earn hours during that zone, there is activity in the
pay code.
Type: String
Optional
Introduced in v5.1
Tuesday
Tuesday
Boolean value that, when True, indicates that the bonus or deduction rule applies
to Tuesday.
Type: Boolean
Optional
Introduced in v5.1
Type
Type
Deduct rule type that triggers the bonus or deduction. It can have one of the
following values:
• B: After a specified amount of time has accumulated in a certain pay code
• D: After a specified shift length
• F: When an employee works at a specified time of day
The default trigger is Length of Shift with the Shift Length Minimum set to 0:00
and Shift Length Maximum set to 99:59. This enables the bonus or deduction to
occur during any shift. The default locator is 4:00, and At or After and Before are
both set to 12:00 A.M.
Type: String
Optional
Introduced in v5.1
Wednesday
Wednesday
Boolean value that, when True, indicates that the bonus or deduction rule applies
to Wednesday.
Type: Boolean
Optional
Introduced in v5.1
WeekStart
Week Start
When the trigger is pay code (Type property is B) and BonusQualify is week,
number of the day of the week on which the timeframe accumulator resets. The
default is 1 (Monday).
Type: Integer
Optional
Introduced in v5.1
WSABreakRule Tag
Break Rule
The Break Rule tag enables you to list and update break rules.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSABreakRule
[ EndTime = Time ]
[ LongChgPoint = TimeDuration ]
[ LongException = TimeDuration ]
[ LongGrace = TimeDuration ]
[ LongRound = TimeDuration ]
[ MaxLength = TimeDuration ]
[ MediumGrace = TimeDuration ]
[ MediumRound = TimeDuration ]
[ Name = String ]
[ PaidAmount = Long ]
[ RelativeTo = String ]
[ ShortChgPoint = TimeDuration ]
[ ShortException = TimeDuration ]
[ ShortGrace = TimeDuration ]
[ ShortRound = TimeDuration ]
[ StartTime = Time ] />
Action Descriptions
RetrieveAllForUpdate
Returns all break rules for updating.
Return Value Type: Zero or more WSABreakRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all break rules.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified break rule for updating.
Return Value Type: WSABreakRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified break rule.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
EndTime
End Time
"Before" time in HH:mm format. This value, relative to the time in the
RelativeTo property, defines the end of a range of time in which the break rule
applies. The default is 0:00.
Type: Time
Optional
Introduced in v5.1
LongChgPoint
Long Change Point
Long change point in HH:mm format. This value determines the limit at which the
round and grace rules for the medium break interval are activated. The default is
0:00.
Type: TimeDuration
Optional
Introduced in v5.1
LongException
Long Exception
Long Exception in HH:mm format. This exception defines a long period of time
between an out-punch for a break and a returning in-punch. For example, it is
possible to identify employees who take long lunches. This exception identifies
that situation on the Timecard and on reports. The actual break interval is
compared to the Long Exception setting. If the interval is equal to or greater than
the Long Exception, the exception appears on timecards and reports. The default
is 24:00.
Type: TimeDuration
Optional
Introduced in v5.1
LongGrace
Long Grace
Grace rule (in HH:mm format) that applies to the long break interval. The default
is 0:00.
Type: TimeDuration
Optional
Introduced in v5.1
LongRound
Long Round
Round rule (in HH:mm format) that applies to the long break interval. The default
is 0:01.
Type: TimeDuration
Optional
Introduced in v5.1
MaxLength
Max Length
Maximum amount of time, in HH:mm format, that an employee can punch out
during a shift and still have the next punch recognized as the return in-punch for
that shift. The default is 0:30.
Type: TimeDuration
Optional
Introduced in v5.1
MediumGrace
Medium Grace
Grace rule (in HH:mm format) that applies to the medium break interval. The
default is 0:00.
Type: TimeDuration
Optional
Introduced in v5.1
MediumRound
Medium Round
Round rule (in HH:mm format) that applies to the medium break interval. The
default is 0:00.
Type: TimeDuration
Optional
Introduced in v5.1
Name
Name
Break rule name. The name can be up to 32 characters long, is case-insensitive,
and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
PaidAmount
Paid Amount
Paid amount of time in HH:mm format. Specify this amount if employees receive
compensation for their breaks. If you select this option, when employees take a
break that is equal to or less than the paid amount, no time is deducted from their
timecards. If they take a break that is longer than the paid amount, only the
incremental amount of time is deducted from their shifts. For example, the paid
amount is 30 minutes and employees punch out for 25 minutes. No time is
deducted from employeesís timecards. If they punch out for 45 minutes, then 15
minutes is deducted. The default is 0:00.
Type: Long
Optional
Introduced in v5.1
RelativeTo
Relative To
Value that determines how the values expressed in the StartTime and EndTime
properties are used. Valid values of the RelativeTo property are: "midnight",
"scheduledStart", and "actualStart". Relative to "midnight" sets the StartTime and
EndTime properties as fixed points in time, whereas Relative to "scheduledStart"
or "actualStart" makes them variable. "scheduledStart" depends on the employee
linking to a schedule, whereas "actualStart" does not. The default is "midnight".
Type: String
Optional
Introduced in v5.1
ShortChgPoint
Short Change Point
Short change point in HH:mm format. This value determines the limits at which
the round and grace rules for the normal and long break intervals are activated.
The default is 0:00.
Type: TimeDuration
Optional
Introduced in v5.1
ShortException
Short Exception
Short exception in HH:mm format. This exception defines a short period of time
between an out-punch for a break and a returning in-punch. For example, it is
possible to identify employees who take short lunches. This exception identifies
this situation on the Timecard and on reports. The actual break interval is
compared to the Short Exception setting. If the interval is equal to or less than the
Short Exception setting, the exception appears. The default is 0:00.
Type: TimeDuration
Optional
Introduced in v5.1
ShortGrace
Short Grace
Grace rule (in HH:mm format) that applies to the short break interval. The default
is 0:00.
Type: TimeDuration
Optional
Introduced in v5.1
ShortRound
Short Round
Round rule (in HH:mm format) that applies to the short break interval. The
default is 0:01.
Type: TimeDuration
Optional
Introduced in v5.1
StartTime
Start Time
"At or After" time in HH:mm format. This value, relative to the time in the
RelativeTo property, defines the beginning of a range of time in which the break
rule applies. The default is 0:00.
Type: Time
Optional
Introduced in v5.1
WSABreakTime Tag
Break Time
The BreakTime tag allows you to manage break times.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Retrieve"
Properties→
<WSABreakTime
[ BreakRuleName = String ]
[ MaxStart = Long ]
[ MinStart = Long ]
[ Name = String ]
[ OrderNum = Integer ] />
Action Descriptions
Retrieve
Returns the specified break time.
Return Value Type: WSABreakTime tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
BreakRuleName
Associated Break Rule
Name of the break rule associated with the scheduled break.
Type: String
Optional
Introduced in v5.1
MaxStart
Maximum start period
Maximum number of minutes that an employee is allowed to work before a
scheduled break must begin.
Type: Long
Optional
Introduced in v5.1
MinStart
Minimum start period
Minimum number of minutes that an employee must work before a scheduled
break.
Type: Long
Optional
Introduced in v5.1
Name
Name
Name of the break schedule time. The name is case-insensitive and must be
unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
OrderNum
Position in sequence
Order number that uniquely identifies this break schedule time with respect to the
specified break rule.
Type: Integer
Optional
Introduced in v5.1
WSACallInRule Tag
Call-In Rule
The Call-In Rule tag allows you to specify and manage rules that specify how
employees are compensated when they are on call, called back to work, or both.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSACallInRule
[ EarlyScheduleMargin = TimeDuration ]
[ HasTransferToCallback = Boolean ]
[ HasTransferToRegular = Boolean ]
[ IsCallbackDeducted = Boolean ]
[ IsGuaranteedAsSumOfShifts = Boolean ]
[ IsOnlyActualAmountDeducted = Boolean ]
[ IsPaidBothRegularAndCallback = Boolean ]
[ IsSeparateShift = Boolean ]
[ MaximumOnCall = TimeDuration ]
[ MinimumToQualify = TimeDuration ]
[ Name = String ]
[ OnCallLocator = Time ]
[ OnCallWorkRule = String ]
[ ShiftGuarantee = String ]
[ UnscheduledShiftLength = TimeDuration ] />
Action Descriptions
RetrieveAllForUpdate
Returns all call-in rules for updating.
Return Value Type: Zero or more WSACallInRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all call-in rules.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified call-in rule for updating.
Return Value Type: WSACallInRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified call-in rule.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
EarlyScheduleMargin
Early Schedule Margin
Length of time, in HH:mm format, of the early schedule margin that is defined for
the call-in rule. This amount of time specifies the earliest time that employees can
punch in early for a call-back shift and start accruing call-back hours. This
schedule margin overrides the early schedule margin in Punch Interpretation rules.
The default is 0:00.
Type: TimeDuration
Optional
Introduced in v5.1
HasTransferToCallback
Has Transfer To Callback
Boolean value that, when True, indicates that the Transfer to Callback at Regular
Schedule End option is selected for this call-in rule. When this option is selected:
• Employees are scheduled for regular shifts next to call-back shifts.
• Employees work during the call-back shift and regular shift.
• Employees stop accruing regular hours and start accruing call-back hours
when the call-back shift starts.
Type: Boolean
Optional
Introduced in v5.1
HasTransferToRegular
Has Transfer To Regular
Boolean value that, when True, indicates that the Transfer from Callback at
Regular Schedule Start option is selected for this call-in rule. When this option is
selected:
• Employees are scheduled for regular shifts next to call-back shifts.
• Employees work during the call-back shift and the regular shift.0
• Employees stop accruing call-back hours and start accruing regular hours
when the regular shift starts.
Type: Boolean
Optional
Introduced in v5.1
IsCallbackDeducted
Is Callback Deducted
Boolean value that, when True, indicates that the Deduct Call-Back from On-Call
option is selected for this call-in rule. When this option is selected, hours worked
or the guaranteed shift amount is deducted from the on-call hours that accrued.
Type: Boolean
Optional
Introduced in v5.1
IsGuaranteedAsSumOfShifts
Is Guaranteed As Sum Of Shifts
Boolean value that, when True, indicates that the shift guarantee for this call-in
rule applies to the entire on-call shift. When this value is False, the guarantee
applies only to the first call-back period worked.
Type: Boolean
Optional
Introduced in v5.1
IsOnlyActualAmountDeducted
Is Only Actual Amount Deducted
Boolean value that, when True, indicates that the Actual Amount Only option is
selected for this call-in rule. When this option is selected, only the actual amount
of time worked is deducted. When this value is False, the guaranteed shift amount
from the total on-call hours is deducted. This option is available only if you
selected Deduct call-back from On-Call.
Type: Boolean
Optional
Introduced in v5.1
IsPaidBothRegularAndCallback
Is Paid Both Regular And Callback
Boolean value that indicates, when True, a manual transfer is required to stop
accruing both regular and call-back hours during the regular shift.
Type: Boolean
Optional
Introduced in v5.1
IsSeparateShift
Is Separate Shift
Boolean value that, when True, indicates whether the Separate Shift from Other
Work Rules option is selected for this call-in rule. When this option is selected,
any worked span that uses this call-in rule is considered a separate shift.
Type: Boolean
Optional
Introduced in v5.1
MaximumOnCall
Maximum On-Call
Value, in HH:mm format, that indicates the maximum amount of on-call time that
is paid for each on-call shift. The default is 99:00, which is equivalent to no
maximum time specified.
Type: TimeDuration
Optional
Introduced in v5.1
MinimumToQualify
Minimum To Qualify
Amount of time, in HH:mm format, that employees must work before they start
accruing call-back hours. Actual punches are compared to the minimum. This
option prevents shifts that briefly enter an on-call shift from qualifying as call-
back hours. The default is 0:00.
Type: TimeDuration
Optional
Introduced in v5.1
Name
Name
Name of the call-in rule. The name is case-insensitive and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
OnCallLocator
On Call Locator
Value, in HH:mm format, that specifies at what time during a shift that on-call
hours start accumulating. The default is 0:00, which means hours start
accumulating at the beginning of the shift.
Type: Time
Optional
Introduced in v5.1
OnCallWorkRule
On-Call Work Rule
Name that identifies the work rule that is applied to on-call hours.
Type: String
Optional
Introduced in v5.1
ShiftGuarantee
Shift Guarantee
Name that identifies an existing shift guarantee to be assigned to this call-in rule.
Type: String
Optional
Introduced in v5.1
UnscheduledShiftLength
Unscheduled Shift Length
Value that represents when call-back shifts are invoked by an activity code at a
data collection device.
Type: TimeDuration
Optional
Value that indicates whether the Unscheduled Shift Length option is selected for
this call-in rule. If zero (0), the option is not selected; if one, the option is
selected.
Introduced in v5.1
WSACombinationRule Tag
Combination Rule
The Combination Rule tag allows you to manage combination rules.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "RetrieveForUpdate"
Properties→
<WSACombinationRule >
[ <Item>
<WSAOvertimeRule>
</Item> ]
[ <Key>
<WSAOvertimeRule>
</Key> ]
[ <Value>
<WSAOvertimeRule>
</Value> ]
</WSACombinationRule>
Action Descriptions
RetrieveForUpdate
Returns the specified combination rule for update.
Return Value Type: WSACombinationRule tag
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
Item
Item overtime rule
Combination item associated with this combination rule.
Type: WSAOvertimeRule tag
Optional
Introduced in v5.1
Key
Key overtime rule
Combination key associated with this combination rule.
Type: WSAOvertimeRule tag
Optional
Introduced in v5.1
Value
Value overtime rule
Combination value associated with this combination rule.
Type: WSAOvertimeRule tag
Optional
Introduced in v5.1
WSACombinedPayCodeRule Tag
Combined Pay Code Rule
The Combined Pay Code rule tag allows you to manage combined pay code rules.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSACombinedPayCodeRule
[ EffectiveDate = Date ]
[ MoneyCategory = Boolean ]
[ Name = String ]
[ SelectedPayCodes = String list ]
[ VisibleInReport = Boolean ]
[ VisibleToUser = Boolean ] />
Action Descriptions
RetrieveAllForUpdate
Returns all combined pay code rules for updating.
Return Value Type: Zero or more WSACombinedPayCodeRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all combined pay code rules.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified combined pay code rule for updating.
Return Value Type: WSACombinedPayCodeRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified combined pay code rule.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
EffectiveDate
Effective Date
Effective date of the combined pay code, in MM/DD/YYYY format.
Type: Date
Optional
Introduced in v5.1
MoneyCategory
Money Category
Boolean value that, when True, indicates that the pay code displays as money in
the Timecard totals. If a pay code type of time is specified, hours and total wages
appear on reports. If a pay code type of money is specified, hour amounts from
hour type of pay codes are converted to a monetary amount. The conversion
calculates wage rates with hour amounts, and the result is a total monetary
amount. Only monetary amounts appear on reports.
Type: Boolean
Optional
Introduced in v5.1
Name
Name
Name of the combined pay code rule. The name can be up to 32 characters long, is
case-insensitive and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
SelectedPayCodes
Selected Pay Codes
List of pay codes to be combined.
Type: String list
Optional
Introduced in v5.1
VisibleInReport
Visible In Report
Boolean value that, when True (the default), indicates that the combined pay code
is visible in Report options and totals.
Type: Boolean
Optional
Introduced in v5.1
VisibleToUser
Visible To User
Boolean value that, when True (the default), indicates that the pay code is visible
on the Totals tab in the timecard and, if Workforce Scheduler is installed, in the
Cost Summary tab in Schedule.
Type: Boolean
Optional
Introduced in v5.1
WSAComment Tag
WSA Comment
The WSAComment tag enables you to add or edit comments. The Comment and
WSAComment tags refer to the same database object.
All rules related to Comments and their relationship with CommentTypes
Function Access Control Point: WSA.Comment
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAComment
[ Active = Boolean ]
[ Text = String ] >
[ <Types>
<WSACommentType>∗
</Types> ]
</WSAComment>
Action Descriptions
RetrieveAllForUpdate
Returns all comments for update.
Return Value Type: Zero or more WSAComment tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all comments.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified comment for update.
Return Value Type: WSAComment tag
Required Properties: Text
Access Control Point Name: View
Introduced in v5.1
Update
This method uses the supplied WSAComment Bean info to either update (if a
comment with the supplied "Name" attribute exists in the DB already) or add
(otherwise) a comment with the information provided in the input stream. Note
that if you supply a value for the "Types" attribute, that value must be either one or
more WSACommentType bean entries. If you supply this information, the new/
updated comment will be assigned only to the comment categories/types which
you specify.
If you supply a value for the comment type/category attribute, "Types", you need
to provide at least one comment category for the target comment to be assigned to.
Return Value Type: None
Required Properties: Text
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
Active
Is the comment active?
Boolean value that, when True, indicates that the comment is active. This is the
default.
Type: Boolean
Optional
Introduced in v5.1
Text
Name of the WSA comment
Text of the comment. Each comment can have up to 256 characters and must be
unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
Types
Types assigned to the comment
One or more types assigned to a comment.
Type: Zero or more WSACommentType tags
Optional
Introduced in v5.1
WSACommentType Tag
Category of a Comment
The Comment Type tag enables you to retrieve and list the comment categories
and types defined in the database.
Function Access Control Point: WSA.Comment
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "RetrieveForUpdate"
Properties→
<WSACommentType
[ Name = String ] />
Action Descriptions
RetrieveForUpdate
Returns the specified comment type for update.
Return Value Type: WSACommentType tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
Name
Comment name
Name of the comment type.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSAContributingPayCodeRule Tag
Contributing Pay Code Rule
The Contributing Pay Code Rule tag allows you to manage contributing pay code
rules.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAContributingPayCodeRule
[ Name = String ] >
[ <PayCodeNames>
<SimpleValue>∗
</PayCodeNames> ]
</WSAContributingPayCodeRule>
Action Descriptions
RetrieveAllForUpdate
Returns all contributing pay code rules for updating.
Return Value Type: Zero or more WSAContributingPayCodeRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all contributing pay code rules.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified contributing pay code rule for updating.
Return Value Type: WSAContributingPayCodeRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified contributing pay code rule.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
Name
Name
Name of the contributing pay code rule. The name is case-insensitive and must be
unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
PayCodeNames
Pay code names
List of the names of pay codes that are part of the contributing pay code rule.
Type: Zero or more SimpleValue tags
Optional
Introduced in v5.1
WSAContributingShiftRule Tag
Contributing Shift Rule
The Contributing Shift Rule tag allows you to manage contributing shift rules.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAContributingShiftRule
[ ContributingPayCodeRuleName = String ]
[ DaysOfWeekIncludeType = String ]
[ LookBackTime = Integer ]
[ LookBackUnit = String ]
[ MinimumShiftLength = TimeDuration ]
[ Name = String ] >
[ <Days>
<SimpleValue>∗
</Days> ]
</WSAContributingShiftRule>
Action Descriptions
RetrieveAllForUpdate
Returns all contributing shift rules for updating.
Return Value Type: Zero or more WSAContributingShiftRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all contributing shift rules.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified contributing shift rule for updating.
Return Value Type: WSAContributingShiftRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified contributing shift rule.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
ContributingPayCodeRuleName
Name of the contributing pay code rule
Name of the contributing pay code rule for this contributing shift rule. This
property is required when adding a new rule; it is optional when updating an
existing rule.
Type: String
Optional
Introduced in v5.1
Days
List of days
List of those days of the week (for example, Monday, TuesdayÖ, Sunday) that
count toward contributing shifts when the Specify option is selected in the Days of
the Week Include Type property.
Type: Zero or more SimpleValue tags
Optional
Introduced in v5.1
DaysOfWeekIncludeType
Include type for day of the week
Day of week include type. This value indicates how the days of the week are
included in the contributing shifts that qualify for holiday credit. The following
values can be specified:
• A -- Include all days in the period preceding a holiday for the period of days
specified in the Look Back Time property.
• H -- Include only the day of the week on which a holiday falls for the period
of days specified in the Look Back Time column property.
• S -- Include the day of the week the user specifies for the period of days
specified in the Look Back Time property.
Type: String
Optional
Introduced in v5.1
LookBackTime
Look back time
Number of days, weeks, or months immediately preceding the holiday. It is
necessary for a shift to occur during this time period to be considered a
contributing shift.
Type: Integer
Optional
Introduced in v5.1
LookBackUnit
Look back unit
Unit of time specified as the look back time (days, weeks, or months).
Type: String
Optional
Introduced in v5.1
MinimumShiftLength
Minimum length of shift
Minimum length of time, in HH:mm format, for a shift that satisfies the conditions
for the contributing shifts rule relative to a holiday.
Type: TimeDuration
Optional
Introduced in v5.1
Name
Name
Name of the contributing shift rule. The name can be up to 32 characters long, is
case-insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSACoreHoursRule Tag
Core Hours Rule
The Core Hours Rule tag allows you to describe and manage rules that define
specific ranges of time during which employees are expected to work.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSACoreHoursRule
[ AtLeastSelected = Boolean ]
[ BreaksViolate_SW = Boolean ]
[ Description = String ]
[ EndTime = Time ]
[ Friday = Boolean ]
[ Monday = Boolean ]
[ Name = String ]
[ Saturday = Boolean ]
[ StartTime = Time ]
[ Sunday = Boolean ]
[ Thursday = Boolean ]
[ Tuesday = Boolean ]
[ Wednesday = Boolean ] />
Action Descriptions
RetrieveAllForUpdate
Returns all core hours rules for updating.
Return Value Type: Zero or more WSACoreHoursRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all core hours rules.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified core hours rule for updating.
Return Value Type: WSACoreHoursRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified core hours rule.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
AtLeastSelected
At Least Selected
At Least Selected
Type: Boolean
Optional
Introduced in v5.1
BreaksViolate_SW
Breaks violate switch
Boolean value that, when True (the default), indicates that a break taken in a core
hours time span is considered a violation and will be flagged as an exception.
Type: Boolean
Optional
Introduced in v5.1
Description
Description
Description that identifies violations of core hours rules. The Exceptions report
shows this description. For example, you could call the violation "Morning Core
Hours Violation."
Type: String
Optional
Introduced in v5.1
EndTime
End Time
Ending time, in HH:mm AM|PM format, of a specific range of time during which
employees are expected to work. The default is 12:00 AM.
Type: Time
Optional
Introduced in v5.1
Friday
Friday
Boolean value that, when True, indicates that the core hours rule applies to Friday.
By default, this value is False.
Type: Boolean
Optional
Introduced in v5.1
Monday
Monday
Boolean value that, when True, indicates that the core hours rule applies to
Monday. By default, this value is False.
Type: Boolean
Optional
Introduced in v5.1
Name
Name
Name of the core hours rule. The name can be up to 32 characters long, is case-
insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
Saturday
Saturday
Boolean value that, when True, indicates that the core hours rule applies to
Saturday. By default, this value is False.
Type: Boolean
Optional
Introduced in v5.1
StartTime
Start Time
Starting time, in HH:mm AM|PM format, of a specific range of time during
which employees are expected to work. The default is 12:00 AM.
Type: Time
Optional
Introduced in v5.1
Sunday
Sunday
Boolean value that, when True, indicates that the core hours rule applies to
Sunday. By default, this value is False.
Type: Boolean
Optional
Introduced in v5.1
Thursday
Thursday
Boolean value that, when True, indicates that the core hours rule applies to
Thursday. By default, this value is False.
Type: Boolean
Optional
Introduced in v5.1
Tuesday
Tuesday
Boolean value that, when True, indicates that the core hours rule applies to
Tuesday. By default, this value is False.
Type: Boolean
Optional
Introduced in v5.1
Wednesday
Wednesday
Boolean value that, when True, indicates that the core hours rule applies to
Wednesday. By default, this value is False.
Type: Boolean
Optional
Introduced in v5.1
WSACreditCalculator Tag
Credit Calculator
The Credit Calculator tag allows you to manage credit calculations for holiday
credit rules. It is meant for use only within the WSAHolidayCredit rule tag.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Properties→
<WSACreditCalculator
[ ApplyHour = Long ]
[ AsIfWorkedSwitch = Boolean ]
[ AverageDaysMinimum = Integer ]
[ AverageFixedNumber = Integer ]
[ AverageShiftsMinimum = Integer ]
[ AverageSwitch = Long ]
[ AverageType = Long ]
[ ContributingShiftName = String ]
[ CreditFixedAmount = Long ]
[ CreditWageAmount = String ]
[ DefinedHolidayZone = Long ]
[ Grace = TimeDuration ]
[ HolidayDeduct = String ]
[ HolidayPolicy = String ]
[ MaxAmount = Long ]
[ Round = TimeDuration ]
[ Type = Long ]
[ UseAllShiftsSwitch = Boolean ]
[ WageCalculation = Boolean ]
[ WagePercent = String ]
[ WorkRuleName = String ] >
[ <CreditPayCodeNames>
<SimpleValue>∗
</CreditPayCodeNames> ]
</WSACreditCalculator>
Property Descriptions
ApplyHour
Apply hour
Apply hour.
Type: Long
Optional
Introduced in v5.1
AsIfWorkedSwitch
Set as if worked?
Boolean value that indicates whether the holiday credit was paid using work rules
or selected pay code rules. This property can have the following values:
• 0 -- Distribute to the pay codes that would have been in effect, had the
employee worked the scheduled hours on a
nonholiday day.
• 1 -- Distribute to selected pay codes.
Type: Boolean
Optional
Introduced in v5.1
AverageDaysMinimum
Average Days Minimum
Minimum number of days required to calculate the average shift length.
Type: Integer
Optional
Introduced in v5.1
AverageFixedNumber
Average fixed number
Average shift length when Fixed Number is selected in the Average Type
property.
Type: Integer
Optional
Introduced in v5.1
AverageShiftsMinimum
Average shift minimum
Minimum number of shifts required to calculate the average shift length.
Type: Integer
Optional
Introduced in v5.1
AverageSwitch
Average switch for average type
Average swtich for AverageType.
Type: Long
Optional
Introduced in v5.1
AverageType
Average type
Value that indicates which types of criteria are required to calculate the average
shift length, using the calculation: total number of qualified hours/total number of
days or shifts. This property can have the following values:
• 0 -- The divisor of the previous calculation equals the number of shifts that
satisfies the qualifying conditions, such as those specified by Contributing
Shifts.
• 1 -- The divisor of the previous calculation equals the number of days that
contain at least one qualified shift.
Type: Long
Optional
Introduced in v5.1
ContributingShiftName
Name of the contributing shift rule
Type: Long
Optional
Introduced in v5.1
Grace
Grace
Value, expressed in HH:mm format, that is used in calculating an average shift
length. The value is rounded to a multiple of a specific
increment. The Holiday Credit Rules Hours Credits configuration determines the
grace values for the rounding rule.
Type: TimeDuration
Optional
Introduced in v5.1
HolidayDeduct
Holiday deduction
String value that indicates how to deduct the time from the holiday credit. This
property can have the following values:
• A -- Worked time that satisfies any Holiday Zone rule for the given holiday
has no effect on holiday credits.
• N -- Holiday credits are reduced by the amount of worked time that satisfies a
Holiday Zone rule for the particular holiday
• W -- All holiday credits are cancelled if any worked time satisfies a Holiday
Zone rule on a particular holiday.
Type: String
Optional
Introduced in v5.1
HolidayPolicy
Holiday policy
Holiday policy.
Type: String
Optional
Introduced in v5.1
MaxAmount
Maximum amount
Maximum amount of holiday credits that can be issued by a particular holiday
credit rule.
Type: Long
Optional
Introduced in v5.1
Round
Round
Value, expressed in HH:mm format, that is used when calculating an average shift
length. The value is rounded to a multiple of a specific increment. The Holiday
Credit Rules Hours Credits configuration determines the round values for the
rounding rule.
Type: TimeDuration
Optional
Introduced in v5.1
Type
Type
Method used to calculate the holiday credit. This property can have the following
values:
• 0 -- Fixed hours or wages. A set number of hours or wages issued as holiday
credit. This amount does not change from holiday to holiday.
• 1 -- Average actual wage. The actual wages for a specified period of time
immediately preceding the holidays.
• 2 -- Hours from schedule. The number of holiday credits is based on what the
employee would have scheduled for the day of the holiday.
• 3 -- Average shift length. An averaged value of the total wages paid for
qualified shifts during a specified time period immediately preceding the
holiday.
• 4 -- Percent of wages. A fixed percentage of the total wages paid for qualified
shifts during a specified time period immediately preceding the holiday.
• 5 -- Average base wage. The base wage for a specified time period
immediately preceding the holiday.
Type: Long
Optional
Introduced in v5.1
UseAllShiftsSwitch
Should the all shifts switch be used?
Boolean value that indicates how to calculate multiple shifts when the Type
property has a value of hours from schedule. If multiple scheduled
shifts exist for a particular day, you can determine holiday credits by using one of
the following shift values:
• 0 -- First shift. Holiday credits equal the number of hours for the first
scheduled shift of the day.
• 1 -- Sum of all shifts. Holiday credits equal the sum of hours for all the
scheduled shifts of the day.
Type: Boolean
Optional
Introduced in v5.1
WageCalculation
Wage calculation
Boolean value that indicates how the wages are calculated for the Average Wage
option in the Type property. It can have the following values:
• 0 -- Use base wage rate. The holiday credit, as a monetary amount, is the
product of the average shift length and the employee's base wage.
• 1 -- Use actual wages. This option disables the Round and Grace properties.
Type: Boolean
Optional
Introduced in v5.1
WagePercent
Wage percentage
Percentage of the total wages paid as a holiday credit.
Type: String
Optional
Introduced in v5.1
WorkRuleName
Work rule
Name of the work rule that would apply if an employee works on a day on which
he or she was scheduled to be off.
Type: String
Optional
Introduced in v5.1
WSADaysOfWeek Tag
Days of Week
Internal use only. For use with Zone/Zone Combination rules.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "RetrieveForUpdate"
Properties→
<WSADaysOfWeek
[ AtLeastSelected = Boolean ]
[ Friday = Boolean ]
[ Monday = Boolean ]
[ Saturday = Boolean ]
[ Sunday = Boolean ]
[ Thursday = Boolean ]
[ Tuesday = Boolean ]
[ Wednesday = Boolean ] />
Action Descriptions
RetrieveForUpdate
Retrieve the specified instance from the DB
Return Value Type: WSADaysOfWeek tag
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
AtLeastSelected
Is the at least selected flag set?
The AtLeastSelected flag.
Type: Boolean
Optional
Introduced in v5.1
Friday
Is Friday included?
Boolean value that, when True, indicates that Friday is included.
Type: Boolean
Optional
Introduced in v5.1
Monday
Is Monday included?
Boolean value that, when True, indicates that Monday is included.
Type: Boolean
Optional
Introduced in v5.1
Saturday
Is Saturday included?
Boolean value that, when True, indicates that Saturday is included.
Type: Boolean
Optional
Introduced in v5.1
Sunday
IsSunday included?
Boolean value that, when True, indicates that Sunday is included.
Type: Boolean
Optional
Introduced in v5.1
Thursday
IsThursday included?
Boolean value that, when True, indicates that Thursday is included.
Type: Boolean
Optional
Introduced in v5.1
Tuesday
Is Tuesday included?
Boolean value that, when True, indicates that Tuesday is included.
Type: Boolean
Optional
Introduced in v5.1
Wednesday
Is Wednesday included?
Boolean value that, when True, indicates that Wednesday is included.
Type: Boolean
Optional
Introduced in v5.1
WSADisplayOrder Tag
Display Order
The DisplayOrder tag allows you to control the order in which single and
combined pay codes appear in list boxes in Workforce Timekeeper. The order of
this list also affects which pay code receives accrual code payouts. If there is more
than one pay code that deducts from the accrual balance, the pay code that is listed
first in the Display Order window receives the transfer.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSADisplayOrder
[ Name = String ] >
[ <PaycodesList>
<WSADispOrdOptionalRule>∗
</PaycodesList> ]
</WSADisplayOrder>
Action Descriptions
RetrieveAllForUpdate
Returns all display orders for updating.
Return Value Type: Zero or more WSADisplayOrder tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all display orders.
Return Value Type: Zero or more NameList tags
Access Control Point Name: Edit
Introduced in v5.1
RetrieveForUpdate
Returns the specified display order for updating.
Return Value Type: WSADisplayOrder tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified display order.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
Name
Name of the display order
Name of the display order. The name is case-insensitive and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
PaycodesList
Pay codes list
Ordered list of paycodes.
Type: Zero or more WSADispOrdOptionalRule tags
Optional
Introduced in v5.1
WSADispOrdOptionalRule Tag
Display Order Optional Rule
The Display Order Optional Rule tag allows you to manage the display order
optional rule.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "RetrieveForUpdate"
Properties→
<WSADispOrdOptionalRule
[ ListOrder = Integer ]
[ Name = String ] />
Action Descriptions
RetrieveForUpdate
Retrieves for Update
Return Value Type: WSADispOrdOptionalRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
ListOrder
Order of the list
WSAEffectivePayRule Tag
Effective Dated Version of Pay Rule
The Effective Dated Version of Pay Rule tag allows you to manage effectively
dated versions of pay rules. A pay rule contains general payroll rules such as type
of pay period (for example, weekly). A complete pay rule controls such items as
the pay period length, the day divide, when punches link to schedules, when data
collection devices accept and reject punches, which holidays give holiday credits,
and the order that hour types are processed.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Retrieve"
Properties→
<WSAEffectivePayRule
[ ApplyOnly = Boolean ]
[ EffectiveDate = Long ]
[ FixedRuleName = String ]
[ HolidayCreditRuleName = String ]
[ LaborAccountAndJobTransfers = Boolean ]
[ Name = String ]
[ PayFromSchedule = Boolean ]
[ PrepopulateProject = Boolean ]
[ QualifiedSignOffRuleName = String ]
[ ScheduleTotal = Boolean ]
[ SequenceRuleName = String ]
[ TerminalRuleName = String ]
[ WorkRuleName = String ]
[ WorkRuleTransfers = Boolean ] >
[ <AssignmentRules>
<WSAAssignmentRule>∗
</AssignmentRules> ]
[ <Holidays>
<WSAPayRuleHoliday>∗
</Holidays> ]
</WSAEffectivePayRule>
Action Descriptions
Retrieve
Returns the effective pay rule selected by name and effective date.
Return Value Type: WSAEffectivePayRule tag
Required Properties: Name, EffectiveDate
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
ApplyOnly
Is apply only enabled?
Boolean value that, when True, enables scheduled pay code edits to be applied to
the timecard, even if punches or other edits are made. A pay code edit that is
entered manually is not considered.
Type: Boolean
Optional
Introduced in v5.1
AssignmentRules
Assignment rules
List of assignment rules that allows a work rule to be assigned to a specific time
period. When employees qualify for an assigned shift, the assigned work rule
applies, not their default work rule.
Type: Zero or more WSAAssignmentRule tags
Optional
Introduced in v5.1
EffectiveDate
Effective date
Effective date span of this pay rule version.
Type: Long
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
FixedRuleName
Associated fixed rule
Name of the associated fixed rule that identifies constant pay policies that are
assigned to employees.
Type: String
Optional
Introduced in v5.1
HolidayCreditRuleName
Associated holiday credit rule
Name of associated holiday credit rule that determines if an employee is eligible
to receive holiday credits and the amount of holiday credits the employee can
receive.
Type: String
Optional
Introduced in v5.1
Holidays
Holidays
List of holidays that give holiday credits to the employees who are assigned to this
pay rule.
Type: Zero or more WSAPayRuleHoliday tags
Optional
Introduced in v5.1
LaborAccountAndJobTransfers
Are labor account and job transfers enabled?
Boolean value that, when True, enables labor account and job transfers for this
effective pay rule.
Type: Boolean
Optional
Introduced in v5.1
Name
Name
Name of the pay rule. The name is case-insensitive and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
PayFromSchedule
Is pay from schedule enabled?
Boolean value that, when True, enables paying from schedules for this effective
pay rule.
Type: Boolean
Optional
Introduced in v5.1
PrepopulateProject
Should projects be prepopulated?
Boolean value that, when True, enables project prepopulation for this effective
pay rule. When this option is enabled, a project view timecard is prepopulated
with the transfer accounts that were used in the previous pay period.
Type: Boolean
Optional
Introduced in v5.1
QualifiedSignOffRuleName
Name associated with the qualified sign-off rule
Name of associated qualified sign-off rule that restricts a managerís ability to
sign-off, if specific conditions are not met.
Type: String
Optional
Introduced in v5.1
ScheduleTotal
Is schedule total enabled?
Boolean value that, when True, enables the schedule total option for this rule.
When this option is enabled, scheduled and projected totals are stored in the
database.
Type: Boolean
Optional
Introduced in v5.1
SequenceRuleName
Associated processing order rule
Name of associated processing order rule that defines the order in which
accumulated hour types are processed.
Type: String
Optional
Introduced in v5.1
TerminalRuleName
Punch interpretation rule
Name of associated punch interpretation rule that determines when punches link
to schedules and when data collection devices accept and reject punches.
Type: String
Optional
Introduced in v5.1
WorkRuleName
Associated work rule
Name of the associated work rule that identifies the work rule that interprets and
calculate employee time.
Type: String
Optional
Introduced in v5.1
WorkRuleTransfers
Is this a work rule transfer?
Boolean value that, when True, enables the work rule transfers option for this
effective pay rule. When this option is enabled, any work rule transfer that was
entered is allowed to continue until a new transaction (employee punch, Timecard
edit, or Group Edit) is entered.
Type: Boolean
Optional
Introduced in v5.1
WSAEffectiveWorkRule Tag
Effective Version of Work Rule
The Effective Version of Work Rule tag allows you to manage effectively dated
versions of work rules. Work rules determine how employee hours accrue.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Retrieve"
Properties→
<WSAEffectiveWorkRule
[ CallInRuleName = String ]
[ DayDivideOverride = String ]
[ EffectiveDate = Long ]
[ ExceptionRuleName = String ]
[ Name = String ]
[ PayCodeDistributionName = String ]
[ RoundRuleName = String ]
[ ShiftGuaranteeName = String ]
[ UnapprovedOvertimePayCodeName = String ] >
[ <AutoBreakPlacement>
<WSAAutoBreakPlacement>
</AutoBreakPlacement> ]
[ <WorkRuleGeneral>
<WSAWorkRuleGeneral>
</WorkRuleGeneral> ]
[ <WorkRulePCDistr>
<WSAWorkRulePCDistr>
</WorkRulePCDistr> ]
</WSAEffectiveWorkRule>
Action Descriptions
Retrieve
Returns the effective work rule selected by name and effective date.
Return Value Type: WSAEffectiveWorkRule tag
Required Properties: Name, EffectiveDate
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
AutoBreakPlacement
Automatic break placement configuration
Automatic break placement configuration for this work rule.
Type: WSAAutoBreakPlacement tag
Optional
Introduced in v5.1
CallInRuleName
Associated call-in rule
Name of associated call-in rule.
Type: String
Optional
Introduced in v5.1
DayDivideOverride
Associated day divide override rule
Name of associated day divide override rule.
Type: String
Optional
Introduced in v5.1
EffectiveDate
Effective date
Optional
Introduced in v5.1
ShiftGuaranteeName
Name of shift guarantee
Name of associated shift guarantee.
Type: String
Optional
Introduced in v5.1
UnapprovedOvertimePayCodeName
Pay code for unapproved overtime
Name of pay code to use for unapproved overtime.
Type: String
Optional
Introduced in v5.1
WorkRuleGeneral
Configuration for general work rule
General work rule configuration settings.
Type: WSAWorkRuleGeneral tag
Optional
Introduced in v5.1
WorkRulePCDistr
Pay code distribution for this work rule
Name of the pay code distribution associated with this work rule.
Type: WSAWorkRulePCDistr tag
Optional
Introduced in v5.1
WSAEligibilityDeterminer Tag
Eligibility Requirements
The Eligibility Requirements tag allows you to manage the requirements an
employee must meet to be eligible for holiday credits.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Properties→
<WSAEligibilityDeterminer
[ AfterHolidaySwitch = Boolean ]
[ AlternateHolidayCreditRuleName = String ]
[ BeforeHolidaySwitch = Boolean ]
[ EitherBeforeOrAfterHolidaySwitch = Boolean ]
[ MinimumTimeActiveUnit = String ]
[ MinimumTimeActiveValue = Integer ]
[ MinimumTimeEmployedUnit = String ]
[ MinimumTimeEmployedValue = Integer ]
[ MustSatisfyAllSwitch = Boolean ]
[ OnHolidaySwitch = Boolean ]
[ ScheduledShiftTypeSwitch = Boolean ] >
[ <EligibilityWorkHistoryQualifierNames>
<SimpleValue>∗
</EligibilityWorkHistoryQualifierNames> ]
</WSAEligibilityDeterminer>
Property Descriptions
AfterHolidaySwitch
Must the employee work after the holiday?
Boolean value that, when True, indicates that the employee must work after the
holiday to be eligible for this credit.
Type: Boolean
Optional
Introduced in v5.1
AlternateHolidayCreditRuleName
Name of the alternate holiday credit rule
Name of the alternate holiday credit rule. An alternate holiday credit rule is used if
the eligibility requirements for the primary holiday credit rule are not satisfied.
Type: String
Optional
Introduced in v5.1
BeforeHolidaySwitch
Must the employee work before the holiday?
Boolean value that, when True, indicates that the employee must work before the
holiday to be eligible for this credit.
Type: Boolean
Optional
Introduced in v5.1
EitherBeforeOrAfterHolidaySwitch
Must the employee work before or after the holiday?
Boolean value that, when True, indicates that the employee must work either
before or after the holiday to be eligible for this credit.
Type: Boolean
Optional
Introduced in v5.1
EligibilityWorkHistoryQualifierNames
Work history qualifiers
One or more work history qualifiers that must be satisfied in order for an
employee to receive this credit.
Type: Zero or more SimpleValue tags
Optional
Introduced in v5.1
MinimumTimeActiveUnit
Unit of time for minimum amount of active time
Unit of time used for the minimum time an employee must be active prior to a
holiday in order to be eligible for holiday credits. Possible values are: Days,
Weeks, and Months.
Type: String
Optional
Introduced in v5.1
MinimumTimeActiveValue
Amount of active time to be elegible for holiday credits
Minimum number of days, weeks, or months for an employee to be active prior to
a holiday, in order to be eligible for holiday credits.
Type: Integer
Optional
Dependency: If specified, MinimumTimeActiveUnit must also be specified.
Introduced in v5.1
MinimumTimeEmployedUnit
Unit of time for minumum time employed
Units of time (days, weeks, or months) used for the minimum time an employee
must be employed prior to a holiday in order to be eligible for holiday credits.
Type: String
Optional
Introduced in v5.1
MinimumTimeEmployedValue
Minimum amount of time employeed to be eligible for holiday credits
Minimum number of days, weeks, or months for an employee to be employed
prior to a holiday, in order to be eligible for holiday credits.
Type: Integer
Optional
WSAExceptionRule Tag
Exception Rule
The Exception Rule tag allows you to define and manage rules by which to
identify employees who arrive at work early or late, leave work early or late,
forget to punch out, and work when not scheduled.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAExceptionRule
[ InEarly = TimeDuration ]
[ InLate = TimeDuration ]
[ InVeryEarly = TimeDuration ]
[ LongInterval = TimeDuration ]
[ Name = String ]
[ OutEarly = TimeDuration ]
[ OutLate = TimeDuration ]
[ OutVeryLate = TimeDuration ]
[ ShortShift = TimeDuration ]
[ Unscheduled = Boolean ] />
Action Descriptions
RetrieveAllForUpdate
Returns all exception rules for updating.
Property Descriptions
InEarly
In Early
Amount for early in-punches in HH:mm format. Exceptions occur when
employees punch in before their scheduled start times and at or before the early in
amount. The default is 24:00, which disables these exceptions.
Type: TimeDuration
Optional
Introduced in v5.1
InLate
In Late
Amount for late in-punches in HH:mm format. Exceptions occur when
employees punch in after their scheduled start times and at or after the late in
amount.
Type: TimeDuration
Optional
Introduced in v5.1
InVeryEarly
In Very Early
Amount for very early in-punches in HH:mm format. Exceptions appear when
employees punch in before their scheduled start times and at or before the very
early in amount. The default is 24:00, which disables these exceptions.
Type: TimeDuration
Optional
Introduced in v5.1
LongInterval
Long Interval
Long interval in HH:mm format. This property defines an unusually long period
of time between an in-punch and an out-punch. The rounded time between the
punches is used to compute this exception. If it equals or is greater than the long
interval, the long exception appears on the Timecard and on reports. By default,
this value is 99:00.
Type: TimeDuration
Optional
Introduced in v5.1
Name
Name
Introduced in v5.1
ShortShift
Short Shift
The duration of a short shift in HH:mm format. Exceptions appear when rounded
shift lengths are less than or equal to the short shift setting. The default value is
0:00.
Type: TimeDuration
Optional
Introduced in v5.1
Unscheduled
Unscheduled
Boolean value that, when True, indicates that an exception should occur when an
unscheduled employee punches in. By default this value is False.
Type: Boolean
Optional
Introduced in v5.1
WSAFixedRule Tag
Fixed Rule
The Fixed Rule tag allows you to define and manage rules that identify constant
pay policies that are assigned to employees.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAFixedRule
[ ApplyToDate = String ]
[ Name = String ] >
[ <PayPeriodType>
<WSAPayPeriod>
</PayPeriodType> ]
</WSAFixedRule>
Action Descriptions
RetrieveAllForUpdate
Returns all fixed rules for updating.
Return Value Type: Zero or more WSAFixedRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all fixed rules.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified fixed rule for updating.
Return Value Type: WSAFixedRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified fixed rule.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
ApplyToDate
Date when the rule is applied
Day when the pay period begins. Possible values include:
• S -- Scheduled in-day
• E -- Scheduled out-day
• M -- Day with majority hours
• A -- Day actually worked
Type: String
Optional
Introduced in v5.1
Name
Name of the fixed rule
Name of the fixed rule. The name can be up to 32 characters long, is case-
insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
PayPeriodType
Type of pay period
Pay period type. The pay period type can be days, semi-monthly, or monthly.
Type: WSAPayPeriod tag
Optional
Sample values: Days, Months
Introduced in v5.1
WSAFunctionAccessProfile Tag
WSA Function Access Profile
The WSAFunctionAccessProfile tag allows you to define and manage profiles
that determine the system components that users can access and the types of
functions that users can perform. The FunctionAccessProfile and
WSAFunctionAccessProfile tags refer to the same database object.
Function Access Control Point: WSA.AccessProfiles
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAFunctionAccessProfile
[ AllowsAll = Boolean ]
[ Description = String ]
[ IsDefault = Boolean ]
[ Name = String ] >
[ <Permissions>
<WSAPermission>∗
</Permissions> ]
</WSAFunctionAccessProfile>
Action Descriptions
RetrieveAllForUpdate
Returns all function access profiles for updating.
Return Value Type: Zero or more WSAFunctionAccessProfile tags
Property Descriptions
AllowsAll
Does the profile allow all?
Boolean value that, when True, indicates that the function access profile includes
all functions in the system.
Type: Boolean
Optional
Introduced in v5.1
Description
Description
Description of the function access profile.
Type: String
Optional
Introduced in v5.1
IsDefault
Is this the default function access profile?
Boolean value that, when True, makes this the default function access profile for
new users.
Type: Boolean
Optional
Introduced in v5.1
Name
Function access profile name
Name of the function access profile. The name is case-insensitive and must be
unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
Permissions
Permissions associated with the profile
Set of permissions and restrictions that determine which components users can
access and the types of functions they can perform. Permissions are associated
with points in the hierarchy of functions, known as access control points. The
access control points can apply to an entire component, or to specific functions
like printing or editing.
Type: Zero or more WSAPermission tags
Optional
Introduced in v5.1
WSAHoliday Tag
WSA Holiday
The WSAHoliday tag allows you to define a holiday for credits or zones. The
Holiday and WSAHoliday tags refer to the same database object.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAHoliday
[ EndDate = Date ]
[ EndTime = Time ]
[ Name = String ]
[ StartDate = Date ]
[ StartTime = Time ] />
Action Descriptions
RetrieveAllForUpdate
Returns all holidays for updating.
Return Value Type: Zero or more WSAHoliday tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all holidays.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified holiday for updating.
Return Value Type: WSAHoliday tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified holiday.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
EndDate
Holiday end date
Date when the holiday ends, in MM/DD/YYYY format. Specify start and end
dates and times for each year, because holidays do not carry over from year to
year.
Type: Date
Optional
Introduced in v5.1
EndTime
Holiday end time
WSAHolidayCreditRule Tag
Holiday Credit Rule
The Holiday Credit Rule tag allows you to define the requirements for holiday
credit, as well as the calculations used to determine the time or wages to be issued
when the requirements are met.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAHolidayCreditRule
[ DayOvertimeLimitPayCodeName = String ]
[ DayOvertimeLimitType = Integer ]
[ Name = String ]
[ OvertimeLimitPayCodeName = String ]
[ OvertimeLimitType = Integer ] >
[ <WSACreditCalculator>
<WSACreditCalculator>
</WSACreditCalculator> ]
[ <WSAEligibilityDeterminer>
<WSAEligibilityDeterminer>
</WSAEligibilityDeterminer> ]
</WSAHolidayCreditRule>
Action Descriptions
RetrieveAllForUpdate
Returns all holiday credit rules for updating.
Return Value Type: Zero or more WSAHolidayCreditRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all holiday credit rules.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified holiday credit rule for updating.
Return Value Type: WSAHolidayCreditRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified holiday credit rule.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
DayOvertimeLimitPayCodeName
Pay Code for Daily Overtime Limit
Consecutive day overtime pay code.
Type: String
Optional
The number of hours over the limit that must be worked in a day before overtime
hours apply for a pay code
Introduced in v5.1
DayOvertimeLimitType
Daily overtime limit type
Value that indicates whether the holiday credits count toward consecutive day
overtime limits. It is only relevant when holiday credits are distributed to time-
type pay codes such as fixed hours, or average shift length. The following are
possible values for this property:
• 0 -- The holiday credits never count toward overtime limits.
• 1 -- The holiday credits always count toward overtime limits.
• 2 -- The holiday credits count toward overtime limits as specified in the pay
code.
Type: Integer
Optional
Introduced in v5.1
Name
Name of the holiday credit rule
Name of the holiday credit rule. The name can be up to 32 characters long, is
case-insensitive, and must be unique.
Type: String
Optional
The name must be unique.
Maximum length: 50 characters
Contributes to Uniqueness: Yes
Introduced in v5.1
OvertimeLimitPayCodeName
Pay Code for Overtime Limit
WSAIntervalRoundRule Tag
Rounding Rule for an Interval
The Rounding Rule for an Interval tag allows you to define a rule that rounds
periods of time instead of individual start and end times, and applies a round and a
grace to the entire amount of time.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAIntervalRoundRule
[ Grace = TimeDuration ]
[ IsMissedOutException = Boolean ]
[ Name = String ]
[ Round = TimeDuration ]
[ UseScheduledOut = Boolean ] />
Action Descriptions
RetrieveAllForUpdate
Returns all interval round rules for updating.
Return Value Type: Zero or more WSAIntervalRoundRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all interval round rules.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified interval round rule for updating.
Return Value Type: WSAIntervalRoundRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified interval round rule.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
Grace
Grace period
Grace period, in HH:mm format.
Type: TimeDuration
Optional
Introduced in v5.1
IsMissedOutException
Is a missed-out exception reported?
WSALaborLevel Tag
Labor Level
The WSALaborLevel tag allows you to create and edit labor level definitions for
your site. The LaborLevelDefinition and WSALaborLevel tags refer to the same
database object.
Function Access Control Point: WSA.LaborLevel
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSALaborLevel
[ Abbreviation = String ]
[ CanOverrideMinMaxSwitch = Boolean ]
[ EncodedName = String ]
[ MaxNameLength = Integer ]
[ MinNameLength = Integer ]
[ ValidateAllNewEntriesSwitch = Boolean ] />
Action Descriptions
RetrieveAllForUpdate
Returns all labor levels for updating.
Return Value Type: Zero or more WSALaborLevel tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all labor levels.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified labor level for updating.
Return Value Type: WSALaborLevel tag
Required Properties: EncodedName
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified labor level.
Return Value Type: None
Required Properties: EncodedName
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
Abbreviation
Short name for a labor level
Short name for the labor level. The short labor level name can be up to 20
characters long.
Type: String
Optional
Sample values: Div, Dept
Introduced in v5.1
CanOverrideMinMaxSwitch
Can minimum or maximum length for the labor level name be overridden?
Boolean value that allows, if True, users to override the configured number of
minimum and maximum characters when they create a labor level entry for this
labor level. Even with this property set, there is a system-mandated minimum of 1
character and a maximum of 50 characters.
Type: Boolean
Optional
Introduced in v5.1
EncodedName
Labor level name
Name of the labor level. The name can be up to 50 characters long and must be
unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
MaxNameLength
Maximum labor level name length
Maximum number of characters that can be used in a labor level entry name for
this labor level. Valid values are 1 through 50.
Type: Integer
Optional
Introduced in v5.1
MinNameLength
Minimum labor level name length
Minimum number of characters that can be used in a labor level entry name for
this labor level. Valid values are 1 through 50. The minimum labor level name
length cannot be greater than the maximum labor level name length.
Type: Integer
Optional
Introduced in v5.1
ValidateAllNewEntriesSwitch
Should new labor level entries be validated?
Boolean value that, when True, indicates that all new labor level entries must be
validated. Set this property to prevent users from creating labor level entries for
this labor level at a data collection device or ad hoc in the Web browser.
Type: Boolean
Optional
Introduced in v5.1
WSALaborLevelEntry Tag
WSA Labor Level Entry
The WSALaborLevelEntry tag allows you to define choices within each labor
level. The LaborLevelEntry and WSALaborLevelEntry tags refer to the same
database object.
Function Access Control Point: WSA.LaborLevel
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSALaborLevelEntry
[ Description = String ]
[ EncodedName = String ]
[ Inactive = Boolean ]
[ ReadOnly = Boolean ] />
Action Descriptions
RetrieveAllForUpdate
Returns all labor level entries for updating.
Return Value Type: Zero or more WSALaborLevelEntry tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all labor level entries.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified labor level entry for updating.
Return Value Type: WSALaborLevelEntry tag
Required Properties: EncodedName
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified labor level entry.
Return Value Type: None
Required Properties: EncodedName
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
Description
Description of the labor level entry
Description of the labor level entry. Although you can enter up to 250 characters,
some data collection devices can only store 20 characters; any characters over 20
are truncated at the device.
Type: String
Optional
Introduced in v5.1
EncodedName
Name of the labor level entry
Encoded name of the labor level entry. This name includes the following fields:
• The sort order of the definition to which the entry belongs.
• The name of the definition to which the entry belongs.
• The name of the entry. The name can contain letters and numbers (most
commonly just a number). The length of the name must be no less than the
minimum number of characters and no more than the maximum number of
characters set for the labor level entry in the Labor Level definition. Only
names of 20 characters or less are downloaded to the data collection device. A
labor level entry name of more than 20 characters entered at the device will be
truncated.
Each field is separated from the next by the pattern "-:-:-".
For example, a labor level entry named 101, in labor level definition Division, is
rendered as 1-:-:-Division-:-:-101.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
Inactive
Is the labor level entry inactive?
Boolean value that, when True, indicates that the labor level entry is inactive.
Type: Boolean
Optional
Introduced in v5.1
ReadOnly
Can the labor level entry be modified?
Boolean value that, when True, indicates that the labor level entry cannot be
modified. This property cannot be set by a user, and is ignored on update.
Type: Boolean
Optional
Introduced in v5.1
WSALogonProfile Tag
WSA Logon Profile
The WSALogonProfile tag allows you to define the settings for a userís password
and restrictions on Workforce Central sessions. The LogonProfile and
WSALogonProfile tags are used by the same database object.
Function Access Control Point: WSA.AccessProfiles
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSALogonProfile
[ AccLockoutAfter = Integer ]
[ AccLockoutDuration = Long ]
[ AccLockoutSwitch = Boolean ]
[ Description = String ]
[ InactivityTimeOut = Long ]
[ InactivityTimeOutSwitch = Boolean ]
[ IsDefault = Boolean ]
[ Name = String ]
[ PwdExpiredDays = Integer ]
[ PwdExpiredDaysSwitch = Boolean ]
[ PwdMaxHistory = Integer ]
[ PwdMaxHistorySwitch = Boolean ]
[ PwdMinLength = Integer ]
[ PwdMinLengthSwitch = Boolean ] />
Action Descriptions
RetrieveAllForUpdate
Returns all logon profiles for updating.
Return Value Type: Zero or more WSALogonProfile tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all login profiles.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified login profile for updating.
Return Value Type: WSALogonProfile tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified logon profile.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
AccLockoutAfter
Number of attempts before locking user out
Introduced in v5.1
InactivityTimeOut
Length of inactive time before locking account out
When the InactivityTimeOut Switch property is set to True, number of
milliseconds for which an application can be idle before the session is locked, and
the user must reenter the password to return to where he or she left off.
Type: Long
Optional
Introduced in v5.1
InactivityTimeOutSwitch
Should an inactive account be locked out?
Boolean value that, when True, enables account inactivity time out services. If
this value is False, the InactivityTimeOut property is ignored.
Type: Boolean
Optional
Introduced in v5.1
IsDefault
Is this the default logon profile?
Boolean value that, when True, makes this login profile the default for all new
users.
Type: Boolean
Optional
Introduced in v5.1
Name
Logon profile name
Name of the logon profile. The name can be up to 32 characters long, is case-
insensitive, and must be unique.
Type: String
Optional
Type: Boolean
Optional
Introduced in v5.1
PwdMinLength
Minimum length of password
When the PwdMinLengthSwitch property is set to True, minimum number of
characters allowed in a password.
Type: Integer
Optional
Introduced in v5.1
PwdMinLengthSwitch
Should the system enforce a minimum password length?
Boolean value that, when True, indicates that the system will enforce a miniimum
password length. If this value is False, the PwdMinLength property is ignored.
Type: Boolean
Optional
Introduced in v5.1
WSAMajorityRule Tag
Majority Rule
The Majority Rule tag allows you to define rules to apply a single hour type to
shifts when employees qualify for more than one zone. In this respect, majority
rules determine zone precedence in a shift.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAMajorityRule
[ EqualIntervalUse = String ]
[ IncludeDeducts = Boolean ]
[ IncludePunchedBreaks = Boolean ]
[ IncludeRegular = Boolean ]
[ Name = String ] >
[ <SelectedZones>
<WSAOptionalRule>∗
</SelectedZones> ]
</WSAMajorityRule>
Action Descriptions
RetrieveAllForUpdate
Returns all majority rules for updating.
Return Value Type: Zero or more WSAMajorityRule tags
Property Descriptions
EqualIntervalUse
Rule for equal intervals of worked time
Character string that specifies which rule takes precedence in the event that
employees work equal amounts of time in more than one zone, or they work equal
amounts of time in a zone and in a regular (non-zone) shift. The rules include:
• "Highest" -- The rule at the bottom of the Selected Zones list applies to the
entire shift.
• "Lowest" -- The rule at the top of the Selected Zones applies to the entire
shift.
• "First" -- The first zone worked applies to the entire shift.
• "Last" -- The last zone worked applies to the entire shift.
• "Ignore" -- No rule takes precedence. Each interval is paid according to the
rule associated with it.
Type: String
Optional
Introduced in v5.1
IncludeDeducts
Are automatic deductions included in zone length?
Boolean value that, when True, indicates that the time for automatic deductions in
a zone length should be included in the majority shift calculation.
Type: Boolean
Optional
Introduced in v5.1
IncludePunchedBreaks
Are punched breaks included in totalized results?
Boolean value that, when True, indicates that the interval of time for punched
breaks in a zone length should be counted for the purposes of establishing a
majority.
Type: Boolean
Optional
Introduced in v5.1
IncludeRegular
Are regular shifts included in the majority calculation?
Boolean value that, when True, indicates that regular shifts are included in the
majority calculation.
Type: Boolean
Optional
Introduced in v5.1
Name
Name of majority rule
Name of the majority rule. The name can be up to 32 characters long, is case-
insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
SelectedZones
Zones selected for calculation
One or more zones that are used for calculating the majority zone.
Type: Zero or more WSAOptionalRule tags
Optional
Introduced in v5.1
WSAOptionalRule Tag
Optional Rule
The Optional Rule tag allows you to manage optional rules (really wrappers for
zone rules). For internal use with majority rules.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "RetrieveForUpdate"
Properties→
<WSAOptionalRule
[ ListOrder = Integer ]
[ MajorityRuleName = String ]
[ Name = String ] />
Action Descriptions
RetrieveForUpdate
Retrieve the specified instance from the DB
Return Value Type: WSAOptionalRule tag
Required Properties: Name, MajorityRuleName
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
ListOrder
List order
WSAOvertimeCombination Tag
Overtime Combination Rules
The Overtime Combination Rules tag allows you to define and manage rules that
determine which overtime rule to apply when overtime conditions overlap.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAOvertimeCombination
[ Name = String ] >
[ <CombinationRules>
<WSACombinationRule>∗
</CombinationRules> ]
[ <SelectedOvertimeRules>
<WSAOvertimeRule>∗
</SelectedOvertimeRules> ]
</WSAOvertimeCombination>
Action Descriptions
RetrieveAllForUpdate
Returns all overtime combination rules for updating.
Return Value Type: Zero or more WSAOvertimeCombination tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all overtime combination rules.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified overtime combination rule for updating.
Return Value Type: Zero or more WSAOvertimeCombination tags
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified overtime combination rule.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
CombinationRules
Combination rules
List of one or more combination rules to be applied to this overtime combination
rule.
Type: Zero or more WSACombinationRule tags
Optional
Introduced in v5.1
Name
Name of the overtime combination rule
Name of the overtime combination rule. The name can be up to 32 characters
long, is case insensitive and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
SelectedOvertimeRules
Overtime rules selected for combination
List of overtime rules selected for this combination.
Type: Zero or more WSAOvertimeRule tags
Optional
Introduced in v5.1
WSAOvertimeRule Tag
Overtime Rule
The Overtime Rule tag allows you to develop and manage rules that define the
type of overtime employees earn after they work some number of hours.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAOvertimeRule
[ Amount = TimeDuration ]
[ ConPreShifts = Boolean ]
[ Minimum = TimeDuration ]
[ Name = String ]
[ RequiresApproval = Boolean ]
[ ResetAfter = Long ]
[ ResetAtTime = Time ]
[ ResetDate = Date ]
[ ResetDay = Integer ]
[ TrackStart = String ]
[ Type = String ]
[ UseBreakVar = Boolean ] />
Action Descriptions
RetrieveAllForUpdate
Returns all overtime rules for updating.
Return Value Type: Zero or more WSAOvertimeRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all overtime rules.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified overtime rule for updating.
Return Value Type: WSAOvertimeRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified overtime rule.
Return Value Type: String
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
Amount
Amount
Amount.
Type: TimeDuration
Optional
Introduced in v5.1
ConPreShifts
Conditional pre shift
Conditional Pre Shift.
Type: Boolean
Optional
Introduced in v5.1
Minimum
Amount of time worked before accruing overtime
Amount of time, in HH:mm format, an employee must work before starting to
accrue overtime. The default is 8:00.
Type: TimeDuration
Optional
Introduced in v5.1
Name
Name of the overtime rule
Name of the overtime rule. The name can be up to 32 characters long, is case
insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
RequiresApproval
Does the overtime require approval?
Boolean value that, when True, indicates that the overtime defined by this rule
requires a manager's approval.
Type: Boolean
Optional
Introduced in v5.1
ResetAfter
When to reset the accumulater
Time, in HH:mm format, when the accumulator is reset. This property is valid
only when the Type property is R or N.
Type: Long
Optional
Default Value: New Day
Introduced in v5.1
ResetAtTime
Reset time
Valid only with type A
Type: Time
Optional
Introduced in v5.1
ResetDate
Date when the overtime accumulator resets
Initial date, in MM/DD/YYYY format, when the overtime accumulator resets to
zero. Thereafter, the overtime accumulator resets every 14 days. This property is
valid only when the Type property is B or N.
Type: Date
Optional
Introduced in v5.1
ResetDay
Day when the overtime accumulator resets
Day of the week when the overtime accumulator resets. This property is valid
only when the Type property is W or A.
Type: Integer
Optional
Introduced in v5.1
TrackStart
How to track start time
Method for tracking start time when the 24-hour rule is in effect. Valid values
include:
• TrackingStartActual
• TrackingStartSchedule
• TrackingStartEarlier
This property is valid only when the Type property is T.
Type: String
Optional
Introduced in v5.1
Type
Type of overtime rule
Type of overtime rule that can be assigned to employees after they have worked a
standard number of hours. The following types are defined, based on when the
rule is reset:
• A -- Reset at a specified time (HH:mm AM|PM).
• B -- Reset at a new bi-week (day of week determined by specified reference
date).
• D -- Reset at new day.
• N -- Reset after a specified number of days (with respect to a reference date).
• P -- Reset at new pay period.
• R -- Reset after specified amount of time (HHH:mm).
• S -- Reset at new shift.
• T -- 24-hour overtime rule.
• W -- Reset at new week (on specified day of the week).
Type: String
Optional
Sample values: daily, weekly
Introduced in v5.1
UseBreakVar
Use break var?
Break Var.
Type: Boolean
Optional
Introduced in v5.1
WSAPatternTemplateDAP Tag
Pattern Template Data Access Profile
The Pattern Template Data Access Profile tag allows you to specify the set of
pattern templates that a user will see.
Function Access Control Point: WSA.AccessProfiles
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAPatternTemplateDAP
[ AllowAll = Boolean ]
[ Description = String ]
[ Name = String ] >
[ <ProfileItems>
<WSAPatternTemplateProfileItem>∗
</ProfileItems> ]
</WSAPatternTemplateDAP>
Action Descriptions
RetrieveAllForUpdate
Returns all pattern template data access profiles for updating.
Return Value Type: Zero or more WSAPatternTemplateDAP tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all pattern template data access profiles.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified pattern template data access profile for updating.
Return Value Type: WSAPatternTemplateDAP tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified pattern template data access profile.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
AllowAll
Does the pattern template profile allow all?
Boolean value that, when True, indicates that the pattern template data access
profile includes all pattern templates in the system.
Type: Boolean
Optional
Introduced in v5.1
Description
Description
WSAPatternTemplateProfileItem Tag
Pattern Template Profile Item
The Pattern Template Profile Item tag allows you to list and update pattern
template profile items. A pattern template contains a series of shifts that is saved
with a name, but no date, so that you can assign it to multiple employees and reuse
it as needed. Pattern templates save time if you have employees who work
standard shift patterns.
Function Access Control Point: WSA.AccessProfiles
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
RetrieveAllForUpdate
Returns all pattern template data access profiles for updating.
Return Value Type: Zero or more WSAPatternTemplateProfileItem tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified pattern template for updating.
Return Value Type: WSAPatternTemplateProfileItem tag
Required Properties: Name
Property Descriptions
Name
Pattern template name
Name of a pattern template. The name can be up to 32 characters long, is case-
insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSAPayCode Tag
WSA Pay Code Definition
The WSAPayCode tag allows you to manage pay code definitions. The PayCode
and WSAPayCode tags refer to the same database object.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAPayCode
[ AbbreviationChar = String ]
[ CheckAvlbltySw = Boolean ]
[ EditAffShfTotal = Boolean ]
[ EditCntToCdotSw = Boolean ]
[ EditCntToOt = Boolean ]
[ EditExcuseAbsn = Boolean ]
[ IsMoneyCategory = Boolean ]
[ Name = String ]
[ PersistPceSw = Boolean ]
[ ScheduleHoursType = String ]
[ TerminalCdNum = Integer ]
[ VisibleInMainArea = Boolean ]
[ VisibleInReport = Boolean ]
[ VisibleToUser = Boolean ]
[ WageAddition = Double ]
[ WageMultiply = Double ] />
Action Descriptions
RetrieveAllForUpdate
Returns all pay codes for updating.
Return Value Type: Zero or more WSAPayCode tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all pay codes.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified pay code for updating.
Return Value Type: WSAPayCode tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified pay code.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
AbbreviationChar
Short Name
Abbreviated name for the pay code. The short name is for terminal display
purposes.
Type: String
Optional
Introduced in v5.1
CheckAvlbltySw
Available for scheduling?
Boolean value that, when True, causes pay code edits to affect an employee's
availability to be scheduled.
Type: Boolean
Optional
Introduced in v5.1
EditAffShfTotal
Edit Affects Shift Total
Boolean value that, when True, causes pay code edits to be added to timecard
totals.
Type: Boolean
Optional
Introduced in v5.1
EditCntToCdotSw
Edit Counts Towards Consecutive Day Overtime
Boolean value that, when True, causes pay code edits to count toward
consecutive day overtime. This option is not available if the pay code holds
money.
Type: Boolean
Optional
Introduced in v5.1
EditCntToOt
Edit Counts Towards Overtime
Boolean value that, when True, causes pay code edits to count toward overtime
limits. This option is not available if the pay code holds money.
Type: Boolean
Optional
Introduced in v5.1
EditExcuseAbsn
Edit Excuses Absence
Boolean value that, when True, causes pay code edits to excuse absences that
were previously unexcused.
Type: Boolean
Optional
Introduced in v5.1
IsMoneyCategory
Does the pay code hold money?
Boolean value that, when True, indicates that the pay code holds money. If the
value is False, the pay code holds time.
Type: Boolean
Optional
Introduced in v5.1
Name
Pay Code Name
Name of the pay code. The name can be up to 32 characters long, is case-
insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
PersistPceSw
Pay code edit repeats on scheduled days?
Boolean value that, when True, causes pay code edits to repeat on scheduled days
until they are canceled. This option is not available if the pay code holds money.
Type: Boolean
Optional
Introduced in v5.1
ScheduleHoursType
Schedule Hours Type
Scheduled Hours Type determines how pay codes are treated relative to scheduled
hours when using Workforce Scheduler. Pay codes can be tracked as productive
time or non-productive time. Non-productive time does not appear as totaled
hours in the Schedule Planner. Productive time, however, can be included or not
included in the total scheduled hours, depending on the configuration.
Type: String
Optional
Introduced in v5.1
TerminalCdNum
Terminal Code Number
A four-character number that enables users to look up pay codes at a terminal. The
code number must be unique, numeric, and greater than 0 (zero).
Type: Integer
Optional
Introduced in v5.1
VisibleInMainArea
Visible In Main Area
Boolean value that, when True, indicates that the pay code is visible in the main
area of the timecard and schedule, in associated reports, and, if Workforce
Scheduler is installed, on the Hours summary tab in Schedule.
Type: Boolean
Optional
Introduced in v5.1
VisibleInReport
Visible In Report
Boolean value that, when True, indicates that the pay code is visible in Report
options and totals.
Type: Boolean
Optional
Introduced in v5.1
VisibleToUser
Visible To User
Boolean value that, when True, indicates that the pay code is visible on the Totals
tab in the timecard and, if Workforce Scheduler is installed, in the Cost Summary
tab in Schedule.
Type: Boolean
Optional
Introduced in v5.1
WageAddition
Wage Addition
Amount that is added to the employee's base wage to determine the adjusted
wage. This option is not available if the pay code holds money.
Type: Double
Optional
Introduced in v5.1
WageMultiply
Wage Multiply
Amount by which the employee's base wage is multiplied to obtain the adjusted
wage. If the wage multiplier is 0 (zero), the value in the WageAddition Value
property is a flat rate.This option is not available if the pay code holds money.
Type: Double
Optional
Introduced in v5.1
WSAPayCodeDAP Tag
Pay Code Data Access Profile
The Pay Code Data Access Profile tag allows you to define a group of pay codes
that a Workforce Employee or Workforce Manager can use to record time or
money.
Function Access Control Point: WSA.AccessProfiles
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAPayCodeDAP
[ AllowAll = Boolean ]
[ Description = String ]
[ Name = String ] >
[ <ProfileItems>
<WSAPayCodeProfileItem>
</ProfileItems> ]
</WSAPayCodeDAP>
Action Descriptions
RetrieveAllForUpdate
Returns all pay code data access profiles for updating.
Return Value Type: Zero or more WSAPayCodeDAP tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all pay code data access profiles.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified pay code data access profile for updating.
Return Value Type: WSAPayCodeDAP tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified pay code data access profile.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
AllowAll
Does the pay code profile allow all?
Boolean value that, when True, indicates that the pay code data access profile
includes all pay codes in the system.
Type: Boolean
Optional
Introduced in v5.1
Description
Description
Description of the pay code data access profile.
Type: String
Optional
Introduced in v5.1
Name
Pay code data access profile name
Name of the pay code data access profile. The name can be up to 32 characters
long, is case-insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
ProfileItems
Items in the data access profile
List of pay codes associated with this data access profile.
Type: WSAPayCodeProfileItem tag
Optional
Introduced in v5.1
WSAPayCodeDistribution Tag
Pay Code Distribution
The Pay Code Distribution tag allows you to define pay plans for a work rule.
Employees can work various shifts that use different work rules, so an employee
might have several different pay plans. The pay code distribution tells the system
in which pay codes each of the possible hour types accumulate.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAPayCodeDistribution
[ Deviations = String list ]
[ Name = String ]
[ OvertimeCombination = String ]
[ ZoneCombination = String ] >
[ <Distribution>
<WSAPayDistributionAssociation>∗
</Distribution> ]
</WSAPayCodeDistribution>
Action Descriptions
RetrieveAllForUpdate
Returns all pay code distribution rules for updating.
Return Value Type: Zero or more WSAPayCodeDistribution tags
Property Descriptions
Deviations
Deviations
List of one or more schedule deviations.
Type: String list
Optional
Introduced in v5.1
Distribution
Distribution
List of one or more pay codes for employees who are assigned this work rule. The
pay code distribution tells the system in which pay codes each of the possible hour
types accumulate.
Type: Zero or more WSAPayDistributionAssociation tags
Optional
Introduced in v5.1
Name
Name
Name of the pay code distribution rule. The name can be up to 32 characters long,
is case-insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
OvertimeCombination
Overtime Combination
Overtime combination rule.
Type: String
Optional
Introduced in v5.1
ZoneCombination
Zone Combination
Zone combination rule. Zones indicate that employees may receive a special pay
rate for working during a special interval of time (such as a holiday or on a
Sunday).
Type: String
Optional
Introduced in v5.1
WSAPayCodeProfileItem Tag
Pay Code Profile Item
The Pay Code Profile Item tag allows you to list and update pay code profile
items.
Function Access Control Point: WSA.AccessProfiles
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
RetrieveAllForUpdate
Returns all pay code profile items for updating.
Return Value Type: Zero or more WSAPayCodeProfileItem tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified pay code profile item for update.
Return Value Type: WSAPayCodeProfileItem tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
Name
Pay code profile item name
Name of a pay code profile item. The name can be up to 32 characters long, is
case-insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSAPayDistributionAssociation Tag
Pay Distribution Association
The Pay Distribution Association tag allows you to manage pay distribution
associations.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "RetrieveForUpdate"
Properties→
<WSAPayDistributionAssociation
[ Deviation = String ]
[ Name = String ]
[ Overtimes = String list ]
[ PayCodes = String list ]
[ Zones = String list ] />
Action Descriptions
RetrieveForUpdate
Returns the specified pay distribution association for update.
Return Value Type: WSAPayDistributionAssociation tag
Required Properties: Name, Overtimes, Zones, Deviation
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
Deviation
Deviation
Deviation
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
Name
Name
name of the distribution
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
Overtimes
Overtimes
Overtimes
Type: String list
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
PayCodes
Pay Codes
Pay Codes
Type: String list
Optional
Introduced in v5.1
Zones
Zones
Zones
Type: String list
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSAPayPeriod Tag
Pay Period
The Pay Period tag describes the details of a pay period.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "RetrieveForUpdate"
Properties→
<WSAPayPeriod
[ DayDivide = Time ]
[ Length = Integer ]
[ ReferenceDate = Date ]
[ ReferenceDay = String ]
[ TypeCode = String ] />
Action Descriptions
RetrieveForUpdate
Returns the specified pay period for update.
Return Value Type: WSAPayPeriod tag
Required Properties: TypeCode
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
DayDivide
Time of day
The time of day, in HH:mm format, when a pay period starts.
Type: Time
Optional
Introduced in v5.1
Length
Number of days in the pay period
Number of days in the pay period.
Type: Integer
Optional
Introduced in v5.1
ReferenceDate
Start date for the pay period
Date, in MM/DD/YYYY format, when the pay period begins.
Type: Date
Optional
Introduced in v5.1
ReferenceDay
Start day for the pay period
The day of the month on which a semi-monthly or monthly pay period begins.
Type: String
Optional
Introduced in v5.1
TypeCode
Type of pay period
Pay period type. The pay period type can have the following values:
• F -- Days.
• S -- Semi-monthly.
• M -- Monthly.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSAPayRule Tag
Pay Rules
The pay rule tag allows you to define and manage rules that control how time and
attendance information is processed for each employee.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAPayRule
[ Name = String ] >
[ <EffectivePayRules>
<WSAEffectivePayRule>∗
</EffectivePayRules> ]
</WSAPayRule>
Action Descriptions
RetrieveAllForUpdate
Returns all pay rules for updating.
Return Value Type: Zero or more WSAPayRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all pay rules.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified pay rule for updating.
Return Value Type: WSAPayRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified pay rule.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
EffectivePayRules
Effectively dated pay rule
One or more associated effectively dated pay rules.
Type: Zero or more WSAEffectivePayRule tags
Optional
Introduced in v5.1
Name
Name of the pay rule
Name of the pay rule. The name can be up to 32 characters long, is case-
insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSAPayRuleHoliday Tag
Holiday Credit rule for Pay rule
The Pay Rule for Holiday Credit tag allows you to associate a holiday credit rule
with a pay rule.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Retrieve"
Properties→
<WSAPayRuleHoliday
[ CreditRuleNames = String list ]
[ HolidayName = String ]
[ Selected = Boolean ] />
Action Descriptions
Retrieve
Returns the specified pay rule for holiday credit.
Return Value Type: WSAPayRuleHoliday tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
CreditRuleNames
Holiday credit rules for pay rule
Names of one or more holiday credit rules associated with the pay rule.
Type: String list
Optional
Introduced in v5.1
HolidayName
Holiday name
Name of the associated holiday.
Type: String
Optional
Introduced in v5.1
Selected
Is the holiday selected for this pay rule?
Boolean value that, if True, indicates that the holiday indicated by HolidayName,
is selected for this pay rule.
Type: Boolean
Optional
The holidays that are associated with this pay rule
Introduced in v5.1
WSAPermission Tag
Permissions for Function Access Profile
The Permissions for Function Access Profile tag allows you to define the set of
permissions and restrictions that determine which components users can access
and the types of functions they can perform.
Function Access Control Point: WSA.AccessProfiles
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "RetrieveForUpdate"
Properties→
<WSAPermission
[ ActionName = String ]
[ ControlPointKey = String ]
[ ScopeName = String ] />
Action Descriptions
RetrieveForUpdate
Returns the specified permission for updating.
Return Value Type: WSAPermission tag
Required Properties: ControlPointKey, ActionName, ScopeName
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
ActionName
Action name
Action for which the permission has been granted. Possible actions are:
• ALLOWED
• EDIT
• ADD
• DELETE
• VIEW
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
ControlPointKey
Access control point key
An identifier for access control points associated with a function access profile.
An access control point can apply to an entire component, or to specific functions
like printing or editing.
There are different types of control points:
• The great majority of control points are of the simple type, which means they
are either allowed or disallowed. They may be turned on by specifying ìALLî
for ScopeName, and ìALLOWEDî for ActionName. And they may be turned
off simply by leaving them out of an access control point list (as in the
WSAFunctionAccessProfile tag).
• A smaller number of control points have one or more subtypes, which are
distinguished by action name. The single ControlPointKey Wages, for
example, has two subtypes, with ActionNames VIEW and EDIT, and each
action has an independent set of options for ScopeName. The EDIT action
may have scope of ALL, ALL_BUT_SELF, or NONE, while the VIEW
action may have scope of ALL, ONLY_SELF, or NONE.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
ScopeName
Scope name
Scope that is associated with the action and permission type. Possible scopes are:
• ALL
• ALL_BUT_SELF
• ONLY_SELF
• NONE
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSAPunchRoundRule Tag
Punch Round Rule
The Punch Round Rule tag allows to create rounding rules for you site. Rounding
is a way to simplify payroll accounting and reporting, and to enforce shift start
and end times.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAPunchRoundRule
[ InPunchEarlyChangePoint = TimeDuration ]
[ InPunchEarlyInsideGrace = TimeDuration ]
[ InPunchEarlyInsideRound = TimeDuration ]
[ InPunchEarlyOutsideGrace = TimeDuration ]
[ InPunchEarlyOutsideRound = TimeDuration ]
[ InPunchLateChangePoint = TimeDuration ]
[ InPunchLateInsideGrace = TimeDuration ]
[ InPunchLateInsideRound = TimeDuration ]
[ InPunchLateOutsideGrace = TimeDuration ]
[ InPunchLateOutsideRound = TimeDuration ]
[ IsMissedOutException = Boolean ]
[ Name = String ]
[ OutPunchEarlyChangePoint = TimeDuration ]
[ OutPunchEarlyInsideGrace = TimeDuration ]
[ OutPunchEarlyInsideRound = TimeDuration ]
[ OutPunchEarlyOutsideGrace = TimeDuration ]
[ OutPunchEarlyOutsideRound = TimeDuration ]
[ OutPunchLateChangePoint = TimeDuration ]
[ OutPunchLateInsideGrace = TimeDuration ]
[ OutPunchLateInsideRound = TimeDuration ]
[ OutPunchLateOutsideGrace = TimeDuration ]
[ OutPunchLateOutsideRound = TimeDuration ]
[ TransferGrace = TimeDuration ]
[ TransferRound = TimeDuration ]
[ UnscheduledInGrace = TimeDuration ]
[ UnscheduledInRound = TimeDuration ]
[ UnscheduledOutGrace = TimeDuration ]
[ UnscheduledOutRound = TimeDuration ]
[ UseScheduledOut = Boolean ] />
Action Descriptions
RetrieveAllForUpdate
Returns all punch round rules for updating.
Return Value Type: Zero or more WSAPunchRoundRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all punch round rules.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified punch round rule for updating.
Return Value Type: WSAPunchRoundRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified punch round rule.
Property Descriptions
InPunchEarlyChangePoint
In Punch Early Change Point
In Punch Early Change Point, in HH:mm format. This value defines how in-
punches are treated by the round rules when scheduled employees are early for the
beginning of their shifts. Change points determine when inside and outside
rounds and graces apply to punches and to inferred end times of amounts
associated with pay rules. To establish inside rounds and graces, define a change
point. Change points are usually a multiple of the inside round. For example, if
inside rounds are tenth hours (6), the change point would be a value such as 12,
18, 24, or 30. If inside rounds and graces are not used, the change point should be
0 (zero). Legal values are in the range of 00:00 to 99:59. The default is 00:00.
Type: TimeDuration
Optional
Introduced in v5.1
InPunchEarlyInsideGrace
In Punch Early Inside Grace
In Punch Early Inside Grace, in HH:mm format. Early inside graces apply to
punches and amount end times that occur during the early inside interval (after the
change point and before the scheduled start or end time). They determine when
shift start and end times round to the previous increment and when they round to
the next increment. Grace amounts must be less than round amounts. You must
specify a change point to use inside graces. Legal values are in the range of 00:00
to 99:59. The default is 00:00.
Type: TimeDuration
Optional
Introduced in v5.1
InPunchEarlyInsideRound
In Punch Early Inside Round
In Punch Early Inside Round, in HH:mm format. Early inside rounds apply to
punches and amount end times that occur during the early inside interval (after the
change point and before the scheduled start or end time). They establish the
increments for punches and inferred amount end times by dividing hours into
equal segments by minutes, so that 60 is a multiple of the round (for example, 1, 2,
3, 4, 5, 6, 10, 12, 15. 20, and 30). Configure early inside rounds if shift start times
round one way for very early shift start times, but round another way as the
scheduled start time approaches. You must specify a change point to use inside
rounds. Legal values are in the range of 00:00 to 99:59. The default is 00:01.
Type: TimeDuration
Optional
Introduced in v5.1
InPunchEarlyOutsideGrace
In Punch Early Outside Grace
In Punch Early Outside Grace, in HH:mm format. Early outside graces apply to
punches and amount end times that do not occur during the early inside interval
(after the change point and before the scheduled start or end time). They
determine when shift start and end times round to the previous increment and
when they round to the next increment. Grace amounts must be less than round
amounts. Legal values are in the range of 00:00 to 99:59. The default is 00:00.
Type: TimeDuration
Optional
Introduced in v5.1
InPunchEarlyOutsideRound
In Punch Early Outside Round
In Punch Early Outside Round, in HH:mm format. Early outside rounds apply to
punches and amount end times that do not occur during the early inside interval
(after the change point and before the scheduled start or end time). They establish
the increments for punches and inferred amount end times by dividing hours into
InPunchLateInsideRound
In Punch Late Inside Round
In Punch Late Inside Round, in HH:mm format. Late inside rounds apply to
punches and amount end times that occur during the late inside interval (after the
scheduled start or end time and before the change point). They establish the
increments for punches and inferred amount end times by dividing hours into
equal segments by minutes, so that 60 is a multiple of the round (for example, 1, 2,
3, 4, 5, 6, 10, 12, 15. 20, and 30). Configure late inside rounds if shift start times
round one way immediately after the scheduled start time, but round another way
after a period of time. You must specify a change point to use inside rounds.
Legal values are in the range of 00:00 to 99:59. The default is 00:01.
Type: TimeDuration
Optional
Introduced in v5.1
InPunchLateOutsideGrace
In Punch Late Outside Grace
In Punch Late Outside Grace, in HH:mm format. Late outside graces apply to
punches and amount end times that do not occur during the late inside interval
(after the scheduled start or end time and before the change point). They
determine when shift start and end times round to the previous increment and
when they round to the next increment. Grace amounts must be less than round
amounts. Legal values are in the range of 00:00 to 99:59. The default is 00:01.
Type: TimeDuration
Optional
Introduced in v5.1
InPunchLateOutsideRound
In Punch Late Outside Round
In Punch Late Outside Round, in HH:mm format. Late outside rounds apply to
punches and amount end times that do not occur during the late inside interval
(after the scheduled start or end time and before the change point). They establish
the increments for punches and inferred amount end times by dividing hours into
equal segments by minutes, so that 60 is a multiple of the round (for example, 1, 2,
3, 4, 5, 6, 10, 12, 15. 20, and 30). Legal values are in the range of 00:00 to 99:59.
The default is 00:01.
Type: TimeDuration
Optional
Introduced in v5.1
IsMissedOutException
Is Missed Out Exception
Boolean value that, when True, indicates that, when an employee forgets to punch
out and the missed-out limit has been reached, a missed-punch exception appears
on reports and the timecard. Configure the missed-out limit in Punch
Interpretation Rules, which is a Pay Rule building block.
Type: Boolean
Optional
Introduced in v5.1
Name
Name
Name of the punch round rule. The name can be up to 32 characters long, is case-
insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
OutPunchEarlyChangePoint
Out Punch Early Change Point
Out Punch Early Change Point, in HH:mm format. This value defines how in-
punches are treated by the round rules when scheduled employees are early or late
for the end of their shifts. Change points determine when inside and outside
rounds and graces apply to punches and to inferred end times of amounts
associated with pay rules. To establish inside rounds and graces, define a change
point. Change points are usually a multiple of the inside round. For example, if
inside rounds are tenth hours (6), the change point would be a value such as 12,
18, 24, or 30. If inside rounds and graces are not used, the change point should be
0 (zero). Legal values are in the range of 00:00 to 99:59. The default is 00:00.
Type: TimeDuration
Optional
Introduced in v5.1
OutPunchEarlyInsideGrace
Out Punch Early Inside Grace
Out Punch Early Inside Grace, in HH:mm format. Early inside graces apply to
punches and amount end times that occur during the early inside interval (after the
change point and before the scheduled start or end time). They determine when
shift start and end times round to the previous increment and when they round to
the next increment. Grace amounts must be less than round amounts. You must
specify a change point to use inside graces. Legal values are in the range of 00:00
to 99:59. The default is 00:00.
Type: TimeDuration
Optional
Introduced in v5.1
OutPunchEarlyInsideRound
Out Punch Early Inside Round
Out Punch Early Inside Round, in HH:mm format. Early inside rounds apply to
punches and amount end times that occur during the early inside interval (after the
change point and before the scheduled start or end time). They establish the
increments for punches and inferred amount end times by dividing hours into
equal segments by minutes, so that 60 is a multiple of the round (for example, 1, 2,
3, 4, 5, 6, 10, 12, 15. 20, and 30). Configure early inside rounds if shift end times
round one way for very early shift end times, but round another way as the
scheduled end time approaches. You must specify a change point to use inside
rounds. Legal values are in the range of 00:00 to 99:59. The default is 00:01.
Type: TimeDuration
Optional
Introduced in v5.1
OutPunchEarlyOutsideGrace
Out Punch Early Outside Grace
Out Punch Early Outside Grace, in HH:mm format. Early outside graces apply to
punches and amount end times that do not occur during the early inside interval
(after the change point and before the scheduled start or end time). They
determine when shift start and end times round to the previous increment and
when they round to the next increment. Grace amounts must be less than round
amounts. Legal values are in the range of 00:00 to 99:59. The default is 00:00.
Type: TimeDuration
Optional
Introduced in v5.1
OutPunchEarlyOutsideRound
Out Punch Early Outside Round
Out Punch Early Outside Round, in HH:mm format. Early outside rounds apply
to punches and amount end times that do not occur during the early inside interval
(after the change point and before the scheduled start or end time). They establish
the increments for punches and inferred amount end times by dividing hours into
equal segments by minutes, so that 60 is a multiple of the round (for example, 1, 2,
3, 4, 5, 6, 10, 12, 15. 20, and 30). Legal values are in the range of 00:00 to 99:59.
The default is 00:01.
Type: TimeDuration
Optional
Introduced in v5.1
OutPunchLateChangePoint
Out Punch Late Change Point
Out Punch Late Change Point, in HH:mm format. This value defines how in-
punches are treated by the round rules when scheduled employees are early or late
for the end of their shifts. Change points determine when inside and outside
rounds and graces apply to punches and to inferred end times of amounts
associated with pay rules. To establish inside rounds and graces, define a change
point. Change points are usually a multiple of the inside round. For example, if
inside rounds are tenth hours (6), the change point would be a value such as 12,
18, 24, or 30. If inside rounds and graces are not used, the change point should be
0 (zero). Legal values are in the range of 00:00 to 99:59. The default is 00:00.
Type: TimeDuration
Optional
Introduced in v5.1
OutPunchLateInsideGrace
Out Punch Late Inside Grace
Out Punch Late Inside Grace, in HH:mm format. Late inside graces apply to
punches and amount end times that occur during the late inside interval (after the
scheduled start or end time and before the change point). They determine when
shift start and end times round to the previous increment and when they round to
the next increment. Grace amounts must be less than round amounts. You must
specify a change point to use inside graces. Legal values are in the range of 00:00
to 99:59. The default is 00:00.
Type: TimeDuration
Optional
Introduced in v5.1
OutPunchLateInsideRound
Out Punch Late Inside Round
Out Punch Late Inside Round, in HH:mm format. Late inside rounds apply to
punches and amount end times that occur during the late inside interval (after the
scheduled start or end time and before the change point). They establish the
increments for punches and inferred amount end times by dividing hours into
equal segments by minutes, so that 60 is a multiple of the round (for example, 1, 2,
3, 4, 5, 6, 10, 12, 15. 20, and 30). Configure late inside rounds, if shift end times
round one way immediately after the scheduled end time, and round another way
after a period of time. You must specify a change point to use inside rounds.
Legal values are in the range of 00:00 to 99:59. The default is 00:01.
Type: TimeDuration
Optional
Introduced in v5.1
OutPunchLateOutsideGrace
Out Punch Late Outside Grace
Out Punch Late Outside Grace, in HH:mm format. Late outside graces apply to
punches and amount end times that do not occur during the late inside interval
(after the scheduled start or end time and before the change point). They
determine when shift start and end times round to the previous increment and
when they round to the next increment. Grace amounts must be less than round
amounts. Legal values are in the range of 00:00 to 99:59. The default is 00:00.
Type: TimeDuration
Optional
Introduced in v5.1
OutPunchLateOutsideRound
Out Punch Late Outside Round
Out Punch Late Outside Round, in HH:mm format. Late outside rounds apply to
punches and amount end times that do not occur during the late inside interval
(after the scheduled start or end time and before the change point). They establish
the increments for punches and inferred amount end times by dividing hours into
equal segments by minutes, so that 60 is a multiple of the round (for example, 1, 2,
3, 4, 5, 6, 10, 12, 15. 20, and 30). Legal values are in the range of 00:00 to 99:59.
The default is 00:01.
Type: TimeDuration
Optional
Introduced in v5.1
TransferGrace
Transfer Grace
Grace value, in HH:mm format, to be applied to punches by transferring
employees. Graces determine when shift start and end times round to the previous
increment and when they round to the next increment. Grace amounts must be less
than round amounts. Legal values are in the range of 00:00 to 99:59. The default
is 00:00.
Type: TimeDuration
Optional
Introduced in v5.1
TransferRound
Transfer Round
Round value, in HH:mm format, to be applied to punches by transferring
employees. Rounds establish the increments for punches and inferred amount
end times by dividing hours into equal segments by minutes, so that 60 is a
multiple of the round (for example, 1, 2, 3, 4, 5, 6, 10, 12, 15. 20, and 30). Legal
values are in the range of 00:00 to 99:59. The default is 00:01.
Type: TimeDuration
Optional
Introduced in v5.1
UnscheduledInGrace
Unscheduled In Grace
Grace value, in HH:mm format, to be applied to in-punches by unscheduled
employees. Graces determine when shift start and end times round to the previous
increment and when they round to the next increment. Grace amounts must be less
than round amounts. Legal values are in the range of 00:00 to 99:59. The default
is 00:00.
Type: TimeDuration
Optional
Introduced in v5.1
UnscheduledInRound
Unscheduled In Round
Round value, in HH:mm format, to be applied to in-punches by unscheduled
employees. Rounds establish the increments for punches and inferred amount
end times by dividing hours into equal segments by minutes, so that 60 is a
multiple of the round (for example, 1, 2, 3, 4, 5, 6, 10, 12, 15. 20, and 30). Legal
values are in the range of 00:00 to 99:59. The default is 00:01.
Type: TimeDuration
Optional
Introduced in v5.1
UnscheduledOutGrace
Unscheduled Out Grace
Grace value, in HH:mm format, to be applied to out-punches by unscheduled
employees. Graces determine when shift start and end times round to the previous
increment and when they round to the next increment. Grace amounts must be less
than round amounts. Legal values are in the range of 00:00 to 99:59. The default
is 00:00.
Type: TimeDuration
Optional
Introduced in v5.1
UnscheduledOutRound
Unscheduled Out Round
Round value, in HH:mm format, to be applied to out-punches by unscheduled
employees. Rounds establish the increments for punches and inferred amount
end times by dividing hours into equal segments by minutes, so that 60 is a
multiple of the round (for example, 1, 2, 3, 4, 5, 6, 10, 12, 15. 20, and 30). Legal
values are in the range of 00:00 to 99:59. The default is 00:01.
Type: TimeDuration
Optional
Introduced in v5.1
UseScheduledOut
Use Scheduled Out
Boolean value that, when True, indicates that, when employees forget to punch
out and the the missed-out limit has been reached, their scheduled end times are
considered their out-punches. If employees are not scheduled, their unscheduled
shift lengths are added to their rounded in-punches. The result is used as the out-
punch. Configure the missed-out limit in Punch Interpretation Rules, which is a
Pay Rule building block.
Type: Boolean
Optional
Introduced in v5.1
WSAReportDAP Tag
Report Data Access Profile
The Report Data Access Profile tag allows you to define which reports the
Workforce Manager can access.
Function Access Control Point: WSA.AccessProfiles
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAReportDAP
[ AllowAll = Boolean ]
[ Description = String ]
[ Name = String ] >
[ <ProfileItems>
<WSAReportProfileItem>∗
</ProfileItems> ]
</WSAReportDAP>
Action Descriptions
RetrieveAllForUpdate
Returns all report data access profiles for updating.
Return Value Type: Zero or more WSAReportDAP tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all report data access profiles.
Return Value Type: Zero or more NameList tags
Access Control Point Name: Edit
Introduced in v5.1
RetrieveForUpdate
Returns the specified report data access profile for updating.
Return Value Type: WSAReportDAP tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified report data access profile.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
AllowAll
Does the report profile allow all?
Boolean value that, when True, indicates that the report data access profile
includes all reports in the system.
Type: Boolean
Optional
Introduced in v5.1
Description
Description
WSAReportProfileItem Tag
Report Profile Item
The Report Profile Item tag allows you to list and update report profile items.
Function Access Control Point: WSA.AccessProfiles
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Properties→
<WSAReportProfileItem
[ Name = String ] />
Action Descriptions
RetrieveAllForUpdate
Returns all report profile items for updating.
Return Value Type: Zero or more WSAReportProfileItem tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified report profile item for update.
Return Value Type: WSAReportProfileItem tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
Name
Report profile item name
Name of the report profile item. The name can be up to 32 characters long, is
case-insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSAScheduleDeviationRule Tag
Schedule Deviation Rule
The Schedule Deviation Rule tag allows you to set up and maintain special
differentials that employees might earn when they work before or after their
scheduled times, or for shifts that are unscheduled.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAScheduleDeviationRule
[ AfterShift = Boolean ]
[ BeforeShift = Boolean ]
[ Name = String ]
[ NotScheduled = Boolean ]
[ RequiresApproval = Boolean ] />
Action Descriptions
RetrieveAllForUpdate
Returns all schedule deviation rules for updating.
Return Value Type: Zero or more WSAScheduleDeviationRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all schedule deviation rules.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified schedule deviation rule for updating.
Return Value Type: WSAScheduleDeviationRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified schedule deviation rule.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
AfterShift
After Shift
Boolean value that, when True, indicates that time worked after the scheduled end
of a shift and before the missed-out limit accumulates as schedule deviation time.
Type: Boolean
Optional
Introduced in v5.1
BeforeShift
Before Shift
Boolean value that, when True, indicates that time worked within the early
schedule margin and before the start of a shift accumulates as schedule deviation
time.
Type: Boolean
Optional
Introduced in v5.1
Name
Name
Name of the schedule deviation rule. The name can be up to 32 characters long, is
case-insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
NotScheduled
Not Scheduled
Boolean value that, when True, indicates that, if an in-punch does not link to a
schedule, the time worked accumulates as scheduled deviation time.
Type: Boolean
Optional
Introduced in v5.1
RequiresApproval
Requires Approval
Boolean value that, when True, indicates that hours worked outside of the
employeeís scheduled shift requires a managerís approval.
Type: Boolean
Optional
Introduced in v5.1
WSAScheduledHoursType Tag
Scheduled Hours Type
The Scheduled Hours Type tag allows you to define scheduled hours types that
determine how pay codes are treated relative to scheduled hours.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAScheduledHoursType
[ Name = String ]
[ SchedHrsInclSw = Boolean ] />
Action Descriptions
RetrieveAllForUpdate
Returns all scheduled hours types for update.
Return Value Type: Zero or more WSAScheduledHoursType tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all scheduled hours types.
Return Value Type: Zero or more NameList tags
Property Descriptions
Name
Name
Name of the scheduled hours type. The name can be up to 32 characters long, is
case-insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
SchedHrsInclSw
Should scheduled hours type be included in daily total?
Boolean value that, when True, indicates that this scheduled hours type should be
included in the daily total of scheduled hours.
Type: Boolean
Optional
should be included in the daily total of scheduled hours.
Introduced in v5.1
WSAScheduleGroupDAP Tag
Schedule Group Data Access Profile
The Schedule Group Data Access Profile tag allows you to define sets of schedule
groups. A schedule group is a set of employees who work the same shifts.
Function Access Control Point: WSA.AccessProfiles
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAScheduleGroupDAP
[ AllowAll = Boolean ]
[ Description = String ]
[ Name = String ] >
[ <ProfileItems>
<WSAScheduleGroupProfileItem>∗
</ProfileItems> ]
</WSAScheduleGroupDAP>
Action Descriptions
RetrieveAllForUpdate
Return all schedule group data access profiles for update.
Return Value Type: Zero or more WSAScheduleGroupDAP tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all schedule group data access profiles.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified schedule group data access profile for update.
Return Value Type: WSAScheduleGroupDAP tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified schedule group data access profile.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
AllowAll
Does the schedule group profile allow all?
Boolean value that, when True, indicates that the schedule group data access
profile includes all schedule groups in the system.
Type: Boolean
Optional
Introduced in v5.1
Description
Description
WSAScheduleGroupProfileItem Tag
Schedule Group Profile Item
The Schedule Group Profile Item tag allows you to list and update schedule group
items.
Function Access Control Point: WSA.AccessProfiles
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
RetrieveAllForUpdate
Returns all schedule group profile items for update.
Return Value Type: Zero or more WSAScheduleGroupProfileItem tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified schedule group profile item for update.
Return Value Type: WSAScheduleGroupProfileItem tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
Name
Schedule group profile item name
Name of the schedule group profile item. The name can be up to 32 characters
long, is case-insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSASequencedItem Tag
Sequenced Item
The Sequenced Item tag allows you to manage sequenced items. For internal use
with Sequencer Rules. (Now known as Processing Order rules in the v5.1 GUI.)
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "RetrieveForUpdate"
Properties→
<WSASequencedItem
[ Name = String ]
[ TypeCode = String ] />
Action Descriptions
RetrieveForUpdate
Returns the specified sequenced item for update.
Return Value Type: WSASequencedItem tag
Required Properties: Name, TypeCode
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
Name
Name of the item being sequenced
The name of the item being sequenced, for example the name of a schedule
deviation or overtime rule.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
TypeCode
The hour type being sequenced, such as holiday.
The assigned Type Code for the hour type being sequenced.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSASequencerRule Tag
Processing Order rule (formerly Sequencer Rule)
The Sequencer Rule tag identifies the Processing Order rule that defines the order
in which accumulated hour types are processed. The Sequencer is one step in the
Totalizer process.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSASequencerRule
[ Name = String ] >
[ <DoFirstList>
<WSASequencedItem>∗
</DoFirstList> ]
[ <DoLastList>
<WSASequencedItem>∗
</DoLastList> ]
</WSASequencerRule>
Action Descriptions
RetrieveAllForUpdate
Retrieve all sequencer rules for update.
Return Value Type: Zero or more WSASequencerRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all sequencer rules.
Return Value Type: Zero or more NameList tags
Access Control Point Name: Edit
Introduced in v5.1
RetrieveForUpdate
Returns the specified sequencer rule for update.
Return Value Type: WSASequencerRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified sequencer rule.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
DoFirstList
Do first list
Ordered list that specifies the hour types to process first. Hour types that help
employees reach overtime limits may be in this category. For example, if a
holiday occurs at the end of the week, place the holiday hour type in this list.
Holiday hours process first and help employees reach overtime limits.
Type: Zero or more WSASequencedItem tags
Optional
Introduced in v5.1
DoLastList
Do last list
Ordered list that specifies the hour types to process last. You typically place an
hour type in this list to prevent the corresponding hours from counting toward the
weekly overtime goal. For example, if you moved daily overtime hours to this list,
you can prevent daily overtime hours from counting toward weekly overtime. You
can also total or process "non-home" labor level transfers last. That procedure
ensures that the system allocates overtime hours to the department to which the
person was "loaned" rather than to the personís "home" department.
Type: Zero or more WSASequencedItem tags
Optional
Introduced in v5.1
Name
Name of the Processing Order rule
Name of the Processing Order (formerly sequencer) rule. The name can be up to
32 characters long, is case-insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSAShiftGuarantee Tag
Shift Guarantee
The Shift Guarantee tag allows you to set up and manage shift guarantees. Shift
guarantees are amounts of time that employees earn even if they actually work
less time. When employees work during shifts that contain a guaranteed amount,
they earn at least the minimum amounts of time specified in the guarantee. If they
work more than the guarantee, they accrue the amount of time actually worked.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAShiftGuarantee
[ Friday = TimeDuration ]
[ Monday = TimeDuration ]
[ Name = String ]
[ ReductByAmountTardy = Boolean ]
[ Saturday = TimeDuration ]
[ Sunday = TimeDuration ]
[ Thursday = TimeDuration ]
[ Tuesday = TimeDuration ]
[ Wednesday = TimeDuration ]
[ WorkRule = String ] />
Action Descriptions
RetrieveAllForUpdate
Returns all shift guarantees for update.
Return Value Type: Zero or more WSAShiftGuarantee tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all shift guarantees.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified shift guarantee for update.
Return Value Type: WSAShiftGuarantee tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified shift guarantee.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
Friday
Friday
Length of the guaranteed shift for Friday.
Type: TimeDuration
Optional
Introduced in v5.1
Monday
Monday
Length of the guaranteed shift for Monday.
Type: TimeDuration
Optional
Introduced in v5.1
Name
Name
Name of the shift guarantee. The name can be up to 32 characters long, is case-
insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
ReductByAmountTardy
Reduce By Amount Tardy
Boolean value that, when True, indicates that the guaranteed amount will be
reduced by the amount of time that employees are late for that scheduled shift.
The rounded amount is deducted from the guaranteed amount. The late in-punch
round rules determine the deduction for punch rounds. The Interval Round Rules
determine the deduction for interval rounds. If employees punch in later than the
length of the guarantee, the guaranteed shift no longer applies. By default, this
option is not selected.
Type: Boolean
Optional
Introduced in v5.1
Saturday
Saturday
WorkRule
Work Rule
Name of the work rule that accounts for the difference between the amount of
time employees actually work and the amount of time accrued because of shift
guarantees.
Type: String
Optional
Introduced in v5.1
WSAShiftLength Tag
Shift Lengths
The Shifts Length tag allows you to add or edit a shift length and the automated
breaks associated with the shift.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Retrieve"
Properties→
<WSAShiftLength
[ Length = Long ]
[ Name = String ] >
[ <BreakTimes>
<WSABreakTime>∗
</BreakTimes> ]
</WSAShiftLength>
Action Descriptions
Retrieve
Returns the shift length of the specified shift.
Return Value Type: WSAShiftLength tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
BreakTimes
Break times
List of one or more breaks assigned to this shift.
Type: Zero or more WSABreakTime tags
Optional
Introduced in v5.1
Length
Length of shift
Shift length, in HH:mm format. A shift can be from 0 (zero) to 99 hours long.
Type: Long
Optional
Introduced in v5.1
Name
Shift name
Name of the shift. The name can be up to 32 characters long, is case-insensitive,
and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSAShiftTemplateDAP Tag
Shift Template Data Access Profile
The Shift Template Data Access Profile tag allows you to specify the set of shift
templates that a user will see.
Function Access Control Point: WSA.AccessProfiles
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAShiftTemplateDAP
[ AllowAll = Boolean ]
[ Description = String ]
[ Name = String ] >
[ <ProfileItems>
<WSAShiftTemplateProfileItem>∗
</ProfileItems> ]
</WSAShiftTemplateDAP>
Action Descriptions
RetrieveAllForUpdate
Returns all shift template data access profiles for update.
Return Value Type: Zero or more WSAShiftTemplateDAP tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all shift template data access profiles.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified shift template data access profile for update.
Return Value Type: WSAShiftTemplateDAP tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified shift template data access profile.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
AllowAll
Does the shift template profile allow all?
Boolean value that, when True, indicates that the shift template data access profile
includes all shift templates in the system.
Type: Boolean
Optional
Introduced in v5.1
Description
Description
WSAShiftTemplateProfileItem Tag
Shift template profile item
The Shift Template Profile Item tag allows you to list and update shift template
profile items (shift templates). A shift template is a shift with all its segments that
is saved with a name, but no date, so that you can assign it to multiple employees
and reuse it as needed. Shift templates save time if you have employees who work
standard shifts.
Function Access Control Point: WSA.AccessProfiles
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
RetrieveAllForUpdate
Returns all shift template profile items for update.
Return Value Type: Zero or more WSAShiftTemplateProfileItem tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specifed shift template profile item for update.
Return Value Type: WSAShiftTemplateProfileItem tag
Required Properties: Name
Property Descriptions
Name
Shift template name
Name of a shift template. The name can be up to 32 characters long, is case-
insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSASignOffRestriction Tag
Sign-Off Restrictions
The Sign-Off Restrictions tag allows you to set up restrictions that limit a
managerís ability to sign off when specific conditions are not satisfied.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSASignOffRestriction
[ DisallowIfMissingPunches = Boolean ]
[ DisallowIfUnexcusedAbsences = Boolean ]
[ DisallowIfZeroHours = Boolean ]
[ Name = String ]
[ PayCodeForZeroHours = String ] />
Action Descriptions
RetrieveAllForUpdate
Returns all sign-off restrictions for update.
Return Value Type: Zero or more WSASignOffRestriction tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all sign-off restrictions.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified sign-off restriction for update.
Return Value Type: WSASignOffRestriction tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified sign-off restriction.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
DisallowIfMissingPunches
Are missing punches disallowed?
Boolean value that, when True, indicates that, to qualify for sign-off, a timecard
cannot contain any missed punches for the entire period that is being signed off.
Type: Boolean
Optional
Introduced in v5.1
DisallowIfUnexcusedAbsences
Are unexcused absences disallowed?
Boolean value that, when True, disallows unexcused absences. To qualify for
sign-off, a timecard cannot contain any unexcused absences for the entire period
being signed off. An unexcused absence is a day in which the employee is
scheduled to work and the employeeís timecard does not contain any punches or
pay code edits that excuse the absence.
Type: Boolean
Optional
Introduced in v5.1
DisallowIfZeroHours
Are zero hours disallowed?
Boolean value that, when True, indicates that, to qualify for sign-off, a timecard
must contain hours accumulated in a specified pay code. A pay code that does not
contain hours (a zero value) is not signed off. This includes hours resulting from
worked shifts, pay code edits, internal pay code edits (such as holiday credits),
and scheduled pay code edits.
Type: Boolean
Optional
Introduced in v5.1
Name
Name of the sign-off restriction
Name of the sign-off restriction. The name can be up to 32 characters long, is
case-insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
PayCodeForZeroHours
Pay code for zero hours
Pay code associated with the DisallowIfZeroHours property. You can specify a
single pay code or a combined pay code.
Type: String
Optional
Introduced in v5.1
WSATkTerminalRule Tag
Punch Interpretation Rule (formerly Terminal Rule)
The Terminal Rule tag allows you to set up and manage rules that determine when
punches link to schedules and when data collection devices accept and reject
punches. Terminal Rules are now called Punch Interpretation Rules.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSATkTerminalRule
[ AllowOverrides = Boolean ]
[ BeginEarlyEnd = TimeDuration ]
[ EarlyScheduleMargin = TimeDuration ]
[ EarlyStart = TimeDuration ]
[ EarlyStartBreakMargin = TimeDuration ]
[ EnforceBreaks = Boolean ]
[ LateEnd = TimeDuration ]
[ LateEndBreakMargin = TimeDuration ]
[ LateEndMargin = TimeDuration ]
[ LateScheduleMargin = TimeDuration ]
[ LateStart = TimeDuration ]
[ LateStartBreakMargin = TimeDuration ]
[ LiftEarlyEnd = TimeDuration ]
[ MaximumOut = TimeDuration ]
[ MaximumShiftLength = TimeDuration ]
[ MinimumMeal = TimeDuration ]
[ Name = String ]
[ PunchRestrictions = Boolean ]
[ RuleNumber = Integer ]
[ UnscheduledIn = Boolean ]
[ UnscheduledShiftLength = TimeDuration ] />
Action Descriptions
RetrieveAllForUpdate
Returns all terminal rules for update.
Return Value Type: Zero or more WSATkTerminalRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all terminal rules.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified terminal rule for update.
Return Value Type: WSATkTerminalRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified terminal rule.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
AllowOverrides
Can supervisors override schedules?
Boolean value that, when True, allows supervisors to override schedules.
Type: Boolean
Optional
Introduced in v5.1
BeginEarlyEnd
Starts a period of time before the end of a shift when an employee cannot punch out
The Begin Early End restriction, specified in HH:mm format, starts a period of
time before the end of a shift when an employee cannot punch out. If you use this
restriction, you are required to set Lift Early End Restriction, which ends the out-
punch restriction period. Begin Early End Restriction must be at least as great as
Lift Early End Restriction. The Begin Early Restriction default is 24:00..
Type: TimeDuration
Optional
Introduced in v5.1
EarlyScheduleMargin
Early punch-in margin
Amount of time before a shift, specified in HH:mm format, that an employee can
punch in from a device and still have the punch link to the scheduled shift.
Type: TimeDuration
Optional
Introduced in v5.1
EarlyStart
Early punch-in
Value, specified in HH:mm format, that determines how early an employee is
allowed to punch in using a terminal.
Type: TimeDuration
Optional
Restriction (Start, Early End, and Late End) ó These values determine how early
or late an employee is allowed to punch in or out using a terminal.
Introduced in v5.1
EarlyStartBreakMargin
Margin for the early start of breaks and meals.
The Early Start Break Margin, specified in HH:mm format. The punch margin for
the early start of breaks and meals in seconds.
Type: TimeDuration
Optional
Introduced in v5.1
EnforceBreaks
Can the device enforces breaks?
Boolean value that, when True, specifies that the device enforces breaks.
Employees must remain punched out for the entire break. This applies to minor
and adult employees. Supervisors can override this restriction if you also set
Allow Overrides to True.
Type: Boolean
Optional
Introduced in v5.1
LateEnd
Late punch-out
Value, specified in HH:mm format, that determines how late an employee is
allowed to punch out using a terminal.
Type: TimeDuration
Optional
Introduced in v5.1
LateEndBreakMargin
Late margin for the end of breaks and meals
The Late End Break Margin, specified in HH:mm format. The late margin for the
end of breaks and meals. If employees try to punch in after this time, the device
displays an error message.
Type: TimeDuration
Optional
Introduced in v5.1
LateEndMargin
Length of time a punch is considered an out-punch
Length of time, specified in HH:mm format, after the scheduled end of a shift that
a punch is considered to be an out-punch even if the punch is the first punch
recorded for the shift. This can occur if the in-punch is determined to be missing
and an exception is generated.
Type: TimeDuration
Optional
Introduced in v5.1
LateScheduleMargin
Late punch-in margin
Amount of time after a shift, specified in HH:mm format, that an employee can
punch in from a device and still have the punch link to the scheduled shift.
Type: TimeDuration
Optional
Introduced in v5.1
LateStart
Late punch-in
Value, specified in HH:mm format, that determines how late an employee is
allowed to punch in using a terminal.
Type: TimeDuration
Optional
Introduced in v5.1
LateStartBreakMargin
Late punch margin for the start of breaks and meals
The Late Start Break Margin, specified in HH:mm format. The late punch margin
for the start of breaks and meals. If employees try to punch for a break or meal
after the late margin, the device displays an error message.
Type: TimeDuration
Optional
Introduced in v5.1
LiftEarlyEnd
Time before the end of a shift that an employee cannot punch out
The Lift Early End, specified in HH:mm format, specifies the period of time
before the end of a shift when an employee cannot punch out. If you use this
restriction, you are required to set Begin Early End Restriction, which starts the
out-punch restriction period. Lift Early End Restriction cannot exceed Begin
Early End Restriction.
Type: TimeDuration
Optional
Introduced in v5.1
MaximumOut
Time before an out-punch exception is generated
Length of time, specified in HH:mm format, after an in-punch that the out-punch
is determined to have been missed and an out-punch exception is generated.
Type: TimeDuration
Optional
Introduced in v5.1
MaximumShiftLength
Maximum shift length
The maximum length of a shift, specified in HH:mm format.
Type: TimeDuration
Optional
Introduced in v5.1
MinimumMeal
Minimum amount of time allowed for a meal break
Minimum Meal, specified in HH:mm format, is the minimum amount of time
allowed for a meal break.
Type: TimeDuration
Optional
Introduced in v5.1
Name
Name of the terminal rule
Name of the terminal rule. The name can be up to 32 characters long, is case-
insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
PunchRestrictions
Specifies Full or Simple punch restrictions
Boolean value that, when True, indicates Ful, which specifies that the device will
enforce full schedules. False equals Simple, which specifies that the device will
enforce simple schedules. Simple schedules are appropriate for retail
environments, where managers cannot always track the ins and outs of employees,
and for organizations who have minor employees that require strict time regimens.
The simple schedule does not include all of the properties in the Terminal Rule
tag.
Type: Boolean
Optional
Introduced in v5.1
RuleNumber
Rule number
WSAULLE Tag
Unspecified Labor Level Entry
The Unspecified Labor Level Entry tag allows you update the unspecified labor
level entry. The system creates an unspecified labor level entry for each labor
level you create. The entry is the same for all labor levels. This enables you to
attach a labor level to a job and ensures that there is an entry for each labor level in
a labor account.
Function Access Control Point: WSA.LaborLevels
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAULLE
[ Description = String ]
[ Name = String ] />
Action Descriptions
RetrieveAllForUpdate
Returns the one logical unspecified labor level entry in the system. (Note: This
API exists for completeness. Although there is one unspecified labor level entry
for each defined labor level, these entries all have the same attributes and are thus
one logical entity.)
Return Value Type: Zero or more WSAULLE tags
Property Descriptions
Description
Description
WSAWageProfile Tag
WSA Wage Profile
The WSAWageProfile tag allows you to assign multiple wage rates to one or more
employees to comply with union regulations or company policy. The WageProfile
and WSAWageProfile tags refer to the same database object.
Function Access Control Point: WSA.WageProfiles
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAWageProfile
[ Name = String ]
[ OverrideIfHomeSwitch = Boolean ]
[ UseHighestWageSwitch = Boolean ] >
[ <WageProfileLLDef>
<WSAWageProfileLaborLevelLinkage>∗
</WageProfileLLDef> ]
[ <WgpPayCodes>
<WSAWageProfilePayCode>∗
</WgpPayCodes> ]
</WSAWageProfile>
Action Descriptions
RetrieveAllForUpdate
Returns all wage profiles for update.
Return Value Type: WSAWageProfile tag
Property Descriptions
Name
WSA Wage Profile Name
Name of the wage profile. The name can be up to 32 characters long, is case-
insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
OverrideIfHomeSwitch
Should override be allowed if home switch is set?
Boolean value that, when True, indicates that a wage rate adjustment should not
apply to employeesí Primary Labor Accounts.
Type: Boolean
Optional
Introduced in v5.1
UseHighestWageSwitch
Should the highest wage be used?
Boolean value that, when True, indicates that the higher of expanded or base
wages should be used.
Type: Boolean
Optional
Introduced in v5.1
WageProfileLLDef
Set of labor level/wage profile objects
One or more labor level and wage profiles associated with this wage profile.
Type: Zero or more WSAWageProfileLaborLevelLinkage tags
Optional
Introduced in v5.1
WgpPayCodes
Pay codes affected by the wage profile
One or more pay codes associated with this wage profile. If no pay codes are
listed in this property, all page codes are associated with the wage profile.
Type: Zero or more WSAWageProfilePayCode tags
Optional
Introduced in v5.1
WSAWageProfileLaborLevelLinkage Tag
This tag links a wage profile to labor levels
Internal use by WSAWageProfile
Function Access Control Point: WSA.WageProfiles
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "RetrieveForUpdate"
Properties→
<WSAWageProfileLaborLevelLinkage
[ LaborLevelName = String ]
[ WageProfileName = String ] >
[ <Adjustments>
<WSAWPWageAdjustment>∗
</Adjustments> ]
</WSAWageProfileLaborLevelLinkage>
Action Descriptions
RetrieveForUpdate
Returns the specified wage profile labor level linkage.
Return Value Type: WSAWageProfileLaborLevelLinkage tag
Required Properties: WageProfileName, LaborLevelName
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
Adjustments
Adjustments
List of adjustments applying to the linked labor level and wage profile.
Type: Zero or more WSAWPWageAdjustment tags
Optional
Introduced in v5.1
LaborLevelName
Labor level name
Name of associated labor level.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WageProfileName
Wage profile name
Name of the associated wage profile.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSAWageProfilePayCode Tag
Wage Profile Pay Code
Internal Use by WSAWageProfile
Function Access Control Point: WSA.WageProfiles
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "RetrieveForUpdate"
Properties→
<WSAWageProfilePayCode
[ Name = String ] />
Action Descriptions
RetrieveForUpdate
Returns the specified wage profile pay code for update.
Return Value Type: WSAWageProfilePayCode tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
Name
Name
Name of the wage profile pay code. The name is case-insensitive and must be
unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSAWorkHistoryQualifierRule Tag
Work History Qualifier Rule
The Work History Qualifier Rule tag allows you to define a set of conditions that
an employee must meet, prior to a holiday, to be eligible for holiday credits.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAWorkHistoryQualifierRule
[ AmountUnits = String ]
[ ContributingShiftRuleName = String ]
[ Name = String ]
[ Type = String ] />
Action Descriptions
RetrieveAllForUpdate
Returns all work history qualifier rules for update.
Return Value Type: Zero or more WSAWorkHistoryQualifierRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all work history qualifier rules.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified work history qualifier rule for update.
Return Value Type: WSAWorkHistoryQualifierRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified work history qualifier rule.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
AmountUnits
Type of units
It will be "converted" to type KTimeDuration for types B and E, Integer for the
others.
Type: String
Optional
Introduced in v5.1
ContributingShiftRuleName
Name of contributing shift rule
Name of the contributing shift rule for holidays that is associated with this work
history qualifier rule.
Type: String
Optional
Introduced in v5.1
Name
Name of the work history qualifier rule
Name of the work history qualifier rule. The name can be up to 32 characters
long, is case-insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
Type
Type of contributing shift
Type of contributing shift conditions, such as a minimum or maximum number of
shifts, days, or hours, to satisfy this work history qualifier rule. Valid types
include:
• A -- Maximum number of days
• B -- Maximum number of hours
• C -- Maximum number of shifts
• D -- Minimum number of days
• E -- Minimum number of hours
• F -- Minimum number of shifts
Type: String
Optional
Introduced in v5.1
WSAWorkRule Tag
Work Rule
The WSAWorkRule tag allows you to define and manage rules that determine
how employee hours accrue. The WorkRule and WSAWorkRule tags refer to the
same database object.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAWorkRule
[ Name = String ] >
[ <EffectiveWorkRules>
<WSAEffectiveWorkRule>∗
</EffectiveWorkRules> ]
</WSAWorkRule>
Action Descriptions
RetrieveAllForUpdate
Returns all work rules for update.
Return Value Type: Zero or more WSAWorkRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all work rules.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified work rule for update.
Return Value Type: WSAWorkRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified work rule.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
EffectiveWorkRules
Effective-dated versions of the work rule
List of one or more effective-dated versions of this work rule.
Type: Zero or more WSAEffectiveWorkRule tags
Optional
Introduced in v5.1
Name
Name of WSA work rule
Name of the work rule. The name can be up to 32 characters long, is case-
insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSAWorkRuleDAP Tag
Work Rule Data Access Profile
The Work Rule Data Access Profile tag allows you to specify the work rules that
an individual can select.
Function Access Control Point: WSA.AccessProfiles
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAWorkRuleDAP
[ AllowAll = Boolean ]
[ Description = String ]
[ Name = String ] >
[ <ProfileItems>
<WSAWorkRuleProfileItem>∗
</ProfileItems> ]
</WSAWorkRuleDAP>
Action Descriptions
RetrieveAllForUpdate
Returns all work rule data access profiles for update.
Return Value Type: Zero or more WSAWorkRuleDAP tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all work rule data access profiles.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified work rule data access profile for update.
Return Value Type: WSAWorkRuleDAP tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified work rule data access profile.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
AllowAll
If true, the profile allows access to all work rules
Boolean value that, when True, indicates that the work rule data access profile
includes all work rules in the system.
Type: Boolean
Optional
Introduced in v5.1
Description
Description
WSAWorkRuleGeneral Tag
General work rule componentss
The General Work Rules tag allows you to define and maintain bonus/deduction
rules, break rules, and core hours rules associated with the specified work rule.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Retrieve"
Properties→
<WSAWorkRuleGeneral
[ BonusDeductRuleNames = String list ]
[ BreakRuleNames = String list ]
[ CoreHoursRuleNames = String list ]
[ Name = String ] />
Action Descriptions
Retrieve
Returns the specified general work rule.
Return Value Type: WSAWorkRuleGeneral tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
BonusDeductRuleNames
Bonuses and deductions rule name
List of one or more bonus/deduction rules associated with this general rule.
Type: String list
Optional
Select bonuses and deductions from the Available Bonuses/Deductions box and
move the selections to the Selected Bonuses/Deductions box to specify the
deductions and bonuses used in this work rule.
Introduced in v5.1
BreakRuleNames
Break rule names
List of one or more break rules associated with this general work rule.
Type: String list
Optional
Introduced in v5.1
CoreHoursRuleNames
Core hour rules
List of one or more core hours rules associated with this general work rule.
Type: String list
Optional
Introduced in v5.1
Name
Name of the general work rule
Name of the general work rule. The name can be up to 32 characters long, is case-
insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSAWorkRulePCDistr Tag
Pay Code Distributions for Work Rules
The Pay Code Distributions for Work Rules tag allows you to define pay plans for
a work rule. Employees can work various shifts that use different work rules, so
an employee might have several different pay plans. Pay code distributions
depend on the work rule that is assigned to the schedules.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "Retrieve"
Properties→
<WSAWorkRulePCDistr
[ MajorityRuleNames = String list ]
[ Name = String ]
[ OvertimeRuleNames = String list ]
[ ScheduleDeviationRuleNames = String list ]
[ ZoneRuleNames = String list ] />
Action Descriptions
Retrieve
Returns the specified pay code distribution.
Return Value Type: WSAWorkRulePCDistr tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
MajorityRuleNames
Majority rules
List of one or more majority rules associated with this pay code distribution.
Type: String list
Optional
Introduced in v5.1
Name
Name of the pay code distribution
Name of the pay code distribution. The name can be up to 32 characters long, is
case-insensitive and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
OvertimeRuleNames
Overtime rules
List of one or more overtime rules associated with this pay code distribution.
Type: String list
Optional
Introduced in v5.1
ScheduleDeviationRuleNames
Schedule deviation rules
List of one or more schedule deviation rules associated with this pay code
distribution.
Type: String list
Optional
Introduced in v5.1
ZoneRuleNames
Zone rule
List of one or more zone rules associated with this pay code distribution.
Type: String list
Optional
Introduced in v5.1
WSAWorkRuleProfileItem Tag
Work Rule Profile Item
The Work Rule Profile Item tag allows you to list and update work rule profile
items.
Function Access Control Point: WSA.AccessProfiles
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Action Descriptions
RetreiveAllForUpdate
Returns all work rule profile items for update.
Return Value Type: Zero or more WSAWorkRuleProfileItem tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified work rule profile item for update.
Return Value Type: WSAWorkRuleProfileItem tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
Name
Work rule profile item name
Name of the work rule profile item. The name can be up to 32 characters long, is
case-insensitive and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSAWPWageAdjustment Tag
Wage Adjustment
The Wage Adjustiment tag allows you to define an adjustment to a wage profile to
include an amount that changes an employeeís base wage.
Function Access Control Point: WSA.WageProfiles
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "RetrieveForUpdate"
Properties→
<WSAWPWageAdjustment
[ Amount = String ]
[ LaborLevelEntryName = String ]
[ LaborLevelEntryWildcard = String ]
[ LaborLevelName = String ]
[ Type = Integer ]
[ WageProfileName = String ] />
Action Descriptions
RetrieveForUpdate
Returns the specified wage adjustment for update.
Return Value Type: WSAWPWageAdjustment tag
Required Properties: WageProfileName, LaborLevelName,
LaborLevelEntryName, LaborLevelEntryWildcard
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
Amount
Amount
Amount to be applied to the adjustment type. Although this property takes a
string, this value should be a well-formed float/long.
Type: String
Optional
Introduced in v5.1
LaborLevelEntryName
Labor Level Entry Name
Name of the associated labor level entry. If you are using the
LaborLevelEntryWildcard property instead of specifying a labor level entry name,
this property should contain the string "NULL".
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
LaborLevelEntryWildcard
Wildcard for labor level entry
Labor Level Entry Wildcard. If you are using the LaborLevelEntryName property
instead of the wildcard, this property should contain the string "NULL".
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
LaborLevelName
Labor level name
Name of the associated labor level.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
Type
Type of wage adjustment
Integer specifying the type of the wage adjustment. The wage adjustment types
are:
• 1: AdditionóAn amount that is added to or subtracted from the base wage rate
or the current flat rate.
• 0: Flat rateóAn amount that replaces the base wage rate.
• 2: MultiplieróAn amount by which the base wage rate or the current flat rate
is multiplied.
Type: Integer
Optional
Introduced in v5.1
WageProfileName
Wage profile name
Name of the wage profile to which this adjustment belongs.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSAZone Tag
Zone
The Zone tag identifies a zone: that is, an interval of time when an employee can
earn a shift differential. It is an internal tag used within WSAZoneRule.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "RetrieveForUpdate"
Properties→
<WSAZone
[ ConsecutiveDayNumber = Integer ]
[ ConsecutiveLastDayMinimumTime = TimeDuration ]
[ ConsecutiveMinimumTime = TimeDuration ]
[ ConsecutiveType = String ]
[ DaysOfWeekZonesAppliesType = Boolean ]
[ EndNumberOfDay = Integer ]
[ EndTime = Time ]
[ EndWorkAfterTime = Time ]
[ EndWorkAfterTimeSwitch = Boolean ]
[ EndWorkBeforeTime = Time ]
[ EndWorkBeforeTimeSwitch = Boolean ]
[ ExpansionMarginsEarlyTime = TimeDuration ]
[ ExpansionMarginsLateTime = TimeDuration ]
[ HolidayDeductTypeId = String ]
[ HolidayPolicyTypeId = String ]
[ MinimumHoursWithinShift = TimeDuration ]
[ MinimumHoursWithinZone = TimeDuration ]
[ NumberOfDay = Integer ]
[ QualifiersBasedOnType = Boolean ]
[ QualifiersUnscheduled = Boolean ]
[ StartNumberOfDay = Integer ]
[ StartTime = Time ]
[ StartWorkAfterTime = Time ]
[ StartWorkAfterTimeSwitch = Boolean ]
[ StartWorkBeforeTime = Time ]
[ StartWorkBeforeTimeSwitch = Boolean ]
[ TypeCode = String ] >
[ <DaysOfWeek>
<WSADaysOfWeek>
</DaysOfWeek> ]
[ <SelectedHolidays>
<WSAZoneRuleHoliday>∗
</SelectedHolidays> ]
[ <SelectedLimits>
<WSAZoneRuleLimit>∗
</SelectedLimits> ]
</WSAZone>
Action Descriptions
RetrieveForUpdate
Returns the specified zone rule for update.
Return Value Type: WSAZone tag
Required Properties: TypeCode
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
ConsecutiveDayNumber
Number of consecutive days
When the zone type is consecutive days worked and consecutive type is C (Days
is a row), number of the day of the week on which the number of contributing
days is reset to 0 (zero).
Type: Integer
Optional
Introduced in v5.1
ConsecutiveLastDayMinimumTime
Minumum time on last consecutive day
When the zone type is consecutive days worked and the ConsecutiveType
property is C, the minimum amount of time, in HH:mm format, that an employee
must work on the last day in a sequence of consecutive days to receive overtime
pay for that day.
Type: TimeDuration
Optional
Introduced in v5.1
ConsecutiveMinimumTime
Minimum time to qualify towards consecutive overtime
When the zone type is consecutive days worked, the minimum time, in HH:mm
format, an employee must work during a shift for the day to count towards
consecutive day overtime. If the consecutive type is days in a row, the consecutive
day accumulator resets if the shift does not meet the minimum requirement.
Type: TimeDuration
Optional
ConsecutiveMinimumTime is in miliseconds.
Introduced in v5.1
ConsecutiveType
Type of qualifyng consecutive days
When zone type is consecutive days worked, this property specifies one of the
following reset methods:
• A -- Days in a row: Resets the number of contributing days to 0 on the
specified day number. For example, if the value is 7, the count of contributing
days will automatically reset on the seventh day. This method allows days
contributing toward consecutive days work to cross the day divide.
• C -- Days in a row: Resets the number of contributing days to 0 on the
specified day of week.
• D -- Days in a week: Resets the number of contributing days to 0 on the
specified day of the week.
Type: String
Optional
Sample values: Days in a row, Days in a week
Introduced in v5.1
DaysOfWeek
Days of week
When the zone type is days of week and the ConsecutiveType property is D, list of
one or more days that are eligible for a special pay rate.
Type: WSADaysOfWeek tag
Optional
Introduced in v5.1
DaysOfWeekZonesAppliesType
What is the zone type?
When the zone type is days of week, Boolean value that specifies how shifts are
recognized when they cross the day divide. This value can be one of the
following:
• False (default): Hours Worked Between Day Divides ó Activates the zone for
the entire shift.
• True: Hours Applying to Day ó Activates the zone only for the specific day.
Type: Boolean
Optional
Introduced in v5.1
EndNumberOfDay
Day the zone ends
When zone type is daily shift differential or weekend differential, number of the
day when the zone ends and the employee stops accumulating zone hours.
Type: Integer
Optional
Introduced in v5.1
EndTime
Time the zone ends
When the zone type is daily shift differential or weekend differential, the time of
day, in HH:mm format, when the zone ends and the employee stops accumulating
zone hours.
Type: Time
Optional
Introduced in v5.1
EndWorkAfterTime
Allowable amount of time after zone ends
When the zone type is daily shift differential or weekend differential and the
EndWorkAfterTimeSwitch property is True, the amount of time, in HH:mm
format, after a zone ends that an employee can can continue to earn zone hours.
Type: Time
Optional
Introduced in v5.1
EndWorkAfterTimeSwitch
Can an employee earn time after zone end?
When the zone type is daily shift differential or weekend differential, Boolean
value that, when True, indicates that an employee can continue to earn zone hours
after the end of the zone. If the value is False, the EndWorkAfterTime property is
ignored.
Type: Boolean
Optional
Introduced in v5.1
EndWorkBeforeTime
Allowable amount of time before zone ends
When the zone type is daily shift differential or weekend differential and the
EndWorkBeforeTimeSwitch property is True,, the amount of time, in HH:mm
format, before a zone ends that an employee can stop working, but continue to
earn hours for the entire zone.
Type: Time
Optional
Introduced in v5.1
EndWorkBeforeTimeSwitch
Can an employee stop work early and still earn zone time?
When the zone type is daily shift differential or weekend differential, Boolean
value that, when True, indicates an employee can earn zone hours if work is ended
before the end of the zone. If the value is False, the EndWorkBeforeTime
property is ignored.
Type: Boolean
Optional
Introduced in v5.1
ExpansionMarginsEarlyTime
Time before zone when an employee can earn shift differential
When the zone type is daily shift differantial or weekend differential, the amount
of time, in HH:mm format, before the zone start time that an employee can still
earn a shift differential. Hours worked during the expansion window do not count
toward the zone minimum.
Type: TimeDuration
Optional
Default Value: 0.00
Introduced in v5.1
ExpansionMarginsLateTime
Time after zone when an employee can earn shift differential
When the zone type is daily shift differential or weekend differential, the amount
of time, in HH:mm format, after the zone end time that an employee can still earn
a shift differential. Hours worked during the expansion window do not count
toward the zone minimum.
Type: TimeDuration
Optional
Default Value: 0.0
Introduced in v5.1
HolidayDeductTypeId
Id for the holiday zone rule type
When the zone type is holiday, value that defines the effect of worked hours on
holiday credits. The value can be one of the following:
• HolidayDeductNone ó Worked time does not affect the holiday credit.
• HolidayDeductWorked ó Reduces the holiday credit by the amount of time
that the employee worked during the holiday.
• HoidayDeductAll ó Eliminates the holiday credit if the employee works
during the holiday.
Type: String
Optional
Introduced in v5.1
HolidayPolicyTypeId
Id for the holiday policy type
When the zone type is holiday, value indicating where holiday hours belong,
based on the "Hours belong to" property in the Fixed rule. The following values
are defined:
• 0 -- Holiday Zone defined by Times in Holiday Table; Holiday Worked Hours
belong to Day Actually Worked.
• 1 -- Holiday Zone defined by Day Divide; Holiday Worked Hours belong to
Day Actually Worked.
• 2 -- Holiday Zone defined by Day Divide; Holiday Worked Hours belong to
Use Fixed Rule Setting.
• 3 -- Holiday Zone defined by Day Divide; Holiday Worked Hours belong to
Scheduled In-day.
Type: TimeDuration
Optional
Default Value: 0.00
Introduced in v5.1
NumberOfDay
Number of days to work
When the zone type is consecutive days worked and consecutive type is A (Days
is a row), number of the day on which the number of contributing days is reset to
0 (zero).
Type: Integer
Optional
Introduced in v5.1
QualifiersBasedOnType
Will qualifiers be compared to start or must end work times?
If zone type is daily shift differential or weekend differential, Boolean value that,
when True, indicates that work hours are qualified by scheduled start times
compared to the Must Start or Must End work times. When this value is False,
work hours are qualified by rounded punches compared to the Must Start or Must
End work times.
Type: Boolean
Optional
Introduced in v5.1
QualifiersUnscheduled
Can unscheduled employees earn this type of zone hour
If zone type is daily shift differential or weekend differential, Boolean value that,
when True, indicates that unscheduled employees are allowed to earn this type of
zone hour.
Type: Boolean
Optional
Type: Time
Optional
Introduced in v5.1
StartWorkAfterTime
Allowable amount of time after zone begins
When the zone type is daily shift differential or weekend differential and the
StartWorkAfterTime property is True, the amount of time, in HH:mm format,
after a zone begins that an employee can start working, but continue to earn hours
for the entire zone.
Type: Time
Optional
Introduced in v5.1
StartWorkAfterTimeSwitch
Can an employee start work late and still earn zone time?
When the zone type is daily shift differential, Boolean value that, when True,
indicates that an employee can earn zone hours if work is started after the start of
the zone. If the value is False, the StartWorkAfterTime property is ignored.
Type: Boolean
Optional
Introduced in v5.1
StartWorkBeforeTime
Allowable amount of time before zone begins
When the zone type is daily shift differential or weekend differential and the
StartWorkBeforeTime property is True, the amount of time, in HH:mm format,
before a zone begins that an employee can start working.
Type: Time
Optional
Introduced in v5.1
StartWorkBeforeTimeSwitch
Can an employee start work before the zone begins?
When the zone type is daily shift differential or weekend differential, Boolean
value that indicates, when True, that an employee can earn zone hours if work is
started before the start of the zone. If the value is False, the StartWorkBeforeTime
property is ignored.
Type: Boolean
Optional
Introduced in v5.1
TypeCode
Zone type
Type of zone. Valid zone types include:
• C -- Consecutive days worked
• H -- Holiday
• D -- Days of week
• S -- Daily shift differential
• W -- Weekend differential
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSAZoneCombinationRule Tag
Zone Combination Rule
The Zone Combination Rule tag allows you to define a zone combination rule.
Zone combinations specify which zone rule takes precedence if an employee
qualifies for more than one zone.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAZoneCombinationRule
[ Name = String ] >
[ <CombinationRules>
<WSAZoneCombinationSpecificationRule>∗
</CombinationRules> ]
[ <SelectedZoneRules>
<WSAZoneCombinationZoneRule>∗
</SelectedZoneRules> ]
</WSAZoneCombinationRule>
Action Descriptions
RetrieveAllForUpdate
Returns all zone combination rules for update.
Return Value Type: Zero or more WSAZoneCombinationRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all zone combination rules.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified zone combination rule for update.
Return Value Type: WSAZoneCombinationRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified zone combination rule.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
CombinationRules
Zone combination rules
List of one or more combination rules to be applied to this zone combination rule.
Type: Zero or more WSAZoneCombinationSpecificationRule tags
Optional
If only one zone rule exists, you must create a zone combination rule that contains
the one zone rule.
Introduced in v5.1
Name
Name of zone combination rule
Name of the zone combination rule. The name can be up to 32 characters long, is
case insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
SelectedZoneRules
Selected zone rules
List of one or more zone rules used for a combination.
Type: Zero or more WSAZoneCombinationZoneRule tags
Optional
Introduced in v5.1
WSAZoneCombinationSpecificationRule Tag
Zone Combination Specification Rule
Allows the management of zone combination specification rules. This is an
internal tag used within WSAZoneCombinationRule.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "RetrieveForUpdate"
Properties→
<WSAZoneCombinationSpecificationRule
[ ItemName = String ]
[ KeyName = String ]
[ ValueName = String ] />
Action Descriptions
RetrieveForUpdate
Retrieve the specified instance from the DB
Return Value Type: WSAZoneCombinationSpecificationRule tag
Required Properties: ItemName, KeyName, ValueName
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
ItemName
Zone rule
WSAZoneCombinationZoneRule Tag
Zone Combination Zone Rule
Allows the management of zone rules within the context of a zone combination
rule. This is an internal tag used within WSAZoneCombinationRule.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "RetrieveForUpdate"
Properties→
<WSAZoneCombinationZoneRule
[ Name = String ] />
Action Descriptions
RetrieveForUpdate
Retrieve the specified instance from the DB
Return Value Type: WSAZoneCombinationZoneRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
Name
Name of zone combination zone rule
Name of the zone combination zone rule. The name can be up to 32 characters
long, is case-insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WSAZoneRule Tag
Zone Rule
The Zone Rule tag allows you to describe the amount of time within a zone that an
employee is required to work.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Properties→
<WSAZoneRule
[ Name = String ]
[ RequiresApproval = Boolean ] >
[ <Zone>
<WSAZone>
</Zone> ]
</WSAZoneRule>
Action Descriptions
RetrieveAllForUpdate
Returns all zone rules for update.
Return Value Type: Zero or more WSAZoneRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all zone rules.
Return Value Type: Zero or more NameList tags
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns the specified zone rule for update.
Return Value Type: WSAZoneRule tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates the specified zone rule.
Return Value Type: None
Required Properties: Name
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
Name
Name of zone rule
Name of the zone rule. The name can be up to 32 characters long, is case-
insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
RequiresApproval
Is approval required?
Boolean value that, when True, indicates that manager approval is required to use
this zone.
Type: Boolean
Optional
Introduced in v5.1
Zone
Zone
Zone associated with this zone rule.
Type: WSAZone tag
Optional
Sample values: Evening, Night, Sunday, Weekend
Introduced in v5.1
WSAZoneRuleHoliday Tag
Zone Type for Holiday Rule
The Zone Type for Holiday Rule tag describes the zone type for the holiday rule.
This is an internal tag used within the WSAZoneRule tag.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "RetrieveForUpdate"
Properties→
<WSAZoneRuleHoliday
[ Name = String ]
[ StartDateTime = DateTime ] />
Action Descriptions
RetrieveForUpdate
Returns the specified zone holiday rule for update,
Return Value Type: WSAZoneRuleHoliday tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
Name
Name of holiday zone rule
Name of the holiday type zone rule. The name can be up to 32 characters long, is
case-insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
StartDateTime
Start date and time
The start date and time in MM/DD/YYYY HH:mm AM|PM format.
Type: DateTime
Optional
Introduced in v5.1
WSAZoneRuleLimit Tag
Zone Rule Limit
The Zone Rule Limit tag allows the management of Zone Rule limits. This is an
internal tag that is used within WSAZoneRule.
Function Access Control Point: WSA.PayRules
Introduced in v5.1
Syntax
Request→
<Request Action = Actions >
Properties
</Request>
Actions→ "RetrieveForUpdate"
Properties→
<WSAZoneRuleLimit
[ Name = String ] />
Action Descriptions
RetrieveForUpdate
Returns the specified zone rule limiy for update.
Return Value Type: WSAZoneRuleLimit tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Property Descriptions
Name
Name of zone rule limit
Name of the zone rule limit. The name can be up to 32 characters long, is case-
insensitive, and must be unique.
Type: String
Optional
Contributes to Uniqueness: Yes
Introduced in v5.1
WTDEmployeeAssignment Tag
Working Time Directive Employee Assignment
The Working Time Directive feature lets you plan, monitor, and track the amount
of time that employees are required to work. It also lets you ensure that employees
have appropriate rest periods. You can set up Working Time Directive rules for
various types of employees such as Night Workers, Hazardous Night Workers,
and Young Workers.
Set up the application of Working Time Directive rules by defining the global
settings (WTDGlobal tag) and the rules (WTDRule tag). Global settings apply to
all of the workers at your site, and Working Time Directive rules can be tailored
for individual groups of workers.
You do not need to assign a Working Time Directive rule to all employees. You
should assign Working Time Directive rules only to those employees who have
working time limits.
Use this WTDEmployeeAssignment tag to assign a Working Time Directive rule
to an employee or to retrieve information about current Working Time Directive
rule assignments.
See individual actios.
Function Access Control Point: Working Time Directive
Introduced in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveAll" |
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update"
Parameters→
EmployeeId = Long
Properties→
<WTDEmployeeAssignment
EmployeeId = Long
[ HazardousWorker = Boolean ]
Id = Long
Name = String
WtdRuleId = Long >
[ <OptOutStatusList>
<OptOutStatusList>∗
</OptOutStatusList> ]
</WTDEmployeeAssignment>
Action Descriptions
Retrieve
Returns an WTDEmployeeAssignment Bean. If the object does not exist then
Object Key Not Found exception is thrown.
Return Value Type: WTDEmployeeAssignment tag
Access Control Point Name: View
Introduced in v5.1
Action Parameters
RetrieveAll
Returns all Employee Assignments.
Return Value Type: Zero or more WTDEmployeeAssignment tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllForUpdate
Returns all WTDEmployeeAssignments for SDM update.
Return Value Type: Zero or more WTDEmployeeAssignment tags
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns the names of all Employee Assignments. This is formated as
<Name>|<WTKEmployeeId>
Return Value Type: String list
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Retrieves a single WTDEmplyoeeAssignement for SDM update.
Return Value Type: WTDEmployeeAssignment tag
Access Control Point Name: View
Introduced in v5.1
Update
Adds or updates an WTDEmployeeAssignment.
Return Value Type: None
Required Properties: EmployeeId WtdRuleId
Optional Properties: Id
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
EmployeeId
Employee Id
The WTKEmployeeId that this rule is being assigned to.
Type: Long
Required
not null
Sample values: 101
Introduced in v5.1
HazardousWorker
Hazardous Worker
Flag indicating if the employee's job is hazardous.
Type: Boolean
Optional
Sample values: True
Introduced in v5.1
Id
Id
The primary key of a Working Time Directive rule.
Type: Long
Required
not null
Sample values: 1
Contributes to Uniqueness: Yes
Introduced in v5.1
Name
Name
The name of the employee/rule assignment.
Type: String
Required
Introduced in v5.1
OptOutStatusList
OptOutStatusList
The list of effective dated OptOutStatuses
Type: Zero or more OptOutStatusList tags
Optional
Introduced in v5.1
WtdRuleId
WTD Rule Id
The Working Time Directive rule that is being assigned to an employee.
Type: Long
Required
not null
Sample values: 101
Introduced in v5.1
WTDGlobal Tag
Working Time Directive Global Configuration
Creates or modifies the global settings used in Working Time Directive
calculations. The global settings that you choose identify the pay codes that are
included and excluded from the Working Time Directive.
Global settings apply to every worker at your installation. To apply Working Time
Directive rules to a specific set of workers, use Working Time Directive rules.
See individual Actions. All actions check caller access to
WTD_CONFIGURATION
Function Access Control Point: Working Time Directive
Introduced in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"DeleteOnly" |
"Retrieve" |
"RetrieveAll" |
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update" |
"UpdateOnly"
Parameters→
Id = Long
Properties→
<WTDGlobal
[ BreakPayCode = Long ]
[ BreakPayCodeName = String ]
[ ExcludedPayCodeName = String ]
[ ExludedPayCode = Long ]
Id = Long
IncludedPayCode = Long
IncludedPayCodeName = String
Name = String />
Action Descriptions
Add
Creates the global settings for Working Time Directive by including a list of pay
codes. You can choose a specific pay codes, or you can choose All Regular pay
codes. The global settings that you choose identify the pay codes for your site that
are included in Working Time Directive and apply to every worker at your
installation. To apply Working Time Directive rules to a specific set of workers,
use Working Time Directive rules.
Id and IncludedPayCode cannot be null.
Return Value Type: None
Required Properties: IncludedPayCode
Optional Properties: Id BreakPayCode ExcludedPayCode
Access Control Point Name: Edit
Introduced in v5.1
AddOnly
Adds a new instance. If an object exist for this Id then a duplicate exception is
thrown.
Id and IncludedPayCode cannot be null
Return Value Type: None
Required Properties: Id IncludedPayCode
Optional Properties: ExcludedPayCode BreakPayCode
Access Control Point Name: Edit
Introduced in v5.1
Delete
Deletes the specified pay code from the Working Time Directive global settings.
If the pay code is not listed in the global settings, no error is returned.
Return Value Type: None
Required Properties: Id
Access Control Point Name: Edit
Introduced in v5.1
DeleteOnly
Deletes an instance. If the object is not found then
OBJECT_NOT_FOUND_KEY is thrown.
Return Value Type: None
Required Properties: Id
Access Control Point Name: Edit
Introduced in v5.1
Retrieve
Returns a list of pay codes in the Working Time Directive Global settings. If the
object is not found then OBJECT_NOT_FOUND_KEY is thrown.
None
Return Value Type: WTDGlobal tag
Access Control Point Name: View
Introduced in v5.1
Action Parameters
RetrieveAll
Returns all global configurations, which should equal exactly 1 configuration
object. Implemented for future enchancements.
Return Value Type: Zero or more WTDGlobal tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllForUpdate
Returns all for SDM update.
Return Value Type: Zero or more WTDGlobal tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllNames
Returns all names for the Setup Data Manager (SDM).
Return Value Type: String list
Access Control Point Name: View
Introduced in v5.1
RetrieveForUpdate
Returns an instance for the provided name. If the object does not exists and an
Object key not found exception is thrown.
Return Value Type: WTDGlobal tag
Required Properties: Name
Access Control Point Name: View
Introduced in v5.1
Update
Updates a global config. If it does not exist then it is created.
Id IncludedPayCode cannot be null
Return Value Type: None
Required Properties: IncludedPayCode IncludedPayCodeName
Optional Properties: Id ExcludedPayCode BreakPayCode
Access Control Point Name: Edit
Introduced in v5.1
UpdateOnly
updates only. If the object is not found then OBJECT_NOT_FOUND_KEY is
thrown.
Id and IncludedPayCode cannot be null.
Return Value Type: None
Required Properties: Id IncludedPayCode
Optional Properties: BreakPayCode ExcludedPayCode
Access Control Point Name: Edit
Introduced in v5.1
Property Descriptions
BreakPayCode
Break Pay Code
One or more pay codes that you use to identify workersí breaks.
Type: Long
Optional
Sample values: 101
Introduced in v5.1
BreakPayCodeName
Break Pay Code Name
name of the break pay code
Type: String
Optional
Introduced in v5.1
ExcludedPayCodeName
Excluded Pay Code Name
Name of the excluded pay code.
Type: String
Optional
Introduced in v5.1
ExludedPayCode
Pay codes to exclude when applying rules
One or more pay codes to exclude when applying the Working Time Directive
rules. This is useful when you want to exclude one or more pay codes after having
included All Regular pay codes.
Type: Long
Optional
Sample values: 101
Introduced in v5.1
Id
Id
Primary key of the global configuration.
Type: Long
Required
cannot be null
Sample values: 1
WTDRule Tag
Working Time Directive Rule
This tag lets you retrieve, add, delete, or modify Working Time Directive rules.
A Working Time Directive rule specifies information such as maximum working
hours and minimum amounts of time off for certain workers subject to Working
Time Directive limits (for example, young workers or hazardous duty workers).
You should assign Working Time Directive rules only to those employees who
have working time limits.
The pay codes to which Working Time Directive rules are defined by the
WTDGlobal tag. The rules that you define in this WTDRule tag are assigned to
individual employees by the WTDEmployeeAssignment tag.
See Individual Actions.
Function Access Control Point: Working Time Directive
Introduced in v5.1
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"DeleteOnly" |
"Retrieve" |
"RetrieveAll" |
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveForUpdate" |
"Update" |
"UpdateOnly"
Parameters→
Ruleid = Long
Properties→
<WTDRule
[ Description = String ]
[ EndNightPeriod = DateTime ]
ExceptionsOnly = Integer
ExcludedHours = Integer
FirstDayOfWeek = Integer
MaxAdultWork = Integer
[ MaxHazardousNightHours = Integer ]
[ MaxNightHours = Integer ]
MaxWeeklyHours = Integer
MaxYoungWork = Integer
MinAdultBreak = Integer
MinAdultDailyRest = Integer
MinAdultWeeklyRest = Integer
[ MinPercentNightHours = Double ]
MinYoungBreak = Integer
MinYoungDailyRest = Integer
MinYoungWeeklyRest = Integer
Name = String
NumberOfIterations = Integer
OffAveragePeriod = Long
RuleId = Long
[ StartNightPeriod = DateTime ]
WorkedAveragePeriod = Integer
WorkWeekLength = Integer
[ YoungWorkerAge = Integer ]
[ YoungWorkerMaxDailyHours = Integer ]
[ YoungWorkerMaxWeeklyHours = Integer ] />
Action Descriptions
Add
Adds a new WTDRule. If the object already exists a new one is created.
Return Value Type: None
Required Properties: Name WorkWeekLength FirstDayOfWeek
NumberOfIterations ExceptionsOnly MaxWeeklyHours ExcludedHours
WorkedAveragePeriod MaxAdultWork MinAdultBreak MinAdultDailyRest
DeleteOnly
If the rule exists it will be deleted if it does not then an object key not found
exception is thrown.
RuleId cannot be null
Return Value Type: None
Required Properties: RuleId
Access Control Point Name: Edit
Introduced in v5.1
Retrieve
Returns the Working Time Directive rule for the specified RuleId. If the rule does
not exist and an Object key not found, an exception is thrown.
Return Value Type: WTDRule tag
Access Control Point Name: View
Introduced in v5.1
Action Parameters
RetrieveAll
Retrieves all Working Time Directive rules.
Return Value Type: Zero or more WTDRule tags
Access Control Point Name: View
Introduced in v5.1
RetrieveAllForUpdate
Returns all rules for SDM update.
Return Value Type: String list
Property Descriptions
Description
RuleDescription
Short Description.
Type: String
Optional
Cannot exceed 50 characters in length
Sample values: "Description"
Introduced in v5.1
EndNightPeriod
End Night Period
The time on which the night period ends.
Type: DateTime
Optional
Must be a valid date/time
Sample values: 1/1/2005 5:00AM
Introduced in v5.1
ExceptionsOnly
Report Content
Specifies if the report should contain data for everyone or just those that are in
violation.
Type: Integer
Required
cannot be null.
Sample values: 1
Introduced in v5.1
ExcludedHours
Excluded Hours
The minimum number of hours worked in a day to have that day included in an
averaging calculation.
Type: Integer
Required
Cannot be null and must be greater than 0
Sample values: 4
Introduced in v5.1
FirstDayOfWeek
First Day Of Week
The day of the week on which the work week begins.
Type: Integer
Required
Must be greater than 0 and less than 7
Sample values: 0
Introduced in v5.1
MaxAdultWork
Maximum Adult Work Time Without Rest Break
The maximum number of hours an adult who is subject to Working Time
Directive limits should work without a rest break
Type: Integer
Required
Must be greater than 0.
Sample values: 40
Introduced in v5.1
MaxHazardousNightHours
Maximum Hazardous Night Hours
The maximum number of hours an employee should work during the night
performing hazardous work.
Type: Integer
Optional
Must be greater than 0.
Sample values: 6
Introduced in v5.1
MaxNightHours
Maximum Night Hours
The maximum number of hours an employee should work at night.
Type: Integer
Optional
Must be greater than 0.
Sample values: 8
Introduced in v5.1
MaxWeeklyHours
Maximum hours per Week
The maximum number of hours in a work week that employees covered by this
Working Time Directive rule may work.
Type: Integer
Required
Cannot be null and must be greater than 0.
Sample values: 48
Introduced in v5.1
MaxYoungWork
Maximum Young Worker Time Without Break
The maximum number of hours that a Young Worker who is subject to Working
Time Directive limits should work without a rest break.
Type: Integer
Required
Must be greater than 0.
Sample values: 40
Introduced in v5.1
MinAdultBreak
Minimum Adult Rest Break Length
The minimum length of a break, expressed in minutes, for an adult who is subject
to Working Time Directive limits.
Type: Integer
Required
Must be greater than 0.
Sample values: 30
Introduced in v5.1
MinAdultDailyRest
Minimum Adult Daily Rest
The minimum number of hours of rest per day for an employee who is subject to
Working Time Directive limits.
Type: Integer
Required
Must be greater than 0.
Sample values: 16
Introduced in v5.1
MinAdultWeeklyRest
Minimum Adult Weekly Rest
The minimum number of hours a week an adult worker should have to rest.
Type: Integer
Required
Must be greater than 0.
Sample values: 24
Introduced in v5.1
MinPercentNightHours
Minimum Percent Night Hours
The minimum percent time of a shift worked during the night period to have it
count as a night shift.
Type: Double
Optional
Must be a percentage that is greater than 0.
Sample values: 50
Introduced in v5.1
MinYoungBreak
Minimum Young Worker Rest Break Length
The minimum length of a break, expressed in minutes, for a Young Worker who is
subject to Working Time Directive limits.
Type: Integer
Required
Must be greater than 0.
Sample values: 30
Introduced in v5.1
MinYoungDailyRest
Minimum Young Worker Daily Rest Length
The minimum number of hours of rest per day for a Young Worker who is subject
to Working Time Directive limits.
Type: Integer
Required
Must be greater than 0.
Sample values: 18
Introduced in v5.1
MinYoungWeeklyRest
Minimum Young Worker Rest Break Length
The minimum number of hours weekly a young worker should have to rest.
Type: Integer
Required
Must be greater than 0.
Sample values: 48
Introduced in v5.1
Name
Rule Name
The name of the rule.
Type: String
Required
Cannot be null. Cannot excced 50 characters.
Sample values: "Rule One"
Introduced in v5.1
NumberOfIterations
Number of Iterations
How many iterations should an averaging report run.
Type: Integer
Required
Greater than 0 less than 6
Sample values: 1
Introduced in v5.1
OffAveragePeriod
Off Time Average Period.
The number of weeks used in off time averaging calculations.
Type: Long
Required
Must be greater than 0.
Sample values: 17
Introduced in v5.1
RuleId
RuleId
Primary key of a rule.
Type: Long
Required
Cannot be null
Contributes to Uniqueness: Yes
Introduced in v5.1
StartNightPeriod
Start Night Period
The time that marks the beginning of the night period
Type: DateTime
Optional
Must be a valide date/time
Sample values: 1/1/2005 6:00PM
Introduced in v5.1
WorkedAveragePeriod
Average Period for Working Time
The number of weeks to use in an averaging calculation.
Type: Integer
Required
cannot be null and must be greater than 0
Sample values: 17
Introduced in v5.1
WorkWeekLength
Work Week Length
The length of the work week, expressed as a number of days.
Type: Integer
Required
Must be greater than 1
Sample values: 7
Introduced in v5.1
YoungWorkerAge
Young Worker Age
The age for which an employee is considered a Young Worker for Working Time
Directive. Employess whose age is less than or equal to the age listed will be
considered as Young Workers.
Type: Integer
Optional
Must be greater than 0.
Sample values: 18
Introduced in v5.1
YoungWorkerMaxDailyHours
Young Worker Max Daily Hours
The maximum number of hours a young worker should work per day.
Type: Integer
Optional
WTKEmployee Tag
Employee Information
The WTKEmployee tag returns pay rules, accrual, wage, and other information
associated with a person.
Used by: Personality
When the WTKEmployee tag is used by the Personality tag to add employee
information, the PayRuleName must be specified.
Function Access Control Point: API.Person
Introduced in v4; last changed in v5.1
Deprecated in v5.0: Use the Person and JobAssignmentDetails tags instead.
Syntax
Request→
<Request Action = Actions
Parameters >
Properties
</Request>
Action Descriptions
GetPayPeriodDates
Returns the applicable pay period dates for an employee for a given time frame.
Return Value Type: TimeFramePeriod tag
Required Properties: Identity
Access Control Point Name: View
Introduced in v4; last changed in v5.0
Deprecated in v5.0
Action Parameters
Load
Returns WTKEmployee information for the specified person.
Return Value Type: WTKEmployee tag
Required Properties: Identity
Access Control Point Name: View
Introduced in v4; last changed in v5.0
Deprecated in v5.0: Use the Load action in the Person and JobAssignmentDetails
tags instead.
Property Descriptions
AccrualProfileName
Accrual profile
The accrual profile to be used for a person or group. Accrual profiles are based on
your company's accrual rules and policies that apply to similar groups of
employees. The rules determine how employees accrue their time or money, or
both. When an employee uses accrued time or money, specified amounts are
deducted from the balance. When an employee receives or earns time or money,
specified amounts are credited to the balances.
Type: String
Optional
Maximum length: 50 characters
You can find values in the Workforce Timekeeper Setup Application.
Sample values: VAC and Sick Only
Introduced in v4; last changed in v5.0
Deprecated in v5.0: Use the property in the Person tag instead.
DeviceGroupName
Device group
The name of the group of devices that the employee is authorized to use.
Type: String
Optional
Maximum length: 50 characters
You can find values in the Workforce Timekeeper Setup Application.
Introduced in v4; last changed in v5.0
Deprecated in v5.0: Use the property in the JobAssignmentDetails tag instead.
Identity
Identity
One employee, as specified in a PersonIdentity or CurrentUser tag.
Type: Either CurrentUser or PersonIdentity tag
Required
Must uniquely identify an existing and active employee
Contributes to Uniqueness: Yes
Introduced in v4; last changed in v5.0
Deprecated in v5.0
ManagerSignoffThruDateTime
Date of manager signoff
Date of the last manager signoff
Type: Date
Output Only
Introduced in v4; last changed in v5.0
Deprecated in v5.0: Use the property in the Person tag instead.
PayrollLockoutThruDateTime
Date of payroll lockout
Date of the last payroll lockout
Type: Date
Output Only
Introduced in v4; last changed in v5.0
Deprecated in v5.0: Use the property in the Person tag instead.
PayRuleName
Pay rule
The name of the pay rule that is assigned to the employee. A pay rule defines the
set of business standards by which persons are paid and determines how the
person's time is processed and categorized.
Type: String
Optional
Maximum length: 50 characters
Required: For a new TimeKeeper user
Required: When a person is tracked
You can find values in the Workforce Timekeeper Setup Application.
Introduced in v4; last changed in v5.0
Deprecated in v5.0: Use the property in the JobAssignmentDetails tag instead.
ScheduleGroupName
Schedule group name
The name of the schedule group to which the person is currently assigned
Type: String
Optional
Maximum length: 30 characters
You can find values in the Workforce Timekeeper user interface.
Introduced in v4; last changed in v5.0
Deprecated in v5.0: Use the property in the JobAssignment tag instead.
TimeZoneName
Time zone
Contains either the ID, a five-digit value that describes how the local time for a
region relates to Greenwich mean time (GMT), or the exact name of the time zone
in which the person works. A value is required when a value is also specified for
DeviceGroupName. If you do not specify a value, the default time zone is used.
Type: String
Optional
Maximum length: 30 characters
For a list of values, see ìTime Zone Definitionsî in Appendix B in the Workforce
Timekeeper DTK Reference Guide.
Introduced in v4; last changed in v5.0
Deprecated in v5.0: Use the property in the JobAssignmentDetails tag instead.
WageProfileName
Wage profile
The name of the person's wage profile
Type: String
Optional
Maximum length: 50 characters
Introduced in v4; last changed in v5.0
›Accruals ¸AddComment
EmployeeSummary tag 205 HistoricalPayCodeEdit tag 237
›AccrualType HistoricalPayCodeMove tag 245
AccrualBalanceSummary tag 43 NonCancellingPayCodeEdit tag 420
›AccrualViolation OvertimeApproval tag 453
ScheduleHoursStatus tag 692 PayCodeEdit tag 466
›Action PayCodeMove tag 475
Request tag 629 Punch tag 607
›ActionListSwitch WorkedDuration tag 847
ProcessTemplate tag 601 ¸AddEmployees
›ActionName ScheduleGroup tag 676
Error tag 214 ›AddEntries
Permission tag 495 LaborAccountEntry tag 286
WSAPermission tag 1053 OrgSetEntry tag 448
›Active ¸AddOnly
WSAComment tag 922 ApprovalStatus tag 66
›ActiveDays BidGroup tag 88
EmployeeTenure tag 207 BidGroupItem tag 94
›ActiveEmployeeTenure BidRequest tag 102
EligibilityRequirement tag 191 CheckAdvice tag 121
›ActiveFlag Document tag 159
PersonAuthenticationType tag 521 DocumentStatus tag 168
PersonLicenseType tag 545 EligibilityRequirement tag 188
›ActiveSwitch FailedXMLTransaction tag 221
ProcessTemplate tag 601 HistoricalPayCodeEdit tag 237
ShiftStartTimeBand tag 750 HistoricalPayCodeMove tag 245
›ActualNumberOfActiveDays ImportBatchStatus tag 266
TimekeepingException tag 782 LaborAccountSet tag 292
¸Add LaborLevelEntry tag 302
Document tag 158 LeaveCase tag 311
LeaveDocumentTemplate tag 341 LeaveCategory tag 330
PersonLeaveProfileAssignment tag 543 LeaveDocumentTemplate tag 341
Process tag 564 LeaveProfile tag 348
ProcessTemplate tag 586 LeaveReason tag 357
WTDGlobal tag 1175 LeaveRequest tag 362
WTDRule tag 1182 LeaveRule tag 366
›AddAtTerminalFlag LeaveType tag 380
LaborLevelDefinition tag 299 NonCancellingPayCodeEdit tag 420
¸AddBids OrgSet tag 445
BidGroupItem tag 94 PayCodeEdit tag 466
›AmountInTime ›AnchorDate
AccrualMove tag 55 EffectiveWorkload tag 177
EarnedAccrual tag 175 ScheduleAccrualPattern tag 667
OnCall tag 425 SchedulePattern tag 705
OvertimeApproval tag 454 ›APIBeanName
PatternElement tag 458 FailedXMLTransaction tag 221
ResetAccrual tag 640 ›AppendDurationAmount
ScheduleAccrualAmountEdit tag 663 AppendShifts tag 64
ScheduleAccrualPattern tag 667 ¸AppendShift
ScheduleHours tag 683 Schedule tag 650
SchedulePayCodeEdit tag 710 ›AppendShifts
Total tag 791 Schedule tag 656
TotaledScheduledWorkedDuration tag 802 ›AppendToBeginOrEnd
WorkedDuration tag 848 AppendShifts tag 64
›AmountInTimeOrCurrency ¸ApplyBidNotes
EarnedAccrual tag 175 Bid tag 83
HistoricalPayCodeEdit tag 238 ›ApplyHour
HistoricalPayCodeMove tag 246 WSACreditCalculator tag 940
HolidayEditHours tag 254 ›ApplyOnly
HolidayEditWages tag 256 WSAEffectivePayRule tag 956
NonCancellingPayCodeEdit tag 421 ›ApplyToDate
PayCodeEdit tag 467 WSAFixedRule tag 975
PayCodeMove tag 476 ›ApprovalStatus
ResetAccrual tag 641 LeaveCase tag 320
SchedulePayCodeEdit tag 710 ›ApprovalStatusAsOf
TotaledScheduledPayCodeEdit tag 795 LeaveCase tag 320
TotaledScheduledPayCodeEditUneditable ¸Approve
tag 798 ApproveSignoff tag 71
›AmountOperator VacationBid tag 830
WorkHour tag 866 ¸ApproveAll
›AmountUnit OvertimeApproval tag 453
DocumentDueDate tag 163 ¸ApproveNone
DocumentReminder tag 166 OvertimeApproval tag 453
›AmountUnits ¸ApproveSome
WSAWorkHistoryQualifierRule tag 1124 OvertimeApproval tag 453
›AmountYTD ›AsIfWorkedSwitch
CheckAdviceDetailDeductions tag 126 WSACreditCalculator tag 940
CheckAdviceDetailGrossPay tag 130 ¸AssignBreaks
›AmtOperator Schedule tag 651
EmployeeTenure tag 207 ¸AssignCoverShift
›HazardousWorker ›HyperFindQueryName
WTDEmployeeAssignment tag 1172 HyperFindQuery tag 261
›HeadcountPatterns
EffectiveWorkload tag 178 I
›Headcounts ›Id
HeadcountPattern tag 234 WorkflowTemplateCategory tag 864
›HireDate WTDEmployeeAssignment tag 1172
Person tag 501 WTDGlobal tag 1179
›HistoricalDate Id
HistoricalPayCodeEdit tag 240 WTDGlobal tag 1177
HistoricalPayCodeMove tag 249 ›Identity
›HolidayCreditRuleName BadgeAssignment tag 81
WSAEffectivePayRule tag 957 EmploymentStatus tag 212
›HolidayDeduct JobAssignment tag 272
WSACreditCalculator tag 943 PersonAccessAssignment tag 506
›HolidayDeductTypeId Personality tag 510
WSAZone tag 1149 PersonalOvertimeAssignment tag 515
›HolidayName PersonInformation tag 540
HolidayEditHours tag 255 PrimaryLaborAccount tag 561
HolidayEditWages tag 257 User tag 817
WSAPayRuleHoliday tag 1051 UserAccountStatus tag 826
›HolidayPolicy WorkflowAccessAssignment tag 862
WSACreditCalculator tag 943 WTKEmployee tag 1197
›HolidayPolicyTypeId ImpactsAccruals
WSAZone tag 1149 LeaveCase tag 315
›Holidays ›ImpactsAccrualsFlag
WSAEffectivePayRule tag 957 HistoricalPayCodeEdit tag 241
›HomeAccounts HistoricalPayCodeMove tag 249
PersonInformation tag 539 ›In
›HourAmount OptOutStatus tag 434
WorkHour tag 867 ›Inactive
›Hours WSALaborLevelEntry tag 997
CheckAdviceDetailGrossPay tag 131 ›InactiveFlag
ScheduleCostPaycode tag 670 LaborLevelEntry tag 304
›HoursPerDay ›InActiveSw
AccrualBalanceSummary tag 44 WfcJob tag 843
AccrualCode tag 50 ›InactivityTimeOut
VacationBid tag 833 WSALogonProfile tag 1002
›HoursWorked ›InactivityTimeOutSwitch
EligibilityRequirement tag 192 WSALogonProfile tag 1002
TotaledScheduledPayCodeEditUneditable ›LastTotalizationDateTime
tag 800 Timesheet tag 787
TotaledScheduledWorkedDuration tag 803 ›LateEnd
TotaledSpan tag 806 WSATkTerminalRule tag 1108
TransferEmployee tag 810 ›LateEndBreakMargin
WorkedDuration tag 850 WSATkTerminalRule tag 1108
›LaborAccountSetKey ›LateEndMargin
LaborAccountSet tag 293 WSATkTerminalRule tag 1109
›LaborAccountSetName ›LateScheduleMargin
LaborAccountSet tag 294 WSATkTerminalRule tag 1109
›LaborAccountSetProfileId ›LateStart
LaborAccountSetProfile tag 297 WSATkTerminalRule tag 1109
›LaborAccountSetProfileName ›LateStartBreakMargin
LaborAccountSetProfile tag 297 WSATkTerminalRule tag 1110
›LaborAccountSetTypeName ›LeaveCaseRuleAssignments
LaborAccountSet tag 294 LeaveCase tag 324
›LaborLevelDefinitionName ›LeaveCaseShortName
LaborAccountEntry tag 287 LeaveRequest tag 363
LaborAccountEntryData tag 290 ›LeaveCaseStartDate
LaborLevelDefinition tag 299 LeaveRequest tag 363
LaborLevelEntry tag 304 ›LeaveDocumentReminders
LaborLevelDefinitionName LeaveTypeDocumentAssignment tag 386
LaborLevelEntry tag 302, 303 ›LeaveProfile
›LaborLevelEntries PersonLeaveProfileAssignment tag 544
LaborAccount tag 285 ›LeaveRule
›LaborLevelEntryName LeaveProfileCategoryRule tag 354
LaborLevelEntry tag 305 ›LeaveTakings
WSAWPWageAdjustment tag 1141 LeaveTime tag 378
›LaborLevelEntryWildcard ›LeaveTimes
WSAWPWageAdjustment tag 1141 LeaveCase tag 324
›LaborLevelName ›LeaveType
WSAWageProfileLaborLevelLinkage EligibilityEvaluation tag 185
tag 1120 LeaveProfileCategoryType tag 355
WSAWPWageAdjustment tag 1141 LeaveTaking tag 373
›Language LeaveTakingNode tag 375
LeaveDocumentTemplate tag 344 LeaveTypeReason tag 387
›LastName ›LeaveTypeDocumentAssignments
Person tag 502 LeaveType tag 383
›LastSubmitted ›LeaveTypeReasons
BidGroupItem tag 97 LeaveReason tag 360
¸LoadShifts ›LongChgPoint
RequestToCover tag 633 WSABreakRule tag 900
¸LoadSkillAssignments ›LongException
PersonSkillAssign tag 550 WSABreakRule tag 900
¸LoadTemplatePatterns ›LongGrace
SchedulePattern tag 704 WSABreakRule tag 900
¸LoadUserAccount ›LongInterval
User tag 817 WSAExceptionRule tag 971
¸LoadUserAccountStatuses ›LongRound
UserAccountStatus tag 825 WSABreakRule tag 901
›LocationName ›LookBackTime
OrgLocation tag 439 WSAContributingShiftRule tag 931
›LocationNum ›LookBackUnit
OrgLocation tag 440 WSAContributingShiftRule tag 932
›LocationOrgNodePath
TransferJobSeniorityDate tag 812 M
›Locations ›MajorityRuleName
ProcessTask tag 580 WSAOptionalRule tag 1010
Schedule tag 657 ›MajorityRuleNames
›LocationType WSAWorkRulePCDistr tag 1136
OrgLocation tag 440 ›Manager
›Locator BidRequest tag 106
WSABonusDeductRule tag 890 ›ManagerAccessFlag
›LocatorAtOrAfter PayCode tag 463
WSABonusDeductRule tag 891 ›ManagerAccessOrganizationSetName
›LocatorBefore PersonAccessAssignment tag 506
WSABonusDeductRule tag 891 ›ManagerAccessSetName
¸LockDays AccessAssignment tag 28
Schedule tag 652 ›ManagerHasAccessFlag
›LockoutReasonName WorkRule tag 870
UserAccountLockout tag 823 ›ManagerName
›LockoutResetDateTime CancelDeductions tag 116
UserAccount tag 819 PayCodeEdit tag 470
¸LockShifts PayCodeMove tag 480
Schedule tag 653 Punch tag 613
›LogonProfileId ›ManagerPayCodeName
LogonProfile tag 395 AccessAssignment tag 29
›LogonProfileName ›ManagerSignoffDateTime
LogonProfile tag 395 Timesheet tag 788
UserAccount tag 820 ›ManagerSignoffThruDateTime
Y
›YesNode
LeaveDecisionNode tag 336
›YoungWorkerAge
WTDRule tag 1193
›YoungWorkerMaxDailyHours
WTDRule tag 1193
›YoungWorkerMaxWeeklyHours
WTDRule tag 1194
Z
›Zone
WSAZoneRule tag 1164
›ZoneCombination
WSAPayCodeDistribution tag 1037
›ZoneDescription
ScheduleZone tag 734
›ZoneName
ScheduleZone tag 734
›ZoneRuleNames
WSAWorkRulePCDistr tag 1137
›Zones
WSAPayDistributionAssociation tag 1043