Kronos WFC 4500 Developers Toolkit Reference

Workforce Central ®
Developer’s Toolkit Reference

Guide
An alphabetical listing of the XML application programming

interface (API) tag definitions that are used by the Workforce
Central platform and Workforce Timekeeper.
Kronos Workforce Central Suite

Version 6
Document Part Number: 4704277-001

Document Revision: A
The information in this document is subject to change without notice and should not be construed as a commitment
by Kronos Incorporated. Kronos Incorporated assumes no responsibility for any errors that may appear in this
manual. This document or any part thereof may not be reproduced in any form without the written permission of
Kronos Incorporated. All rights reserved. Copyright 2009.
Altitude, Altitude Dream, 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, ShiftLogic, ShopTrac, ShopTrac
Pro, StarComm, StarPort, StarSaver, StarTimer, TeleTime, Timekeeper, Timekeeper Central, TimeMaker, Unicru,
Visionware, Workforce Accruals, Workforce Central, Workforce Decisions, Workforce Express, Workforce Genie,
and Workforce TeleTime are registered trademarks of Kronos Incorporated or a related company. Altitude MPP,
Altitude MPPXpress, Altitude Pairing, Altitude PBS, Comm.Mgr, CommLink, DKC/Datalink, eDiagnostics, Experts at
Improving the Performance of People and Business, FasTrack, Hireport, HR and Payroll Answerforce, HyperFind,
Kronos 4500 Touch ID, Kronos 4500, Kronos 4510, Kronos Acquisition, Kronos e-Central, Kronos KnowledgePass,
Kronos TechKnowledgy, KronosWorks, KVC OnDemand, Labor Plus, Momentum Essentials, Momentum Online,
Momentum, MPPXpress, Overall Labor Effectiveness, Schedule Assistant, Smart Scheduler, Smart View, Start
Quality, Start WIP, Starter Series, StartLabor, Timekeeper Decisions, Timekeeper Web, VisionPlus, Winstar Elite,
WIP Plus, Workforce Acquisition, Workforce Activities, Workforce Analytics, Workforce Attendance, Workforce
Central Portal, Workforce Connect, Workforce Employee, Workforce Forecast Manager, Workforce HR, Workforce
Leave, Workforce Manager, Workforce MobileTime, Workforce Operations Planner, Workforce Payroll, Workforce
Record Manager, Workforce Recruiter, Workforce Scheduler, Workforce Smart Scheduler, Workforce Tax Filing,
Workforce Timekeeper, Workforce View, and Workforce Worksheet are trademarks of Kronos Incorporated or a
related company.
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://
www.openssl.org). This product includes software written by Eric Young (eay@cryptsoft.com).
Mozilla.org is a registered trademark of the Mozilla Foundation. All other trademarks or registered trademarks used
herein are the property of their respective owners and are used for identification purposes only.
When using and applying the information generated by Kronos products, customers should ensure that they comply
with the applicable requirements of federal and state law, such as the Fair Labor Standards Act. Nothing in this
Guide shall be construed as an assurance or guaranty that Kronos products comply with any such laws.
Published by Kronos Incorporated

297 Billerica Road, Chelmsford, Massachusetts 01824-4119 USA
Phone: 978-250-9800, Fax: 978-367-5900
Kronos Incorporated Global Support: 1-800-394-HELP (1-800-394-4357)
For links to information about international subsidiaries of Kronos Incorporated, go to

http://www.kronos.com
Document Revision History
Document Revision Product Version Release Date

A Workforce Central 6.1 January 2009
Contents
About This Guide

Organization of this guide ........................................................................... 24
Abbreviations and terms .............................................................................. 25
Workforce Timekeeper documentation ........ .............................................. 26
Chapter 1: Introduction
Using the tag descriptions ........................................................................... 28
Chapter 2: Workforce Timekeeper XML API Tag Definitions

AccessAssignment Tag ............................................................................... 36
AccessProfile Tag ........................................................................................ 46
AccrualAmountAuditItem Tag .................................................................... 52
AccrualBalanceSummary Tag ..................................................................... 55
AccrualCode Tag ......................................................................................... 62
AccrualData Tag .......................................................................................... 65
AccrualMove Tag ........................................................................................ 67
AccrualPatternElement Tag ......................................................................... 71
AccrualProfile Tag ...................................................................................... 72
AdHocLaborAccount Tag ........................................................................... 75
AdjustmentAllocation Tag .......................................................................... 77
AdjustmentRule Tag .................................................................................... 85
AdjustmentRuleVersion Tag ....................................................................... 90
AdjustmentTrigger Tag ............................................................................... 94
AdjustmentTriggerForRule Tag ................................................................ 103
Allocation Tag ........................................................................................... 107
APICallList Tag ......................................................................................... 109
APIHolidayProfile Tag .............................................................................. 111
APIHolidayProfileData Tag ...................................................................... 115
APIHolidayProfileDataEntry Tag ............................................................. 118
Contents
APIHolidayProfileDataSet Tag ..................................................................121

APIOutsideDate Tag ..................................................................................123
APIPSEEngine Tag ....................................................................................124
APIPunchRestrictionOverride Tag ............................................................126
APISCGEngine Tag ...................................................................................132
APIStableDateSpans Tag ...........................................................................134
APIVolumeDataService Tag ......................................................................136
AppendShifts Tag ......................................................................................138
ApplicationCalendar Tag ...........................................................................140
ApplicationCalendarAPIFacade Tag .........................................................142
Approval Tag .............................................................................................143
Approver Tag .............................................................................................144
ApproveSignoff Tag ..................................................................................146
AssignmentDetail Tag ................................................................................151
AssignmentDispatchEngine Tag ................................................................155
AssignmentEmployee Tag .........................................................................158
Attribute Tag ..............................................................................................160
AuditItem Tag ............................................................................................162
AuditTrail Tag ............................................................................................167
AuthenticationType Tag ............................................................................170
BadgeAssignment Tag ...............................................................................172
BaseWageRate Tag ....................................................................................176
Bid Tag .......................................................................................................179
BidGroup Tag ............................................................................................183
BidGroupItem Tag .....................................................................................189
BidNote Tag ...............................................................................................195
BidRequest Tag ..........................................................................................197
BulkAccruals Tag ......................................................................................207
BulkTotals Tag ...........................................................................................210
C Tag ..........................................................................................................213
CalendarProfile Tag ...................................................................................214
CalendarProfileAPIFacade Tag .................................................................219
CallListEmployee Tag ...............................................................................221
CallListOpenShift Tag ...............................................................................222
4 Kronos Incorporated
Contents
CancelDeductions Tag ............................................................................... 223

CascadeAccrualBalanceLimit Tag ............................................................ 226
CascadeProfile Tag .................................................................................... 228
CascadeProfileRule Tag ............................................................................ 232
CascadeRule Tag ....................................................................................... 233
CascadeRuleNode Tag .............................................................................. 238
CascadeTakingNode Tag ........................................................................... 239
CertificationItem Tag ................................................................................ 242
CheckAdvice Tag ...................................................................................... 244
CheckAdviceDetailDeductions Tag .......................................................... 250
CheckAdviceDetailDirectDeposit Tag ...................................................... 252
CheckAdviceDetailGrossPay Tag ............................................................. 254
CheckAdviceDetailTaxes Tag ................................................................... 257
Comment Tag ............................................................................................ 259
ConnectToSchedule Tag ........................................................................... 262
ConnectToScheduleItem Tag .................................................................... 264
CoverageDetail Tag ................................................................................... 268
CoverageSettings Tag ................................................................................ 269
CoverageSettingsValue Tag ...................................................................... 275
CoverShiftStatus Tag ................................................................................. 277
CurrencyAssignment Tag .......................................................................... 279
CurrencyPolicy Tag ................................................................................... 281
CurrentUser Tag ........................................................................................ 286
CustomData Tag ........................................................................................ 290
CustomDate Tag ........................................................................................ 292
CustomOperator Tag ................................................................................. 294
CustomParameter Tag ............................................................................... 296
DailyEmployeeFirstShiftTime Tag ........................................................... 298
DailyEmployeeTimeAttendance Tag ........................................................ 300
DataAccessGroup Tag ............................................................................... 304
DataElementAPIFacade Tag ..................................................................... 311
DataSetAPIFacade Tag ............................................................................. 313
DataSource Tag ......................................................................................... 315
DateTotals Tag .......................................................................................... 317
Developers Toolkit Reference Guide 5

Contents
DayLockAuditItem Tag .............................................................................319

DeductRule Tag .........................................................................................322
DelegateAuthorityTask Tag .......................................................................324
DelegateProfile Tag ...................................................................................328
DeviceGroup Tag .......................................................................................334
EarnedAccrual Tag ....................................................................................337
EffectiveLaborStandardVersion Tag .........................................................341
EffectiveWorkload Tag ..............................................................................343
EffTokeRule Tag ........................................................................................347
EffTokeRuleLaborAccount Tag ................................................................351
EffTokeRulePayCode Tag .........................................................................352
EligibleJobs Tag .........................................................................................353
EmailAddress Tag ......................................................................................356
EmployeeAdjustmentRuleAssignment Tag ...............................................358
EmployeeCurrencyAssignment Tag ..........................................................365
EmployeeFirstShiftTimeDetail Tag ...........................................................367
EmployeeGroupAssign Tag .......................................................................369
EmployeeGroupItem Tag ...........................................................................372
EmployeeGroupProfile Tag .......................................................................375
EmployeeHolidayDetail Tag ......................................................................378
EmployeeMessage Tag ..............................................................................380
EmployeeOpenShiftRequestItem Tag ........................................................384
EmployeePreferredZone Tag .....................................................................387
EmployeeReportDataProfile Tag ...............................................................390
EmployeeRequestMgmt Tag ......................................................................393
EmployeeSummary Tag .............................................................................399
EmployeeTimeDetail Tag ..........................................................................401
EmployeeTimeOffHoursRequestItem Tag ................................................403
EmployeeTimeOffRequestItem Tag ..........................................................406
EmployeeTipRuleAssignment Tag ............................................................409
EmployeeTokeRuleAssignment Tag .........................................................416
EmploymentStatus Tag ..............................................................................420
EmploymentTerm Tag ...............................................................................424
EmploymentTermAssignment Tag ............................................................429
Contents
EmploymentTermVersion Tag .................................................................. 432

Error Tag ................................................................................................... 435
ExchangeRate Tag ..................................................................................... 439
ExpectedHours Tag ................................................................................... 441
FailedXMLTransaction Tag ...................................................................... 443
Formula Tag .............................................................................................. 450
FPAAllocation Tag .................................................................................... 454
FPARule Tag ............................................................................................. 457
FPARuleVersion Tag ................................................................................ 462
FPATrigger Tag ......................................................................................... 466
From Tag ................................................................................................... 474
FunctionAccessProfile Tag ....................................................................... 476
GDAPAssignment Tag .............................................................................. 479
GDAPAssignmentDefaultSwitch Tag ....................................................... 485
GDAPItem Tag .......................................................................................... 487
GenericEmployeeCalendar Tag ................................................................. 489
GenericEmployeeCalendarAPIFacade Tag ............................................... 495
GenericManagerCalendar Tag ................................................................... 497
GenericManagerCalendarAPIFacade Tag ................................................. 504
GenericNotification Tag ............................................................................ 506
GenericNotificationTrigger Tag ................................................................ 512
GenieColumn Tag ..................................................................................... 515
GenieRow Tag ........................................................................................... 517
GlsegmentDetail Tag ................................................................................. 519
GroupMembership Tag ............................................................................. 522
Headcount Tag ........................................................................................... 524
HeadcountPattern Tag ............................................................................... 526
HistoricalPayCodeEdit Tag ....................................................................... 528
HistoricalPayCodeMove Tag .................................................................... 536
HistoryDetails Tag ..................................................................................... 545
Holiday Tag ............................................................................................... 546
HolidayDetailData Tag .............................................................................. 548
HolidayEditHours Tag ............................................................................... 550
HolidayEditWages Tag ............................................................................. 553

Contents
HomeAccount Tag .....................................................................................556

HoursCategory Tag ....................................................................................558
HoursCategoryComponent Tag .................................................................564
HoursCategoryJob Tag ..............................................................................565
HoursCategoryPayCode Tag ......................................................................567
HoursCategorySet Tag ...............................................................................569
HoursSummary Tag ...................................................................................574
HoursSummaryService Tag .......................................................................576
HPPDItem Tag ...........................................................................................578
HPPDService Tag ......................................................................................581
HPPDSummary Tag ...................................................................................584
HPPDSummaryService Tag .......................................................................587
HyperFindProfile Tag ................................................................................589
HyperFindQuery Tag .................................................................................595
HyperFindResult Tag .................................................................................599
ImportBatchStatus Tag ..............................................................................602
Indicator Tag ..............................................................................................608
IndicatorOperation Tag ..............................................................................613
JobAssignment Tag ....................................................................................616
JobAssignmentDetails Tag ........................................................................621
JobGroup Tag .............................................................................................626
Kronos_WFC Tag ......................................................................................631
KTimeZone Tag .........................................................................................633
KTimeZoneRule Tag .................................................................................638
LaborAccount Tag .....................................................................................643
LaborAccountEntry Tag ............................................................................646
LaborAccountEntryData Tag .....................................................................649
LaborAccountSet Tag ................................................................................651
LaborAccountSetProfile Tag .....................................................................657
LaborLevelDefinition Tag .........................................................................660
LaborLevelEntry Tag .................................................................................663
LaunchHistory Tag ....................................................................................669
LicenseType Tag ........................................................................................674
LightWeightPerson Tag .............................................................................678
Contents
LightWeightQuery Tag ............................................................................. 680

LocationId Tag .......................................................................................... 682
LocationProfileSettings Tag ...................................................................... 683
LockedDataCorrection Tag ....................................................................... 689
LogonProfile Tag ....................................................................................... 691
ManagerRoleAvailabilityPatternProfile Tag ............................................. 694
ManagerRoleScheduleGroupProfile Tag .................................................. 697
ManagerRoleSchedulePatternProfile Tag ................................................. 700
ManagerRoleShiftCodeProfile Tag ........................................................... 703
MarkForTotalization Tag .......................................................................... 706
MarkPostedAuditItem Tag ........................................................................ 709
Menu Tag ................................................................................................... 712
MenuItem Tag ........................................................................................... 714
MetricsSettings Tag ................................................................................... 717
MinimunHoursNoModification Tag ......................................................... 722
NameList Tag ............................................................................................ 725
Names Tag ................................................................................................. 727
NameValuePair Tag .................................................................................. 728
NavProfile Tag .......................................................................................... 729
NonCancellingPayCodeEdit Tag ............................................................... 734
Note Tag .................................................................................................... 742
OnCall Tag ................................................................................................ 744
OpenShift Tag ........................................................................................... 746
OpenShiftItem Tag .................................................................................... 747
OpenShiftRequestItem Tag ....................................................................... 748
OpenShiftVolunteer Tag ........................................................................... 752
OptOutStatus Tag ...................................................................................... 757
OptOutStatusList Tag ................................................................................ 759
OrgDirect_IndirectPct Tag ........................................................................ 761
OrgJob Tag ................................................................................................ 762
OrgLocation Tag ....................................................................................... 764
OrgLocationsImport Tag ........................................................................... 769
OrgMapIntegration Tag ............................................................................. 771
OrgNode Tag ............................................................................................. 773

Contents
OrgSet Tag .................................................................................................776

OrgSetEntry Tag ........................................................................................781
OrgSetJob Tag ............................................................................................783
OrgWorkAllocationEntry Tag ...................................................................785
OverCoverageSpan Tag .............................................................................787
OvertimeApproval Tag ..............................................................................790
PasswordHistory Tag .................................................................................795
PatternElement Tag ....................................................................................797
PayCode Tag ..............................................................................................801
PayCodeAuditItem Tag ..............................................................................805
PayCodeEdit Tag .......................................................................................809
PayCodeMove Tag .....................................................................................820
PayCodeProfile Tag ...................................................................................828
PayFromSchedule Tag ...............................................................................831
PayFromScheduleStopEvent Tag ..............................................................834
PayRuleProfile Tag ....................................................................................837
PeriodTotals Tag ........................................................................................840
Permission Tag ...........................................................................................842
Person Tag ..................................................................................................844
PersonAccessAssignment Tag ...................................................................853
Personality Tag ..........................................................................................857
PersonalOvertimeAssignment Tag ............................................................862
PersonalOvertimeLimit Tag .......................................................................866
PersonalOvertimeRule Tag ........................................................................868
PersonAuthenticationType Tag ..................................................................870
PersonCascadeProfileAssignment Tag ......................................................872
PersonCertificationAssign Tag ..................................................................875
PersonCertificationItem Tag ......................................................................878
PersonIdentity Tag .....................................................................................881
PersonInformation Tag ..............................................................................887
PersonLicenseType Tag .............................................................................896
PersonShiftTemplateAssignment Tag ........................................................898
PersonSkillAssign Tag ...............................................................................900
PersonSkillItem Tag ...................................................................................903
Contents
PostalAddress Tag ..................................................................................... 905

PreferenceProfile Tag ................................................................................ 908
PrimaryLaborAccount Tag ........................................................................ 911
Procedure Tag ............................................................................................ 916
ProcedureAction Tag ................................................................................. 921
ProcedureContext Tag ............................................................................... 923
ProcedureParameter Tag ........................................................................... 925
ProcedureParameterDefinition Tag ........................................................... 927
ProcedureSet Tag ....................................................................................... 929
ProcedureSetItem Tag ............................................................................... 935
Process Tag ................................................................................................ 937
ProcessorToEmployee Tag ........................................................................ 945
ProcessProfile Tag ..................................................................................... 951
ProcessSchedule Tag ................................................................................. 954
ProcessTask Tag ........................................................................................ 958
ProcessTemplate Tag ................................................................................. 966
ProjectingOvertime Tag ............................................................................ 991
Punch Tag .................................................................................................. 993
PunchStatus Tag ...................................................................................... 1005
RBSRule Tag ........................................................................................... 1008
RBSRuleVersion Tag .............................................................................. 1012
ReportDataProfileAssignment Tag ......................................................... 1017
ReportDataProfileAssignmentList Tag ................................................... 1019
ReportProfile Tag .................................................................................... 1021
Request Tag ............................................................................................. 1024
RequestFor Tag ....................................................................................... 1028
RequestId Tag .......................................................................................... 1030
RequestItems Tag .................................................................................... 1031
RequestMgmt Tag ................................................................................... 1034
RequestOvertimeApproval Tag ............................................................... 1041
RequestOvertimeStatus Tag .................................................................... 1044
RequestParamDef Tag ............................................................................. 1048
RequestParamValue Tag ......................................................................... 1050
RequestStatusChange Tag ....................................................................... 1052

Contents
RequestSubtype Tag ................................................................................1055

RequestToCover Tag ...............................................................................1060
RequestToCoverItem Tag ........................................................................1066
ResetAccrual Tag .....................................................................................1068
Response Tag ...........................................................................................1074
RoleProfileKBO Tag ................................................................................1076
RollupIndicatorElement Tag ....................................................................1081
RollupStrategyTotal Tag ..........................................................................1083
RuleSetEmployeeAssign Tag ..................................................................1085
RuleVersion Tag ......................................................................................1088
SchedGenSettings Tag .............................................................................1091
SchedGenSettingsValue Tag ....................................................................1097
SchedRule Tag .........................................................................................1099
SchedRuleContext Tag ............................................................................1106
SchedRuleOperator Tag ...........................................................................1108
SchedRuleSet Tag ....................................................................................1110
SchedRuleSortOrder Tag .........................................................................1116
SchedRuleTopic Tag ................................................................................1118
SchedRuleValueType Tag .......................................................................1120
Schedule Tag ............................................................................................1122
ScheduleAccrualAmountEdit Tag ...........................................................1137
ScheduleAccrualPattern Tag ....................................................................1141
ScheduleAuditItems Tag ..........................................................................1147
ScheduleCostPaycode Tag .......................................................................1150
ScheduleCostResult Tag ..........................................................................1152
ScheduleCostSummary Tag .....................................................................1154
ScheduleCoverage Tag ............................................................................1156
ScheduleGroup Tag ..................................................................................1159
ScheduleGroupProfile Tag .......................................................................1164
ScheduleHours Tag ..................................................................................1167
ScheduleHoursAccrualViolation Tag ......................................................1173
ScheduleHoursDailyStatus Tag ...............................................................1174
ScheduleHoursException Tag ..................................................................1176
ScheduleHoursStatus Tag ........................................................................1177
Contents
ScheduleMarkPosted Tag ........................................................................ 1180

ScheduleMetrics Tag ............................................................................... 1182
ScheduleMetricsItem Tag ........................................................................ 1185
ScheduleOff Tag ...................................................................................... 1187
SchedulePattern Tag ................................................................................ 1192
SchedulePayCodeEdit Tag ...................................................................... 1199
SchedulePeriod Tag ................................................................................. 1207
ScheduleRuleOverride Tag ..................................................................... 1211
ScheduleRuleOverrideDetails Tag .......................................................... 1217
ScheduleShift Tag ................................................................................... 1219
ScheduleShiftSwap Tag ........................................................................... 1225
ScheduleUnavailable Tag ........................................................................ 1227
ScheduleZone Tag ................................................................................... 1233
SchedulingAudit Tag ............................................................................... 1236
SegmentDetails Tag ................................................................................. 1239
SegmentType Tag .................................................................................... 1244
SequencedBreak Tag ............................................................................... 1246
ServerTime Tag ....................................................................................... 1247
SettingIndicator Tag ................................................................................ 1249
SettingsParamDefinition Tag .................................................................. 1251
SettingsParamValue Tag ......................................................................... 1254
SettingStrategy Tag ................................................................................. 1256
SettingsType Tag ..................................................................................... 1258
ShiftAuditItem Tag .................................................................................. 1261
ShiftBuilder Tag ...................................................................................... 1266
ShiftCode Tag .......................................................................................... 1269
ShiftCountSpan Tag ................................................................................ 1273
ShiftHistory Tag ...................................................................................... 1275
ShiftSegment Tag .................................................................................... 1279
ShiftStartTimeBand Tag .......................................................................... 1284
ShiftTemplateAssignment Tag ................................................................ 1288
ShiftTemplateItem Tag ............................................................................ 1290
ShiftValidation Tag ................................................................................. 1292
Signature Tag ........................................................................................... 1295

Contents
SignatureItem Tag ....................................................................................1299

SimplePair Tag .........................................................................................1301
SimpleValue Tag ......................................................................................1303
StaffingRequirement Tag .........................................................................1304
StandardShift Tag ....................................................................................1305
Strategy Tag .............................................................................................1307
SuiteProduct Tag ......................................................................................1310
Supervisor Tag .........................................................................................1313
SwapShiftEmployees Tag ........................................................................1314
SwapShiftJobs Tag ...................................................................................1317
SwitchRoleEngine Tag ............................................................................1320
SystemSettings Tag ..................................................................................1323
TelephoneNumber Tag ............................................................................1325
TermDurationPaycode Tag ......................................................................1327
TimeEntry Tag .........................................................................................1329
TimeFramePeriod Tag .............................................................................1332
TimekeepingException Tag .....................................................................1335
TimeOffHoursRequestItem Tag ..............................................................1339
TimeOffRequestItem Tag ........................................................................1343
TimeOffRule Tag .....................................................................................1347
Timesheet Tag ..........................................................................................1354
TipRule Tag .............................................................................................1360
TipRuleVersion Tag .................................................................................1365
TipTrigger Tag .........................................................................................1368
To Tag ......................................................................................................1376
TokeRule Tag ...........................................................................................1378
TopicParameterDefinition Tag ................................................................1382
TopicParameterValue Tag .......................................................................1384
Total Tag ..................................................................................................1386
TotalBreakException Tag ........................................................................1390
TotaledScheduledPayCodeEdit Tag ........................................................1394
TotaledScheduledPayCodeEditUneditable Tag .......................................1397
TotaledScheduledWorkedDuration Tag ..................................................1401
TotaledSpan Tag ......................................................................................1404
Contents
TotalSummary Tag .................................................................................. 1406

Transaction Tag ....................................................................................... 1407
TransferEmployee Tag ............................................................................ 1408
TransferJobSeniorityDate Tag ................................................................. 1411
TreeNodeType Tag .................................................................................. 1414
Trigger Tag .............................................................................................. 1419
TrxDataException Tag ............................................................................ 1423
TypeOverride Tag ................................................................................... 1426
UnderCoverageSpan Tag ......................................................................... 1428
User Tag .................................................................................................. 1431
UserAccount Tag ..................................................................................... 1434
UserAccountLockout Tag ....................................................................... 1438
UserAccountStatus Tag ........................................................................... 1440
UserCurrencyAssignment Tag ................................................................ 1444
VacationBid Tag ...................................................................................... 1446
VolumeDataItem Tag .............................................................................. 1453
WageProfile Tag ...................................................................................... 1454
WeekDay Tag .......................................................................................... 1457
WFCGenie Tag ........................................................................................ 1459
WfcJob Tag ............................................................................................. 1463
WorkedDuration Tag ............................................................................... 1468
WorkerType Tag ..................................................................................... 1477
WorkerTypeElement Tag ........................................................................ 1481
WorkflowAccessAssignment Tag ........................................................... 1483
WorkflowTemplateCategory Tag ............................................................ 1487
WorkHourDef Tag ................................................................................... 1490
WorkloadAuditItem Tag ......................................................................... 1492
WorkRule Tag ......................................................................................... 1496
WorkRuleProfile Tag .............................................................................. 1498
WorkWeek Tag ....................................................................................... 1501
WorkWeekAssignments Tag ................................................................... 1507
WorkWeekDay Tag ................................................................................. 1510
WSAAccrualCode Tag ............................................................................ 1514
WSAAccrualDetail Tag ........................................................................... 1516

Contents
WSAAccrualDetailColumnSet Tag .........................................................1521

WSAAccrualPolicy Tag ...........................................................................1525
WSAAccrualPolicyGrant Tag ..................................................................1534
WSAAccrualPolicyLimit Tag ..................................................................1536
WSAAccrualPolicyPayCode Tag ............................................................1538
WSAAccrualPolicyTakingLimit Tag ......................................................1539
WSAAccrualProfile Tag ..........................................................................1541
WSAAccrualProfilePolicy Tag ................................................................1545
WSAAccrualQualifier Tag ......................................................................1547
WSAAPICombination Tag ......................................................................1550
WSAAPICombinationComponent Tag ....................................................1553
WSAAPICombinationRule Tag ...............................................................1556
WSAAPICombinationTowardOT Tag ....................................................1560
WSAAssignmentRule Tag .......................................................................1563
WSAAutoBreakPlacement Tag ...............................................................1568
WSAAvailabilityPatternDAP Tag ...........................................................1571
WSAAvailabilityPatternProfileItem Tag .................................................1574
WSAAveragingDetail Tag .......................................................................1576
WSAAveragingDetailColumnSet Tag .....................................................1581
WSABonusDeductRule Tag ....................................................................1585
WSABreakRule Tag ................................................................................1599
WSABreakTime Tag ................................................................................1606
WSACalendarProfile Tag ........................................................................1609
WSACallInRule Tag ................................................................................1611
WSACfgAccrualCode Tag ......................................................................1618
WSACfgContactType Tag .......................................................................1622
WSACfgContactTypeList Tag .................................................................1625
WSACfgCustomData Tag ........................................................................1628
WSACfgCustomDataList Tag .................................................................1630
WSACFGDistributionAssignment Tag ...................................................1633
WSACFGExtProcessorComponent Tag ..................................................1636
WSACFGOvertimeComponent Tag ........................................................1638
WSACFGPaycodeAssignment Tag .........................................................1640
WSACFGPaycodeDistribution Tag .........................................................1642
Contents
WSACFGZoneComponent Tag .............................................................. 1645

WSAColumnDefinition Tag .................................................................... 1647
WSAColumnDefinitionDataType Tag .................................................... 1650
WSAColumnDetail Tag .......................................................................... 1653
WSACombinationRule Tag ..................................................................... 1659
WSACombinedPayCodeRule Tag .......................................................... 1661
WSAComment Tag ................................................................................. 1665
WSACommentType Tag ......................................................................... 1669
WSAContributingPayCodeRule Tag ....................................................... 1671
WSAContributingShiftRule Tag ............................................................. 1674
WSACoreHoursRule Tag ........................................................................ 1678
WSACreditCalculator Tag ...................................................................... 1684
WSACriteriaSet Tag ................................................................................ 1691
WSACustomDate Tag ............................................................................. 1694
WSACustomDateType Tag ..................................................................... 1697
WSACustomUrl Tag ............................................................................... 1699
WSACustomUrlProfile Tag .................................................................... 1702
WSADateFinder Tag ............................................................................... 1706
WSADatePattern Tag .............................................................................. 1709
WSADayMonthSpan Tag ........................................................................ 1713
WSADaysOfWeek Tag ........................................................................... 1716
WSADetail Tag ....................................................................................... 1719
WSADetailColumnSet Tag ..................................................................... 1723
WSADisplayOrder Tag ........................................................................... 1727
WSADisplayProfile Tag .......................................................................... 1730
WSADisplayProfileWorkforceGenieProfile Tag .................................... 1743
WSADispOrdOptionalRule Tag .............................................................. 1745
WSADPLaborLevelDefinition Tag ......................................................... 1747
WSADPPayCode Tag ............................................................................. 1749
WSADPTimePeriod Tag ......................................................................... 1751
WSAEffectivePayRule Tag ..................................................................... 1753
WSAEffectiveWorkRule Tag .................................................................. 1760
WSAEligibilityDeterminer Tag ............................................................... 1765
WSAExceptionRule Tag ......................................................................... 1769

Contents
WSAExceptionType Tag .........................................................................1776

WSAFixedRule Tag .................................................................................1778
WSAFunctionAccessProfile Tag .............................................................1781
WSAGenie Tag ........................................................................................1785
WSAGrant Tag ........................................................................................1788
WSAHoliday Tag .....................................................................................1794
WSAHolidayCreditRule Tag ...................................................................1798
WSAHolidayDate Tag .............................................................................1802
WSAHyperfindQuery Tag .......................................................................1804
WSAInitialGrant Tag ...............................................................................1807
WSAInterval Tag .....................................................................................1809
WSAIntervalRoundRule Tag ...................................................................1811
WSAIsrProfile Tag ..................................................................................1814
WSALaborLevel Tag ...............................................................................1822
WSALaborLevelEntry Tag ......................................................................1826
WSALeaveCaseDetail Tag ......................................................................1829
WSALeaveCaseDetailColumnSet Tag ....................................................1833
WSALimit Tag .........................................................................................1837
WSALimitAlert Tag ................................................................................1842
WSALogonProfile Tag ............................................................................1844
WSAMainTab Tag ...................................................................................1853
WSAMajorityRule Tag ............................................................................1855
WSANavbarCategory Tag .......................................................................1859
WSAOptionalRule Tag ............................................................................1861
WSAOrganizationType Tag ....................................................................1863
WSAOverridePayCode Tag .....................................................................1867
WSAOvertimeAllocation Tag ..................................................................1869
WSAOvertimeCombination Tag ..............................................................1875
WSAOvertimeRule Tag ...........................................................................1878
WSAPatternTemplateDAP Tag ...............................................................1888
WSAPatternTemplateProfileItem Tag .....................................................1891
WSAPayCode Tag ...................................................................................1893
WSAPayCodeDAP Tag ...........................................................................1901
WSAPayCodeDistribution Tag ................................................................1904
Contents
WSAPayCodeProfileItem Tag ................................................................ 1908

WSAPayDistributionAssociation Tag ..................................................... 1910
WSAPayPeriod Tag ................................................................................. 1913
WSAPayRule Tag ................................................................................... 1916
WSAPayRuleHoliday Tag ....................................................................... 1919
WSAPermission Tag ............................................................................... 1921
WSAProbationPeriod Tag ....................................................................... 1924
WSAProbationQualifier Tag ................................................................... 1928
WSAProcessingOrderRule Tag ............................................................... 1931
WSAPunchRoundRule Tag ..................................................................... 1934
WSAQuickFind Tag ................................................................................ 1948
WSAReportDAP Tag .............................................................................. 1952
WSAReportProfileItem Tag .................................................................... 1955
WSARollup Tag ...................................................................................... 1957
WSARollupColumnSet Tag .................................................................... 1961
WSAScheduleAssistant Tag .................................................................... 1965
WSAScheduleAssistantColumnSet Tag .................................................. 1969
WSAScheduleAssistantTab Tag ............................................................. 1973
WSAScheduleDeviationRule Tag ........................................................... 1975
WSAScheduledHoursType Tag .............................................................. 1978
WSAScheduleEditor Tag ........................................................................ 1981
WSAScheduleEditorColumnSet Tag ...................................................... 1988
WSAScheduleGroupDAP Tag ................................................................ 1992
WSAScheduleGroupDetail Tag .............................................................. 1995
WSAScheduleGroupDetailColumnSet Tag ............................................ 2000
WSAScheduleGroupProfileItem Tag ...................................................... 2004
WSAScheduleGroupRollup Tag ............................................................. 2006
WSAScheduleGroupRollupColumnSet Tag ........................................... 2011
WSASchedulePeriod Tag ........................................................................ 2015
WSASchedulePlanner Tag ...................................................................... 2017
WSASchedulePlannerColumnSet Tag .................................................... 2025
WSASequencedItem Tag ........................................................................ 2029
WSASequencerRule Tag ......................................................................... 2031
WSAShiftGuarantee Tag ......................................................................... 2034

Contents
WSAShiftLength Tag ..............................................................................2039

WSAShiftLengthExclusion Tag ..............................................................2041
WSAShiftTemplateDAP Tag ...................................................................2042
WSAShiftTemplateProfileItem Tag ........................................................2045
WSASignOffRestriction Tag ...................................................................2046
WSASubsequentGrant Tag ......................................................................2050
WSATimePeriod Tag ...............................................................................2052
WSATkTerminalRule Tag .......................................................................2054
WSATreeType Tag ..................................................................................2063
WSAULLE Tag .......................................................................................2066
WSAWageAdjustment Tag ......................................................................2069
WSAWageProfile Tag .............................................................................2072
WSAWageProfileLaborLevelLinkage Tag ..............................................2076
WSAWageProfilePayCode Tag ...............................................................2078
WSAWfgColumnSet Tag ........................................................................2080
WSAWorkforceGenieProfile Tag ............................................................2082
WSAWorkHistoryQualifierRule Tag ......................................................2085
WSAWorkloadPlannerProfile Tag ..........................................................2088
WSAWorkRule Tag .................................................................................2090
WSAWorkRuleDAP Tag .........................................................................2093
WSAWorkRuleGeneral Tag ....................................................................2096
WSAWorkRulePCDistr Tag ....................................................................2099
WSAWorkRuleProfileItem Tag ...............................................................2102
WSAZone Tag .........................................................................................2104
WSAZoneCombinationRule Tag .............................................................2116
WSAZoneCombinationSpecificationRule Tag ........................................2119
WSAZoneCombinationZoneRule Tag .....................................................2121
WSAZoneRule Tag ..................................................................................2123
WSAZoneRuleHoliday Tag .....................................................................2126
WSAZoneRuleLimit Tag .........................................................................2128
WTDEmployeeAssignment Tag ..............................................................2130
WTDGlobal Tag ......................................................................................2135
WTDRule Tag ..........................................................................................2142
WTKEmployee Tag .................................................................................2154
Contents
Developers Toolkit Reference Guide 21dex

Contents
About This Guide
This reference guide defines and describes the Kronos XML API for Workforce
Timekeeper.
This preface contains the following sections:
• “Organization of this guide” on page 24
• “Abbreviations and terms” on page 25
• “Workforce Timekeeper documentation” on page 26
About This Guide
Organization of this guide

This reference guide contains the following information:
• Chapter 1, “Introduction,” on page 27 provides an overview on how to use the
reference information.
• Chapter 2, “Workforce Timekeeper XML API Tag Definitions,” on page 35
contains detailed information about each XML tag.
Users of this guide

This reference guide is for programmers, system integrators, and Web developers
who need to understand the Kronos XML interface.
Readers should have knowledge of the following software technologies:
• Tag-based markup languages such as HTML and XML.
• Data transfer protocols such as TCP/IP; HTTP and HTTPS; and SOAP.
• Request-response transactions and sessions.
• The Workforce Central user interface.
Abbreviations and terms
Abbreviations and terms

The following abbreviations and terms are used in this reference guide:
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

About This Guide
Workforce Timekeeper documentation

• Getting Started with Workforce Timekeeper—A Manager’s Guide for Power
Users summarizes the most common manager tasks, which include using
Workforce Genies, Timecards, Reports, and the People Editor.
• Getting Started with Workforce Timekeeper—A Guide for Managers
summarizes key product features for people who access employee time and
attendance information. The book also explains the various Workforce
Timekeeper components and the most common tasks that managers are likely
to perform with each component.
• Getting Started with Workforce Timekeeper—An Employee Guide for Power
Users explains some of the most common employee tasks, which include
using the Timecard and Time Stamp components, as well as viewing personal
schedules and reports.
• Getting Started with Workforce Timekeeper—A Guide for Employees explains
some of the most common employee tasks in Workforce Employee - HTML
Client, which includes using the Timecard, Time Stamp, and Quick Time
Stamp components, as well as viewing personal reports.
• Workforce Timekeeper Database Tables Reference Guide contains details
about the Workforce Central database tables.
• Workforce Timekeeper Database Views Reference Guide provides information
and details about Views and how they are used as virtual tables in Workforce
Central.
• Workforce Central System Administrator’s Guide—Timekeeping describes the
administrator’s activities, such as system configuration and setup, and
working with log reports, predefined data, and diagnostic tools.
• Workforce Timekeeper Table Format Import Programmer’s Guide provides
instructions and table data for Workforce Timekeeper Import tables.
• Workforce Central Process Manager Programmer’s Guide—Timekeeping and
Scheduling provides information on how to configure the Workforce
Timekeeper and Workforce Scheduler process templates.
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
Using the tag descriptions

The XML tags are described using standard formats and conventions, described in
this section.
XML tag name
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 functional area that a user must
have access to in order to use the XML tags within that functional area.
For example, for the Punch tag, the function access control point is API.Timecard.
This means that a user must have access to Timecard in order to use this tag.
To validate whether a user has 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. Click Function Access Profiles from the list on the left.
3. Click the function access profile associated with the user whose access rights
you are checking; for example, IS.
The Edit Function Access Profile window opens.
4. Expand the API and API Beans entries to see the function access control
points.
5. Find the function access control point you are interested in (for example,
Timecard) and verify that it is set to Allowed for the type of operation the user
needs to perform.
If it is set to Allowed, the user has access rights to all the tags in the reference
chapter of this document whose Function Access Control Point is specified as
API.Timecard; for example, the Punch tag.
Note: In the GUI, the function access control point name may reflect the
control point’s association with Java beans. Thus, the GUI may refer to
API.Timecard as Timecard Beans.
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
The syntax conventions are described in the following table.
Syntax Description Example

monospace Variable, which must be replaced CommentText = String
italic by a value in the XML code. where String tells you to add
comments here.
Brackets Optional elements [CommentText = String]
[ ] where [] mean that the
CommentText property is not
required in the tag.
Parenthesis Output only properties (AccrualCodeId = Long)
() identifies AccrualCodeId as a
property that is only used for
output.
Syntax Description Example

vertical pipe Mutually exclusive options "AddComment" |
| "AddOnly" | "Delete"
Choose one of these actions.
asterisk Array of zero or more occurrences <Comment>*
* An array of comments can be
specified.
plus sign Array of one or more occurrences
+
Parts of a syntax statement
The five optional parts of a syntax statement are:

• Request—An XML statement can be actionable or non-actionable. If it is
actionable, the statement is contained within a Request tag. If it is not
actionable, it must be used within an actionable tag.
• Actions—If the syntax statement contains actions, an Actions part identifies
all the actions supported by the XML tag.
• Parameters—If any actions use parameters, a Parameters part identifies them.
• Properties—The properties part of the syntax statement identifies all
properties that are available for a tag, including required and optional
properties.
• 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 action description includes the following information:

• The action name includes the technical name, or how the action is referenced
in code; and the non-technical name, or how the action is referenced in the
XML Import and Export Programmer Guides and the user interface.
• The description tells what the action does, including validation rules.

• The return value type identifies whether the action returns any data, and if so,
the data type of the returned value.
• The required properties identifies all properties that must be specified when
this action is used.
• The optional properties identifies the properties that can optionally be
specified for the action.
• The access control point name identifies the type of access available for the
tag.
• The Action Parameters table specifies the names and descriptions of all
parameters associated with an action. Not all actions have action parameters.
• The “introduced” version specifies the Workforce Central version number
when the action was introduced. If the action 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 action, check your
XML code to make sure it is up-to-date.
If the action 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.
Property 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.

Chapter 2
Workforce Timekeeper XML API Tag Definitions
This chapter lists the Timekeeping XML API tag descriptions 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: null
Introduced in v4; last changed in v5.2
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<AccessAssignment
[AvailabilityPatternName = String]
[TransferEmployeeFlag = Boolean]
[DelegateProfileName = String]
[PreferenceProfileName = String]
[ManagerAccessSetName = String]
[AccessProfileName = String]
[ProfessionalTransferSetName = String]
[ManagerTransferSetName = String]
[SchedulePatternName = String]
[ManagerPayCodeName = String]
[ManagerViewPayCodeName = String]
[ProfessionalPayCodeName = String]
[ReportName = String]
[GroupScheduleName = String]
[ShiftCodeName = String]
[TimeEntryTypeName = String]
[ProfessionalWorkRuleName = String]
[ManagerWorkRuleName = String] >
</AccessAssignment>
Property Descriptions
AccessProfileName
Function access profile
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.
The following predefined data values are available:
• &DEFAULT
• &OTHER_MANAGER
• &PAYROLL_MANAGER
• &IS
• &TIMESTAMP_EMPLOYEE
• &WORKFORCE_EMPLOYEE
Type: String
Optional
Maximum length: 50 characters
Default value: Specified in the Access Profile Editor in Timekeeping Setup
AvailabilityPatternName
Availability template profile
The name of the availability template profile that an individual can use when in a
manager's role. An availability template is a series of availability settings for a
recurring time period that a manager can assign to multiple employees and reuse
as needed. An availability template profile is a group of availability templates.
Type: String
Developers Toolkit Programmer’s Guide 37

Chapter 2
Optional
You can find values in the Timekeeping user interface.
Default value: The Empty Data Access Profile
Introduced in v5.0; last changed in v5.1
DelegateProfileName
Delegate profile name
Delegate Profile contains the list of people to whom the user with that profile may
delegate his/her authority.
Type: String
Optional
Sample values:
Empty Profile
Default value: &EMPTY

Introduced in v5.2
GroupScheduleName
Schedule group profile
Contains the name of a manager's schedule group profile. A schedule group is a
set of employees who work the same shifts, and the schedule group profile is a set
of schedule groups.
• &ALL_SCHEDULE_PATTERNS and &EMPTY_PROFILE for all schedules
• &ALL_GROUP_SCHEDULES and &EMPTY for all group schedules
Type: String
Optional
Dependency: Only specify for a person who has a manager's license

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.
• &ALL_LABOR_ACCOUNTS
• &EMPTY
Type: String
Optional
Must have a labor account set type of Employee Groups (Manager) or All Sets
(Both Manager and Transfer)
ManagerPayCodeName
Pay codes Edit 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 for
editing.
• &ALL_PAY_CODES
• &EMPTY
Type: String
Optional
Dependency: Only specify for a person who has a manager's license.

Chapter 2
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.
• &EMPTY
•
Type: String
Optional
Must be identified as a labor account set and have a Type of Employee Groups
(Manager) or All Sets (Both Manager and Transfer)
ManagerViewPayCodeName
Pay codes View 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 for
viewing.
• &ALL_PAY_CODES
• &EMPTY
Type: String
Optional
Introduced in v5.2
ManagerWorkRuleName
Work rule profile - manager
The name of the work rule profile that applies to an individual in a manager role.
A work rule profile is a set of rules that determines how employee hours accrue
(for example, details about how punches round, what types of overtime can be
earned, which pay codes hold what type of hours, and policies for meals and
breaks).
• &ALL_WORK_RULES
• &EMPTY
Type: String
Optional
PreferenceProfileName
Display profile
The name of the display profile for the person. The display profile identifies the
information that is displayed to a user; for example, which items appear on the
navigation bar, or how time is displayed in the interface.
Type: String
Optional
Default value: &DEFAULT_PREFERENCE
Enumerated value: &DEFAULT_PREFERENCE,
&SUPER_USER_PREFERENCE, Monday Manager, Tuesday Manager, Friday
Manager, Timekeeper, Scheduler, Professional Employees

Chapter 2
ProfessionalPayCodeName
Pay codes profile - employee
The name of the pay code profile that applies to an individual when in an
employee role. A pay code profile identifies those pay codes that the employee
can select.
• &ALL_PAY_CODES
• &EMPTY
Type: String
Optional
Dependency: Only specify for an employee who has a user account user.
ProfessionalTransferSetName
Labor level transfer set - employee
The name of the labor level transfer set that applies to an individual when in an he
name of the labor level transfer set that applies to an individual when in an
employee 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.
• &EMPTY
Type: String
Optional
Dependency: The specified person must have a Type of Employee Groups
(Manager) or All Sets (Both Manager and Transfer)
Dependency: Only specify for an employee who has a user account.
ProfessionalWorkRuleName
Work rule profile - employee
The name of the work rule profile that applies to an individual in an employee
role. A work rule profile is a set of rules that determines how employee hours
accrue (for example, details about how punches round, what types of overtime can
be earned, which pay codes hold what type of hours, and policies for meals and
breaks).
• &ALL_WORK_RULES
• &EMPTY
Type: String
Optional
Dependency: Only specify for an employee who has a user account user.
ReportName
Reports profile
Contains the name of the report profile that applies to an individual when in a
manager role. A reports profile defines which reports the manager can generate or
view.
• &ALL_REPORTS
• &EMPTY
Type: String
Optional
Dependency: Only specify for a person who has a manager license.

Chapter 2
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.
• &ALL_SCHEDULE_PATTERNS
• &EMPTY
Type: String
Optional
Dependency: Only specify for a person who has a manager license.
You can find values in Setup Application.
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.
• &ALL_SHIFT_CODES
• &EMPTY_PROFILE
Type: String
Optional
Dependency: Only specify for a person who has a manager license
Default value: The Empty Data Access Profile.

TimeEntryTypeName
Time entry method
Indicates the method that the person uses for entering time.
Specify one of the following numbers to represent the data value:
• 1 for Timestamp
• 2 for Timestamp and Hourly View
• 3 for Hourly View
• 4 for Project View
Type: String
Optional
Maximum length: 1 character
Enumerated value: 1, 2, 3, 4
TransferEmployeeFlag
Can see transferred employees
Indicates whether the user can view data for employees who have transferred into
work labor accounts that match the primary accounts to which the user has access.
TransferEmployeeFlag can have the following values:
• False, if the user cannot see employees who have transferred in
• True, if the user can see employees who have transferred in
Type: Boolean
Optional
Enumerated value: True, False
Introduced in v4

Chapter 2
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 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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"IsPermitted" |
"Load" |
"LoadAllAccessControlPointNames" |
"LoadAllActionNames" |
"LoadAllowedPermissions" |
"LoadAllSuiteProductNames"
Parameters→
IsPermitted→
AccessControlPointName = String
ActionName = String
[PersonNumber = String]
SuiteProductName = String
Chapter 2
Properties→
<AccessProfile
AccessProfileName = String
(Description = String) >
(<Permission>
<Permission>*
</Permission>)
(<SimpleValue>
<SimpleValue>*
</SimpleValue>)
</AccessProfile>
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
Chapter 2
Action Parameters
Parameter Name Description Additional information

AccessControlPointNam The name of the access control point. Introduced in v4
e Required
This name must be listed in the Access
Control Point table. Otherwise, the
system returns False.
ActionName The name of the action. Introduced in v4
Required
This name must be identified in the
names in the Permission Type table.
Otherwise, the system returns False.
PersonNumber The person number used to determine Introduced in v4
whose access profile to use.
Optional
The person number to check the
access against. It must be the access
profile of this person that the
permission is checked against.
Default value: The currently logged
on user.
SuiteProductName The suite product being checked. Introduced in v4
Required
This name must be listed in the Suite
Product table. Otherwise, the system
returns False.
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
Optional Properties: AccessProfileName
Chapter 2

LoadAllAccessControlPointNames
Returns all access control points.
Return Value Type: Zero or more SimpleValue tags
Introduced in v4
LoadAllActionNames
Returns all action names.
Introduced in v4
LoadAllowedPermissions
Returns all permissions allowed for the specified access profile.
Either the specified AccessProfileName or the default AccessProfile must exist.
Return Value Type: Zero or more Permission tags
Required Properties: None
Introduced in v4
LoadAllSuiteProductNames
Returns all suite product names.
Introduced in v4
Chapter 2
AccessProfileName
Access profile name
determines the components that users can access and the types of functions that
users can perform, 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 Setup. Refer to the System Administrator's Guide-
Timekeeping for an explanation of the roles.
• &OTHER_MANAGER
• &PAYROLL_MANAGER
• &IS
• &TIMESTAMP_EMPLOYEE
• &WORKFORCE_EMPLOYEE
• &DEFAULT
Type: String
Optional, Key
Default value: As specified in the Access Profile editor of the Setup
Description
Description
Describes the access profile.
Type: String
Output Only
Chapter 2
Introduced in v4
Permission
Permission
The permissions for the specified access profile are returned in this property. You
do not need to specify this property in the request.
Type: Zero or more Permission tags
Output only
Returned in the response only. Not part of the AccessProfile tag.
Introduced in v5.2
SimpleValue
Simple value
Information for this property is returned in the response; you do not specify this
property in the request.
Type: Zero or more SimpleValue tags
Output only
SimpleValue object is in the response. Not part of the request or the AccessProfile
bean
Introduced in v5.2
Chapter 2
AccrualAmountAuditItem Tag
Accrual Amount Audit Record
This tag contains accrual amount information for an audit.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<AccrualAmountAuditItem
(AccrualAmount = String)
(AccrualCode = String)
(Action = String)
(DataSource = String)
(EditDateTime = DateTime)
(EffectiveDate = Date)
(PersonNumber = String)
(User = String) >
</AccrualAmountAuditItem>
AccrualAmount
Accrual Amount
The accrual amount. Could be days, hours or money.
Type: String
Output only
Chapter 2
AccrualCode
Accrual Code
The accrual code
Type: String
Output only
Action
Action
The audited action
Type: String
Output only
Sample values:
CREATE, DELETE
Introduced in v6.1
DataSource
Data Source
The functional area
Type: String
Output only
Sample values:
SCHEDULING, EXTERNAL API

EditDateTime
Edit Date Time
The audit date time
Type: DateTime
Output only
Chapter 2

EffectiveDate
Effective Date
The accrual amount effective date
Type: Date
Output only
PersonNumber
Employee Number
The person number associated to this accrual amount
Type: String
Output only
User
User
The audited user
Type: String
Output only
Sample values:
SuperUser:pontus::10.129.62.89
Introduced in v6.1
Chapter 2
AccrualBalanceSummary Tag
Accrual Balance for a Person
The AccrualBalanceSummary tag returns data about an accrual balance for one
person.
Used by: AccrualData, EmployeeSummary
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<AccrualBalanceSummary
(AccrualCodeId = Long)
(AccrualCodeName = String)
(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)
(AccrualType = Long)
(EncumberedBalanceInCurrency = Currency)
(VestedBalanceInCurrency = Currency)
(EncumberedBalanceInTime = TimeDuration)
(VestedBalanceInTime = TimeDuration) >
</AccrualBalanceSummary>
Chapter 2
AccrualCodeId
Accrual code Id
A unique identifier for the accrual code.
Type: Long
Output Only
Introduced in v4
AccrualCodeName
Accrual code name
A named account containing the category in which time or money accrues, such
as sick, personal, or vacation.
Type: String
Output Only
Sample values:
Vacation, Sick

AccrualType
Type of accrual
The type identifier displayed for an accrual: 1 for hours, 2 for days, 3 for currency.
Type: Long
Output Only
Enumerated value: 1, 2, 3
Introduced in v4
EncumberedBalanceInCurrency
Vested balance, in currency
Amount of money vested, minus any future scheduled takings.
Type: Currency
Output Only
Chapter 2
Contains a value if the accrual is a monetary type

Introduced in v4
EncumberedBalanceInTime
Vested balance, in time
Amount of time vested, minus any future scheduled takings.
Type: TimeDuration
Output Only
Contains a value if the accrual is a time type
Introduced in v4
HoursPerDay
Hours per day
Number of hours in an accrual day.
Type: TimeDuration
Output Only
ProbationaryBalanceInCurrency
Probationary balance, in currency
Amount of money earned, but not taken because the employee is within the
probation period. 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
ProbationaryBalanceInTime
Probationary balance, in time
Amount of time earned, but not taken because the employee is within the
probation period. A probationary amount is one that cannot be taken or paid out.
Chapter 2
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: TimeDuration
Output Only
ProjectedBalanceInCurrency
Projected balance, in currency
The current balance minus all projected takings and plus all projected credits up
through the furthest projected taking date. This balance includes any scheduled
resets.
Type: Currency
Output Only
Contains a value if the accrual type is currency
Introduced in v4; last changed in v5.1; deprecated in v5.0
ProjectedBalanceInTime
Projected balance, in time
The current balance minus all projected takings and plus all projected credits up
through the furthest projected taking date. This balance includes any scheduled
resets.
Type: TimeDuration
Output Only
Contains a value if the accrual type represents a time
ProjectedDate
Projected date
The date used in determining the projected balance.
Type: Date
Output Only
Chapter 2

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
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
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
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
Chapter 2
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: TimeDuration
Output only
ProjectedTakingAmountInCurrency
Projected taking amount, in currency
The amount of money that the employee is scheduled to take between the selected
date and the furthest projected taking date.
Type: Currency
Output Only
ProjectedTakingAmountInTime
Projected taking amount, in time
The amount of time that the employee is scheduled to take between the selected
date and the furthest projected taking date.
Type: TimeDuration
Output Only
ProjectedVestedBalanceInCurrency
Projected vested balance, in currency
The current vested balance of money minus all projected takings and plus all
projected vested credits up through the furthest projected taking date. This
balance includes any scheduled resets.
Type: Currency
Output only
Chapter 2
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
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
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
Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadAllAccrualCodes"
Parameters→
None
Properties→
<AccrualCode
(Abbreviation = String)
(AccrualCodeName = String)
(DisplayType = String)
(HoursPerDay = TimeDuration) >
</AccrualCode>
Action Descriptions
LoadAllAccrualCodes
Returns information for all accrual codes
Return Value Type: Zero or more AccrualCode tags
AccrualCode Tag
Abbreviation
Abbreviation
The abbreviation of the accrual code, which can be up to three characters. This
abbreviation may appear on selected reports.
Type: String
Output Only
Introduced in v4
AccrualCodeName
Accrual code name
Name of an account that identifies a category of time or money that employees
earn.
Type: String
Output Only
Sample values:
Vacation, Sick

DisplayType
Display type
The type of accrual code, which can be money, hours, or days.
Type: String
Output Only
Enumerated value: Hours, Days, Currency
Introduced in v4
HoursPerDay
Number of hours in accrual day
The number of hours per day that constitutes a day of this accrual code. This value
is used to convert hours to days.

Chapter 2
Type: TimeDuration
Output Only
Contains no value when the DisplayType is Currency
Introduced in v4
Chapter 2
AccrualData Tag
Accrual Data for Employee
The AccrualData tag gets accrual balance information for the specified employee
on the specified date.
Used by: EmployeeSummary
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load"
Parameters→
None
Properties→
<AccrualData
BalanceDate = Date >
(<AccrualBalances>
<AccrualBalanceSummary>*
</AccrualBalances>)
<Employee>
</Employee>
</AccrualData>
Action Descriptions
Load
Returns one summary for each accrual code for the specified employee and date.
Chapter 2
Only returns one employee

Return Value Type: AccrualData tag
Required Properties: Employee, BalanceDate
Introduced in v4
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
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, Key
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 Key
Must uniquely identify an existing and active employee.
Introduced in v4
Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<AccrualMove
AmountInCurrency = Currency
AmountInDays = Double
AmountInTime = TimeDuration
GivingEmployeeAccrualCodeName = String
TakingEmployeeAccrualCodeName = String
Date = Date >
<GivingEmployee>
</GivingEmployee>
<TakingEmployee>
</TakingEmployee>
Chapter 2
</AccrualMove>
Action Descriptions
Update
Moves an accrual amount from one employee accrual code to another. The taking
employee's accrual profile must have an accrual policy governing the taking
accrual code.
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
AmountInCurrency
Amount of accrual, in currency
An accrual amount expressed as money.
Type: Currency
AmountInDays
Amount of accrual, in days
An accrual amount, expressed as days.
Type: Double
Introduced in v6.1
AmountInTime
Amount of accrual, in time
An accrual amount, expressed as time.
Chapter 2
Type: TimeDuration
The accrual amount that should be assigned to the employee if the accrual code is
an hour or daily accrual code.
Date
Effective date
The date when the accrual move takes effect.
Type: Date
Required
GivingEmployee
Employee who is giving
One employee, as specified in a PersonIdentity or CurrentUser tag, from whom
the accrual will be deducted.
Required Key
Must uniquely identify an existing and active employee
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
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.
Chapter 2
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.
Required Key
TakingEmployeeAccrualCodeName
Accrual code the accrual is moved to
Accrual code (such as sick or vacation) to which you want to move an accrued
amount.
Type: String
Required
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.
Groups of Mutually Exclusive Properties

Amount
The accrual code determines whether AmountInCurrency and AmountInTime
must be specified
Required
Group includes: AmountInCurrency, AmountInDays, AmountInTime
Chapter 2
AccrualPatternElement Tag
Accrual Pattern Element
The AccrualPatternElement tag represents a schedule day allocated to a specific
accrual code.
Used by: ScheduleAccrualPattern
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<AccrualPatternElement
DayNumber = Integer >
</AccrualPatternElement>
DayNumber
Day number in the pattern
Specifies the day of the pattern.
Type: Integer
Required
Must be greater than zero
Introduced in v4
Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAllAccrualProfiles" |
"LoadById"
Parameters→
None
Properties→
<AccrualProfile
[AccrualProfileName = String]
[AccrualProfileId = Integer] >
</AccrualProfile>
Action Descriptions
Load
Returns an accrual profile.
Name should be valid
Chapter 2
Return Value Type: AccrualProfile tag

Required Properties: AccrualProfileName
Introduced in v4
LoadAllAccrualProfiles
Returns all accrual profiles in the system.
Return Value Type: Zero or more AccrualProfile tags
Introduced in v4
LoadById
Returns an accrual profile, based on the specified AccrualProfileId.
Return Value Type: AccrualProfile tag
Required Properties: AccrualProfileID
Introduced in v4
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
Chapter 2
deducted from the balance. When an employee receives or earns time or money,
specified amounts are credited to the balances.
Type: String
Optional
You can find values in the Setup Application.
Sample values:
VAC and Sick Only
Introduced in v4
Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"CreateAdHoc"
Parameters→
None
Properties→
<AdHocLaborAccount
FieldDefinitionName = String
LaborAccountName = String >
</AdHocLaborAccount>
Action Descriptions
CreateAdHoc
Adds an ad hoc labor account
Required Properties: LaborAccountName
Introduced in v4
Chapter 2
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
The user and labor level account must allow ad hoc access
Introduced in v4
Chapter 2
AdjustmentAllocation Tag
Adjustment Allocation
Allocates either a wage or bonus adjustment for an adjustment rule.
Wage or bonus allocations must be greater than zero.
For a bonus type allocation, the pay code must be either money or hourly.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<AdjustmentAllocation
BonusRateHourlyRate = Double
BonusRateAmount = String
TimeAmountMaximumAmount = Double
TimeAmountMaximumTime = Time
[AdjustmentType = String]
[Amount = String]
[LaborAccount = String]
[LaborAccountType = String]
[TimeAmountMinimumTime = Time]
[OncePerDay = Boolean]
[PayCode = String]
[OverrideIfHomeSwitch = Boolean]
[UseHighestWageSwitch = Boolean]
[TimePeriod = String]
[Type = String]
[WeekStart = String] >
</AdjustmentAllocation>
Chapter 2
TimeAmountMaximumAmount
Maximum Amount
If specified, it represents the maximum amount that can be given for an employee
as a bonus adjustment. You can enter a TimeAmountMaximumTime or a
TimeAmountMaximumAmount, but not both.
Type: Double
Must be a valid amount.
Sample values:
TimeAmountMaximumAmount="150.00"

TimeAmountMaximumTime
Maximum Time Amount
If specified, it represents the maximum time amount worked that will be applied
for the bonus adjustment. You can enter a TimeAmountMaximumTime or a
TimeAmountMaximumAmount, but not both.
Type: Time
Must be a valid time amount in HH:mm format.
Sample values:
TimeAmountMaximumTime="10:00"

BonusRateHourlyRate
Bonus Hourly Rate
Specifies the rate that will be multiplied by the eligible worked hours then added
to the employees totals. You can enter a BonusRateAmount or a
BonusHourlyRate, but not both.
Type: Double
Rate amount must be a positive value.
Sample values:
Chapter 2
BonusRateHourlyRate="10.25"
BonusRateAmount
Bonus Rate Amount
A fixed amount of money or time that is added to the employees totals. You can
enter a BonusRateAmount or a BonusHourlyRate, but not both.
Type: String
Amount must be a positive value. Depending on the type of PayCode (Money or
Hourly), the value must represent either money or time amount.
Sample values:
<AdjustmentAllocation AdjustmentType="Bonus"
PayCode="Bonus$" BonusRateAmount="20.25".../>
PayCode="BonusHourly" BonusRateAmount="0:30" Ö />

AdjustmentType
Adjustment Type
Specifies the type of an Adjustment Rule. Valid values are "Bonus" or "Wage". If
it's not supplied, the type defaults to the "Wage" type.
Type: String
Optional
Sample values:
<AdjustmentAllocation AdjustmentType="Bonus" Ö>
Default value: Wage

Introduced in v6.1
Amount
Amount
Used only with the AdjustmentType="Wage". Specifies the wage amount to be
applied to an employee totals.
Chapter 2
Type: String
Optional
It must be a valid positive amount. It is Required for Wage type adjustment but not
used with the Bonus type adjustment.
Sample values:
Amount = "50.25"

LaborAccount
Labor Account Name
The specific labor account that will be allocated for the Bonus Adjustment pay, if
applies. This property must be supplied when the property LaborAccountType is
equal to "Specify".
Type: String
Optional
Must be a valid labor account. If AdHoc is enabled and validation for a labor level
is turned off, then labor level entries may be created by adhoc.
Sample values:
LaborAccount="102/201/3/4/501/601/702"
Introduced in v6.1
LaborAccountType
Labor Account Type
Specifies a type of labor account that will be allocated for the pay.
Type: String
Optional
Valid values are: Worked, Home or Specify. If LaborAccountType="Specify", a
LaborAccount property must be supplied.
Sample values:
LaborAccountType="Home"
Chapter 2
Default value: Worked

OncePerDay
Once Per Day
Specifies, if the Bonus Adjustment Rule should be applied only once per day or
more.
Type: Boolean
Optional
Valid Values are: true, false.
Sample values:
OncePerDay = "false"
Default value: false

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
Valid Values are: true, false
Sample values:
OverrideIfHomeSwitch="true"

Chapter 2
PayCode
Pay Code
Specifies the pay code that will be allocated for the pay.
Type: String
Optional
It is Required for Bonus type adjustment but not used with the Wage type
adjustment. The Pay Code must be either Money or Hourly pay code.
Sample values:
PayCode="Bonus$"

TimeAmountMinimumTime
Minimum Time Amount
If specified, it represents minimum time amount worked that is required to qualify
an employee to get the bonus adjustment.
Type: Time
Optional
Must be a valid time amount in HH:mm format.
Sample values:
TimeAmountMinimumTime="2:00"

TimePeriod
Time Period
Specifies the Time Period that will be applied for the Bonus Adjustment
calculations.
Type: String
Optional
Valid values are: Shift, PayPeriod, Weekly. If the value is "Weekly", the
WeekStart parameter must be supplied also.
Chapter 2
Sample values:
TimePeriod="Shift"
Default value: Shift

Type
Type
Used only with the AdjustmentType="Wage". Specifies how the wage adjustment
amount should be applied to an employee totals.
Type: String
Optional
Valid Values are: Addition, FlatRate, Multiplier. It is Required for Wage type
adjustment but not used with the Bonus type adjustment.
Sample values:
Type = "FlatRate"
Default value: Addition

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
Valid Values are: true, false
Sample values:
UseHighestWageSwitch="true"

Chapter 2
WeekStart
Week Start
If the property TimePeriod is equal to "Weekly", it defines the start day of the
week.
Type: String
Optional
Valid Values are: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday,
Saturday.
Sample values:
WeekStart = "Monday"
Introduced in v6.1

BonusRate
Bonus can be calculated either as a flat amount (BonusRateAmount) or as an
hourly rate (BonusRateHourlyRate).
Optional
Group includes: BonusRateHourlyRate, BonusRateAmount
TimeAmountMaximum
Maximum amount must be specified either in terms of time or money.
Optional
Group includes: TimeAmountMaximumAmount, TimeAmountMaximumTime
Chapter 2
AdjustmentRule Tag
Adjustment Rule
This tag provides many operations to manage Adjustment Rules, i.e. to create,
read, update, and delete. Use the EmployeeAdjustmentRuleAssignment tag to
assign an Adjustment Rule to an employee.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"Delete" |
"Retrieve" |
"RetrieveAll" |
"RetrieveAllForUpdate" |
"RetrieveAllNames" |
"RetrieveByName" |
"RetrieveForUpdate" |
"Update"
Parameters→
None
Properties→
<AdjustmentRule
Name = String >
<RuleVersions>
<AdjustmentRuleVersion>*
</RuleVersions>
</AdjustmentRule>
Action Descriptions
Chapter 2
Add
This action will insert an Adjustment Rule with the given Name. If the
RuleVersions are not supplied, the rule will be entered with default effective and
expiration dates, 1/1/1753 and 1/1/3000, respectively.
Name must not be null and between 1 and 30 characters.
Required Properties: Name
Optional Properties: RuleVersions
Introduced in v6.1
Delete
The action will delete the Adjustment Rule with the given Name.
Introduced in v6.1
Retrieve
Retrieves the Adjustment Rule information for the given rule Name.
Name must not be null and must be between 1 and 30 characters in length. The
name must be unique.
Return Value Type: AdjustmentRule tag
RetrieveAll
Retrieves all Adjustment Rules with the detail information on the system.
Return Value Type: Zero or more AdjustmentRule tags
Chapter 2
Introduced in v6.1
RetrieveAllForUpdate
Retrieves all Adjustment Rules with the detailed information on the system. Same
as RetrieveAll.
Return Value Type: Zero or more AdjustmentRule tags
Introduced in v6.1
RetrieveAllNames
Retrieves all Adjustment Rule names on the system.
Return Value Type: Zero or more NameList tags
Introduced in v6.1
RetrieveByName
Retrieves the Adjustment Rule information for the given Name.
Introduced in v6.1
RetrieveForUpdate
Retrieves the Adjustment Rule information for the given Name. Same as Retrieve
or RetrieveByName actions.
Name must not be null and must be between 1 and 30 characters in length.
Introduced in v6.1
Update
This action will update the Adjustment Rule with the given Name. If the
Adjustment Rule does not exist, the action "Add" will be performed.
Chapter 2

Name
Rule Name
The name of the Adjustment Rule.
Type: String
Required Key
Must not be null and between 1 and 30 characters. Special characters are not
allowed. The name must be unique.
Sample values:
Name="Bonus Adjustment Rule"

RuleVersions
Rule Versions
A list of revisions of the rule.
Type: Zero or more AdjustmentRuleVersion tags
Required
Sample values:
<RuleVersions>
<RuleVersion EffectiveDate="01/01/1753"
ExpirationDate="01/01/3000" Description="test API" />
</RuleVersions>
Chapter 2
Chapter 2
AdjustmentRuleVersion Tag
Adjustment Rule Version
Represents a revision of an Adjustment Rule.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddVersionToRule"
Parameters→
AddVersionToRule→
RuleName = String
Properties→
<AdjustmentRuleVersion
[Description = String]
EffectiveDate = Date
ExpirationDate = Date >
[<Triggers>
<AdjustmentTriggerForRule>*
</Triggers>]
</AdjustmentRuleVersion>
Action Descriptions
AddVersionToRule
Adds a new version to an Adjustment Rule.
Required Properties: EffectiveDate, ExpirationDate
Chapter 2
Optional Properties: Description, Triggers

Introduced in v6.1
Action Parameters

RuleName Name of the Adjustment Rule that the Introduced in v6.1
action applies to.
Required
Description
Description
Simple description to describe the revision.
Type: String
Optional
Sample values:
Description="First version"
Introduced in v6.1
EffectiveDate
Effective Date
The date that this revision begins.
Type: Date
Required
Must be a valid date and not null.
Sample values:
EffectiveDate="01/01/1753"
Introduced in v6.1
Chapter 2
ExpirationDate
Expiration Date
The end date of this revision.
Type: Date
Required
Sample values:
ExpirationDate="01/01/3000"
Introduced in v6.1
Triggers
Triggers
Triggers in a version are used to compare against a total. If the trigger matches
then the total is used to allocate specific pay code amount.
Type: Zero or more AdjustmentTriggerForRule tags
Optional
Sample values:
<Triggers>
<AdjustmentTriggerForRule LaborAccountPattern="102/
///501//702">
<AdjustmentAllocation>
PayCode="Bonus$" LaborAccountType="Home"
BonusRateHourlyRate="3.45" TimePeriod="Shift"
TimeAmountMaximumTime="11.00"/>
<PayCodes>
<SimpleValue Value="Daily-OT"/>
<SimpleValue Value="Day"/>
</PayCodes>
</AdjustmentTriggerForRule>
</Triggers>
Chapter 2
Chapter 2
AdjustmentTrigger Tag
Adjustment Rule Trigger
It defines a trigger of an Adjustment Rule. This tag was created for the
AddTriggerToRule action to specify the exact type of a Total Allocation Rule (i.e.
Adjustment Rule) to which the trigger will be added.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddTriggerToRule" |
"DeleteByTrigger" |
"UpdateOnlyByTrigger"
Parameters→
AddTriggerToRule→
RuleName = String
VersionEffectiveDate = Date
DeleteByTrigger→
RuleName = String
UpdateOnlyByTrigger→
RuleName = String
Properties→
<AdjustmentTrigger
[JobCode = String]
[JobCodeEffectiveDate = Date]
[JobCodeToMatch = String]
LaborAccountPattern = String
[LaborAccountPatternToMatch = String]
[SequenceNumberToMatch = Long]
Chapter 2
SequenceNumber = Integer >

[<PayCodes>
<SimpleValue>*
</PayCodes>]
[<PayCodesToMatch>
<SimpleValue>*
</PayCodesToMatch>]
</AdjustmentTrigger>
Action Descriptions
AddTriggerToRule
Adds a new Trigger to an Adjustment Rule revision.
Required Properties: LaborAccountPattern, SequenceNumber,
AdjustmentAllocation
Optional Properties: JobCode, JobCodeEffectiveDate
Chapter 2
Action Parameters

RuleName Name of the Adjustment Rule to add Introduced in v6.1; last changed
this trigger to. in v6.1
Required
VersionEffectiveDate The effective date of an Adjustment Introduced in v6.1
Rule version to which the trigger will
be added.
Required
Date must be valid.
DeleteByTrigger
Deletes a trigger within an Adjustment Rule revision.
Required Properties: LaborAccountPatternToMatch
Optional Properties: JobCodeToMatch, PayCodesToMatch,
SequenceNumberToMatch
Introduced in v6.1
Chapter 2
Action Parameters

RuleName Name of the Adjustment Rule where Introduced in v6.1
the trigger will be deleted.
Required
VersionEffectiveDate The effective date of an Adjustment Introduced in v6.1; last changed
Rule version where the trigger will be in v6.1
deleted.
Required
Date must be valid.
UpdateOnlyByTrigger
Updates a trigger within an Adjustment Rule revision. NOTE: The update will
not occur if you have the same trigger settings, but different Allocation Types (e.g.
Wage Adjustment for Trigger 1, Bonus for Trigger 2). In this case you must
specify the SequenceNumberToMatch to perform the update.
Chapter 2
Action Parameters

RuleName Name of the Adjustment Rule Introduced in v6.1
containing the updated trigger.
Required
VersionEffectiveDate The effective date of an Adjustment Introduced in v6.1
Rule containing the updated trigger.
Required
Date must be valid.
Adjustment Allocation for an Adjustment Rule.
Type: AdjustmentAllocation tag
Required
Sample values:
BonusRateAmount="20.25" TimePeriod="Shift"
Introduced in v6.1
JobCode
Job Code
The Job that will be used to compare against a Job of totals pay. Used in
combination with the Labor Account pattern and Pay Codes.
Type: String
Optional
Chapter 2
The Job Code Path entered must exist.

Sample values:
JobCode="Organization/Manufacturing/Bright Plant/
Lamps/Line 1/ASSM"
Introduced in v6.1
JobCodeEffectiveDate
Job Code Effective Date
The effective date of the chosen Job. It should be supplied if the JobCode property
value is given.
Type: Date
Optional
Must be a valid date. If not provided then the current date is used.
Sample values:
JobCodeEffectiveDate="4/02/2008"
Introduced in v6.1
JobCodeToMatch
Job Code To Match
For the DeleteByTrigger and UpdateOnlyByTrigger actions, the job code that is
used to identify triggers that will be deleted or updated. All pieces of the trigger
must match.
Type: String
Optional
The Job Code Path entered must exist and be qualified enough that there is only
one match. Entering in a Job such as just "QCE" will fail as there are numerous
QCE jobs at different locations (Line)
Sample values:
JobCodeToMatch="Line 1/QCE"
Introduced in v6.1
Chapter 2
LaborAccountPattern
Labor Account Pattern
The Labor Account that will be used to compare against a Labor Account of totals
pay. If this and any other trigger attributes match then the trigger is applied.
Type: String
Required
Must be in a valid Labor Account format containing the correct number of labor
levels, use the correct wild card characters (*,?). Full labor level entries are
validated to exist.
Sample values:
LaborAccountPattern="10*//307//501//702"
Introduced in v6.1
LaborAccountPatternToMatch
Labor Account Pattern To Match
For the DeleteByTrigger and UpdateOnlyByTrigger actions, the labor account
that is used to identify triggers that will be deleted or updated. All pieces of the
trigger must match.
Type: String
Optional
Must be in a valid labor account format containing the correct number of labor
levels, use the correct wild card characters (*,?). If a full labor level entries are
validated to exist.
Sample values:
LaborAccountPatternToMatch="//////701"
Introduced in v6.1

Chapter 2
PayCodes
Pay Codes
Part of the trigger and when defined used when comparing against a total. If there
are paycodes defined on the trigger, then the total must match one of those
paycodes.
Optional
The Pay Codes must be Hourly or Money pay codes.
Sample values:
<PayCodes>
<SimpleValue value="Regular"/>
</PayCodes>

PayCodesToMatch
Pay Codes To Match
For the DeleteByTrigger and UpdateOnlyByTrigger actions, the pay codes that
are used to identify triggers that will be deleted or updated. All pieces of the
trigger must match.
Optional
The Pay Codes must be Hourly pay codes.
Sample values:
<PayCodesToMatch>
</PayCodesToMatch>

SequenceNumber
Trigger Sequence Number
Specifies the order in which triggers are applied. The sequence is used in the UI
display and by a processor for the order in which the triggers are used.

Chapter 2
Type: Integer
Required
It must be a valid positive number.
Sample values:
SequenceNumber="1"
Introduced in v6.1
Sequence Number To Match
For the DeleteByTrigger and UpdateOnlyByTrigger actions, the sequence
numbers that is used to identify triggers that will be deleted or updated. All pieces
of the trigger must match, then this Sequence number is used to identify a specific
trigger.
Type: Long
Optional
It must be a valid positive number. If used, it should be unique in a version.
Sample values:
SequenceNumberToMatch="1"

Chapter 2
AdjustmentTriggerForRule Tag
Adjustment Rule Trigger
Defines a trigger for an Adjustment Rule.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<AdjustmentTriggerForRule
[JobCode = String]
[OriginalSequenceNumber = Long]
[SequenceNumber = Long] >
[<PayCodes>
<SimpleValue>*
</PayCodes>]
</AdjustmentTriggerForRule>
Adjustment Allocation for an Adjustment Rule
Type: AdjustmentAllocation tag
Required
Sample values:

Chapter 2
BonusRateHourlyRate="3.45" TimePeriod="Shift"
Introduced in v6.1
JobCode
Job Code
The Job that will be used to compare against a Job totals pay. Used in combination
with the Labor Account Pattern and Pay Codes.
Type: String
Optional
Sample values:
Lamps/Line 1/ASSM"
Introduced in v6.1
The effective date of the chosen Job.
Type: Date
Optional
Sample values:
Introduced in v6.1

Chapter 2
LaborAccountPattern
The Labor Account that will be used to copmare against a Labor Account of totals
Type: String
Required
validated to exist.
Sample values:
LaborAccountPattern="1*////501//702"
Introduced in v6.1
OriginalSequenceNumber
Original Sequence Number
Specifies the original sequence number used when matching triggers.
Type: Long
Optional
Sample values:
OriginalSequenceNumber="1"
Introduced in v6.1
PayCodes
Pay Codes
A list of Pay Codes in the Total Allocation Rule trigger. When defined in the
trigger, the Pay Codes are matched against the Pay Codes in totals.
Optional
The Pay Codes must be money pay codes if hourly rate is used.

Chapter 2
Sample values:
<PayCodes>
</PayCodes>
Introduced in v6.1
SequenceNumber
Sequence Number
display and by a processor for the order in which the triggers are used. If the
Sequence Number is not specified, it will be generated. If the Sequence Number is
used, it should be unique in a version.
Type: Long
Optional
Sample values:
SequenceNumber="1"
Introduced in v6.1

Chapter 2
Allocation Tag
Allocation
Allocates pay code and rate amount for a total allocation rule.
Amount must be a positive number, pay code must be a money pay code.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<Allocation
PayCode = String
RateAmount = Double >
</Allocation>
PayCode
Pay Code
Specifies the pay code that will be allocated for the pay.
Type: String
Required
Pay Code must be a Money pay code.
Sample values:
<Allocation PayCode="TipCode$" RateAmount="12.00" />

Chapter 2
RateAmount
Rate Amount
Specifies the amount that will be added for each eligible worked hour.
Type: Double
Required
Amount must be a positive value.
Sample values:
<Allocation PayCode="TipCode$" RateAmount="12.00" />

Chapter 2
APICallList Tag
Call List
This tag provides managers, supervisors, or staffing specialists, a call list to find
employees that are qualified and available to fill an open shift.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveCallList"
Parameters→
RetrieveCallList→
EndDate = Date
ProcedureSetName = String
StartDate = Date
Action Descriptions
RetrieveCallList
Retrieves the list of open shifts and matching employees for each open shift.
Return Value Type: Zero or more APICallList tags
Introduced in v6.0

Chapter 2
Action Parameters

EndDate The end date of the scheduling period. Introduced in v6.0
Required
ProcedureSetName The name of the script to execute. Introduced in v6.0
Required
StartDate The start date of the scheduling Introduced in v6.0
period.
Required

Chapter 2
APIHolidayProfile Tag
Holiday Profiles
Holiday profiles enable you to assign holidays and holiday credit rules to
employees outside of pay rules and work rules. Using holiday profiles, you can
manage the holidays that employees celebrate in different location without
creating multiple pay rules and work rules.
The Holiday Profiles workspace displays a table that contains each holiday profile
in the system, including its name and description, and whether it is active.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"Update"
Parameters→
None
Properties→
<APIHolidayProfile
[Active = Boolean]
Name = String >
[<HolidayProfileDataSet>
<APIHolidayProfileDataSet>
</HolidayProfileDataSet>]
</APIHolidayProfile>

Chapter 2
Action Descriptions
Delete
Deletes the HolidayProfile if it is not in use.
The profile to be deleted should exist in the database.
Introduced in v6.1
Retrieve
Specify the name of the holiday profile to be retrieved; the name should not
exceed 50 characters.
Return Value Type: (***undefined***): HolidayProfile
Optional Properties: None
Introduced in v6.1
Retrieves all of the available Holiday Profiles based on the user's GDAP profile.
This is used by Setup Data Manager to transfer all available Hoilday Profiles from
Source system to target system.
Return Value Type: Collection
Introduced in v6.1

Chapter 2
RetrieveAllNames
Return the collection of names of HolidayProfile objects required for Setup Data
Manager.
Introduced in v6.1
RetrieveForUpdate
Response of this action can be used as input to Update action and this is used by
Setup Data Manger for that purpose.
Introduced in v6.1
Update
The name of the holiday profile must be unique and not exceed 50 characters and
it can not be empty. The description of holiday profile can not exceed 250
characters.
Name should be unique, Active can be true or false.
Optional Properties: Description, Active
Introduced in v6.1

Chapter 2
Active
Active
Based on the value of this property, a holiday profile has a status of Active or
Iinactive.
Type: Boolean
Optional
It should always have either true or false when this property is used.
Default value: true
Description
Description
Description of the holiday profile that is being created or modified.
Type: String
Optional
HolidayProfileDataSet
Holiday Profile Data Set
This will contain zero or more Effective-Dated Holiday Profile data items for this
Holiday profile.
Type: APIHolidayProfileDataSet tag
Optional
Name
Holiday Profile Name
The name of the holiday profile that you would like to create, modify or delete.
The name must be unique.
Type: String
Required Key

Chapter 2
APIHolidayProfileData Tag
Effective-dated Holiday Profile
This is an internal representation of components of the effectively-dated
component of a holiday profile.
The EffectiveDate value cannot be empty and should have a valid value.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve"
Parameters→
None
Properties→
<APIHolidayProfileData
[DefaultCreditRuleName = String]
[DefaultZoneRuleName = String]
EffectiveDate = DateTime
[ExpirationDate = DateTime] >
[<Entries>
<APIHolidayProfileDataEntry>*
</Entries>]
</APIHolidayProfileData>
Action Descriptions
Retrieve
Returns an Effectively Dated component of a Holiday Profile.

Chapter 2
EffectiveDate must have a valid value.

Return Value Type: APIHolidayProfileData tag
Required Properties: EffectiveDate
Optional Properties: Name
Introduced in v6.1
DefaultCreditRuleName
Default Credit Rule
The name of the holiday credit yule that will be used as a default credit rule for a
version of an effectively-dated Holiday Profile component.
Type: String
Optional
DefaultZoneRuleName
Default Zone Rule
The name of the zone rule that will be used as a default zone rule for a version of
an effectively-dated Holiday Profile component.
Type: String
Optional
EffectiveDate
Effective Date
The Effective Date for a version of an effectively-dated Holiday Profile
component.
Type: DateTime
Required
EffectiveDate can not be empty and it should have a valid value.

Chapter 2
Sample values:
5/01/2008
Default value: 01/01/1753

Entries
Entries
This will contain zero or more Holiday Profile data entry components.
Type: Zero or more APIHolidayProfileDataEntry tags
Optional
ExpirationDate
Expiration Date
The expiration date of a version of an effectively-dated Holiday Profile
component.
Type: DateTime
Optional
Sample values:
04/30/2010


Chapter 2
APIHolidayProfileDataEntry Tag
Holiday Profile Data
This is an internal representation of a component of an effectively-dated
component in a holiday profile.
This component wraps a Holiday, which must already exist in the database.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<APIHolidayProfileDataEntry
[UseDefaultCreditRule = Boolean]
[UseDefaultZoneRule = Boolean]
[CreditRuleName = String]
HolidayName = String
[ZoneRuleName = String] >
</APIHolidayProfileDataEntry>
CreditRuleName
Holiday CreditRule Name
Name of the Holiday CreditRule that will be added as a component of an
Effectivedated HolidayProfile. This attribute represents the name of a Holiday
Credit Rule which must previously exist in the database.
Type: String
Optional

Chapter 2
This attribute represents the name of a Holiday Credit Rule which must previously
exist in the database.
Introduced in v6.1
HolidayName
Holiday Name
This attribute represents the name of the holiday that will be added as a
component of an effective-dated holiday profile. The holiday must already exist
in the database.
Type: String
Required
This attribute represents the name of a holiday, which must already exist in the
database.
UseDefaultCreditRule
Default Credit Rule
The Credit Rule can be used as a default based on the value of this property.
Type: Boolean
Optional
Introduced in v6.1
UseDefaultZoneRule
Default Zone Rule
The Zone Rule can be used as a default based on the value of this property.
Type: Boolean
Optional
Introduced in v6.1
ZoneRuleName
Zone Rule Name
Name of the Holiday Zone Rule that will be added as a component of an
Effectivedated HolidayProfile. This attribute represents the name of a Holiday
Zone Rule which must previously exist in the database.

Chapter 2
Type: String
Optional
This attribute represents the name of a Holiday Zone Rule which must previously
exist in the database.
Introduced in v6.1

Chapter 2
APIHolidayProfileDataSet Tag
Holiday Profile Data Set
This is an internal representation of a component of an Effectively-dated
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve"
Parameters→
None
Properties→
<APIHolidayProfileDataSet
Name = String >
[<DataMembers>
<APIHolidayProfileData>*
</DataMembers>]
</APIHolidayProfileDataSet>
Action Descriptions
Retrieve
Returns HolidayProfileDataSet for the given name of HolidayProfile.
Name of the Holiday Profile should not be empty and must have a valid value.
Return Value Type: APIHolidayProfileDataSet tag

Chapter 2

Introduced in v6.1
DataMembers
Data Members
This is an internal representation of a component of an effectively-dated
Type: Zero or more APIHolidayProfileData tags
Optional
Name
Holiday Profile Name
The name of the holiday profile that contains this data set.
Type: String
Required
The name of the Holiday Profile must have a value.

Chapter 2
APIOutsideDate Tag
Outside of work week date
This tag specifies whether hours outside of the work week are excluded when
validating weekly employee schedule rules.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<APIOutsideDate
OutsideDate = Date >
</APIOutsideDate>
OutsideDate
A date outside of work week
Specify a date outside of the work week. Hours scheduled on this day are not
counted in the weekly scheduling rule limits.
Type: Date
Required
Standard date validation applies
Sample values:
<OutsideDate> 04/26/2006</OutsideDate>

Chapter 2
APIPSEEngine Tag
Run Priority Scheduling Engine
This tag runs the Priority Scheduling Engine (PSE) with a set of parameters,
including procedure set name, start date, and end date.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Run"
Parameters→
Run→
EndDate = Date
ProcedureSetName = String
StartDate = Date
Action Descriptions
Run
This action runs the PSE with the given parameters.
Introduced in v6.0

Chapter 2
Action Parameters

EndDate The end date of the scheduling period. Introduced in v6.0
Required
ProcedureSetName The name of the script to execute. Introduced in v6.0
Required
StartDate The start date of the scheduling Introduced in v6.0
period.
Required

Chapter 2
APIPunchRestrictionOverride Tag
Override Punch Restriction
This tag lets you override punch restrictions for Timestamp employees.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<APIPunchRestrictionOverride
[EarlyInOverrideFlag = Boolean]
[EarlyOutRestrictionFlag = Boolean]
[ExpirationDateTime = DateTime]
[LateInRestrictionFlag = Boolean]
[LateOutRestrictionFlag = Boolean]
[MinimumBreakRestrictionFlag = Boolean]
PersonNumber = String
[StartBreakRestrictionFlag = Boolean]
[UnscheduledPunchRestrictionFlag = Boolean] >
</APIPunchRestrictionOverride>
Action Descriptions
RetrieveForUpdate
Retrieves the punch restriction override information (if any is present in the DB)
for a given employee.

Chapter 2
Person Number should represent the employee id of an existing employee.

Return Value Type: APIPunchRestrictionOverride tag
Required Properties: PersonNumber
Introduced in v6.0
Update
Updates or adds a punch restriction override record to the database for the
specified employee.
Person number must be specified and must represent the employee id of an
existing employee.
Introduced in v6.0
EarlyInOverrideFlag
Early In Override
Specify whether to override the duration of time before the scheduled shift starts
when the employee can punch in.
Type: Boolean
Optional
Must be either "true" or "false".
Sample values:
true

Introduced in v6.0

Chapter 2
EarlyOutRestrictionFlag
Early Out Restriction Override
Specify whether to override the amount of time before the scheduled end of a shift
when employees cannot punch out.
Type: Boolean
Optional
Sample values:
true

Introduced in v6.0
ExpirationDateTime
Expiration Date and Time
Specify the expiration date and time for the override.
Type: DateTime
Optional
Must be able to be converted to a valid date and time (KDateTime)
Sample values:
1/25/2007 10:37AM
Default value: Currentdate and time plus 24 hours.

Introduced in v6.0
LateInRestrictionFlag
Late In Restriction Override
Specify whether to override the amount of time after a scheduled shift starts
before an employees punch is rejected.
Type: Boolean
Optional

Chapter 2

Sample values:
true

Introduced in v6.0
LateOutRestrictionFlag
Late Out Restriction Override
Specify whether to override the amount of time after the scheduled end of a shift
when employees can punch out.
Type: Boolean
Optional
Sample values:
true

Introduced in v6.0
MinimumBreakRestrictionFlag
Minimum Break Restriction Override
Specify whether to override the punch restriction on the minimum amount of time
allowed for a meal break.
Type: Boolean
Optional
Sample values:
true

Chapter 2
Introduced in v6.0
PersonNumber
Person Number
Specify the person's identification number for whom the punch restriction
override will apply.
Type: String
Required
Must be specified and should represent the employee id of an existing employee
previously added to the system.
Sample values:
"242" or "JSMITH"
Introduced in v6.0
StartBreakRestrictionFlag
Start Break Restriction Override
Specify whether to override the amount of time before the start of a scheduled
shift when an employee punch is rejected.
Type: Boolean
Optional
Sample values:
true

Introduced in v6.0
UnscheduledPunchRestrictionFlag
Unscheduled Punch Restriction Override
Specify whether to override the timestamp or device rule to reject in-punches
from employees who do not have a scheduled shift.
Type: Boolean

Chapter 2
Optional
Sample values:
true

Introduced in v6.0

Chapter 2
APISCGEngine Tag
Run Schedule Generator
Runs the Schedule Generator engine with a set of parameters: start date and end
date.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"run"
Parameters→
run→
EndDate = Date
OptionSetName = String
StartDate = Date
Action Descriptions
run
Runs the Schedule Generator engine.
Introduced in v6.0

Chapter 2
Action Parameters

EndDate The end date. Introduced in v6.0
Required
OptionSetName Represents the schedule generator Introduced in v6.0
location settings name.
Required
StartDate The start date. Introduced in v6.0
Required

Chapter 2
APIStableDateSpans Tag
Stable date spans
This tag lists all the stable date spans for a given list of locations.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve"
Parameters→
None
Properties→
<APIStableDateSpans
QueryDateSpan = String >
[<Locations>
<LocationItem>*
</Locations>]
</APIStableDateSpans>
Action Descriptions
Retrieve
Retrieve the stable date span list.
Return Value Type: APIStableDateSpans tag
Required Properties: QueryDateSpan
Optional Properties: Locations

Chapter 2
Introduced in v6.0
Locations
Locations related to stable date span
Represents a list of locations.
Type: Zero or more LocationItem tags
Optional
Sample values:
<Locations>
<LocationItem Location="Organization/Hospitals/Hosp
A/Floor 1"/>
</Locations>

QueryDateSpan
A stable date span
Represents a date span.
Type: String
Required
Sample values:
<QueryDateSpan> 04/23/2006 - 04/29/2006</
QueryDateSpan>

Chapter 2
APIVolumeDataService Tag
Volume data service
This tag returns all the volume items for a list of locations and a range of dates.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve"
Parameters→
None
Properties→
<APIVolumeDataService
[<Locations>
<LocationItem>*
</Locations>]
</APIVolumeDataService>
Action Descriptions
Retrieve
Retrieves all the Volume Items for the given date period and for the given list of
locations.
Return Value Type: Zero or more VolumeDataItem tags

Chapter 2

Introduced in v6.0
Locations
Locations
Specify a list of locations, such as hospital, floor, or department.
Optional
Sample values:
<Locations>
A/Floor 1/ER"/>
A/Floor 1/Pediatrics"/>
</Locations>
Introduced in v6.0
QueryDateSpan
Date span of volume data
Specify a date span to query.
Type: String
Required
Sample values:
<QueryDateSpan> 04/11/2006 - 04/12/2006</
QueryDateSpan>

Chapter 2
AppendShifts Tag
Append shifts
The AppendShifts tag adds time to the beginning or end of a given shift.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<AppendShifts
AppendDurationAmount = TimeDuration
AppendToBeginOrEnd = Boolean
[LaborAccountName = String]
[OrgJobPath = String]
[WorkRuleName = String] >
</AppendShifts>
AppendDurationAmount
Amount of time to be appended
AppendDurationAmount
Type: TimeDuration
Required
AppendToBeginOrEnd
Append to the beginning?
AppendToBeginOrEnd property.

Chapter 2
Type: Boolean
Required
Introduced in v5.1
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

Chapter 2
ApplicationCalendar Tag
Calendar for Application View
The tag creates an application calendar for a specific application, such as
timekeeping or scheduling. The application calendar can be used by calendar
profiles.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ApplicationCalendar
ViewType = Integer
MonthWidth = Integer
ApplicationName = String
DataSetName = String >
</ApplicationCalendar>
ApplicationName
The name of application
The name of an existing application such as timekeeping or scheduling that is
associated with the calendar profile.
Type: String
Required

Chapter 2
DataSetName
The name of the calendar data set
The name of the calendar data set to be used in this calendar profile. The calendar
data set is created by the DataSet tag.
Type: String
Required
MonthWidth
Default width of months in multiple months view
The default width of months in multiple months display. Even if you select one
week or one month as the default time period for the calendar width, you might
want to choose a default number of months, to accommodate individual users who
change their calendar view to multiple months.
Type: Integer
Required
ViewType
Default view type
The default time period display for the calendar. Use 1 for weekly view, 2 for
monthly view, or 3 for multiple months view. (You select the number of months
in a multiple month view using the MonthWidth property.)
Type: Integer
Required
Sample values:
1
2
3
Enumerated value: 1,2,3


Chapter 2
ApplicationCalendarAPIFacade Tag
Facade for Application Calendar
This tag is the public interface to the ApplicationCalendar. ApplicationCalendars
can only be modified by CalendarProfiles.
Introduced in v5.2
Syntax
None

Chapter 2
Approval Tag
Approval
The Approval tag provides a wrapper for the Approval business object for
returning approval data to users through the API via XML.
Read only - no validation.
Introduced in v5.2
Syntax
None

Chapter 2
Approver Tag
Approver
The Approver tag defines a person's list of approvers. A person can have up to 5
approvers.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<Approver
ApproveLevel = Integer
[DueDateAmount = Integer]
FullName = String >
</Approver>
ApproveLevel
Approve Level
The order number of the approver
Type: Integer
Required
It can only be integer number from 1 to 5.
Sample values:
1, 2, 3, 4, 5.

Chapter 2
DueDateAmount
Due Date Amount
The amount of days that the approver should approve the person's request.
Type: Integer
Optional
The number should not be less than 0.
Sample values:
1, 2, etc.
Introduced in v6.1
FullName
Full Name
The approver's full name.
Type: String
Required
The person should have active manager's license.
Sample values:
CLARK, FREDERICK
Introduced in v6.1

Chapter 2
ApproveSignoff Tag
Approve Timecard
The ApproveSignoff tag enables the user to manage the approval and signoff
aspects of a timecard.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Approve" |
"ListAllApprovals" |
"PeriodIsApproved" |
"PeriodIsSignedOff" |
"RemoveApproval" |
"RemoveOthersApproval" |
"RemoveSignOff" |
"SignOff"
Parameters→
None
Properties→
<ApproveSignoff
[DataSource = String]
[UserName = String] >
<Employee>
</Employee>
[<Period>
<TimeFramePeriod>
</Period>]
</ApproveSignoff>

Chapter 2
Action Descriptions
Approve
Approves the specified employee's timesheet.
Return Value Type: Zero or more Approval tags
Required Properties: Employee, Period
Introduced in v4
ListAllApprovals
Returns a list of approvals for the specified employee within the specified time
period.
Return Value Type: Zero or more Approval tags
Introduced in v6.1
PeriodIsApproved
Returns a True or False, depending on whether the specified employee's timesheet
is approved.
Introduced in v4
PeriodIsSignedOff
Returns True or False, depending on whether the specified employee's timesheet
is signed off.
Introduced in v4

Chapter 2
RemoveApproval
Removes the approval from the employee.
Required Properties: Employee
Introduced in v4
RemoveOthersApproval
Removes an approval that was added by someone other than the current user.
Required Properties: Employee, Period, UserName, DataSource
Introduced in v4
RemoveSignOff
Removes the latest signoff for the employee.
Introduced in v4
SignOff
Adds a sign off to the specified employee's timesheet.
Introduced in v4

Chapter 2
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
Introduced in v4
Employee
Employee
One employee whose time is to be approved or signed off, as specified in a
PersonIdentity or CurrentUser tag.
Required Key
Introduced in v4
Period
Time period
For all actions except Signoff, this is the timeframe to which the action applies. It
is ignored for the Signoff action.
Type: TimeFramePeriod tag
Optional
Introduced in v4
UserName
User name
The user name used for the approval. Used in the PeriodIsApproved action.
Type: String
Optional

Chapter 2
Default value: The logged on user

Introduced in v4

Chapter 2
AssignmentDetail Tag
Schedule Assignments Details
Assignment detail item, appears within AssignmentDispatchEngine API response
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<AssignmentDetail
(<AssignmentEmployee>
<AssignmentEmployee>
</AssignmentEmployee>)
(<OverCoverageSpan>
<OverCoverageSpan>
</OverCoverageSpan>)
(<ShiftSegment>
<ShiftSegment>
</ShiftSegment>)
(<UnderCoverageSpan>
<UnderCoverageSpan>
</UnderCoverageSpan>)
</AssignmentDetail>
AssignmentEmployee
Employee Assignment
Employee currently working the overcoverage segment (RetreiveOverCoverage
response), or employee which could work the suggested transfer span
(RetreiveUnderCoverage response).

Chapter 2
Type: AssignmentEmployee tag

Output only
Sample values:
<Employee PersonNumber="256" Name="Smithson,
Danielle">

OverCoverageSpan
Over Coverage Span
For the RetrieveOverCoverage action,
The OverSpan element describes a subset of the segment span which is
overcovered. If several overcoverage spans are found overlapping a given
segment, two coverage detail items will be returned (the segment and employee
information duplicated).
For the RetrieveUnderCoverage action [TBD],

The OverSpan element describes a suggested transfer span : a subset of the
undercoverage span for which there is an overcoverage span in another
organization job.
Type: OverCoverageSpan tag
Output only
Sample values:
<OverCoverageSpan
OrgJobPath="Organization/Hospitals/Hosp A/
Floor 1/ER/RN"
StartDayNumber="1"
EndDayNumber="1"
StartTime="3:00PM"
EndTime ="5:00PM"
Duration="2:00" />

Chapter 2
ShiftSegment
Shift Segment
Segment overlapping an overcoverage period (RetreiveOverCoverage response),
or segment which a suggested transfer span employee is currently working
(RetreiveUnderCoverage response).
Type: ShiftSegment tag
Output only
Sample values:
<ShiftSegment
StartDate="7/03/2007"
EndDate="7/03/2007"
StartTime="9:00AM"
EndTime="5:00PM"
StartDayNumber="1"
EndDayNumber="1"
SegmentTypeName="REGULAR" /
Introduced in v6.1
UnderCoverageSpan
Under Coverage Span
For the RetrieveOverCoverage action,
The UnderSpan element describes a suggested transfer span : a subset of the
overcoverage span for which there is an undercoverage span in another
organization job which the employee can cover.
For the RetrieveUnderCoverage action [TBD],

The UnderSpan element describes an undercovered span for a given organixzation
job. If several undercoverage spans exist for the job, two coverage detail items
will be returned.
Type: UnderCoverageSpan tag
Output only
Sample values:

Chapter 2
<UnderCoverageSpan
OrgJobPath="Organization/Hospitals/Hosp A/
Floor 2/Maternity/RN"
StartDayNumber="1"
EndDayNumber="1"
StartTime="3:00PM"
EndTime ="4:00PM"
Duration="1:00" />

Chapter 2
AssignmentDispatchEngine Tag
Schedule Assignments
Returns a list of assignment detail items (shift segments with associated over
coverage information) for the given date, time span, and orgJobs.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveOverCoverage"
Parameters→
None
Properties→
<AssignmentDispatchEngine
QueryDate = Date
TimeSpan = DateTimeSpan >
(<AssignmentDetails>
<AssignmentDetail>*
</AssignmentDetails>)
<OrgPaths>
<SimpleValue>*
</OrgPaths>
</AssignmentDispatchEngine>
Action Descriptions
RetrieveOverCoverage
Obtains the Assignment information (segments and associated over/
undercoverage information) for the locations, period and indicators provided.

Chapter 2
Return Value Type: AssignmentDispatchEngine tag

Required Properties: QueryDate, TimeSpan, OrgPaths
Introduced in v6.1
AssignmentDetails
Assignment Details
List of over detail items. This is in fact a list of Assignment Detail objects.
Type: Zero or more AssignmentDetail tags
Output only
OrgPaths
Location Paths
List of organization nodes or leaves to consider
Required
Sample values:
<OrgPaths>
<SimpleValue Value="Organization/Hospitals/Hosp
A/Floor 1"/>
<SimpleValue Value=""Organization/Hospitals/
Hosp A/Floor 2"/>
</OrgPaths>

QueryDate
Date
Date for which segment spans are requested.
Type: Date
Required

Chapter 2
Sample values:
QueryDate="01/02/2007"

TimeSpan
Time Span
Time span for which segment spans are requested.
Type: DateTimeSpan
Required
Sample values:
TimeSpan="4:00-6:00"

Chapter 2
AssignmentEmployee Tag
Schedule Assignments Employee
Employee for which coverage detail is given within AssignmentDispatchEngine
API response.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<AssignmentEmployee
(Name = String)
(PersonNumber = String) >
</AssignmentEmployee>
Name
Employee Name
Employee full name
Type: String
Output only
Sample values:
Name="Smithson, Danielle"

Chapter 2
PersonNumber
Employee Number
Employee number
Type: String
Output only
Sample values:
PersonNumber="256"

Chapter 2
Attribute Tag
Attribute for process or task
The Attribute tag identifies an attributes for either a process or a task.
Used by: Process, ProcessTask
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<Attribute
Name = String
Value = String >
</Attribute>
Name
Attribute name
Name of the attribute. Each attribute must contain both a name and a value.
Type: String
Required Key
Sample values:
HRAdministrator
Introduced in v5.1

Chapter 2
Value
Attribute value
The value for the attribute. Each attribute must contain both a name and a value.
Type: String
Required
Introduced in v5.1

Chapter 2
AuditItem Tag
Audit Item
This tag provides audit information that results from making a change to an
audited data item.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<AuditItem
(AfterImage = String)
(AssociatedId = Long)
(AssociatedName = String)
(AuditAction = String)
(AuditBeginDtm = DateTime)
(AuditEndDtm = DateTime)
(AuditType = String)
(BeforeImage = String)
(EnteredOnDtm = DateTime)
(<AuditItemChildren>
<AuditItem>*
</AuditItemChildren>)
(<DataSource>
<DataSource>
</DataSource>)
</AuditItem>

Chapter 2
AfterImage
After image
The value of the audited information after the change.
Type: String
Output only
Introduced in v6.0
AssociatedId
Associated ID
The database ID of the employee whose information was changed.
Type: Long
Output only
Introduced in v6.0
AssociatedName
Associated name
The name of the database table that has changed.
Type: String
Output only
Introduced in v6.0
AuditAction
Audit action
The user action that caused the change, such as create, modify, or delete. Always
one of the values in the database table AUDITACTION, column
AUDITACTIONNM.
Type: String
Output only
Sample values:
CREATE or MODIFY or DELETE
Introduced in v6.0

Chapter 2
AuditBeginDtm
Audit begin date time
The date and time that the audited action began.
Type: DateTime
Output only
Introduced in v6.0
AuditEndDtm
Audit end date time
The date and time that the audited action finished.
Type: DateTime
Output only
Introduced in v6.0
AuditItemChildren
Audit item children
The audited changes that logically belong to this audit item. Audit item children
can also have their own children. You can change many person attributes, such as
the primary job and the job transfer set, simultaneously. These changes would be
children of a parent audit item. One change that affects multiple database tables is
also represented as a parent/child audit item relationship.
Type: Zero or more AuditItem tags
Output only
Introduced in v6.0
AuditType
Audit type
The general functional area where the change occurred. This information is
derived from the AUDITTYPEdatabase table in the column labelled
AUDITTYPENM.
Type: String
Output only
Sample values:

Chapter 2
Person Access Assignment or Schedule Validation Rules
Introduced in v6.0
BeforeImage
Before image
The value of the audited information prior to the change. The value is blank if the
change is a creation.
Type: String
Output only
Introduced in v6.0
DataSource
Data source
The user name and machine responsible for the audited change.
Type: DataSource tag
Output only
Introduced in v6.0
EnteredOnDtm
Entered on date time
The date and time that the audit information itself (not the change being audited)
was saved to the database.
Type: DateTime
Output only
Introduced in v6.0
PersonNumber
Person number
The employee identification number of the person whose information was
changed.
Type: String
Output only

Chapter 2
Introduced in v6.0

Chapter 2
AuditTrail Tag
Audit Trail
This tag provides information collected from the database about audited items.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveAuditTrail"
Parameters→
None
Properties→
<AuditTrail
DateSpan = DateSpan
DateTimeSpan = DateTimeSpan
[AuditType = String]
(<AuditItems>
<AuditItem>*
</AuditItems>)
</AuditTrail>
Action Descriptions
RetrieveAuditTrail
Retrieves an AuditTrail element whose AuditItems reflect the date span, date time
span, audit type, user name, and person number specified.
Return Value Type: AuditTrail tag

Chapter 2
Required Properties: DateSpan, DateTimeSpan

Optional Properties: AuditType, UserName, PersonNumber
Introduced in v6.0
DateSpan
Date Span
The dates used to query requested audits. Audits occuring on these dates will be
retrieved from the database.
Type: DateSpan
Introduced in v6.0
DateTimeSpan
Date time span
The date and times on which audits occurred. Audits made in this range will be
retrieved from the database. If this date time span is used, the times must be
entered. If you want just a day, use the DateSpan property.
Type: DateTimeSpan
Introduced in v6.0
AuditItems
Audit items
The list of heirarchical audit item information retrieved from the database.
Type: Zero or more AuditItem tags
Output only
Introduced in v6.0
AuditType
Audit type
The general functional area where the change occurred. This information is
derived from the AUDITTYPEdatabase table in the column labelled
AUDITTYPENM.

Chapter 2
Type: String
Optional
Introduced in v6.0
PersonNumber
Person number
The employee identification number of the person whose information was
changed.
Type: String
Optional
Introduced in v6.0
UserName
User Name
The user name of the person making the changes. The audit items that are
retrieved from the database will consist of information changed by this user.
Type: String
Optional
Introduced in v6.0

DateSpanOrDateTimeSpan
Either the DateSpan or the DateTimeSpan, but not both.
Required
Group includes: DateSpan, DateTimeSpan

Chapter 2
AuthenticationType Tag
Authentication Type
The AuthenticationType tag retrieves all AuthenticationType objects.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveAll"
Parameters→
None
Properties→
<AuthenticationType
(AuthTypeName = String) >
</AuthenticationType>
Action Descriptions
RetrieveAll
Retrieves all AuthenticationType objects from the database.
None
Return Value Type: Zero or more AuthenticationType tags
Introduced in v5.1

Chapter 2
AuthTypeName
Authentication type
Name of the authentication type.
Type: String
Output only
Introduced in v5.1

Chapter 2
BadgeAssignment Tag
Badge Assignment
The BadgeAssignment tag assigns a badge number to an employee.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadBadgeAssignments"
Parameters→
None
Properties→
<BadgeAssignment
BadgeNumber = String
[ExpirationDate = DateTime] >
<Identity>
</Identity>
[<Period>
<TimeFramePeriod>
</Period>]
</BadgeAssignment>
Action Descriptions

Chapter 2
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.
Return Value Type: Zero or more BadgeAssignment tags
Required Properties: Identity
Optional Properties: Period
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
Must be unique for the specified date span. Validation is done after a person is
associated with a badge, using the PersonInformation tag.

Chapter 2
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
Default value: If only the date is specified, the time defaults to 12:00am; that is,
midnight.
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
Identity
Identity
The person to whom the badge number is assigned, as specified in a
Optional Key
Must uniquely identify a person.

Chapter 2
Period
Time period
The time span that is associated with the badge assignments.
Optional
The specified identity is used when the time frame requires an association with a
person.
Used for the LoadBadgeAssignments action.
Default value: From the current date until January 1, 3000
Introduced in v5.0

Chapter 2
BaseWageRate Tag
Base Wage Rate
The BaseWageRate tag is used to modify the hourly rate of an employee, effective
as of a specific date or to view the wage rate history within a specified timeframe.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadBaseWageRateHistory"
Parameters→
None
Properties→
<BaseWageRate
(ExpirationDate = Date)
HourlyRate = Currency
(Period = DateSpan) >
<Identity>
</Identity>
</BaseWageRate>
Action Descriptions
LoadBaseWageRateHistory
This action loads the wage rate history for a person. If no time period is specified,
the entire history is loaded, beginning with the rate that is from the start of time to

Chapter 2
end of time including any future rates. If a time period is specified, the rates that
are in effect as of the start and end dates will be loaded.
Return Value Type: (***undefined***): BaseWageRateEdit
EffectiveDate
Effective date
The effective date determines when the new rate will be applied.
Type: Date
Required
Sample values:
11/23/2005
Default value: today

Introduced in v5.2
ExpirationDate
Expiration date
This property is returned when the base wage rate history is loaded. It indicates
the day on which a wage rate expires.
Type: Date
Output only
The value must represent a date.
Sample values:
12/02/2005

Chapter 2
Introduced in v5.2
HourlyRate
Hourly rate
The hourly rate represents the new value of an employee's hourly wage. It will go
into effect on the effective date.
Type: Currency
Required
Sample values:
10.15
Introduced in v5.2
Identity
Identity
This property identifies the employee when the LoadBaseWageRateHistory action
is used.
Optional Key
Introduced in v5.2
Period
Period
The time period that is optionally used with the LoadBaseWageRateHistory action
in order to limit the timeframe of the base wage rate history.
Type: DateSpan
Output only
Introduced in v5.2

Chapter 2
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.
Introduced in v5.0a; last changed in v5.0a
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"ApplyBidNotes" |
"DeleteBidNotes"
Parameters→
None
Properties→
<Bid
BidId = Long
BidGroupItemId = Long
Priority = Integer
(Status = String) >
[<BidNotes>
<BidNote>*
</BidNotes>]
</Bid>

Chapter 2
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.
Required Properties: BidId, BidNotes
Introduced in v5.0; last changed in v5.0a
DeleteBidNotes
Deletes all bid notes associated with the bid represented by this bid bean.
For the DeleteBidNotes Action, the BidId property MUST be defined.
Required Properties: BidId
BidGroupItemId
Bid group item Id
Id of the bid group item that this bid belongs to.
Type: Long
Required Key
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:

Chapter 2
<VacationBid BidGroupItemId="3" Priority="5"

StartDate="04/01/2004 00:00:00" EndDate="05/01/2004
11:48:56" HoursPerDay="288000"
CreateOpenShift="false">
</VacationBid>

BidId
Bid Id
Unique identifier for this bid.
Type: Long
Required Key
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.
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>

Chapter 2

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:
11:48:56" HoursPerDay="288000"
</VacationBid>

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.
Sample values:
Submitted - 0, Approved - 1, Rejected - 2
Default value: Submitted, 0

Enumerated value: Submitted - 0, Approved - 1, Rejected - 2

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"Load" |
"LoadByBidRequest" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<BidGroup
BidGroupId = Long
Name = String
BidRequestId = Long
CloseDate = DateTime
[NotificationText = String]
OpenDate = DateTime
ShiftOverride = Boolean >
</BidGroup>

Chapter 2
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
Delete
Deletes a bid group.
For the Delete Action, the BidGroupId MUST be specified and set to a valid
BidGroupId value.
Required Properties: BidGroupId
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

Chapter 2

LoadByBidRequest
Loads all bid groups for a given bid request.
For the LoadByBidRequest Action, the BidRequestId property MUST be
specified and set to a valid id for a BidRequest.
Return Value Type: Zero or more BidGroup tags
Required Properties: BidRequestId
Update
Updates or inserts a bid group depending respectively on whether a bid group
having the specified BidGroupId, already exists or not. When the update implies
addition of a new bid group, the BidGroupId, if any, if specified, is ignored.
For Update Action, the BidGroupId property, the BidRequestId property, the
OpenDate property, and the CloseDate property all MUST be specified for the
Update Action.
Required Properties: BidGroupId, BidRequestId, OpenDate, CloseDate
Optional Properties: ShiftOverride, NotificationText
UpdateOnly
Updates a bid group given its BidGroupId.
For the UpdateOnly Action, the BidRequestId MUST NOT be specified. The
BidGroupId property MUST be specified, and the BidGroupId specified MUST
be a valid id for a Bid Group.
Optional Properties: Name, Description, OpenDate, CloseDate, ShiftOverride,
NotificationText

Chapter 2

BidGroupId
Bid Group Id
Identifies a unique bid group.
Type: Long
Required Key
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.
BidRequestId
Bid Request Id
Identifies the parent bid request.
Type: Long
Required Key
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.
CloseDate
Close Date
Date on which bidding closes.
Type: DateTime
Required

Chapter 2
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"

Description
Bid Group Description
Description for bid group.
Type: String
Optional
If defined for an Action, the Description property cannot be null.
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.
NotificationText
Notification Text
Text of the notification sent when the parent bid request is sent to the bidding
participants.
Type: String
Optional

Chapter 2
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.
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"

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.
Sample values:
"true" OR "false"
Default value: "false"


Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddBids" |
"AddOnly" |
"Delete" |
"Load" |
"LoadByBidGroupAndPerson" |
"RemoveBids"
Parameters→
None
Properties→
<BidGroupItem
BidGroupId = Long
BidGroupItemId = Long
(BidSubmissionStatus = String)
[BidReceived = DateTime]

Chapter 2
[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
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
Required Properties: BidGroupId, PersonId
Optional Properties: LastSubmitted, BidReceived
Delete
Deletes a bid group item given its BidGroupItemId.
For the Delete Action, the BidGroupItemId MUST be specified.

Chapter 2

Load
Loads the specific bid group item given its BidGroupItemId.
For the Load Action, the BidGroupItemId must be specified.
LoadByBidGroupAndPerson
Retrieves the specific bid group item given the BidGroupId and PersonId.
For the LoadByBidGroupAndPerson Action, the BidGroupId and PersonId
property must be specified.
Required Properties: BidGroupId, PersonId
Optional Properties: BidGroupItemId, LastSubmitted, BidReceived
RemoveBids
Remove bids from a bid group item specified by the BidGroupItemId.
For the RemoveBids Action, the BidGroupItemId property and the BidList
property MUST be specified.

Chapter 2

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 Key
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.
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 Key
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.
BidList
Bid List
List of Bids to add to the bid group item.

Chapter 2
Type: Zero or more VacationBid tags

Optional
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.
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"

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.
Default value: Not Submitted
Enumerated value: 1 - Not Submitted, 2 - Submitted, 3 - Declined To Submit

Chapter 2
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"

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 Key
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.

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<BidNote
Text = String
Sequence = Integer >
</BidNote>
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:

Chapter 2
<BidNotes>
<BidNote Sequence="1" Text="This text is for vacation
bid with Id=501"> </BidNote>
</BidNotes>

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.

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"Load" |
"LoadByManager" |
"PostToSchedule" |
"SendToParticipants" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<BidRequest
[PeriodStartDate = DateTime]
BidRequestId = Long
[Name = String]
Type = String
GroupScheduleProfileName = String
[MaxBids = Integer]

Chapter 2
[NotificationDate = DateTime]
[PeriodEndDate = DateTime]
SchedulePatternProfileName = String
ShfitCodeProfileName = String
(Status = 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
Delete
Deletes a bid request given the BidRequestId.
For the Delete Action, the BidRequestId property MUST be specified.

Chapter 2
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.
Return Value Type: BidRequest tag
LoadByManager
Retrieves a list of bid requests corresponding to the specified Manager. Properties
other than the Manager property, if specified, will be ignored.
For the LoadByManager Action, the Manager property MUST be specified.
Return Value Type: Zero or more BidRequest tags
Required Properties: Manager
PostToSchedule
Posts the bid request for the specified BidRequestId to schedule. Properties other
than the BidRequestId property, if specified, are ignored.
For the PostToSchedule Action, the BidRequestId property MUST be specified.
SendToParticipants
Posts the bid request for the specified BidRequestId to schedule. Properties other
than the BidRequestId, if specified, are ignored.
For the SendToParticipants Action, the BidRequestId property MUST be
specified.

Chapter 2

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.
Required Properties: BidRequestId, Manager, PeriodStartDate, PeriodEndDate,
Name, MaxBids, Type, Either VacationPayCodeName, ShiftCodeProfileName,
SchedulePatternProfileName, or GroupScheduleProfileName
Optional Properties: Description, NotificationDate
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.
Optional Properties: Manager, PeriodStartDate, PeriodEndDate, Name,
Description, MaxBids, NotificationDate, Type and Either
VacationPayCodeName, ShiftCodeProfileName, SchedulePatternProfileName,
GroupScheduleProfileName

Chapter 2

BidRequestId
Bid Request Id
Identifies a unique bid request.
Type: Long
Required Key
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.
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.
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 Key

Chapter 2
If defined for an Action, the GroupScheduleProfileName cannot be null. If the

Type property is set to the shift by group schedule bidding type, then the
GroupScheduleProfileName MUST be defined, and the VacationPayCodeName
and other 2 Profile Names NOT.
Manager
Bid Request Owner
Owner of bid request.
Type: PersonIdentity tag
Required Key
If defined for an Action, the Manager property cannot be null. The PersonIdentity
tag must be specified in the Manager property. The Manager property MUST be
specified for the AddOnly and the LoadByManager Actions.
Sample values:
<Manager>
<PersonIdentity PersonNumber="207">
</PersonIdentity>
</Manager>

MaxBids
Max Bids
Maximum number of bids allowed.
Type: Integer
Optional
If the property is defined for an Action, the MaxBids property cannot be null. The
MaxBids property MUST be greater than or equal to 1. The MaxBids property
MUST be specified for the AddOnly Action.

Chapter 2
Name
Bid Request Name
Name for the bid request.
Type: String
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
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"

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"

Chapter 2

PeriodStartDate
Bid Period Start Date
Start Date for the target bidding period.
Type: DateTime
Optional
If defined for an Action, the PeriodStartDate cannot be null. The PeriodStartDate
property MUST be specified for the AddOnly Action.
Sample values:
"04/20/2004 00:00:00"

SchedulePatternProfileName
Schedule Pattern Profile Name
Name of Access Profile that governs the set of Schedule Patterns from which
bidding participants can choose. Applies only to bidding type 'Shift By Pattern'.
Type: String
Required Key
If defined for an Action, the SchedulePatternProfileName cannot be null. If the
Type property is set to the shift by pattern bidding type, then the
SchedulePatternProfileName MUST be defined, and the VacationPayCodeName
and other 2 Profile Names NOT.
ShfitCodeProfileName
Shift Code Profile Name
Name of Access Profile that governs the set of Shift Codes from which bidding
participants can choose. Applies only to bidding type 'Shift By Day'.
Type: String
Required Key

Chapter 2
If defined for an Action, the ShiftCodeProfileName cannot be null. If the Type

property is set to the shift by day bidding type, then only the
ShiftCodeProfileName MUST be specified, the VacationPayCodeName and other
2 Profile Name properties MUST NOT.
Status
Status
Status for bid request.
Type: String
Output only
The Status property MUST NOT be defined or specified for any BidRequest
Action.
Default value: 0 - Not Ready
Enumerated value: 0 - Not Ready, 1 - Ready, 2 - Done, 3 - Posted
Type
Bid Type
Identifies the bidding type.
Type: String
Required Key
If defined for an Action, the Type property cannot be null. The Type property can
only be 1 of 4 Bidding Types - Vacation, Shift By Day, Shift By Pattern, or Shift
By Group Schedule. The Type property MUST be specified for the AddOnly
Action.
VacationPayCodeName
Vacation Pay Code Name
Name of Pay Code to use for vacation. Applies only for bidding type 'Vacation'.
Type: String
Required Key

Chapter 2
If defined for an Action, the VacationPayCodeName cannot be null. If the Type

property is set to the vacation bidding type, then only the VacationPayCodeName
MUST be specified, the other 3 ProfileName properties MUST NOT be defined.

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadAccruals"
Parameters→
None
Properties→
<BulkAccruals
AccrualCodeNames = String >
(<EmployeeSummary>
<EmployeeSummary>
</EmployeeSummary>)
<Employees>
<PersonIdentity>
</Employees>
<Period>
<TimeFramePeriod>
</Period>
</BulkAccruals>
Action Descriptions

Chapter 2
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
Introduced in v4
AccrualCodeNames
Accrual code names
A comma-separated list of accrual code names. The accrual codes are created in
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
Sample values:
Vacation, Sick
Introduced in v4
Employees
Employees
One or more people, as specified in a PersonIdentity tag, for whom accruals are
requested.
Required
Introduced in v4

Chapter 2
EmployeeSummary
Employee Summary
The Employee Summary contains either accruals or totals for an employee along
with PersonNumber.
Type: EmployeeSummary tag
Output only
Introduced in v5.2
Period
Time period
Two timeframes are supported:
• 1 or Current_Pay_Period
• 13 or Today
Required
Enumerated value: 1, 13

Chapter 2
BulkTotals Tag
Bulk Totals
The BulkTotals tag identifies a list of employees, a list of pay code names, and a
time period.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadPayCodeTotals"
Parameters→
None
Properties→
<BulkTotals
PayCodeNames = String >
(<EmployeeSummary>
<EmployeeSummary>
</EmployeeSummary>)
<Employees>
<PersonIdentity>
</Employees>
<Period>
<TimeFramePeriod>
</Period>
</BulkTotals>
Action Descriptions
LoadPayCodeTotals
Returns totals for a given list of employees in their respective current pay periods.

Chapter 2
Return Value Type: Zero or more EmployeeSummary tags

Required Properties: Employees, PayCodeNames, Period
Introduced in v4
Employees
Employees
One or more people, as specified in a PersonIdentity tag, for whom totals are
requested.
Required
Introduced in v4
EmployeeSummary
Employee Summary
The Employee Summary contains either accruals or totals for an employee along
with PersonNumber.
Type: EmployeeSummary tag
Output only
PayCodeNames
Pay codes
A comma-separated list of pay code names
Type: String
Required
Introduced in v4
Period
Time period
Two timeframes are supported:

Chapter 2
• 1 or Current_Pay_Period
• 13 or Today
Required
Default value: 1, 13

Chapter 2
C Tag
Time Off Request Item Bean
A time off request bean
Introduced in v6.1
Syntax
None

Chapter 2
CalendarProfile Tag
Calendar Profile
This tag creates a calendar profile. Calendar profiles are the basis for the calendars
that are displayed for managers or employees. A calendar profile includes one or
more generic calendars, or it can include a calendar data set associated with a
specific application such as timekeeping or scheduling.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"RetrieveAll" |
"RetrieveAllByName" |
"RetrieveAllByNameAndActive" |
"RetrieveById" |
"RetrieveByName" |
"Update"
Parameters→
None
Properties→
<CalendarProfile
Name = String
[GenericEmployeeCalendarNames = String list]
[GenericManagerCalendarNames = String list]
[Active = Boolean] >
[<ApplicationCalendars>
<ApplicationCalendar>*

Chapter 2
</ApplicationCalendars>]
</CalendarProfile>
Action Descriptions
Add
Creates or modifies a calendar profile. If a calendar profile exists with the same
name, it is modified. If no calendar profile with that name exists, a new one is
created.
Required Properties: Name, Description, Active
Optional Properties: GenericEmployeeCalendarNames,
GenericManagerCalendarNames, ApplicationCalendars
AddOnly
Adds a calendar profile. If a calendar profile exists with the same name, the
operation will fail.
Required Properties: Name, Description, Active
Optional Properties: GenericEmployeeCalendarNames,
GenericManagerCalendarNames, ApplicationCalendars
Delete
Deletes an existing calendar profile. The operation will fail if the calendar profile
doesn't exist.

Chapter 2
RetrieveAll
Returns all calendar profiles.
Return Value Type: Zero or more CalendarProfile tags
RetrieveAllByName
Searches for calendar profiles by name and returns a list of calendar profiles.
RetrieveAllByNameAndActive
Searches for calendar profiles by name and active, and returns a list of calendar
profiles.
Required Properties: Name, Active
RetrieveById
Returns the specified calendar profile. The operation will fail if the calendar
profile doesn't exist.
Return Value Type: CalendarProfile tag
RetrieveByName
Returns the specified calendar profile. The operation will fail if the calendar
profile doesn't exist.
Return Value Type: CalendarProfile tag

Chapter 2

Update
Updates an existing calendar profile. If the calendar profile doesn't exist, it will be
added.
Optional Properties: NewName, Description, Active,
GenericEmployeeCalendarNames, GenericManagerCalendarNames,
ApplicationCalendars
Active
Is the calendar profile active?
True if the calendar profile is active, false if it is inactive.
Type: Boolean
Optional
Sample values:
True
False

ApplicationCalendars
Application calendars
The list of the application calendars in a calendar profile.
Type: Zero or more ApplicationCalendar tags
Optional

Chapter 2

Description
Description
The description of a calendar profile.
Type: String
Optional
GenericEmployeeCalendarNames
Generic employee calendar names
The names of the generic employee calendars in a calendar profile.
Type: String list
Optional
GenericManagerCalendarNames
Generic manager calendar Ids
The names of the generic manager calendars in a calendar profile.
Type: String list
Optional
Name
Calendar profile name
The unique name of a calendar profile.
Type: String
Required Key

Chapter 2
CalendarProfileAPIFacade Tag
Calendar Profile
This tag is the basis for the calendars that are displayed for managers or
employees. A calendar profile typically includes one or more generic calendars,
but you can also create a calendar profile that does not include any generic
calendar.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<CalendarProfileAPIFacade
Name = String >
</CalendarProfileAPIFacade>
Action Descriptions
RetrieveAllNames
Retrieves all names of calendar profiles.

Chapter 2
Introduced in v5.2
RetrieveForUpdate
Retrieves the calendar profile corresponding to the specified name.
Return Value Type: CalendarProfileAPIFacade tag
Introduced in v5.2
Update
Updates the calendar profile
Introduced in v5.2
Name
Calendar profile name
The calendar profile name.
Type: String
Required
Introduced in v5.2

Chapter 2
CallListEmployee Tag
Employee on Call List
This tag provides a list of employees that are qualified and available to fill an open
shift.
Introduced in v6.0
Syntax
None

Chapter 2
CallListOpenShift Tag
Open Shift from Call List
This tag provides a list of open shifts that a qualified and available employee can
fill.
Introduced in v6.0
Syntax
None

Chapter 2
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.
Introduced in v4; last changed in v5.0a
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<CancelDeductions
Date = Date
[ManagerName = String]
Time = Time >
<Employee>
</Employee>
</CancelDeductions>
Action Descriptions

Chapter 2
Update
Flags the indicated shift so that automatic deductions are not applied to the totals
for that shift.
Required Properties: Employee, Date, Time
Introduced in v4
Date
Date of cancellation
The date of the cancellation.
Type: Date
Required
Introduced in v4
Employee
Employee
One employee whose deductions are being canceled, as specified in a
Required
Introduced in v4
ManagerName
Manager name
The name used to replace the user name in audit.
Type: String
Optional

Chapter 2
Introduced in v5.0a
Time
Time of cancellation
The time of the cancellation. 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 cancellation has no effect.
Type: Time
Required
Introduced in v4

Chapter 2
CascadeAccrualBalanceLimit Tag
Cascade Accrual Balance Limit
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. 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.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<CascadeAccrualBalanceLimit
[DayLimit = Double]
Limit = TimeDuration >
</CascadeAccrualBalanceLimit>
DayLimit
Day Limit
An amount of time in days. This is used for cascading rules that have a day
cascading pay code.
Type: Double
Optional

Chapter 2
Limit
Limit
An amount of time in hours. This is used for cascading rules that have an hours
cascading pay code
Type: TimeDuration
Required
Introduced in v6.1

Chapter 2
CascadeProfile Tag
Cascade Profile
The profile object for Cascade Rules. This contains the collection of cascade rules
that can be assigned to an employee.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"Update"
Parameters→
Update→
[NewName = String]
Properties→
<CascadeProfile
[IsActive = Boolean]
Name = String >
[<CascadeProfileRules>
<CascadeProfileRule>
</CascadeProfileRules>]
</CascadeProfile>
Action Descriptions

Chapter 2
Delete
Deletes the specified cascade profile.
The name must be a valid cascade profile.
Introduced in v6.1
Retrieve
Retrieves a cascade profile, by name.
Return Value Type: CascadeProfile tag
Introduced in v6.1
Retrieve all cascade profiles.
Return Value Type: Zero or more CascadeProfile tags
Introduced in v6.1
RetrieveAllNames
Retrieves the names of all the cascade profiles.
Introduced in v6.1
RetrieveForUpdate
Retrieves a cascade profile, by name.
The name must be a valid cascade profile
Return Value Type: CascadeProfile tag

Chapter 2

Introduced in v6.1
Update
Updates the specified cascade profile, if it exists; otherwise the cascade profile is
added.
Optional Properties: Description, IsActive, CascadeProfileRules
Introduced in v6.1
Action Parameters

NewName New Name for the cascade profile Introduced in v6.1
Optional
CascadeProfileRules
Cascade profile rules
The liist of cascade rules in a profile.
Type: CascadeProfileRule tag
Optional
Description
Description
The description of the cascade profile.
Type: String

Chapter 2
Optional
IsActive
Active flag
Indicates whether the cascade profile is active.
Type: Boolean
Optional
Default value: true
Introduced in v6.1
Name
Name
The name of the cascade profile.
Type: String
Required Key
The length must be between 1 and 50 characters.

Chapter 2
CascadeProfileRule Tag
Cascade Profile Rule
A cascade rule associated with a cascade profile.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<CascadeProfileRule
CascadeRule = String >
</CascadeProfileRule>
CascadeRule
Cascade Rule Name
The cascade rule name.
Type: String
Required Key
It must be a valid cascade rule.
Introduced in v6.1

Chapter 2
CascadeRule Tag
Cascade Rule
The Cascade Rule tag is used by the Cascader to calculate cascaded takings.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"Update"
Parameters→
Update→
[NewName = String]
Properties→
<CascadeRule
[RemainderPayCode = String]
CascadePayCode = String
[DisregardAccrualRules = Boolean]
Name = String >
[<RootNode>
<CascadeRuleNode>
</RootNode>]
</CascadeRule>

Chapter 2
Action Descriptions
Delete
Deletes the specified Cascade Rule.
The name must be a valid Cascade Rule.
Introduced in v6.1
Retrieve
Retrieves a Cascade Rule, by name.
Return Value Type: CascadeRule tag
Introduced in v6.1
Retrieve all Cascade Rules.
Return Value Type: Zero or more CascadeRule tags
Introduced in v6.1
RetrieveAllNames
Retrieves the names of all the Cascade Rules.
Introduced in v6.1
RetrieveForUpdate
Retrieves a Cascade Rule, by name.

Chapter 2
Return Value Type: CascadeRule tag

Introduced in v6.1
Update
Updates the specified Cascade Rule, if it exists; otherwise the Cascade Rule is
added.
Optional Properties: IsActive, CascadePayCode, DisregardAccrualRules,
Description
Introduced in v6.1
Action Parameters

NewName New Name for the Cascade Rule Introduced in v6.1
Optional
CascadePayCode
Cascade pay code
The name of the pay code for which this cascade rule is valid.
Type: String
Required
This must be the name of an existing pay code of type cascade. The maximum
name length is 32 characters.
Introduced in v6.1

Chapter 2
Description
Description
The description of this cascade rule.
Type: String
Optional
The maximum length is 250 characters.
Introduced in v6.1
DisregardAccrualRules
Disregard accrual policies
If true, this cascade rule disregards accrual taking limits for validating takings.
Type: Boolean
Optional
Default value: true
Introduced in v6.1
IsActive
Active flag
Indicates whether the cascade rule is active.
Type: Boolean
Optional
Default value: true
Introduced in v6.1
Name
Name
The name of this cascade rule.
Type: String
Required Key
The maximum name length is 50 characters.
Introduced in v6.1

Chapter 2
RemainderPayCode
Apply uncascaded balance to
The pay code that the uncascaded balance will be applied to if the requested
amount was not satisfied by the other nodes in the policy.
Type: String
Optional
Introduced in v6.1
RootNode
Root node
The root node of the rule tree that eventually gets associated with a rule.
Type: CascadeRuleNode tag
Optional
Introduced in v6.1

Chapter 2
CascadeRuleNode Tag
Cascade Rule Node
The cascade rule node is the root node of the cascade rule tree.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<CascadeRuleNode
[<Children>
<LeaveDecisionNode> | <LeavePassThroughNode> |
<LeaveRuleNode> | <LeaveTakingNode>
</Children>]
</CascadeRuleNode>
Children
Children
A list of nodes that are children of the current node.
Type: Either LeaveDecisionNode, LeavePassThroughNode, LeaveRuleNode or
LeaveTakingNode tag
Optional
Introduced in v6.1

Chapter 2
CascadeTakingNode Tag
Cascade Taking Node
These nodes evaluate the accrual balances, and produce takings from the paycode
edits that are being processed.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<CascadeTakingNode
AccrualCode = String
[EnforceWarning = Boolean]
[PayCode = String] >
[<AccrualBalanceLimit>
<CascadeAccrualBalanceLimit>
</AccrualBalanceLimit>]
[<Children>
<LeaveDecisionNode> | <LeavePassThroughNode> |
<LeaveRuleNode> | <LeaveTakingNode>
</Children>]
</CascadeTakingNode>
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: CascadeAccrualBalanceLimit tag
Optional

Chapter 2
Introduced in v6.1
AccrualCode
Accrual Code
The name of an accrual code.
Type: String
Required
The name must match an exsiting Accrual Code that is defined in Workforce
Central Setup.
Introduced in v6.1
Children
Children
A list of nodes that are children of the current node.
Type: Either LeaveDecisionNode, LeavePassThroughNode, LeaveRuleNode or
LeaveTakingNode tag
Optional
Introduced in v6.1
EnforceWarning
Enforce Warning
Enforce Warning for Maximum Taking Limits if true. Ignore the warning if false.
Type: Boolean
Optional
Default value: true
Introduced in v6.1
PayCode
Pay Code
The name of a pay code.
Type: String
Optional

Chapter 2
The name must match an exsiting Pay Code that is defined in Workforce Central
Setup.
Introduced in v6.1

Chapter 2
CertificationItem Tag
Certification Item
The CertificationItem tag defines an item in the certification.
Used by: PersonCertificationAssign
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<CertificationItem
[Abbreviation = String]
Name = String
[IsActive = Boolean] >
</CertificationItem>
Abbreviation
Abbreviation for the certification item
Abbreviation for the certification
Type: String
Optional
Introduced in v5.0
IsActive
Is the rule type active?
If True, the specified rule type is active.

Chapter 2
Type: Boolean
Optional
Introduced in v5.0
Name
Certification item name
The unique name of the certification item
Type: String
Required
Introduced in v5.0

Chapter 2
CheckAdvice Tag
Earnings History
The CheckAdvice tag provides earnings history information for the specified
employee.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Update"
Parameters→
None
Properties→
<CheckAdvice
CheckNumber = String
CheckDate = Date
EndDate = Date
[GrossPay = String]
PaymentType = String
NetPay = String
StartDate = Date
[Taxes = String]
[TotalHours = String]
[Deductions = String] >
[<DirectDepositList>
<CheckAdviceDetailDirectDeposit>*
</DirectDepositList>]
<Employee>
</Employee>

Chapter 2
[<DeductionsList>
<CheckAdviceDetailDeductions>*
</DeductionsList>]
[<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
Required Properties: Employee, CheckNumber, CheckDate, NetPay, StartDate,
EndDate, PaymentType
Introduced in v5.0; last changed in v5.0; deprecated in v6.1
Update
Adds a pay stub to the database. If one already exists with the same key, it is
overwritten by the new one.
Required Properties: Required Properties
Introduced in v6.1

Chapter 2
CheckDate
Date of check
Payment date
Type: Date
Required
CheckNumber
Check number
The check number for this transaction
Type: String
Required Key
Deductions
Total of all deductions
The total amount of deductions that applied to the payment
Type: String
Optional
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.

Chapter 2
DirectDepositList
Direct deposit details
Details about the direct deposit of the check
Type: Zero or more CheckAdviceDetailDirectDeposit tags
Optional
Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag.
Required
EndDate
End date of pay period
The end date for the pay period for which the check is drawn
Type: Date
Required
GrossPay
Gross pay
The amount of the check before adjustments are made
Type: String
Optional

Chapter 2
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
NetPay
Net pay
The gross pay with adjustments, such as deductions and taxes, applied
Type: String
Required
PaymentType
Method of payment
The method of payment
Type: String
Required
Sample values:
Direct Deposit, Check

StartDate
Start date of pay period
The start of the pay period for which the check is drawn
Type: Date
Required

Chapter 2

Taxes
Taxes
Total amount of taxes for items identified as detail taxes that is deducted from the
gross payment
Type: String
Optional
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
TotalHours
Total hours
The total number of hours for which the employee is being paid
Type: String
Optional

Chapter 2
CheckAdviceDetailDeductions Tag
Earnings History - Deduction
The CheckAdviceDetailDeductions tag describes a deduction in the employee's
earnings history.
Used by: CheckAdvice
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<CheckAdviceDetailDeductions
Amount = String
Description = String
EmployeePaid = String
AmountYTD = String
EmployeePaidYTD = String >
</CheckAdviceDetailDeductions>
Amount
Amount of deduction
Amount of the specified deduction
Type: String
Required

Chapter 2
AmountYTD
Year to date total
A cumulative year to date amount for this deduction
Type: String
Required
Description
Description
An explanation of the deduction
Type: String
Required
EmployeePaid
Portion paid by employee
The portion of the deduction that is paid by the employee
Type: String
Required
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

Chapter 2
CheckAdviceDetailDirectDeposit Tag
Earnings History - Direct Deposit
The CheckAdviceDetailDirectDeposit tag describes details about a direct deposit.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<CheckAdviceDetailDirectDeposit
AccountNumber = String
Amount = String
RoutingNumber = String >
</CheckAdviceDetailDirectDeposit>
AccountNumber
Account number
The account number to which the direct deposit is posted.
Type: String
Required
Amount
Amount of deposit
Amount of the direct deposit

Chapter 2
Type: String
Required
Description
Description
An explanation of the item listed for the direct deposit
Type: String
Required
RoutingNumber
Routing number
The routing number of the bank to which the direct deposit is posted.
Type: String
Required

Chapter 2
CheckAdviceDetailGrossPay Tag
Earnings History - Gross Pay
The CheckAdviceDetailGrossPay tag identifies a gross pay detail.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<CheckAdviceDetailGrossPay
Amount = String
Date = Date
Hours = String
Rate = String
AmountYTD = String >
</CheckAdviceDetailGrossPay>
Amount
Amount of gross pay
Gross pay amount
Type: String
Required

Chapter 2
AmountYTD
Year to date total
Gross year to date pay amount
Type: String
Required
Date
Date of check
Date of the check
Type: Date
Required
Description
Description
The explanation that the specified amount is the gross pay
Type: String
Required
Hours
Hours paid
Number of hours for which payment is made
Type: String
Required
Must match an existing field definition name
Rate
Pay rate
Rate at which payment was made
Type: String

Chapter 2
Required

Chapter 2
CheckAdviceDetailTaxes Tag
Earnings History - Taxes
The CheckAdviceDetailTaxes tag describes details about a tax that is part of the
employee's earnings history.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<CheckAdviceDetailTaxes
Amount = String
TaxableWages = String
TaxesYTD = String >
</CheckAdviceDetailTaxes>
Amount
Amount of tax
Amount of the specified tax
Type: String
Required

Chapter 2
Description
Description
An explanation of the specified tax
Type: String
Required
TaxableWages
Taxable wages
Wages for which taxes are paid
Type: String
Required

TaxesYTD
Year to date total for taxes
The cumulative year to date taxes for this taxable item reported with this check
Type: String
Required

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadActiveComments" |
"LoadCommentCategories"
Parameters→
None
Properties→
<Comment
[CommentCategory = String]
(CommentText = String) >
[<Notes>
<Note>*
</Notes>]
</Comment>
Action Descriptions
LoadActiveComments
Returns a list of active comments.
Return Value Type: Zero or more Comment tags

Chapter 2

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
Introduced in v5.1
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
Sample values:
SHIFTS
Default value: null

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

Chapter 2
Introduced in v4
Notes
Comment Notes
The list of notes for the comment
Type: Zero or more Note tags
Optional
Introduced in v6.0

Chapter 2
ConnectToSchedule Tag
Schedule Import
The ConnectToSchedule tag imports an employee's scheduled shifts from another
application into the scheduler.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<ConnectToSchedule
<ConnectToScheduleItems>
<ConnectToScheduleItem>*
</ConnectToScheduleItems>
</ConnectToSchedule>
Action Descriptions
Update
Adds the specified items into schedule period
Required Properties: ConnectToScheduleItems
Introduced in v5.1

Chapter 2
ConnectToScheduleItems
Schedule items to import
One or more ConnectToScheduleItem tags. Taken together, these items define the
values that form a shift.
Type: Zero or more ConnectToScheduleItem tags
Required
Introduced in v5.1

Chapter 2
ConnectToScheduleItem Tag
Schedule Import Items
This tag contains schedule import elements that are used by another application to
import shifts into the Scheduler.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ConnectToScheduleItem
[CommentText = String]
[StartDate = Date]
EmployeeId = String
RequestCode = Integer
[Duration = TimeDuration]
[StartTime = Time]
[<Notes>
<Note>*
</Notes>]
</ConnectToScheduleItem>
CommentText
Comment
A comment about the shift
Type: String

Chapter 2
Optional
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 Key
Must identify an existing and active employee
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
Notes
Comment Notes
The list of notes for the comment to be created from comment text
Optional

Chapter 2
Introduced in v6.0
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
A code that represents a request, where: DELETE_CODE = 10;
BEGIN_SHIFT_CODE = 11; INSERT_BREAK_CODE = 12;
INSERT_TRANSFER_CODE = 13; END_SHIFT_CODE = 14;
OFF_DAY_CODE = 15; DELETE_SHIFT_CODE = 16;
INSERT_OFF_DAY_CODE_COMMENT = 17;
INSERT_SHIFT_CODE_COMMENT = 21; OFF_SHIFT_CODE = 41;
INSERT_OFF_SHIFT_CODE_COMMENT = 42.
Type: Integer
Required
Enumerated value: 10, 11, 12, 13, 14, 15, 16, 17, 21, 41, 42
StartDate
Date when a shift starts
The date when a shift starts
Type: Date
Optional
Introduced in v5.1
StartTime
Time when a shift starts
Time when a shift starts

Chapter 2
Type: Time
Optional
Introduced in v5.1
WorkRuleName
Work rule name
Name of the work rule
Type: String
Optional
Introduced in v5.1

Chapter 2
CoverageDetail Tag
Coverage Detail
This tag returns the daily coverage (required/scheduled) for the location and date
range selected for every job in locations and for every time span.
Syntax
None

Chapter 2
CoverageSettings Tag
Coverage settings
This tag determines how to calculate coverage measures and how to present them.
A coverage setting may be associated to each location type in the organizational
map.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"DeleteOnly" |
"Retrieve" |
"RetrieveAll" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<CoverageSettings
SettingsName = String
[Description = String] >
[<SettingsParamValues>
<SettingsParamValue>*
</SettingsParamValues>]
[<OrgPaths>

Chapter 2
<SimpleValue>*
</OrgPaths>]
</CoverageSettings>
Action Descriptions
Add
Add a coverage type setting object into the system. If it already exists an update is
performed.
Required Properties: SettingsName
Optional Properties: Description, SettingsParamValues, OrgPaths
Introduced in v6.0
AddOnly
Add a coverage type setting object into the system. If it already exists an error is
thrown.
Introduced in v6.0
Delete
Delete a coverage type settings object. If the object doesn't exist, no exception will
be thrown.
Introduced in v6.0

Chapter 2
DeleteOnly
Delete a coverage type settings object. If doesn't exist an exception is thrown.
Introduced in v6.0
Retrieve
Return the coverage type setting object by name.
Return Value Type: (***undefined***): CoverageSetting
Introduced in v6.0
RetrieveAll
Return all the coverage type setting objects.
Return Value Type: Zero or more CoverageSettings tags
Introduced in v6.0
Return a list of coverage type setting objects. This action is used for future
updates.
Return Value Type: Zero or more CoverageSettings tags
Introduced in v6.0
RetrieveAllNames
Return the coverage type setting name objects.
Return Value Type: (***undefined***): KBusinessObjectNameList
Introduced in v6.0

Chapter 2
RetrieveForUpdate
Return the coverage type setting object. This action is used for future updates.
Return Value Type: CoverageSettings tag
Introduced in v6.0
Update
Update the coverage type setting object.If it does not exist an add is performed.
Introduced in v6.0
UpdateOnly
Update a coverage type setting object. If it does not exist an error is thrown.
Introduced in v6.0
Description
Coverage settings object description
Specify a description for the coverage settings.
Type: String
Optional
Sample values:

Chapter 2
<CoverageSettings SettingsName="coverage setting 3"

Description="sample setting">

OrgPaths
Location paths
Specify the list of associated organizational location type paths.
Optional
Must be existing locations on current date, and must be accessible to user.
Sample values:
<OrgPaths>
<SimpleValue Value="Organization/Hospitals/Hosp A/
Floor 1" />
</OrgPaths>

SettingsName
Coverage settings name
Specify the coverage settings name.
Type: String
Required Key
Sample values:
<CoverageSettings SettingsName="coverage setting 3"
Description="sample setting">

SettingsParamValues
Coverage settings parameter values
Specify the coverage settings parameter values.
Type: Zero or more SettingsParamValue tags

Chapter 2
Optional
Sample values:
<SettingsParamValues>
<SettingsParamValue Name="PARAM" Value="Test"/>
</SettingsParamValues>

Chapter 2
CoverageSettingsValue Tag
Value of coverage setting parameter
This tag provides the coverage setting parameter associated with the organization
path given in the request.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveValue"
Parameters→
RetrieveValue→
orgPath = String
paramDefinitionName = String
Properties→
<CoverageSettingsValue
(Value = String) >
</CoverageSettingsValue>
Action Descriptions
RetrieveValue
Return a coverage setting value object.
Return Value Type: CoverageSettingsValue tag
Introduced in v6.0

Chapter 2
Action Parameters

orgPath Path of the location from which to find Introduced in v6.0
the setting and its parameter value.
Required
paramDefinitionName The name of parameter definition for Introduced in v6.0
which the value is requested.
Required
Must be an existing sched gen
parameter defintion
Value
Parameter value
value of the parameter specified in the request, read from the setting matching the
location specified in the request.
Type: String
Output only
Sample values:
<Response Status="Success" OrgPath="Organization/
Hospitals/Hosp A/Floor 3" Action="RetrieveValue"
ParamDefinitionName="PERFECTCOVERAGE_CELL_COLOR">
<CoverageSettingsValue Value="FFFFFF"/>
</Response>

Chapter 2
CoverShiftStatus Tag
Cover Shift Status
This tag represents result of daily status.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<CoverShiftStatus
(Date = Date)
(IsShiftExists = Boolean)
(IsShiftCovered = Boolean) >
(<RequestToCoverItems>
<RequestToCoverItem>*
</RequestToCoverItems>)
</CoverShiftStatus>
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.

Chapter 2
Type: Boolean
Output only
IsShiftExists
Does the shift exist?
This property holds the result of whether is the shift existing.
Type: Boolean
Output only
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

Chapter 2
CurrencyAssignment Tag
Currency Assignment
This tag is used for assigning currency to a user or an employee.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadCurrencyAssignment"
Parameters→
None
Properties→
<CurrencyAssignment
(<EmployeeAssignment>
<EmployeeCurrencyAssignment>
</EmployeeAssignment>)
<Identity>
<PersonIdentity>
</Identity>
(<UserAssignment>
<UserCurrencyAssignment>
</UserAssignment>)
</CurrencyAssignment>
Action Descriptions
LoadCurrencyAssignment
This is to load both employee and user's currency assignment for the given
Identity.

Chapter 2
Return Value Type: CurrencyAssignment tag

Introduced in v6.1
EmployeeAssignment
Employee Currency Assignment
Returns an employee's currency assignment with the currency code and currency
locale.
Type: EmployeeCurrencyAssignment tag
Output only
Introduced in v6.1
Identity
Identity
The identity of the user or employee to whom the currency is assigned.
Optional Key
UserAssignment
User Currency Assignment
Load user's currency assignment with currency code and currency locale
information.
Type: UserCurrencyAssignment tag
Output only
Introduced in v6.1

Chapter 2
CurrencyPolicy Tag
Currency Policy
Allows you to activate a currency and set a base currency in the suite application.
It is also used to supply the initial exchange rate for the activated currency and
allows you to update the exchange rate for a given span of dates.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveExchangeRates" |
"RetrieveExchangeRatesFromDate" |
"Update"
Parameters→
None
Properties→
<CurrencyPolicy
[ActiveSw = Boolean]
[BaseCurrencyCode = String]
CurrencyCode = String
[InitialExchangeRate = Double] >
(<CurrentExchangeRate>
<ExchangeRate>
</CurrentExchangeRate>)
[<ExchangeRates>
<ExchangeRate>*
</ExchangeRates>]

Chapter 2
</CurrencyPolicy>
Action Descriptions
Retrieve
Retrieves the Currency Policy object for the given currency code.
Validates the given currency code is valid.
Return Value Type: CurrencyPolicy tag
Required Properties: CurrencyCode
Retrieves all the Currency Policy objects in the system for update.
Return Value Type: Zero or more CurrencyPolicy tags
RetrieveAllNames
Returns all of the currency codes in the system.
RetrieveExchangeRates
Returns a list of exchange rates as children of the currency policy for the given
currency code.
Return Value Type: Zero or more CurrencyPolicy tags

Chapter 2
RetrieveExchangeRatesFromDate
Returns a list of exchange rates as a child of CurrencyPolicy from the startdate
using the given currencycode.
Validates the date and the CurrencyCode.
Return Value Type: String
Required Properties: CurrencyCode, startDate
RetrieveForUpdate
Retrieves the Currency Policy object identified by the currency code for update.
Return Value Type: CurrencyPolicy tag
Update
Updates the currency policy for a system. The BaseCurrencyCode property is
required the first time only. After the base currency is set, this property is not
required (because you might not be allowed to change the base currency). The
InitialExchangeRate property is also required, only for the first time, when
activating the currency. Optionally, you might want to provide a list of exchange
rates, in case you want to overide the InitialExchangeRate.
All propertues are validated.
Optional Properties: ActiveSw, BaseCurrencyCode, InitialExchangeRate,
ExchangeRates

Chapter 2
ActiveSw
Active Switch
Indicates whether the given currency is active in the system.
Type: Boolean
Optional
The only value possible is "true" or "false".
Sample values:
ActiveSw="true"

BaseCurrencyCode
Base Currency Code
Describes the base currency for which an exchange rate is stored.
Type: String
Optional
should be a standard currency code.
Sample values:
BaseCurrencyCode="USD"

CurrencyCode
Currency Code
Holds the currency code.
Type: String
Required Key
Validates the entered code is valid.
Sample values:
CurrencyCode="USD"

Chapter 2

CurrentExchangeRate
Current Exchange Rate
Gives the current exchange rate associated with the given currency code.
Type: ExchangeRate tag
Output only
ExchangeRates
Exchange Rates
Returns a list of exchange rates associated with a given currency code and the
base currency code. The date spans are based on whenever there was a rate
change.
Type: Zero or more ExchangeRate tags
Optional
Should satisy the exchange rate validation rules as specified in the Exchange rate
tag.
InitialExchangeRate
Initial Exchange Rate
The default exchange rate that is populated for the duration specified in the system
settings.
Type: Double
Optional
This should be a value greater than zero and should be one when the active the
currency code is also the base currency.

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadIdentities"
Parameters→
None
Properties→
<CurrentUser
EmployeeKey = Long
PersonKey = Long
UserKey = Long
</CurrentUser>
Action Descriptions

Chapter 2
LoadIdentities
Returns current user information for the logged on user.
Return Value Type: CurrentUser tag
Introduced in v4
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 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
Introduced in v4
EmployeeKey
Employee database key
The employee database key for the current user
Type: Long

Chapter 2
Maximum value = 2,147,488, 848

Must identify only one person
PersonKey
Person database key
The person database key for the current user
Type: Long
PersonNumber
Person number
Person number of the specified person
Type: String
Introduced in v4
UserKey
User database key
The database key for the current user
Type: Long

Identifier
A single value that identifies the current user
Required

Chapter 2
Group includes: BadgeNumber, EmployeeKey, PersonKey, PersonNumber,

UserKey

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<CustomData
Text = String
CustomDataTypeName = String >
</CustomData>
CustomDataTypeName
Type of custom data
The customer-defined label for custom string types. You must define the custom
data type first using the Setup Application. Then you can use this property to
specify custom strings.
Type: String
Required Key
Values for CustomDataTypeName are added to the system through the Setup
Application.

Chapter 2
A maximum of ten custom strings can be included for a person.

Sample values:
seniority number, mother's maiden name, Social Security
Number
Introduced in v4
Text
Text
The text of the custom string
Type: String
Required
Introduced in v4

Chapter 2
CustomDate Tag
Custom Date
The CustomDate tag denotes Date type information for a site-specified Date
category that can be assigned to a person.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<CustomDate
Date = Date
CustomDateTypeName = String >
</CustomDate>
CustomDateTypeName
Date name
Contains the name of a person-specific date for an employee
Type: String
Required Key
You can find values in the Workforce Timekeeper user interface.
Sample values:
401K Enrollment Date

Chapter 2
Introduced in v4
Date
Date
Specifies a custom date field to be used by the Person tag.
Type: Date
Required
Introduced in v4

Chapter 2
CustomOperator Tag
Sorting and Mathcing Rule Custom Operator
Gives access to sorting or matching rule's custom operator item objects of the
Priority Scheduling Engine.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<CustomOperator
OperatorName = String
Value = String >
</CustomOperator>
OperatorName
Custom operator name
Represents the name of a sorting or matching rule custom operator.
Type: String
Required Key
Introduced in v6.0
Value
Custom operator value
Represents the value of a sorting or matching rule custom operator.
Type: String
Required

Chapter 2
Introduced in v6.0

Chapter 2
CustomParameter Tag
Custom Parameter
This is an object that contains the custom name value tags to be used by the
Generic Notification trigger.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<CustomParameter
Name = String
Value = String >
</CustomParameter>
Name
Name
This is the name of the custom parameter used for the Generic Notification.
Type: String
Required
Introduced in v6.1
Value
Value
This is the value of the custom parameter used for the Generic Notification.
Type: String
Required

Chapter 2
Introduced in v6.1

Chapter 2
DailyEmployeeFirstShiftTime Tag
Daily Employee First Shift Time
The start and end time of the first shift, or the paycode edit.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<DailyEmployeeFirstShiftTime
(Date = Date)
(EmployeeId = Long)
(EndTime = DateTime)
(StartTime = DateTime) >
(<Employee>
<Personality>
</Employee>)
</DailyEmployeeFirstShiftTime>
Date
Date
Date of the day.
Type: Date
Output only
Introduced in v6.1

Chapter 2
Employee
Employee
The employee
Type: Personality tag
Output only
Introduced in v6.1
EmployeeId
Employee ID
ID of the employee.
Type: Long
Output only
Introduced in v6.1
EndTime
End time
The end time.
Type: DateTime
Output only
Introduced in v6.1
StartTime
Start time
The start time.
Type: DateTime
Output only
Introduced in v6.1

Chapter 2
DailyEmployeeTimeAttendance Tag
Daily Employee Time Attendance
The daily time attendance data for an employee, used in India Statutory Reports.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<DailyEmployeeTimeAttendance
(AttendanceStringForDay = String)
(Date = Date)
(EmployeeId = Long)
(FirstLeavePaycodeId = Long)
(FirstLeavePaycodeName = String)
(IsLeaveDay = Boolean)
(IsWorkedDay = Boolean)
(WorkStartTime = DateTime) >
(<Employee>
<Personality>
</Employee>)
</DailyEmployeeTimeAttendance>
AttendanceStringForDay
Attendance string for day
The string describes the employee's daily attendance status, such as "X" for a
working day, or the first character of the leave pay code, such as "S" for Sick day.
You can have a combination of work and leave pay codes applied to the same day,
such as "S/X".

Chapter 2
Type: String
Output only
Sample values:
"X", "S", "V", "S/X"
Introduced in v6.1
Date
Date
The date of the day.
Type: Date
Output only
Introduced in v6.1
Employee
Employee
The employee's personality data.
Output only
Introduced in v6.1
EmployeeId
Employee ID
The employee's ID.
Type: Long
Output only
Introduced in v6.1
FirstLeavePaycodeId
First leave pay code ID
The pay code ID of the first leave pay code total for that day.
Type: Long
Output only

Chapter 2
Introduced in v6.1
FirstLeavePaycodeName
First leave pay code name
The pay code name of the first leave pay code total for that day.
Type: String
Output only
Introduced in v6.1
IsLeaveDay
Is leave day
Indicates whether the employee has a leave pay code total for that day.
Type: Boolean
Output only
Sample values:
true, false
Enumerated value: true, false

Introduced in v6.1
IsWorkedDay
Is worked day
Indicates whether the employee has a work pay code total for that day.
Type: Boolean
Output only
Sample values:
true, false

Introduced in v6.1

Chapter 2
WorkStartTime
Work start time
The start time of the first work pay code total for that day.
Type: DateTime
Output only
Introduced in v6.1

Chapter 2
DataAccessGroup Tag
DataAccessGroup
This tag specifies the schedule group that users who are assigned a specific data
access profile can access and assign.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddGDAPItem" |
"AddOnly" |
"Delete" |
"DeleteAllGDAPItem" |
"DeleteGDAPItem" |
"Duplicate" |
"GetGDAPItemTypeList" |
"Retrieve" |
"RetrieveAll" |
"Update" |
"UpdateOnly"
Parameters→
Retrieve→
AllowItemList = Boolean
[GDAPItemType = String]
RetrieveAll→
AllowItemList = Boolean
[GDAPItemType = String]
UpdateOnly→
[NewName = String]

Chapter 2
Properties→
<DataAccessGroup
Name = String
<GDAPItemList>
<GDAPItem>*
</GDAPItemList>
</DataAccessGroup>
Action Descriptions
AddGDAPItem
Add GDAPItemList to the existing GDAP
The Retrieve method is the factory Action. Check whether GDAPItemList is
empty
Required Properties: Name, GDAPItemList
Introduced in v6.0
AddOnly
Create a new GDAP and Assign it the current User
Check whether the Name property already in the Database
Optional Properties: Description,GDAPItemList
Introduced in v6.0
Delete
Delete the GDAP and any associated GDAP Items

Chapter 2

Introduced in v6.0
DeleteAllGDAPItem
Delete all the GDAPItems that associated with this GDAP
Introduced in v6.0
DeleteGDAPItem
Delete the GDAP Items in the GDAPItemList
Required Properties: Name,GDAPItemList
Introduced in v6.0
Duplicate
The name of an existing Generic Data Access Profile that will be duplicated.
The Name should be the name of an existing Generic Data Access Profile.
Introduced in v6.0
GetGDAPItemTypeList
Return the dataAccessgroup object with an ArrayList of DAGEntity type it
contains.
Valid Generic Data Access group Profile Name is in user's context
Return Value Type: DataAccessGroup tag

Chapter 2

Retrieve
Get GDAP with all asociate GDAP items if the GDAPItemType=True and
GDAPItemType is not specified
Check whether the GDAP Name is in User's context
Action Parameters

AllowItemList set AllowItemList=TRUE to get Introduced in v6.0; last changed
GDAPItems showed in the response in v6.0
Required
Default value: False
GDAPItemType What kind of GDAPItemType you Introduced in v6.0
want to retrieve
Optional
RetrieveAll
Retrieves a list of Data Access Groups
Introduced in v6.0

Chapter 2
Action Parameters

AllowItemList set AllowItemList = true to indicate Introduced in v6.0; last changed
that you want the GDAP items in v6.0
showed in the response
Required
GDAPItemType What kind of GDAPItemType you Introduced in v6.0
want to retrieve
Optional
Default value: FALSE
Returns all Generic Data Access Profile for updating.
Return Value Type: Zero or more DataAccessGroup tags
Introduced in v6.0
RetrieveAllNames
Returns a list of the names of all Generic Data Access Profile in user's GDAP
context
RetrieveForUpdate
Returns the specified Generic Data Access Profile for updating.
Introduced in v6.0

Chapter 2
Update
Update the specified Generic Data Access Profile.
The specified Generic Data Access Profile must in database.
Introduced in v6.0
UpdateOnly
Update the GDAP with Description or change the GDAP with the NewName
Optional Properties: NewName, Description
Action Parameters

NewName DataAccessGroup Name . The new Introduced in v6.0; last changed
name should be unique. in v6.0
Optional
The new name should be unique.
Description
Description of the Data Access Group
Specity the description of the Data Access Group.
Type: String
Optional
Default value: NULL

Chapter 2
Introduced in v6.0
GDAPItemList
List of GDAP Items
Specify the list of generic data access profiles.
Type: Zero or more GDAPItem tags
Required
This list cannot be empty.
Name
Data Access Group Name
Specify a unique name for the Data Access Group. The name is also used by
Retrievel, AddOnly, Delete, UpdateOnly, DeleteGDAPItem,
DeleteAllGDAPItem, and GetGDAPItemTypeList.
Type: String
Required
The Name must be unique

Chapter 2
DataElementAPIFacade Tag
Calendar Data Element Facade
Creates or modifies Data Elements using the SDM API.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<DataElementAPIFacade
Name = String >
</DataElementAPIFacade>
Action Descriptions
RetrieveAllNames
Retrieves All Names
Introduced in v5.2
RetrieveForUpdate
Retrieve for update through SDM

Chapter 2
Return Value Type: DataElementAPIFacade tag

Introduced in v5.2
Update
Updates using SDM
Introduced in v5.2
Name
Name
Name
Type: String
Required Key
Introduced in v5.2

Chapter 2
DataSetAPIFacade Tag
Calendar setup data
Creates or modifies setup data for a calendar view.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<DataSetAPIFacade
Name = String >
</DataSetAPIFacade>
Action Descriptions
RetrieveAllNames
Retrieves All names of Calendar Data Set objects.
Introduced in v5.2
RetrieveForUpdate
Retrieves the Calendar Data Set object corresponding to the name.

Chapter 2
Return Value Type: DataSetAPIFacade tag

Introduced in v5.2
Update
Updates the Calendar data Set object corresponding to the name.
Introduced in v5.2
Name
Name of calendar view
Name of the calendar view to be created or changed.
Type: String
Required Key
Introduced in v5.2

Chapter 2
DataSource Tag
Data Source
The DataSource tag identifies the location and meaning of a Timesheet item.
Introduced in v4
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<DataSource
(ClientName = String)
(FunctionalAreaCode = Integer)
(ServerName = String)
(UserName = String) >
</DataSource>
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

Chapter 2
Output Only
Introduced in v4
ServerName
Server name
Name representing the server
Type: String
Output Only
Introduced in v4
UserName
User name
Name of the logged on user
Type: String
Output Only
Introduced in v4

Chapter 2
DateTotals Tag
Totals for a Date
The DateTotals tag returns a summary of totals for a particular date.
Used by: Timesheet
Introduced in v4
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<DateTotals
(Date = Date) >
(<Totals>
<TotalSummary>
</Totals>)
</DateTotals>
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

Chapter 2
Type: TotalSummary tag

Output only
Introduced in v4

Chapter 2
DayLockAuditItem Tag
Day Lock Audit Record
This tag represents an audit record of day locks.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<DayLockAuditItem
(Action = String)
(Date = Date)
(User = String) >
</DayLockAuditItem>
Action
Action
The audited action
Type: String
Output only
Sample values:
CREATE, DELETE, etc.
Introduced in v6.1

Chapter 2
DataSource
Data Source
The functional area of the user
Type: String
Output only
Sample values:
SCHEDULING

Date
Date
The day lock date
Type: Date
Output only
Introduced in v6.1
EditDateTime
Edit Date Time
The date and time of the audited action
Type: DateTime
Output only
Introduced in v6.1
PersonNumber
Person Number
The person number of the employee related to the day lock
Type: String
Output only
Introduced in v6.1

Chapter 2
User
User
The audited user into the format [User]:[Server]::[Client]
Type: String
Output only
Sample values:
Introduced in v6.1

Chapter 2
DeductRule Tag
Deduct Rule
The DeductRule tag provides information about deduct rules. The DeductRule
and WSABonusDeductRule tags refer to the same database object.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadAllDeductRules"
Parameters→
None
Properties→
<DeductRule
(DeductRuleName = String) >
</DeductRule>
Action Descriptions
LoadAllDeductRules
Returns all deduct rules in the system.
Return Value Type: Zero or more DeductRule tags

Chapter 2
DeductRuleName
Deduct rule name
Name of the deduct rule
Type: String
Output only
Must be unique

Chapter 2
DelegateAuthorityTask Tag
DelegateAuthorityTask
DelegateAuthorityTask describes a delegation task that was requested and
accepted by a delegate (proxy manager). A delegate can have delegation tasks
from more than one delegator (manager).
Use this tag to retrieve a delegate's delegation tasks.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveByProxyMgrPersonNumber"
Parameters→
RetrieveByProxyMgrPersonNumber→
Properties→
<DelegateAuthorityTask
(TaskString = String)
(EndDate = Date)
(TaskId = Long)
(RoleProfileId = Long)
(RoleName = String)
(MgrName = String)
(ProxyMgrName = String)
(ProxyMgrId = String)
ProxyMgrNumber = String
(MgrId = String)
(StartDate = Date) >
</DelegateAuthorityTask>

Chapter 2
Action Descriptions
RetrieveByProxyMgrPersonNumber
This action takes parameter PersonNumber of a delegate (the proxy manager). It
retrieves a list of delegation tasks for the delegate.
PersonNumber parameter is always required. This PersonNumber is the person
number for the delegate (the proxy manager).
Return Value Type: Zero or more DelegateAuthorityTask tags
Action Parameters

PersonNumber The person number for the delegate Introduced in v5.2
(the proxy manager).
Required
This parameter is always required for
the action.
EndDate
End date of a delegate task
End date of a delegate task.
Type: Date
Output only
MgrId
Proxy manager ID
Proxy manager's person ID.
Type: String
Output only

Chapter 2

MgrName
Name of a manager
Manager's name.
Type: String
Output only
ProxyMgrId
Person ID of a proxy manager
Proxy manager's person ID.
Type: String
Output only
ProxyMgrName
Name of proxy manager
Proxy Manager's full name.
Type: String
Output only
ProxyMgrNumber
Person number of a proxy manager
Proxy manager's person number.
Type: String
Required Key
RoleName
Name of a delegate role profile
Delegate role profile name.
Type: String

Chapter 2
Output only
RoleProfileId
Id of a delegate role profile
Delegate role profile ID.
Type: Long
Output only
StartDate
Start date of a delegate task
Start Date of a delegate task.
Type: Date
Output only
TaskId
ID of a delegate task
Delegate task ID.
Type: Long
Output only
TaskString
Description of a task
Task string.
Type: String
Output only

Chapter 2
DelegateProfile Tag
Delegate Profile
View, list, create, delete, duplicate and update a delegate profile.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"Duplicate" |
"Retrieve" |
"RetrieveAll" |
"UpdateEntryList" |
"UpdateOnly"
Parameters→
Duplicate→
Name = String
UpdateEntryList→
[NewName = String]
UpdateOnly→
[NewName = String]
Properties→
<DelegateProfile
Name = String
<Delegates>
<LightWeightPerson>*
</Delegates>
</DelegateProfile>

Chapter 2
Action Descriptions
AddOnly
A manager license is required to Add a new delegate profile. The name of the
delegate profile must be unique and not exceed 50 characters. The list of delegates
is required and is defined as a LightWeightPerson bean List.
The length of the name should not exceed 50. The length of the description should
not exceed 250. Delegates is defined as list of LightWeightPerson bean List.The
list of delegates is required. They need to have manager license.
Required Properties: Name, Delegates
Optional Properties: Description
Delete
The name of an existing delegate profile.
The name of an existing delegate profile.
Introduced in v5.2
Duplicate
The name of an existing delegate profile that will be duplicated.
The Name should be the name of an existing delegate profile.

Chapter 2
Action Parameters

Name The Name should be the name of an Introduced in v5.2
existing delegate profile.
Required
The Name should be the name of an
existing delegate profile.
Retrieve
Specify the name of the delegate profile to be retrieved; the name should not
The length of the name should not exceed 50.
Return Value Type: (***undefined***):
RetrieveAll
No special validation
Introduced in v5.2
UpdateEntryList
This action should add a list of delegates but not delete the existing deletes. This is
the difference between the UpdateEntryList and UpdateOnly.
Parameter NewName is used when rename a delegate profile. The length of Name
should not exceed 50. The length of Description should not exceed 250. Delegates
is defined as list of
LightWeightPerson bean List. The list is required.

Chapter 2
Required Properties: Name, Delegates

Action Parameters

NewName The name for the delegete profile Introduced in v6.0
should be unique.
Optional
The name for the delegete profile
should be unique.
UpdateOnly
Required Properties: Name,Delegates

Chapter 2
Action Parameters

NewName The new name should be unique. Introduced in v5.2
Optional
Delegates
List of available delegates
The names of the people who are the available delegates.
Type: Zero or more LightWeightPerson tags
Required
This list can't be empty.
Introduced in v5.2
Description
Description of delegate profile
The description of the delegate profile; it can be any text you want.
Type: String
Optional
The size can't exceed 250 characters.
Introduced in v5.2
Name
Delegate profile name
Specify the name of an existing delegate profile; or when creating a new delegate
profile using the AddOnly action, specify a unique name. The name must not
Type: String
Required

Chapter 2
The name of delegate profile. The length should not exceed 50. If it is used for
AddOnly, the name needs to be unique.
Introduced in v5.2

Chapter 2
DeviceGroup Tag
Device Group
The DeviceGroup tag represents all of the data collection devices that an
employee can access.
Introduced in v4
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAllDeviceGroups" |
"LoadById"
Parameters→
None
Properties→
<DeviceGroup
[DeviceGroupId = Integer]
[DeviceGroupName = String] >
</DeviceGroup>
Action Descriptions
Load
Returns information about the specified device group, based on
DeviceGroupName.
Return Value Type: DeviceGroup tag
Required Properties: DeviceGroupName

Chapter 2
Introduced in v4
LoadAllDeviceGroups
Returns all device groups in the system.
Return Value Type: Zero or more DeviceGroup tags
Introduced in v4
LoadById
Returns information about a device group, based on DeviceGroupId.
Return Value Type: DeviceGroup tag
Required Properties: DeviceGroupId
Optional Properties: DeviceGroupId
Introduced in v4
DeviceGroupId
Device group ID
A unique identifier for a device group.
Type: Integer
Optional
Introduced in v4
DeviceGroupName
Device group name
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 Timekeeper Setup application.

Chapter 2
Introduced in v4

Chapter 2
EarnedAccrual Tag
Earned Accrual
The Earned Accrual 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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<EarnedAccrual
AccrualCodeName = String
Date = Date >
<Employee>
</Employee>
</EarnedAccrual>

Chapter 2
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.
Required Properties: AccrualCodeName, Date, Employee, One member of the
AccrualAmount group
AmountInDays
Amount in days
The amount of time (expressed as a number of days) to be added to the current
balance for the specified accrual code and employee. Use a negative value to
decrement the current balance.
Type: Double
AmountInDays belongs to the AccrualAmount group. Only one member of the
group can be used.
Introduced in v6.1
AmountInCurrency
The 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

Chapter 2
AmountInCurrency belongs to the AccrualAmount group. To specify a currency

value, use either the AmountInCurrency or the AmountInTimeOrCurrency
property.
AmountInTime
The amount of time to be added to the current balance for the specified accrual
code and employee. Use a negative value to decrement the current balance.
Type: TimeDuration
AmountInTime belongs to the AccrualAmount group. To specify a time value, use
either the AmountInTime or the AmountInTimeOrCurrency property.
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
AmountInTimeOrCurrency belongs to the AccrualAmount group. Only one
member of the group can be used.
AccrualCodeName
Accrual code name
The name of an accrual code that exists and is assigned to the specified employee.
Type: String
Required
You can find values in the timekeeping Setup.
Sample values:

Chapter 2
Vacation, Sick

Date
Date
The date to which the accrual transaction applies
Type: Date
Required
Introduced in v4
Employee
Employee
Required Key
Introduced in v4

AccrualAmount
Accrual amount must be specified either in terms of time or money.
AmountInTimeOrCurrency is recommended, but you can use the other
properties instead.
Required
Group includes: AmountInDays, AmountInCurrency, AmountInTime,

Chapter 2
EffectiveLaborStandardVersion Tag
Effective Labor Standard Version
This tag provides the definition of an effective labor standard version consisting
of an effective date and the TimeValue, StandardDriver and StandardDistribution
values of a Labor Standard.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<EffectiveLaborStandardVersion
EffectiveDate = String >
[<StandardDistributionSetting>
<EvenStandardDistribution> |
<TrafficPatternStandardDistribution>
</StandardDistributionSetting>]
[<StandardDriverSetting>
<FixedStandardDriver> |
<FixedWeekPercentageDayStandardDriver> | <StaticStandardDriver>
| <UserDefinedStandardDriver> | <VariableStandardDriver>
</StandardDriverSetting>]
[<TimeValue>
<ConstantTimeValue> | <DynamicTimeValue>
</TimeValue>]
</EffectiveLaborStandardVersion>
EffectiveDate
Effective Date
This is the date upon which the effective labor standard version is in effect.

Chapter 2
Type: String
Required
Must be a String that can be converted into a valid Kdate object or the String
"BOT" which will assing the Beginning of Time date for the version. Also, the
date must be the start date of a Forecast Week.
Sample values:
12/02/2007
Introduced in v6.1
StandardDistributionSetting
Standard Distribution Setting
The Standard Distribution Setting for a Labor Standard.
Type: Either EvenStandardDistribution or TrafficPatternStandardDistribution tag
Optional
StandardDriverSetting
Standard Driver Setting
The Standard Driver setting for a Labor Standard
Type: Either FixedStandardDriver, FixedWeekPercentageDayStandardDriver,
StaticStandardDriver, UserDefinedStandardDriver or VariableStandardDriver tag
Optional
TimeValue
Time Value
The TimeValue property for a Labor Standard
Type: Either ConstantTimeValue or DynamicTimeValue tag
Optional

Chapter 2
EffectiveWorkload Tag
Workload type
The EffectiveWorkload tag defines a workload type.
Used by: WorkloadPlan
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<EffectiveWorkload
(AnchorDate = Date)
OrgJobPath = String
[PatternDurationType = String]
(WorkloadType = String)
WorkloadPatternType = String
WorkloadPlanType = String >
<HeadcountPatterns>
<HeadcountPattern>*
</HeadcountPatterns>
</EffectiveWorkload>
AnchorDate
Base start date of workload pattern
Specifies the date on which the workload pattern is scheduled to start
Type: Date
Output only

Chapter 2
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: Zero or more HeadcountPattern tags
Required
Introduced in v5.0
OrgJobPath
The fully qualified path name for an organizational job
Type: String
Required
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:

Chapter 2
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
Enumerated value: 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

Chapter 2
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.
Dependency: If WorkloadPlanType is specified as Regular and
PatternDurationType is specified as Daily, then they are available from the
Workload Planner user interface on the Calendar tab.
Type: String
Required
Enumerated value: Regular, Holiday
Introduced in v5.0
WorkloadType
Type of workload
Type of workload
Type: String
Output only
This value is system-generated.
Introduced in v5.0

Chapter 2
EffTokeRule Tag
Effective Toke Rule
The EffTokeRule tag contains information about an effective toke rule. Used by:
TokeRule.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<EffTokeRule
[CalcTypeName = String]
[CarryOverSwitch = String]
[ExpirationDate = Date]
[PayCodeName = String]
[StartDay = String]
[StartTime = Time]
[EffectiveDate = Date]
[Name = String]
[TimePeriodTypeName = String] >
[<EffTokeRuleLaborAccounts>
<EffTokeRuleLaborAccount>*
</EffTokeRuleLaborAccounts>]
[<EffTokeRulePayCodes>
<EffTokeRulePayCode>*
</EffTokeRulePayCodes>]
</EffTokeRule>

Chapter 2
CalcTypeName
Calculation type - Beginningofshift''
The calculation type name for the toke pool rule. 'Beginning of shift' is the only
option currently implemented.
Type: String
Optional
Sample values:
Beginning of shift
Introduced in v6.1
CarryOverSwitch
Carry over switch
The carry over switch value. Indicates if the remainder toke amounts should be
carriedf over to the next pool date. '1' indicates carry over is used. '0' indicates that
no remainder amounts are carried over.
Type: String
Optional
Introduced in v6.1
Description
Description
The desription for the Effective Toke pool Rule.
Type: String
Optional
Introduced in v6.1
EffectiveDate
Starting date for the toke pool rule
The start date for this effective toke pool rule.
Type: Date
Optional

Chapter 2
Introduced in v6.1
EffTokeRuleLaborAccounts
Qualifying labor accounts
Labor accounts that qualify for this toke pool rule. Multiple labor accounts can be
qualified using wildcards.
Type: Zero or more EffTokeRuleLaborAccount tags
Optional
Introduced in v6.1
EffTokeRulePayCodes
Selected pay codes
Selected pay codes for this toke pool rule.
Type: Zero or more EffTokeRulePayCode tags
Optional
Introduced in v6.1
ExpirationDate
Ending date for the toke pool rule
The expiration date for this effective toke pool rule.
Type: Date
Optional
Introduced in v6.1
Name
Toke pool rule name
The name of the toke pool rule. The name appears in the Toke AmountEntry
workspace and the People Editor.
Type: String
Optional
Introduced in v6.1

Chapter 2
PayCodeName
Pay code name for the adjustment
The pay code name for the adjustment. This is a money pay code that the system
uses to add toke awards to employee timecards when the pool is finalized.
Type: String
Optional
Introduced in v6.1
StartDay
Start day for a weekly toke pool
The start day for a weekly toke pool. Values are taken from the WEEKDAY table.
Type: String
Optional
Sample values:
Sunday
Introduced in v6.1
StartTime
Start time
The start time for the toke hours for this toke pool rule.
Type: Time
Optional
Introduced in v6.1
TimePeriodTypeName
Type of pool - "Daily" or "Weekly"
The type of toke pool rule. Valid values are 'Daily' or 'Weekly'.
Type: String
Optional
Introduced in v6.1

Chapter 2
EffTokeRuleLaborAccount Tag
Effective Toke Rule Labor Account
The EffTokeRuleLaborAccount tag contains the labor account(s) that are assigned
to the Effective Toke Rule. Used by : EffTokeRule
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<EffTokeRuleLaborAccount
[LaborAccount = String] >
</EffTokeRuleLaborAccount>
LaborAccount
Labor account
The labor account name in format a/b/c/d/e/f/g
Type: String
Optional
Introduced in v6.1

Chapter 2
EffTokeRulePayCode Tag
Effective Toke Rule Pay Codes
The EffTokeRulePayCode tag contains the pay code(s) that are assigned to an
Effective Toke Rule. Used by : EffTokeRule
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<EffTokeRulePayCode
[Name = String] >
</EffTokeRulePayCode>
Name
Pay code name
The pay code name to associate with an Effective Toke Rule
Type: String
Optional
Introduced in v6.1

Chapter 2
EligibleJobs Tag
EligibleJobs
This tag will get all open shifts for a specified date range.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadAll"
Parameters→
None
Properties→
<EligibleJobs
[EndDate = Date]
StartDate = Date >
<Employee>
<PersonIdentity>
</Employee>
(<LocationItems>
<LocationItem>*
</LocationItems>)
</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.

Chapter 2
Return Value Type: Zero or more LocationItem tags

Required Properties: Employee, StartDate
Optional Properties: EndDate
Employee
Employee
This property represents the employee who requests the action.
Required Key
It must be an active employee.
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.
LocationItems
Location Items
A list of location items.
Output only

Chapter 2
Introduced in v5.2
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.

Chapter 2
EmailAddress Tag
Email Address
The EmailAddress tag specifies an e-mail address of the given e-mail address
type.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<EmailAddress
[HasEmailNotificationDelivery = Boolean]
Address = String
ContactTypeName = String >
</EmailAddress>
Address
Email address for employee
The employee's electronic mail address
Type: String
Required
Introduced in v4

Chapter 2
ContactTypeName
Type of contact
The name of the contact category
Type: String
Required Key
Introduced in v4
HasEmailNotificationDelivery
Determines if this e-mail is used for receiving Generic Notifications
If a Generic Notification is sent to the associated Person, the person will receive
this notification on this e-mail address.
This property is optional. If it has not been specified, the current value of this e-
mail address' HasEmailNotificationDelivery remains unchanged.
Type: Boolean
Optional
Introduced in v6.1

Chapter 2
EmployeeAdjustmentRuleAssignment Tag
Assign Adjustment Rule to an employee
Assign Adjustment Rules defined on a system to an employee. This assignment is
effective dated.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"Retrieve" |
"RetrieveAll" |
"RetrieveByPerson" |
"RetrieveByPersonAndEffectiveDate" |
"RetrieveByProcessor" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<EmployeeAdjustmentRuleAssignment
Processor = String
[OriginalEffectiveDate = Date] >
<Person>
<PersonIdentity>
</Person>

Chapter 2
</EmployeeAdjustmentRuleAssignment>
Action Descriptions
Add
Adds a new association of an Adjustment Rule to an employee, or updates an
existing one.
Required Properties: Processor, Person
Optional Properties: EffectiveDate, ExpirationDate
Introduced in v6.1
AddOnly
Adds a new association of an Adjustment Rule to an employee.
Introduced in v6.1
Delete
Deletes an association of an Adjustment Rule to an employee. If the effective date
is not specified, deletes the association that is in effect at start of time (01/01/
1753).
Optional Properties: EffectiveDate
Introduced in v6.1

Chapter 2
Retrieve
Retrieves an EmployeeAdjustmentRuleAssignment association. If an
EffectiveDate is not specified, retrieves the Adjustment Rule in effect at
beginning of time (01/01/1753).
Return Value Type: EmployeeAdjustmentRuleAssignment tag
Introduced in v6.1
RetrieveAll
Retrieves a list of all of the EmployeeAdjustmentRuleAssignment associations.
Return Value Type: Zero or more EmployeeAdjustmentRuleAssignment tags
Introduced in v6.1
RetrieveByPerson
Retrieves the list of EmployeeAdjustmentRuleAssignment associations for a
given employee.
Person must be a valid PersonIdentity.
Required Properties: Person
Introduced in v6.1
RetrieveByPersonAndEffectiveDate
Retrieves an EmployeeAdjustmentRuleAssignment association for the given
person that is in effect on the given effective date.
Person must be a valid PersonIdentity, and EffectiveDate must be a valid date.
Required Properties: Person, EffectiveDate

Chapter 2
Introduced in v6.1
RetrieveByProcessor
Retrieves the list of EmployeeAdjustmentRuleAssignment associations for a
given processor (i.e. Adjustment Rule name).
Must specify a valid Adjustment Rule name.
Required Properties: Processor
Introduced in v6.1
RetrieveForUpdate
Retrieves an EmployeeAdjustmentRuleAssignment association for update. If the
effective date is not specified, retrieves the Adjustment Rule assignment in effect
at start of time (01/01/1753).
Introduced in v6.1
Update
Updates an existing association of an Adjustment Rule to an employee, or adds
one if it does not exist.
Required Properties: Processor, Person, OriginalEffectiveDate
Introduced in v6.1
UpdateOnly
Updates an existing association of an Adjustment Rule to an employee.

Chapter 2

Introduced in v6.1
EffectiveDate
Effective Date
The first date that an Adjustment Rule applies to an employee.
Type: Date
Optional
Must be a valid date.
Sample values:
Default value: Beginning of time (1/1/1753)

ExpirationDate
Expiration Date
The last date of an association of an Adjustment Rule and an employee.
Type: Date
Optional
Sample values:
Default value: 1/1/3000 (forever)


Chapter 2
OriginalEffectiveDate
Original Effective Date
The original effective date of the association of an extension processor and an
employee. This property must be used with the "Update" and "UpdateOnly"
actions.
Type: Date
Optional
Sample values:
OriginalEffectiveDate="3/30/2008"
Introduced in v6.1
Person
Person
The PersonIdentity of the employee to be associated with an Adjustment Rule.
Required Key
Must be a valid PersonIdentity.
Sample values:
<Person>
<PersonIdentity PersonNumber="13"/>
</Person>
Introduced in v6.1
Processor
Adjustment Rule Name
The name of an Adjustment Rule to associate with an employee.
Type: String
Required Key

Chapter 2
Must be a valid Adjustment Rule processor name up to 30 characters long. Special

characters are not allowed.
Sample values:
Processor="Bonus Adjustment"

Chapter 2
EmployeeCurrencyAssignment Tag
Employee Currency Assignment
This is for a person's currency assignment. It contains the currency code and
currency locale information for this person.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<EmployeeCurrencyAssignment
CurrencyLocale = String >
</EmployeeCurrencyAssignment>
CurrencyCode
Currency Code
The currency code assigned to an employee or a user. For example, "USD".
Type: String
Required
Introduced in v6.1
CurrencyLocale
Currency Locale
The currency locale an employee or a user will be using. For example, "en-US",
constructed with the language code and country code.
Type: String

Chapter 2
Required
Introduced in v6.1

Chapter 2
EmployeeFirstShiftTimeDetail Tag
Employee First Shift Time Detail
The API returns the start and end time of the first shift, or paycode edit for a list of
employees in a certain date range.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve"
Parameters→
None
Properties→
<EmployeeFirstShiftTimeDetail
(<DailyData>
<DailyEmployeeFirstShiftTime>*
</DailyData>)
</EmployeeFirstShiftTimeDetail>
Action Descriptions
Retrieve
Method to retrieve the data
Return Value Type: EmployeeFirstShiftTimeDetail tag
Required Properties: employees, beginDate, endDate, workPayCodes
Introduced in v6.1

Chapter 2
DailyData
Daily data
List of daily data for all the employees.
Type: Zero or more DailyEmployeeFirstShiftTime tags
Output only
Introduced in v6.1

Chapter 2
EmployeeGroupAssign Tag
Employee group assignments
The EmployeeGroupAssign tag is used to assign a list of employees to one or
more schedule groups.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"Update"
Parameters→
None
Properties→
<EmployeeGroupAssign
[IsEmploymentTerm = Boolean]
(PersonNumber = Integer) >
<Employees>
</Employees>
<EmployeeGroupItems>
<EmployeeGroupItem>*
</EmployeeGroupItems>
</EmployeeGroupAssign>
Action Descriptions

Chapter 2
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
Optional Properties: Period,TimeFramePeriod, PeriodDateSpan
Update
Update action assigns a list of employees to one or more groups of a certain date
range.
EmployeeGroupItems shouldn't be null
Required Properties: EmployeeGroupItems, Employees
EmployeeGroupItems
List of EmployeeGroupItem tags
A list of EmployeeGroupItem tags.
Type: Zero or more EmployeeGroupItem tags
Required
Employees
Employees
A list of schedule employees

Chapter 2

Required
IsEmploymentTerm
Is Employment Term
When present and TRUE, this flag indicates that the Action should be done on the
EmploymentTerm whose name has been specified. When absent, or when present
and FALSE, the Action will be performed on the ScheduleGroup whose name has
been specified.
Type: Boolean
Optional
none
Sample values:
false

Enumerated value: Is Employment Term
Introduced in v6.1
PersonNumber
Person number
PersonNumber is a required property for load action only.
Type: Integer
Output only

Chapter 2
EmployeeGroupItem Tag
Employee Group Item
The EmployeeGroupItem tag contains information about the employee's group
assignment.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<EmployeeGroupItem
ExpirationDate = Time
EndDate = Time
EffectiveDate = Time
Name = String >
</EmployeeGroupItem>
ExpirationDate
Expiration date of employee assignment
The expiration date which employee will be disassociated from a schedule group.
If this is not present, it will default to the end of time.
Type: Time
Introduced in v5.1; last changed in v6.0; deprecated in v6.0. The expiration date is
not used in the UI so it should not be exposed in the API. The end date should be
used instead.

Chapter 2
EndDate
The end date of the employee assignment.
The end date is used to determine the last day an employee belongs to a schedule
group. If this is not present, it will default to the end of time.
Type: Time
EffectiveDate
Effective date of assignment
The effective date on which an employee will be assigned to a schedule group.
Type: Time
Required
IsEmploymentTerm
Is Employment Term
been specified.
Type: Boolean
Optional
none
Sample values:
false

Enumerated value: Is Employment Term
Introduced in v6.1
Name
Name of the employee group
The name of the group

Chapter 2
Type: String
Required

EndAndExpirationDate
Only one of these should be specified. The preference is end date since expiration
date is deprecated.
Optional
Group includes: ExpirationDate, EndDate

Chapter 2
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.
Introduced in v4
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAllEmployeeGroupProfiles" |
"LoadById"
Parameters→
None
Properties→
<EmployeeGroupProfile
[EmployeeGroupProfileId = Integer]
[EmployeeGroupProfileName = String] >
</EmployeeGroupProfile>
Action Descriptions
Load
Returns the specified employee group profile, based on
EmployeeGroupProfileName.

Chapter 2
Return Value Type: EmployeeGroupProfile tag

Required Properties: EmployeeGroupProfileName
Introduced in v4
LoadAllEmployeeGroupProfiles
Returns all employee group profiles in the system.
Return Value Type: Zero or more EmployeeGroupProfile tags
Introduced in v4
LoadById
Returns the specified employee group profile, based on EmployeeGroupProfileId.
Return Value Type: EmployeeGroupProfile tag
Required Properties: EmployeeGroupProfileId
Introduced in v4
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

Chapter 2
Introduced in v4

Chapter 2
EmployeeHolidayDetail Tag
Employee Holiday Detail
The API bean that contains the holiday attendance data for a list of employees
used in India Statutory Reports.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve"
Parameters→
None
Properties→
<EmployeeHolidayDetail
(<HolidayDetailDataList>
<HolidayDetailData>*
</HolidayDetailDataList>)
</EmployeeHolidayDetail>
Action Descriptions
Retrieve
The method used to retrieve the holiday attendance data for a list of employees.
Return Value Type: EmployeeHolidayDetail tag
Required Properties: Employees, HolidayDates, WorkkPayCodes
Introduced in v6.1

Chapter 2
HolidayDetailDataList
Holiday detail data list
List of HolidayDetailData for each employee on every holiday.
Type: Zero or more HolidayDetailData tags
Output only
Introduced in v6.1

Chapter 2
EmployeeMessage Tag
Employee Message
The EmployeeMessage tag is used to send messages to employees, view messages
or delete messages.
The bean does the validation
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Load" |
"LoadAllMessages" |
"Send"
Parameters→
None
Properties→
<EmployeeMessage
MessageSubject = String
TypeId = String >
<Recipients>
<HyperFindQuery> | <To>
</Recipients>
<Sender>
<From>
</Sender>
</EmployeeMessage>
Action Descriptions

Chapter 2
Delete
validation done in the bean
Required Properties: MessageId,Sender
Introduced in v5.2
Load
Return Value Type: Zero or more EmployeeMessage tags
Required Properties: Sender
Introduced in v5.2
LoadAllMessages
bean does the validation
bean does the validation
Return Value Type: (***undefined***): APIBeanList
Send
Required Properties: TypeId,Sender,Recipients,MessageSubject
Optional Properties: MessageBody,MessageId

Chapter 2
MessageSubject
Message Subject
Message subject
Type: String
Required
Validation done in the bean
Introduced in v5.2
Recipients
Recipients
The recipients can be either a <hyperfindquery
bean or a <to
bean
Type: Either HyperFindQuery or To tag
Required
Introduced in v5.2
Sender
Sender
Type: From tag
Required
Introduced in v5.2
TypeId
Message Type ID
The acceptable values are 1, 2 or 3.

Chapter 2
Type: String
Required
The acceptable values are 1, 2 or 3.
Sample values:
1, 2 or 3
Introduced in v5.2

Chapter 2
EmployeeOpenShiftRequestItem Tag
Employee Open Shift Request Item
Describe an employee open shift request item
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<EmployeeOpenShiftRequestItem
(CreationDateTime = DateTime)
[Id = String]
RequestFor = String
ShiftDate = Date
(StatusName = String) >
[<Comments>
<Comment>*
</Comments>]
<ShiftSegments>
<ShiftSegment>*
</ShiftSegments>
</EmployeeOpenShiftRequestItem>
Comments
Comments
A list of comments related to the request
Type: Zero or more Comment tags
Optional
Introduced in v6.1

Chapter 2
CreationDateTime
Creation Date Time
The creation date/time
Type: DateTime
Output only
Introduced in v6.1
Id
Id
The request id
Type: String
Optional
Introduced in v6.1
RequestFor
Request For
The request subtype
Type: String
Required
Introduced in v6.1
ShiftDate
Shift Date
The date of the open shift requested
Type: Date
Required
Introduced in v6.1
ShiftSegments
Shift Segments
The list of shift segments describing the requested open shift
Type: Zero or more ShiftSegment tags
Required

Chapter 2
Introduced in v6.1
StatusName
Status Name
The current status of the request
Type: String
Output only
Introduced in v6.1

Chapter 2
EmployeePreferredZone Tag
Preferred schedule zone assignment for the employee
This tag assigns a preferred schedule zone for an employee.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Load" |
"Update"
Parameters→
None
Properties→
<EmployeePreferredZone
[PreferredZone = String]
PersonNumber = Integer
[PreferredZoneSet = String] >
</EmployeePreferredZone>
Action Descriptions
Delete
This will delete the preferred zone assignment for the person whose
personNumber matches the one supplied.

Chapter 2
Introduced in v5.2
Load
This is the person number of the employee whose preferred zone you would like
to retrieve.
Return Value Type: EmployeePreferredZone tag
Introduced in v5.2
Update
This will set the preferred zone for the person supplied. It will be set to the zone
in the zone set which has been passed in via the PreferredZone and
PreferredZoneSet attributes.
Required Properties: PersonNumber, PreferredZoneSet, PreferredZone
Introduced in v5.2
PersonNumber
Person number
The person number of the employee that you are assigning or deleting the
preferred zone for.
Type: Integer
Required
PreferredZone
Name of preferred schedule zone
The name of the zone that is being assigned to an employee
Type: String

Chapter 2
Optional
PreferredZoneSet
Schedule Zone Set that contains the preferred zone
The name of the zone set that contains the zone that is being assigned or deleted
Type: String
Optional

Chapter 2
EmployeeReportDataProfile Tag
Employee Report Data Profile
Specifies the effective-dated assignment of an India Statutory Reports Profile to
an employee.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadByPerson" |
"Update"
Parameters→
None
Properties→
<EmployeeReportDataProfile
<Employee>
<PersonIdentity>
</Employee>
[<ReportDataProfileAssignmentList>
<ReportDataProfileAssignment>*
</ReportDataProfileAssignmentList>]
</EmployeeReportDataProfile>
Action Descriptions
LoadByPerson
Retrieves the employee's India Statutory Reports profile assignments.
Return Value Type: EmployeeReportDataProfile tag

Chapter 2

Introduced in v6.1
Update
Creates or updates the India Statutory Reports Profile assignments for an
employee.
Required Properties: Employee, ReportDataProfileAssignmentList
Introduced in v6.1
Employee
Employee
Specifies the employee identifier.
Required Key
Sample values:
Introduced in v6.1
ReportDataProfileAssignmentList
Report data profile assignment list
Specifies the effective-dated India Statutory Report profile assignments for the
employee.
Type: Zero or more ReportDataProfileAssignment tags
Optional
Sample values:

Chapter 2
<ReportDataProfileAssignment ProfileName="North
Factory" EffectiveDate="1/30/2007" EndDate="6/30/
2007"/>
<ReportDataProfileAssignment ProfileName="South
Factory" EffectiveDate="9/1/2007" EndDate=""/>
Introduced in v6.1

Chapter 2
EmployeeRequestMgmt Tag
Employee Request Management
Various operations that an employee could do to manage it's requests
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddRequests" |
"DeleteRequests" |
"RetractRequests" |
"RetrieveAvailableRequestsFor" |
"RetrieveRequests" |
"SubmitRequests" |
"UpdateRequests"
Parameters→
RetrieveAvailableRequestsFor→
[RequestType = String]
RetrieveRequests→
[RequestFor = String]
[StatusName = String]
Properties→
<EmployeeRequestMgmt
QueryDateSpan = DateSpan
[RequestType = String]
[StatusName = String] >
<Employee>
<PersonIdentity>
</Employee>
(<RequestForItems>

Chapter 2
<RequestFor>*
</RequestForItems>)
[<RequestIds>
<RequestId>*
</RequestIds>]
[<RequestItems>
<RequestItems>
</RequestItems>]
</EmployeeRequestMgmt>
Action Descriptions
AddRequests
Add a request
Return Value Type: RequestItems tag
Required Properties: QueryDateSpan, Employee, RequestItems
Introduced in v6.1
DeleteRequests
Delete a request
Required Properties: QueryDateSpan, Employee, RequestIds
RetractRequests
Retract a request

Chapter 2
RetrieveAvailableRequestsFor
Retrieve every available "request for" for which the submission period is open
Return Value Type: Zero or more RequestFor tags
Introduced in v6.1
Action Parameters

RequestType The type of the request Introduced in v6.1
Optional
RetrieveRequests
Retrieve requests for an employee and a date span
Return Value Type: RequestItems tag
Required Properties: QueryDateSpan, Employee
Introduced in v6.1
Action Parameters

RequestFor The request for (subtype) Introduced in v6.1
Optional
StatusName The status Introduced in v6.1
Optional
SubmitRequests
Submit a request

Chapter 2

UpdateRequests
Update a request
Required Properties: QueryDateSpan, Employee, RequestItems
Introduced in v6.1
Employee
Employee
The employee making the request(s)
Required
Introduced in v6.1
QueryDateSpan
Query Date Span
The global date span including every request item date span
Type: DateSpan
Required
RequestFor
Request For
The request for (subtype)
Type: String
Optional
Introduced in v6.1

Chapter 2
RequestForItems
Request For Items
A list of request for items
Type: Zero or more RequestFor tags
Output only
RequestIds
Request Ids
A list of request id
Type: Zero or more RequestId tags
Optional
Introduced in v6.1
RequestItems
Request Items
A list of various request items object
Type: RequestItems tag
Optional
Introduced in v6.1
RequestType
RequestType
The request type
Type: String
Optional
Sample values:
TIME_OFF, TIME_OFF_HOUR
Introduced in v6.1

Chapter 2
StatusName
Status Name
The request status
Type: String
Optional
Sample values:
DRAFT, SUBMITTED
Introduced in v6.1

Chapter 2
EmployeeSummary Tag
Employee Summary
The EmployeeSummary tag contains either accruals or totals for an employee.
Used by: BulkAccruals, BulkTotals
Introduced in v4
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<EmployeeSummary
(<Accruals>
<AccrualBalanceSummary>*
</Accruals>)
(<Employee>
<PersonIdentity>
</Employee>)
(<Totals>
<Total>*
</Totals>)
</EmployeeSummary>
Accruals
Accruals
One or more accruals for the specified employee, as requested by the
BulkAccruals tag.
Type: Zero or more AccrualBalanceSummary tags
Output Only

Chapter 2
Introduced in v4
Employee
Employee
One employee, as specified in a PersonIdentity tag, for whom the accruals or
totals are returned.
Output Only
Introduced in v4
Totals
Totals
A list of totals for the specified employee, as requested by the BulkTotals tag. The
Total tag contains the minimum information, PayCodeId, PayCodeName, and
AmountInTime or AmountInCurrency.
Type: Zero or more Total tags
Output Only
Introduced in v4

Chapter 2
EmployeeTimeDetail Tag
Employee Time Detail
API to retrieve India report data directly from the business object.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve"
Parameters→
None
Properties→
<EmployeeTimeDetail
(<DailyData>
<DailyEmployeeTimeAttendance>*
</DailyData>)
</EmployeeTimeDetail>
Action Descriptions
Retrieve
Retrieves the employee time detail data.
Return Value Type: EmployeeTimeDetail tag
Required Properties: Employees, BeginDate, EndDate, ShowWorkDetails,
WorkPayCodes
Introduced in v6.1

Chapter 2
DailyData
Daily Data
A list of DailyEmployeeTimeAttendance for each employee.
Type: Zero or more DailyEmployeeTimeAttendance tags
Output only
Introduced in v6.1

Chapter 2
EmployeeTimeOffHoursRequestItem Tag
Employee Time Off Hours Request Item
Describe a time off hours request created/submitted by an employee
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<EmployeeTimeOffHoursRequestItem
[CreationDateTime = DateTime]
Duration = TimeDuration
[Id = String]
PayCodeName = String
RequestFor = String
StartDateTime = DateTime
<Comments>
<Comment>*
</Comments>
</EmployeeTimeOffHoursRequestItem>
Comments
Comments
A list of comments related to this request
Required
Introduced in v6.1

Chapter 2
CreationDateTime
Creation Date Time
The request creation date/time
Type: DateTime
Optional
Introduced in v6.1
Duration
Duration
The request time duration
Type: TimeDuration
Required
Id
Id
The request Id
Type: String
Optional
Introduced in v6.1
PayCodeName
Pay Code Name
The Pay Code of this request
Type: String
Required
Introduced in v6.1
RequestFor
Request For
The request subtype
Type: String
Required

Chapter 2
Introduced in v6.1
StartDateTime
Start Date Time
The request start date time
Type: DateTime
Required
Introduced in v6.1
StatusName
Status Name
The request current status
Type: String
Output only
Introduced in v6.1

Chapter 2
EmployeeTimeOffRequestItem Tag
Employee Time Off Request
Describe a time off request created /submitted by an employee
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<EmployeeTimeOffRequestItem
EndDate = Date
[Id = String]
RequestFor = String
StartDate = Date
[<Comments>
<Comment>*
</Comments>]
</EmployeeTimeOffRequestItem>
Comments
Comments
A list of comments for this request
Optional
Introduced in v6.1

Chapter 2
CreationDateTime
Creation Date Time
The creation date/time of the request
Type: DateTime
Output only
EndDate
End Date
The end date of the time off request
Type: Date
Required
Introduced in v6.1
Id
Id
Request Id
Type: String
Optional
Introduced in v6.1
PayCodeName
Pay Code Name
The pay code of the request
Type: String
Required
Introduced in v6.1
RequestFor
Request For
The request subtype
Type: String
Required

Chapter 2
Introduced in v6.1
StartDate
Start Date
The start date of the time off
Type: Date
Required
Introduced in v6.1
StatusName
Status Name
The status of the current request
Type: String
Output only

Chapter 2
EmployeeTipRuleAssignment Tag
Assign Tip Rule to an employee
Assign Tip Rules defined on a system to an employee. This assignment is
effective dated.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"Retrieve" |
"RetrieveAll" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<EmployeeTipRuleAssignment
[OriginalEffectiveDate = Date]
Processor = String >
<Person>
<PersonIdentity>
</Person>

Chapter 2
</EmployeeTipRuleAssignment>
Action Descriptions
Add
Adds a new association of a Tip Rule to an employee, or updates an existing one.
AddOnly
Adds a new association of a Tip Rule to an employee.
Delete
Deletes an association of a Tip Rule to an employee. If the effective date is not
specified, deletes the association that is in effect at start of time (01/01/1753).
Retrieve
Retrieves an EmployeeTipRuleAssignment association. If an effective date is not
specified, retrieves the Tip Rule in effect at start of time (01/01/1753).

Chapter 2
Return Value Type: EmployeeTipRuleAssignment tag

RetrieveAll
Retrieves a list of all of the EmployeeTipRuleAssignment associations.
Return Value Type: Zero or more EmployeeTipRuleAssignment tags
Introduced in v6.1
RetrieveByPerson
Retrieves the list of EmployeeTipRuleAssignment associations for a given
employee.
Return Value Type: Zero or more EmployeeTipRuleAssignment tags
Retrieve the list of EmployeeTipRuleAssignment associations for the given
person that are in effect on the given effective date.
Introduced in v6.1

Chapter 2
RetrieveByProcessor
Retrieves the list of EmployeeTipRuleAssignment associations for a given
processor (i.e.Tip Rule name).
Must specify a valid tip rule name.
RetrieveForUpdate
Retrieves a EmployeeTipRuleAssignment association for update. If the effective
date is not specified, retrieves the tip rule in effect at start of time (01/01/1753).
Introduced in v6.1
Update
Updates an existing association of a Tip Rule to an employee, or adds one if it
does not exist.
UpdateOnly
Updates an existing association of a Tip Rule to an employee.

Chapter 2

EffectiveDate
Effective Date
The effective date of the association of a Tip Rule and an employee.
Type: Date
Optional
Sample values:
Default value: Beginning of time, i.e."1/01/1753"

ExpirationDate
Expiration Date
The expiration date of an association of a Tip Rule and an employee.
Type: Date
Optional
Sample values:


Chapter 2
Original Effective Date
The original effective date of the association of an extension processor and an
employee. This property must be used with the "Update" and "UpdateOnly"
actions.
Type: Date
Optional
Sample values:
OriginalEffectiveDate="3/30/2008"

Person
Person
The PersonIdentity of the employee to be associated with a Tip Rule.
Required Key
Sample values:
<Person>
</Person>

Processor
Tip Rule name
The name of a Tip Rule to associate with an employee.
Type: String
Required Key
Must be a valid Tip Rule processor name.

Chapter 2
Sample values:
Processor="Tip 1"

Chapter 2
EmployeeTokeRuleAssignment Tag
Employee Toke Rule Assignment
The Employee Toke Rule Assignment tag allows you to assign a Toke Pool Rule
to an employee. An employee may be assigned to more than one Toke Pool Rule.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"Delete" |
"Retrieve" |
"RetrieveAll" |
"Update"
Parameters→
None
Properties→
<EmployeeTokeRuleAssignment
[EndDate = Date]
[OriginalStartDate = Date]
[StartDate = Date]
[TokeRuleName = String] >
</EmployeeTokeRuleAssignment>
Action Descriptions
Add
Adds the employee toke rule assignment

Chapter 2

Required Properties: PersonNumber, TokeRuleName
Optional Properties: StartDate, EndDate
Introduced in v6.1
Delete
Deletes the employee toke rule assignment
Introduced in v6.1
Retrieve
Retrieves a employee toke rule assignment for an employee
Return Value Type: EmployeeTokeRuleAssignment tag
Introduced in v6.1
RetrieveAll
Returns a list of all of the employee toke rule assignments
Return Value Type: Zero or more EmployeeTokeRuleAssignment tags
Introduced in v6.1
Update
Updates the employee toke rule assignment

Chapter 2

Introduced in v6.1
EndDate
Ending date
The ending date of this Toke Rule for this employee.
Type: Date
Optional
Introduced in v6.1
OriginalStartDate
Original start date
The original start date of the rule for this employee.
Type: Date
Optional
Introduced in v6.1
PersonNumber
Employee number
The employee number of the person.
Type: String
Optional
Introduced in v6.1
StartDate
Starting date
The starting date for this Toke Rule for this employee
Type: Date
Optional
Introduced in v6.1

Chapter 2
TokeRuleName
Toke Rule name
The name of the Toke Rule to assign to the employee.
Type: String
Optional
Introduced in v6.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadEmploymentStatuses"
Parameters→
None
Properties→
<EmploymentStatus
EmploymentStatusName = String
[ExpirationDate = Date] >
<Identity>
</Identity>
[<Period>
<TimeFramePeriod>
</Period>]
</EmploymentStatus>
Action Descriptions

Chapter 2
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
EffectiveDate
Effective date
The beginning date of the employment status that this tag sets.
Type: Date
Optional
Default value: The date of the import
EmploymentStatusName
Employment status name
Indicates the current status of the employee.
Values can be:

Chapter 2
• 0 for not applicable

• 1 for an active employee
• 2 for an inactive employee
• 3 for a terminated employee
Type: String
Required
Enumerated value: 0, 1, 2, 3
Introduced in v4
ExpirationDate
Expiration date
The date when the employment status specified by this tag ends.
Type: Date
Optional
Must occur after the effective date.
Identity
Identity
One person, as specified in a PersonIdentity or CurrentUser tag.
Optional Key
Introduced in v5.0
Period
Time period
The time span that is associated with an employment status

Chapter 2
Optional
The specified identity shall be used when the time frame requires an association
with a person.
Used for the LoadEmploymentStatuses action
Introduced in v5.0

Chapter 2
EmploymentTerm Tag
Employment Term
The EmploymentTerm tag is a wrapper for the EmploymentTerm business object.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"RetrieveAll" |
"Update"
Parameters→
Update→
[NewName = String]
Properties→
<EmploymentTerm
[AllowsInheritance = Boolean]
name = String
ProcessType = Integer >
[<Versions>
<EmploymentTermVersion>*
</Versions>]
</EmploymentTerm>
Action Descriptions

Chapter 2
Delete
To delete an existing EmploymentTerm from database.
It must be the name of an existing EmploymentTerm.
Required Properties: name
Introduced in v6.1
Retrieve
To retrieve EmploymentTerm by specified a valid name.
Return Value Type: EmploymentTerm tag
Introduced in v6.1
RetrieveAll
Retrieves all the Employment Terms.
Return Value Type: Zero or more EmploymentTerm tags
Introduced in v6.1
RetrieveAllNames
Retrieves the names of all the Employment Terms.
Return Value Type: Collection list
Introduced in v6.1
RetrieveForUpdate
Retrieves an Employment Term, by name.
Name must be valid.
Return Value Type: EmploymentTerm tag

Chapter 2

Introduced in v6.1
Update
Updates the specified Employment Term, if it exists; otherwise the Employment
Term is added.
Optional Properties: EmploymentTermVersion, Description, IsActive
Introduced in v6.1
Action Parameters

NewName New name for the specified Introduced in v6.1
Employment Term.
Optional
AllowsInheritance
Allows inheritance
Indicates that the employment term shifts are inherited by the employees assigned
to the term.
Type: Boolean
Optional
Introduced in v6.1
Description
Description
The description of an employment term object.

Chapter 2
Type: String
Optional
Introduced in v6.1
IsActive
Is active
Is this employment term active flag.
Type: Boolean
Optional
Introduced in v6.1
name
Name of employment term
The name of an employment term object.
Type: String
Optional Key
It must be the name of an existing EmploymentTerm.
Introduced in v6.1
ProcessType
Process type
Indicates that the end date of the employment term is enforced (-1) or the
employment terms will continue to be used for processing after the end date of the
assignment (-2).
Type: Integer
Required
Enumerated value: -1, -2
Introduced in v6.1

Chapter 2
Versions
Employment term version
List of EmploymentTermVersion objects. This must be a complete list of the
versions. If all the versions do not appear in the list, it is assumed that this means
that any existing versions not listed will be deleted.
Type: Zero or more EmploymentTermVersion tags
Optional
Introduced in v6.1

Chapter 2
EmploymentTermAssignment Tag
Employment Term Assignment
The EmploymentTermAssignment tag defines a Person's assignment to an
EmploymentTerm over a range of dates.
A Person may have only one EmploymentTermAssignment on any given date;
thus, an EmploymentTermAssignment's dates may not overlap with any other
EmploymentTermAssignment for that same Person.
The EffectiveDate may not be before the Person's Date Of Hire.

Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<EmploymentTermAssignment
[EndDate = Date]
[Name = String]
[OriginalStartDate = Date]
[StartDate = Date] >
</EmploymentTermAssignment>
EndDate
End date
Specifies the date on which an EmploymentTermAssignment should end. Note
that the assignment is inclusive of the EndDate (i.e. the assignment is active on the
specified date and expires at the end of the day).

Chapter 2
Type: Date
Optional
The End Date cannot be prior to the Start Date.
Name
Name
The name of the EmploymentTerm which is to be assigned to a person.
Type: String
Optional
Must refer to a real EmploymentTerm.
Introduced in v6.1
OriginalStartDate
Original start date
Specifies the StartDate of an existing EmploymentTermAssignment that is to be
edited or deleted. Since EmploymentTermAssignments are not permitted to
overlap, the StartDate alone is sufficient to uniquely identify the desired
assignment. Other properties may be optionally specified; if so, the assignment is
edited to the new specified values(s), subject to the same validation rules as when
an assignment is first created; if the Name property is given as an empty string
(i.e. ""), the target assignment is deleted.
Type: Date
Optional
Must specify the StartDate of an existing EmploymentTermAssignment for this
person.
StartDate
Start date
Specifies the date on which an EmploymentTermAssignment should begin.
Type: Date
Optional

Chapter 2
May not occur prior to the Person's Date Of Hire (DOH)


Chapter 2
EmploymentTermVersion Tag
Employment Term Version
EmploymentTermVersion contains the rules for employment terms.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<EmploymentTermVersion
AccrualProfile = String
CascadeProfile = String
EndDate = Date
HolidayProfile = String
PayRule = String
StartDate = Date
TimeOffRule = String >
[<WorkHours>
<WorkHourDef>*
</WorkHours>]
[<DurationPaycodes>
<TermDurationPaycode>*
</DurationPaycodes>]
</EmploymentTermVersion>
AccrualProfile
Accrual profile name
The name of an accrual profile.
Type: String

Chapter 2
Optional Key
Must be the name of an existing accrual profile.
Introduced in v6.1
CascadeProfile
Cascade profile
The name of an existing cascade profile.
Type: String
Optional Key
Must be the name of an existing cascade profile.
Introduced in v6.1
DurationPaycodes
Term duration pay code
A list term duration pay codes for this employment term version.
Type: Zero or more TermDurationPaycode tags
Optional
Introduced in v6.1
EndDate
End date
The employment term version end date.
Type: Date
Required
Introduced in v6.1
HolidayProfile
Holiday profile
The name of an existing holiday profile.
Type: String
Optional Key
Must be the name of an existing holiday profile.

Chapter 2
Introduced in v6.1
PayRule
Pay rule name
The name of a pay rule.
Type: String
Optional Key
Must be the name of an existing pay rule.
Introduced in v6.1
StartDate
Start date
The employment term version start date.
Type: Date
Required
Introduced in v6.1
TimeOffRule
Time-Off rule
The name of an existing Time-Off rule.
Type: String
Optional Key
If specified, the value must be the name of an existing Time-Off rule.
Introduced in v6.1
WorkHours
List of work hour definitions
List of work hour definitions.
Type: Zero or more WorkHourDef tags
Optional
Introduced in v6.1

Chapter 2
Error Tag
Error
An Error tag represents a processing, validation, or persistence error that occurred
while processing the XML or executing an action
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<Error
[ActionName = String]
[PropertyType = String]
[ParameterType = String]
ErrorCode = Integer
Message = String
[ErrorData = Collection]
[ParameterName = String]
[PropertyName = String]
[BeanName = String]
[PropertyValue = String]
[ParameterValue = String] >
[<DetailErrors>
<Error>*
</DetailErrors>]
</Error>
ActionName
Action being used when error occurred
Identifies the action in which the error occurred

Chapter 2
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

Chapter 2
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

Chapter 2
Introduced in v4
PropertyType
Data type of property being used when the error occurred
The data type of the property in which the error occurred
Type: String
Optional
Introduced in v4
PropertyValue
Value of property when the error occurred
The value of the property in which the error occurred
Type: String
Optional
Introduced in v4

Chapter 2
ExchangeRate Tag
Exchange Rate
Returns an exchange rate between a given currency and a base currency and the
dates for which the rates apply. Used in conjuction with Currency Policy only.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ExchangeRate
EndDate = Date
ExchangeRate = Double
StartDate = Date >
</ExchangeRate>
EndDate
End Date
Holds the enddate at which an exchange rate was available between two
currencies.
Type: Date
Required
Proper date validation is done.

Chapter 2
ExchangeRate
Exchange Rate
The exchange rate between two currencies.
Type: Double
Required
The rate should be greater than zero.
StartDate
Start Date
holds the startdate from which a given rate is applicable between two currencies.
Type: Date
Required
proper date validation is performed.

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ExpectedHours
Quantity = TimeDuration
TimePeriodTypeName = String >
</ExpectedHours>
Quantity
Number of hours
The number of hours the employee is expected to work for the time span
identified in TimePeriodTypeName.
Type: TimeDuration
Required
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.

Chapter 2
TimePeriodTypeName
Time span associated with number of hours
The span of time associated with the number of hours reported in Quantity.
Type: String
Required Key
Enumerated value: Daily, Weekly, Monthly, Annually, Pay Period, Schedule
Period

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"Load"
Parameters→
None
Properties→
<FailedXMLTransaction
BatchStatId = Long
[XMLRequestBodyText = String]
[ErrorText = String]
[SourceDetails = String]
[XMLRequestEndDate = Date]
[XMLRequestEndTime = Time]
[ErrorCode = Integer]
[XMLRequestHeaderText = String]
[SourceName = String]
[APIBeanName = String]
[PropertyName = String]
[ErrorRecordNumber = Integer]

Chapter 2
[XMLRequestBeginDate = Date]
[XMLRequestBeginTime = Time]
[TransactionType = String]
[PropertyValue = String] >
</FailedXMLTransaction>
Action Descriptions
AddOnly
Adds a failed XML transaction error record to the database.
Does not replace an existing failed transaction
Required Properties: SourceName, BatchStatId, XMLRequestEndDate,
XMLRequestEndTime, TransactionType, XMLRequestHeaderText,
XMLRequestBodyText
Introduced in v5.0
Delete
Removes the failed transaction record with matching property values from the
database. SourceName or TransactionType must be specified.
Required Properties: XMLRequestEndDate, XMLRequestEndTime
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

Chapter 2
Introduced in v5.0
APIBeanName
Name of failed XML tag
The API tag name for the failed XML transaction request
Type: String
Optional
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 Key
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

Chapter 2
Optional
Introduced in v5.0
ErrorText
Description of error
A description of the error that was returned
Type: String
Optional
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
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
Introduced in v5.0
SourceDetails
Details about the application
The source details including additional information about source
Type: String
Optional

Chapter 2

Introduced in v5.0
SourceName
Name of application submitting the import
The name of the source system submitting an XML import
Type: String
Optional
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

Chapter 2
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
The time when the XML request was started
Type: Time
Optional
Introduced in v5.0
XMLRequestBodyText
Body of the XML request
Details for the failed XML request
Type: String
Optional
Replace all special characters with the descriptive special HTML characters, as
shown: " = " & = & < = <
= > ' = '
Sample values:
< Request Action=" AddOnly"> < Punch
Date=" 08/23/03" Time="9:00AM"
KronosTimeZone="13411" >
<Employee> < PersonIdentity
BadgeNumber=" 28" /> < /Employee>
< /Punch> < /Request>
Introduced in v5.0

Chapter 2
XMLRequestEndDate
End date of XML request
The end date of the request failure
Type: Date
Optional
Introduced in v5.0
XMLRequestEndTime
End time of XML request
The end time of the request failure.
Type: Time
Optional
Value must parse to a valid time according to current user's preferences.
Introduced in v5.0
XMLRequestHeaderText
Header of the XML request
The XML request header for the failed XML request
Type: String
Optional
Replace all special characters with the special HTML characters, as shown: " =
" & = & < = <
= > ' = '
Sample values:
< ?xml version=" 1.0" ?> <Kronos_WFC
version=" 1.0" >
Introduced in v5.0

Chapter 2
Formula Tag
Schedule Metrics Indicator Expression
IndicatorExpression are predefined and used by indicators to specify how to
calculate a statistical measure a user would like to see.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames"
Parameters→
None
Properties→
<Formula
(Description = String)
(Expression = String)
(I18Name = String)
Name = String
(ValueTypeName = String) >
</Formula>
Action Descriptions
Retrieve
Returns an indicator expression object given the name.
Return Value Type: (***undefined***): IndicatorExpresssion

Chapter 2

Introduced in v6.1
RetrieveAll
Returns all indicator expressions
Return Value Type: (***undefined***): IndicatorExpresssion
Introduced in v6.1
RetrieveAllNames
Returns all indicator expression names
Description
Description
Specify a description for the indicator expression.
Type: String
Output only
Sample values:
<IndicatorExpression Name="SCHEDULED"
I18Name="Scheduled" Description="Scheduled hours."
Expression="" ValueTypeName="HOURS"/>

Expression
Expression
Specify the indicator expression formula to calculate metrics measure.

Chapter 2
Type: String
Output only
Sample values:
<IndicatorExpression Name="SERVICE_LEVEL" I18Name="100
* (Required - Under) / max(1,Required)"
Description="Service Level Indicator" Expression="100 *
(REQUIRED - UNDER) / max(1,REQUIRED)"
ValueTypeName="PERCENTAGE"/>

I18Name
Internationalized Name
Specify the indicator expression internationalized name. This name is used in the
UI setup of an indicator.
Type: String
Output only
Sample values:
Expression="" ValueTypeName="HOURS">

Name
Name
Specify the indicator expression name.
Type: String
Required Key
Sample values:

Chapter 2

ValueTypeName
Value Type
Specify the indicator expression value type. (HOURS, PERCENTAGE)
Type: String
Output only
Sample values:

Chapter 2
FPAAllocation Tag
Percent Allocation Rule Allocation
Defines the labor account and how wages are allocated to that labor account.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<FPAAllocation
Percentage = Double
[WageAdjustmentAmount = Double]
[WageAdjustmentType = Integer] >
</FPAAllocation>
LaborAccountName
Labor Account Name
The labor account that will be allocated the specified percent of the pay.
Type: String
Optional
Must be a valid labor account. If AdHoc is enabled and validation for a labor level
is turned off, then labor level entries may be created by adhoc.
Sample values:
LaborAccountName="101//303//504//701"

Chapter 2
Introduced in v5.2
Percentage
Percentage
The percentage of the total wage that will be allocated to the specified labor
account. All allocations for a trigger must add up to 100.
Type: Double
Required
Must be between 0 and 100.
Sample values:
Percentage="100"
Introduced in v5.2
WageAdjustmentAmount
Wage Adjustment Amount
Specifies the amount that the base wage will be adjusted by.
Type: Double
Optional
Sample values:
WageAdjustmentAmount="5.00"
Introduced in v5.2
WageAdjustmentType
Wage Adjustment Type
Specifies how the base wage will be adjusted after the allocation rule is applied: 0
- none; 1 - addition; 2 - multiplier; 3 - flat rate.
Type: Integer
Optional
Must be between 0 and 3
Sample values:

Chapter 2
WageAdjustmentType="1"
Introduced in v5.2

Chapter 2
FPARule Tag
Percent Allocation Rule
This tag provides the create, read, update, and delete operations used for
managing percent allocation rules. Use the ProcessorToEmployee tag to assign a
percent allocation rule to an employee.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"RetrieveAll" |
"RetrieveByName" |
"Update"
Parameters→
None
Properties→
<FPARule
Name = String >
<FPARuleVersions>
<FPARuleVersion>*
</FPARuleVersions>
</FPARule>
Action Descriptions

Chapter 2
Delete
Deletes an FPARule
name must not be null and should be between 1 and 30 characters
Introduced in v5.2
Retrieve
The name of the rule to be retrieved
name must not be null and must be between 1 and 30 characters in length
Return Value Type: FPARule tag
Introduced in v5.2
RetrieveAll
Returns all FPA rules in the system
Return Value Type: Zero or more FPARule tags
Introduced in v5.2
RetrieveAllNames
Returns the names of all FPARules in the system
RetrieveByName
Returns a FPARule for a given name
name must not be null and between 1 and 30 characters

Chapter 2

Introduced in v5.2
RetrieveForUpdate
Returns a FPARule for use in an Update request
name must not be null and should be between 1 and 30 characters
Introduced in v5.2
Update
This action will update (insert,update) a FPARule. It uses the factory method
RetrieveByName to retrieve an existing rule if it exists. The FPARuleVersion is a
list of FPARuleVersion API Tags. See the FPARuleVersion Tag for more
information.
name must not be null and between 1 and 30 characters
Optional Properties: FPARuleVersions
Introduced in v5.2
FPARuleVersions
Percent Allocation Revisions
The list of revisions (FPARuleVersion) of a FPA Rule
Type: Zero or more FPARuleVersion tags
Required
Sample values:

Chapter 2
<FPARuleVersions>
<FPARuleVersion EndEffectiveDate="01/01/3000"
StartEffectiveDate="01/01/1753" Description="BOT -
EOT">
<Triggers>
<FPATrigger LaborAccountPattern="//////701"
SequenceNumber="1">
<PayCodes>
<SimpleValue value="All Regular"/>
</PayCodes>
<Allocations>
<FPAAllocation LaborAccountName="101//303//
504//701" WageAdjustmentType="1" Percentage="50"
WageAdjustmentAmount="5.00" />
</Allocations>
</FPATrigger>
<FPATrigger JobCode="Line 1/QCE"
JobCodeEffectiveDate="11/15/2005" SequenceNumber="1">
<PayCodes>
</PayCodes>
<Allocations>
</Allocations>
</FPATrigger>
</Triggers>
</FPARuleVersion>
</FPARuleVersions>
Introduced in v5.2
Name
Percent Allocation Rule Name
The name of the rule

Chapter 2
Type: String
Required Key
Must not be null and between 1 and 30 characters
Sample values:
<FPARule Name="SDM Rule">
Introduced in v5.2

Chapter 2
FPARuleVersion Tag
Percent Allocation Rule Revision
Represents a revision of a FPARule
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddVersionToRule"
Parameters→
AddVersionToRule→
ruleName = String
Properties→
<FPARuleVersion
EndEffectiveDate = Date
StartEffectiveDate = Date >
[<Triggers>
<FPATrigger>*
</Triggers>]
</FPARuleVersion>
Action Descriptions
AddVersionToRule
Adds a new FPA Version to a rule
Required Properties: StartEffectiveDate

Chapter 2

Introduced in v6.0
Action Parameters

ruleName Name of the urle to add this version to Introduced in v6.0
Required
Description
Description
Simple description to describe the revision
Type: String
Optional
Sample values:
Description="Initial Version"
Introduced in v5.2
EndEffectiveDate
End Effective Date
The end date of this revision
Type: Date
Required
Must not be null and be a valid date
Sample values:
EndEffectiveDate="01/01/3000"
Introduced in v5.2

Chapter 2
StartEffectiveDate
Start Effective Date
The date that this revision begins
Type: Date
Required
Must not be null and be a valid date
Sample values:
StartEffectiveDate="01/01/1753"
Introduced in v5.2
Triggers
Triggers
Triggers on a version are used to compare against a total. If the trigger matches
then the total is allocated accordingly to the allocations specified for the total.
Type: Zero or more FPATrigger tags
Optional
Sample values:
<Triggers>
<FPATrigger LaborAccountPattern="//////701"
SequenceNumber="1">
<PayCodes>
<SimpleValue value="All Regular"/>
</PayCodes>
<Allocations>
</Allocations>
</FPATrigger>
<FPATrigger JobCode="Line 1/QCE"
JobCodeEffectiveDate="11/15/2005" SequenceNumber="1">

Chapter 2
<PayCodes>
</PayCodes>
<Allocations>
</Allocations>
</FPATrigger>
</Triggers>
Introduced in v5.2

Chapter 2
FPATrigger Tag
Percent Allocation Rule Trigger
Represents a trigger that is used to determine if a total should be split and
allocated
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"DeleteByTrigger" |
Parameters→
AddTriggerToRule→
ruleName = String
versionStartDate = Date
DeleteByTrigger→
RuleName = String
RuleName = String
Properties→
<FPATrigger
[JobCode = String]
SequenceNumber = Long
[SequenceNumberToMatch = Long] >

Chapter 2
[<Allocations>
<FPAAllocation>*
</Allocations>]
[<PayCodes>
<SimpleValue>*
</PayCodes>]
[<PayCodesToMatch>
<SimpleValue>*
</PayCodesToMatch>]
</FPATrigger>
Action Descriptions
AddTriggerToRule
Adds a new trigger to a rule
Required Properties: LaborAccountPattern, SequenceNumber, Allocations
Introduced in v6.0
Action Parameters

ruleName name of the rule to add this trigger to Introduced in v6.0
Required
versionStartDate The start date of this version. Introduced in v6.0
Required
Validate the date format.
DeleteByTrigger
Deletes a trigger within a Fixed Percent Allocation Rule revision.

Chapter 2

Introduced in v6.1
Action Parameters

RuleName Name of the Percent Allocation Rule Introduced in v6.1
where the trigger will be deleted.
Required
VersionEffectiveDate The effective date of a Percent Introduced in v6.1
Allocation Rule version to where the
trigger will be deleted.
Required
Date must be valid.
UpdateOnlyByTrigger
Updates a trigger within a Fixed Percent Allocation Rule revision.
Introduced in v6.1

Chapter 2
Action Parameters

RuleName Name of the Percent Allocation Rule Introduced in v6.1
Required
VersionEffectiveDate The effective date of a Percent Introduced in v6.1
Allocation Rule containing the
updated trigger.
Required
Date must be valid.
Allocations
Allocations
Specifies how much of a total should be allocated, to where, and at what wage
rate, once the trigger is matched against the original total.
Type: Zero or more FPAAllocation tags
Optional
If allocations are specified then their total percentage must equal to 100
Sample values:
<Allocations>
</Allocations>
Introduced in v5.2

Chapter 2
JobCode
Job Code
The Job that is compared against the trigger when determining if a trigger matches
the total. Used in combination with the labor account pattern and paycodes
Type: String
Optional
Sample values:
JobCode="Line 1/QCE"
Introduced in v5.2
The effective date of the job chosen.
Type: Date
Optional
Sample values:
Introduced in v5.2
JobCodeToMatch
Job Code To Match
must match.
Type: String
Optional

Chapter 2
Sample values:
Introduced in v6.1
LaborAccountPattern
The labor account that will be used to compare against a total. If this and any other
trigger attributes match then the trigger is applied to the total (split)
Type: String
Required
validated to exist
Sample values:
LaborAccountPattern="//////701"
Introduced in v5.2
trigger must match.
Type: String
Optional
validated to exist.
Sample values:

Chapter 2

PayCodes
Pay Codes
paycodes.
Optional
Sample values:
<PayCodes>
</PayCodes>

PayCodesToMatch
Pay Codes To Match
trigger must match.
Optional
Sample values:
<PayCodesToMatch>
</PayCodesToMatch>

Chapter 2
SequenceNumber
Sequence Number
Each trigger is given a sequence number to determine in which order they are
compared against the total. Each trigger should have a unique sequence number.
Type: Long
Required
Must be a valid long
Sample values:
SequenceNumber="1"
Introduced in v5.2
trigger.
Type: Long
Optional
Sample values:

Chapter 2
From Tag
The Kmail sender
Sender of Kmail. This tag appears as a child of the Sender tag of the
EmployeeMessage tag.
Validation done in the FromBean
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<From
Address = String
[PersonKey = String] >
</From>
Address
Email address
email address
Type: String
Required
Introduced in v5.2

Chapter 2
PersonKey
Person key
Person Key
Type: String
Optional
Introduced in v5.2
PersonNumber
Person id
Person id
Type: String
Optional
Introduced in v5.2

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAllFunctionAccessProfiles" |
"LoadById"
Parameters→
None
Properties→
<FunctionAccessProfile
[FunctionAccessProfileId = Integer]
[FunctionAccessProfileName = String] >
</FunctionAccessProfile>
Action Descriptions

Chapter 2
Load
Returns a function access profile, based on FunctionAccessProfileName.
Return Value Type: FunctionAccessProfile tag
Required Properties: FunctionAccessProfileName
Introduced in v4
LoadAllFunctionAccessProfiles
Returns all function access profiles in the system.
Return Value Type: Zero or more FunctionAccessProfile tags
Introduced in v4
LoadById
Returns a function access profile, based on FunctionAccessProfileId.
ID must be valid
Return Value Type: FunctionAccessProfile tag
Required Properties: FunctionAccessProfileId
Introduced in v4
FunctionAccessProfileId
Function access profile ID
Uniquely identifies the function access profile in the database
Type: Integer
Optional
Introduced in v4

Chapter 2
FunctionAccessProfileName
Function access profile name
determines the timekeeping components that users can access and the types of
functions that users can perform within timekeeping, 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. Refer to the timekeeping System Administrator's Guide for an
explanation of the roles.
The following predefined data values are provided:
• IS
• Payroll Manager
• Time Stamp Employee
• Workforce Employee
Type: String
Optional
Default value: Default
Introduced in v4

Chapter 2
GDAPAssignment Tag
Generic Data Access Profile Assignment
This tag lets users associate a generic data access profile with a person.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"ExpireNow" |
"Load" |
"RetrieveByGDAPName" |
"RetrieveByPersonId" |
"RetrieveByPersonIdAndRole" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<GDAPAssignment
DefaultSwitch = Boolean
GDAPName = String
[OriginalEffectiveDate = Date]
[OriginalExpirationDate = Date]
Role = String >
<Identity>
<PersonIdentity>
</Identity>

Chapter 2
</GDAPAssignment>
Action Descriptions
AddOnly
Creates a new GDAP assignment object to associate a Person with a GDAP.
At least one GDAP Assignment must be the default for the user; if this is the first
one, it MUST be set to true. If multiple assignments are made with the default
switch set to true, only the last one in will be the default.
Required Properties: Identity, GDAPName, EffectiveDate, ExpirationDate, Role,
DefaultSwitch
Introduced in v6.0
Delete
Finds an existing GDAP assignment based on the GDAPName and either the
EffectiveDate, the ExpirationDate, or both, and removes that GDAP assignment.
Either EffectiveDate or ExpirationDate or both must be present or an error will be
thrown.
Required Properties: Identity, GDAPName, EffectiveDate and/or ExpirationDate
Introduced in v6.0
ExpireNow
Expires matching GDAP assignment object at current date/time.
GDAP Assignment for this employee must exist with the other matching
properties.
Required Properties: Identity, GDAPName, EffectiveDate, Role

Chapter 2
Introduced in v6.0
Load
Returns a list of GDAPs assigned to the person given in the Identity. If the given
person has no GDAP assignments, the list will be empty. If the person does not
exist an error will be thrown.
Return Value Type: Zero or more GDAPAssignment tags
Introduced in v6.0
RetrieveByGDAPName
Returns an object of type DataAccessGroupAssignmentSet containing all
DataAccessGroupAssignment objects for this GDAP. If no GDAP assignments
can be found for the given GDAPName an error will be thrown.
Required Properties: GDAPName
Introduced in v6.0
RetrieveByPersonId
Returns a list of GDAPs assigned to the person given in the Identity. If the given
person has no GDAP assignments, the list will be empty. If the person does not
exist an error will be thrown.
Introduced in v6.0
RetrieveByPersonIdAndRole
Retrieves a list of GDAP objects for the person specified in the Identity property,
and of the type (Manager, Employee) given in the Role property. If Role is not
specified, this action will effectively be the same as the RetrieveByPersonId

Chapter 2
action. If the person does not have any GDAP assignments, an empty list will be
returned. If the person does not exist, an error will be thrown.
Optional Properties: Role
Introduced in v6.0
Update
Updates an existing GDAP assignment.
Required Properties: Identity, GDAPName, Role, EffectiveDate, ExpirationDate,
DefaultSwitch, OriginalEffectiveDate, OriginalExpirationDate
Introduced in v6.0
UpdateOnly
Updates an existing GDAP assignment object.
Required Properties: Identity, GDAPName, Role, EffectiveDate, ExpirationDate,
DefaultSwitch, OriginalEffectiveDate, OriginalExpirationDate
Introduced in v6.0

Chapter 2
DefaultSwitch
Default Switch
Indicates whether the generic data access profile assignment should be used as the
person's default profile.
Type: Boolean
Required
Should be either "true" or "false".
Sample values:
true

Introduced in v6.0
EffectiveDate
Effective Date
Specify the effective date of the generic data access profile.
Type: Date
Optional
Introduced in v6.0
ExpirationDate
Expiration Date
Specify the expiration date of the generic data access profile.
Type: Date
Optional
Introduced in v6.0
GDAPName
Generic Data Access Profile Name
Specify the name of the generic data access profile to be assigned.
Type: String
Required

Chapter 2
Introduced in v6.0
Identity
Identity
Specify the identity of the person who will be assigned the generic data access
profile.
Required
Introduced in v6.0
OriginalEffective Date
Specify the original effective date of the generic data access profile, which you
can use later for updates.
Type: Date
Optional
OriginalExpirationDate
OriginalExpiration Date
Specify the original expiration date of the generic data access profile, which you
can use later for updates.
Type: Date
Optional
Introduced in v6.0
Role
Role (Manager, Employee)
Specify either "MANAGER_ROLE" or "EMPLOYEE_ROLE" for the role.
Type: String
Required
Must be either "MANAGER_ROLE" or "EMPLOYEE_ROLE"
Introduced in v6.0

Chapter 2
GDAPAssignmentDefaultSwitch Tag
General Data Access Profile Assignment Default
This tag lets you assign users to a default generic data access profile that contains
selected data.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<GDAPAssignmentDefaultSwitch
GDAPName = String
Role = String >
</GDAPAssignmentDefaultSwitch>
Action Descriptions
Update
Changes the default Generic Data Access Profile for the logged on user.
Must have Role and GDAP name
Return Value Type: GDAPAssignmentDefaultSwitch tag
Required Properties: GDAP Name, Role

Chapter 2
Introduced in v6.0
GDAPName
Generic Data Access Profile name
Specify the name of the default generic data access profile for the user that has
signed into the application.
Type: String
Required
Introduced in v6.0
Role
Role
Specify the role of the default generic data access profile assignment.
Type: String
Required
Must be either "MANAGER_ROLE" or "EMPLOYEE_ROLE"
Introduced in v6.0

Chapter 2
GDAPItem Tag
Generic Data Access Profile Item
This tag lets you add generic data access profile items, such as Pay Codes, to the
Data Access Group.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<GDAPItem
Name = String
Type = String >
</GDAPItem>
Name
Name
Specify the name of genric data access profile. Use a name that is meaningful for
your configuration.
Type: String
Required
The name property cannot be empty.
Introduced in v6.0
Type
Type
Specify the type of generic data access profile, for example, Pay Codes.

Chapter 2
Type: String
Required
The Type property cannot be empty.
Introduced in v6.0

Chapter 2
GenericEmployeeCalendar Tag
Default calendar view for employees
The tag for a generic calendar view in a calendar profile used by employees.
A generic calendar is based on a single calendar data set. It includes a default time
period and other attributes that define the calendar display. The generic calendars
that are available, either from the default installation or that you create, are the
basis for calendar profiles that are assigned directly to individuals.
Each generic calendar is specific to either managers or to employees. This tag
applies to generic calendars for employees.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"RetrieveAll" |
"RetrieveById" |
"RetrieveByName" |
"Update"
Parameters→
None
Properties→
<GenericEmployeeCalendar
[TimePeriodId = Integer]
[MonthWidth = Integer]

Chapter 2
[ViewType = Integer]
[Active = Boolean]
Name = String
DataSetName = String
[DisplayName = String] >
</GenericEmployeeCalendar>
Action Descriptions
Add
Adds a generic employee calendar, if the calendar with the same name exists, it
will be updated.
Required Properties: Name, Description, active, dataSetName, displayName,
viewType, monthWidth, timePeriodId
AddOnly
Adds a generic employee calendar, the operation will fail if a calendar with the
same name exists.
Required Properties: Name, Description, active, dataSetName, displayName,
Delete
Deletes a generic employee calendar. The operation will fail if the calendar
doesn't exist.

Chapter 2
RetrieveAll
Returns all the generic employee calendars.
Return Value Type: Zero or more GenericEmployeeCalendar tags
RetrieveAllByName
Searches for generic employee calendars by name.
Searches for generic employee calendars by name and active.
RetrieveById
Returns the specified employee generic calendar. The operation will fail if the
calendar doesn't exist.
Return Value Type: GenericEmployeeCalendar tag
RetrieveByName
Returns the specified generic employee calendar. The operation will fail if the
Return Value Type: GenericEmployeeCalendar tag

Chapter 2

Update
Updates a generic employee calendar. If the calendar doesn't exist, it will be
added.
Optional Properties: newName, Description, active, dataSetId, displayName,
Active
Is the employee calendar active?
True if the default employee calendar view is active; false if it is not.
Type: Boolean
Optional
Sample values:
True

DataSetName
Name of the base calendar data set
The name of the calendar data set that is the basis for the generic calendar. Each
default calendar view is based on a single calendar data set.
Type: String
Required

Chapter 2

Description
Description of the default calendar view
The description of the default calendar view for employees.
Type: String
Optional
DisplayName
Name to display in the user interface
The display name of the default employee calendar view.
Type: String
Optional
MonthWidth
Default number of months to display
Type: Integer
Optional
Name
Name of default calendar view
The unique name of the default view to use for the employee calendar.
Type: String
Required Key

Chapter 2
TimePeriodId
Default date range to display
The date range that the calendar will initially display. If you use a relative range of
dates, you must also enter time periods that are before and after the current date;
the resulting calendar display will include the relative dates that you specify.
Type: Integer
Optional
ViewType
Default time period to display
The default time period display for the calendar. Use 1 for weekly view; 2 for
monthly view; or 3 for multiple months view. To select the number of months in a
multiple month view, use the MonthWidth property.
Type: Integer
Optional

Chapter 2
GenericEmployeeCalendarAPIFacade Tag
Change the default employee calendar view
Creates or modifies the default employee calendar view using Setup Data
Manager.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<GenericEmployeeCalendarAPIFacade
Name = String >
</GenericEmployeeCalendarAPIFacade>
Action Descriptions
RetrieveAllNames
Retrieves all names of Generic Employee Calendars.
Introduced in v5.2

Chapter 2
RetrieveForUpdate
Retrieves the Generic Employee calendar corresponding to the name.
Return Value Type: GenericEmployeeCalendarAPIFacade tag
Introduced in v5.2
Update
Updates the Generic Employee calendar corresponding to name.
Introduced in v5.2
Name
Default employee calendar view name
Name of the default employee calendar view to create or modify.
Type: String
Required Key
Introduced in v5.2

Chapter 2
GenericManagerCalendar Tag
Generic Manager Calendar
The tag for a generic calendar view in a calendar profile used by managers.
A generic calendar is based on a single calendar data set. It includes a default
HyperFind query, a default time period, and other attributes that define the
calendar display. The generic calendars that are available, either from the default
installation or that you create, are the basis for calendar profiles that are assigned
directly to individuals.
Each generic calendar is specific to either managers or to employees. This tag
applies to generic calendars for managers.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"RetrieveAll" |
"RetrieveById" |
"RetrieveByName" |
"Update"
Parameters→
None
Properties→
<GenericManagerCalendar
[NavBarCategoryId = Long]

Chapter 2
DataSetName = Long
Name = String
[HyperFindQueryId = Long]
[Active = Boolean]
[DisplayName = String]
[TimePeriodId = Integer]
[ViewType = Integer]
[MonthWidth = Integer] >
</GenericManagerCalendar>
Action Descriptions
Add
Adds a generic manager calendar, if a calendar with the same name exists, it will
be updated.
Required Properties: name, Description, active, dataSetName, displayName,
viewType, monthWidth, timePeriodId, hperFindQueryId, navBarCategoryId
AddOnly
Adds a generic manager calendar, the operation will fail if a calendar with the
same name exists.
Required Properties: name, Description, active, dataSetName, displayName,
Delete
Deletes a generic manager calendar. The operation will fail if the calendar doesn't
exist.

Chapter 2

RetrieveAll
Returns all the generic manager calendars.
Return Value Type: Zero or more GenericManagerCalendar tags
RetrieveAllByName
Searches for generic manager calendars by name.
Searches for generic manager calendars by name and active.
RetrieveById
Returns the specified generic manager calendar. The operation will fail if the
Return Value Type: GenericManagerCalendar tag
RetrieveByName
Returns the specified generic manager calendar. The operation will fail if the

Chapter 2
Return Value Type: GenericManagerCalendar tag

Update
Updates a generic manager calendar. If the calendar doesn't exist, it will be added.
Optional Properties: newName, Description, active, dataSetId, displayName,
Active
Is the generic manager calendar active?
True if a generic manager calendar is active, false if it's not.
Type: Boolean
Optional
Sample values:
True

DataSetName
Data Set Name
The name of the calendar data set that is the basis for the generic calendar. Each
generic calendar is based on one and only one calendar data set.
Type: Long

Chapter 2
Required
Description
Description
The description of a generic manager calendar.
Type: String
Optional
DisplayName
The display name of the generic manager calendar.
Type: String
Optional
HyperFindQueryId
HyperFind Query Id
The name of the default HyperFind query that this generic calendar will use. Note
that the default HyperFind query is available only on generic calendars for
managers, and not on generic calendars for employees.
Type: Long
Optional
MonthWidth
Width of Month
Type: Integer
Optional

Chapter 2

Name
Generic Manager Calendar Name
The unique name of a generic manager calendar.
Type: String
Required Key
NavBarCategoryId
Category Id of the assigned navigation bar
The navigation bar category for this generic calendar (for example, Timekeeping,
Scheduling, and so on). Note that the navigation bar category is available only on
generic calendars for managers, and not on generic calendars for employees.
Type: Long
Optional
TimePeriodId
Time Period Id
The date range that the calendar will initially display. If you use a relative range of
dates, you must also enter time periods that are before and after the current date;
the resulting calendar display will include the relative dates that you specify.
Type: Integer
Optional
ViewType
View Type
The default time period display for the calendar. Use 1 for weekly view, 2 for
monthly view, or 3 for multiple months view. (You select the number of months
in a multiple month view using the MonthWidth property.)
Type: Integer
Optional

Chapter 2


Chapter 2
GenericManagerCalendarAPIFacade Tag
Generic Manager Calendar Facade
Creates or modifies Generic Manager Calendar using the SDM API.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<GenericManagerCalendarAPIFacade
Name = String >
</GenericManagerCalendarAPIFacade>
Action Descriptions
RetrieveAllNames
Retrieves all names of Generic Manager calendars.
Introduced in v5.2
RetrieveForUpdate
Retrieves the Generic manager calendar corresponding to the name for update
using the SDM API.

Chapter 2
Return Value Type: GenericManagerCalendarAPIFacade tag

Introduced in v5.2
Name
Name
Name
Type: String
Required Key
Introduced in v5.2

Chapter 2
GenericNotification Tag
Generic Notification
This is the XML API used to configure a Generic Notification instance.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Update"
Parameters→
None
Properties→
<GenericNotification
DeliveryDelayAmount = TimeDuration
IsOnceDaily = Boolean
[EmailRecipients = String]
MessageContents = String
Name = String
[SendToEmployee = Boolean]
[SendToManager = Boolean]
SubjectHeading = String >
</GenericNotification>
Action Descriptions

Chapter 2
Delete
This is the action which deletes a previously existing Generic Notification
instance.
The Generic Notification instance must exist.
Introduced in v6.1
This is the action which retrieve all of the configured Generic Notification
instances with the properties necessary for an update.
Return Value Type: Zero or more GenericNotification tags
Introduced in v6.1
RetrieveAllNames
This returns a list of all of the currently configured generic notifications objects.
Introduced in v6.1
RetrieveForUpdate
This is the action which receives a single Generic Notification instance with the
properties necessary for an update.
Return Value Type: GenericNotification tag
Introduced in v6.1

Chapter 2
Update
This action Updates an existing Generic Notification instance if it exists and Adds
it, if it is a new instance.
You can't have BOTH IsOnceDaily and DeliveryDelayAmount
Return Value Type: GenericNotification tag
Required Properties: Name, SubjectHeading, MessageContents
Optional Properties: Description, EmailRecipients, SendToEmployee,
SendToManager, IsOnceDaily, DeliveryDelayAmount
Introduced in v6.1
DeliveryDelayAmount
Delivery delay amount
This is the duration between notifications for an instance of a Generic
Notification. If this property is present, the "Every" radio button under the
Notification Dilivery will be set, as well as the input field being populated with
the correct representation of this value.
Type: TimeDuration
This must be a valid Time Duration value.
Sample values:
1:30 for an HH:MM format.
Introduced in v6.1
IsOnceDaily
Is received once daily
This is the property that denotes whether this is a Generic Notification that should
only be received once a day. This property is used for notification supression.
Type: Boolean
This must be a valid Boolean property.

Chapter 2
Introduced in v6.1
Description
Description
This is the description of the Generic Notification instance.
Type: String
Optional
Introduced in v6.1
EmailRecipients
Email recipients
This is the email list associated with a Genric Notification instance.
Type: String
Optional
The list must be a valid list of email addresses, separated by a valid delimiter. If an
email list is passed in, the SendToEmployee property must be filled.
Sample values:
aaa@mycompany.com,bbb@mycompany.com
Introduced in v6.1
MessageContents
Message contents
This is the property that contains the contents of the message for the Generic
Notification instance.
Type: String
Required
Sample values:
MessageContents="My message body
Employees: <Employee list>
Manager: <Manager name>"
Introduced in v6.1

Chapter 2
Name
Name
This is the name of the Generic Notification instance.
Type: String
Required
Introduced in v6.1
SendToEmployee
Send to employee
This is a boolean that denotes whether a notification is sent to the employee.
Type: Boolean
Optional
This must be a valid Boolean value.
Introduced in v6.1
SendToManager
Send to manager
This is a boolean that denotes whether a notification is sent to the employee's
manager.
Type: Boolean
Optional
This must be a valid Boolean property.
Introduced in v6.1
SubjectHeading
Subject heading
This is the property that contains the subject heading data for the Generic
Notification instance.
Type: String
Required
Introduced in v6.1

Chapter 2

Notification Delivery
The Notification Delivery suppression type
Optional
Group includes: DeliveryDelayAmount, IsOnceDaily

Chapter 2
GenericNotificationTrigger Tag
Generic Notification Trigger
This XML API will cause an existing Generic Notification instance to be
triggered. That is, a notification will be sent using the notification method
configured for the users associated with the notification, the employees passed in,
and/or the email list passed in.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Trigger"
Parameters→
None
Properties→
<GenericNotificationTrigger
[EmailAddresses = String]
Name = String >
[<CustomParameters>
<CustomParameter>*
</CustomParameters>]
[<Employees>
<PersonIdentity>*
</Employees>]
</GenericNotificationTrigger>
Action Descriptions

Chapter 2
Trigger
This Action to trigger an existing Generic Notification.
Return Value Type: Integer
Optional Properties: Employees, EmailAddresses,CustomParameters
Introduced in v6.1
CustomParameters
Custom parameters
This is a list containing any custom parameter tags being sent to the triggered
generic notification. The notification instance must be able to handle these custom
tags.
Type: Zero or more CustomParameter tags
Optional
This must be a vald list of custom paramter objects.
Sample values:
††††††† <CustomParameters>
††††††††††† <CustomParameter Name="TAG1" Value="abc"/>
††††††††††† <CustomParameter Name="TAG2"
Value="12:30pm"/>
††††††† </CustomParameters>
Introduced in v6.1
EmailAddresses
Email addresses
This is the string containing a list of additional email recipients who should
receive the triggered notification.
Type: String
Optional

Chapter 2
The string must contain a valid list of email addresses, separated by a valid
character. Each email addresss must be propery formed.
Sample values:
aaa@mycompany.com;bbb@anycompany.com
Introduced in v6.1
Employees
Employees
This is the list of the additional person identity objects of the employees who
should receive the notification.
Type: Zero or more PersonIdentity tags
Optional
This must be a valid PersonIdenetity object.
Introduced in v6.1
Name
Name
This is the name of the existing Generic Notification instance.
Type: String
Required
Introduced in v6.1

Chapter 2
GenieColumn Tag
Column Definition
The GenieColumn tag contains metadata.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<GenieColumn
ColumnNumber = Integer
ExitNum = Integer
Label = String
Product = String
Width = Integer >
</GenieColumn>
ColumnNumber
Column Number
The position of the column, which can be found in Display Preferences Setup.
Type: Integer
Required
Introduced in v5.2
ExitNum
Exit Number
The extension number. Product and ExitNum makes an unique key to identify a
column data type

Chapter 2
Type: Integer
Required
Introduced in v5.2
Label
Label
The column label, which can be found in Display Preferences Setup.
Type: String
Required
Product
Product
The name of the product that this column belongs to.
Type: String
Required
Introduced in v5.2
Width
Width
The column width in pixels, which can be found in Display Preferences Setup.
Type: Integer
Required
Introduced in v5.2

Chapter 2
GenieRow Tag
Row Definition
The GenieRow tag contains data for a row.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<GenieRow
ColumnN = String
RowKey = Integer >
</GenieRow>
ColumnN
Column referenced in a row
The data for column N in this row. Column N is described by a GenieColumn tag.
Type: String
Required
RowKey
Row Key
The value of this attribute depends on what is loaded:
Detail, QuickFind or Schedule Group Detail: person key
• Roll-Up: labor account name

Chapter 2
• Schedule Roll-Up: schedule group name

Type: Integer
Required
Introduced in v5.2

Chapter 2
GlsegmentDetail Tag
GlSegment Detail
The GLSegmentDetail tag describes the labor level segment information when
two or more location types map to the same labor level.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<GlsegmentDetail
[AllowNewLLEntries = Boolean]
[endSeparatorCharacter = String]
[FillCharacter = String]
[FillPosition = String]
[LaborLevelName = String]
[SegmentLength = Integer]
[SegmentNumber = Integer] >
</GlsegmentDetail>
AllowNewLLEntries
Allow New labor Level Entry
Specify whether you can create new labor level entries as part of creating new
locations for this location type. Specify either yes or no.
Type: Boolean
Optional
Introduced in v6.0

Chapter 2
endSeparatorCharacter
End Separator Character
Specify the character used to separate segments of a labor level entry.
Type: String
Optional
the length is 1
Introduced in v6.0
FillCharacter
Filled Character
Specify the character used to complete a labor level entry when an organizational
job does not contain all the location types that are associated with a segmented
labor level.
Type: String
Optional
the length is 1
Introduced in v6.0
FillPosition
Filled Position
Specify the position to insert a fill character when a segment of the labor level
entry does not meet the segment length criteria.
Type: String
Optional
either "Trailing" or "Leading"
LaborLevelName
Labor level definition name
Specify the name of labor level to which the location type maps.
Type: String
Optional

Chapter 2
must be exist in the system

Introduced in v6.0
SegmentLength
Segment Length
Specify the number of characters in the labor level segment to which the location
type maps.
Type: Integer
Optional
Introduced in v6.0
SegmentNumber
Segment Number
Specify the part of a labor level entry to which the location type maps.
Type: Integer
Optional

Chapter 2
GroupMembership Tag
Group Membership
The GroupMembership tag identifies employees who belong to a group during a
specified time period.
Used by: ScheduleGroup
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<GroupMembership
EffectiveDateSpan = DateSpan >
<Employee>
</Employee>
</GroupMembership>
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

Chapter 2
Employee
Employee
One employee who belongs to the group, as specified in a PersonIdentity or
CurrentUser tag.
Required
Introduced in v4

Chapter 2
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
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<Headcount
DayOfWeek = String
NumberOfStaffs = Integer >
</Headcount>
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

Chapter 2
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.
Enumerated value: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday,
Saturday, Anyday
NumberOfStaffs
Number of staff required
The total number of staff required for a given day of the week
Type: Integer
Required
Introduced in v5.0

Chapter 2
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
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<HeadcountPattern
WorkloadSpanName = String >
<Headcounts>
<Headcount>*
</Headcounts>
</HeadcountPattern>
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.

Chapter 2
Type: Zero or more Headcount tags

Required
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

Chapter 2
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.
Note: Day-based pay codes and duration pay codes are not supported.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddComment" |
"AddOnly" |
"Delete"
Parameters→
AddOnly→
[AccrualOverride = Boolean]
[allowAdHoc = Boolean]
[EchoData = Boolean]
Properties→
<HistoricalPayCodeEdit
[ImpactsAccrualsFlag = Boolean]
(EnteredOnDate = Date)
HistoricalDate = Date
Date = Date
[PaidFlag = Boolean]
(EnteredOnTime = Time)

Chapter 2
[<Notes>
<Note>*
</Notes>]
(<Comments>
<Comment>*
</Comments>)
<Employee>
</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.
Required Properties: AmountInTimeOrCurrency, CommentText, Date,
HistoricalDate, Employee, PayCodeName
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
Introduced in v4

Chapter 2
Action Parameters

AccrualOverride If the action results in an accrual Introduced in v4
warning, the warning is overridden
when AccrualOverride = True.
Optional
allowAdHoc Specifies whether an ad hoc labor Introduced in v5.0; last changed
level is allowed. in v5.0; deprecated in v5.0. Not
Optional used
EchoData If True, the Response includes a copy Introduced in v4
of this tag.
Optional
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.
Required Properties: AmountInTimeOrCurrency, Date, HistoricalDate,
Employee, PayCodeName
Introduced in v4
Amount of pay code, in time or currency
A value that can represent money or time, depending on the PayCodeName.

Chapter 2
The value is a monetary amount if PayCodeName is a money type or time if

PayCodeName is a time type.
Type: String
Required, Key
Maximum of 30 characters.
Comments
Comments
The set of comments currently associated with this timekeeping item.
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
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, Key

Chapter 2
Introduced in v4
Employee
Employee
One employee for whom the edit applies, as specified in a PersonIdentity or
CurrentUser tag.
Required, Key
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, Key
The specified date must be within a locked pay period.
Introduced in v4

Chapter 2
ImpactsAccrualsFlag
Accrual balance adjusted based on historical amount?
Determines whether the accrual balances should be adjusted based on the
historical amount.
Its value is:
• False if the employee's accrual balances should not be adjusted based upon
the historical amount entered
• True if the employee's accrual balances should be adjusted based upon the
historical amount entered
Type: Boolean
Optional
Introduced in v4
LaborAccountName
Labor account
The name of the labor account of the employee whose pay code amount or totaled
amount is being edited. It is required when the pay code edit, historical edit, or
totaled amount being deleted or commented, contained an explicit value. This
property need not be specified if the pay code amount or totaled amount applies to
the employee's primary account. It is required if you are deleting or adding a
comment to a pay code edit that contains an explicit LaborAccountName value.
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, using the following format: 101/202/303/404/504/603/702.
Do not specify 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 are the same as the employee's primary labor account,
Type: String

Chapter 2
Optional
Default value: Primary account for the employee
Notes
Comment Note
Optional
Introduced in v6.0
PaidFlag
Included in totals for the employee?
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
PayCodeName
Pay code
Identifies the name of the pay code that is being applied to an amount associated
with a historical amount.

Chapter 2
A pay code represents an amount in time or currency. 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, Key
Introduced in v4
WorkRuleName
Work rule
DEPRECATED. Name of the work rule. A work rule applies specific payroll rules
to shifts that determine how employee hours accrue.
• &ALL_WORK_RULES
• &EMPTY
Type: String
Optional
You can find values in Setup.
Introduced in v4; deprecated in v5.0

Chapter 2
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.
Note: Day-based pay codes and duration pay codes are not supported.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddComment" |
"AddOnly" |
"Delete"
Parameters→
AddOnly→
Properties→
<HistoricalPayCodeMove
[ImpactsAccrualsFlag = Boolean]
Date = Date
HistoricalDate = Date
[PaidFlag = Boolean]

Chapter 2
FromLaborAccountName = String
[<Notes>
<Note>*
</Notes>]
(<Comments>
<Comment>*
</Comments>)
<Employee>
</Employee>
</HistoricalPayCodeMove>
Action Descriptions
AddComment
Adds a comment to the set of comments associated with this historical pay code
move.
FromLaborAccountName, FromPayCodeName, HistoricalDate, Employee,
PayCodeName
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

Chapter 2
Introduced in v4
Action Parameters

when AccrualOverride = True.
Optional
Optional used
of this tag.
Optional
Delete
Marks all historical pay code edits for an employee that match a set of specified
requirements for deletion.
FromPayCodeName, HistoricalDate, Employee, PayCodeName
Introduced in v4
Amount of pay code, expressed as a time duration or a currency.
Type: String

Chapter 2
Required, Key
Whether the value is expressed as a time duration or a currency depends on the
pay code.
Both PayCodeName and FromPayCodeName must identify pay codes that are of
the same payment type; either time or currency.
Introduced in v4
Comments
Comments
The set of comments currently returned with this timekeeping item.
Output Only
Introduced in v4
CommentText
Comment text
A comment that you can add with this edit
Type: String
Optional
Must match exactly an applicable comment that already exists in the database.
The string matching is case-sensitive.
Introduced in v4
Date
Effective date of the edit
The date on which the edit is applied to correct an event that occurred on the
HistoricalDate.
Type: Date
Required, Key

Chapter 2
Introduced in v4
Employee
Employee
The employee for whom the edit applies, as specified in a PersonIdentity or
CurrentUser tag.
Required, Key
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, Key

Chapter 2
Ad hoc creation of labor level entries is not supported; the labor level entries must
exist.
FromPayCodeName
Pay code that the amount is moved from
If moving an amount from one pay code to another, the pay code from which the
amount is to be moved.
Type: String
Required, Key
Both PayCodeName and FromPayCodeName must be associated with the same
type of payment; either time or currency.
HistoricalDate
Historical date to which the edit applies
The past date which this edit is correcting. It can be at or prior to the employee's
current signoff timestamp.
Type: Date
Required, Key
Introduced in v4
ImpactsAccrualsFlag
Check edit against accrual balance?
Indicates whether this edit should be checked against the employee's accrual
balances
Determines whether the accrual balances should be adjusted based on the
historical amount
Its value is:
• 0 if the employee's accrual balances should not be adjusted based upon the

Chapter 2
• 1 if the employee's accrual balances should be adjusted based upon the

Type: Boolean
Optional
Introduced in v4
LaborAccountName
Labor account
If moving time from one labor account to another, the name of the labor account
to which a pay code amount or totaled amount is being applied.
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 contained 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 timekeeping
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
Type: String
Optional
Notes
Comment Notes

Chapter 2
Optional
Introduced in v6.0
PaidFlag
Included in totals for the employee
Indicates whether this item is included in the employee's totals.
Type: Boolean
Optional
Default value: Included in employeestotals'
Introduced in v6.1
PayCodeName
Pay code
If moving an amount from one pay code to another, the pay code to which the
amount is to be moved.
Type: String
Required, Key
Both PayCodeName and FromPayCodeName must be associated with the same
type of payment; either time or currency.
WorkRuleName
Work rule
Name of the work rule
• &ALL_WORK_RULES
• &EMPTY
Type: String
Optional

Chapter 2

Introduced in v4; deprecated in v5.0

Chapter 2
HistoryDetails Tag
History Details
Details of an action in the launch of the PSE.
Introduced in v6.0
Syntax
None

Chapter 2
Holiday Tag
Holiday
The Holiday tag denotes a predefined holiday period. The Holiday and
WSAHoliday tags refer to the same database object.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAllHolidaysInSpan"
Parameters→
None
Properties→
<Holiday
[Name = String] >
</Holiday>
Action Descriptions
Load
Returns the named holiday for the specified time span.
Return Value Type: Holiday tag
Required Properties: Name, DateTimeSpan

Chapter 2
LoadAllHolidaysInSpan
Returns all holidays that are effective within the specified date span.
Return Value Type: Zero or more Holiday tags
Required Properties: DateTimeSpan
Introduced in v4
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

Chapter 2
HolidayDetailData Tag
Holiday Detail Data
The detail attendance data for one holiday used in India Statutory Reports.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<HolidayDetailData
(Date = Date)
(EmployeeID = Long)
(HolidayString = String) >
(<Employee>
<Personality>
</Employee>)
</HolidayDetailData>
Date
Date
The date of the holiday.
Type: Date
Output only
Introduced in v6.1
Employee
Employee
The employee's personality data.

Chapter 2

Output only
Introduced in v6.1
EmployeeID
Employee ID
The employee's ID.
Type: Long
Output only
Introduced in v6.1
HolidayString
Holiday string
The string that describes the attendance status of the holiday. Null-the holiday was
not configured in the employee's payrule; "N/E"- the employee is not eligible for
the holiday; "H"- the employee took the holiday; "W/H"-the employee worked on
that holiday; "W/D"- the employee worked and got double or more paid for that
day.
Type: String
Output only
Enumerated value: null, "N/E", "H", "W/H", "W/D"
Introduced in v6.1

Chapter 2
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.
Introduced in v4
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<HolidayEditHours
(AmountInTimeOrCurrency = String)
(Date = Date)
(HolidayName = String)
(IsCurrencyFlag = Boolean)
(PayCodeName = String) >
</HolidayEditHours>
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

Chapter 2
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
HolidayName
Holiday
Type: String
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
Must always be False
Enumerated value: False
Introduced in v4
PayCodeName
Pay code
The pay code to be credited with the amount
Type: String
Output Only
Enumerated value: Holiday

Chapter 2
Introduced in v4

Chapter 2
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.
Introduced in v4
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<HolidayEditWages
(Date = Date)
(HolidayName = String)
</HolidayEditWages>
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

Chapter 2
Date
Type: Date
Output Only
Sample values:
Introduced in v4
HolidayName
Holiday
Type: String
Output Only
Introduced in v4
IsCurrencyFlag
False indicates that the pay code represents a monetary item.
Type: Boolean
Output Only
Must always be True
Enumerated value: True
Introduced in v4
PayCodeName
Pay code
Type: String
Output Only
Enumerated value: Holiday

Chapter 2
Introduced in v4

Chapter 2
HomeAccount Tag
Home Account
The HomeAccount tag denotes the labor account assigned for the specified time
frame.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<HomeAccount
LaborAccountName = String >
</HomeAccount>
EffectiveDate
Effective date
The date when the home labor account status becomes effective
Type: Date
Required
Introduced in v4; last changed in v5.0; deprecated in v5.0. Use this property in the
PrimaryLaborAccount tag instead.

Chapter 2
ExpirationDate
Expiration date
The date when the home labor account expires
Type: Date
Optional
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.
Type: String
Required Key

Chapter 2
HoursCategory Tag
Hours Category
Hours category defines the jobs and / or the pay codes that will be will be
associated to a hours category set.
Hours categories can be defined by a list of jobs and / or pay codes with the
percentage of shift time that corresponds to jobs or pay code edits. If no jobs or
pay codes are specified, then all jobs and / or pay codes will be used.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"DeleteOnly" |
"Retrieve" |
"RetrieveAll" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<HoursCategory
Name = String >

Chapter 2
[<HoursCategoryJobs>
<HoursCategoryJob>*
</HoursCategoryJobs>]
[<HoursCategoryPayCodes>
<HoursCategoryPayCode>*
</HoursCategoryPayCodes>]
</HoursCategory>
Action Descriptions
Add
Adds a hours category. If the hours category already exists, it will be updated,
otherwise it will be added.
The name cannot be blank.
Optional Properties: Description, HoursCategoryJobs, HoursCategoryPayCodes
Introduced in v6.1
AddOnly
Adds a hours category. An error will be thrown if the hours category already
exists.
Introduced in v6.1
Delete
Deletes the hours category for the specified name. If the hours category does not
exist, no error will occur.

Chapter 2

Introduced in v6.1
DeleteOnly
Deletes the hours category for the specified name. If the hours category does not
exist, an error will be thrown.
Introduced in v6.1
Retrieve
Returns the hours category for the specified name.
Return Value Type: HoursCategory tag
Introduced in v6.1
RetrieveAll
Returns all the hours categories.
Return Value Type: Zero or more HoursCategory tags
Introduced in v6.1
Returns all the hours categories.
Return Value Type: Zero or more HoursCategory tags

Chapter 2

Introduced in v6.1
RetrieveAllNames
Returns all the hours category names.
RetrieveForUpdate
Returns the hours category for the specified name.
Return Value Type: HoursCategory tag
Introduced in v6.1
Update
Updates an existing hours category. If the hours category does not exist, it will be
added.
Introduced in v6.1
UpdateOnly
Updates an existing hours category. An error will be thrown if the hours category
does not exist.

Chapter 2

Introduced in v6.1
Description
Description
Description of hours category.
Type: String
Optional
The max length for the description is 250 characters.
HoursCategoryJobs
Jobs
List of jobs for the hours category.
Type: Zero or more HoursCategoryJob tags
Optional
HoursCategoryPayCodes
Pay Codes
List of pay codes for the hours category.
Type: Zero or more HoursCategoryPayCode tags
Optional
Name
Name
The name of the hours category.
Type: String

Chapter 2
Required Key
The name cannot be blank and the max length is 50 characters.

Chapter 2
HoursCategoryComponent Tag
Hours Category Component
The hours category that will be associated to a hours category set.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<HoursCategoryComponent
Name = String >
</HoursCategoryComponent>
Name
Name
The name of the hours category.
Type: String
Required Key

Chapter 2
HoursCategoryJob Tag
Hours Category Job
Defines the jobs that will be used to group metrics indicators.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<HoursCategoryJob
Name = String
Percentage = Double >
</HoursCategoryJob>
Name
Name
The name of the job.
Type: String
Required Key
Percentage
Percentage
Percentage to multiply the hours for the specified job.
Type: Double

Chapter 2
Required
Value must be greater then 0 and less then or equal to 100.

Chapter 2
HoursCategoryPayCode Tag
Hours Category Pay Code
Defines the pay codes that will be used to group metrics indicators.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<HoursCategoryPayCode
Name = String
Percentage = Double >
</HoursCategoryPayCode>
Name
Name
The pay code name.
Type: String
Required Key
Percentage
Percentage
Percentage to multiply the hours for the specified pay code.
Type: Double

Chapter 2
Required
Value must be greater then 0 and less then or equal to 100.

Chapter 2
HoursCategorySet Tag
Hours Category Set
Hours category sets define a list of hours categories that will be associated to a
metrics setting.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"DeleteOnly" |
"Retrieve" |
"RetrieveAll" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<HoursCategorySet
Name = String >
<HoursCategories>
<HoursCategoryComponent>*
</HoursCategories>
</HoursCategorySet>

Chapter 2
Action Descriptions
Add
Adds a hours category set. If the hours category set already exists, it will be
updated, otherwise it will be added.
The name cannot be blank and the hours category component must contain at least
one hours category.
Required Properties: Name, HoursCategoryComponent
Introduced in v6.1
AddOnly
Adds a hours category set. An error will be thrown if the hours category set
already exists.
one hours category.
Introduced in v6.1
Delete
Deletes the hours category set for the specified name. If the hours category set
does not exist, no error will occur.
Introduced in v6.1

Chapter 2
DeleteOnly
Deletes the hours category set for the specified name. If the hours category set
does not exist, an error will be thrown.
Introduced in v6.1
Retrieve
Returns the hours category set for the specified name.
Return Value Type: HoursCategorySet tag
Introduced in v6.1
RetrieveAll
Returns all the hours category sets.
Return Value Type: Zero or more HoursCategorySet tags
Introduced in v6.1
Returns all the hours category sets.
Return Value Type: Zero or more HoursCategorySet tags
Introduced in v6.1
RetrieveAllNames
Returns all the hours category set names.

Chapter 2

RetrieveForUpdate
Returns the hours category set for the specified name.
Return Value Type: HoursCategorySet tag
Introduced in v6.1
Update
Updates an existing hours category set. If the hours category set does not exist, it
will be added.
one hours category.
Introduced in v6.1
UpdateOnly
Updates an existing hours category set. An error will be thrown of the hours
category set does not exist.
one hours category.
Introduced in v6.1

Chapter 2
Description
Description
The hours category set description.
Type: String
Optional
The max length for the description is 250 characters.
HoursCategories
Hours Categories
List of hours categories that will be associated to the hours category set.
Type: Zero or more HoursCategoryComponent tags
Required
Name
Name
The hours category set name.
Type: String
Required Key

Chapter 2
HoursSummary Tag
Hours summary for a location
This tag contains the summary of the hours for a specific location.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<HoursSummary
Amount = String
OrgPath = String
SummaryType = String
ValueType = String >
</HoursSummary>
Amount
Amount
Specify the amount of hours.
Type: String
Required
Sample values:
42.5000
Introduced in v6.0

Chapter 2
OrgPath
Organizational Path
Specify the organizational node path.
Type: String
Required
Sample values:
Organization/Hospitals/Hosp A/Floor 1/ER
Introduced in v6.0
SummaryType
Summary Type
Specify the hours summary for a location type.
Type: String
Required
Sample values:
Location
Introduced in v6.0
ValueType
Value Type
Specify the hours summary value type.
Type: String
Required
Sample values:
GrandSum
Introduced in v6.0

Chapter 2
HoursSummaryService Tag
Hours summary items for a location
This service returns all the summary items for a list of locations. Each summary
item hold the sum (in hours) of the durations of all ProductiveShifts and PayCodes
in the schedule container associated with the specified locations and date range.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve"
Parameters→
None
Properties→
<HoursSummaryService
[<Locations>
<LocationItem>*
</Locations>]
</HoursSummaryService>
Action Descriptions
Retrieve
Retrieves all the Summary Items for the given date period and for the given list of
locations.
Return Value Type: Zero or more HoursSummary tags

Chapter 2

Introduced in v6.0
Locations
Locations for hours summary
Optional
Sample values:
<Locations>
A/Floor 1/ER"/>
A/Floor 1/Pediatrics"/>
</Locations>
Introduced in v6.0
QueryDateSpan
Date range for hours summary
Type: String
Required
Sample values:
<QueryDateSpan> 11/1/2005 - 11/5/2005</QueryDateSpan>
Introduced in v6.0

Chapter 2
HPPDItem Tag
HPPD item
The HPPDItem tag contains information about HPPD data.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<HPPDItem
[DataTypeName = String]
[Contribute = String]
[ValueTypeName = String]
[Amount = String]
OrgPath = String >
</HPPDItem>
Amount
Hours, or float number
Amount of either hours or float number.
Type: String
Optional
For action update, it has to be a number.

Chapter 2
Contribute
Direct, indirect, or total
Contribute is one of the following: Direct, Indirect or Total.
Type: String
Optional
For action update, it must be one of the follows: Direct, Indirect.
DataTypeName
Budgeted, Actual, Scheduled, or Variance
DataTypeName is one of the following: Budgeted, Actual, Scheduled or Variance.
Type: String
Optional
It must be either Budgeted or Actual in action Update.
EffectiveDate
Effective date of HPPD assignment
The effective date of a HPPD assignment.
Type: Date
Optional Key
OrgPath
Location in organizational map
The Location in the organization tree.
Type: String
Optional Key
It must be a valid location path.

Chapter 2
ValueTypeName
HPPD, Hours, or Volume
ValueTypeName holds the one of the following values: HPPD, Hours, or Volume.
Type: String
Optional
It must be "HPPD" for action update.

Chapter 2
HPPDService Tag
HPPD Service
The HPPDService tag updates or retrieves HPPD values by a giving location and
date.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"Update"
Parameters→
None
Properties→
<HPPDService
[QueryDateSpan = DateSpan]
OrgPath = String >
[<Items>
<HPPDItem>*
</Items>]
</HPPDService>
Action Descriptions
Retrieve
This action retrieves a list of hppd data for a specified location and date range.
Return Value Type: Zero or more HPPDItem tags

Chapter 2
Required Properties: OrgPath, QueryDateSpan

RetrieveForUpdate
This action retrieves HPPD data stored in the database and ready for update.
Return Value Type: Zero or more HPPDItem tags
Required Properties: OrgPath, QueryDateSpan
Update
This action will either insert or update a list of HPPD items onto a database table.
Required Properties: Items
Introduced in v5.2
Items
HPPD items
A list of HPPD items.
Type: Zero or more HPPDItem tags
Optional
Introduced in v5.2
OrgPath
Org node path
Location in the organization tree.
Type: String
Optional Key

Chapter 2

QueryDateSpan
Date span
This property represents a date span for query the hppd values.
Type: DateSpan
Optional
Introduced in v5.2

Chapter 2
HPPDSummary Tag
Hours/Volume Summary
This tag provides hours per per patient day (HPPD) summary data for various
levels of your organization.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<HPPDSummary
Amount = String
Contribute = String
DataTypeName = String
OrgPath = String
ValueType = String >
</HPPDSummary>
Amount
Amount
Specify the hours per patient day summary amount value.
Type: String
Required
Sample values:
12.50
Introduced in v6.0

Chapter 2
Contribute
Contribute
Specify the hours per patient day summary contribution value, which can be
direct, indirect or total.
Type: String
Required
Sample values:
Direct
Introduced in v6.0
DataTypeName
Data Type Name
Specify the hours per patient day summary data type, which can be budgeted,
target or actual.
Type: String
Required
Sample values:
Budgeted
Introduced in v6.0
OrgPath
Organizational map path
Represents the organizational map path for the hours per patient day summary
information.
Type: String
Required
Sample values:

Chapter 2
ValueType
Value Type
Represents the hppd summary value type, which can be hours, volume or hppd.
Type: String
Required
Sample values:
Hours
Introduced in v6.0

Chapter 2
HPPDSummaryService Tag
HPPD Summary Service
This service returns all the hppd summary items for a list of locations. Each
summary item hold the sum of hppd infos associated with the specified locations
and date range.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve"
Parameters→
None
Properties→
<HPPDSummaryService
QueryDateSpan = DateSpan >
[<Locations>
<LocationItem>*
</Locations>]
</HPPDSummaryService>
Action Descriptions
Retrieve
Returns the hppd summary data for the specified date span and list of locations. If
no location is specified, the home locations will be used.
Return Value Type: Zero or more HPPDSummary tags

Chapter 2

Introduced in v6.0
Locations
Locations
Represents the locations for the hppd summary data to be retrieved.
Optional
Sample values:
Introduced in v6.0
QueryDateSpan
Query Date Span
Represents the date span for the hppd summary to retrieve.
Type: DateSpan
Required
Sample values:
11/01/2005 - 11/05/2005
Introduced in v6.0

Chapter 2
HyperFindProfile Tag
HyperFind Profile
View, list, create, delete, duplicate, and update a HyperFind profile.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"Duplicate" |
"Retrieve" |
"RetrieveAll" |
"UpdateEntryList" |
"UpdateOnly"
Parameters→
Duplicate→
Name = String
UpdateEntryList→
[NewName = String]
UpdateOnly→
[NewName = String]
Properties→
<HyperFindProfile
Name = String >
<HyperFindEntries>
<LightWeightQuery>*
</HyperFindEntries>
</HyperFindProfile>

Chapter 2
Action Descriptions
AddOnly
not exceed 250. HyperFindEntries is defined as list of LightWeightQuery bean
List.The list of HyperFindEntries is required. They need to be existing hyperfind
queries.
not exceed 250. HyperFindEntries is defined as list of LightWeightQuery bean
List.The list of HyperFindEntries is required. They need to be existing hyperfind
queries.
Required Properties: Name, HyperFindEntries
Introduced in v6.1
Delete
The name of a existing HyperFind Profile.
The name of a existing HyperFind Profile.
Introduced in v6.1
Duplicate
The name should be an existing HyperFind profile's name.
The name should be an existing HyperFind profile's name.
Introduced in v6.1

Chapter 2
Action Parameters

Name The Name should be the name of an Introduced in v6.1
existing hyperfind query.
Required
The Name should be the name of an
existing hyperfind query.
Retrieve
Specify the name of the HyperFind profile to be retrieved; the name should not
Introduced in v6.1
RetrieveAll
Introduced in v6.1
UpdateEntryList
This action should add a list of hyperfind queries but not delete the existing
queries. This is the difference between the UpdateEntryList and UpdateOnly.
Parameter NewName is used when rename a hyperfind profile. The length of
Name should not exceed 50. The length of Description should not exceed 250.
Hyperfind is defined as list of
LightWeightQuery bean List. The list is required.

Chapter 2

Action Parameters

NewName The name for the hyperfind profile Introduced in v6.1
should be unique.
Optional
The name for the hyperfind profile
should be unique.
UpdateOnly
HyperFindEntries
Parameter NewName is used when rename a hyperfind profile. The length of
Name should not exceed 50. The length of Description should not exceed 250.
Hyperfind is defined as list of
LightWeightQuery bean List. The list is required.
Optional Properties: Name, Description

Chapter 2
Action Parameters

NewName The new name should be unique. Introduced in v6.1
Optional
Description
#unassigned#
The description of the hyperfind profile; it can be any text you want.
Type: String
Optional
The size can't exceed 250 characters.
Introduced in v6.1
HyperFindEntries
#unassigned#
A list of existing hyperfind queries.
Type: Zero or more LightWeightQuery tags
Required
A list of existing hyperfind queries.
Introduced in v6.1
Name
#unassigned#
The name of hyperfind profile. The length should not exceed 50. If it is used for
Type: String
Required
The name of hyperfind profile. The length should not exceed 50. If it is used for

Chapter 2
Introduced in v6.1

Chapter 2
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
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"GetQueryCount" |
"LoadAllQueries" |
"RunQuery"
Parameters→
None
Properties→
<HyperFindQuery
[QueryPersonOrEmployee = String]
HyperFindQueryName = String
[QueryIncludeWTKEmployeeFlag = Boolean]
[QueryIncludePersonFlag = Boolean]
[QueryIncludeUserFlag = Boolean]
VisibilityCode = String >
</HyperFindQuery>
Action Descriptions

Chapter 2
GetQueryCount
Returns the number of people that can be returned by the HyperFind query.
Required Properties: HyperFindQueryName, VisibilityCode, QueryDateSpan,
QueryPersonOrEmployee
Introduced in v4
LoadAllQueries
Returns a list of all HyperFind queries.
Return Value Type: Zero or more HyperFindQuery tags
Required Properties: VisibilityCode
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,
Introduced in v4
Description
Description of query
Describes the HyperFind query
Type: String
Output Only

Chapter 2
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 Key
The names of HyperFind queries can be found in the Workforce Central user
interface.
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
QueryIncludePersonFlag
Include person data?
Indicates whether to include information from the Person tag in the result
Type: Boolean
Optional
QueryIncludeUserFlag
Include user account data?
Indicates whether to include information from the UserAccount tag in the result
Type: Boolean
Optional

Chapter 2

QueryIncludeWTKEmployeeFlag
Include employee data?
Indicates whether to include information from the WTKEmployee tag in the result
Type: Boolean
Optional
Category (person, employee, job assignment) for query
The type of person being requested in the query
Type: String
Optional
Enumerated value: Person, Employee, Job Assignment
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 Key
Note: For a Personal HyperFind, use the value Private.
Enumerated value: Public, Private

Chapter 2
HyperFindResult Tag
Result of Query
The HyperFindResult tag returns the result of running a HyperFind query.
Used by: HyperFindQuery
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<HyperFindResult
(FullName = String)
(<WTKEmployeeData>
<WTKEmployee>
</WTKEmployeeData>)
(<PersonData>
<Person>
</PersonData>)
(<UserAccountData>
<UserAccount>
</UserAccountData>)
</HyperFindResult>
FullName
Full name
Name of the resulting person
Type: String
Output Only

Chapter 2

Introduced in v4
PersonData
Person data
Information about the resulting person
Type: Person tag
Output Only
Dependency: Only contains a value when the QueryIncludePersonFlag property
in the HyperFindQuery is True
Introduced in v4
PersonNumber
Person number
Type: String
Output Only
Introduced in v4
UserAccountData
User account data
The User Account tag for the resulting person
Type: UserAccount tag
Output Only
Dependency: Only contains a value when the QueryIncludeUserAccountFlag
property in the HyperFindQuery is True
Introduced in v4
WTKEmployeeData
Employee data
WTKEmployee tag for the resulting person
Type: WTKEmployee tag
Output Only

Chapter 2
Contains a value when the QueryIncludeWTKEmployeeFlag property in the

HyperFindQuery is True
Introduced in v4

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"LoadAllBatchNames" |
"Update"
Parameters→
None
Properties→
<ImportBatchStatus
(BatchDescription = String)
[BatchName = String]
BatchStatId = Long
[ErrorText = String]
(BatchType = String)
[SuccessRecordCount = Integer]
[FailedRecordCount = Integer]
[BatchProcessStatus = String]
[TotalRecordCount = Integer]
[TransactionType = String] >
</ImportBatchStatus>

Chapter 2
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.
Return Value Type: ImportBatchStatus tag
Required Properties: BatchName
Introduced in v5.0
LoadAllBatchNames
Returns all batch name information in the database.
The response status is Failure if the request finds no records.
Return Value Type: Zero or more ImportBatchStatus tags
Update
Adds a new batch status record or updates an existing one.
The BatchProcessStatus must exist in the ImportProcStat table and the
TransactionType must exist in the ImportCntntType table. Otherwise, the tag
returns a status of Failure.
Required Properties: BatchStatId, TransactionType, BatchProcessStatus
Optional Properties: ErrorText, TotalRecordCount, SuccessRecordCount,
FailedRecordCount
Introduced in v5.0

Chapter 2
BatchDescription
Batch description
The BatchDescription contains the same value as BatchName.
Type: String
Output only
Introduced in v5.0
BatchName
Batch name
A user defined Import Batch name.
Type: String
Optional
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
Must be one of the identified values
Enumerated value: IN PROCESS, COMPLETE, INTERRUPTED BY USER,
TERMINATED
Introduced in v5.0

Chapter 2
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 Key
Introduced in v5.0
BatchType
Import type (table or XML)
The type of batch import
Type: String
Output only
Enumerated value: Table Import, XML Import
Introduced in v5.0
ErrorText
Description of error
The error text for the batch
Type: String
Optional
Sample values:
Normal Completion
Introduced in v5.0

Chapter 2
FailedRecordCount
Number of records processed unsuccessfully
The total number of records that were not successfully processed in the batch. The
client can provide the total record count at the beginning of the batch; then
provide this information and the success count at the conclusion.
Otherwise, the system can update these values for each record.
Type: Integer
Optional
Introduced in v5.0
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

Chapter 2
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

Chapter 2
Indicator Tag
Schedule Metrics Indicator
Indicators that define a statistical measure for Metrics functionality
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"DeleteOnly" |
"Retrieve" |
"RetrieveAll" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<Indicator
FormulaName = String
Name = String >
</Indicator>
Action Descriptions

Chapter 2
Add
Add an indicator object into the system. If it already exists an update is performed
Required Properties: Name, FormulaName
AddOnly
Add an indicator object into the system. If it already exists an error is thrown.
Delete
Delete an iindicator object. If the object doesn't exist, no exception will be thrown.
Introduced in v6.1
DeleteOnly
Delete an indicator object. If doesn't exist an exception is thrown
Introduced in v6.1
Retrieve
Returns an indicator object given the name.

Chapter 2
Return Value Type: Indicator tag

Introduced in v6.1
RetrieveAll
Returns all indicator expressions.
Return Value Type: Zero or more Indicator tags
Introduced in v6.1
Return a list of indicator objects. This action is used for future updates.
Return Value Type: Zero or more Indicator tags
Introduced in v6.1
RetrieveAllNames
Return all indicator object names.
RetrieveForUpdate
Return the indicator object. This action is used for future updates.
Return Value Type: Indicator tag
Introduced in v6.1
Update
Update the indicator object.If it does not exist an add is performed

Chapter 2

UpdateOnly
Update an indicator object. If it does not exist an error is thrown.
Introduced in v6.1
Description
Description
The description of this indicator
Type: String
Optional
FormulaName
Formula Name
Specify the formula used for metrics evaluation.
Type: String
Required
Must be the name of an existing Formula.
Sample values:
<Request Action="Add">
<Indicator Name="indicator 1" Description="indicator
sample setting"

Chapter 2
FormulaName="SERVICE_LEVEL"/>
</Request>

Name
Name
The name of this indicator
Type: String
Required Key
Sample values:
<Indicator Description="indicator sample setting."
Name="indicator 1">

Chapter 2
IndicatorOperation Tag
Indicator Operation
An Indicator operation defines the way a total on indicators is calculated (for
example sum, average, max, min)
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames"
Parameters→
None
Properties→
<IndicatorOperation
(I18Name = String)
Name = String >
</IndicatorOperation>
Action Descriptions
Retrieve
Returns the IndicatorOperation object with the given name
Return Value Type: IndicatorOperation tag

Chapter 2
Introduced in v6.1
RetrieveAll
Returns all IndicatorOperation objects
Return Value Type: Zero or more IndicatorOperation tags
Introduced in v6.1
RetrieveAllNames
Returns the names of all Indicator operations
Description
Description
The description of the indicator operation
Type: String
Output only
I18Name
The localized name of the indicator operation
Type: String
Output only
Name
Name
The name of the indicator operation
Type: String

Chapter 2
Required
Sample values:
<Request Action="Retrieve">
<IndicatorOperation Name="SUM"/>
</Request>

Chapter 2
JobAssignment Tag
Job Assignment
The JobAssignment tag specifies information about a person's job assignment. It
is used to import data.
Used by: Personality
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load"
Parameters→
None
Properties→
<JobAssignment
(HasPersonalOvertimeFlag = Boolean)
[ScheduleGroupName = String] >
[<BaseWageRates>
<BaseWageRate>*
</BaseWageRates>]
[<EmploymentTermAssignments>
<EmploymentTermAssignment>*
</EmploymentTermAssignments>]
<Identity>
</Identity>
[<JobAssignmentDetailsData>
<JobAssignmentDetails>
</JobAssignmentDetailsData>]
[<PersonalOvertimeAssignments>
<PersonalOvertimeAssignment>*

Chapter 2
</PersonalOvertimeAssignments>]
[<PrimaryLaborAccounts>
<PrimaryLaborAccount>*
</PrimaryLaborAccounts>]
[<Period>
<TimeFramePeriod>
</Period>]
</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
Introduced in v5.0
BaseWageRates
Base wage rates
One or more effective-dated base wage rates.
Type: Zero or more BaseWageRate tags
Optional
Introduced in v6.1
EmploymentTermAssignments
Employment term assignments
Contains one or more effective-dated EmploymentTermAssignment elements to
be created, updated or deleted for this person.
Type: Zero or more EmploymentTermAssignment tags

Chapter 2
Optional
HasPersonalOvertimeFlag
Is there personal overtime?
Indicates whether personal overtime assignments are associated with that person.
Type: Boolean
Output only
Identity
Identity
Optional Key
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
Period
Time period
The specified time frame.
Optional

Chapter 2
Must evaluate to a span of time. Identity is used when the time frame requires
association with a person.
Used for the Load action.
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 moreprimary labor accounts.
Type: Zero or more PrimaryLaborAccount tags
Optional
This property consists of one or more labor levels, separated by slash (/). Each
labor level has a maximum length of 50 characters.
At least one primary labor account must be specified for a new person.
ScheduleGroupName
Schedule group assignment
The name of the schedule group to which the person is currently assigned.
Type: String
Optional

Chapter 2

Introduced in v5.0

Chapter 2
JobAssignmentDetails Tag
Job Assignment Details
The JobAssignmentDetails tag specifies certain job, employee, and schedule
information for a person.
Used by: JobAssignment
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<JobAssignmentDetails
[BaseWageHourly = Currency]
[BaseWageEffectiveDate = Date]
[DeviceGroupName = String]
[PayRuleEffectiveDate = Date]
[PayRuleName = String]
[SupervisorName = String]
[SeniorityRankDate = Date]
[SupervisorPersonNumber = String]
[TimeZoneName = String]
[WageProfileName = String]
[WorkerTypeName = String] >
</JobAssignmentDetails>
BaseWageEffectiveDate
Base wage effective date
This property indicates when the specified base wage rate should take effect.
Type: Date

Chapter 2
Optional
The string entered must represent a date.
Sample values:
12/02/2005

Introduced in v5.2
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
If specified, this value must be greater than or equal to 0.0.
DeviceGroupName
Device group
The Device Group represents all of the data collection devices that the employee
can access.
Type: String
Optional
PayRuleEffectiveDate
Pay Rule Effective Date
The PayRuleEffectiveDate property was added to handle the Effective Dating Pay
Rules feature in 6.1. This is the date for which the user wishes the passed in

Chapter 2
PayRuleName to become effective. If a PayRuleEffectiveDate property is not

passed in, the effective date of the passed in pay rule will default tobeginning-of-
time.
Type: Date
Optional
If passed in, the pay rule effective date must be in a valid Date format. If a date is
not passed in, it will default to beginning-of-time.
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
Required: For a new Workforce Timekeeper Employee or Timekeeper Employee
that tracks their time in Workforce Central.
SeniorityRankDate
Seniority date
The date when the individual became qualified to work the job or was assigned to
the job.
Type: Date
Optional

Chapter 2
SupervisorName
Reports to
The name of a person's manager
Type: String
Optional
Specify the managers name as last name, first name, middle initial.
It must match the name of an existing manager
Sample values:
Example: Smith, John B

SupervisorPersonNumber
Supervisor person number
This property can be used to uniquely identify a manager or combine with
SupervisorName.
Type: String
Optional
Must uniquely identify an existing and active manager
Sample values:
A person ID,
Sample SupervisorPersonNumber="213"

TimeZoneName
Time zone
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.
Type: String

Chapter 2
Optional
Required: When a value is also specified for DeviceGroupName
For a list of values, see "Time Zone Definitions" in the Workforce Central DTK
Programmer's Guide.
Default value: Default time zone
Introduced in v5.0
WageProfileName
Wage profile
The name of the person's wage profile. The Wage Profile allows an employee to
have multiple wage rates.
Type: String
Optional
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

Chapter 2
JobGroup Tag
Job Group
It defines a group of jobs to be used in Whole House Coverage report, Metrics,
Metrics Settings. It contains a list of jobs.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"DeleteOnly" |
"Retrieve" |
"RetrieveAll" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<JobGroup
ColumnNumber = String
Name = String >
<JobList>
<SimpleValue>*
</JobList>
</JobGroup>

Chapter 2
Action Descriptions
Add
Adds the job groupt to the DB. If it already exists, it will be updated.
Required Properties: Name, ColumnNumber, JobList
Introduced in v6.1
AddOnly
Adds the job group to the DB. If it already exists, throws an exception.
Introduced in v6.1
Delete
Deletes the job group from DB. If it does not exist, no exception is thrown.
Introduced in v6.1
DeleteOnly
Deletes the job group from DB. If it does not exist, throws an exception.

Chapter 2
Introduced in v6.1
Retrieve
Retrieves the JobGroup by its name.
Return Value Type: JobGroup tag
Introduced in v6.1
RetrieveAll
Retrieves all the JobGroup in the DB.
Return Value Type: Zero or more JobGroup tags
Introduced in v6.1
Retrieves all the JobGroup in the DB.
Return Value Type: Zero or more JobGroup tags
Introduced in v6.1
RetrieveAllNames
Retrieves all job groups' name in the DB.
Return Value Type: (***undefined***): KBusinessObjectBeanList
RetrieveForUpdate
Retrieves a JobGroup object by its name for updating.
Return Value Type: JobGroup tag
Introduced in v6.1

Chapter 2
Update
Updates the current object in the DB. If it does not exist, a new one will be
created.
UpdateOnly
Updates the current object in the DB. If it does not exist, throws an exception.
Optional Properties: Description, ColumnNumber, JobList
Introduced in v6.1
ColumnNumber
Column Number
The number of the column.
Type: String
Required
Description
Description
The description of the job group
Type: String
Optional

Chapter 2
Introduced in v6.1
JobList
Job List
The list of jobs associated with the group
Required
Name
Name
The name of the job group
Type: String
Required Key

Chapter 2
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 the application server. It can contain any combination of XML API tags
defined in the 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 XML version. The response will also contain
this tag which shall include the version, WFCVersion, and TimeStamp tags.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<Kronos_WFC
[TimeStamp = String]
Version = String
(WFCVersion = String) >
</Kronos_WFC>
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

Chapter 2
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 core timekeeping version on the server that the session was run on
Type: String
Output Only
Introduced in v4

Chapter 2
KTimeZone Tag
Effective Dated Time Zone
The KTimeZone tag provides information about the time zones in the timekeeping
system.
For a list of time zone values, see "Time Zone Definitions" in the DTK
Programmer's Guide.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAllKTimeZones" |
"LoadById" |
"Update"
Parameters→
None
Properties→
<KTimeZone
[IsInactive = Boolean]
ID = Integer
Name = String
[GMTOffset = Integer]
[KTimeZoneId = Integer]
[KTimeZoneName = String] >
[<KTimeZoneRules>
<KTimeZoneRule>*

Chapter 2
</KTimeZoneRules>]
</KTimeZone>
Action Descriptions
Load
Returns time zone information, based on KTimeZoneName.
Return Value Type: KTimeZone tag
Required Properties: KTimeZoneName
LoadAllKTimeZones
Returns a list of all time zones in the system.
Return Value Type: Zero or more KTimeZone tags
LoadById
Returns time zone information, based on KTimeZoneId.
ID should be valid
Required Properties: KTimeZoneId
Retrieves a list of fully qualified effective dated time zones.
Return Value Type: Zero or more KTimeZone tags

Chapter 2
Introduced in v6.1
RetrieveAllNames
Retrieves a list of the Names of all available effective dated time zones.
Introduced in v6.1
RetrieveForUpdate
Retrieves an effective dated time zone from the database given its ID or Name. If
both are specified, the ID is used.
Optional Properties: Name, ID
Introduced in v6.1
Update
Updates the given effective dated time zone and returns the updated version of it.
The time zone is identified by either the ID or the Name property. If both a
specified, the ID is used.
Required Properties: GMTOffset IsInactive
Optional Properties: ID, Name
GMTOffset
Offset, in seconds, from GMT.
This is the offset, in seconds, from Greenwich Mean Time.
Type: Integer
Optional

Chapter 2
Introduced in v6.1
ID
Effective Date Time zone ID
This is the ID of an effective dated time zone. It can be used to retrieve a
particular effective dated time zone (see also Name).
Type: Integer
Optional Key
Sample values:
20103

IsInactive
Determines if time zone is inactive
Determines if the effective dated time zone is inactive. If it is inactive, it won't
show up in configuration screens.
Type: Boolean
Optional
Introduced in v6.1
KTimeZoneId
Time zone ID
Uniquely identifies the time zone in the database.
Type: Integer
Optional
Sample values:
13411
Introduced in v4; last changed in v6.1; deprecated in v6.1. Use the ID property
instead.

Chapter 2
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; last changed in v6.1; deprecated in v6.1. Use the Name property
instead.
KTimeZoneRules
Contains the list of KTimeZoneRule elements
This element contains a list of historical time zone definitions, a list of
KTimeZoneRule elements.
Type: Zero or more KTimeZoneRule tags
Optional
Introduced in v6.1
Name
Effective Dated Time zone Name
This is the Name of an effective dated time zone. This property can be use to
retrieve a particular time zone from the database (see also ID). Note that this
property is not the same as the deprecated KTimeZoneName. The
KTimeZoneName is a display name and shows translated names (using property-
files). The Name property shows the names as they are in the database.
Type: String
Optional Key
Introduced in v6.1

Chapter 2
KTimeZoneRule Tag
Defines the rule of an effective dated Time Zone (KTimeZone)
A KTimeZone contains a list of KTimeZoneRules. Each KTimeZoneRule is in
effect from its StartDate until its EndDate. A KTimeZoneRule defines the start-
and end-times of Daylight Savings Time for each year in its effective-dated
period.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<KTimeZoneRule
[EndDate = Date]
StandardDayNumber = Integer
DSTDayNumber = Integer
StartDate = Date
StandardMonth = Integer
DSTMonth = Integer
StandardDayOfWeek = Integer
DSTDayOfWeek = Integer
StandardTimeOfDay = Time
DSTTimeOfDay = Time >
</KTimeZoneRule>
DSTDayNumber
Ordinal number of the weekday (start of DST)
This property defines the ordinal number of the weekday that specifies when the
DST starts.

Chapter 2
E.g. if DST starts at the 2nd Sunday of November, the ordinal number is 2.
It can have a value from 0 through 5.
0 : No DST is ever in effect.
1...4: 1st ... 4th weekday.
5: The last weekday.
Type: Integer
Required
Introduced in v6.1
DSTDayOfWeek
The weekday (start of DST)
This property defines which weekday the DST starts.
E.g. if DST starts at the 2nd Sunday of November, the weekday is 1.
0: No DST is ever in effect.
1: Sunday
2: Monday
...
7: Saturday
Type: Integer
Required
Introduced in v6.1
DSTMonth
The month (start of DST)
The month (start of DST)
This property defines the month in which the DST starts.
1: January
2: February
...

Chapter 2
12: December
Type: Integer
Required
Introduced in v6.1
DSTTimeOfDay
Time of day (start of DST)
This property defines what time the DST starts on the specified day of the month.
Specification must be in military time.
Type: Time
Required
Introduced in v6.1
EndDate
End date
Defines the end date of the period for which a rule is in effect.
Type: Date
Optional
Introduced in v6.1
StandardDayNumber
Ordinal number of the weekday (end of DST)
This property defines the ordinal number of the weekday that specifies when the
DST ends.
E.g. if DST ends at the 2nd Sunday of November, the ordinal number is 2.
It can have a value from 0 through 5.
0 : No DST is ever in effect.
1...4: 1st ... 4th weekday.
5: The last weekday.
Type: Integer
Required

Chapter 2
Introduced in v6.1
StandardDayOfWeek
The weekday (end of DST)
This property defines the weekday on which the DST ends.
E.g. if DST ends at the 2nd Sunday of November, the weekday is 1.
1: Sunday
2: Monday
...
7: Saturday
Type: Integer
Required
Introduced in v6.1
StandardMonth
The month (end of DST)
This property defines the month in which DST ends.
1: January
2: February
...
12: December
Type: Integer
Required
Introduced in v6.1
StandardTimeOfDay
Time of day (end of DST)
This property defines what time the DST ends on the specified day of the month.
Specification must be in military time.

Chapter 2
Type: Time
Required
Introduced in v6.1
StartDate
Start date
Defines the start date of the period for which the rule is in effect.
Type: Date
Required
Introduced in v6.1

Chapter 2
LaborAccount Tag
Labor Account
The LaborAccount tag identifies the labor level entries in a labor level account.
Used by: PunchStatus
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"Update" |
"UpdateAndLoad"
Parameters→
None
Properties→
<LaborAccount
LaborAccountName = String
[LaborAccountId = String] >
[<LaborLevelEntries>
<LaborLevelEntry>*
</LaborLevelEntries>]
</LaborAccount>
Action Descriptions
Load
Returns labor account information for the specified labor account
Return Value Type: LaborAccount tag

Chapter 2
Optional Properties: LaborAccountName, LaborAccountId

Update
Adds a new labor account or updates an existing one
Introduced in v4
UpdateAndLoad
Adds a new labor account, or updates an existing one. Returns labor account
information for the specified labor account.
Return Value Type: LaborAccount tag
Description
Description of labor account
Describes the labor account
Type: String
Output only
Must contain only legal description characters
LaborAccountId
LaborAccountId
Assigned by system

Chapter 2
Type: String
Optional
Sample values:
3863
Introduced in v6.1
LaborAccountName
Labor account
The name of the labor account.
Type: String
Required Key
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.
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
Optional
Introduced in v4

Chapter 2
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
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<LaborAccountEntry
[AddEntries = String]
[RemoveEntries = String]
[ReplaceEntries = String]
LaborLevelDefinitionName = String >
</LaborAccountEntry>
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

Chapter 2
Optional
Each semicolon-delimited entry is validated against the labor level definitions
length requirements, and checked for invalid characters.
Except for wildcards, all labor level entries must exist.
LaborLevelDefinitionName
Labor level to which the entry belongs
The name of the labor level to which this labor level entry belongs
Type: String
Required Key
Introduced in v4
RemoveEntries
Labor level entries removed from the labor account set
The semicolon-delimited list of labor level entries to be removed from the labor
account set for this labor level. Entries can contain wildcards.
Type: String
Optional
Except for wildcards, all labor level entry must exist.
ReplaceEntries
Labor level entries that replace the labor account set
A semicolon-delimited list of labor level entries that should replace existing
entries in the labor account set for this labor level. Entries can contain wildcards.
Type: String

Chapter 2
Optional
Except for wildcards, all labor level entry must exist.

Chapter 2
LaborAccountEntryData Tag
Entry Data for a Labor Account
The LaborAccountEntryData tag describes the labor account entry data in a labor
account set.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<LaborAccountEntryData
(Descriptions = String)
(Adhoc = Boolean)
(LaborLevelDefinitionName = String)
(Entries = String) >
</LaborAccountEntryData>
Adhoc
Is ad hoc allowed?
True or False, based on whether ad hoc is allowed
Type: Boolean
Output only
Introduced in v5.0

Chapter 2
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
Labor level definition
The name of the labor level definition
Type: String
Output only

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Load" |
"LoadLaborAccountData" |
"LoadLaborAccountUpdatedData" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<LaborAccountSet
LaborAccountSetKey = String
LaborAccountSetName = String
[NewName = String]
[LaborAccountSetTypeName = String]
[UpdatedDate = String] >
[<EntryList>

Chapter 2
<LaborAccountEntry>*
</EntryList>]
</LaborAccountSet>
Action Descriptions
AddOnly
Adds a new labor account set
Required Properties: LaborAccountSetName, LaborAccountSetTypeName
Introduced in v4
Load
Returns information for the specified labor account set name
Return Value Type: LaborAccountSet tag
Required Properties: LaborAccountSetName
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
LoadLaborAccountUpdatedData
Returns a list of labor entries for the specified labor account set key that have been
updated or modified since the given reference date.
Required Properties: LaborAccountSetKey, UpdatedDate

Chapter 2

RetrieveAllNames
Retrieves the names of all Labor Account Sets
RetrieveForUpdate
Returns the Labor Account Set information for the specified
LaborAccountSetName or LaborAccountSetKey
Update
Adds a new labor account set or updates an existing one
Required Properties: LaborAccountSetName. If adding a new labor account set,
LaborAccountSetTypeName is required.
Introduced in v4
UpdateOnly
Updates an existing labor account set
Introduced in v4

Chapter 2
Description
Summary of the labor level set
A brief summary of the labor level set
Type: String
Optional
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
The database key for the labor account set
Type: String
Optional Key
LaborAccountSetName
Labor account set name
The name of the labor level set
Type: String
Required Key

Chapter 2
Introduced in v4
LaborAccountSetTypeName
Type of labor account set
Identifies the type of the labor level set. LaborAccountSetTypeName can have the
following values:
1-Indicates the entry of a labor level set that can be used in any user role.
2-Indicates the entry of a labor level set that is used exclusively for employee
group labor level sets.
3-Indicates entry of a labor level set that is used exclusively for labor level
transfer sets.
For values 1 and 2, there must be at least one entry in each level in the labor level
set. For example, if the labor level set consists of seven labor levels, then there
must be at least one entry in each level.
For value 3, there must be at least one entry in the labor level set, which can be in
any labor level. For example, if the labor level set consists of seven labor levels,
then at least one of those seven must include at least one entry.
Type: String
Optional
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
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.

Chapter 2

UpdatedDate
Updated Date
The date when the entries of the specified labor account set are updated
Type: String
Optional

Chapter 2
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.
Introduced in v4
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAllLaborAccountSetProfiles" |
"LoadById"
Parameters→
None
Properties→
<LaborAccountSetProfile
[LaborAccountSetProfileId = Integer]
[LaborAccountSetProfileName = String] >
</LaborAccountSetProfile>
Action Descriptions
Load
Returns a labor account set profile, based on LaborAccountSetProfileName.
Return Value Type: LaborAccountSetProfile tag

Chapter 2
Required Properties: LaborAccountSetProfileName

Introduced in v4
LoadAllLaborAccountSetProfiles
Returns all labor account set profiles in the system.
Return Value Type: Zero or more LaborAccountSetProfile tags
Introduced in v4
LoadById
Returns a labor account set profile, based on LaborAccountSetProfileID.
ID must be valid
Return Value Type: LaborAccountSetProfile tag
Required Properties: LaborAccountSetProfileID
Introduced in v4
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.

Chapter 2
Type: String
Optional
Sample values:
All Labor Account
Introduced in v4

Chapter 2
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
Introduced in v4
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"GetNumberOfLaborLevels" |
"LoadAllDefinitions"
Parameters→
None
Properties→
<LaborLevelDefinition
(AddAtTerminalFlag = Boolean)
(LaborLevelDefinitionName = String)
(MaxNameLength = Integer)
(MinNameLength = Integer)
(OverrideFlag = Boolean)
(SortOrder = Integer)
(ShortName = String) >
</LaborLevelDefinition>
Action Descriptions
GetNumberOfLaborLevels
Returns a count of labor level definitions

Chapter 2

Introduced in v4
LoadAllDefinitions
Returns all labor level definition names
Return Value Type: Zero or more LaborLevelDefinition tags
Introduced in v4
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
Introduced in v4
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

Chapter 2
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
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

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"GetCountByLaborLevelWithFilter" |
"GetCountsByLaborLevel" |
"Load" |
"LoadByWildcard" |
"Update" |
"UpdateOnly"
Parameters→
GetCountByLaborLevelWithFilter→
LaborLevelDefinitionName = String
Wildcard = String
LoadByWildcard→
WildCard = String

Chapter 2
Properties→
<LaborLevelEntry
[InactiveFlag = Boolean]
LaborLevelEntryName = String
NewName = String >
</LaborLevelEntry>
Action Descriptions
AddOnly
Adds a new labor level entry
Required Properties: LaborLevelEntryName, LaborLevelDefinitionName
Introduced in v4
GetCountByLaborLevelWithFilter
Returns the number of visible labor level entries for the specified level
Introduced in v4
Action Parameters

LaborLevelDefinitionNa The name of labor level definition Introduced in v5.1
me Required
Wildcard Introduced in v4.0
Required
GetCountsByLaborLevel
Returns the number of labor level entries for each labor level in the system

Chapter 2

Introduced in v4
Load
Returns the specified labor level entry
Return Value Type: LaborLevelEntry tag
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
Introduced in v4
Action Parameters

LaborLevelDefinitionNa The name of the labor level definition Introduced in v4
me Required
WildCard The pattern with which to search the Introduced in v4
description field
Required
Update
Adds a new labor level entry or updates an existing one

Chapter 2

Introduced in v4
UpdateOnly
Updates an existing labor level entry
Introduced in v4
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
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
Introduced in v4

Chapter 2
Name of the Labor Level
Identifies the labor level for which a labor level entry can be specified.
For example, if the LaborLevelDefinitionName is Job, a LaborLevelEntryName
might be 401 and have a corresponding Description value of Assembly. The
value of this input property can be either the name or the ID of the labor level. If
a labor level definition with a matching name is not found, a labor level definition
with a matching ID is looked for.
Type: String
Optional Key
LaborLevelEntryName
Name of the 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
Welding

Chapter 2

Painting
Inspection
Type: String
Optional Key
NewName
New Name for an Existing Labor Level Entry
Identifies the new name of an existing labor level entry. NewName is required
only when you update a labor level entry.
If the labor level entry name is not changing, you can enter @H to indicate that the
labor level entry name should retain its original value.
Type: String
Optional Key
Introduced in v4

Chapter 2
LaunchHistory Tag
PSE Launch History
History of the Priority Scheduling Engine (PSE) launch.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveAll" |
"RetrieveByDate" |
"RetrieveByDatePerson" |
"RetrieveByProcedureSet" |
"RetrieveByProcedureSetUserAccountName" |
"RetrieveByUser"
Parameters→
RetrieveByDate→
Date = Date
RetrieveByDatePerson→
Date = Date
Person = String
RetrieveByPerson→
Person = String
RetrieveByProcedureSet→
ProcedureSet = String
RetrieveByProcedureSetUserAccountName→
ProcedureSet = String
UserName = String
RetrieveByUser→
UserName = String

Chapter 2
Action Descriptions
RetrieveAll
Retrieve all existing LaunchHistory. No properties are required.
Return Value Type: Zero or more LaunchHistory tags
Introduced in v6.0
RetrieveByDate
Retrieve all the launch history for a specific date. Will throw an exception if the
date string is invalid
Introduced in v6.0
Action Parameters

Date String for the date. Introduced in v6.0; last changed
Required in v6.0
RetrieveByDatePerson
Retrieve all the launch history for a specific employee on a date.
Introduced in v6.0

Chapter 2
Action Parameters

Date String for the date. Introduced in v6.0; last changed
Required in v6.0
Person The name of the person employee. Introduced in v6.0; last changed
Required in v6.0
RetrieveByPerson
Retrieve all the launch history for a specific employee.
Introduced in v6.0
Action Parameters

Person The name of the employee. Introduced in v6.0; last changed
Required in v6.0
RetrieveByProcedureSet
Retrieve an existing LaunchHistory, based on the procedure set name. The
procedure set name property must be provided or a validation exception will be
thrown.
Introduced in v6.0

Chapter 2
Action Parameters

ProcedureSet The name of the procedure. Introduced in v6.0; last changed
Required in v6.0
RetrieveByProcedureSetUserAccountName
Retrieve an existing LaunchHistory, based on the procedure set name and the user
name. The procedure set name and username property must be provided or a
validation exception will be thrown.
Introduced in v6.0
Action Parameters

ProcedureSet The name of the procedure set. Introduced in v6.0; last changed
Required in v6.0
UserName The name of the user. Introduced in v6.0; last changed
Required in v6.0
RetrieveByUser
Retrieve all the launch history for a specific user.
Introduced in v6.0

Chapter 2
Action Parameters

UserName The user name of the LaunchHistory Introduced in v6.0; last changed
to retrieve. in v6.0
Required

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAssignable"
Parameters→
None
Properties→
<LicenseType
(CategoryName = String)
LicenseTypeName = String
(LimitCount = Integer)
(InUseCount = Integer)
(AvailableCount = Integer) >
</LicenseType>
Action Descriptions
Load
Returns the category and count information associated with the specified license
type.

Chapter 2
The license type name must be specified and identify an existing license within
the system.
Return Value Type: LicenseType tag
Required Properties: LicenseTypeName
Introduced in v5.0
LoadAssignable
Returns all assignable licenses that are active and have a limit count greater than
zero.
Return Value Type: Zero or more LicenseType tags
Introduced in v5.0
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
Enumerated value: Product, Interactive
Introduced in v5.0

Chapter 2
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 Key
Specify @ to make no change to the existing license type.
Enumerated value: @, 1, 2, 3, 5, 9, 10, 12
LimitCount
Maximum number of licenses allowed
The total number of licenses allowed
Type: Integer

Chapter 2
Output only
Introduced in v5.0

Chapter 2
LightWeightPerson Tag
Available delegate
The LightWeight Person tag displays a person's name and number.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<LightWeightPerson
(FullName = String)
PersonNumber = String >
</LightWeightPerson>
FullName
Person Name
This is output only.
Type: String
Output only
This is output only.
PersonNumber
Person Number
The PersonNumber of existing person.
Type: String

Chapter 2
Required
The PersonNumber of existing person.

Chapter 2
LightWeightQuery Tag
Query Name and Description
The LightWeightQuery tag displays a HyperFind query's name and description.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<LightWeightQuery
QueryName = String >
</LightWeightQuery>
Description
#unassigned#
The description of an existing hyperfind query.
Type: String
Output only
The description of an existing hyperfind query.
Introduced in v6.1
QueryName
#unassigned#
The query name of an existing hyperfind query.
Type: String

Chapter 2
Required
The query name of an existing hyperfind query.
Introduced in v6.1

Chapter 2
LocationId Tag
Location Id of Node
The LocationId tag identifies the location of a node in the Organizational Map.
Used by: ScheduleZoneSet, StandardShiftSet
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<LocationId
NodeId = String >
</LocationId>
NodeId
Node ID
An existing node in the Organizational Map
Type: String
Required
Introduced in v5.0

Chapter 2
LocationProfileSettings Tag
Location Profiles
Used to assign procedure sets to locations.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"DeleteOnly" |
"Retrieve" |
"RetrieveAll" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<LocationProfileSettings
SettingsName = String >
<OrgPaths>
<SimpleValue>*
</OrgPaths>

Chapter 2
</LocationProfileSettings>
Action Descriptions
Add
Adds a pse settings object into the system. If the object already exists, an update
will be performed.
Required Properties: SettingsName, SettingsParamValues, OrgPaths
Optional Properties: description
Introduced in v6.0
AddOnly
Adds a pse settings object into the system. If an object with the same name exists,
an exception is thrown.
Introduced in v6.0
Delete
Deletes a pse settings object from the system. If the object doesn't exists, no
exception is thrown.
Introduced in v6.0

Chapter 2
DeleteOnly
Deletes a pse settings object from the system. If the object doesn't exist, an
Introduced in v6.0
Retrieve
Returns the pse setting object by name.
Return Value Type: (***undefined***): PSESettings
Introduced in v6.0
RetrieveAll
Returns all the pse settings objects.
Introduced in v6.0
Returns all pse settings objects. The ouput will be used as input by the update
method by the SDM.
Introduced in v6.0
RetrieveAllNames
Returns all pse settings objects names.
Return Value Type: String list

Chapter 2
Introduced in v6.0
RetrieveForUpdate
Returns a pse settings object. The output of this method will be used as input for
update method by the SDM.
Introduced in v6.0
Update
Updates a pse settings object into the system. If the obejct doesn't exists, an
Introduced in v6.0
UpdateOnly
Updates a pse settings objects into the system. If the object doesn't exists, an
Introduced in v6.0
Description
Description
The PSE settings object's description.

Chapter 2
Type: String
Optional
Sample values:
<Description> This is a description</Description>

OrgPaths
Organizational Nodes Paths
The PSE settings object's organizational nodes assignment.
Required
Sample values:
<OrgPaths>
Floor 1" />
</OrgPaths>

SettingsName
Settings Name
The PSE settings object name.
Type: String
Required Key
Sample values:
<SettingsName> PSESettingsName</SettingsName>

SettingsParamValues
Settings Parameters Values
All values for this setting object.

Chapter 2

Required
Sample values:
<SettingsParamValue Name="PROCEDURE_SETS"
Value="Assign Only;Unassign Only"/>
<SettingsParamValue Name="METRICS_SETTINGS"
Value="Retail"/>
<SettingsParamValue Name="BASE_WAGE_RATE"
Value="15.75"/>

Chapter 2
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
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<LockedDataCorrection
(Date = Date) >
(<Employee>
</Employee>)
(<Totals>
<Total>*
</Totals>)
</LockedDataCorrection>

Chapter 2
Date
Date
Type: Date
Output Only
Sample values:
Introduced in v4
Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, to whom the
amount is credited.
Output Only
Introduced in v4
Totals
Totals
The totals constituting the correction
Output Only
Introduced in v4

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAllLogonProfiles" |
"LoadById"
Parameters→
None
Properties→
<LogonProfile
[LogonProfileId = Integer]
[LogonProfileName = String] >
</LogonProfile>
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

Chapter 2
Required Properties: LogonProfileName

LoadAllLogonProfiles
Returns all assignable logon profiles in the system.
Only logon profiles with a database key of -1 or greater shall be returned.
Return Value Type: Zero or more LogonProfile tags
LoadById
Returns information for the specified logon profile, based on LogonProfileId.
Only logon profiles with a database key of -1 or greater shall be returned.
Return Value Type: LogonProfile tag
Required Properties: LogonProfileId
LogonProfileId
Logon profile Id
Uniquely identifies the logon profile in the database
Type: Integer
Optional
Introduced in v4

Chapter 2
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.
• &DEFAULT_LOGON
• &SUPER_USER_LOGON
• &XMLUSER_LOGON
• &IMPORT_LOGON_PROFILE
Type: String
Optional
Sample values:
MobileTime Logon
Default value: &DEFAULT_LOGON

Introduced in v4

Chapter 2
ManagerRoleAvailabilityPatternProfile Tag
Availability Pattern Profile for Managers
The ManagerRoleAvailabilityPatternProfile tag contains a valid, existing
availability pattern Profile.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAll"
Parameters→
None
Properties→
<ManagerRoleAvailabilityPatternProfile
AvailabilityPatternProfileName = String
(IsAllowAll = Boolean) >
</ManagerRoleAvailabilityPatternProfile>
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

Chapter 2

Introduced in v5.0
LoadAll
Load all of the AvailabilityPattern profiles in the database.
Return Value Type: Zero or more ManagerRoleAvailabilityPatternProfile tags
AvailabilityPatternProfileName
Availability pattern profile name
The AvailabilityPatternProfile Name.
Type: String
Optional Key
Required: For a Load action
Introduced in v5.0
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

Chapter 2


Chapter 2
ManagerRoleScheduleGroupProfile Tag
Schedule Group Profile for Managers
The ManagerRoleScheduleGroupProfile tag contains a valid Schedule Group
Profile defined in timekeeping.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAll"
Parameters→
None
Properties→
<ManagerRoleScheduleGroupProfile
(IsAllowAll = Boolean)
ScheduleGroupProfileName = String >
</ManagerRoleScheduleGroupProfile>
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

Chapter 2

LoadAll
Load all of the Schedule Group Profiles in the database.
Return Value Type: Zero or more ManagerRoleScheduleGroupProfile tags
Description
Description
Description of the profile.
Type: String
Output only
Introduced in v5.0
IsAllowAll
Indicates whether the profile contains all permissions
Type: Boolean
Output only
ScheduleGroupProfileName
Schedule group profile name
The name of a Manager's schedule group profile. This schedule group profile
identifies those schedule groups that the person can select.
• &ALL_SCHEDULE_PATTERNS
• &EMPTY

Chapter 2
Type: String
Optional Key

Chapter 2
ManagerRoleSchedulePatternProfile Tag
Schedule Pattern Profile for Managers
The ManagerRoleSchedulePatternProfile tag contains valid SchedulePattern
Profiles defined in Timekeeping.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAll"
Parameters→
None
Properties→
<ManagerRoleSchedulePatternProfile
SchedulePatternProfileName = String >
</ManagerRoleSchedulePatternProfile>
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

Chapter 2

Introduced in v5.0
LoadAll
Load all of the SchedulePattern profiles in the database.
Return Value Type: Zero or more ManagerRoleSchedulePatternProfile tags
Description
Description
Required: For a load action
Type: String
Output only
Introduced in v5.0
IsAllowAll
Type: Boolean
Output only
SchedulePatternProfileName
Schedule pattern profile name
The name of SchedulePatternProfile
Type: String

Chapter 2
Optional Key
Introduced in v5.0

Chapter 2
ManagerRoleShiftCodeProfile Tag
Shift Code Profile for Managers
The ManagerRoleShiftCodeProfile displays a valid shift code profile that already
exists.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAll"
Parameters→
None
Properties→
<ManagerRoleShiftCodeProfile
ShiftCodeProfileName = String >
</ManagerRoleShiftCodeProfile>
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

Chapter 2

Introduced in v5.0
LoadAll
Load all of the ShiftCode profiles in the database.
Return Value Type: Zero or more ManagerRoleShiftCodeProfile tags
Description
Description
Type: String
Output only
Introduced in v5.0
IsAllowAll
Type: Boolean
Output only
ShiftCodeProfileName
Shift code profile name
Name of the shift code profile
Required: For a load action
Type: String
Optional Key

Chapter 2
Maximum value: 30 characters

Introduced in v5.0

Chapter 2
MarkForTotalization Tag
Mark for Totalization
The MarkForTotalization tag identifies employee information that has changed
and must be recomputed. MarkForTotalization will mark an employee for priority
toatlization, i.e., sets the TotalizationStatus to '9', so that that employee will be
picked up for totalization before other employees marked for normal totalization.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<MarkForTotalization
[RuleChangedFlag = Boolean]
[ScheduleChangedFlag = Boolean] >
<Employee>
</Employee>
</MarkForTotalization>
Action Descriptions
Update
Updates the specified flag or flags for the employee.

Chapter 2

Optional Properties: RuleChangeFlag, ScheduleChangedFlag
Introduced in v4
Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, to be marked
for totalization
Required Key
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
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

Chapter 2


Chapter 2
MarkPostedAuditItem Tag
Mark Posted Audit Record
This tag represents a mark posted (or posted schedule) audit record.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<MarkPostedAuditItem
(Action = String)
(EndDate = Date)
(OrgPathName = String)
(StartDate = Date)
(User = String) >
</MarkPostedAuditItem>
Action
Action
The audited action
Type: String
Output only
Sample values:
CREATE, DELETE

Chapter 2
Introduced in v6.1
DataSource
Data Source
The functional area of the user
Type: String
Output only
Sample values:
SCHEDULING

EditDateTime
Edit Date Time
The date time of the audited action
Type: DateTime
Output only
EndDate
End Date
The end date of the mark posted schedule
Type: Date
Output only
Introduced in v6.1
OrgPathName
Organization Path Name
The complete organization path name of the mark posted schedule
Type: String
Output only
Introduced in v6.1

Chapter 2
StartDate
Start Date
The start date of the mark posted schedule
Type: Date
Output only
Introduced in v6.1
User
User
The audited user
Type: String
Output only
Sample values:
Introduced in v6.1

Chapter 2
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.
Introduced in v4
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load"
Parameters→
None
Properties→
<Menu
(<MenuItems>
<MenuItem>*
</MenuItems>)
<User>
</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

Chapter 2
Introduced in v4
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
Optional Key
Default value: Logged on user
Introduced in v4

Chapter 2
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
Introduced in v4
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<MenuItem
(AccessControlPointName = String)
(Depth = Integer)
(ExternalFlag = Boolean)
(Label = String)
(MenuItemName = String)
(URL = String) >
</MenuItem>
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

Chapter 2
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 application. If
it points to an external link, the value is True.
Type: Boolean
Output Only
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

Chapter 2
URL
URL for menu item
The URL of the menu item
Type: String
Output Only
Introduced in v4

Chapter 2
MetricsSettings Tag
Metrics Settings
Metrics settings define the evaluation parameters used to display a summary
table.
Contains a list of indicators to evaluate and strategies to apply .
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"DeleteOnly" |
"Retrieve" |
"RetrieveAll" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<MetricsSettings
Name = String >
<SettingStrategies>
<SettingStrategy>*
</SettingStrategies>
<SettingIndicators>

Chapter 2
<SettingIndicator>*
</SettingIndicators>
</MetricsSettings>
Action Descriptions
Add
Adds a MetricsSettings object. If an object with the same name already exists it is
updated, otherwise it is added.
Required Properties: Name, SettingStrategies, SettingIndicators
Introduced in v6.1
AddOnly
Adds a MetricsSettings object in database. If it's already there, throws an error
Introduced in v6.1
Delete
Deletes the MetricsSettings object with the given name. If this object doesn't exist,
nothing happens (no error message).
Introduced in v6.1

Chapter 2
DeleteOnly
Deletes the MetricsSettings object with the given name. If this object doesn't exist,
an error is thrown.
Introduced in v6.1
Retrieve
Returns the metrics setting with the given name.
Return Value Type: MetricsSettings tag
Introduced in v6.1
RetrieveAll
Returns all the MetricsSettings objects.
Return Value Type: Zero or more MetricsSettings tags
Introduced in v6.1
Returns all MetricsSettings
Return Value Type: Zero or more MetricsSettings tags
Introduced in v6.1
RetrieveAllNames
Returns the list of all MetricsSettings names.

Chapter 2
RetrieveForUpdate
Returns the metrics setting with the given name.
Return Value Type: MetricsSettings tag
Introduced in v6.1
Update
Updates an existing MetricsSettings object. If the object doesn't already exist it is
added.
Introduced in v6.1
UpdateOnly
Updates an existing MetricsSettings object. If the object doesn't exist an error is
thrown.
Introduced in v6.1
Description
Description
Description of the setting.
Type: String
Optional

Chapter 2
Introduced in v6.1
Name
Name
Name of the metrics setting.
Type: String
Required
SettingIndicators
Indicators
The list of indicators for the metrics setting.
Type: Zero or more SettingIndicator tags
Required
SettingStrategies
Groupings
List of strategies for the metrics setting.
Type: Zero or more SettingStrategy tags
Required

Chapter 2
MinimunHoursNoModification Tag
Minimum 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.
Introduced in v5.1Beta; last changed in v5.2
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load"
Parameters→
None
Properties→
<MinimunHoursNoModification
(MinimunHoursRequired = Time)
(IsBeyondMinimunHours = Boolean)
QueryDate = Date
StartTime = Time >
</MinimunHoursNoModification>
Action Descriptions
Load
This action determines whether the request is made at an acceptable time.

Chapter 2
Return Value Type: MinimunHoursNoModification tag

Required Properties: QueryDate, StartTime
Introduced in v5.1Beta
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
Introduced in v5.0a
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.0a
QueryDate
Start date
The date when the request is submitted
Type: Date
Required

Chapter 2
StartTime
Start time
The time of day when the shift begins
Type: Time
Required

Chapter 2
NameList Tag
Name List
The NameList tag returns one or more items that are specified in a specific
request.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<NameList
(PropertyName = String) >
(<Names>
</Names>)
</NameList>
Names
Names
One or more names of the entities in the DB as instances of "SimpleValue" or
"SimplePair"
Type: Either tag
Output only
Introduced in v5.1

Chapter 2
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

Chapter 2
Names Tag
Names of Rules
List of user-understandable names of all rules (i.e business entities).
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<Names
(<SimpleValues>
<SimpleValue>*
</SimpleValues>)
</Names>
SimpleValues
Set of rule names
List of names returned as simple values.
Output only

Chapter 2
NameValuePair Tag
Simple Name Value Pair
A bean contain a simple name/value pair
Introduced in v6.1
Syntax
None

Chapter 2
NavProfile Tag
Navigation Profile
This tag enables you to specify what parts of the system users can see and access.
Standard named entity validation.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"RetrieveAll" |
"RetrieveForUpdateFactory" |
"Update"
Parameters→
None
Properties→
<NavProfile
[Active = String]
[HomePagePath = String]
Name = String
[Type = String]
[RootNodePath = String]
[LegacyHomePage = String] >
</NavProfile>

Chapter 2
Action Descriptions
Delete
Deletes the named NavProfile.
Introduced in v6.0
Retrieve
Retrieves the NavProfile item
Return Value Type: NavProfile tag
RetrieveAll
Retrieves all the NavProfiles in the system.
Return Value Type: Zero or more NavProfile tags
RetrieveAllNames
Retrieves the names of all the NavProfiles in the system. Required method for
Setup Data Manager.
Introduced in v6.0

Chapter 2
RetrieveForUpdate
Retrieves the named NavProfile for update. Method required for Setup Data
Manager.
Introduced in v6.0
RetrieveForUpdateFactory
Retrieves the named NavProfile for updating.
Introduced in v6.0
Update
Updates the profile or inserts a new NavProfile if it doesn't exist.
Optional Properties: Name, Type, Active, LegacyHomePage, Description,
RootNodePath, HomePagePath
Active
Active or Inactive Navigation Profile
Specify whether the navigation profile is active or not active.
Type: String
Optional
Sample values:
true

Chapter 2
Default value: true

Description
NavProfile Description
Specify an optional descriptiion of the navigation profile.
Type: String
Optional
Sample values:
This is a NavProfile for Managers
Introduced in v6.0
HomePagePath
Home page path
Specify an optional path to the user's home page.
Type: String
Optional
Introduced in v6.0
LegacyHomePage
UsersHomePage'
Specify the page to load for advanced users when they log on.
Type: String
Optional
Sample values:
/QUICKFIND
Introduced in v6.0

Chapter 2
Name
Navigation Profile Name
Specify the name of the navigation profile.
Type: String
Required
Normal WFC character validation for Srings.
Sample values:
Manager Navigation

RootNodePath
Root node path
Specify an optional root node in the menu structure for this profile.
Type: String
Optional
Introduced in v6.0
Type
Navigation Profile Type
Specify the types of Navigation Profiles. The choices are Basic for the default
home page, and Advanced to select another home page.
Type: String
Optional
Sample values:
Basic
Default value: Basic

Enumerated value: Advanced, Basic

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddComment" |
"AddOnly" |
"Delete"
Parameters→
AddOnly→
Properties→
<NonCancellingPayCodeEdit
ScheduleAmountType = String
OrgJobId = String
OrgJobName = String
Date = Date

Chapter 2
[OverrideAccrualDays = Double]
[StartTime = Time]
(EnteredOnTime = Time) >
[<Notes>
<Note>*
</Notes>]
(<Comments>
<Comment>*
</Comments>)
<Employee>
</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.
Required Properties: AmountInTimeOrCurrency, CommentText, Date, Employee,
PayCodeName
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
Introduced in v4

Chapter 2
Action Parameters

when AccrualOverride=True.
Optional
Optional used
of this tag.
Optional
Delete
Marks for deletion all pay code edits for the employee with matching properties.
Introduced in v4
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

Chapter 2

pay code.
ScheduleAmountType
Amount, based on the employee 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
• 3 to calculate the amount as a full-day contract amount.
• 5 to calculate the amount as a first half-day contract amount
• 6 to calculate the amount as a second half-day contract amount
Type: String
Enumerated value: 1, 2, 3, 5, 6
Introduced in v6.0
OrgJobId
ID of job in organization
Type: String
Introduced in v6.0
OrgJobName
Job in the organization

Chapter 2
Type: String
Introduced in v6.0
Comments
Comments
The set of comments currently returned with this timekeeping item
Output Only
Introduced in v4
CommentText
Comment text
A comment
Type: String
Optional
The comment must match exactly an applicable comment that already exists in the
database. The string matching is case-sensitive.
Date
The date to which the edit applies
Type: Date
Required, Key
Sample values:
4/2/2000
Introduced in v4

Chapter 2
Employee
Employee
One employee to be credited with the amount, as specified in a PersonIdentity or
CurrentUser tag
Required, Key
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
True if the pay code represents a monetary item. False if it represents an hourly
pay code.
Type: Boolean
Output Only
Introduced in v4

Chapter 2
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.
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.
Type: String
Optional, Key
ManagerName
Manager name
Manager Name
Type: String
Optional
Introduced in v6.0
Notes
Comment Notes
Comment Notes
Optional
Introduced in v6.0

Chapter 2
OverrideAccrualDays
Override Accrual Days
Override Accrual Days
Type: Double
Optional
Introduced in v6.0
PayCodeName
Pay code
The pay code to be edited.
Type: String
Required, Key
Must be associated with an hourly or monetary pay code edit
StartTime
Start Time
Start Time
Type: Time
Optional
Introduced in v6.0

Amount in Time
Amount value
Required
Group includes: AmountInTimeOrCurrency, ScheduleAmountType
OrgJob
Organization Job
Optional
Group includes: OrgJobId, OrgJobName

Chapter 2
Note Tag
Note
This tag lets you add text notes to comments on a time sheet or schedule item.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<Note
Text = String
[Timestamp = DateTime] >
[<DataSource>
<DataSource>
</DataSource>]
</Note>
DataSource
Data Source
Specify the person who created the note.
Type: DataSource tag
Optional
Introduced in v6.0; last changed in v6.1; deprecated in v6.1. TAL-12530
Text
Note Text
Specify the text of the note.
Type: String

Chapter 2
Required
Introduced in v6.0
Timestamp
Note Timestamp
Specify the time when you created the note.
Type: DateTime
Optional
Introduced in v6.0

Chapter 2
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
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<OnCall
(AmountInTime = TimeDuration)
(Date = Date)
(LaborAccountName = String) >
(<Employee>
</Employee>)
</OnCall>
AmountInTime
Amount of pay code, in time
Amount of pay code amount, expressed as a time duration
Type: TimeDuration
Output Only

Chapter 2
Introduced in v4
Date
Date
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.
Output Only
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

Chapter 2
OpenShift Tag
Open shift
An open shift.
Introduced in v6.0
Syntax
None

Chapter 2
OpenShiftItem Tag
Open shift details
This tag only contains an open shift's date time span information.
none
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<OpenShiftItem
(DATE_TIME_SPAN = DateTimeSpan) >
</OpenShiftItem>
DATE_TIME_SPAN
Date-time span of the open shift
This property contains an open shift's date time span.
Type: DateTimeSpan
Output only
Must be a valid date time span.

Chapter 2
OpenShiftRequestItem Tag
Open Shift Request Item
Describe an open shift request item
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<OpenShiftRequestItem
(CreatedByUser = String)
Id = String
RequestFor = String
ShiftDate = Date
[<Comments>
<Comment>*
</Comments>]
<Employee>
<PersonIdentity>
</Employee>
(<RequestStatusChanges>
<RequestStatusChange>*
</RequestStatusChanges>)
<ShiftSegments>
<ShiftSegment>*
</ShiftSegments>
</OpenShiftRequestItem>

Chapter 2
Comments
Comments
A list of comments for the open shift request
Optional
CreatedByUser
Created By User
The user who created this request
Type: String
Output only
Introduced in v6.1
CreationDateTime
Creation Date Time
The creation date/time
Type: DateTime
Output only
Introduced in v6.1
Employee
Employee
The employee for which the open shift is requested
Required
Introduced in v6.1
Id
Id
The request id
Type: String
Optional Key

Chapter 2
Introduced in v6.1
RequestFor
Request For
The subtype of the request
Type: String
Required
Introduced in v6.1
RequestStatusChanges
Request Status Changes
A list of status changes
Type: Zero or more RequestStatusChange tags
Output only
Introduced in v6.1
ShiftDate
Shift Date
The open shift date
Type: Date
Required
Introduced in v6.1
ShiftSegments
Shift Segments
The list of shift segments describing the requested open shift
Required
Introduced in v6.1
StatusName
Status Name
The current status of the request
Type: String

Chapter 2
Output only
Sample values:
DRAFT, SUBMITTED
Introduced in v6.1

Chapter 2
OpenShiftVolunteer Tag
Open Shift Volunteer
This tag assigns a Workforce Scheduler licensed employee to an open shift.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AssignOpenShiftVolunteer" |
"GetOpenShiftsForJob"
Parameters→
None
Properties→
<OpenShiftVolunteer
[IsCheckRules = Boolean]
[PartialEndDate = Date]
[PartialEndTime = Time]
QueryDateTimeSpan = DateTimeSpan
OrgJobPath = String
[QueryDate = Date]
[IsSaveData = Boolean]
[PartialStartDate = Date]
[PartialStartTime = Time] >
<Employee>
<PersonIdentity>
</Employee>
(<OpenShiftItems>
<OpenShiftItem>*
</OpenShiftItems>)
(<RuleViolations>
<RuleViolation>*

Chapter 2
</RuleViolations>)
</OpenShiftVolunteer>
Action Descriptions
AssignOpenShiftVolunteer
This action will assign a person to an open shift.
The specified open shift must be a valid open shift. The specified employee must
be an active employee.
Return Value Type: Zero or more RuleViolation tags
Required Properties: QueryDateTimeSpan,OrgJobPath,Employee
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
Employee
Employee
This property represents the employee who requests the action to cover an open
shift.
Required Key

Chapter 2

IsCheckRules
Check validation rules?
This property indicates whether schedule validation rules will be checked.
Type: Boolean
Optional
none
IsSaveData
Save change data?
This property indicates whether the changes made will be persisted to the
database.
Type: Boolean
Optional
none
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
OrgJobPath
Organizational job path
This property represents an organization job for an open shift
Type: String
Optional Key

Chapter 2
The specified jon must be a valid job

PartialEndDate
End date of replacement shift
This property represents the end date of a shift to replace a specified open shift.
Type: Date
Optional
PartialEndTime
End time of replacement shift
This property represents the end time of a shift to replace a specified open shift.
Type: Time
Optional
Must be a valid time.
PartialStartDate
Start date of replacement shift
This property represents the start date of a shift to replace a specified open shift.
Type: Date
Optional
PartialStartTime
Start time of replacement shift
This property represents the start time of a shift to replace a specified open shift.
Type: Time
Optional

Chapter 2
Must be a valid time.

QueryDate
Query date
This property is used to query for open shifts in the specified date.
Type: Date
Optional
QueryDateTimeSpan
Open shift date and time span
This property represents an existing an open shift date time span.
Type: DateTimeSpan
Optional Key
It must be a valid date time span for an existing open shift.
RuleViolations
Rule violations
This is a set of rule violations that was generated by the tag.
Type: Zero or more RuleViolation tags
Output only
none

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<OptOutStatus
[EffectiveDate = DateTime]
[ExpirationDate = DateTime]
[In = Boolean]
WtdEmployeeAssgnmntId = Long >
</OptOutStatus>
EffectiveDate
Effective Date
The date on which this status is effective.
Type: DateTime
Optional

Chapter 2
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
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<OptOutStatusList
[WtdAssignmentId = Long] >
[<OptOutStatuses>
<OptOutStatus>*
</OptOutStatuses>]
</OptOutStatusList>
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

Chapter 2
WtdAssignmentId
WTD Assignment Id
Set on insertion into WTDEmployeeAssignment. Not necessary to set.
Type: Long
Optional
Introduced in v5.1

Chapter 2
OrgDirect_IndirectPct Tag
API Org Direct and Indirect Pct
API that takes the OrgIds and EffectiveDate and returns an
ApiOrgDirect_IndirectPctBean that contains the entered data and the Direct and
InDirect percentages. The action is load.
That the OrgIds and EffectiveDate are set as input properties and that the return
object contains the OrgIds, EffectiveDate, Direct percentage and InDirect
percentage values
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"load"
Parameters→
None
Action Descriptions
load
Gets the Direct and InDirect Pct
Return Value Type: (***undefined***): ApiOrgDirect_IndirectPct
Required Properties: OrgIds EffectiveDate

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<OrgJob
[FullPath = String]
(NodeId = Long) >
</OrgJob>
FullPath
Full path for organizational job
The full path for the task group organizational job
Type: String
Optional
NodeId
Organizational node id
The id for the organizational node
Type: Long
Output only

Chapter 2

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<OrgLocation
[EndEffectiveDate = Date]
[StartEffectiveDate = Date]
[Seasonal = Boolean]
[LLEntryName = String]
LocationPathName = String
ParentLocationNum = Long
[LocationType = String]
LocationNum = Long
[LocationName = String]
ParentLocationPathName = String >
[<OrgWorkAllocationEntryList>
<OrgWorkAllocationEntry>*
</OrgWorkAllocationEntryList>]
</OrgLocation>

Chapter 2
Description
Description
Describes the node.
Type: String
Optional
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 effective 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.
LLEntryName
Labor level entry
The labor level name of the node.
Type: String
Optional

Chapter 2
Introduced in v5.0
LocationName
Node in the organization
The name of the node.
Type: String
Optional
Required: If you are adding a new node
Introduced in v5.0
LocationNum
Node Id
A unique identifier for the node.
Type: Long
Required Key
Maximum length: 12
Introduced in v5.0
LocationPathName
Location Path Name
Contains the location full path and is mutually exclusive with LoationNum
Type: String
Required
Sample values:
OrganizationHospitalsHosp A
Introduced in v6.1
LocationType
Location type
The category of the node in the organization.
Type: String

Chapter 2
Optional
Required: If you add a new node, you must specify an already existing
LocationType.
Sample values:
Facility, Job, Division
Introduced in v5.0
OrgWorkAllocationEntryList
Fixed percent allocation rules
A list of fixed percent allocation rules that apply to the jobs in this location.
Type: Zero or more OrgWorkAllocationEntry tags
Optional
Introduced in v5.2
ParentLocationNum
Location of parent node
The unique identifier of the parent node to which this node is associated.
Type: Long
Required
Must be an integer
The ParentLocationNum must exist in the organizational tree.
Required: When adding a new location or job
ParentLocationPathName
Parent Location Path Name
Contains the full path of the parent node and is mutually exclusive with
ParentLocationNum
Type: String

Chapter 2
Required
Sample values:
OrganizationHospitalsHosp A
Introduced in v6.1
Seasonal
Is the location seasonal?
Boolean value that, when True, indicates that the job or location is not active for
the full year.
Type: Boolean
Optional
true or false
Sample values:
true, false
Introduced in v5.1
StartEffectiveDate
Effective start date
The date when the node becomes effective.
Required: If an organizational location is being added.
Optional: If an organizational location is being updated.
Type: Date
Optional
The effective 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.

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"Update"
Parameters→
None
Properties→
<OrgLocationsImport
ChangeDate = Date >
<OrgLocations>
<OrgLocation>*
</OrgLocations>
</OrgLocationsImport>
Action Descriptions
Retrieve
Imports one or more organizational tree nodes.
If a node doesn't exist, an exception is thrown.
Return Value Type: Zero or more OrgLocation tags

Chapter 2
Required Properties: ChangeDate, OrgLocations

Optional Properties: ShowChildren
Introduced in v6.1
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.
Required Properties: ChangeDate, OrgLocations
Introduced in v5.0
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: Zero or more OrgLocation tags
Required
Introduced in v5.0

Chapter 2
OrgMapIntegration Tag
Organizational map
Use this tag to access the organizational map.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadJobLocations" |
"RetrieveAll" |
"RetrievePartial"
Parameters→
None
Action Descriptions
LoadJobLocations
Retrieve Home Location data which can be either retrieved from the database or
calculated in memory
Return Value Type: OrgNode tag
RetrieveAll
Validation done in the KBO
Validation done in the KBO

Chapter 2

Required Properties: Kdate
RetrievePartial
validation done in the KBO
validation done in the KBO
Required Properties: Date, OrgPath, Depth

Chapter 2
OrgNode Tag
Organizational Node
Returns all the organizational node information. A node can be either a location or
a job, based on the action parameters.
Validated by the KBO
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<OrgNode
(EndDate = Date)
(NodeId = String)
(IsJob = Boolean)
(Name = String)
(StartDate = Date) >
(<Children>
<OrgNode>*
</Children>)
</OrgNode>
Children
Child org nodes of this parent node
List of zero or more children of an org node.
Type: Zero or more OrgNode tags
Output only

Chapter 2
EndDate
End Date
End Date of the org node.
Type: Date
Output only
IsJob
Is this node a job?
True if it is a job, else false.
Type: Boolean
Output only
Name
Name of Organizational Node
Name of the organizational node.
Type: String
Output only
NodeId
ID of Organizational Node
The ID of the organizational node.
Type: String
Output only
StartDate
Start Date
The start date of the org node.
Type: Date
Output only

Chapter 2

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Load" |
"Update" |
"UpdateEntryList" |
"UpdateOnly"
Parameters→
None
Properties→
<OrgSet
OrgSetName = String
[OrgSetTypeName = String]
[Name = String]
(OrgSetId = Long) >
[<EntryList>
<OrgSetEntry>*

Chapter 2
</EntryList>]
(<OrgSetJobList>
<OrgSetJob>*
</OrgSetJobList>)
</OrgSet>
Action Descriptions
AddOnly
Adds a new organizational set.
Required Properties: OrgSetName,OrgSetTypeName, EntryList,
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, fullPath
Update
Adds a new organizational set or updates an existing one. When adding a new
organizational set, Description, orgSetTypeName and EntryList are required.
Required Properties: orgsetName
Optional Properties: Description, OrgSetTypeName, EntryList
Introduced in v5.0

Chapter 2
UpdateEntryList
Updates all jobs in the organizational set.
Required Properties: OrgSetName, EntryList
Invalid Properties: Description, OrgSetTypeName
Introduced in v6.0
UpdateOnly
Updates information for an existing organization set.
Required Properties: OrgSetName
Description
Description
Describes the organization set, which consists of locations and jobs.
Type: String
Optional
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

Chapter 2
Name
New name of job set
A unique name used to rename the organization job set
Type: String
Optional
OrgSetId
Primary identifier for job set
The primary identifier for the organization job set
Type: Long
Output only
An integer value
OrgSetJobList
Jobs in set
One or more jobs in the organization job set
Type: Zero or more OrgSetJob tags
Output only
OrgSetName
Job set name
The name of the organizational set for the selected action.
Type: String
Required Key
OrgSetTypeName
Job set type
Type of the organization job set

Chapter 2
Type: String
Optional
Enumerated value: All Organizational Sets, Organizational Groups, Job Transfer
Sets
Introduced in v5.0

Chapter 2
OrgSetEntry Tag
Jobs in Set
Use the OrgSetEntry tag to add or replace organizational jobs in an organizational
set.
Used by: OrgSet
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<OrgSetEntry
(OrgId = Long)
[AddEntries = String]
[Name = String]
[ReplaceEntries = String] >
</OrgSetEntry>
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

Chapter 2
EffectiveDate
Effective date
The date when the specified jobs become effective
Type: Date
Required
Name
Name of the job set entry
Name of the job set entry.
Type: String
Optional
OrgId
ID for job set entry
A unique identifier for the organization set entry
Type: Long
Output only
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

Chapter 2
OrgSetJob Tag
Job in Organizational Job Set
The OrgSetJob tag describes a job that is defined in the organizational set.
Used by: Org Set
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<OrgSetJob
(OrgJobId = String)
(OrgJobName = String) >
</OrgSetJob>
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.
OrgJobName
Job name
The full path of the job in the organization

Chapter 2
Note: OrgJobName string matching is case-sensitive on a server that connects to

an Oracle database.
Type: String
Output only

Chapter 2
OrgWorkAllocationEntry Tag
Labor percentages for organizational map jobs
Use this tag to add or change the percentage for both direct labor and indirect
labor for a job that is part of an organization map.
Used by: OrgLocation
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<OrgWorkAllocationEntry
OrgWorkPct = Integer
OrgWorkTypeName = String >
</OrgWorkAllocationEntry>
OrgWorkPct
Percentage of work in a job of an organization map
Specify a percentage value for the type of work, either Direct Labor or Indirect
Labor, in an organizational map job. The percentages for both Direct Labor and
Indirect Labor must add up to 100 percent.
Type: Integer
Required
between 0 and 100
Introduced in v5.2

Chapter 2
OrgWorkTypeName
Type of work in the job of an organizational map
Specify the type of work, Direct Labor or Indirect Labor, to assign a percentage
value to.
Type: String
Required
Sample values:
"Direct work" or "Indirect work"
Introduced in v5.2

Chapter 2
OverCoverageSpan Tag
Schedule Assignments Overcoverage Period
Describes an overcoverage period within AssignmentDispatchEngine API
response.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<OverCoverageSpan
(Duration = TimeDuration)
(EndTime = Time)
(StartTime = Time)
(EndDayNumber = Integer)
(OrgJobPath = String)
(StartDayNumber = Integer) >
</OverCoverageSpan>
Duration
Coverage Duration
Duration of coverage span in hours.
Type: TimeDuration
Output only
Sample values:
Duration="1:00"

Chapter 2

EndDayNumber
End Day Number
Reference day of span end, relative to start reference days. If satart and end time
of the span are both on the same day, EndDayNumber="1"; if the end time is on
the next day, EndDayNumber="2"; etc.
Type: Integer
Output only
Sample values:
EndDayNumber="2"

EndTime
Coverage End Time
End of the coverage span.
Type: Time
Output only
Sample values:
EndTime="3:00PM"

OrgJobPath
Job Path
Full path to orgJob
Type: String
Output only
Sample values:
OrgJobPath="Organization/Hospitals/Hosp A/Floor 1/ER/
RN"

Chapter 2

StartDayNumber
Start Day Number
Reference number for start day. Always 1.
Type: Integer
Output only
Sample values:
StartDayNumber="1"

StartTime
Coverage Start Time
Start time of the coverage span.
Type: Time
Output only
Sample values:
StartTime="3:00PM"

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddComment" |
"Approve" |
"ApproveAll" |
"ApproveNone" |
"ApproveSome" |
"RejectRequest"
Parameters→
None
Properties→
<OvertimeApproval
[AmountInTime = TimeDuration]
[approverNotes = String]
Date = Date
(<Comments>
<Comment>*
</Comments>)

Chapter 2
<Employee>
</Employee>
</OvertimeApproval>
Action Descriptions
AddComment
Adds a comment along with the action taken.
Required Properties: Employee, Date, CommentText, AmountInTime
Introduced in v4
Approve
To approve an overtime request by approver
Logon user must be an assigned approver.
Required Properties: Employee, Date
Optional Properties: AmountInTime, approverNotes
Introduced in v6.1
ApproveAll
Approve all overtime for the specified day.
ApproveNone
Does not approve any overtime requested or submitted for the specified day.

Chapter 2

ApproveSome
Approve only a portion of the overtime hours that the employee submitted or
requested.
Required Properties: Employee, Date, AmountInTime
RejectRequest
To deny an overtime request
Logon user must be an assigned approver
Optional Properties: approverNotes
Introduced in v6.1
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

Chapter 2
approverNotes
Approve Notes
Note for an overtime request approval or denial
Type: String
Optional
Introduced in v6.1
Comments
Comments
Output Only
Introduced in v4
CommentText
Comment text
A comment
Type: String
Optional
The comment must match exactly an applicable comment that already exists in the
database. The string matching is case-sensitive.
Introduced in v4
Date
Date of overtime
The date for which the overtime hours are being approved
Type: Date
Required Key
Introduced in v4

Chapter 2
Employee
Employee
One employee for whom overtime hours are to be approved, as specified in a
Required Key
Introduced in v4
EnteredOnDate
Date of the edit
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

Chapter 2
PasswordHistory Tag
Password History
The PasswordHistory tag returns an encrypted password for the specified date.
Used by: User
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<PasswordHistory
(EffectiveDateTime = DateTime)
(Password = Password) >
</PasswordHistory>
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

Chapter 2
Output Only

Chapter 2
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
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<PatternElement
ShiftCodeName = String
[AmountInDays = Double]
(CommentText = String)
DayNumber = Integer
[DisplayTime = Time] >
(<Comments>
<Comment>*
</Comments>)
</PatternElement>
PayCodeName
Pay code for the day
The pay code allocated to that day. PayCodeName and ShiftCodeName are
mutually exclusive; one is required.

Chapter 2
Type: String
A pay code can require either AmountInCurrency, AmountInTime, or
AmountInDays. Must be a valid pay code.
Introduced in v4
ShiftCodeName
Shift code for the day
The shift code allocated to the specified day. PayCode and ShiftCode are
mutually exclusive; one is required.
Type: String
If an attribute, shift code name must match an existing shift template.
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
Introduced in v4
AmountInTime
A pay code amount, expressed as a time duration.
Dependency: Only used if PayCodeName is specified and represents an hourly
pay code.
Type: TimeDuration
Introduced in v4

Chapter 2
AmountInDays
Amount of pay code in days
The amount of the pay code edit, expressed as a day value. If AmountInDays is
specified, the associated PayCodeName must match. The AmountInTime must
also be specified. If OverrideAccrualDaysAmount is not specified the
OverrideAccrualDaysAmount will default to the AmountInDays amount.
Type: Double
Optional
must be between -1 and 1
Introduced in v6.1
Comments
Comments
User comments.
Output only
Introduced in v5.0
CommentText
Comment text
A text string that is returned.
Type: String
Output only
Introduced in v5.0
DayNumber
Day number in the pattern
Specifies the day of the pattern.
Type: Integer
Required

Chapter 2
Introduced in v4
DisplayTime
Time to display in the user interface
The time displayed in the user interface.
Type: Time
Optional
DisplayTime is required if a PayCodeName is specified
Introduced in v4

AccrualAmount
AccrualAmount
Optional
Group includes: AmountInCurrency, AmountInTime
PatternElementCode
A Schedule Pattern element is either a Shift or PayCode
Required
Group includes: PayCodeName, ShiftCodeName

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadAllPayCodes"
Parameters→
None
Properties→
<PayCode
(ManagerAccessFlag = Boolean)
(IsVisibleFlag = Boolean)
(ProfessionalAccessFlag = Boolean)
(ExcuseAbsenceFlag = Boolean)
(IsCombinedFlag = Boolean)
(DisplayOrder = Integer)
</PayCode>
Action Descriptions

Chapter 2
LoadAllPayCodes
Returns a list of all pay codes.
Return Value Type: Zero or more PayCode tags
Introduced in v4
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
Introduced in v4
IsCombinedFlag
Is the pay code combined?
Indicates whether the pay code is combined.
Type: Boolean
Output Only
Introduced in v4

Chapter 2
IsCurrencyFlag
pay code.
Type: Boolean
Output Only
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
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
Introduced in v4
PayCodeName
Pay code
The name of the pay code.
Type: String
Output Only
Introduced in v4

Chapter 2
ProfessionalAccessFlag
Can an employee access the pay code?
Indicates whether the pay code is accessible for professional functions.
Type: Boolean
Output Only
Introduced in v4

Chapter 2
PayCodeAuditItem Tag
Pay Code Audit Record
This tag contains pay code information for an audit.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<PayCodeAuditItem
(Account = String)
(AccrualAmount = String)
(Action = String)
(Amount = String)
(Comment = String)
(Job = String)
(PayCode = String)
(StartTime = Time)
(User = String) >
</PayCodeAuditItem>
Account
Account
The pay code labor account
Type: String

Chapter 2
Output only
Introduced in v6.1
AccrualAmount
Accrual Amount
The accrual amount of this pay code
Type: String
Output only
Action
Action
The audited action
Type: String
Output only
Sample values:
CREATE, DELETE
Introduced in v6.1
Amount
Amount
The time or money amount of the pay code
Type: String
Output only
Sample values:
Either a time (7:00) or a money amount (500$)
Introduced in v6.1
Comment
Comment
The comments and notes associated to this paycode

Chapter 2
Type: String
Output only
Introduced in v6.1
DataSource
Data Source
The functional area
Type: String
Output only
Sample values:

EditDateTime
Edit Date Time
The audit datetime
Type: DateTime
Output only
EffectiveDate
Effective Date
The pay code effective date
Type: Date
Output only
Job
Job
The job associated to this pay code
Type: String
Output only

Chapter 2
Introduced in v6.1
PayCode
Pay Code
The pay code
Type: String
Output only
PersonNumber
Employee Number
The person number
Type: String
Output only
StartTime
Start Time
The pay code start time
Type: Time
Output only
User
User
The audited user
Type: String
Output only
Sample values:
Introduced in v6.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddComment" |
"AddOnly" |
"Delete"
Parameters→
AddOnly→
Properties→
<PayCodeEdit
ScheduleAmountType = String
OrgJobId = String
OrgJobName = String
Date = Date
[NamedDurationAmount = TimeDuration]

Chapter 2
[OverrideAccrualDays = Double]
[StartTime = Time]
[<Notes>
<Note>*
</Notes>]
(<Comments>
<Comment>*
</Comments>)
<Employee>
</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.
Required Properties: AmountInTimeOrCurrency, CommentText, Date, Employee,
PayCodeName
Introduced in v4
AddOnly
Adds a new pay code edit with the specified properties.
Return Value Type: PayCodeEdit tag
Optional Properties: NamedDurationAmount, WorkRuleName

Chapter 2
Action Parameters

Optional
Optional used
of this tag.
Optional
Delete
Marks for deletion all pay code edits for the employee with matching properties.
Introduced in v4
ScheduleAmountType
Amount, based on the employee 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.

Chapter 2
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
• 3 to calculate the amount as a full-day contract amount.
• 5 to calculate the amount as a first half-day contract amount
• 6 to calculate the amount as a second half-day contract amount
Type: String
Amount, in time, currency, or days
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 days, specify a decimal amount between -1.0 and 1.0
• If PayCodeName holds time, specify a duration of time.
Type: String
OrgJobId
A unique identifier for a job in the organization.
Type: String
Default value: Null

Chapter 2
Introduced in v5.0
OrgJobName
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.
an Oracle database.
Type: String
Default value: Null
Introduced in v5.0
Comments
Comments
The set of comments currently returned with this timekeeping item.
Output Only
Introduced in v4
CommentText
Comment text
A text string that is attached to the pay code amount or totaled amount.
CommentText is required when you add a comment. It is optional when adding a
pay code edit, historical edit, or totaled amount.
Type: String
Optional

Chapter 2
Introduced in v4
Date
The date on which the current pay code edit becomes effective.
Type: Date
Required, Key
Sample values:
Introduced in v4
Employee
Employee
with the amount.
Required, Key
EnteredOnDate
Date of the edit
The date on which the edit is added to the database.
Type: Date
Output Only
Introduced in v4

Chapter 2
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 the pay code represents
an hourly pay code.
Type: Boolean
Output Only
Introduced in v4
LaborAccountName
Labor account name
This is the name of the 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 is being deleted or commented contains an
explicit value. It does not to be specified if the pay code amount or totaled amount
applies to the employee's primary account.
level, using the following format: 101/202/303/404/504/603/702.
Type: String
Optional, Key

Chapter 2

ManagerName
Manager name
The name that replaces the user name in audit.
Type: String
Optional
Introduced in v5.0a
NamedDurationAmount
Named duration amount
The hourly amount of the associated named duration, for day-based pay codes
with an associated duration pay code only. If the value is not set, the associated
named duration pay code would use Full Contract amount.
Type: TimeDuration
Optional
Default value: null
Introduced in v6.1
Notes
Comment notes
The list of notes for the comment to be created from comment text.
Optional
Introduced in v6.0
OverrideAccrualDays
Override accrual days
A decimal number used to override the calculations made when determining the
number of days (or fraction of a day) to be accrued as a result of this pay code

Chapter 2
edit. If specified, this value trumps all other calculated values. Note that this value
must not be specified if the value of the PayCodeName attribute refers to a pay
code of "money" type. Only used in the "AddOnly" action.
Type: Double
Optional
A decimal number between 0 and 1 (inclusive) with, at most, 2 digits after the
decimal point. Do not specify this attribute if the value of the PayCodeName
attribute refers to a pay code of "money" type. Only used in the "AddOnly" action.
Introduced in v6.0
PayCodeName
Pay code
Identifies the name of the pay code that is being applied to an amount associated
with a pay code or 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 currency. 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, Key
Introduced in v4

Chapter 2
StartTime
Start time
StartTime is an optional field and should not be specified when: (1) PayCode is of
"money" type or (2) the ScheduleAmountType value is specified. This is only
applicable to the "AddOnly" action.
Type: Time
Optional
The value must be able to be converted to a KTime object. If the specified
PayCode is of a "money" type or if the ScheduleAmountType value is specified,
then StartTime should simply not be specified. This is only applicable to the
"AddOnly" action.
Sample values:
1pm or 1:00pm or 13:00
Introduced in v6.0
WorkRuleName
Work rule name
The work rule of the associated named duration, for day-based pay codes with an
associated duration pay code only.
Type: String
Optional
Introduced in v6.1

Amount in Time
Properties that specify the amount of time to be assigned to a specified pay code
Required
Group includes: ScheduleAmountType, AmountInTimeOrCurrency
OrgJob
Organization Job Name or ID: If ID exists, Name is ignored.

Chapter 2
Optional

Chapter 2
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.
Note: Duration pay codes are not supported.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddComment" |
"AddOnly" |
"Delete"
Parameters→
AddOnly→
Properties→
<PayCodeMove
OrgJobId = String
OrgJobName = String
Date = Date
FromLaborAccountName = String

Chapter 2

[<Notes>
<Note>*
</Notes>]
(<Comments>
<Comment>*
</Comments>)
<Employee>
</Employee>
</PayCodeMove>
Action Descriptions
AddComment
Adds a comment to the set of comments associated with the pay code move item.
FromLaborAccountName, FromPayCodeName, PayCodeName
Introduced in v4
AddOnly
Adds a new pay code move item with the specified properties.
Return Value Type: PayCodeMove tag
FromPayCodeName, PayCodeName
Introduced in v4

Chapter 2
Action Parameters

Optional
Optional used
of this tag
Optional
Delete
Marks for deletion an existing pay code move item.
FromPayCodeName, PayCodeName
Introduced in v4
OrgJobId
Type: String
Default value: Null
Introduced in v5.0

Chapter 2
OrgJobName
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.
an Oracle database.
Type: String
Default value: null
Introduced in v5.0
Amount of pay code, expressed as a time duration or currency.
Type: String
Required, Key
pay code.
Comments
Comments
Output Only
Introduced in v4

Chapter 2
CommentText
Comment text
A comment
Type: String
Optional
Introduced in v4
Date
Date
The date on which the move is to be credited; for example, move 8:00 from pay
code A to pay code B, effective on 4/1/2001
Type: Date
Required, Key
Introduced in v4
Employee
Employee
One employee whose pay codes are to be adjusted, as specified in a
Required, Key
Introduced in v4
EnteredOnDate
Date of the edit
The server date on which the move is entered in the database
Type: Date

Chapter 2
Output Only
Introduced in v4
EnteredOnTime
Time of the edit
The server time at which the move is entered in the database
Type: Time
Output Only
Introduced in v4
FromLaborAccountName
Labor account that the amount is moved from
This is the name of the labor account of the employee from which a pay code
amount or totaled amount is being moved. LaborAccountName is optional when
contained an explicit value. This property need not be specified if the pay code
you can enter @H for those labor levels instead of entering the labor entry name.
Type: String
Optional, Key
FromPayCodeName
Pay code that the amount is moved from
The pay code from which the amount is to be moved

Chapter 2
Type: String
Required, Key
Introduced in v4
LaborAccountName
Labor account
This is the name of the labor account of the employee for whom a pay code
amount or totaled amount is being applied. LaborAccountName is optional when
contained an explicit value. This property need not be specified if the pay code
Type: String
Optional
ManagerName
Manager Name
The name to replace the user name in audit.
Type: String
Optional
Introduced in v5.0a

Chapter 2
Notes
Comment Notes
Optional
Introduced in v6.0
PayCodeName
Pay code
The pay code to be credited with the moved amount
Type: String
Required, Key
Introduced in v4

OrgJob
Organization Job ID or Name: If ID exists, Name is ignored.
Optional

Chapter 2
PayCodeProfile Tag
Pay Code Profile
The PayCodeProfile tag returns information about valid PayCode profiles defined
within the timekeeping system. A Pay Code is a category that the timekeeping
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAllPayCodeProfiles" |
"LoadById" |
"LoadPayCodesForProfileName"
Parameters→
None
Properties→
<PayCodeProfile
[PayCodeProfileId = Integer]
[PayCodeProfileName = String] >
</PayCodeProfile>
Action Descriptions

Chapter 2
Load
Returns a pay code profile, based on PayCodeProfileName.
Return Value Type: PayCodeProfile tag
Required Properties: PayCodeProfileName
Introduced in v4
LoadAllPayCodeProfiles
Returns a list of all pay code profiles in the system.
Return Value Type: Zero or more PayCodeProfile tags
Introduced in v4
LoadById
Returns a pay code profile, based on PayCodeProfileId.
ID must be valid
Return Value Type: PayCodeProfile tag
Required Properties: PayCodeProfileId
Introduced in v4
LoadPayCodesForProfileName
Returns all paycodes associated with the given profile name, based on
PayCodeProfileName.
Validates that the name is associated with a valid profile name.
Return Value Type: Zero or more PayCode tags
Required Properties: PayCodeProfileName
Introduced in v5.1

Chapter 2
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

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Delete"
Parameters→
None
Properties→
<PayFromSchedule
EndDate = Date
StartDate = Date >
<Employee>
<PersonIdentity>
</Employee>
</PayFromSchedule>
Action Descriptions

Chapter 2
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.
Required Properties: Employee, StartDate, EndDate
Introduced in v4
Delete
Marks all existing pay from schedule items for deletion for the specified
employee and time span.
Required Properties: Employee, StartDate, EndDate
CommentText
Comment text
A comment
Type: String
Optional
Introduced in v4

Chapter 2
Employee
Employee
One employee who is paid from a schedule, as specified in a PersonIdentity tag.
Required
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

Chapter 2
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).
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Delete"
Parameters→
None
Properties→
<PayFromScheduleStopEvent
Date = Date >
<Employee>
<PersonIdentity>
</Employee>
</PayFromScheduleStopEvent>
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.

Chapter 2

Introduced in v4
Delete
Marks the record to stop an employee from being paid according to the schedule
for deletion.
The employee must exist
Introduced in v5.0
CommentText
Comment text
A comment
Type: String
Optional
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

Chapter 2
Required
Introduced in v4
Employee
Employee
One employee, as specified in a PersonIdentity tag, who is paid from schedule and
was absent.
Required
Introduced in v4

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAllPayRuleProfiles" |
"LoadById"
Parameters→
None
Properties→
<PayRuleProfile
[PayRuleProfileId = Integer]
[PayRuleProfileName = String] >
</PayRuleProfile>
Action Descriptions
Load
Returns a pay rule profile, based on PayRuleProfileName.

Chapter 2
Return Value Type: PayRuleProfile tag

Required Properties: PayRuleProfileName
Introduced in v4
LoadAllPayRuleProfiles
Returns a list of all pay rule profiles in the system.
Return Value Type: Zero or more PayRuleProfile tags
Introduced in v4
LoadById
Returns a pay rule profile, based on PayRuleProfileId.
Return Value Type: PayRuleProfile tag
Required Properties: PayRuleProfileId
Introduced in v4
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

Chapter 2
Type: String
Optional
Sample values:
Full Time
Introduced in v4

Chapter 2
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
Introduced in v4
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<PeriodTotals
(PeriodDateSpan = DateSpan) >
(<Totals>
<TotalSummary>
</Totals>)
</PeriodTotals>
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

Chapter 2
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

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<Permission
(AccessControlPointName = String)
(ActionName = String)
(SuiteProductName = String)
(ScopeName = String) >
</Permission>
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

Chapter 2
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
Enumerated value: 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

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<Person
[AccrualProfileEffectiveDate = String]
[AccrualProfileEndDate = String]
[BaseWageHourly = Currency]
[BirthDate = Date]
(ManagerSignoffThruDateTime = Date)
(PayrollLockoutThruDateTime = Date)
[HasKmailNotificationDelivery = Boolean]
[FirstName = String]
(FullName = String)
[HireDate = Date]
[FingerRequiredFlag = Boolean]
[LastName = String]
[MiddleInitial = String]
[FullTimePercentage = Long]
[PhoneticFullName = String]
[EmployeeStandardHours = Double]
[FullTimeStandardHours = Double]
[RomanizedFullName = String]

Chapter 2
[ShortName = String] >

</Person>
AccrualProfileEffectiveDate
Accrual profile effective date
Specifies the date (inclusive) when an Accrual Profile Assignment is effective. If
AccrualProfileEffectiveDate is not supplied (tag or value), the effective date is
effective from Beginning of time.
Type: String
Optional
Introduced in v6.1
AccrualProfileEndDate
Accrual profile end date
Specifies date (inclusive) when an Accrual Profile Assignment ends. If
AccrualProfileEndDate is not supplied (tag or value), the End date extends to
forever.
Type: String
Optional
Introduced in v6.1
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. The Accrual Profile assignment to an employee is effective dated based on
the optional properties AccrualProfileEffectiveDate and AccrualProfileEndDate.
There could be only one single Accrual Profile assigned to an employee on any
one day. Assigning a different Accrual Profile over existing assignment(s) will
insert the new Assignment over the old Assignment(s).
Type: String

Chapter 2
Optional
Sample values:
VAC and Sick Only

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
If specified, this value must be greater than or equal to 0.0.
Default value: 0.00
BaseWageRateEntry 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
The EmployeeStandardHours and FullTimeStandardHours properties define the
full-time equivalency for a part-time employee, defining the equivalency as a ratio

Chapter 2
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
EmployeeStandardHours must be greater than or equal to 0.0. If both
EmployeeStandardHours and FullTimePercentage are specified,
FullTimePercentage takes precedence.
FingerRequiredFlag
Is finger scan identification required?
Indicates when a finger scan (biometric) entry is required for the person
Type: Boolean
Optional
FirstName
First name
The person's first name.

Chapter 2
Type: String
Optional
Introduced in v4
FullName
Full name
Name of the person. This name is usually listed in the browser.
Type: String
Output Only
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.
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

Chapter 2
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
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.
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.

Chapter 2
HasKmailNotificationDelivery
Determines if this personsKMailisusedforreceivingGenericNotifications'
If a Generic Notification is sent to the associated Person, the person will receive
this notification in his/her Inbox.
This property is optional. If it has not been specified, the current value of this
person's HasKmailNotificationDelivery remains unchanged
Type: Boolean
Optional
Introduced in v6.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 record for the new hire is imported.
LastName
Last name
The person's last name. A value for this column is required when adding a new
person.
Type: String
Optional
Introduced in v4
ManagerSignoffThruDateTime
Date of last manager signoff
Date of the last manager signoff

Chapter 2
Type: Date
Output only
MiddleInitial
Middle initial
The person's middle initial
Type: String
Optional
Introduced in v4
PayrollLockoutThruDateTime
Date of last payroll lockout
Date of the last payroll lockout
Type: Date
Output only
PersonNumber
Person number
Person number of the specified person. This property is used to set, change, or
display the Person Number assignment.
Type: String
Optional
This number must be unique regardless of whether the person is active, inactive,
or terminated.
Required: When creating a new person

Chapter 2
PhoneticFullName
Phonetic Full Name
The Phonetic version of the person's full name.
Type: String
Optional
Introduced in v6.0
RomanizedFullName
Romanized Full Name
The Romanized version of the person's full name.
Type: String
Optional
Introduced in v6.0
ShortName
Short name for person
The name by which the person wants to be known.
Type: String
Optional
Default value: The first 20 characters of the first name.
Introduced in v4

Chapter 2
PersonAccessAssignment Tag
Access Assignment Data
The PersonAccessAssignment tag specifies an access assignment that is in effect
for an employee as of the effective date.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadPersonAccessAssignments"
Parameters→
None
Properties→
<PersonAccessAssignment
[ProfessionalTransferOrganizationSetName = String]
[ManagerTransferOrganizationSetName = String]
[ManagerAccessOrganizationSetName = String] >
<Identity>
</Identity>
[<Period>
<TimeFramePeriod>
</Period>]
</PersonAccessAssignment>
Action Descriptions

Chapter 2
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
Introduced in v5.0
EffectiveDate
Date when access becomes effective
The date the access assignment becomes effective for the person
Type: Date
Optional
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

Chapter 2

Introduced in v5.0
Identity
Identity
Optional Key
Introduced in v5.0
ManagerAccessOrganizationSetName
Organizational group
An organizational group that a manager can use.
Type: String
Optional
Default value: The Empty Organization Set
Enumerated value: All Organizational Sets, Organizational Groups
ManagerTransferOrganizationSetName
Job transfer set - manager
A job transfer set that a manager can use.
Type: String
Optional
Enumerated value: All Organizational Sets, Job Transfer Sets

Chapter 2
Period
Time period
The span of time associated with the person access assignments
Optional
Used for the LoadPersonAccessAssignments action
Introduced in v5.0
ProfessionalTransferOrganizationSetName
Job transfer set - employee
A job transfer set that an employee can use.
Type: String
Optional
Enumerated value: All Organizational Sets, Job Transfer Sets

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"DeleteOnly" |
"Load" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<Personality
[<WTKEmployeeData>
<WTKEmployee>
</WTKEmployeeData>]
[<GDAPAssignments>
<GDAPAssignment>*
</GDAPAssignments>]
<Identity>
</Identity>
[<JobAssignmentData>
<JobAssignment>
</JobAssignmentData>]

Chapter 2
[<PersonInformationData>
<PersonInformation>
</PersonInformationData>]
[<Period>
<TimeFramePeriod>
</Period>]
[<UserData>
<User>
</UserData>]
</Personality>
Action Descriptions
AddOnly
Adds a new person to the system.
Required Properties: PersonInformationData
Invalid Properties: Identity
Introduced in v4
Delete
Marks a person for deletion.
Introduced in v5.0
DeleteOnly
Marks a person for deletion.

Chapter 2
Load
Returns a person's demographic, user, and employee information.
Return Value Type: Personality tag
Introduced in v4
Update
Adds information for a new person or updates an existing one.
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.
Introduced in v4
UpdateOnly
Updates an existing person.
Introduced in v4
GDAPAssignments
Generic Data Access Profile Assignment List
Generic Data Access Profile Assignments for the person.
Type: Zero or more GDAPAssignment tags
Optional
Introduced in v6.0

Chapter 2
Identity
Identity
Optional Key
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
Optional
Used for narrowing the effective date of the request
PersonInformationData
Person data
The person information of the person
Type: PersonInformation tag
Optional

Chapter 2
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
Introduced in v4; last changed in v5.0; deprecated in v5.0. Use the properties in
the Person and JobAssignmentDetails tags.

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load"
Parameters→
None
Properties→
<PersonalOvertimeAssignment
[StopOvertimeFlag = Boolean]
OvertimeLevel = Long
OvertimeTypeName = String >
<Identity>
</Identity>
[<PersonalOvertimeRuleData>
<PersonalOvertimeRule>
</PersonalOvertimeRuleData>]
<Period>
<TimeFramePeriod>
</Period>
</PersonalOvertimeAssignment>

Chapter 2
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
Introduced in v5.0
EffectiveDate
Effective date
The date when the personal overtime assignment becomes effective
Type: Date
Optional
Default value: Current system date
Introduced in v5.0
ExpirationDate
Expiration date
The date when the personal overtime assignment expires
Type: Date

Chapter 2
Optional
Introduced in v5.0
Identity
Identity
One employee, as specified in a PersonIdentity or CurrentUser tag
Optional Key
Only used for the Load action
Introduced in v5.0
OvertimeLevel
Overtime level
The numeric position of the overtime rule within the sequence of rules.
Type: Long
Required Key
The value must be an integer greater than zero.
Introduced in v5.0
OvertimeTypeName
Overtime type
The reset interval for the rule
Type: String
Required Key
Introduced in v5.0

Chapter 2
Period
Time period
The specified time frame
Optional Key
Must evaluate to a span of time. Identity is used when the time frame requires
association with a person.
Used for the Load action
Introduced in v5.0
PersonalOvertimeRuleData
Personal overtime rule
The personal overtime rule associated with the personal overtime assignment An
overtime establishes the limits and reset methods for accumulating overtime
hours.
Type: PersonalOvertimeRule tag
Optional
StopOvertimeFlag
Associate with job assignment?
Indicates whether this personal overtime assignment shall be associated with the
job during the time span
Type: Boolean
Optional
Introduced in v5.0

Chapter 2
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
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<PersonalOvertimeLimit
[MinimumAmount = TimeDuration]
[Amount = TimeDuration]
PersonalOvertimeAmountTypeName = String >
</PersonalOvertimeLimit>
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

Chapter 2
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 Key
Enumerated value: DAILY, WEEKLY, PAYPERIOD, BI_WEEKLY,
RANGE_OF_TIME, SHIFT, 24HOUR_RULE, NUMBER_OF_DAYS

Chapter 2
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
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<PersonalOvertimeRule
(PersonalOvertimeRuleDisplayName = String)
[UseScheduleFlag = Boolean] >
[<PersonalOvertimeLimits>
<PersonalOvertimeLimit>*
</PersonalOvertimeLimits>]
</PersonalOvertimeRule>
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

Chapter 2
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
Introduced in v5.0

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<PersonAuthenticationType
ActiveFlag = Boolean
AuthenticationTypeName = String >
</PersonAuthenticationType>
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

Chapter 2
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

Chapter 2
PersonCascadeProfileAssignment Tag
Person Cascade Profile Assignment
Assigns a Cascade Profile to a Person
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"Delete" |
"Retrieve"
Parameters→
None
Properties→
<PersonCascadeProfileAssignment
[CascadeProfile = String] >
<Person>
<PersonIdentity>
</Person>
</PersonCascadeProfileAssignment>
Action Descriptions
Add
Assigns a Cascade Profile to a Person
The cascade profile and person must exist.
Required Properties: CascadeProfile, Person

Chapter 2

Introduced in v6.1
Delete
Deletes the cascade profile assignment for the specified person.
The person must exist.
Introduced in v6.1
Retrieve
Retrieves the cascade profile assignment for the specified person.
The person must exist.
Return Value Type: PersonCascadeProfileAssignment tag
Introduced in v6.1
CascadeProfile
Cascade Profile
The name of the cascade profile to assign to the person. This property is required
only for the Add action.
Type: String
Optional
Introduced in v6.1
Person
Person
The person to whom a cascade profile is assigned.

Chapter 2

Required
Introduced in v6.1

Chapter 2
PersonCertificationAssign Tag
Certifications Assigned to Employees
The PersonCertificationAssign tag assigns one or more certifications to one or
more employees.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadAll" |
"LoadCertificationAssignments" |
"Update"
Parameters→
None
Properties→
<PersonCertificationAssign
[PersonNumber = String] >
[<PersonCertificationItems>
<PersonCertificationItem>*
</PersonCertificationItems>]
[<Employees>
<PersonIdentity>*
</Employees>]
[<Period>
<TimeFramePeriod>
</Period>]
</PersonCertificationAssign>
Action Descriptions

Chapter 2
LoadAll
Returns all certification assignments for an employee.
Return Value Type: PersonCertificationAssign tag
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
Update
Assigns certifications to one or more employees.
Required Properties: PersonCertificationItems, Employees
Introduced in v5.0
Employees
Employees
One or more employees, as specified in one or more PersonIdentity tags, for
whom the certification is assigned.
Optional

Chapter 2
Each employee must have a WFS license.

Introduced in v5.0
Period
Time period
The time span when the assignment is in effect.
Optional
PersonCertificationItems
Certification items
The certification items that are assigned to the employees specified in Employees.
Type: Zero or more PersonCertificationItem tags
Optional
Introduced in v5.0
PersonNumber
Person number
The person number of the person about whom information is returned
Type: String
Optional
Introduced in v5.0

Chapter 2
PersonCertificationItem Tag
Certification Assigned to Employees
The PersonCertificationItem tag identifies a certification that can be assigned to
one or more people.
Used by: PersonCertificationAssign
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<PersonCertificationItem
Name = String
[CertificationNumber = String]
ExpirationDate = Date
[OldCertificationNumber = String]
[OldEffectiveDate = Date]
[OldExpirationDate = Date] >
</PersonCertificationItem>
CertificationNumber
Certification number
Certification number
Type: String
Optional

Chapter 2

EffectiveDate
Effective date
The date when the certification assignment becomes effective for the employee
previously specified
Type: Date
Required
ExpirationDate
Expiration date
The date when the assignment of this certification to the previously specified
employee expires
Type: Date
Required
Name
Certification name
The unique name of a legal certification
Type: String
Required
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.

Chapter 2
To update a certification number, you must specify the certification number and
these three properties.
Type: String
Optional
OldEffectiveDate
Old effective date
The old effective date is the one that was previously specified for a person
certification assignment.
Type: Date
Optional
OldExpirationDate
Old expiration date
The old expiration date is the one that was previously specified for a person
certification assignment.
Type: Date
Optional

Chapter 2
PersonIdentity Tag
Person Identity Data
The PersonIdentity tag identifies one or more people. It is used by many import
transactions.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadIdentities"
Parameters→
None
Properties→
<PersonIdentity
EmployeeKey = Long
PersonKey = Long
<PersonIdentityList>
</PersonIdentityList>
UserKey = Long
[EffectiveTime = Time] >
[<FilterQueryName>
<HyperFindQuery>
</FilterQueryName>]
</PersonIdentity>
Action Descriptions

Chapter 2
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.
Return Value Type: PersonIdentity tag
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 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.
A member of the Identifier group. If you are importing data from another system,
this may be a convenient identifier to use.
Type: String
The effective date is the date of the server
Introduced in v4

Chapter 2
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
Must identify just one person
A member of the Identifier group
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
PersonIdentityList
Person identity list
One or more PersonIdentity and CurrentUser tags
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
PersonNumber
Person number
The person's identification number.

Chapter 2
A member of the Identifier group. If you are importing data from another system,
this may be a convenient identifier to use.
Type: String
Non-numeric values are permitted.
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
EffectiveDate
Effective Date
Currently this property is only associated with BadgeNumber. If it is not specified
the server's date is used as the EffectiveDate to find the employee by the
BadgeNumber.
Type: Date
Optional
The date format must be valid.
Sample values:
EffectiveDate = "7/31/2007"
Introduced in v6.1

Chapter 2
EffectiveTime
Effective Time
Currently this property is only associated with the BadgeNumber to find the
employee. If the EffectiveTime is not specified, the server's time is used as the
EffectiveTime.
Type: Time
Optional
The time format must be valid.
Sample values:
EffectiveTime = î 5:49PM î
Introduced in v6.1
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

Identifier
Only one member of the Identifier group can be specified.
Identifier and FilterQueryName are mutually exclusive.

Chapter 2
Outstanding: Identifier usage constraint is specified as Required. But Identifier

and FilterQueryName are mutually exclusive. Therefore, Identifier should not be
Required.
Required
Group includes: BadgeNumber, EmployeeKey, PersonKey, PersonIdentityList,
PersonNumber, UserKey

Chapter 2
PersonInformation Tag
Person Information and Data
The PersonInformation tag contains demographic, employment, and system
information.
See the following tags for validation rules:
• AccessAssignment
• BadgeAssignment
• CustomData
• CustomDate
• EmailAddress
• EmploymentStatus
• ExpectedHours
• HomeAccount
• PersonIdentity
• Person
• PersonAccessAssignment
• PersonLicenseType
• PostalAddress
• Supervisor
• TelephoneNumber
• UserAccountStatus
Syntax
Request→

Chapter 2
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAllBadgeAssignments" |
"LoadAllEmploymentStatus" |
"LoadAllHomeAccounts" |
"LoadAllUserAccountStatus"
Parameters→
None
Properties→
<PersonInformation
[<PersonAccessAssignments>
<PersonAccessAssignment>*
</PersonAccessAssignments>]
[<AccessAssignmentData>
<AccessAssignment>
</AccessAssignmentData>]
[<CustomDataList>
<CustomData>*
</CustomDataList>]
[<Approvals>
<Approver>*
</Approvals>]
[<PersonAuthenticationTypes>
<PersonAuthenticationType>*
</PersonAuthenticationTypes>]
[<BadgeAssignments>
<BadgeAssignment>*
</BadgeAssignments>]
[<CurrencyAssignment>
<EmployeeCurrencyAssignment>
</CurrencyAssignment>]
[<EMailAddresses>
<EmailAddress>*
</EMailAddresses>]
[<EmploymentStatusList>
<EmploymentStatus>*
</EmploymentStatusList>]
<Identity>

Chapter 2
</Identity>
[<HomeAccounts>
<HomeAccount>*
</HomeAccounts>]
[<PersonData>
<Person>
</PersonData>]
[<CustomDates>
<CustomDate>*
</CustomDates>]
[<PostalAddresses>
<PostalAddress>*
</PostalAddresses>]
[<ExpectedHoursList>
<ExpectedHours>*
</ExpectedHoursList>]
[<PersonLicenseTypes>
<PersonLicenseType>*
</PersonLicenseTypes>]
[<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

Chapter 2
Introduced in v4
LoadAllBadgeAssignments
Returns all badge assignments for the specified person.
Return Value Type: Zero or more BadgeAssignment tags
LoadAllEmploymentStatus
Returns all employment statuses for the specified person.
Return Value Type: Zero or more EmploymentStatus tags
LoadAllHomeAccounts
Returns all home accounts for the specified person. The home account shall be
the derived account (resulting from the combination of the Primary Job and
Primary Labor Account) for the specified time frame.
Return Value Type: Zero or more HomeAccount tags
LoadAllUserAccountStatus
Returns all user account statuses for the specified person.
Return Value Type: Zero or more UserAccountStatus tags

Chapter 2
AccessAssignmentData
Access rights
A set of access rights and preferences
Type: AccessAssignment tag
Optional
Introduced in v4
Approvals
Approvals
The list of managers who can approve or deny overtime requested by employees.
Type: Zero or more Approver tags
Optional
Introduced in v6.1
BadgeAssignments
Badge assignments
One or more badge numbers and associated time frames
Type: Zero or more BadgeAssignment tags
Optional
Introduced in v4
CurrencyAssignment
CurrencyAssignment
Employee's currency assignment
Type: EmployeeCurrencyAssignment tag
Optional
Introduced in v6.1
CustomDataList
Additional information
One or more sets of information for site-specified data categories

Chapter 2
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
Specifies the person's e-mail address.
Type: Zero or more EmailAddress tags
Optional
EmploymentStatusList
Employment statuses
The employment statuses for the specified time frames
Type: Zero or more EmploymentStatus tags
Optional
Introduced in v4
ExpectedHoursList
Standard hours
The number of hours for the specified time period types
Type: Zero or more ExpectedHours tags
Optional
Introduced in v4

Chapter 2
HomeAccounts
Labor accounts
Specifies labor accounts assigned for the specified time frames. When specified
within and AddOnly, Update, or UpdateOnly action, the values within this tag
represent the labor accounts assigned to the person over the specified time frame.
When resulting from the Load action, the home account shall be the derived
account (resulting from the combination of the Primary Job and Primary Labor
Account) for the specified time frame.
Type: Zero or more HomeAccount tags
Optional
Introduced in v4; last changed in v5.0; deprecated in v5.0. Use the
PrimaryLaborAccount tag to assign labor accounts.
Identity
Identity
Required Key
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.

Chapter 2
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
Introduced in v4
PersonLicenseTypes
Status of licenses
The licenses for a specific person.
Type: Zero or more PersonLicenseType tags
Optional
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

Chapter 2
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

Chapter 2
PersonLicenseType Tag
License that is Assigned to a Person
The PersonLicenseType tag contains information about the license assigned to a
person.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<PersonLicenseType
ActiveFlag = Boolean
LicenseTypeName = String >
</PersonLicenseType>
ActiveFlag
Is the license active?
Specifies the state of the license. True if the license is active for the person.
Type: Boolean
Required
Introduced in v4
LicenseTypeName
Type of license
The name or the Id of the license type.

Chapter 2
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
Type: String
Required Key
Specify @ to make no change to the existing license type.
Enumerated value: @, 1, 2, 3, 5, 9

Chapter 2
PersonShiftTemplateAssignment Tag
Shift Template Profile Assigned to Person
The PersonShiftTemplateAssignment tag associates a shift template profile with a
person.
Introduced in v5.1Beta; last changed in v5.0a
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"Update"
Parameters→
None
Properties→
<PersonShiftTemplateAssignment
ShiftTemplateProfileName = String >
<Employee>
<PersonIdentity>
</Employee>
</PersonShiftTemplateAssignment>
Action Descriptions
Load
Returns the name of the shift template for the specified employee.
Return Value Type: PersonShiftTemplateAssignment tag

Chapter 2
Update
Assigns a specified shift template to a specified employee.
Taken together, the shift template and employee must be unique in the system.
Required Properties: Employee, ShiftTemplateProfileName
Employee
Employee
One employee, as specified in a PersonIdentity tag
Required Key
ShiftTemplateProfileName
Shift template profile name
The name of a shift code profile name
Type: String
Optional Key

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadAll" |
"LoadSkillAssignments" |
"Update"
Parameters→
None
Properties→
<PersonSkillAssign
[<Employees>
<PersonIdentity>*
</Employees>]
[<PersonSkillItems>
<PersonSkillItem>*
</PersonSkillItems>]
[<Period>
<TimeFramePeriod>
</Period>]
</PersonSkillAssign>
Action Descriptions

Chapter 2
LoadAll
Returns all skill assignments for an employee.
Return Value Type: PersonSkillAssign tag
LoadSkillAssignments
Returns skill assignments for an employee for the specified timeframe.
Return Value Type: PersonSkillAssign tag
Update
Assigns skills to one or more employees.
Required Properties: PersonSkillItems, Employees
Introduced in v5.0
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.
Optional
Each employee must have a WFS license.
Introduced in v5.0

Chapter 2
Period
Time period
The span of time during which the skill assignments are in effect for the specified
employees.
Optional
Introduced in v5.0
PersonNumber
Person number
The person number of a person about whom information is returned.
Type: String
Optional
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

Chapter 2
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
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<PersonSkillItem
Name = String >
</PersonSkillItem>
EffectiveDate
Effective date
The date when the skill becomes available for assignment
Type: Date
Optional
Introduced in v5.0

Chapter 2
ExpirationDate
Expiration date
The date when the skill will no longer be available for assignment
Type: Date
Output only
IsActive
Is the skill active?
Specifies whether the skill is active
Type: Boolean
Optional
Introduced in v5.0
Name
Skill name
The name of a skill
Type: String
Required
You can see the list of existing skills in the user interface.

Chapter 2
PostalAddress Tag
Postal Address
The PostalAddress tag specifies address elements for a specified address type.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<PostalAddress
ContactTypeName = String
[City = String]
[Country = String]
[State = String]
[Street = String]
[PostalCode = String] >
</PostalAddress>
City
City
The city or town portion of the person's address
Type: String
Optional
Introduced in v4

Chapter 2
ContactTypeName
Category of the contact
The name of the contact category
Type: String
Required Key
Introduced in v4
Country
Country
The country portion of the person's address
Type: String
Optional
Introduced in v4
PostalCode
Zip code
The postal code portion of the person's address
Type: String
Optional
Introduced in v4
State
State/Province
The state or province of the person's address
Type: String
Optional

Chapter 2
Street
Street
The numerical and street name portion of the person's address
Type: String
Optional
Introduced in v4

Chapter 2
PreferenceProfile Tag
Display Profile
The PreferenceProfile tag provides information about valid Preference Profiles
defined within the timekeeping system. The display profile determines the
information that the system displays to a user (for example, the HyperFinds that
appear on the navigation bar).
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAllPreferenceProfiles" |
"LoadById"
Parameters→
None
Properties→
<PreferenceProfile
PreferenceProfileName = String
[PreferenceProfileId = Integer] >
</PreferenceProfile>
Action Descriptions
Load
Returns a preference profile, based on PreferenceProfileName.
Return Value Type: PreferenceProfile tag

Chapter 2
Required Properties: PreferenceProfileName

LoadAllPreferenceProfiles
Returns all preference profiles in the system.
Return Value Type: Zero or more PreferenceProfile tags
Introduced in v4
LoadById
Returns a preference profile, based on PreferenceProfileId.
Return Value Type: PreferenceProfile tag
Required Properties: PreferenceProfileId
Introduced in v4
PreferenceProfileId
Id of display profile
Uniquely identifies the preference profile in the database
Type: Integer
Optional
Introduced in v4
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 display
profile for managers.
Type: String

Chapter 2
Required
Introduced in v4

Chapter 2
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

Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadPrimaryLaborAccounts"
Parameters→
None
Properties→
<PrimaryLaborAccount
[OrganizationPath = String] >
<Identity>
</Identity>
[<Period>
<TimeFramePeriod>
</Period>]

Chapter 2
</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
EffectiveDate
Effective date
The date when the primary labor account becomes effective
Type: Date
Optional
Default value: Current date
Introduced in v5.0
ExpirationDate
Expiration date
The date when the primary labor account expires
Type: Date

Chapter 2
Optional
Introduced in v5.0
Identity
Identity
Optional Key
Must uniquely identify a person
LaborAccountName
Labor account
The name of the employee's primary labor account.
Type: String
Optional
Required for an employee's primary labor account name.
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

Chapter 2
OrganizationPath
Primary job in the organization
The primary job information.
Dependency: This value is required only to import a Scheduling Employee.
Enter values in the same format as they appear in the database. String matching is
case-sensitive on a 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
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
Optional
Identity is used if a person is required in association with the time frame.
Used for the LoadPrimaryLaborAccounts action

Chapter 2

Introduced in v5.0

Chapter 2
Procedure Tag
Procedure
A procedure represents a PSE engine process.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"DeleteOnly" |
"Retrieve" |
"RetrieveAll" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<Procedure
[ContextName = String]
ProcedureName = String >
</Procedure>
Action Descriptions

Chapter 2
Add
Inserts one Procedure object in the database . If it's already there a rule with the
same name nothing happens.
Required Properties: ProcedureName, ContextName
Introduced in v6.0
AddOnly
Inserts one Procedure object in the database . If it's already there an error is
thrown.
Required Properties: ProcedureName, ContextName
Introduced in v6.0
Delete
Deletes the Procedure object from the database that has the same name as the one
specified in the ProcedureName. If it's not there nothing happens.
Required Properties: ProcedureName
Introduced in v6.0
DeleteOnly
Deletes the Procedure object from the database that has the same name as the one
specified in the ProcedureName. If it's not there an error is thrown.
Introduced in v6.0

Chapter 2
Retrieve
Retrieves the Procedure object that has the same name as the one specified in the
ProcedureName.
Return Value Type: Procedure tag
Introduced in v6.0
RetrieveAll
Retrieves all the Procedure objects.
Return Value Type: Zero or more Procedure tags
Introduced in v6.0
Retrieves all the Procedure objects.
Return Value Type: Zero or more Procedure tags
Introduced in v6.0
RetrieveAllNames
Retrieves all the names for all Procedure objects.
Introduced in v6.0
RetrieveForUpdate
Retrieves the Procedure object that has the same name as the one specified in the
ProcedureName.
Return Value Type: Procedure tag

Chapter 2
Introduced in v6.0
Update
Updates one Procedure object in the database . If it's not there it's inserted, if it's
there it's updated.
Introduced in v6.0
UpdateOnly
Updates one Procedure object in the database . If it's not there an error is thrown.
Introduced in v6.0
ContextName
Context name
The name of the context.
Type: String
Optional
Introduced in v6.0
Description
Description
It's the description of the rule set. It must not have more then 255 characters and
must not contain invalid characters also.
Type: String
Optional
Introduced in v6.0

Chapter 2
ProcedureName
Procedure name
Defines the name of the Procedure object.
Type: String
Required
Introduced in v6.0

Chapter 2
ProcedureAction Tag
Procedure Action
Procedure actions define legal actions for the pse engine.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveAll"
Parameters→
None
Properties→
<ProcedureAction
ProcedureActionName = String >
</ProcedureAction>
Action Descriptions
Retrieve
Retrieves the ProcedureAction object that has the same name as the one specified
in the ProcedureActionName.
Return Value Type: ProcedureAction tag
Required Properties: ProcedureActionName
Introduced in v6.0

Chapter 2
RetrieveAll
Retrieves all the ProcedureAction objects.
Return Value Type: Zero or more ProcedureAction tags
Introduced in v6.0
ProcedureActionName
Procedure action name
The name of the ProcedureAction object.
Type: String
Required Key
Introduced in v6.0

Chapter 2
ProcedureContext Tag
Procedure Context
Defines the context of a Procedure.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames"
Parameters→
None
Properties→
<ProcedureContext
ProcedureContextName = String >
</ProcedureContext>
Action Descriptions
Retrieve
Retrieves the ProcedureContext object that has the same name as the one
specified in the ProcedureContextName.
Return Value Type: ProcedureContext tag
Required Properties: ProcedureContextName
Introduced in v6.0

Chapter 2
RetrieveAll
Retrieves all the ProcedureContext objects.
Return Value Type: Zero or more ProcedureContext tags
Introduced in v6.0
RetrieveAllNames
Retrieves all the names for all ProcedureContext objects.
Introduced in v6.0
ProcedureContextName
Procedure context name
The name of the ProcedureContext.
Type: String
Required Key
Introduced in v6.0

Chapter 2
ProcedureParameter Tag
Procedure Parameter
A generic procedure parameter.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ProcedureParameter
ParameterValue = String
ProcedureParameterName = String
ProcedureParameterDefinitionName = String >
</ProcedureParameter>
ParameterValue
Parameter value
Defines the value of this ProcedureParameter object.
Type: String
Required Key
Introduced in v6.0
ProcedureParameterDefinitionName
Procedure parameter definition name
Defines the name of the ProcedureParameterDefinition object associated to this
ProcedureParameter object.
Type: String

Chapter 2
Required Key
Introduced in v6.0
ProcedureParameterName
Procedure Parameter Name
Represents the procedure parameter name.
Type: String
Required Key
Introduced in v6.0

Chapter 2
ProcedureParameterDefinition Tag
Procedure Parameter Definition
Defines a Procedure parameter.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames"
Parameters→
None
Properties→
<ProcedureParameterDefinition
ProcedureParameterName = String >
</ProcedureParameterDefinition>
Action Descriptions
Retrieve
Retrieves the ProcedureParameterDefinition object that has the same name as the
one specified in the ProcedureParameterName.
Return Value Type: ProcedureParameterDefinition tag
Required Properties: ProcedureParameterName

Chapter 2
RetrieveAll
Retrieves all the sorting and matching ProcedureParameterDefinition objects.
Return Value Type: Zero or more ProcedureParameterDefinition tags
Introduced in v6.0
RetrieveAllNames
Retrieves all the names for all ProcedureParameterDefinition objects.
Introduced in v6.0
Procedure parameter name
The name of the Procedure's parameter.
Type: String
Required Key
Introduced in v6.0

Chapter 2
ProcedureSet Tag
Procedure Set
Represents a set of ProceduresSetItem objects. Each item ProceduresSetItem has
a procedure and a set of ProcedureParam objects that holds all the parameters that
are needed to run the given procedure.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"DeleteOnly" |
"Retrieve" |
"RetrieveAll" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<ProcedureSet
ContextName = String
ProcedureSetName = String >
[<ProcedureSetItems>
<ProcedureSetItem>*
</ProcedureSetItems>]

Chapter 2
</ProcedureSet>
Action Descriptions
Add
Inserts one ProcedureSet object in the database. If it's already there a Procedure
with the same name nothing happens.
Required Properties: ProcedureSetName, ContextName
Introduced in v6.0
AddOnly
Inserts one ProcedureSet object in the database . If it's already there an error is
thrown.
Introduced in v6.0
Delete
Deletes the ProcedureSet object from the database that has the same name as the
one specified in the ProcedureSetName. If it's not there nothing happens.
Required Properties: ProcedureSetName
Introduced in v6.0
DeleteOnly
Deletes the ProcedureSet object from the database that has the same name as the
one specified in the ProcedureSetName. If it's not there an error is thrown.

Chapter 2

Introduced in v6.0
Retrieve
Retrieves the ProcedureSet object that has the same name as the one specified in
the ProcedureSetName.
Return Value Type: ProcedureSet tag
Introduced in v6.0
RetrieveAll
Retrieves all the ProcedureSet objects.
Return Value Type: Zero or more ProcedureSet tags
Introduced in v6.0
Retrieves all the ProcedureSet objects.
Return Value Type: Zero or more ProcedureSet tags
Introduced in v6.0
RetrieveAllNames
Retrieves all the names for all ProcedureSet objects.
Introduced in v6.0

Chapter 2
RetrieveForUpdate
Retrieves the ProcedureSet object that has the same name as the one specified in
the ProcedureSetName.
Return Value Type: ProcedureSet tag
Introduced in v6.0
Update
Updates one ProcedureSet object in the database. If it's not there it's inserted, if it's
there it's updated.
Introduced in v6.0
UpdateOnly
Updates one ProcedureSet object in the database . If it's not there an error is
thrown.
Introduced in v6.0
ContextName
Context Name
Represents the procedure set context name.
Type: String

Chapter 2
Required
Sample values:
PSE_CONTEXT
Introduced in v6.0
Description
Description of rule set
Description of the rule set. Cannot exceed 255 characters and cannot contain
invalid characters.
Type: String
Optional
Introduced in v6.0
ProcedureSetItems
Procedure Set Items
Represents the list of procedure set items.
Type: Zero or more ProcedureSetItem tags
Optional
Sample values:
<ProcedureSetItems>
<ProcedureSetItem ProcedureName = "Procedure2"
GenerateAudit="False">
<ProcedureParameters>
<ProcedureParameter
ProcedureParameterDefinitionName =
"SORTING_EMPLOYEES_RULE_SET" ParameterValue="Rule Set
NB 4" />
<ProcedureParameter
ProcedureParameterDefinitionName =
"SORTING_SHIFTS_RULE_SET" ParameterValue="Rule Set NB
3" />
</ProcedureParameters>
</ProcedureSetItem>
</ProcedureSetItems

Chapter 2
Introduced in v6.0
ProcedureSetName
Procedure set name
The name of the ProcedureSet.
Type: String
Required Key
Introduced in v6.0

Chapter 2
ProcedureSetItem Tag
Procedure Set Item
Makes the link between a Procedure and a ProcedureSet.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ProcedureSetItem
GenerateAudit = Boolean
ProcedureName = String >
[<ProcedureParameters>
<ProcedureParameter>*
</ProcedureParameters>]
</ProcedureSetItem>
GenerateAudit
Generate audit
The audit trail flag. The value of this can be only "True" or "False".
Type: Boolean
Required Key
Introduced in v6.0
ProcedureName
Procedure name
The name of the Procedure associated to this ProcedureSetItem.
Type: String

Chapter 2
Required Key
Introduced in v6.0
ProcedureParameters
Procedure Parameters
The list of procedure parameters, which is composed of a procedure parameter
definition and the value associated.
Type: Zero or more ProcedureParameter tags
Optional
Sample values:
<ProcedureParameters>
<ProcedureParameter ProcedureParameterDefinitionName
= "SORTING_EMPLOYEES_RULE_SET" ParameterValue="Rule
Set NB 4" />
<ProcedureParameter ProcedureParameterDefinitionName
= "SORTING_SHIFTS_RULE_SET" ParameterValue="Rule Set NB
3" />
</ProcedureParameters>
Introduced in v6.0

Chapter 2
Process Tag
Process
The Process tag specifies a process that resulted from a specific process template.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddWithWebForm" |
"DeleteOnly" |
"Retrieve" |
"UpdateOnly"
Parameters→
Add→
ResourceId = String
AddWithWebForm→
ResourceId = String
Properties→
<Process
AdminTemplateId = Integer
ProcessStateCode = Integer
ProcessId = Integer
ProcessName = String
ProcessState = String
[KProcessUniqueKey = String] >
[<ProcessAttributes>
<Attribute>*
</ProcessAttributes>]
</Process>

Chapter 2
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 WTKPersonNumber or PersonId value. The ResourceId must
match the timekeeping 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
Introduced in v5.1

Chapter 2
Action Parameters

ResourceId The ResourceId is a required action Introduced in v5.1
parameter for the Add action. It is the
identifier of the resource or equivalent
to the PersonNumber or PersonId of
the person who will be initiating the
process. 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.
Required
Minimum length: 1 character
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 WTKPersonNumber
or PersonId value. The ResourceId must match the timekeeping 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.

Chapter 2
Optional Properties: ProcessAttributes

Introduced in v5.1
Action Parameters

ResourceId The ResourceId is the required action Introduced in v5.1
paramter for the AddWithWebForm
action. It is the id of the resource or
equivalent to the person's number or
person id who will be initiating the
process. 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.
Required
DeleteOnly
The DeleteOnly method deletes a single process specified by the process id.
The ProcessId must be greater than 0.
Required Properties: ProcessId
Introduced in v5.1
Retrieve
This action returns a specific process.
The ProcessId must be greater than 0.

Chapter 2

Introduced in v5.1
UpdateOnly
This action updates a process by updating the process state and the process
attributes. This action does not add new process attributes, but can update existing
ones. The process state can be updated from an aborted state to active state. The
process state can be updated from a ready state to a passive state. The process
state can be updated from an active state to passive state or to an abort state. The
process state can be updated from an abort state to a passive state. Any process
attribute that has an attribute type of "Object" or "java.lang.Object" cannot be
updated or initialized.
The ProcessId must be greater than 0. The ProcessStateCode can be 1 to update a
process state to active, 3 to update process state to abort state, and 4 to update a
process state to passive or a canceled state.
Optional Properties: ProcessStateCode, ProcessAttributes
Introduced in v5.1
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

Chapter 2
AdminTemplateId is an optional property on the Process Add and

AddWithWebForm actions.
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.
Sample values:
<ProcessAttributes>
<Attribute Name="HRAdministrator" Value="207"> </
Attribute>
</ProcessAttributes>
Introduced in v5.1

Chapter 2
ProcessId
Process identifier
The identifier of the process or the instantiated process template
Type: Integer
Required Key
Must be greater than 0.
Introduced in v5.1
ProcessName
Process name
The name of the process
Type: String
Required
Minimum length: Must be greater than 1 character
Sample values:
EmployeeAward
Introduced in v5.1
ProcessState
Process state
The state of the process
Type: String
Required
ProcessState is a required property on the Process. The ProcessState must not be
null and must be one of the valid process states. The ProcessState is an optional
property on the Process UpdateOnly action.
Sample values:
"Ready","Active","Done","Abort","Passive"

Chapter 2
Introduced in v5.1
ProcessStateCode
Process State Code
The integer value for the process state.
Type: Integer
Required
The ProcessState Code can only be values 0, 1, 2, 3, 4.
Sample values:
0 for Ready process state, 1 for Active process state,
2 for Done process state, 3 for Abort process state, 4
for Passive process state
Introduced in v5.1

Chapter 2
ProcessorToEmployee Tag
Assign processor rule to an employee
Assign rules defined by an extension processor, such as the fixed percent
allocation and rest between shift processors, to an employee. This assignment is
effective dated.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"Retrieve" |
"RetrieveAll" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<ProcessorToEmployee
Processor = String >
<Person>
<PersonIdentity>
</Person>

Chapter 2
</ProcessorToEmployee>
Action Descriptions
Add
Adds a new association of an extension processor to an employee, or updates an
existing one.
Optional Properties: EffectiveDate, ExpirationDate, NewProcessor,
NewEffectiveDate
Introduced in v5.2
AddOnly
Adds a new association of an extension processor to an employee.
Introduced in v5.2
Delete
Deletes an association of an extension processor to an employee. If the effective
date is not specified, deletes the association that is in effect at start of time (01/01/
1753).
Introduced in v5.2

Chapter 2
Retrieve
Retrieves a ProcessorToEmployee association. If an effective date is not specified,
retrieves the association in effect at start of time (01/01/1753).
Return Value Type: ProcessorToEmployee tag
Introduced in v5.2
RetrieveAll
Retrieves a list of all of the ProcessorToEmployee associations.
Return Value Type: Zero or more ProcessorToEmployee tags
Introduced in v5.2
RetrieveByPerson
Retrieves the list of ProcessorToEmployee associations for a given employee.
Introduced in v5.2
Retrieve the list of ProcessorToEmployee associations for the given person that
are in effect on the given effective date.
Introduced in v5.2

Chapter 2
RetrieveByProcessor
Retrieves the list of ProcessorToEmployee associations for a given extension
processor.
Must specify a valid Processor name.
Introduced in v5.2
RetrieveForUpdate
Retrieves a ProcessorToEmployee association for update. If the effective date is
not specified, retrieves the association in effect at start of time (01/01/1753).
Return Value Type: ProcessorToEmployee tag
Introduced in v5.2
Update
Updates an existing association of an extension processor to an employee, or add
one if it does not exist.
NewEffectiveDate
Introduced in v5.2
UpdateOnly
Updates an existing association of an extension processor to an employee.

Chapter 2

NewEffectiveDate
Introduced in v5.2
EffectiveDate
Effective date
The effective date of the association of an extension processor and an employee.
Type: Date
Optional
Default value: 01/01/1753 (start of time)
Introduced in v5.2
ExpirationDate
Expiration date
The expiration date of an association of an extension processor and an employee.
Type: Date
Optional
Introduced in v5.2
Person
Person
The PersonIdentity of the employee to be associated with an extension processor.
Required Key

Chapter 2
Introduced in v5.2
Processor
Processor
The name of an extension processor to associate with an employee.
Type: String
Required Key
Must be a valid extension processor name.
Introduced in v5.2

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAllProcessProfiles" |
"LoadById"
Parameters→
None
Properties→
<ProcessProfile
ProcessProfileId = Long
[ProcessProfileName = String] >
</ProcessProfile>
Action Descriptions
Load
Loads the process profile from the database given the ProcessProfileName
property. An example of the ProcessProfileName may be "All Process
Templates".

Chapter 2
The ProcessProfileName must already exist in the database, prior to calling the
Load action.
Return Value Type: (***undefined***): WorkflowProfile
Required Properties: ProcessProfileName
LoadAllProcessProfiles
Loads all process profiles in the database, returning a list of
APIWorkflowProfileBeans.
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.
Required Properties: ProcessProfileId
ProcessProfileId
Process Profile Id
The Id of a specific process profile, which identifies a unique process profile.
Type: Long
Required Key

Chapter 2
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"

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"CoverShift" |
"SwapShifts"
Parameters→
None
Properties→
<ProcessSchedule
[SaveData = Boolean]
[CheckRules = Boolean] >
<Employees>
</Employees>
[<ScheduleItems>
<ScheduleAccrualAmountEdit> | <ScheduleOff> |
<SchedulePayCodeEdit> | <ScheduleShift> | <ScheduleShiftSwap> |
<ScheduleUnavailable>
</ScheduleItems>]
</ProcessSchedule>

Chapter 2
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.
Required Properties: Employees, QueryDateSpan, ScheduleItems
Optional Properties: SaveData, CheckRules
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.
Required Properties: Employees, QueryDateSpan, ScheduleItems
CheckRules
Validate modified schedule?
Indicates whether schedule validation will take place on the modified schedule
from an action

Chapter 2
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.
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.
Required Key
Introduced in v5.0
QueryDateSpan
Span of dates
The span of dates that are used
Type: DateSpan
Required Key
The span must fully encompass the dates of any shift that is specified in
ScheduleItems.
Introduced in v5.0
SaveData
Save the modified schedule?
SaveData indicates whether the schedule, modified by an action, will be saved.
Type: Boolean
Optional
SaveData and CheckRules cannot both be false.

Chapter 2
If SaveData 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: True
Introduced in v5.0
ScheduleItems
Scheduled shifts
The ScheduleItems property contains the shifts that will be processed by actions
in the ProcessSchedule tag. Each one represents a shift that would appear in the
schedule editor or the schedule planner. Each item in this list must be a
ScheduleShiftSwap tag.
Type: Either ScheduleAccrualAmountEdit, ScheduleOff, SchedulePayCodeEdit,
ScheduleShift, ScheduleShiftSwap or ScheduleUnavailable tag
Optional
Introduced in v5.0

Chapter 2
ProcessTask Tag
Process Task
The ProcessTask tag relates a task within a process or workflow. A process task
has state and attribute values that can be retrieved and updated.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveAllByProcessId" |
"RetrieveAllByResourceId" |
"UpdateOnly"
Parameters→
RetrieveAllByResourceId→
[CategoryName = String]
Properties→
<ProcessTask
EndDate = Date
[Locations = String]
[PrevLocations = String]
ProcessId = Integer
[ProcessName = String]
[ResourceId = String]
[ResourceName = String]
StartDate = Date
[TaskURL = String]
TaskId = Integer
TaskName = String
TaskState = String
TaskStateCode = Integer >

Chapter 2
[<TaskAttributes>
<Attribute>*
</TaskAttributes>]
</ProcessTask>
Action Descriptions
Retrieve
The Retrieve action returns the ProcessTask specified by the TaskId.
Required Properties: TaskId
Introduced in v5.0a
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
WTKPersonNumber or PersonId value. The ResourceId must match the
timekeeping 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
Optional Properties: TaskStateCode, ResourceId
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 assigned to

Chapter 2
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 a 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 WTKPersonNumber or PersonId
value. The ResourceId must match the timekeeping 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
Introduced in v5.1
Action Parameters

CategoryName The CategoryName is an optional Introduced in v5.1
action parameter to the
RetrieveByResourceId action.
Optional
If specified for the action, the
CategoryName must not be null and
must be greater than 1 character and
less than or equal to 50 characters in
length.
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.

Chapter 2
Required Properties: TaskId

Optional Properties: TaskStateCode, TaskAttributes
Introduced in v5.1
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

Chapter 2
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.
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 WTKPerson Number or PersonId value. The
ResourceId must match the timekeeping person number, and it is important to
note that trailing blanks are significant and should not be included.
Type: String
Optional
Introduced in v5.1

Chapter 2
ResourceName
Resource or person who owns the task
The name of the resource or person who owns the process task
Type: String
Optional
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.

Chapter 2
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 Key
Must be greater than zero.
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

Chapter 2
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
Introduced in v5.1
TaskURL
Task URL
The url of the web task in a process
Type: String
Optional
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"DeleteOnly" |
"Retrieve" |
"RetrieveAll" |
"RetrieveAllByCategory" |
"RetrieveAllByResourceId" |
"RetrieveAllForEmployee" |
"RetrieveAllForManager" |
"RetrieveByDisplayName" |
"RetrieveByUniqueKey" |
"UpdateOnly"
Parameters→
RetrieveAllByCategory→
[IncludeTemplateData = Boolean]
RetrieveAllByResourceId→
GetHiddenActions = Boolean
ResourceId = String
RetrieveAllForEmployee→

Chapter 2
RetrieveAllForManager→
ResourceId = String
RetrieveByDisplayName→
RetrieveByUniqueKey→
UpdateOnly→
Properties→
<ProcessTemplate
AdminTemplateId = Long
[KProcessUniqueKey = String]
ExpirationDate = DateTime
ActiveSwitch = Integer
ActionListSwitch = Integer
(LastDeployed = DateTime)
[MaxPoolSize = Integer]
[UsedBy = String]
[CategoryNames = String]
DisplayName = String
TemplateData = String
TemplateId = Long
AdminTemplateName = String
Version = Integer >
</ProcessTemplate>
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

Chapter 2

Introduced in v5.1
DeleteOnly
This action deletes a process template specified by the AdminTemplateId.
Required Properties: AdminTemplateId
Introduced in v5.1
Retrieve
This action returns the process template for the specified template identifier.
The AdminTemplateId must be greater than 0.
Introduced in v5.1
RetrieveAll
The RetrieveAll method retrieves a list of all process templates regardless of
which person or resource id they belong to or which category they belong to. This
method retrieves a list of all process templates. By default, the Filter action
parameters is set to "ALL" and the IncludeTemplateData action parameter is set
to "false". If the IncludeTemplateData action parameter is set to "true", the
TemplateData property will be displayed for each process template returned in the
XML Response. If the IncludeTemplateData action parameter is set to "false", the
TemplateData property will not be displayed for each process template returned in
the XML Response. If the IncludeTemplateData action parameter is not specified
at all for this action, by default the IncludeTemplateData action parameter is set to
"false", and the TemplateData property will not be displayed for each returned
process template.
Filter action parameter can only be: "ALL", "ACTIVE", "INACTIVE" and the
IncludeTemplateData action parameter can only be "true" or "false"
Return Value Type: Zero or more ProcessTemplate tags

Chapter 2
Optional Properties: Filter, IncludeTemplateData

Introduced in v5.1
RetrieveAllByCategory
This action returns one or more process templates for the specified category.
This action has an action parameter, IncludeTemplateData. If
IncludeTemplateData action parameter is specified as "true", TemplateData
property is returned for each process template. By default, the
IncludeTemplateData action parameter is set to "false". If the
IncludeTemplateData action parameter is not specified, the IncludeTemplateData
is set to "false", and the TemplateData property will not be displayed for each
ProcessTemplate returned.
Required Properties: CategoryName
Optional Properties: IncludeTemplateData
Introduced in v5.1

Chapter 2
Action Parameters

IncludeTemplateData The IncludeTempateData specifies Introduced in v5.1
whether information that is returned
should include TemplateData. If the
IncludeTemplateData action
parameter is set to "true",
TemplateData is returned for each
process template. If you do not specify
the IncludeTemplateData as action
parameter, the IncludeTemplateData
by default is set to "false", and the
TemplateData property will not be
displayed in each process template
returned.
Optional
IncludeTemplateData is an optional
action parameter on the
RetrieveAllByCategory action. It can
only be set to "true" or "false".
RetrieveAllByResourceId
This method returns a combined list of all the process templates that 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

Chapter 2
IncludeTemplateData action parameter is set to "false". If you do not specify the

IncludeTemplateData action parameter, the value 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
WTKPersonNumber or PersonId value. The ResourceId must match the
timekeeping 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".
Required Properties: ResourceId, GetHiddenActions
Introduced in v5.1

Chapter 2
Action Parameters

GetHiddenActions The GetHiddenActions action Introduced in v5.1
parameter is a required action
parameter on the
RetrieveAllByResourceId action. The
GetHiddenActions action parameter
can either be "true" or "false". If the
GetHiddenActions action parameter is
set to "true", all the process templates
that have the ActionListSwitch set to 0
will be returned along with those
who's value is 1. This implies all of
the process templates that are
"Hidden" from the Actions list, will be
returned along those which are visible
on the Actions list.
Required
GetHiddenActions is a required action
parameter on the
RetrieveAllByResourceId action. It
can either be set to "true" or "false".

Chapter 2

process template. If the
parameter is set to "false",
the IncludeTemplateData action
parameter, the default value for
IncludeTemplateData is set to "false".
Therefore, the TemplateData property
will not be displayed for each returned
process template.
Optional
action parameter on
must be set to either "true" or "false".

Chapter 2

parameter on the
represents the id of the resource,
manager or employee who will be
initiating the process. 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.
Required
ResourceId is a required action
parameter on the
RetrieveAllByResourceId action. The
ResourceId must be greater than 1
character and less than or equal to 30
characters in length.
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

Chapter 2
IncludeTemplateData will be set to "false" by default, and the TemplateData

property will not be displayed for each returned process template.
GetHiddenActions, IncludeTemplateData are required parameters.
GetHiddenActions can only be "true" or "false".
Required Properties: GetHiddenActions
Optional Properties: CategoryName, IncludeTemplateData

Chapter 2
Action Parameters

RetrieveAllForEmployee action. It
represents the name of the category
which one or more process template
belongs to.
Optional
CategoryName is an optional action
parameter on the
must be greater than 1 character and
less than or equal to 50 characters in
length.
parameter on the
RetrieveAllForEmployee action. The
Required
parameter on the
can either be set to "true" or "false".

Chapter 2

process template.If the
parameter is set to "false",
TemplateData is not returned for each
the IncludeTemplateData action
parameter, by default the
IncludeTemplateData value is set to
"false". Therefore, the TemplateData
property will not be displayed for each
returned process template.
Optional
IncludeTemplateData is a required
action parameter on
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

Chapter 2
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 WTKPersonNumber or PersonId value. The ResourceId must
match the timekeeping 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".
Required Properties: ResourceId, GetHiddenActions
Optional Properties: CategoryName, IncludeTemplateData
Introduced in v5.1

Chapter 2
Action Parameters

action parameter on
RetrieveAllForManager. It represents
the name of the category which one or
more process template belongs to.
Optional
CategoryName is an optional action
parameter on the
RetrieveAllForManager action. If
specified on the action, it must be
greater than 1 character and less than
or equal to 50 characters in length.
parameter on the
RetrieveAllForManager action. The
Required
parameter on the
RetrieveAllForManager action. It

Chapter 2

process template.
Optional
RetrieveAllForManager action. It can
parameter on the
RetrieveAllForManager action. It
represents the id of the resource or
manager who will be initiating the
process. 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.
Required
ResourceId is a required action
parameter on the
RetrieveAllForManager action. The
ResourceId must be greater than 1
character and less than or equal to 30
characters in length.
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

Chapter 2

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
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
parameter to RetrieveByDisplayName action. It can only be either "true" or
"false" value.
Required Properties: DisplayName
Introduced in v5.1

Chapter 2
Action Parameters

IncludeTemplateData The IncludeTemplateData action Introduced in v5.1
parameter specifies whether
information that is returned should
include TemplateData property. If the
TemplateData property is returned for
each process template. If you do not
specify the IncludeTemplateData as
action parameter, the
IncludeTemplateData by default is set
to "false", and the TemplateData
property will not be displayed in the
returned process template.
Optional
RetrieveByDisplayName action. It
can only be set to "true" or "false".
RetrieveByUniqueKey
This method returns a process template by specifying the KProcessUniqueKey.
The action RetrieveByUniqueKey takes one action parameter called
IncludeTemplateData, which can either be set to "true" or "false". If the
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
IncludeTemplateData is set to "false" and the TemplateData property will not be
displayed for each process template returned.
The KProcessUniqueKey is a required property and must be

Chapter 2
1 character and <= 255 characters in length. The IncludeTemplateData is an

optional action parameter to RetrieveByUniqueKey action. It can only be either
"true" or "false" value.
Required Properties: KProcessUniqueKey
Introduced in v5.1
Action Parameters

displayed in the process template
returned.
Optional
RetrieveByUniqueKey action. It can
UpdateOnly
This method updates a process template. The following ProcessTemplate
properties cannot be updated through this method: the TemplateId,
AdminTemplateId, AdminTemplateName, Version, UsedBy,

Chapter 2
KProcessUniqueKey, and TemplateData properties. All other properties of the

ProcessTemplate can be updated. This method will allow updates to a process
template by assigning a process template to categories. If the CategoryName does
not exist, the process template will not be assigned to that category. The category
name will not be added to the ProcessTemplate categoryNames list. The
UpdateOnly action takes one action parameter called IncludeTemplateData. The
IncludeTemplateData action parameter can only be "true" or "false" value. If the
will be displayed within the process template within the returned XML Response.
If the IncludeTemplateData action parameter is set to "false", the TemplateData
property will not be displayed within the 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
IncludeTemplateData value is set to "false", and the TemplateData property will
not be displayed in the returned process template.
The AdminTemplateId is a required property. The AdminTemplateId must be
greater than 0. The IncludeTemplateData is an optional action parameter. It can
only be "true" or "false" value.
Optional Properties: DisplayName, ActiveSwitch, EffectiveDate, ExpirationDate,
ActionListSwitch, CommentText, MaxPoolSize, CategoryNames,
IncludeTemplateData
Introduced in v5.1

Chapter 2
Action Parameters

displayed in the process template
returned.
Optional
action parameter on the UpdateOnly
action. It must be set to either "true" or
"false".
ActionListSwitch
Is the process visible in the action list?
The ActionListSwitch indicates whether this process is visible in the action list.
Type: Integer
Required
Introduced in v5.1
ActiveSwitch
Is the process active?
The ActiveSwitch indicates whether this process is active.
Type: Integer

Chapter 2
Required
Enumerated value: 0, 1
Introduced in v5.1
AdminTemplateId
Administrator Template Id
The template id used in the Process Manager Process Designer application and in
the Process Administrator, used for administrative purposes. Corresponds to the
DWEWORKFLOWID column in the WPMWORKFLOW table.
Type: Long
Required Key
Sample values:
2101

AdminTemplateName
Template name
The AdminTemplateName is the name used in the Process Manager Process
Designer application and in the Process Administrator, used for administration
purposes.
Type: String
Required
Sample values:
Employee_Award.template
Introduced in v5.1
CategoryNames
Set of categories
A comma separated list of categories that this process template belongs to.

Chapter 2
Type: String
Optional
Maximum length for each CategoryName: 50 characters
Introduced in v5.1
CommentText
Comment text
The CommentText is a comment on a process.
Type: String
Optional
Introduced in v5.1
DisplayName
Template Display Name
The name or the display name of the process template.
Type: String
Required
Sample values:
EmployeeAward
Introduced in v5.1
EffectiveDate
Effective date
The effective date of this process.
Type: DateTime
Required
Must be a valid KDateTime.
Sample values:

Chapter 2
12/01/2004 00:00:00
Introduced in v5.1
ExpirationDate
Expiration date
The expiration date of this process.
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 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
Introduced in v5.1
LastDeployed
Last Deployed Date/Time
A timestamp indicating the date and time at which the template was deployed.
Type: DateTime
Output only

Chapter 2
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".
Introduced in v5.1
TemplateData
Template XML
A based-64 encoded string that represents the process template XML.
Type: String
Required
Introduced in v5.1
TemplateId
Template identifier
The identifier of the process template. Corresponds to the WPMWORKFLOWID
column in the WPMWORKFLOW table.
Type: Long
Required Key
Introduced in v5.1
UsedBy
Process profiles that use the template
A comma-separated list of process profiles that use this process template.
Type: String
Optional

Chapter 2

Introduced in v5.1
Version
Version for optimistic locking
The version number used for optimistic locking.
Type: Integer
Required
Introduced in v5.1

Chapter 2
ProjectingOvertime Tag
Projected overtime
This tag provides a projected overtime calculation for a date span for specified
locations.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load"
Parameters→
None
Properties→
<ProjectingOvertime
[<Locations>
<LocationItem>*
</Locations>]
</ProjectingOvertime>
Action Descriptions
Load
Returns the projecting overtime data.
Return Value Type: ProjectingOvertime tag

Chapter 2

Introduced in v6.0
Locations
Locations for overtime projection
Optional
Sample values:
<Locations>
A/Floor 1"/>
</Locations>

QueryDateSpan
Date span for overtime projection
Type: String
Required
Sample values:
<QueryDateSpan> 04/23/2006 - 04/29/2006</
QueryDateSpan>

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddComment" |
"AddOnly" |
"AddOnlyWithRestrictions" |
"Delete" |
"RemoveWorkRule"
Parameters→
AddOnly→
AddOnlyWithRestrictions→
RemoveWorkRule→
Properties→
<Punch
OrgJobId = String
OrgJobName = String
Date = Date

Chapter 2
[CancelDeductRuleName = String]
[ExceptionResolved = Boolean]
[DaylightSavingsFlag = Boolean]
Time = Time
[KronosTimeZone = String]
[OverrideTypeName = String]
[<Notes>
<Note>*
</Notes>]
(<Comments>
<Comment>*
</Comments>)
<Employee>
</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:
• LaborAccountName
• WorkRuleName
• OverrideTypeName
• KronosTimeZone
Required Properties: CommentText, Date, Employee, Time
Introduced in v4

Chapter 2
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
Optional Properties: Date, Time
Introduced in v4

Chapter 2
Action Parameters

Optional
Optional used
of the tag.
Optional
AddOnlyWithRestrictions
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. If no date/time specified, punch restriction rule
will apply
Optional Properties: Date, Time

Chapter 2
Action Parameters

AccrualOverride If the action results in an accrual Introduced in v6.0; last changed
warning, the warning is overridden in v6.0
Optional
EchoData If True, the Response includes a copy Introduced in v6.0; last changed
of the tag. in v6.0
Optional
Delete
Marks an existing punch for deletion.
Required Properties: Date, Employee, Time
Introduced in v4
RemoveWorkRule
Removes the work rule transfer from an existing punch.
Required Properties: Date, Employee, Time
Introduced in v4

Chapter 2
Action Parameters

of this tag.
Optional
OrgJobId
A unique identifier for a job in the organization.
Type: String
Default value: Null
Introduced in v5.0
OrgJobName
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 server that connects to an
Oracle database.
Type: String
exist in the organizational structure
Default value: Null
Introduced in v5.0

Chapter 2
CancelDeductRuleName
Deduct rule for cancellation 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
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
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

Chapter 2
• 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
Type: Date
Optional Key
Dependency: If Date is specified, Time must also be specified.
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
Introduced in v4
Employee
Employee
One employee for whom the punch is credited, as specified in a PersonIdentity or
CurrentUser tag.
Required, Key
EnteredOnDate
Date of the edit
The server date on which the edit is added to the database.
Type: Date
Output Only

Chapter 2
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
ExceptionResolved
ExceptionResolved
Tells whether the corresponding exception has been marked or resolved by the
user.
Type: Boolean
Optional
None
Sample values:
False

Introduced in v6.1
KronosTimeZone
Time zone
The time zone used for the punch. Specify either the name of the time zone or the
five-digit KronosTimeZone.
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

Chapter 2
Programmer's Guide.
Sample values:
13411, Eastern
Default value: Time zone at the employees server

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
Timekeeping 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 Timekeeping 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
Introduced in v4
ManagerName
Manager name
The name to replace the user name in audit.

Chapter 2
Type: String
Optional
Introduced in v5.0a
Notes
Comment Notes
Optional
Introduced in v6.0
OverrideTypeName
Type of override
The type of override.
Type: String
Optional
Enumerated value: 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
Type: Time
Optional Key

Chapter 2
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.
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.
• &ALL_WORK_RULES
• &EMPTY
Type: String
Optional
You can find values in Timekeeping Setup.
Sample values:
Salaried, Part Time
Introduced in v4

OrgJob
Organization Job ID or Name: If ID is supplied, Name is ignored.
Optional

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"CheckStatus"
Parameters→
None
Properties→
<PunchStatus
[Time = DateTime]
[DaylightSavingsFlag = Boolean]
[KronosTimeZone = Integer] >
<Employee>
<PersonIdentity>
</Employee>
(<LaborAccountName>
<LaborAccount>
</LaborAccountName>)
</PunchStatus>
Action Descriptions
CheckStatus
Returns the status (In or Out) of the punch.

Chapter 2
Return Value Type: PunchStatus tag

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
Introduced in v5.0
Employee
Employee
One employee, as specified in a PersonIdentity tag.
Required
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

Chapter 2
Programmer's Guide.
Sample values:
13411
Default value: The application server timezone

LaborAccountName
Labor account
If the punch status is in, returns the current labor account transfer
Type: LaborAccount tag
Output only
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
Sample values:
06/17/2003 10:00AM
Default value: Current time


Chapter 2
RBSRule Tag
Rest Between Shifts Rule
Rest Between Shifts
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"RetrieveAll" |
"RetrieveByName" |
"Update"
Parameters→
None
Properties→
<RBSRule
Name = String >
[<RBSRuleVersions>
<RBSRuleVersion>*
</RBSRuleVersions>]
</RBSRule>
Action Descriptions
Delete
Delete the named RBS Rule

Chapter 2
Rule cannot be deleted if linked to a work rule.

Introduced in v5.2
Retrieve
Returns the RBS Rule with the given name.
Return Value Type: RBSRule tag
Introduced in v5.2
RetrieveAll
Retrieve all RBS rules.
Return Value Type: Zero or more RBSRule tags
Introduced in v5.2
RetrieveAllNames
Returns the names of all RBS Rules defined in the system.
Introduced in v5.2
RetrieveByName
Retrieve named RBS rule.
Introduced in v5.2

Chapter 2
RetrieveForUpdate
Retrieve RBSRule For Update.
Name length should be between 1 to 30.
Introduced in v5.2
Update
Updates the RBS Rule with the given name. If the rule does not exist, then it will
be created.
Optional Properties: RBSRuleVersions
Introduced in v5.2
Name
Rule Name
The name of the RBS Rule
Type: String
Required Key
Rule name has to comply with the general rules for the WFC rule names. The rule
name has to be at least one character long.
Introduced in v5.2
RBSRuleVersions
RBS Rule Data Versions in the RBS Rule
The data versions of the RBS Rule
Type: Zero or more RBSRuleVersion tags

Chapter 2
Optional
Introduced in v5.2

Chapter 2
RBSRuleVersion Tag
RBS Rule Data Version
The Data Version of the RBS Rule
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<RBSRuleVersion
ApplyPremiumToEntireShift = Boolean
IsRestIntervalContinuous = Boolean
[MaxRestPremiumDuration = TimeDuration]
[MinRestPremiumDuration = TimeDuration]
[MinShiftLengthDuration = TimeDuration]
RuleName = String
RequiredRestDuration = TimeDuration
LookbackDuration = TimeDuration
OutPunchOption = Integer
InPunchOption = Integer
UnscheduledShiftIsRest = Boolean >
</RBSRuleVersion>
ApplyPremiumToEntireShift
Apply Premium To Entire Shift
A flag specifying whether to apply RBS premium to the entire shift. If set to false
- the premium is applied to the amount of denied rest. If the duration of denied rest
is greater than the duration of a shift, the premium is applied to the duration of a

Chapter 2
shift. If this flag is set to true, RBS premium is applied to the whole duration of a
shift.
Type: Boolean
Required
Introduced in v5.2
Description
RBS Rule Data Version Description
The description of the RBS Rule Data Version
Type: String
Optional
Introduced in v5.2
InPunchOption
Shift Start
The option specifying whether to consider a shift's start at Rounded Punch,
Actual Punch or Scheduled Punch time stamp.The allowable values are 0 - for
Rounded Punch, 1 - for Actual Punch, 2 - for Scheduled Punch
Type: Integer
Required
Introduced in v5.2
IsRestIntervalContinuous
Continuous Rest Interval
This flag specifies if the rest between shifts is required to be continuous in order
foe the employee to qualify for the Rest Between Shifts premium. If it is set to
true, the rest is required to be continuous, if it is set to false, the rest is not required
to be continuous, all rest intervals within a lookback window will be considered.
Type: Boolean
Required
Introduced in v5.2

Chapter 2
LookbackDuration
Rest Interval Window
The duration of the lookback window from the start of a shift in which the rest
intervals are counted to determine whether the shift qualifies for the Rest Between
Shift premium.
Type: TimeDuration
Required
Default value: 0:00
Introduced in v5.2
MaxRestPremiumDuration
Maximum Rest Premium
The maximum duration of the Rest Between Shifts premium
Type: TimeDuration
Optional
Introduced in v5.2
MinRestPremiumDuration
Minimum Rest Premium
The duration of the Minimum RBS Rest Premium
Type: TimeDuration
Optional
Introduced in v5.2
MinShiftLengthDuration
Minimum Shift Length
The minimum duration of a shift to qualify for the Rest Between Shifts premium
Type: TimeDuration
Optional
Introduced in v5.2

Chapter 2
OutPunchOption
Shift End
The option specifying whether to consider shift's end at Rounded Punch, Actual
Punch or Scheduled Punch time stamp.The allowable values are 0 - for Rounded
Punch, 1 - for Actual Punch, 2 - for Scheduled Punch
Type: Integer
Required
Introduced in v5.2
RequiredRestDuration
Required Rest
The duration of the required rest between shifts
Type: TimeDuration
Required
Should be less than the duration of the LookbackDuration
Introduced in v5.2
RuleName
RBS Rule Name
The name of the RBS Rule, that this data belongs to
Type: String
Required
See validation for the RBSRule Name
Introduced in v5.2
UnscheduledShiftIsRest
Unscheduled Shifts Count As Rest
A flag specifying whether unscheduled shifts count as rest or as work. If true -
unscheduled shifts count as rest, if false - unscheduled shifts count as work
Type: Boolean
Required

Chapter 2
Introduced in v5.2

Chapter 2
ReportDataProfileAssignment Tag
India Reports Profile Assignment
Sets the effective dates for an India Statutory Reports profile of an employee.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ReportDataProfileAssignment
EndDate = Date
ProfileName = String >
</ReportDataProfileAssignment>
EffectiveDate
Effective date
Specifies the date on which the profile takes effect.
Type: Date
Required
Must be a valid date
Sample values:
1/31/2007
Introduced in v6.1

Chapter 2
EndDate
End date
Specifies the last date that the profile is in effect. If the value is empty, the end
date is set to 'forever.'
Type: Date
Required
Must be a date. The end date must be after the effective date.
Sample values:
12/31/2007
Introduced in v6.1
ProfileName
Profile name
Specifies the India Statutory Report profile for a time period. If it is empty, no
profile is assigned for that period.
Type: String
Required
Specified profile must be Active.
Sample values:
North Factory Profile
Introduced in v6.1

Chapter 2
ReportDataProfileAssignmentList Tag
Report data profile assignment list
employee.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ReportDataProfileAssignmentList
[<ReportDataProfileAssignment>
<ReportDataProfileAssignment>*
</ReportDataProfileAssignment>]
</ReportDataProfileAssignmentList>
ReportDataProfileAssignment
Report Data Profile Assignment
employee.
Type: Zero or more ReportDataProfileAssignment tags
Optional
Sample values:
<ReportDataProfileAssignment ProfileName="North
Factory" EffectiveDate="1/30/2007" EndDate="6/30/
2007"/>
<ReportDataProfileAssignment ProfileName="South
Factory" EffectiveDate="9/1/2007" EndDate=""/>

Chapter 2
Introduced in v6.1

Chapter 2
ReportProfile Tag
Report Profile
The ReportProfile tag shows the report profile assigned to a manager. A Report
Profile defines which reports the Manager can view or run.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAllReportProfiles" |
"LoadById"
Parameters→
None
Properties→
<ReportProfile
[ReportProfileId = Integer]
[ReportProfileName = String] >
</ReportProfile>
Action Descriptions
Load
Returns a report profile, based on ReportProfileName.
Return Value Type: ReportProfile tag
Required Properties: ReportProfileName

Chapter 2

Introduced in v4
LoadAllReportProfiles
Returns a list of all report profiles in the system.
Return Value Type: Zero or more ReportProfile tags
Introduced in v4
LoadById
Returns a report profile, based on ReportProfileId.
ID must be valid
Return Value Type: ReportProfile tag
Required Properties: ReportProfileId
Introduced in v4
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

Chapter 2
Optional
Introduced in v4

Chapter 2
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 timekeeping. These tags are in add-on products such as Activities or
Scheduling.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<Request
Action = String
[OnError = String]
[DataSource = String]
[Password = Password]
[ProcessAsManager = Boolean]
[Sequence = String]
[Object = String]
[FailureURL = String]
[SuccessURL = String]
</Request>

Chapter 2
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
Required: When specifying System for Logon, Logoff, or Ping
Required: When the contained object is omitted
Introduced in v4

Chapter 2
OnError
Action to take after error (continue or stop)
Indicates whether to continue or stop after an error is encountered
Type: String
Optional
Enumerated value: Continue, Stop
Introduced in v4
Password
Password
Logon password
Type: Password
Optional
Required: For logon Action
ProcessAsManager
Process requests using Manager role
Specifies whether to process the XML APIs within the request using the
Manager's role:
• True - process using Manager's role
• False - process using Employee role.
Type: Boolean
Optional
Sample values:
true


Chapter 2
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

Chapter 2
RequestFor Tag
Request For
The user view of a "subtype"
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<RequestFor
(Name = String)
(RequestType = String)
(Symbol = String) >
</RequestFor>
Description
Description
The description of subtype name
Type: String
Output only
Name
Name
The name of the subtype
Type: String

Chapter 2
Output only
RequestType
Request Type
The request type
Type: String
Output only
Symbol
Symbol
The symbol of a request for (subtype)
Type: String
Output only
Introduced in v6.1

Chapter 2
RequestId Tag
Request Id
An xml tag that represents a Request Id
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<RequestId
Id = String >
</RequestId>
Id
Id
The request id
Type: String
Required Key
Sample values:
REQ_999
Introduced in v6.1

Chapter 2
RequestItems Tag
Request Items
A various list of request items
For the RequestMgmt API, the request items could be TimeOffRequestItem,

TimeOffHourRequestItem, OpenShiftRequestItem
For the EmployeeRequestMgmt API, the request items could be

EmployeeTimeOffRequestItem, EmployeeTimeOffHourRequestItem,
EmployeeOpenShiftRequestItem
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<RequestItems
[<EmployeeOpenShiftRequestItem>
<EmployeeOpenShiftRequestItem>*
</EmployeeOpenShiftRequestItem>]
[<EmployeeTimeOffHoursRequestItem>
<EmployeeTimeOffHoursRequestItem>*
</EmployeeTimeOffHoursRequestItem>]
[<EmployeeTimeOffRequestItem>
<EmployeeTimeOffRequestItem>*
</EmployeeTimeOffRequestItem>]
[<OpenShiftRequestItem>
<OpenShiftRequestItem>*
</OpenShiftRequestItem>]
[<TimeOffHoursRequestItem>
<TimeOffHoursRequestItem>*

Chapter 2
</TimeOffHoursRequestItem>]
[<TimeOffRequestItem>
<TimeOffRequestItem>*
</TimeOffRequestItem>]
</RequestItems>
EmployeeOpenShiftRequestItem
Employee Open Shift Request Item
An Employee Open shift requet item
Type: Zero or more EmployeeOpenShiftRequestItem tags
Optional
EmployeeTimeOffHoursRequestItem
Employee Time Off Hours Request Item
An Employee Time Off Hours Request Item
Type: Zero or more EmployeeTimeOffHoursRequestItem tags
Optional
EmployeeTimeOffRequestItem
Employee Time Off Request Item
An employee time off request item
Type: Zero or more EmployeeTimeOffRequestItem tags
Optional
OpenShiftRequestItem
Open Shift Request Item
An open shift request item
Type: Zero or more OpenShiftRequestItem tags
Optional

Chapter 2

TimeOffHoursRequestItem
Time Off Hours Request Item
A time off hour request item
Type: Zero or more TimeOffHoursRequestItem tags
Optional
TimeOffRequestItem
Time Off Request Item
A time off request item
Type: Zero or more TimeOffRequestItem tags
Optional

Chapter 2
RequestMgmt Tag
Request management
Various operations that a manager could do to manage it's employees requests
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"ApproveRequests" |
"Delete" |
"PendingRequests" |
"RefuseRequests" |
"RetractRequests" |
"Retrieve" |
"RetrieveWithDetails" |
"SubmitRequests" |
"Update" |
"UpdateStatus"
Parameters→
Retrieve→
[TypeName = String]
RetrieveWithDetails→
[TypeName = String]
Properties→
<RequestMgmt

Chapter 2
[TypeName = String] >
<Employees>
<PersonIdentity>*
</Employees>
[<RequestIds>
<RequestId>*
</RequestIds>]
[<RequestItems>
<RequestItems>
</RequestItems>]
[<RequestStatusChanges>
</RequestStatusChanges>]
</RequestMgmt>
Action Descriptions
Add
Add a request
Return Value Type: (***undefined***): RequestItem
Required Properties: QueryDateSpan, Employees, RequestItems
ApproveRequests
Approve a request
Required Properties: QueryDateSpan, Employees, RequestIds
Delete
Delete a request

Chapter 2

PendingRequests
Change the request status to "pending"
RefuseRequests
Refuse a request
RetractRequests
Retract a request
Retrieve
Retrieve a request
Required Properties: QueryDateSpan, Employees
Introduced in v6.1

Chapter 2
Action Parameters

RequestFor The request for (subtype name) Introduced in v6.1
Optional
StatusName The status of a request Introduced in v6.1
Optional
TypeName The type of a request Introduced in v6.1
Optional
RetrieveWithDetails
Retrieve requests with details (the list of status changes)
Introduced in v6.1
Action Parameters

RequestFor The request for (subtype name) Introduced in v6.1
Optional
StatusName The status of a request Introduced in v6.1
Optional
TypeName The request type Introduced in v6.1
Optional
SubmitRequests
Submit a request

Chapter 2

Update
Update a request items
Required Properties: QueryDateSpan, Employees, RequestItems
Introduced in v6.1
UpdateStatus
Update the status of a request
Required Properties: QueryDateSpan, Employees, RequestStatusChanges
Employees
Employees
The global list of employees (i.e. list that includes every employees of
RequestItems tags)
Required
Introduced in v6.1
QueryDateSpan
Query Date Span
The global date span including every request items date span of the request
Type: DateSpan
Required

Chapter 2
RequestFor
Request For
The request for (or subtype) of a request (optional parameter for Retrieve and
RetrieveWithDetails)
Type: String
Optional
Introduced in v6.1
RequestIds
Request Ids
A list of request id
Type: Zero or more RequestId tags
Optional
Introduced in v6.1
RequestItems
Request Items
A list of mixed request items object
Type: RequestItems tag
Optional
Introduced in v6.1
The status changes of one or more requests
Optional
StatusName
Status Name
The status of a request (optional parameter for Retrieve and RetrieveWithDetails)
Type: String

Chapter 2
Optional
Sample values:
DRAFT, SUBMITTED
Introduced in v6.1
TypeName
Type Name
The type of a request (optional parameter for Retrieve and RetrieveWithDetails)
Type: String
Optional
Sample values:
TIME_OFF, TIME_OFF_REQUEST
Introduced in v6.1

Chapter 2
RequestOvertimeApproval Tag
Request Overtime Approval
The RequestOvertimeApproval tag lets an individaul request over time approval
for an employee on one specified day
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RequestOverTime"
Parameters→
None
Properties→
<RequestOvertimeApproval
AmountInTime = String
Date = Date
[Reason = String]
[StartTime = Time] >
<Employee>
</Employee>
</RequestOvertimeApproval>
Action Descriptions
RequestOverTime
Request overTime for Approval

Chapter 2
Required Properties: Employee, Date, AmountInTime

AmountInTime
Amount of time
This property is overtime amount to be approved
Type: String
Required
It cannot be negative
Date
Date
The date to work overtime
Type: Date
Required
Employee
Employee
Required
Introduced in v6.1
Reason
Reason
The reason to request work overtime

Chapter 2
Type: String
Optional
Introduced in v6.1
StartTime
Start Time
Specify when to start work overtime
Type: Time
Optional

Chapter 2
RequestOvertimeStatus Tag
RequestOvertimeStatus
The RequestOvertimeStatus tag query for a particular overtime request's status of
a giving approver
The query employee and approver must be a valid one.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"HasRequestOn" |
"Load"
Parameters→
None
Properties→
<RequestOvertimeStatus
Date = Date
(isApproved = Boolean)
(isDenied = Boolean)
Approver = String
(HasRequestOn = Boolean) >
<Employee>
<Personality>
</Employee>
</RequestOvertimeStatus>
Action Descriptions

Chapter 2
HasRequestOn
check there is an overtime request on a date for an employee
Return Value Type: RequestOvertimeStatus tag
Load
load requested overtime approval status
Employeeand Approver both must be uniquely identify an existing and active
employee. Approver must be in the employee's approver list
Return Value Type: RequestOvertimeStatus tag
Required Properties: Employee, Approver, Date
Approver
The Approver
The manager who has the right to approve or deny an overtime request from a
person
Type: String
Required Key
Must be in the employee's assigned approver list
Introduced in v6.1
Date
Date
The date to work overtime
Type: Date
Required

Chapter 2
Introduced in v6.1
Employee
Employee
Required Key
Introduced in v6.1
HasRequestOn
has overtime request on
this property identified the exist of ovetime request on certain date for an
employee
Type: Boolean
Output only
Introduced in v6.1
isApproved
Is Approved
A boolean value true or false indicates whether the specified overtime request has
been approved by specified approver.
Type: Boolean
Output only
Introduced in v6.1
isDenied
IsDenied
A boolean value true or false indicates whether the specified overtime request has
been denied by specified approver.
Type: Boolean
Output only

Chapter 2
Introduced in v6.1

Chapter 2
RequestParamDef Tag
Request Param Definition
Retrieve the parameter definitions
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames"
Parameters→
None
Properties→
<RequestParamDef
(RequestParamDefName = String)
</RequestParamDef>
Action Descriptions
Retrieve
Retrieve a parameter definition by it's name
Return Value Type: RequestParamDef tag
Required Properties: RequestParameterDefName
Introduced in v6.1

Chapter 2
RetrieveAll
Retrieve all parameter definition
Return Value Type: Zero or more RequestParamDef tags
Introduced in v6.1
RetrieveAllNames
Retrieve all paremeter definitions names
Introduced in v6.1
RequestParamDefName
Request Param Def Name
The name of the request parameter definition
Type: String
Output only
ValueTypeName
Value Type Name
The value type of the parameter
Type: String
Output only

Chapter 2
RequestParamValue Tag
Request Parameter Value
Name / value representation of a request type parameter
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<RequestParamValue
Name = String
[Value = String] >
</RequestParamValue>
Name
Name
The name of the parameter
Type: String
Required Key
Value
Value
The value of the parameter
Type: String
Optional

Chapter 2
Introduced in v6.1

Chapter 2
RequestStatusChange Tag
Request Status Change
Represents a request status change
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<RequestStatusChange
(ChangeDateTime = Date)
(FromStatusName = String)
RequestId = String
ToStatusName = String >
[<Comments>
<Comment>*
</Comments>]
(<User>
<PersonIdentity>
</User>)
</RequestStatusChange>
ChangeDateTime
Change Date Time
The date/time of the status change
Type: Date
Output only

Chapter 2
Comments
Comments
The comment associated to a status change
Optional
Introduced in v6.1
FromStatusName
From Status Name
The status name before the change
Type: String
Output only
Introduced in v6.1
RequestId
Request Id
The request id of this status change
Type: String
Required
Introduced in v6.1
ToStatusName
To Status Name
The status name after the change
Type: String
Required
User
User
The user who made the status change
Output only

Chapter 2
Introduced in v6.1

Chapter 2
RequestSubtype Tag
Request Subtype
Defines the request sub type for self scheduling
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"DeleteOnly" |
"Retrieve" |
"RetrieveAll" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<RequestSubtype
Name = String
RequestTypeName = String
[Symbol = String] >
[<RequestParamValues>
<RequestParamValue>*
</RequestParamValues>]
</RequestSubtype>

Chapter 2
Action Descriptions
Add
Add a subtype
Required Properties: Name, RequestTypeName
Introduced in v6.1
AddOnly
Add a subtype
Introduced in v6.1
Delete
Delete a request subtype
Introduced in v6.1
DeleteOnly
Delete a subtype
Introduced in v6.1

Chapter 2
Retrieve
Retrieve a subtype based on it's name
Return Value Type: RequestSubtype tag
Introduced in v6.1
RetrieveAll
Retrieve all sub types based on your GDAP
Return Value Type: Zero or more RequestSubtype tags
Introduced in v6.1
Retrieve all subtypes for update
Return Value Type: Zero or more RequestSubtype tags
Introduced in v6.1
RetrieveAllNames
Retrieve all subtypes name based on your GDAP
Introduced in v6.1
RetrieveForUpdate
Retrieve a subtype for update based on the name parameter
Return Value Type: RequestSubtype tag

Chapter 2
Update
Update a subtype
Introduced in v6.1
UpdateOnly
Update a request sub type
Introduced in v6.1
Description
Description
Description of a request subtype
Type: String
Optional
Introduced in v6.1
Name
Name
The subtype name
Type: String
Required Key
Introduced in v6.1
RequestParamValues
Request Param Values
A list of request type parameter values

Chapter 2
Type: Zero or more RequestParamValue tags

Optional
Introduced in v6.1
RequestTypeName
Request Type Name
Request type name of a request subtype
Type: String
Required
Sample values:
TIME_OFF
TIME_OFF_HOURS

Symbol
Symbol
The symbol character string of a request subtype
Type: String
Optional
Introduced in v6.1

Chapter 2
RequestToCover Tag
Request to cover another shift
This tag will provide all the needed actions to assign a shift to an employee to
cover another shift.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AssignCoverShift" |
"LoadEligibleEmployees" |
"LoadShifts"
Parameters→
None
Properties→
<RequestToCover
[QueryDate = Date]
[PartialEndDate = Date]
[PartialEndTime = Time]
[QueryDateTimeSpan = DateTimeSpan]
[PartialStartDate = Date]
[PartialStartTime = Time] >
(<RequestToCoverItems>
<RequestToCoverItem>*
</RequestToCoverItems>)
(<RequestToCoverStatus>
<CoverShiftStatus>
</RequestToCoverStatus>)

Chapter 2
<Employee>
<Personality>
</Employee>
(<RuleViolations>
<RuleViolation>*
</RuleViolations>)
<Employees>
<PersonIdentity>*
</Employees>
</RequestToCover>
Action Descriptions
AssignCoverShift
AssignCoverShift assigns a shift to an employee to cover another shift.
Required Properties: QueryDateTimeSpan, Employees
Optional Properties:
PartialStartDate,PartialEndDate,PartialStartTime,PartialEndTime,IsSaveData,IsC
heckRules
LoadEligibleEmployees
LoadEligibleEmployees returns eligible employees who can work for the
specified shift.
Return Value Type: RequestToCover tag
Required Properties: QueryDateTimeSpan, Employee
LoadShifts
The LoadShifts action will load all shifts for the specified employee and a query
date.
Return Value Type: RequestToCover tag

Chapter 2
Required Properties: QueryDate,Employee

Employee
Requesting employee
The employee who requests his/her shift to be covered.
Optional Key
Employees
Two employees (requesting and covering)
This property represents 2 employees for whom one's shift is to be covered by the
other one.
Optional Key
The size must be 2.
IsCheckRules
Check rules?
This property indicates whether schedule rule validation should be checked.
Type: Boolean
Optional

Chapter 2
IsSaveData
Save changes?
This property indicates whether the changes made by an action will be persisted to
the database.
Type: Boolean
Optional
IsShiftExists
Does the shift exist?
This property holds the result of whether is the shift existing.
Type: Boolean
Output only
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
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

Chapter 2
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
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
QueryDate
Date to query
The date to query for a specified employee's shifts.
Type: Date
Optional
It must be a valid date.
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.

Chapter 2
RequestToCoverItems
Date and time span
This property contains a shift's date time span information.
Type: Zero or more RequestToCoverItem tags
Output only
RequestToCoverStatus
Request To Cover Status
This property is the status of the result.
Type: CoverShiftStatus tag
Output only
RuleViolations
Rule violations generated
RuleViolations is the set of rule violations that was generated by the tag.
Output only

Chapter 2
RequestToCoverItem Tag
Request To Cover Item
This tag represents the result of execution of the OpenShifts tag.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<RequestToCoverItem
(DateTimeSpan = DateTimeSpan) >
(<OrgJobPaths>
<LocationItem>*
</OrgJobPaths>)
</RequestToCoverItem>
DateTimeSpan
Date and time span
This property represents a date and time span of a valid shift.
Type: DateTimeSpan
Output only
none
OrgJobPaths
Organization job paths
This property represents a set of valid organization jobs.

Chapter 2

Output only
none
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<ResetAccrual
ProbationAmountInCurrency = Currency
ProbationAmountInDays = Double
ProbationAmountInTime = TimeDuration
Date = Date >
<Employee>
</Employee>
</ResetAccrual>

Chapter 2
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
Either AmountInTime or AmountInCurrency must be specified.
Required Properties: AccrualCodeName, Date, Employee
Introduced in v4
AmountInCurrency
The new monetary value for the employee's accrual balance
Type: Currency
Default value: 0.00
Introduced in v4
AmountInDays
Amount of accrual, in days
The amount of time (expressed as a positive or negative number of days) to be
added to the current balance for the specified accrual code and employee.
Type: Double
AmountInDays belongs to the Amount/Currency group. Only one member of the
group can be used.
Introduced in v6.1

Chapter 2
AmountInTime
The new time span value for the employee's accrual balance
Type: TimeDuration
Default value: 0.0 or 0:0
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
AmountInTimeOrCurrency belongs to the AccrualAmount group. Only one
member of the group can be used.
ProbationAmountInCurrency
Probationary amount, in currency
The amount, expressed as a currency, of accrual balances which have been 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,
ProbationaryAmountInTime or ProbationaryAmountInDays, 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
Introduced in v4

Chapter 2
ProbationAmountInDays
Probationary amount, in days
The amount, expressed as a positive or negative number of days, of accrual
balances which have been 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, ProbationaryAmountInTime or
ProbationaryAmountInDays, then the probation amount defaults to zero.
in AmountInDays.
Type: Double
ProbationAmountInDays belongs to the Probation Amount/Currency group. Only
one member of the group can be used.
Introduced in v6.1
ProbationAmountInTime
Probationary amount, in time
The amount, expressed as a time duration, of accrual balances which have been
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,
ProbationaryAmountInTime or ProbationaryAmountInDays, then the probation
amount defaults to zero.
in AmountInTime.
Type: TimeDuration
AccrualCodeName
Accrual code name
The accrual code associated with the transaction.
Type: String
Required

Chapter 2
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
Date
Date
The date when the accrual transaction is effective
Type: Date
Required
Introduced in v4
Employee
Employee
Required Key
Introduced in v4

Amount/Currency
Mutually Exclusive group for AmountInTimeOrCurrency, AmountInTime and
AmountInCurrency
Required
Group includes: AmountInCurrency, AmountInDays, AmountInTime,
Probation Amount/Currency
Mutually Exclusive group for Probation AmountInCurrency and Probation
AmountInTime

Chapter 2
Optional
Group includes: ProbationAmountInCurrency, ProbationAmountInDays,
ProbationAmountInTime

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<Response
(Message = String)
(Sequence = String)
(Status = String)
(TransactionSequence = String) >
</Response>
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

Chapter 2
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
Enumerated value: 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

Chapter 2
RoleProfileKBO Tag
Role Profile API
The tag allows user to view, list, update, create, duplicate and delete role profile.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"Duplicate" |
"Retrieve" |
"RetrieveAll" |
"RetrieveRoleProfiles" |
"Update" |
"UpdateOnly"
Parameters→
Update→
[NewName = String]
UpdateOnly→
[NewName = String]
Properties→
<RoleProfileKBO
[AccessProfileName = String]
[PreferenceProfileName = String]
[Name = String] >
</RoleProfileKBO>

Chapter 2
Action Descriptions
AddOnly
Adds the role profile with the given [Name] to the database.
Required Properties: Name,AccessProfileName,PreferenceProfileName
Delete
Deletes the role profile by name
Duplicate
Creates a duplicate of the existing role profile with the name "copy of [Name]"
Retrieve
Introduced in v5.2

Chapter 2
RetrieveAll
Retrieves all the available RoleProfile objects.
Return Value Type: Zero or more RoleProfileKBO tags
Introduced in v5.2
RetrieveAllNames
Return the collection of names of RoleProfile objects required for Setup Data
Manager.
Introduced in v5.2
RetrieveForUpdate
Returns a single instance of RoleProfileKBO which can be used for Update by
SDM.
Return Value Type: RoleProfileKBO tag
Introduced in v5.2
RetrieveRoleProfiles
Retrieves list of all profiles in the database
Introduced in v5.2
Update
This method will update if the RoleProfile object exists with the given name
otherwise creates a new a object.

Chapter 2

Action Parameters

NewName RoleProfile will be created with the Introduced in v5.2
given NewName if it doesn't exist
already.
Optional
UpdateOnly
Updates the role profile info in the delegaterole table
name should not exceed 50 chars
Optional Properties: Description, AccessProfileName, PreferenceProfileName
Action Parameters

NewName The new name of the RoleProfile that Introduced in v5.2
will be updated as the given New
Name parameter.
Optional
AccessProfileName
Access Profile Name
The function Access Profile Name that will be included as part of the Role Profile.
Type: String

Chapter 2
Optional
Introduced in v5.2
Description
Description
Role Profile Description
Type: String
Optional
Introduced in v5.2
Name
Role Profile Name
Name of the Role Profile that will be retrieved.
Type: String
Optional
Introduced in v5.2
Display Profile Name
The Display Profile Name that will be included as part of the Role Profile.
Type: String
Optional
Introduced in v5.2

Chapter 2
RollupIndicatorElement Tag
Indicator Element
Part of the hierarchical tree of indicator element values returned by a
ScheduleMetrics query.
Indicator element (eg ValueTypeName="HOURS" VerticalTotal="1796:00"
ElementName="QA Req") containing a list of metric values
(ScheduleMetricsItem).
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<RollupIndicatorElement
(ElementName = String)
(ValueTypeName = String)
(VerticalTotal = String) >
(<ScheduleMetricsItems>
<ScheduleMetricsItem>*
</ScheduleMetricsItems>)
</RollupIndicatorElement>
ElementName
Element Name
The name of the indicator element
Type: String
Output only

Chapter 2
Sample values:
ElementName="QA Req"

ScheduleMetricsItems
Metrics Items
The metrics items
Type: Zero or more ScheduleMetricsItem tags
Output only
ValueTypeName
Value Type
The value type of the indicator (eg hours, percentage) to which this value belongs.
Type: String
Output only
Sample values:
ValueTypeName="HOURS"

VerticalTotal
Vertical Total
The total of all the metric items
Type: String
Output only
Sample values:
VerticalTotal="1796:00"

Chapter 2
RollupStrategyTotal Tag
Strategy Total
Part of the hierarchical tree of element values returned by a ScheduleMetrics
query.
The total strategy is containing the list of totals by date.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<RollupStrategyTotal
(ElementName = String)
(ElementPath = String)
(ElementType = String) >
(<RollupIndicatorElements>
<RollupIndicatorElement>*
</RollupIndicatorElements>)
</RollupStrategyTotal>
ElementName
Element Name
Element name
Type: String
Output only

Chapter 2
ElementPath
Element Path
Element path
Type: String
Output only
Introduced in v6.1
ElementType
Element Type
Element type
Type: String
Output only
Introduced in v6.1
RollupIndicatorElements
Indicator Elements
The elements of the indicator
Type: Zero or more RollupIndicatorElement tags
Output only

Chapter 2
RuleSetEmployeeAssign Tag
Rule Sets Assigned to Employees
The RuleSetEmployeeAssign tag assigns one or more rule sets to one or more
employees.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"Update"
Parameters→
None
Properties→
<RuleSetEmployeeAssign
<Employees>
<PersonIdentity>*
</Employees>
<EmployeeRuleSetItems>
<EmployeeRuleSetItem>*
</EmployeeRuleSetItems>
</RuleSetEmployeeAssign>
Action Descriptions
Load
Returns the rule set assignments for an employee

Chapter 2

Introduced in v5.0
Update
Assigns rule sets to one or more employees.
Required Properties: EmployeeRuleSetItems, Employees
EmployeeRuleSetItems
Rules in the rule set
The rule sets that are assigned to the specified employees. The list includes an
optional list of rule sets overriden.
Type: Zero 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.
Required
Each employee specified must have a WFS license.
PersonNumber
Person number
Person number of the person about whom information is returned
Type: String

Chapter 2
Optional
This person must have WFS license.

Chapter 2
RuleVersion Tag
Rule Version
Represents a revision of a total allocation rule.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<RuleVersion
[<Triggers>
<Trigger>*
</Triggers>]
</RuleVersion>
Description
Description
Simple information that describes the rule and revision.
Type: String
Optional
Sample values:
Description="Initial version"
Introduced in v6.1

Chapter 2
EffectiveDate
Effective Date
Type: Date
Required
Must not be null and be a valid date.
Sample values:
Introduced in v6.1
ExpirationDate
Expiration Date
Type: Date
Required
Must not be null and be a valid date.
Sample values:

Triggers
Triggers
Type: Zero or more Trigger tags
Optional
Sample values:
<Triggers>
<Trigger LaborAccountPattern="102////501//702">
<Allocations>

Chapter 2
<Allocation PayCode="Bonus$"
RateAmount="12.00" />
</Allocations>
<PayCodes>
</PayCodes>
</Trigger>
</Triggers>
Introduced in v6.1

Chapter 2
SchedGenSettings Tag
Schedule Generator settings
Used to configure schedule generator engine run options.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"DeleteOnly" |
"Retrieve" |
"RetrieveAll" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<SchedGenSettings
SettingsName = String >
[<OrgPaths>
<SimpleValue>*
</OrgPaths>]
[<SettingsParamValues>
</SettingsParamValues>]

Chapter 2
</SchedGenSettings>
Action Descriptions
Add
Add a schedule generator settings object into the system. If it already exists an
update is performed.
Introduced in v6.0
AddOnly
Add a new schedule generator settings object into the system. If it already exists
an error is thrown.
Introduced in v6.0
Delete
Delete a schedule generator settings object. If the object doesn't exist, no
Introduced in v6.0

Chapter 2
DeleteOnly
Delete a schedule generator settings object with the specified name. If the object
doesn't exist, an error is thrown.
Introduced in v6.0
Retrieve
Return the schedule generator settings object with the specified name.
Return Value Type: SchedGenSettings tag
Introduced in v6.0
RetrieveAll
Return all the schedule generator settings objects.
Return Value Type: Zero or more SchedGenSettings tags
Introduced in v6.0
Return a list of schedule generator settings objects. This action is used for future
updates.
Return Value Type: Zero or more SchedGenSettings tags
Introduced in v6.0
RetrieveAllNames
Return a schedule generator settings names list.

Chapter 2
Introduced in v6.0
RetrieveForUpdate
Return the schedule generator settings object with the specified name. This action
is used for future updates.
Return Value Type: SchedGenSettings tag
Introduced in v6.0
Update
Update the schedule generator settings object. If it does not exist an add is
performed.
Introduced in v6.0
UpdateOnly
Update a schedule generator settings object. If it does not exist an error is thrown.
Introduced in v6.0
Description
Description of Schedule Generator setting
Represents the schedule generation settings object's description.
Type: String

Chapter 2
Optional
Sample values:
<Description> This is a description.</Description>

OrgPaths
Location path
Represents the organizational nodes associated to a schedule generator settings
object.
Optional
Path must be valid on this date. Path must be acessible to logged-on user.
Sample values:
<OrgPaths>
Floor 1" />
</OrgPaths>

SettingsName
Name of Schedule Generator setting
Represents the schedule generation setting's name.
Type: String
Required Key
Sample values:
<SettingsName> ThisIsAName</SettingsName>

SettingsParamValues
Settings objectsparametersvalues'
Represents the schedule generator settings object's parameters values.

Chapter 2

Optional
Parameter names must be SchedGenSettings type parameters.
Sample values:
<SettingsParamValue Name="PARAM" Value="test"/>

Chapter 2
SchedGenSettingsValue Tag
Value of Schedule Generator settings
Retrieves all the schedule generation settings associated with the organization
paths given in the request.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveSettings"
Parameters→
None
Properties→
<SchedGenSettingsValue
(<Settings>
<SchedGenSettings>
</Settings>)
<OrgPaths>
<SimpleValue>*
</OrgPaths>
</SchedGenSettingsValue>
Action Descriptions
RetrieveSettings
Return the list of schedule generator settings objects associated to the orgpaths
specified.
Return Value Type: SchedGenSettingsValue tag

Chapter 2
Required Properties: OrgPaths

Introduced in v6.0
OrgPaths
Organizational location path
List of locations for which setting values should be retrieved. This property is
input only.
Required
Sample values:
<OrgPaths>
<SimpleValue Value="Organization/Hospitals/
Hosp A/Floor 3" />
<SimpleValue Value="Organization/Hospitals/
Hosp A/Floor 2" />
</OrgPaths>

Settings
Associated SchedGenSettings
List of schedGenSettings associated to one of the locations specified in the request
(orgPaths property).
Type: SchedGenSettings tag
Output only
Sample values:
see SchedGenSettings

Chapter 2
SchedRule Tag
Sorting and Matching Rule
Gives access to sorting or matching rules used by the Priority Scheduling Engine
(PSE).
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"DeleteOnly" |
"Retrieve" |
"RetrieveAll" |
"RetrievesAllForUpdate" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<SchedRule
[CustomSortOrderFilter = Boolean]
RuleName = String
SortOrderName = String
TopicName = String >
[<CustomOperators>

Chapter 2
<CustomOperator>*
</CustomOperators>]
[<TopicParameterValues>
<TopicParameterValue>*
</TopicParameterValues>]
</SchedRule>
Action Descriptions
Add
Adds a sorting or matching rule object into the system. If it is already there a rule
with the same name nothing happens.
Required Properties: RuleName, ContextName, TopicName, SortOrderName
Optional Properties: Description, TopicParameterValues, CustomOperators,
CustomSortOrderFilter
AddOnly
Adds a sorting or matching rule object into the system . If it is already there an
error is thrown.
Required Properties: RuleName, ContextName, TopicName, SortOrderName
Optional Properties: Description, TopicParameterValues, CustomOperators,
Delete
Deletes the sorting or matching rule object that has the same name as the one
specified in the RuleName. If it's not there nothing happens.
Required Properties: RuleName

Chapter 2

Introduced in v6.0
DeleteOnly
Deletes the sorting or matching rule object that has the same name as the one
specified in the RuleName. If it's not there an error is thrown.
Introduced in v6.0
Retrieve
Retrieves the sorting or matching rule object by name.
Return Value Type: SchedRule tag
Introduced in v6.0
RetrieveAll
Retrieves all sorting or matching rule objects.
Return Value Type: Zero or more SchedRule tags
Introduced in v6.0
RetrieveAllNames
Retrieves all sorting or matching rule objects names.
Introduced in v6.0
RetrieveForUpdate
Retrieves the sorting or matching rule object specified by name for future updates.
Return Value Type: SchedRule tag

Chapter 2

Introduced in v6.0
RetrievesAllForUpdate
Retrieves all sorting or matching rule objects to be used in future updates.
Return Value Type: Zero or more SchedRule tags
Introduced in v6.0
Update
Updates a sorting or matching rule object into the system. If the rule iis not there,
it is added, else it is updated.
Optional Properties: ContextName, TopicName, SortOrderName, Description,
TopicParameterValues, CustomOperators, CustomSortOrderFilter
UpdateOnly
Updates a sorting or matching rule object into the system. If it is not there an error
is thrown.
Optional Properties: ContextName, TopicName, SortOrderName, Description,
TopicParameterValues, CustomOperators, CustomSortOrderFilter

Chapter 2
ContextName
Rule Context Name
The name of the context.
Type: String
Required
Sample values:
SORTING_SHIFTS
Introduced in v6.0
CustomOperators
Rule Custom Operators
This tag allows the user to assign custom operators to a rule.
Type: Zero or more CustomOperator tags
Optional
Sample values:
<CustomOperators>
<CustomOperator OperatorName="EQUAL_TO"
Value="RN" />
<CustomOperator OperatorName="EQUAL_TO"
Value="RN2" />
</CustomOperators>
Introduced in v6.0
Used to remove items that don't fit a custom sort
Type: Boolean
Optional
Introduced in v6.1

Chapter 2
Description
Rule Description
It's the description of the rule. It must not have more then 255 characters and must
not contain invalid characters also.
Type: String
Optional
Sample values:
Introduced in v6.0
RuleName
Rule Name
The name of the rule.
Type: String
Required Key
Sample values:
<RuleName> test Rule</RuleName>
Introduced in v6.0
SortOrderName
Rule Sort Order Name
The sort order used within this rule.
Type: String
Required
Sample values:
ASCENDING
Introduced in v6.0

Chapter 2
TopicName
Rule Topic Name
The name of the topic of this rule.
Type: String
Required
Sample values:
SHIFT_END_TIME
Introduced in v6.0
TopicParameterValues
Rule Topic Parameter Values
This tag allows the user to assign some TopicParameterValues to one rule.
Type: Zero or more TopicParameterValue tags
Optional
Sample values:
<TopicParameterValues>
<TopicParameterValue
TopicParameterName="PRIMARY_JOB" Value="true" />
TopicParameterName="TRANSFER_SET" Value="true" />
</TopicParameterValues>
Introduced in v6.0

Chapter 2
SchedRuleContext Tag
Sorting and Matching Rule Context
Gives access to sorting or matching rule's context used in Priority Scheduling
Engine . It is a gold data.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames"
Parameters→
None
Properties→
<SchedRuleContext
ContextName = String >
</SchedRuleContext>
Action Descriptions
Retrieve
Retrieves a sorting or mathcing rule's context object by name.
Return Value Type: SchedRuleContext tag
Required Properties: ContextName
Introduced in v6.0

Chapter 2
RetrieveAll
Retrieves all sorting or mathcing rule's context objects from the database.
Return Value Type: Zero or more SchedRuleContext tags
Introduced in v6.0
RetrieveAllNames
Retrieves the names of all sorting or matching rule's context objects.
Introduced in v6.0
ContextName
Context Name
The name of the context to retrieve.
Type: String
Required Key
Introduced in v6.0

Chapter 2
SchedRuleOperator Tag
Sorting and Matching Rule Operator
Gives access to sorting or matching rules's operators used in Priority Scheduleing
Engine. It is a gold data.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames"
Parameters→
None
Properties→
<SchedRuleOperator
OperatorName = String >
</SchedRuleOperator>
Action Descriptions
Retrieve
Retrieves the sorting or matching rule's operator object by name.
Return Value Type: SchedRuleOperator tag
Required Properties: OperatorName
Introduced in v6.0

Chapter 2
RetrieveAll
Retrieves all sorting or matching rule's operator objects.
Return Value Type: Zero or more SchedRuleOperator tags
Introduced in v6.0
RetrieveAllNames
Retrieves all sorting or matching rule's operator objects names.
Introduced in v6.0
OperatorName
Operator Name
Represents the sorting and matching rule operator name.
Type: String
Required Key
Sample values:
EQUAL
Introduced in v6.0

Chapter 2
SchedRuleSet Tag
Sorting and Matching Rule Set
Gives access to sorting or matching rule sets used by the Priority Scheduling
Engine.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"DeleteOnly" |
"Retrieve" |
"RetrieveAll" |
"RetrievesAllForUpdate" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<SchedRuleSet
RuleSetName = String >
[<SchedRules>
<SchedRule>*
</SchedRules>]
</SchedRuleSet>

Chapter 2
Action Descriptions
Add
Adds a sorting or matching rule set object into the system. If already exists
nothing happens.
Required Properties: RuleSetName, ContextName
Introduced in v6.0
AddOnly
Adds a sorting or matching rule set object into the system. If already exists an
error is thrown.
Required Properties: RuleSetName, ContextName
Introduced in v6.0
Delete
Deletes a sorting or matching rule set object from the system. If already exists
nothing happens.
Required Properties: RuleSetName
Introduced in v6.0
DeleteOnly
Deletes a sorting or matching rule set object from the system that has the same
name as the one specified in the RuleSetName. If doesn't exists an error is thrown.

Chapter 2

Required Properties: RuleSetname
Introduced in v6.0
Retrieve
Retrieves a sorting or matching rule set object by name.
Return Value Type: SchedRuleSet tag
Introduced in v6.0
RetrieveAll
Retrieves all sorting or matching rule set objects.
Return Value Type: Zero or more SchedRuleSet tags
Introduced in v6.0
RetrieveAllNames
Retrieves all sorting or matching rule set objects names.
Introduced in v6.0
RetrieveForUpdate
Retrieves sorting or matching rule set object that has the same name as the one
specified in the RuleSetName parameter. This object will be used in future
updates.
Return Value Type: SchedRuleSet tag
Introduced in v6.0

Chapter 2
RetrievesAllForUpdate
Retrieves all sorting and matching rule set objects.
Return Value Type: Zero or more SchedRuleSet tags
Introduced in v6.0
Update
Updates a sorting or matching rule set object into the system. If doesn't exists it
will be updated.
Introduced in v6.0
UpdateOnly
Updates a sorting or matching rule set object into the system. If doesn't exists an
error is thrown.
Introduced in v6.0
ContextName
Rule Set Context Name
The name of the context used in the rule set.
Type: String
Required
Sample values:
<ContextName> SORTING_SHIFTS</ContextName>

Chapter 2
Introduced in v6.0
Description
Rule Set Description
Description of the rule set. Cannot exceed 255 characters and cannot contain
invalid characters.
Type: String
Optional
Sample values:
Introduced in v6.0
RuleSetName
Rule Set Name
The name of the rule set.
Type: String
Required Key
Sample values:
<RuleSetName> Test Rule Set</RuleSetName>
Introduced in v6.0
SchedRules
Sort and Match Rules
Represents the list of sorting and matching rules.
Type: Zero or more SchedRule tags
Optional
Sample values:
<SchedRules>
<SchedRule RuleName=îShift Start Time Ruleî
Description=îThis will sort shifts based on their start
time.î TopicName=îSHIFT_START_TIMEî

Chapter 2
ContextName=îSORTING_SHIFTSî SortOrderName=îASCENDINGî
/>
</ SchedRules >
Introduced in v6.0

Chapter 2
SchedRuleSortOrder Tag
Sorting and Matching Rule Sort Order
Gives access to sorting or matching rule's sort orders used in Priority Scheduling
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames"
Parameters→
None
Properties→
<SchedRuleSortOrder
SortOrderName = String >
</SchedRuleSortOrder>
Action Descriptions
Retrieve
Retrieves the sorting or matching rule's sort order object by the specified name.
Return Value Type: SchedRuleSortOrder tag
Required Properties: SortOrderName
Introduced in v6.0

Chapter 2
RetrieveAll
Retrieves all sorting or matching rule's sort order objects.
Return Value Type: Zero or more SchedRuleSortOrder tags
Introduced in v6.0
RetrieveAllNames
Retrieves all sorting or matching rule's sort order objects names.
Introduced in v6.0
SortOrderName
Sort Order Name
Represents the sorting and matching rules sort order name.
Type: String
Required Key
Sample values:
ASCENDING
Introduced in v6.0

Chapter 2
SchedRuleTopic Tag
Sorting and Matching Rule Topic
Gives access to sorting or matching rule's topics used in Priority Scheduleing
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames"
Parameters→
None
Properties→
<SchedRuleTopic
TopicName = String >
</SchedRuleTopic>
Action Descriptions
Retrieve
Retrieves the sorting or matching rule's topic object by name.
Return Value Type: SchedRuleTopic tag
Required Properties: TopicName
Introduced in v6.0

Chapter 2
RetrieveAll
Retrieves all sorting or matching rule's topic objects.
Return Value Type: Zero or more SchedRuleTopic tags
Introduced in v6.0
RetrieveAllNames
Retrieves all sorting or matching rule's topic objects names.
Introduced in v6.0
TopicName
Topic Name
Represents the sorting and matching rule's topic name.
Type: String
Required Key
Sample values:
EMPLOYEE_HIRE_DATE
Introduced in v6.0

Chapter 2
SchedRuleValueType Tag
Sorting and Matching Rule Value Type
Gives access to sorting or matching rule's value type used in Priority Scheduling
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames"
Parameters→
None
Properties→
<SchedRuleValueType
ValueTypeName = String >
</SchedRuleValueType>
Action Descriptions
Retrieve
Retrieves the sorting or matching rule's value type object by the given name.
Return Value Type: SchedRuleValueType tag
Required Properties: ValueTypeName
Introduced in v6.0

Chapter 2
RetrieveAll
Retrieves all sorting or matching rule's value type objects.
Return Value Type: Zero or more SchedRuleValueType tags
Introduced in v6.0
RetrieveAllNames
Retrieves all sorting or matching rule's value type objects names.
Introduced in v6.0
ValueTypeName
Valiue Type Name
Represents the sorting and matching rules value type name.
Type: String
Required Key
Sample values:
BooleanValueType
Introduced in v6.0

Chapter 2
Schedule Tag
Schedule
The Schedule tag contains information about all schedule activities for one
employee or group.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddScheduleItems" |
"AddShiftRemovingOverlaps" |
"AppendShift" |
"AssignBreaks" |
"AssignOpenShift" |
"CheckRuleViolations" |
"Delete" |
"DeletePatterns" |
"EditScheduleItems" |
"Load" |
"LockDays" |
"LockShifts" |
"RemoveScheduleItems" |
"RemoveSpecifiedScheduleItems" |
"ReplaceShift" |
"TransferEmployees" |
"UnLockDays" |
"UnlockShifts" |
"Update"
Parameters→
None
Properties→

Chapter 2
<Schedule
[EditLevel = String]
[IsForeverPattern = Boolean]
[IsOpenShift = Boolean]
[SaveData = Boolean]
[CheckRules = Boolean]
[ViewPCESymbolicValue = Boolean] >
[<AppendShifts>
<AppendShifts>*
</AppendShifts>]
<Employees>
</Employees>
[<OpenShiftItems>
<ScheduleShiftSwap>*
</OpenShiftItems>]
[<PartialShiftItems>
<ScheduleShiftSwap>*
</PartialShiftItems>]
[<ScheduleItems>
<ScheduleAccrualAmountEdit> | <ScheduleOff> |
<SchedulePayCodeEdit> | <ScheduleShift> | <ScheduleShiftSwap> |
<ScheduleUnavailable>
</ScheduleItems>]
[<Locations>
<LocationItem>*
</Locations>]
[<OrgJobPaths>
<LocationItem>*
</OrgJobPaths>]
[<ScheduleCostSummaries>
<ScheduleCostSummary>*
</ScheduleCostSummaries>]
<ScheduleGroups>
<ScheduleGroup>*
</ScheduleGroups>
[<SchedulePatterns>
<SchedulePattern>*
</SchedulePatterns>]
[<TransferEmployees>
<TransferEmployee>*

Chapter 2
</TransferEmployees>]
</Schedule>
Action Descriptions
AddScheduleItems
Adds the specified items into the schedule for the identified people and time
period
Required Properties: ScheduleItems, QueryDateSpan
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.
Required Properties: QueryDateSpan, Employees, ScheduleItems
Introduced in v5.0
AppendShift
Appends shift for specified employees. At lease one of the optional properties
must be present.
Required Properties: AppendShifts, QueryDateSpan
Optional Properties: Employees, ScheduleGroups

Chapter 2

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
Introduced in v5.0a
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.
Required Properties: QueryDateSpan, Employees, OrgJobPath, OpenShiftItems
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.
Optional Properties: Employees, OrgJobPath, OrgJobPaths

Chapter 2

Delete
Marks all schedule items for deletion from the identified schedule period. At least
one of the optional properties must be present.
DeletePatterns
Marks an existing accrual pattern for deletion from an employee or a group. At
least one of the optional properties must be present.
The existing pattern anchor time must be within the query date span.
EditScheduleItems
Modifies one or more existing schedule items. At least one of the optional
properties must be present.

Chapter 2
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
Optional Properties: Employees, ScheduleGroups, IsOpenShift, OrgJobPath,
ViewPCESymbolicValue
LockDays
Locks the days for specified employees. At least one of the optional properties
must be present.
LockShifts
Lock schedule shifts for the following conditions:
QueryDateSpan and one or more Locations
QueryDateSpan and one or more OrgJobPaths
QueryDateSpan and one or more Employees
QueryDateSpan spanning 1 day, one employee

Chapter 2
Optional fields contain following logic: one of: Locations, OrgJobPaths,

Employees or QueryDateSpan and one employee, and one ScheduleItem
ScheduleItems must identify one Shift and one Employee.
QueryDateSpan must represent a single day.
If Locations, OrgJobPath, or Employees is specified, QueryDateSpan must also be
specified.
Optional Properties: Locations, OrgJobPaths, Employees, ScheduleItems
RemoveScheduleItems
Removes the specified items for the specified identified time period
Introduced in v4
RemoveSpecifiedScheduleItems
Removes the specified items for the specified identified time period
ReplaceShift
Replace shift for specified employees. At least one of the optional properties must
be present. Note: to avoid an override of the <StartDate
value, keep the <StartDayNumber
and <EndDayNumber

Chapter 2
values to 1 when performing a replaceshifts action.

TransferEmployees
Transfers employees to other jobs. At least one of the optional properties must be
present.
Required Properties: TransferEmployees, QueryDateSpan
UnLockDays
UnLockDays for the specified employees. At least one of the optional properties
must be present.
Optional Properties: Employee, ScheduleGroups
UnlockShifts
Locks schedule shifts can be used for the following cases:
QueryDateSpan and one or more Locations
QueryDateSpan and one or more OrgJobPaths

Chapter 2
QueryDateSpan and one or more Employees
QueryDateSpan spanning 1 day, one employee
Optional fields contain following logic: one of: Locations, OrgJobPaths,

Employees or QueryDateSpan and one employee, and one ScheduleItem
If ScheduleItems is specified, there can only be one, and it must be a Shift.
Only one Employee must be specified.
QueryDateSpan must represent a single day.
If Locations, OrgJobPath, or Employees is specified, QueryDateSpan must also be
specified.
Return Value Type: None list
Optional Properties: Locations, OrgJobPaths, Employees, ScheduleItems
Update
Replaces the specified items and patterns from the schedule period
At least one employee or group must be specified.
Introduced in v4

Chapter 2
AppendShifts
Append shifts
AppendShifts
Type: Zero or more AppendShifts tags
Optional
Introduced in v5.1
CheckRules
Indicates 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.
Introduced in v5.0
EditLevel
Edit Level
Determines what model for schedule group operations should be used by the
application.
Type: String
Optional
Default value: As specified by
global.WTKScheduler.ScheduleGroups.api.DefaultEditLevel
Enumerated value: At Employee Level, At Group Level
Introduced in v6.0

Chapter 2
Employees
Employees
One or more employees for whom the schedule is valid, as specified in one or
more PersonIdentity or CurrentUser tags.
Optional Key
IsEmploymentTerm
Is Employment Term
been specified.
Type: Boolean
Optional
none
Sample values:
true

IsForeverPattern
Extend end date indefinitely?
Indicates whether the pattern end date is January 1, 3000
Type: Boolean
Optional
Introduced in v4

Chapter 2
IsOpenShift
Is this an open shift?
Specifies whether the shift is open. If True, the shift is open.
Type: Boolean
Optional
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
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
The fully qualified organizational job
Type: String
Optional
Only used if the IsOpenShift property is "True"

Chapter 2
OrgJobPaths
Organizational jobs
OrgJobPaths specifies a list of OrgJobs. It is similar to multiple OrgJobPath
properties.
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.
Type: Zero or more ScheduleShiftSwap tags
Optional
Only one partial shift can be specified.
Introduced in v5.1
QueryDateSpan
Span of dates for the schedule
The span of dates when the schedule is valid. If you are creating a pattern and
want the pattern to last forever, use IsForeverPattern.
Type: DateSpan
Required, Key
Introduced in v4
SaveData
Save the modified schedule?
SaveData indicates whether the modified schedule will be saved.
Type: Boolean
Optional

Chapter 2
No Save severity rule violations may exist, regardless of the value of

IsCheckRules. If any such rules exist, the Request will fail and the violations will
be listed.
Dependency: Only one of SaveData and CheckRules can be False.
Default value: True
Introduced in v5.0
ScheduleCostSummaries
Schedule cost summaries
One or more ScheduleCostSummary tags.
Type: Zero or more ScheduleCostSummary tags
Optional
Default value: none
Introduced in v5.0a
ScheduleGroups
Schedule groups associated with the schedule
One or more groups for which the schedule is valid.
Type: Zero or more ScheduleGroup tags
Optional Key
ScheduleItems
Items in schedule
A list of all ScheduleShift, SchedulePayCodeEdit, ScheduleUnavailable,
ScheduleOff, ScheduleShiftSwap, and ScheduleAccrualAmountEdit tags that
make up the schedule. These items can all be seen in the user interface.
Each of them contains an IsDeleted property, which specifies whether the item is
active. An inactive item is one that is deleted but remains visible and struck
through in the user interface. Any item that is not visible in the user interface, such
as a deleted ad hoc shift item, is not included.
Type: Either ScheduleAccrualAmountEdit, ScheduleOff, SchedulePayCodeEdit,
ScheduleShift, ScheduleShiftSwap or ScheduleUnavailable tag

Chapter 2
Optional
Introduced in v4
SchedulePatterns
Schedule patterns
A list of patterns that are used to generate the schedule
Type: Zero or more SchedulePattern tags
Optional
Introduced in v4
TransferEmployees
Transfer employees
TransferEmployees
Type: Zero or more TransferEmployee tags
Optional
Introduced in v5.1
ViewPCESymbolicValue
View the pay code edit symbolic value
Use it to indicate if you want to see the symbolic value of the pay code edits (in
the output tags SchedulePayCodeEdit)
Type: Boolean
Optional
Sample values:
ViewPCESymbolicValue="true"

Introduced in v6.1

Chapter 2
ScheduleAccrualAmountEdit Tag
Accrual Amount Edit
The ScheduleAccrualAmountEdit tag represents a modification to the accrued
balance of an employee or group.
Used by: Schedule
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ScheduleAccrualAmountEdit
(IsDeleted = Boolean)
[ScheduleGroupName = String]
Startdate = Date >
[<Employee>
</Employee>]
</ScheduleAccrualAmountEdit>
AmountInCurrency
An accrual amount expressed as a currency
Type: Currency

Chapter 2
Introduced in v4
AmountInTime
An accrual amount, expressed in hours or days
Type: TimeDuration
Introduced in v4
AccrualCodeName
Accrual code name
The accrual code associated with the transaction. The accrual code must be
created in timekeeping and assigned to the employee before you can import data
against it.
Type: String
Required
You can find values in the timekeeping Application.
Sample values:
Vacation, Sick
Introduced in v4
Employee
Employee
One employee who is assigned to the shift, as specified in a PersonIdentity or
CurrentUser tag.
Optional
Introduced in v4

Chapter 2
IsDeleted
Is the item inactive?
Indicates whether the item is active.
• If False, the item is active.
• If True, it is currently inactive.
Type: Boolean
Output only
ScheduleGroupName
Schedule group name
The name of the schedule group to which the person is currently assigned
Type: String
Optional
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

AccrualAmount
AccrualAmount

Chapter 2
Required

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Update"
Parameters→
None
Properties→
<ScheduleAccrualPattern
IsForeverPattern = Boolean
(PeriodLengthInDays = Integer)
[PeriodLength = Integer]
[AnchorDate = Date]
[PeriodCodeName = String] >
<AccrualPatternElements>
<AccrualPatternElement>*
</AccrualPatternElements>
[<Employees>
<PersonIdentity>
</Employees>]
[<ScheduleGroups>

Chapter 2
<ScheduleGroup>*
</ScheduleGroups>]
</ScheduleAccrualPattern>
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.
Required Properties: AccrualCodeName
Introduced in v4
Update
Adds a new pattern or updates an existing one for an employee or a group
Required Properties: AccrualCodeName
Introduced in v4
AmountInCurrency
An accrual amount expressed as a currency
Type: Currency
Introduced in v4
AmountInTime
A pay code amount, expressed in hours or days

Chapter 2
Type: TimeDuration
Introduced in v4
AccrualCodeName
Accrual code name
A named account containing a specific type of accrual balance
Type: String
Required
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.
Type: Zero or more AccrualPatternElement tags
Required
Introduced in v4
AnchorDate
Start date for accrual pattern
Specifies the date on which the pattern is scheduled to start
Type: Date
Optional
Introduced in v4

Chapter 2
Employees
Employees
One or more employees, as specified in a PersonIdentity tag, who are assigned to
the accrual.
Dependency: At least one of Employees or ScheduleGroups is required.
Optional
Introduced in v4
IsForeverPattern
Extend end date indefinitely?
Indicates whether the pattern's end date is January 1, 3000
Type: Boolean
Required
Introduced in v4
PeriodCodeName
Units of time for accrual period
The unit of time used for the PeriodLength
Type: String
Optional
Enumerated value: Daily, Weekly, Monthly, Annually, Pay Period, Schedule
Period
Introduced in v4

Chapter 2
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, this number 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
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 Key
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

Chapter 2

AccrualAmount
AccrualAmount is either in Currency or in Time depending on AccrualCodeName
Required

Chapter 2
ScheduleAuditItems Tag
Schedule Audit Records
This tab contains a collection of record tags for a scheduling audit. For example: a
ScheduleAuditItems could contain numerous ShiftAuditItem,
DayLockAuditItem, and PayCodeAuditItem record tags.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ScheduleAuditItems
(<AccrualAmountAuditItem>
<AccrualAmountAuditItem>*
</AccrualAmountAuditItem>)
(<DayLockAuditItem>
<DayLockAuditItem>*
</DayLockAuditItem>)
(<MarkPostedAuditItem>
<MarkPostedAuditItem>*
</MarkPostedAuditItem>)
(<PayCodeAuditItem>
<PayCodeAuditItem>*
</PayCodeAuditItem>)
(<ShiftAuditItem>
<ShiftAuditItem>*
</ShiftAuditItem>)
(<WorkloadAuditItem>
<WorkloadAuditItem>*
</WorkloadAuditItem>)
</ScheduleAuditItems>

Chapter 2
AccrualAmountAuditItem
AccrualAmountAuditItem
An accrual amount audit item
Type: Zero or more AccrualAmountAuditItem tags
Output only
Introduced in v6.1
DayLockAuditItem
DayLockAuditItem
A day lock audit item
Type: Zero or more DayLockAuditItem tags
Output only
Introduced in v6.1
MarkPostedAuditItem
MarkPostedAuditItem
A mark posted audit item
Type: Zero or more MarkPostedAuditItem tags
Output only
Introduced in v6.1
PayCodeAuditItem
PayCodeAuditItem
A pay code audit item
Type: Zero or more PayCodeAuditItem tags
Output only
Introduced in v6.1
ShiftAuditItem
ShiftAuditItem
A shift audit item
Type: Zero or more ShiftAuditItem tags
Output only

Chapter 2
Introduced in v6.1
WorkloadAuditItem
WorkloadAuditItem
A workload audit item
Type: Zero or more WorkloadAuditItem tags
Output only
Introduced in v6.1

Chapter 2
ScheduleCostPaycode Tag
Schedule Cost Paycode
This tag contains the hours and wages for a single pay code in the schedule
costing table.
Introduced in v5.0a; last changed in v5.2
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ScheduleCostPaycode
(Hours = Time)
(Label = String)
(Wages = Currency) >
</ScheduleCostPaycode>
Hours
Hours to earn wage
The hours worked to earn the wage.
Type: Time
Output only
Sample values:
41.00

Chapter 2
Label
Paycode label
A label for the paycode
Type: String
Output only
none
Sample values:
Summary
Default value: none

Wages
Wage for paycode and job
The wage for this paycode and job.
Type: Currency
Output only
Sample values:
1,500
Default value: none


Chapter 2
ScheduleCostResult Tag
Schedule Cost Result
This tag contains the result tags for all paycodes under the given job or account.
none
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ScheduleCostResult
(Label = String) >
(<Paycodes>
<ScheduleCostPaycode>*
</Paycodes>)
</ScheduleCostResult>
Label
Job or account label
The fully qualified name for the selected job or account label
Type: String
Output only
Sample values:
Organization/Manufacturing/Bright Plant/Light Bulbs/
Line 1/ASSM
Default value: none

Chapter 2

Paycodes
Paycodes for the job or account
One or more ScheduleCostPaycode tags for the job or account
Type: Zero or more ScheduleCostPaycode tags
Output only

Chapter 2
ScheduleCostSummary Tag
Schedule Cost Summary
The ScheduleCostSummary tag contains information about the schedule cost.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ScheduleCostSummary
SummaryType = String
Grouping = String
[Updated = Boolean] >
(<Results>
<ScheduleCostResult>*
</Results>)
</ScheduleCostSummary>
Grouping
Job or account?
Specifies whether the results should be indexed by job or by account.
Type: String
Required
Enumerated value: job, account

Chapter 2
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
SummaryType
Employee or location?
Specifies whether the output should be based on employee or location
Type: String
Required
Default value: none
Enumerated value: employee, location
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

Chapter 2
ScheduleCoverage Tag
Schedule coverage
Used to retrieve information on Schedule Planner data: open shifts, staffing
requirements, coverage details.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveAll" |
"RetrieveDetails" |
"RetrieveOpenShifts" |
"RetrieveSummary"
Parameters→
None
Properties→
<ScheduleCoverage
[<Locations>
<LocationItem>*
</Locations>]
</ScheduleCoverage>
Action Descriptions
RetrieveAll
This will retrieve data that may be either from the cache or the calculation by the
Schedule container for coverage details, staffing requirements and open shifts.
Return Value Type: ScheduleCoverage tag

Chapter 2

Introduced in v6.0
RetrieveDetails
Schedule container for coverage details.
Return Value Type: Zero or more CoverageDetail tags
Introduced in v6.0
RetrieveOpenShifts
Schedule container for open shifts.
Return Value Type: Zero or more OpenShift tags
Introduced in v6.0
RetrieveSummary
Schedule container for staffing requirements summary.
Return Value Type: Zero or more StaffingRequirement tags
Introduced in v6.0

Chapter 2
Locations
Locations with the requirements
Optional
Sample values:
<Locations>
A/Floor 1/ER"/>
</Locations>

QueryDateSpan
Date span of requirements
Type: String
Required
Sample values:
<QueryDateSpan> 12/18/05-12/22/05</QueryDateSpan>

Chapter 2
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, ScheduleAccrualPattern
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddEmployees" |
"Delete" |
"Load" |
"LoadAllGroups" |
"RemoveEmployees" |
"RemoveEmployeesByDateSpan" |
"Update"
Parameters→
None
Properties→
<ScheduleGroup
[AllowsInheritance = Boolean]
[AllowContract = Boolean]
[IsOverrideConflict = Boolean]
[<GroupMemberships>
<GroupMembership>*

Chapter 2
</GroupMemberships>]
</ScheduleGroup>
Action Descriptions
AddEmployees
Adds one or more employees to the existing group for the specified period of time
Required Properties: ScheduleGroupName, Group Memberships
Introduced in v4
Delete
Marks a specified group for deletion
Required Properties: ScheduleGroupName
Introduced in v4
Load
Returns an employee assignment for the specified group for the date span
Return Value Type: ScheduleGroup tag
Required Properties: ScheduleGroupName, QueryDateSpan
Introduced in v4
LoadAllGroups
Returns all groups in the system
Return Value Type: Zero or more ScheduleGroup tags
Introduced in v4

Chapter 2
RemoveEmployees
Removes one or more employees from the schedule group for the specified period
of time
Required Properties: ScheduleGroupName, GroupMemberships
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.
Required Properties: GroupMemberships
Introduced in v4
Update
Modifies the employee list for the specified group and date span
Required Properties: ScheduleGroupName, QueryDateSpan
Introduced in v4
AllowContract
Is the group schedule a schedule contract?
Determine if a group schedule is being used as a schedule Contract
Type: Boolean
Optional

Chapter 2

AllowsInheritance
Does this group allows inheritance?
This flag determines if employees in a Group can inherit shifts from the group
schedule
Type: Boolean
Optional
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
IsEmploymentTerm
Is Employment Term
been specified.
Type: Boolean
Optional
None
Sample values:
false

Enumerated value: Is Emplyment Term

Chapter 2

IsOverrideConflict
Override schedule conflicts?
Indicates whether to override conflicts when adding group members
Type: Boolean
Optional
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

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"Load" |
"LoadAllScheduleGroupProfiles" |
"LoadById"
Parameters→
None
Properties→
<ScheduleGroupProfile
[ScheduleGroupId = Integer]
</ScheduleGroupProfile>
Action Descriptions
Load
Returns a schedule group.

Chapter 2

Introduced in v4
Load
Returns a schedule group, based on ScheduleGroupName.
Return Value Type: ScheduleGroupProfile tag
Required Properties: ScheduleGroupName
LoadAllScheduleGroupProfiles
Returns all schedule group profiles in the system.
Return Value Type: Zero or more ScheduleGroup tags
Introduced in v4
LoadById
Returns a schedule group, based on ScheduleGroupId.
ID must be valid
Required Properties: ScheduleGroupId

Chapter 2
IsEmploymentTerm
Is Employment Term
When tag is present and value is TRUE, the API will handle EmploymentTerms
only. When tag is absent or set to FALSE, the API will handle Schedule Groups
only.
Type: Boolean
Optional
None
Sample values:
False

Introduced in v6.1
ScheduleGroupId
Identifier of schedule group
Uniquely identifies the schedule group in the database
Type: Integer
Optional
ScheduleGroupName
Schedule group name
Type: String
Optional
Introduced in v4

Chapter 2
ScheduleHours Tag
Schedule Hours
The ScheduleHours tag provides information about a schedule shift for a person,
and allows it to be overridden.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"CancelTimeOff"
Parameters→
None
Properties→
<ScheduleHours
[AmountInTime = TimeDuration]
[IsAllDays = Boolean]
[IsCreateOpenShift = Boolean]
[IsOverride = Boolean]
PaycodeName = String
[UnavailableDuration = TimeDuration]
[DisplayTime = Time]
[UnavailableStartTime = Time]
[validateShifts = Boolean] >
<Employee>
<PersonIdentity>
</Employee>
</ScheduleHours>

Chapter 2
Action Descriptions
AddOnly
This action either overrides existing scheduled hours with a pay code edit, or adds
the pay code edit to the schedule.
Required Properties: Employee, QueryDateSpan, PaycodeName
Optional Properties: AmountInTime, DisplayTime,
IsAllDays,UnavailableDuration, IsCreateOpenShift, IsOverride, IsSaveData,
IsCheckRules
Introduced in v5.0
CancelTimeOff
This action removes the specified pay code edit.
Return Value Type: Zero or more ScheduleHoursStatus tags
Required Properties: Employee, QueryDateSpan, PaycodeName
AmountInTime
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.

Chapter 2
Dependency: If AmountInTime is used, the pay code must be associated with

time, rather than currency.
Introduced in v5.0
DisplayTime
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
Required Key
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.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.

Chapter 2

IsCheckRules
Indicates 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.
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

Chapter 2
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
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 Key
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

Chapter 2
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
validateShifts
Validate shifts
This property is a flag that specifies whether to validate that all requested dates
have shifts already assigned. If this property is set to false, no validation is done.
Type: Boolean
Optional

Chapter 2
ScheduleHoursAccrualViolation Tag
Accrual Violations Message
This tag contains a message about an accrual violation.
Used by: ScheduleHoursStatus
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ScheduleHoursAccrualViolation
(ViolationMessage = String) >
</ScheduleHoursAccrualViolation>
ViolationMessage
Violation message
The violation message
Type: String
Output only
Cannot be null.

Chapter 2
ScheduleHoursDailyStatus Tag
Daily Status for Schedule Hours
The ScheduleHoursDailyStatus tag returns daily information about schedule
hours.
Introduced in v5.1Beta; last changed in v5.1Beta
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ScheduleHoursDailyStatus
(Date = Date)
(ScheduledShiftExist = Boolean)
(IsPayCodeEditCreated = Boolean) >
</ScheduleHoursDailyStatus>
Date
Date for requested data
The date for which schedule information has been requested
Type: Date
Output only
IsPayCodeEditCreated
Was pay code edit created?
This property returns true if a pay code edited was created; false if one has not.

Chapter 2
Type: Boolean
Output only
ScheduledShiftExist
Does scheduled shift exist?
This property returns true if the specified shift exists; false if it does not.
Type: Boolean
Output only

Chapter 2
ScheduleHoursException Tag
Exception Message for Schedule Hours
This tag contains an exception message.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ScheduleHoursException
(ViolationMessage = String) >
</ScheduleHoursException>
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.

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ScheduleHoursStatus
(Date = Date) >
(<AccrualViolation>
<ScheduleHoursAccrualViolation>
</AccrualViolation>)
(<RuleViolations>
<RuleViolation>*
</RuleViolations>)
(<DailyStatus>
<ScheduleHoursDailyStatus>*
</DailyStatus>)
(<Exception>
<ScheduleHoursException>
</Exception>)
</ScheduleHoursStatus>

Chapter 2
AccrualViolation
Accrual violation
An accrual violation as shown in the ScheduleHoursAccrualViolation tag
Type: ScheduleHoursAccrualViolation tag
Output only
DailyStatus
Status for daily schedule hours
One or more schedule hours daily status records, as shown in the
ScheduleHoursDailyStatus tag.
Type: Zero or more ScheduleHoursDailyStatus tags
Output only
Date
Date
The date for which information is requested
Type: Date
Output only
Exception
Violation for schedule hours
The schedule hours violation message as shown by the ScheduleHoursException
tag
Type: ScheduleHoursException tag
Output only

Chapter 2
RuleViolations
Schedule rule violations
The rule violations as shown in the RuleViolations tag
Output only

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<ScheduleMarkPosted
OrgJobLocation = String
QueryDateSpan = DateSpan >
</ScheduleMarkPosted>
Action Descriptions
Update
Updates a mark posted period if one exists
Required Properties: QueryDateSpan, OrgJobLocation

Chapter 2
Introduced in v5.0
OrgJobLocation
Set of jobs in the organization
A set of jobs for which all shifts will be marked as posted
Type: String
Required
Introduced in v5.0
QueryDateSpan
Span of dates for schedule
The date range when the schedule is valid
Type: DateSpan
Required

Chapter 2
ScheduleMetrics Tag
Schedule Metrics
Returning Summary data of any type for the given dates, locations, and Summary
settings.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveWithSettings"
Parameters→
None
Properties→
<ScheduleMetrics
SettingName = String >
<OrgPaths>
<SimpleValue>*
</OrgPaths>
(<ScheduleMetricsSettings>
<MetricsSettings>
</ScheduleMetricsSettings>)
(<ScheduleMetricsTotals>
<RollupStrategyTotal>*
</ScheduleMetricsTotals>)
</ScheduleMetrics>
Action Descriptions

Chapter 2
RetrieveWithSettings
Obtains the Summary data for the locations, period and settings provided.
Return Value Type: ScheduleMetrics tag
Required Properties: QueryDateSpan, SettingName, OrgPaths
Introduced in v6.1
OrgPaths
Location Paths
List of locations the summary data is requested for.
Required
Sample values:
<OrgPaths>
Floor 1" />
</OrgPaths>

QueryDateSpan
Date Span
Dates the summary data is requested for
Type: DateSpan
Required
Sample values:
QueryDateSpan="10/07/2007 - 10/10/2007"

Chapter 2
ScheduleMetricsSettings
Metrics Settings
The settings of the metric
Type: MetricsSettings tag
Output only
ScheduleMetricsTotals
Metrics Totals
The result of the metric
Type: Zero or more RollupStrategyTotal tags
Output only
SettingName
Setting Name
Setting name that is requested for
Type: String
Required
Sample values:
SettingName="Original Metrics Panel"

Chapter 2
ScheduleMetricsItem Tag
Indicator Value
Indicator value returned by a ScheduleMetrics query
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ScheduleMetricsItem
(Date = Date)
(Value = String) >
</ScheduleMetricsItem>
Date
Date
The date for which the indicator was evaluated.
Type: Date
Output only
Sample values:
Date="01/02/2007"

Chapter 2
Value
Value
The value of this indicator. The type might be a number or a duration in hours, this
depends on the indicator type.
Type: String
Output only
Sample values:
Value="02:00"

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ScheduleOff
<ShiftSegments>
<ShiftSegment>*
</ShiftSegments>
StartDate = Date
[ShiftTypeName = String] >
[<Notes>
<Note>*
</Notes>]
(<Comments>
<Comment>*
</Comments>)

Chapter 2
[<Employee>
</Employee>]
</ScheduleOff>
ShiftSegments
Segments in shift
The set of segments that comprise the shift code schedule
ShiftCodeName
Shift code name
Name of shift code
Type: String
Must identify an existing shift code
Introduced in v5.0
Comments
Comments
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

Chapter 2
Optional
Employee
Employee
CurrentUser tag.
Optional
Introduced in v4
IsDeleted
Type: Boolean
Output only
IsOpenShift
Specifies whether the current Off shift is open. If True, the shift is open.
Type: Boolean
Optional

Chapter 2

Notes
Comment Notes
Optional
Introduced in v6.0
ShiftTypeName
Type of shift
Name of shift type
Type: String
Optional
Introduced in v5.0
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.

Chapter 2
• 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.
Type: Date
Required

Shift segment
A shift must specify either a ShiftCode or a set of segments, but not both.
Required
Group includes: ShiftSegments, ShiftCodeName

Chapter 2
SchedulePattern Tag
Schedule Pattern
This tag describes a schedule pattern.
Used by: Schedule
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddPatternElements" |
"Delete" |
"Load" |
"LoadAllPatterns" |
"LoadTemplatePatterns" |
"Update"
Parameters→
None
Properties→
<SchedulePattern
(EffectiveDateSpan = DateSpan)
(Employee = String)
[IsTemplateFlag = Boolean]
(PeriodLengthInDays = Integer)
[PeriodLength = Integer]
SchedulePatternName = String
(ScheduleGroupName = String)
[AnchorDate = Date]

Chapter 2
[PeriodCodeName = 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.
Required Properties: SchedulePatternName
Introduced in v4
Delete
Marks a pattern for deletion
Must be a template pattern
Introduced in v4
Load
Returns a single pattern by name
Return Value Type: SchedulePattern tag
Introduced in v4

Chapter 2
LoadAllPatterns
Returns a list of defined patterns, including templates
Return Value Type: Zero or more SchedulePattern tags
Introduced in v4
LoadTemplatePatterns
Returns information about all template patterns
Introduced in v4
SDM optional action to retrieve all Schedule Patterns.
Introduced in v5.1
RetrieveAllNames
SDM required action to retrieve all the names of the Schedule Patterns.
Introduced in v5.1
RetrieveForUpdate
SDM required action to retrieve a Schedule Pattern by name.
Return Value Type: SchedulePattern tag
Introduced in v5.1

Chapter 2
Update
Adds a new pattern or updates an existing one
Must be a template pattern
Required Properties: SchedulePatternName, AnchorDate, PatternElements,
PeriodLength, PeriodCodeName
Introduced in v4
AnchorDate
Start date for pattern
Specifies the date on which the pattern is scheduled to start
Type: Date
Optional
Introduced in v4
Description
Description of the pattern
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
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

Chapter 2
Introduced in v5.0
Employee
Employee
The PersonNumber for the specified employee
Type: String
Output only
Introduced in v5.0
IsTemplateFlag
Is the pattern a template?
Indicates whether this pattern is a template
Type: Boolean
Optional
Introduced in v4
PatternElements
Pattern elements list
Lists the elements that comprise the pattern
Type: Zero or more PatternElement tags
Optional
PeriodCodeName
Units of time period (days or weeks)
Type: String
Optional
Enumerated value: Days, Weeks

Chapter 2
Introduced in v4
PeriodLength
Number of units
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 pattern applies. This number is formulated by
converting the PeriodLength on the basis of the PeriodCodeName.
Type: Integer
Output Only
Introduced in v4
ScheduleGroupName
Schedule group name
Type: String
Output only
Introduced in v5.0
SchedulePatternName
Pattern template profile
Defines the name of the schedule pattern template
Type: String
Required Key

Chapter 2

Introduced in v4

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<SchedulePayCodeEdit
[AmountInDays = Double]
[IsOverrideAccrual = Boolean]
[IsPartialOverride = Boolean]
[IsOverride = Boolean]
[StartDate = Date]
[UnavailableStartTime = Time]
(SymbolicValue = String)
[UnavailableDuration = TimeDuration]
DisplayTime = Time >
[<Notes>
<Note>*

Chapter 2
</Notes>]
(<Comments>
<Comment>*
</Comments>)
[<Employee>
</Employee>]
</SchedulePayCodeEdit>
Amount of pay code
The amount of the pay code edit, in time or currency, expressed as string, and
convert the string to Time duration or Currency based on amount type of pay
code.
Type: String
AmountInCurrency
The amount of the pay code edit, expressed as currency.
Dependency: If AmountInCurrency is specified, the associated PayCodeName
must match.
Type: Currency
Must be between 0 and 999
Introduced in v4
AmountInTime
The amount of the pay code edit, expressed as a time value. If AmountInTime is
specified, the associated PayCodeName must match.
Type: TimeDuration
Must be between 00:00 and 100:00
Introduced in v4

Chapter 2
AmountInDays
Amount of pay code in days
The amount of the pay code edit, expressed as a day value. If AmountInDays is
specified, the associated PayCodeName must match. The AmountInTime must
also be specified. If OverrideAccrualDaysAmount is not specified, the
OverrideAccrualDaysAmount defaults to the AmountInDays amount.
Type: Double
Optional
Must be between -1 and 1
Introduced in v6.1
Comments
Comments
The set of comments that are returned with this timekeeping item.
Output Only
Introduced in v4
CommentText
Comment text
A comment string that is attached to the scheduled pay code edit.
Type: String
Optional
DisplayTime
The start time of the scheduled pay code edit.

Chapter 2
Type: Time
Required
Employee
Employee
Either a PersonIdentity or CurrentUser tag. Specifies the employee assigned to the
paycode edit.
Optional
Introduced in v5.0
IsDeleted
Type: Boolean
Output only
IsOverride
Override shift while creating pay code edit?
Indicates whether shifts can be overridden.
• If True, all existing inherited shifts for the specified day are overridden.
• If False, no override is applied.
Type: Boolean
Optional

Chapter 2

IsOverrideAccrual
Override shift and allow pay code edit?
Indicates whether an override is acceptable:
• If True, it overrides a warning exception and creates a new pay code edit.
• f False, it provides a warning message and no pay code edit is added.
Type: Boolean
Optional
Introduced in v5.0
IsPartialOverride
Override shift partially while creating pay code edit?
If IsPartialOverride is True, the shift is partially overridden.
Type: Boolean
Optional
Sample values:
True

LaborAccountName
Labor account name
The labor account that is associated with the pay code.
Note the following:
-Do not specify if the scheduled pay code edit applies to the employee's primary
account

Chapter 2
-LaborAccountName is required if the scheduled pay code edit applies to a labor

account other than the employee's primary account
-If you are adding a comment to a scheduled pay code edit that had an explicit
value for LaborAccountName when it was added, you must enter that value.
-Do not specify if you are deleting a scheduled pay code edit.
-Enter data for labor accounts in the same format as they appear in timekeeping. If
you have a seven-level labor account in the timekeeping configuration, specify a
value for each labor level, using the format shown in the following example: 101/
202/303/404/504/603/702
-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
Notes
Comment notes
Optional
OrgJobPath
The organizational job path of the employee whose scheduled pay code edit is
being imported.

Chapter 2
Enter data for OrgJobPath in the same format as it appears in the database. The
OrgJobPath string matching is case-sensitive on a 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
Dependency: This is required if the scheduled pay code edit applies to an
organizational job other than the employee's primary organizational job.
PayCodeName
Pay code name
The pay code that is associated with the pay code edit.
Type: String
Optional
Introduced in v4
StartDate
Start date
The start date of the scheduled pay code edit.
Type: Date
Optional
Introduced in v5.0
SymbolicValue
Symbolic value
Show the pay code edit symbolic value if the property "ViewPCESymbolicValue"
from the XML API tag "Schedule" is true.
Type: String

Chapter 2
Output only
Sample values:
SymbolicValue="full contract day"
Enumerated value: "full contract day", "half contract day", etc.

Introduced in v6.1
UnavailableDuration
Time duration of unavailability
The period of time when an employee is unavailable on a specific day.
Type: TimeDuration
Optional
Introduced in v5.0
UnavailableStartTime
Start time for unavailability
The start time for an unavailable duration.
Type: Time
Optional
Introduced in v5.0

AccrualAmount
AccrualAmount is either in Currency or in Time depending on PayCodeName
Required
Group includes: AmountInTimeOrCurrency, AmountInCurrency, AmountInTime

Chapter 2
SchedulePeriod Tag
Schedule Period
The SchedulePeriod tag defines the length of time to be used for the previous,
current, and next schedule periods.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Load" |
"LoadAllPeriods" |
"Update"
Parameters→
None
Properties→
<SchedulePeriod
PeriodLength = Integer
SchedulePeriodName = String
StartDate = Date
PeriodCodeName = String >
</SchedulePeriod>
Action Descriptions

Chapter 2
Delete
Marks an existing schedule period for deletion
Required Properties: SchedulePeriodName
Load
Returns all existing schedule period in the database
LoadAllPeriods
Load all schedule periods from the database.
Return Value Type: Zero or more SchedulePeriod tags
Introduced in v5.0
SDM optional action to retrieve all Schedule Periods.
Return Value Type: Zero or more SchedulePeriod tags
Introduced in v5.1
RetrieveAllNames
SDM required action to retrieve all the names of the Schedule Periods.
Introduced in v5.1

Chapter 2
RetrieveForUpdate
SDM required action to retrieve a Schedule Period by name.
Return Value Type: SchedulePeriod tag
Introduced in v5.1
Update
Adds a new schedule period or updates an existing one
Required Properties: PeriodCodeName, PeriodLength, StartDate,
SchedulePeriodName
Description
Description
Describes the schedule period
Type: String
Optional
Introduced in v5.0
PeriodCodeName
Units for time period (days or months)
Type: String
Required
Default value: Days

Chapter 2
Enumerated value: Days, Weeks

Introduced in v5.0
PeriodLength
Number of units
PeriodLength is 3, it specifies three weeks.
Type: Integer
Required
Introduced in v5.0
SchedulePeriodName
Schedule period name
The name of the schedule period
Type: String
Required
Introduced in v5.0
StartDate
Start date (anchor date)
The anchor date for the schedule period
Type: Date
Required

Chapter 2
ScheduleRuleOverride Tag
Schedule rule override
This tag contains the corressponding actions and properties for schedule rule
override
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"Retrieve" |
"RetrieveAll" |
"Update"
Parameters→
None
Properties→
<ScheduleRuleOverride
(DetailsSummary = String)
[EffectiveDate = DateTime]
(EmployeeId = Long)
[ExpirationDate = DateTime]
[Name = String]
[SchedRuleId = Long] >
[<ScheduleRuleOverrideDetailsList>
<ScheduleRuleOverrideDetails>*
</ScheduleRuleOverrideDetailsList>]
</ScheduleRuleOverride>

Chapter 2
Action Descriptions
AddOnly
Adds the schedule rule override
Return Value Type: ScheduleRuleOverride tag
Required Properties: PersonNumber, SchedRuleId, EffectiveDate,
ExpirationDate, ScheduleRuleOverrideDetailsList
Introduced in v6.0
Delete
Deletes the schedule rule override
Introduced in v6.0
Retrieve
Retrieves the ScheduleruleOverride for a specfied name
Introduced in v6.0
RetrieveAll
Retrieves the list of available schedule rule override.
Introduced in v6.0
Update
Changes to the schedule rule override

Chapter 2

Required Properties: Name, ScheduleRuleOverrideDetailsList
Introduced in v6.0
DetailsSummary
Details summary
Details summary
Type: String
Output only
Introduced in v6.0
EffectiveDate
Effective date
Effective date
Type: DateTime
Optional
Introduced in v6.0
EmployeeId
Employee id
Employee id
Type: Long
Output only
ExpirationDate
Expiration date
Expiration date
Type: DateTime
Optional

Chapter 2
Introduced in v6.0
Name
Name
Name
Type: String
Optional
Introduced in v6.0
PersonNumber
Person number
Person number
Type: String
Optional
Introduced in v6.0
SchedRuleId
Schedule rule id
Schedule rule id
Description Schedule Rule that will be overriden
API NTL Name Schedule Parameter Parameter Week
Parameter Parameter Notes
Rule id Value Type ID Quantity day id type MM id type
id
Minimum Time Between Shifts 29 1 seconds No 10

11
Maximum Shift Length 28 1 seconds Yes 9 5
Minimum Shift Length 27 1 seconds Yes 8 5
Maximum Consecutive Days 24 2 days (integer) No 7 3
Minimum Hours Per Day 18 1 seconds Yes 1 4
Maximum Hours Per Day 20 1 seconds Yes 3 1

Chapter 2
Minimum Hours Per Week 19 1 seconds No 2 1

Maximum Hours Per Week 21 1 seconds No 4 1
Maximum Hours Per Bi-Weekly 36 1 seconds No 24 1
Maximum Job Segment for a Shift 35 6 integer Yes 23 16
Maximum Shifts Per Day 38 9 integer Yes 26 18
Maximum Days Per Week 23 2 days (integer) No 6 2
Minimum Days Per Week 22 2 days (integer) No 5 2
Maximum Nights Per Week 37 8 integer No 25 17
Number Unscheduled Weekends 33 7 integer No 21 14
Use this to define the # of Weekends*
For a Span of Weeks
Number Unscheduled Weekends 33 6 integer No 22 15
Use this to define the # of Weeks*
For a Span of Weeks
*Both parameters must be provided in the same transaction.
Additional Notes: The above information should be used when adding

schedule overrides.
When updating an existing schedule rule override, the 'Name' of the schedule
override must be provided. This is actually the EMPRULOVERRIDEID from the
EMPRULEOVERRIDE table.
When deleting an existing schedule rule override, the 'Name' of the schedule
override must be provided.
Type: Long
Optional

Chapter 2
ScheduleRuleOverrideDetailsList
Schedule rule override details list
Schedule rule override details list
Type: Zero or more ScheduleRuleOverrideDetails tags
Optional

Chapter 2
ScheduleRuleOverrideDetails Tag
Schedule rule override details
This tag constains the schedule rule override details.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ScheduleRuleOverrideDetails
ParamQty = Double
ParamTypeMMId = Long
ParamTypeId = Long
(ParamValue = String)
ParamValTypeId = Long
[WeekDayId = Long] >
</ScheduleRuleOverrideDetails>
ParamQty
Parameter quantity
Parameter quantity
Type: Double
Required
ParamTypeId
Parameter type id
Parameter type id

Chapter 2
Type: Long
Required
Introduced in v6.0
ParamTypeMMId
Parameter type MM id
Parameter type MM id
Type: Long
Required
Introduced in v6.0
ParamValTypeId
Parameter value type id
Parameter value type id
Type: Long
Required
ParamValue
Parameter value
Parameter value
Type: String
Output only
WeekDayId
Week day id
Week day id
Type: Long
Optional
Introduced in v6.0

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ScheduleShift
<ShiftSegments>
<ShiftSegment>*
</ShiftSegments>
[ShiftTypeName = String]
StartDate = Date >
[<Notes>
<Note>*
</Notes>]
(<Comments>
<Comment>*
</Comments>)
[<Employee>

Chapter 2
</Employee>]
</ScheduleShift>
ShiftSegments
Segments in shift
The set of segments that comprise the shift code schedule
Introduced in v4
ShiftCodeName
Shift code name
The name of a shift template
Type: String
Must be an existing shift code name
Introduced in v4
Comments
Comments
The set of comments returned with this shift
Output only
Introduced in v5.0
CommentText
Comment text
A text string that is attached to the entire shift, rather than to any shift segment.
This string must apply for this category.
Type: String
Optional

Chapter 2

Introduced in v5.0
Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, who is
assigned to the shift. Specify either ScheduleGroupName or Employee, but not
both.
Optional
Introduced in v4
IsDeleted
Type: Boolean
Output only
IsOpenShift
Specifies whether the shift is open. If True, the shift is open.
Type: Boolean
Optional

Chapter 2

Notes
Comment Notes
Optional
Introduced in v6.0
OrgJobPath
Contains the organizational job path to which the employee is transferring.
The OrgJobPath is case-sensitive if your 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
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

Chapter 2
Introduced in v4
ShiftTypeName
Shift display type
How the shift is displayed
Type: String
Optional
Enumerated value: 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
StartDate
Start date of shift
• If the action is to delete all scheduled shifts, pay codes, and off days that begin
being deleted.
• If the action is to begin importing a new shift, it contains the start date of the
• 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
• 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
• If the action is to add an off shift (a shift for an off day on which a person is
imported.

Chapter 2
Type: Date
Required
Must be within the date span of the containing schedule.

ShiftCodeSegment
Either provide ShiftCodeName from shift template or ShiftSegmnets with detailed
information for each segment.
Required
Group includes: ShiftSegments, ShiftCodeName

Chapter 2
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
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ScheduleShiftSwap
EndDate = Date
EndTime = Time
StartDate = Date
StartTime = Time >
<Employee>
</Employee>
</ScheduleShiftSwap>
Employee
Employee
CurrentUser tag.
Required

Chapter 2
Introduced in v5.0
EndDate
End date of the shift
End date for shift
Type: Date
Required
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

Chapter 2
ScheduleUnavailable Tag
Unavailable Schedule Period
This 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
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ScheduleUnavailable
EndDate = Date
EndTime = Time
(IsLockedFlag = Boolean)
StartDate = Date
StartTime = Time >
[<Notes>
<Note>*
</Notes>]
(<Comments>
<Comment>*
</Comments>)
[<Employee>
</Employee>]
</ScheduleUnavailable>

Chapter 2
Comments
Comments
The set of comments currently returned with this unavailable shift
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
String matching is case-sensitive.
Introduced in v5.0
Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, who is
unavailable.
Optional
Introduced in v4
EndDate
End date of unavailable period
The end date of the unavailable period
Type: Date
Required

Chapter 2
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?
- 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
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

Chapter 2

Notes
Comment Notes
Optional
Introduced in v6.0
ScheduleGroupName
Schedule group name
Type: String
Optional
Introduced in v4
StartDate
Start date
- If the action is to delete all scheduled shifts, pay codes, and off days that begin
being deleted.
- If the action is to begin importing a new shift, it contains the start date of the
- 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

Chapter 2
- 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
- If the action is to add an off shift (a shift for an off day on which a person is
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.
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

Chapter 2
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.

Chapter 2
ScheduleZone Tag
Schedule Zone
This 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
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ScheduleZone
[ZoneDescription = String]
EndTime = Time
[NewName = String]
ZoneName = String
[isDeleted = Boolean]
BeginTime = Time >
</ScheduleZone>
BeginTime
Start time
The starting time for a zone time span
Type: Time
Required
Introduced in v5.0

Chapter 2
EndTime
End time
The ending time for a zone time span
Type: Time
Required
Introduced in v5.0
isDeleted
Should the zone be deleted?
Specify if the zone should be deleted or not
Type: Boolean
Optional
NewName
New zone name
New zone name.
Type: String
Optional
Introduced in v5.2
ZoneDescription
Description of schedule zone
Describes the schedule zone
Type: String
Optional
Introduced in v5.0
ZoneName
Schedule zone name
The name of a schedule zone
Type: String

Chapter 2
Required
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

Chapter 2
SchedulingAudit Tag
Scheduling Audit
Retrieve audit records for a variety of scheduling data.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveByEmployee" |
"RetrieveByLocation"
Parameters→
None
Properties→
<SchedulingAudit
Type = String >
[<Employees>
<PersonIdentity>*
</Employees>]
[<OrgPaths>
<SimpleValue>*
</OrgPaths>]
</SchedulingAudit>
Action Descriptions
RetrieveByEmployee
Retrieve audit records by employee
Return Value Type: ScheduleAuditItems tag

Chapter 2
Required Properties: Type, QueryDateSpan, Employees

Introduced in v6.1
RetrieveByLocation
Return a list of audit records by location. If no orgpaths specified, take the home
locations of the user
Return Value Type: ScheduleAuditItems tag
Required Properties: Type, QueryDateSpan
Optional Properties: OrgPaths
Introduced in v6.1
Employees
Employees
The employees list
Optional
Introduced in v6.1
OrgPaths
Location Paths
The organization paths list
Optional
QueryDateSpan
Date Span
The audit date span
Type: DateSpan

Chapter 2
Required
Type
Type
The audit type
Type: String
Required
Sample values:
SHIFT, PAY_CODE, ACCRUAL_AMOUNT, DAY_LOCKING, Mark
Posted, WORKLOAD
Introduced in v6.1

Chapter 2
SegmentDetails Tag
Segment Details
Segment Details
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"RetrieveAll" |
"Update"
Parameters→
Update→
[NewName = String]
Properties→
<SegmentDetails
Active = Boolean
[CountsTowardsBudget = Boolean]
Name = String
[ScheduleSeed = Boolean]
[Symbol = String]
[VersionCnt = Integer] >
[<SegmentTypes>
<SegmentType>*
</SegmentTypes>]
</SegmentDetails>

Chapter 2
Action Descriptions
Delete
Delete SegmentDetails with specified Name
Introduced in v6.1
Retrieve
Retrieve SegmentDetails with specified Name and SegmentTypes
Return Value Type: SegmentDetails tag
Introduced in v6.1
RetrieveAll
Retrieves all the Segment Details.
Return Value Type: Zero or more SegmentDetails tags
Introduced in v6.1
RetrieveAllNames
Retrieves the Names of all the Segment Details.
Introduced in v6.1
RetrieveForUpdate
Retrieves the SegmentDetails specified by Name for use by Update. Differs from
Retrieve in that VersionCnt is not returned.
Return Value Type: SegmentDetails tag

Chapter 2

Introduced in v6.1
Update
updates a SegmentDetails to the database.
Required Properties: Name, SegmentTypes
Optional Properties: Active, Description, Symbol, VersionCnt, ScheduleSeed,
CountsTowardsBudget
Introduced in v6.1
Action Parameters

NewName NewName Introduced in v6.1
Optional
Active
Active
Active switch
Type: Boolean
Required
Introduced in v6.1
CountsTowardsBudget
Counts Towards Budget
Counts Towards Budget
Type: Boolean
Optional

Chapter 2
Introduced in v6.1
Description
Description
Description
Type: String
Optional
Introduced in v6.1
Name
Name
Name
Type: String
Required
Introduced in v6.1
ScheduleSeed
Schedule Seed
Schedule Seed
Type: Boolean
Optional
Default value: true
SegmentTypes
Segment Types
Segment Types
Type: Zero or more SegmentType tags
Optional
Introduced in v6.1
Symbol
Symbol
Symbol

Chapter 2
Type: String
Optional
Introduced in v6.1
VersionCnt
Version Count
Version Count
Type: Integer
Optional
Introduced in v6.1

Chapter 2
SegmentType Tag
Segment Type
Segment Type
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"retrieve" |
"retrieveAll"
Parameters→
None
Properties→
<SegmentType
Name = String >
</SegmentType>
Action Descriptions
retrieve
Retrieve Segment Type with specified Name
Return Value Type: SegmentType tag
Introduced in v6.1

Chapter 2
retrieveAll
Retrieves all the SegmentTypes
Return Value Type: Zero or more SegmentType tags
Introduced in v6.1
Name
Segment type Name
Segment type Name
Type: String
Required
Introduced in v6.1

Chapter 2
SequencedBreak Tag
Break Sequence
The order in which breaks should be taken, for example, rest, meal, rest. This is
blank by default.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<SequencedBreak
BreakRuleName = String >
</SequencedBreak>
BreakRuleName
BreakRuleName
Name of the Break Rule.
Type: String
Required
Introduced in v6.1

Chapter 2
ServerTime Tag
Server Date and Time
The ServerTime tag represents the date, time, and time zone of the timekeeping
server.
Introduced in v4
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"GetServerTime"
Parameters→
None
Properties→
<ServerTime
(DateTime = DateTime)
(KronosTimeZone = String) >
</ServerTime>
Action Descriptions
GetServerTime
Returns the server's date, time, and timezone.
Return Value Type: ServerTime tag
Introduced in v4

Chapter 2
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
Programmer's Guide.
Introduced in v4

Chapter 2
SettingIndicator Tag
Metrics Setting Indicator
Setting indicators are in charge of returning the metrics setting's indicators and
their horizontal and vertical total type associated
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<SettingIndicator
TotalHorizontal = String
Name = String
TotalVertical = String >
</SettingIndicator>
Description
Description
The description of the indicator
Type: String
Output only
Introduced in v6.1
Name
Name
Name of the indicator.

Chapter 2
Type: String
Required
Sample values:
Name="Req RTS"
Introduced in v6.1
TotalHorizontal
Horizontal Total Type
The operation to use for the horizontal total calculation of this indicator.
Type: String
Required
Sample values:
TotalHorizontal="SUM"

TotalVertical
Vertical Total Type
The operation to use for the vertical total calculation.
Type: String
Required
Sample values:
TotalVertical="SUM"

Chapter 2
SettingsParamDefinition Tag
Settings parameters
Represents the parameters of a setting to which a user may configure; for
example, the color used to indicate overcoverage in Coverage settings.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames"
Parameters→
None
Properties→
<SettingsParamDefinition
SettingsParameterDefinitionName = String
</SettingsParamDefinition>
Action Descriptions
Retrieve
Return a parameter definition object given the name.
Return Value Type: SettingsParamDefinition tag
Required Properties: SettingsParameterDefinitionName

Chapter 2
Introduced in v6.0
RetrieveAll
Returns all parameter definitions.
Return Value Type: Zero or more SettingsParamDefinition tags
Introduced in v6.0
RetrieveAllNames
Return all parameter definitions objects names.
Introduced in v6.0
SettingsParameterDefinitionName
Name of settings parameter
Represents a settings parameter definition name.
Type: String
Required Key
Sample values:
<SettingsParameterDefinitionName> ThisIsAName</
SettingsParameterDefinitionName>

ValueTypeName
Parameter value type
value type expected by this parameter: integer, objectId, dateÖ
Type: String
Output only
Sample values:

Chapter 2
ValueTypeName="OBJECTID"

Chapter 2
SettingsParamValue Tag
Value of a settings parameter
Represents a settings parameter definition and its associated value.
Each parameter validates the values differently.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<SettingsParamValue
Name = String
Value = String >
</SettingsParamValue>
Name
Name of parameter definition
Name of an existing setting parameter definition.
Type: String
Required
Must be an existing parameter definition from SettingsParamValue gold data.
Sample values:
<SettingsParamValue Value="Admin Assistant;Full Time"
Name="WORK_RULES"/>

Chapter 2
Value
Parameter value
Value chosen for a parameter definition. Eg: number of decimals = "2".
Type: String
Required
Each parameter class validates the values according to its own rules.
Sample values:
<SettingsParamValue Value="Admin Assistant;Full Time"
Name="WORK_RULES"/>

Chapter 2
SettingStrategy Tag
Metrics Setting Strategy
Metrics setting strategies are in charge of returning the metrics setting's strategies
with associated label and parameter.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<SettingStrategy
GroupBy = String
[Label = String]
[Parameter = String] >
</SettingStrategy>
Description
Description
The description of the strategy.
Type: String
Output only
Sample values:
Description="Group by Job"
Introduced in v6.1

Chapter 2
GroupBy
Grouping
Name of the strategy.
Type: String
Required
Sample values:
GroupBy="JOB"

Label
Label
Display label of the strategy.
Type: String
Optional
Sample values:
Label="By Job"
Introduced in v6.1
Parameter
Parameter
Parameter of the strategy.
Type: String
Optional
If the strategy has available parameters, a valid parameter value is required.
Sample values:
Parameter="Strategy Zone Set"
Introduced in v6.1

Chapter 2
SettingsType Tag
Settings Type
Represents the types of settings which are available for user configuration
(coverage settings, schedule generation settings, etc).
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames"
Parameters→
Retrieve→
SettingsTypeName = String
Properties→
<SettingsType
SettingsTypeName = String >
</SettingsType>
Action Descriptions
Retrieve
Retrieve a setting type object by name.
Return Value Type: SettingsType tag
Required Properties: SettingsTypeName

Chapter 2
Introduced in v6.0
Action Parameters

SettingsTypeName Name of the setting type. Introduced in v6.0
Required
RetrieveAll
Retrieves all settings type objects.
Return Value Type: Zero or more SettingsType tags
Introduced in v6.0
RetrieveAllNames
Retrieves all settings type objects names.
Introduced in v6.0
Description
Settings type description
Settings type description
Type: String
Output only
Introduced in v6.0
SettingsTypeName
Settings type name
Representa a settings type object name.
Type: String

Chapter 2
Required Key
Sample values:
<SettingsTypeName> ThisIsAName</SettingsTypeName>

Chapter 2
ShiftAuditItem Tag
Shift Audit Record
This tag contains shift information for an audit.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ShiftAuditItem
(Account = String)
(Action = String)
(Comment = String)
(Job = String)
(Label = String)
(SegmentEnd = DateTime)
(SegmentStart = DateTime)
(SegmentType = String)
(ShiftEnd = DateTime)
(ShiftStart = DateTime)
(User = String)
(WorkRule = String) >
</ShiftAuditItem>
Account
Account
the shift labor account

Chapter 2
Type: String
Output only
Introduced in v6.1
Action
Action
The audited action
Type: String
Output only
Sample values:
CREATE, MODIFY
Introduced in v6.1
Comment
Comment
The comment(s) and note(s) associated to the shift
Type: String
Output only
Introduced in v6.1
DataSource
Data Source
The functional area
Type: String
Output only
Sample values:

Chapter 2
EditDateTime
Edit Date Time
The audit action date time
Type: DateTime
Output only
Job
Job
The shift job
Type: String
Output only
Introduced in v6.1
Label
Label
The shift label
Type: String
Output only
Introduced in v6.1
PersonNumber
Employee Number
The person number assigned to this shift
Type: String
Output only
SegmentEnd
Segment End
The shift segment end datetime
Type: DateTime
Output only

Chapter 2

SegmentStart
Segment Start
The shift segment start date time
Type: DateTime
Output only
SegmentType
Segment Type
The shift segment type
Type: String
Output only
Sample values:
shift, off, unavailable

ShiftEnd
Shift End
The shift end date time
Type: DateTime
Output only
ShiftStart
Shift Start
The shift start datetime
Type: DateTime
Output only

Chapter 2
User
User
The audited user
Type: String
Output only
Sample values:
Introduced in v6.1
WorkRule
Work Rule
The work rule associted to this shift
Type: String
Output only

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"BuildShifts" |
"LoadPopulatedThroughDate" |
"PurgeShiftBuilderErrorDetails" |
"ResubmitFailedShiftBuilderTasks"
Parameters→
None
Properties→
<ShiftBuilder
(PopulatedThroughDate = Date)
</ShiftBuilder>
Action Descriptions
BuildShifts
Invokes the shift builder process
Introduced in v4

Chapter 2
LoadPopulatedThroughDate
To get the PopulatedThroughDate.
PurgeShiftBuilderErrorDetails
Purge shift builder error details in the SHIFTBUILDERDTL table, any records
older than certain number of days will be purged from the database.
Introduced in v6.0
ResubmitFailedShiftBuilderTasks
Resubmit the failed shift builder entries that are stuck in the SCHEDULEPROC
table so they can be retried again.
Introduced in v6.0
PopulatedThroughDate
Date through which the schedule is populated
The populated through date
Type: Date
Output only
none
UserName
User who starts the schedule builder
The name of the user who starts the Schedule Builder

Chapter 2
Type: String
Optional

Chapter 2
ShiftCode Tag
Shift
The ShiftCode tag describes a named shift. It can be used for group or individual
shifts, or as a template for generating shifts.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Load" |
"LoadAllShiftCodes" |
"Update"
Parameters→
None
Properties→
<ShiftCode
[Label = String]
ShiftCodeName = String >
[<ShiftSegments>
<ShiftSegment>*
</ShiftSegments>]
</ShiftCode>
Action Descriptions

Chapter 2
Delete
Marks the specified shift code for deletion
Required Properties: ShiftCodeName
Introduced in v4
Load
Returns the specified shift code
Return Value Type: ShiftCode tag
Introduced in v4
LoadAllShiftCodes
Returns all user-defined shift codes
Return Value Type: Zero or more ShiftCode tags
Introduced in v4
SDM optional action to retrieve all Shift Codes.
Return Value Type: Zero or more ShiftCode tags
Introduced in v5.1
RetrieveAllNames
SDM required action to retrieve all the names of the Shift Codes.
Introduced in v5.1

Chapter 2
RetrieveForUpdate
SDM required action to retrieve a Shift Code by name.
Return Value Type: ShiftCode tag
Introduced in v5.1
Update
Adds a new shift code or updates an existing one
Required Properties: ShiftCodeName, ShiftSegments
Description
Description of shift code
Describes the shift code
Type: String
Optional
Label
Label for shift code
The shift code label that displays in the user interface
Type: String
Optional

Chapter 2
ShiftCodeName
Shift code name
The shift that can be generated by the system
Type: String
Required, Key
Introduced in v4
ShiftSegments
Segments in shift
The set of segments that comprise the specified shift code
Optional
Introduced in v4

Chapter 2
ShiftCountSpan Tag
Shift counting exceptions
This 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.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ShiftCountSpan
EndTime = Time
BeginTime = Time >
</ShiftCountSpan>
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

Chapter 2
Required
Introduced in v5.0

Chapter 2
ShiftHistory Tag
Shift history
This tag retrieves a shift's history.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve"
Parameters→
None
Properties→
<ShiftHistory
<Employee>
<PersonIdentity>
</Employee>
OrgJobPath = String
(Action = String)
(Comment = String)
(NewShift = String)
(Reason = String)
(Info = String)
(DateTime = DateTime)
(UserName = String) >
</ShiftHistory>
Action Descriptions

Chapter 2
Retrieve
Retrieve action to retrieve a shift's history.
Return Value Type: Zero or more ShiftHistory tags
Required Properties: DateTimeSpan, Employee or OrgJobPath but not both.
Introduced in v5.2
Employee
Employee
The employee to whom the schedule applies.
Employee and OrgJobPath are mutually exclusive.
OrgJobPath
Organizational job
The fully qualified Organization job is used to retrieve the booked-off open shift
history.
Type: String
OrgJobPath and Employee are mutually exclusive.
Action
Action
The shift history action.
Type: String
Output only

Chapter 2
Comment
Comment
The comment of the modification.
Type: String
Output only
DateTime
Shift modified date and time.
The shift modified date and time.
Type: DateTime
Output only
Introduced in v5.2
DateTimeSpan
Shift span
The fully qualified date time span to define a shift's duration.
Type: DateTimeSpan
Required
Introduced in v5.2
Info
Shift information
The shift information.
Type: String
Output only
NewShift
New shift
Information of the new created shift.
Type: String
Output only

Chapter 2

Reason
Reason
The Book-Off, Book-On or Relief Not Needed reason.
Type: String
Output only
UserName
User who modified the shift
The user who modified the shift.
Type: String
Output only

Employee
Must have either Employee or OrgJobPath but not both
Required
Group includes: Employee, OrgJobPath

Chapter 2
ShiftSegment Tag
Shift Segment
The ShiftSegment tag represents shift-related information for a single time span.
Used by: ScheduleOff, ScheduleShift, and ShiftCode
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ShiftSegment
EndTime = Time
EndDayNumber = Integer
StartDayNumber = Integer
[SegmentTypeName = String]
[StartTime = Time]
</ShiftSegment>
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

Chapter 2
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.
Type: String
Optional
Introduced in v4
OrgJobPath
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.

Chapter 2
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
SegmentTypeName
Segment type
The type of activity that the segment represents
Type: String
Optional
Default value: Regular
Enumerated value: Regular, Unavailable, Transfer, Break, Off, Regular PCE,
Availability PCE, Accrual Edit
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:

Chapter 2
- 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
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.
WorkRuleName
Work rule
Name of the work rule that describes the activity
&ALL_WORK_RULES
&EMPTY
Type: String
Optional

Chapter 2

You can find values in the Timekeeping Application.

Chapter 2
ShiftStartTimeBand Tag
Shift Start Time Band
The ShiftStartTimeBand tag describes a named start time of the shift.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"addOnly" |
"deleteOnly" |
"retrieve" |
"retrieveAll" |
"update" |
"updateOnly"
Parameters→
None
Properties→
<ShiftStartTimeBand
[ActiveSwitch = Boolean]
Name = String
[NewName = String]
StartTime = Time >
</ShiftStartTimeBand>
Action Descriptions
addOnly
Stores shift start band in the database. Returns an error if object with the same
name exists

Chapter 2
Validate all properties including optional

Return Value Type: Boolean
Required Properties: Name, DisplayName, StartTime
Optional Properties: ActiveFlag
Introduced in v5.1
deleteOnly
Logically deletes the shift start time band object from the database or returns an
error if object does not exists
Validate Name property.
Introduced in v5.1
retrieve
Retrieves shift start time band object from the database by name
Validate the Name property.
Return Value Type: ShiftStartTimeBand tag
Introduced in v5.1
retrieveAll
Retrieves all ShiftStartTimeBand objects from the database
Return Value Type: (***undefined***): List of ShiftStartTimeBand
Introduced in v5.1

Chapter 2
update
Persists the shift start time band object in the database or updates with new data if
object exists.
Validate all properties including optional.
Optional Properties: NewName, DisplayName, StartTime, ActiveSwitch
Introduced in v5.1
updateOnly
Updates the start time band object in the database. Returns an error if object does
not exist or the new name is not unique
Validate all properties including optional
Optional Properties: NewName, DisplayName, StartTime, ActiveSwitch
Introduced in v5.1
ActiveSwitch
Is the band active?
The active band flag.
Type: Boolean
Optional
Introduced in v5.1
DisplayName
The shift start time band display name

Chapter 2
Type: String
Required
Can not be null and should contain between 1 and 50 characters.
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 start time band ( for update action only)
Type: String
Optional
Cannot be null and should contain between 1 and 30 characters.
StartTime
Start Time
The shift start time (required for add, optional for update)
Type: Time
Required
Can not be null
Introduced in v5.1

Chapter 2
ShiftTemplateAssignment Tag
Shift Template Profiles assigned to an employees
The ShiftTemplateAssignment tag consists of one or more shift template profiles
for one employee who has been identified in the ShiftTemplateItem.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAll" |
"Update"
Parameters→
None
Properties→
<ShiftTemplateAssignment
<ShiftTemplateItems>
<ShiftTemplateItem>*
</ShiftTemplateItems>
</ShiftTemplateAssignment>
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.

Chapter 2
Return Value Type: ShiftTemplateAssignment tag

Required Properties: ShiftTemplateItems
LoadAll
Loads all shift template profiles in the system.
Return Value Type: Zero or more ShiftTemplateItem tags
Required Properties: none
Update
Updates a person's shift template profile.
Required Properties: ShiftTemplateItems
ShiftTemplateItems
Shift template items
One or more shift template assignments, as shown in the ShiftTemplateItem tag.
Type: Zero or more ShiftTemplateItem tags
Required

Chapter 2
ShiftTemplateItem Tag
Shift Template Item
The ShiftTemplateItem tag defines an element of a shift template profile
assignment.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<ShiftTemplateItem
ShiftTemplateProfileName = String >
<Employee>
<PersonIdentity>
</Employee>
</ShiftTemplateItem>
Employee
Employee
The employee to whom the shift code template profile is assigned
Required Key
Must be a unique and existing employee

Chapter 2
ShiftTemplateProfileName
Shift template profile name
The name of an existing shift code profile
Type: String
Optional Key

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load"
Parameters→
None
Properties→
<ShiftValidation
EndTime = Time
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

Chapter 2
Required Properties: QueryDate, StartTime, EndTime, Employee

Employee
Employee
Required Key
EndTime
Shift end time
The time when the shift ends
Type: Time
Required
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
QueryDate
Shift start date
The date when the shift starts
Type: Date

Chapter 2
Required
StartTime
Shift start time
The time when the shift begins
Type: Time
Required

Chapter 2
Signature Tag
Signature
Used in a Procedure to hold the prototype of the Procedure
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"DeleteOnly" |
"Retrieve" |
"RetrieveAll" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<Signature
SignatureName = String >
</Signature>
Action Descriptions

Chapter 2
Add
Inserts one Signature object in the database . If it's already there a rule with the
same name nothing happens.
Required Properties: SignatureName
Introduced in v6.0
AddOnly
Inserts one Signature object in the database . If it's already there an error is
thrown.
Introduced in v6.0
Delete
Deletes the Signature object from the database that has the same name as the one
specified in the SignatureName. If it's not there nothing happens.
Introduced in v6.0
DeleteOnly
Deletes the Signature object from the database that has the same name as the one
specified in the SignatureName. If it's not there an error is thrown.
Introduced in v6.0

Chapter 2
Retrieve
Retrieves the Signature object that has the same name as the one specified in the
SignatureName.
Return Value Type: Signature tag
Introduced in v6.0
RetrieveAll
Retrieves all the Signature objects.
Return Value Type: Zero or more Signature tags
Introduced in v6.0
Retrieves all the Signature objects.
Return Value Type: Zero or more Signature tags
RetrieveAllNames
Retrieves all the names for all Signature objects.
Introduced in v6.0
RetrieveForUpdate
Retrieves the Signature object that has the same name as the one specified in the
SignatureName.
Return Value Type: Signature tag

Chapter 2
Introduced in v6.0
Update
Updates one Signature object in the database . If it's not there it's inserted, if it's
there it's updated.
Introduced in v6.0
UpdateOnly
Updates one Signature object in the database . If it's not there an error is thrown.
Introduced in v6.0
SignatureName
Signature Name
Defines the name property of the Signature object.
Type: String
Required Key
Introduced in v6.0

Chapter 2
SignatureItem Tag
Signature Item
This object is the small part of a Signature object.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<SignatureItem
ProcedureParameterDefinitionName = String
ProcedureParameterName = String >
</SignatureItem>
ProcedureParameterDefinitionName
Procedure Parameter Definition Name
The name of the procedure parameter definition object of this SignatureItem
object.
Type: String
Required Key
Introduced in v6.0
Procedure Parameter Name
The name of procedure parameter.
Type: String
Required Key

Chapter 2
Introduced in v6.0

Chapter 2
SimplePair Tag
Simple Pair
The SimplePair tag contains Key and Value.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<SimplePair
Key = String
Value = String >
</SimplePair>
Key
Key
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
Default value: String
Introduced in v5.2
Value
Value

Chapter 2
Type: String
Required
Introduced in v5.2

Chapter 2
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.
Introduced in v4
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<SimpleValue
Value = String >
</SimpleValue>
Value
Value
Type: String
Required
This property represents one value.
Introduced in v4

Chapter 2
StaffingRequirement Tag
Staffing requirement
This tag returns the daily coverage (required/scheduled) for every location and for
every time span.
Introduced in v6.0
Syntax
None

Chapter 2
StandardShift Tag
Standard Shift
The StandardShift tag describes a named time span.
Used by: StandardShiftSet
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<StandardShift
[ShiftDescription = String]
EndTime = Time
ShiftName = String
BeginTime = Time >
</StandardShift>
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

Chapter 2
Type: Time
Required
Introduced in v5.0
ShiftDescription
Description
Describes the shift
Type: String
Optional
Introduced in v5.0
ShiftName
Shift name
The name of the shift
Type: String
Required
You can find values in the Workforce Timekeeper user interface under the
Scheduler Setup Workload Setup menu.
Introduced in v5.0

Chapter 2
Strategy Tag
Strategy
Strategies define the hierarchy by which indicator values are hierarchically
grouped and subtotalized
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames"
Parameters→
None
Properties→
<Strategy
(I18Name = String)
Name = String >
</Strategy>
Action Descriptions
Retrieve
returns the strategy with the given name
Return Value Type: Strategy tag

Chapter 2
Introduced in v6.1
RetrieveAll
Returns all strategies
Return Value Type: Zero or more Strategy tags
Introduced in v6.1
RetrieveAllNames
Returns the list of all strategy names
Return Value Type: (***undefined***): KBusinessObjectBeanList
Description
Description
The description of the metrics strategy
Type: String
Output only
I18Name
The localized name of the metrics strategy
Type: String
Output only
Name
Name
The name of the metrics strategy
Type: String

Chapter 2
Required
Sample values:
<Request Action="Retrieve">
<Strategy Name="JOB"/>
</Request>

Chapter 2
SuiteProduct Tag
Product in Suite
The SuiteProduct tag provides license information about products in the suite.
The product that is specified must be defined to the system, but need not be
installed.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadAll" |
"LoadByName"
Parameters→
None
Properties→
<SuiteProduct
(InstalledSw = Boolean)
(LicensedSw = Boolean)
(IndependentProductSw = Boolean)
[SuiteProductName = String]
(Version = String) >
</SuiteProduct>
Action Descriptions
LoadAll
Returns information about all suite products in the system.
Return Value Type: Zero or more SuiteProduct tags

Chapter 2

LoadByName
Returns information about the requested suite product.
Return Value Type: SuiteProduct tag
Required Properties: SuiteProductName
IndependentProductSw
Is this a standalone product?
Specifies whether the product is part of the suite or is independent
Type: Boolean
Output only
InstalledSw
Is the product installed?
Specifies whether the product is installed
Type: Boolean
Output only
LicensedSw
Is the product licensed?
Specifies whether the suite is licensed
Type: Boolean

Chapter 2
Output only
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

Chapter 2
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.
Syntax
None

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadEligibleEmployees"
Parameters→
None
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.

Chapter 2
Return Value Type: Zero or more Person tags

Required Properties: Employee, QueryDate, StartTime, EndTime
Employee
Employee
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.
EndTime
Shift end time
The end time for the shift that needs to be swapped
Type: Time
Required
QueryDate
Shift start date
The start date for a shift that can be swapped.
Type: Date
Required

Chapter 2
StartTime
Shift start time
Start time for the shift that can be swapped.
Type: Time
Required

Chapter 2
SwapShiftJobs Tag
Jobs Eligible for Swap Shifts
This tag returns job list for a shift swap.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadJobs"
Parameters→
None
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.

Chapter 2
Return Value Type: Zero or more OrgJob tags

Employee
Employee
Required
EndTime
Shift end time
This property is the end time of a shift.
Type: Time
Required
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
QueryDate
Shift start date
This property is the start date of a shift.
Type: Date
Required

Chapter 2
StartTime
Shift start time
This property is the start time of a shift
Type: Time
Required

Chapter 2
SwitchRoleEngine Tag
SwitchRoleEngine
The SwitchRoleEngine tag will switch the role from myself to the delegator role
or switch back from the delegator role to myself.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"SwitchBackToMyself" |
"SwitchRole"
Parameters→
None
Properties→
<SwitchRoleEngine
delegatorFullName = String
delegatorPersonNum = String
roleProfileName = String >
</SwitchRoleEngine>
Action Descriptions
SwitchBackToMyself
Switch the role back to myself.
Required Properties: none

Chapter 2
Introduced in v5.2
SwitchRole
Switch the current user to the identifier with role profile
one of the delegator identifier and role profile name cannot be null or empty
Required Properties: Delegator Identifier, Role Profile Name
Introduced in v5.2
delegatorFullName
delegator Full Name
The name of the delegator. Specify the name as last name, comma, space, first
name, space, middle initial.
Type: String
delegatorPersonNum
delegator Person Number
The person number of the delegator.
Type: String
roleProfileName
role Profile Name
The name of the delegation role profile name.
Type: String
Required

Chapter 2

Delegator Identifier
One member or both members of the Identifier group can be specified..
Outstanding: Identifier usage constraint is specified as Required. But only one
member of the Identifier group is required. Their values can be none.
Required
Group includes: delegatorFullName, delegatorPersonNum

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load"
Parameters→
Load→
KeyNames = String
Properties→
<SystemSettings
(Key = String)
(Value = String) >
</SystemSettings>
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.

Chapter 2
Return Value Type: Zero or more SystemSettings tags

Introduced in v5.0
Action Parameters

KeyNames A comma separated list of system Introduced in v5.0
setting keys. Each item in the list
represents one or more system
settings.
Required
Key
Key for 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

Chapter 2
TelephoneNumber Tag
Telephone Number
The TelephoneNumber tag defines a person's telephone number.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<TelephoneNumber
PhoneNumber = String
ContactTypeName = String >
</TelephoneNumber>
ContactTypeName
Type of contact
The customer-defined name of the contact category; up to three telephone
numbers can be provided. You can define the contact category name using
Workforce Central Setup Application.
Type: String
Required Key
Values for CustomTypeName can be changed through the Workforce Central
Setup Application.
Sample values:

Chapter 2
Home Phone, Work Phone, Mobile Phone

PhoneNumber
Phone number
The telephone number for the specified contact type
Type: String
Required
A maximum of three phone numbers can be specified for a person in Workforce
Timekeeper.
Introduced in v4

Chapter 2
TermDurationPaycode Tag
Term Duration Pay Code
TermDurationPaycode contains the duration pay code work rule mapping.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<TermDurationPaycode
PayCode = String
WorkRule = String >
</TermDurationPaycode>
PayCode
Pay code name
The name of a pay code.
Type: String
Optional Key
Introduced in v6.1
WorkRule
Work rule name
The name of a work rule.
Type: String
Optional Key

Chapter 2
Introduced in v6.1

Chapter 2
TimeEntry Tag
Time Entry
The TimeEntry tag returns information about valid time entries defined within the
system. The Time Entry Method determines how employees will see time when
entering data.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAllTimeEntries" |
"LoadById"
Parameters→
None
Properties→
<TimeEntry
[TimeEntryId = Integer]
[TimeEntryName = String] >
</TimeEntry>
Action Descriptions
Load
Returns a time entry, based on TimeEntryName.
Return Value Type: TimeEntry tag
Required Properties: TimeEntryName

Chapter 2

Introduced in v4
LoadAllTimeEntries
Returns all time entries in the system.
Return Value Type: Zero or more TimeEntry tags
Introduced in v4
LoadById
Returns a time entry, based on TimeEntryID.
ID must be valid
Return Value Type: TimeEntry tag
Required Properties: TimeEntryID
Introduced in v4
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

Chapter 2
Enumerated value: Timestamp, Timestamp & Hourly View, Hourly View, Project
View
Introduced in v4

Chapter 2
TimeFramePeriod Tag
Time Frame for a Period of Time
The TimeFramePeriod tag describes a period of time.
Used by: a number of other tags
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadAllTimeFrames" |
"LoadDateRange"
Parameters→
None
Properties→
<TimeFramePeriod
[TimeFrameDate = Date]
[PeriodDateSpan = DateSpan]
TimeFrameName = String >
</TimeFramePeriod>
Action Descriptions
LoadAllTimeFrames
Returns all time frames in the system.
Only TimeFrameName is returned
Return Value Type: Zero or more TimeFramePeriod tags

Chapter 2

Introduced in v4
LoadDateRange
Parameter MAP could have any Parameters like CURRENT_PAY_PERIOD,
PREVIOUS_PAY_PERIOD, NEXT_PAY_PERIOD,
CURRENT_SCHEDULE_PERIOD, PREVIOUS_SCHEDULE_PERIOD,
NEXT_SCHEDULE_PERIOD, WEEK_TO_DATE, LAST_WEEK,
YESTERDAY, TODAY, DATE_RANGE, and SPECIFIC_DATE.
Return Value Type: (***undefined***): APITimeFramePeriodBean
Required Properties: ParameterMap
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

Chapter 2
TimeFrameName
Time frame name
The name of the time frame
• 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
Enumerated value: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 13

Chapter 2
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
Introduced in v4
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<TimekeepingException
(MissedOutDateTime = DateTime)
(DifferenceToLimit = TimeDuration)
(ExceptionTypeName = String)
(AssociatedWithInPunchFlag = Boolean)
(MinimumNumberOfActiveDays = Integer)
(ActualNumberOfActiveDays = Integer)
(NumberOfWorkedDays = Integer)
(DurationOfException = TimeDuration) >
</TimekeepingException>
ActualNumberOfActiveDays
Number of active days
Meaningful only for MinimumDaysActive and MinimumDaysEmployed
timekeeping exceptions
Type: Integer
Output Only

Chapter 2
Introduced in v4
AssociatedWithInPunchFlag
Is the exception associated with an in-punch?
True if the exception is associated with an In punch, False if it is associated with
an Out punch
Type: Boolean
Output Only
Introduced in v4
DifferenceToLimit
Difference between triggering limit and time of event
Specifies the difference between the triggering limit and the time of the event.
Meaningful only for timekeeping exceptions identified as Early, Late, VeryEarly,
VeryLate, Long, or Short. For example, if there is a Late limit of 0:32, and if the
employee punches out at 1:00 past the scheduled end of shift, the
DifferentToLimit is 0:28.
Type: TimeDuration
Output Only
Introduced in v4
DurationOfException
Time duration for exception
Specifies the sum of the DifferenceToLimit and the value of the triggering limit.
Meaningful only for Early, Late, VeryEarly, VeryLate, Long, and Short
timekeeping exceptions. For example, if the late limit is 0:32, and if the employee
punches out 1:00 past the scheduled end of shift, the DurationOfException is 1:00.
Type: TimeDuration
Output Only
Introduced in v4

Chapter 2
ExceptionTypeName
Exception type
The name of the exception.
Type: String
Output Only
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

Chapter 2
Introduced in v4

Chapter 2
TimeOffHoursRequestItem Tag
Time Off Hours Request Item
Describe a time off hours request
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<TimeOffHoursRequestItem
Duration = TimeDuration
Id = String
RequestFor = String
StartDateTime = DateTime
[<Comments>
<Comment>
</Comments>]
<Employee>
<PersonIdentity>
</Employee>
</TimeOffHoursRequestItem>

Chapter 2
Comments
Comments
The request comments
Type: Comment tag
Optional
Introduced in v6.1
CreatedByUser
Created By User
The user who made the request
Type: String
Output only
Introduced in v6.1
CreationDateTime
Creation Date Time
The creation dat/time of the request
Type: DateTime
Output only
Introduced in v6.1
Duration
Duration
The duration (in hours) of a time off hours request
Type: TimeDuration
Required
Employee
Employee
The employee of the request
Required

Chapter 2
Introduced in v6.1
Id
Id
Request id's
Type: String
Optional Key
Introduced in v6.1
PayCodeName
Pay Code Name
The pay code name of the request
Type: String
Required
Introduced in v6.1
RequestFor
Request For
The request subtype
Type: String
Required
Introduced in v6.1
The list of status changes
Output only
Introduced in v6.1
StartDateTime
Start Date Time
The Start Date Time of the time off
Type: DateTime

Chapter 2
Required
Introduced in v6.1
StatusName
Status Name
The status of the request
Type: String
Output only
Introduced in v6.1

Chapter 2
TimeOffRequestItem Tag
Time Off Request Item
Represents a Time Off Request
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<TimeOffRequestItem
EndDate = Date
[Id = String]
RequestFor = String
StartDate = Date
[<Comments>
<Comment>*
</Comments>]
<Employee>
<PersonIdentity>
</Employee>
</TimeOffRequestItem>

Chapter 2
Comments
Comments
A list of comments
Optional
Introduced in v6.1
CreatedByUser
Created By User
The user that created the request
Type: String
Output only
CreationDateTime
Creation Date Time
The datetime of the request creation
Type: DateTime
Output only
Introduced in v6.1
Employee
Employee
The employee of the request
Required
Introduced in v6.1
EndDate
End Date
A request end date
Type: Date
Required

Chapter 2

Id
Id
The id of the request
Type: String
Optional
PayCodeName
Pay Code Name
Pay code name
Type: String
Required
Introduced in v6.1
RequestFor
Request For
The request subtype name
Type: String
Required
Introduced in v6.1
The list of status changes
Output only
Introduced in v6.1
StartDate
Start Date
The request start date
Type: Date

Chapter 2
Required
StatusName
Status Name
The status of a request
Type: String
Output only
Sample values:
DRAFT, APPROVED
Introduced in v6.1

Chapter 2
TimeOffRule Tag
Time Off Rule
The TimeOffRule tag is a wrapper for the TimeOffRule business object.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"RetrieveAll" |
"Update"
Parameters→
None
Properties→
<TimeOffRule
[AverageCalcGrace = TimeDuration]
[AverageCalcRound = TimeDuration]
[AverageFixAmount = String]
[AverageType = String]
[MaxTimeOff = TimeDuration]
[MinTimeOff = TimeDuration]
[MultiShiftOption = String]
Name = String
ShiftRuleName = String
[ShiftSourceType = String] >
</TimeOffRule>

Chapter 2
Action Descriptions
AddOnly
This is the Action to add a new TimeOffRule.
Properties other than Name and ShiftRuleName will be defaulted.
Required Properties: Name, ShiftRuleName
Introduced in v6.1
Delete
This is the Action to delete an existing TimeOffRule
Optional Properties: no other properties are necessary
Introduced in v6.1
RetrieveAll
This is the Action to retrieve all existing TimeOffRule business objects.
Return Value Type: Zero or more TimeOffRule tags
Introduced in v6.1
RetrieveAllNames
This is the Action to retrieve a list of all of the named objects.

Chapter 2

Introduced in v6.1
RetrieveForUpdate
This is the Action to retrieve an existing TimeOffRule object by name
Return Value Type: TimeOffRule tag
Introduced in v6.1
Update
This is the action to update an exiting TimeOffRule. If it does not exits, it will be
added.
Optional Properties: Properties other than Name and ShiftRuleName will be
defaulted.
Introduced in v6.1
AverageCalcGrace
Average calculated grace
This is the grace amount for the average shift rounding.
Type: TimeDuration
Optional
0:00 is the minimum value 99.59 is the maximum value.
Sample values:
0:00

Chapter 2
Default value: 0:00

Introduced in v6.1
AverageCalcRound
Average calculated rounding
This is the property for the rounding of the average shift.
Type: TimeDuration
Optional
0:01 is the minimum value 99.59 is the maximum value. Round must be greater
than the grace.
Sample values:
0:01
Default value: 0:01

Introduced in v6.1
AverageFixAmount
Average fix amount
This is the fixed number value used for the average type.
Type: String
Optional
This must be a positive value between 0.0 and 1000000.0. 6 decimal places are
supported by the database.
Sample values:
1.25
Introduced in v6.1
AverageType
Average type
This is the character representing the average type.
Type: String

Chapter 2
Optional
This is actually a character. Valid Characters are C, D or F are valid.
Sample values:
S for qualified shifts, D for qualified days, F for
fixed number
Introduced in v6.1
Description
Description
This is the description for the Time Off Rule.
Type: String
Optional
Maximum length of desc is 250.
Introduced in v6.1
MaxTimeOff
Maximum time off
This is the maximum time off value.
Type: TimeDuration
Optional
0:00 is the minimum value 99.59 is the maximum value. This must be greater than
the MinTimeOff property.
Sample values:
99:59
Default value: 99:59

Introduced in v6.1
MinTimeOff
Minimum time off
This is the minimum time off value.

Chapter 2
Type: TimeDuration
Optional
0:00 is the minimum value 99.59 is the maximum value. This must be less than
the MaxTimeOff property.
Sample values:
0:00
Default value: 0:00

Introduced in v6.1
MultiShiftOption
Multiple shift option
This is the character representing the multiple shift option.
Type: String
Optional
This is actually a character. Valid characters are L and S
Sample values:
L for Long, S for Short.
Introduced in v6.1
Name
Name
This is the name of the Time Off Rule.
Type: String
Required
Maximun length is 50 characters.
Introduced in v6.1
ShiftRuleName
Shift rule name
This is the name of the Shift Rule used in the Time Off Rule

Chapter 2
Type: String
Required Key
This must be a valid previously created Shift Rule name. The
WSAContributingShiftRule API must be used before this one to create the Shift
Rules.
Introduced in v6.1
ShiftSourceType
Shift source type
This is the character representing the type of the shift source.
Type: String
Optional
This is actually a character. Valid characters are W, S or C are valid.
Sample values:
W for Worked, C for Contract, S for Scheduled
Introduced in v6.1

Chapter 2
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, worked durations, and totalization output such as per period
summary, per day summaries, and exceptions.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadDailyTotals" |
"LoadPeriodTotals"
Parameters→
None
Properties→
<Timesheet
(TotalsUpToDateFlag = Boolean)
(LastTotalizationDateTime = DateTime)
(ManagerSignoffDateTime = DateTime) >
<Employee>
</Employee>
(<DailyTotals>
<DateTotals>*
</DailyTotals>)
<Period>
<TimeFramePeriod>
</Period>
(<TotaledPayCodeEdits>

Chapter 2
<HistoricalPayCodeEdit> | <HistoricalPayCodeMove> |
<LockedDataCorrection> | <OnCall> | <PayCodeEdit> |
<PayCodeMove> | <Punch>
</TotaledPayCodeEdits>)
(<TotaledWorkedDurations>
<WorkedDuration>*
</TotaledWorkedDurations>)
(<PeriodTotalData>
<PeriodTotals>
</PeriodTotalData>)
(<TotaledSpans>
<TotaledSpan>*
</TotaledSpans>)
(<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
Introduced in v4
LoadDailyTotals
Returns a timesheet whose daily totals contain the most recent totalization for the
specified period and employee.

Chapter 2
Introduced in v4
LoadPeriodTotals
Returns a timesheet whose period totals contain totals for the specified period and
employee.
Introduced in v4
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.
Required
Introduced in v4
LastTotalizationDateTime
Date and time of last totalization
A server timestamp for the most recent totalization.

Chapter 2
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.
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.

Chapter 2
Type: Either HistoricalPayCodeEdit, HistoricalPayCodeMove,

LockedDataCorrection, OnCall, PayCodeEdit, PayCodeMove or Punch tag
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
Timekeeping 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.

Chapter 2
Type: Boolean
Output Only
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

Chapter 2
TipRule Tag
Tip Rule
This tag provides many operations to manage Tip Rules, i.e. to create, read,
update, and delete. Use the EmployeeTipRuleAssignment tag to assign a Tip Rule
to an employee.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"Delete" |
"Retrieve" |
"RetrieveAll" |
"RetrieveByName" |
"Update"
Parameters→
None
Properties→
<TipRule
Name = String >
<RuleVersions>
<RuleVersion>*
</RuleVersions>
</TipRule>
Action Descriptions

Chapter 2
Add
This action will insert a Tip Rule. If the RuleVersions are not supplied, the rule
will be entered with default effective and expiration dates, 1/1/1753 and 1/1/3000,
respectively.
Introduced in v6.1
Delete
The action will delete the Tip Rule with the given name.
Retrieve
Retrieves the Tip Rule information for the given rule Name.
Name must not be null and must be between 1 and 30 characters in length
Return Value Type: TipRule tag
Introduced in v6.1
RetrieveAll
Retrieves all Tip Rules with the detail information on the system.
Return Value Type: Zero or more TipRule tags

Chapter 2
Introduced in v6.1
Retrieves all Tip Rules with the detailed information on the system. Same as
RetrieveAll.
Return Value Type: Zero or more TipRule tags
Introduced in v6.1
RetrieveAllNames
Retrieves all Tip Rule names on the system.
Introduced in v6.1
RetrieveByName
Retrieves the Tip Rule information for the given Name.
Name must not be null and must be between 1 and 30 characters in length
Introduced in v6.1
RetrieveForUpdate
Retrieves the Tip Rule information for a given rule Name. Same as Retrieve or
RetrieveByName actions.
Name must not be null and must be between 1 and 30 characters in length.
Introduced in v6.1

Chapter 2
Update
This action will update a Tip Rule. If the Tip Rule does not exist, the action "Add"
will be performed.
Name must not be null and between 1 and 30 characters
Name
Name
The name of the Tip Rule.
Type: String
Required Key
Must not be null and between 1 and 30 characters
Sample values:
<TipRule Name="Tip 1">

RuleVersions
Rule Versions
A list of revisions of the rule.
Type: Zero or more RuleVersion tags
Required
Sample values:
<RuleVersions>

Chapter 2
<RuleVersion EffectiveDate="01/01/1753"
ExpirationDate="01/01/3000" Description="Tip Version"
>
<Triggers>
<Trigger LaborAccountPattern="102//////701"
Lamps/Line 1/ASSM" JobCodeEffectiveDate="2/06/2008"
SequenceNumber="1" >
<Allocations>
</Allocations>
<PayCodes>
</PayCodes>
</Trigger>
</Triggers>
</RuleVersion>
</RuleVersions>

Chapter 2
TipRuleVersion Tag
Tip Rule Version
Represents a revision of a Tip Rule.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddVersionToRule"
Parameters→
AddVersionToRule→
RuleName = String
Properties→
<TipRuleVersion
[<Triggers>
<Trigger>*
</Triggers>]
</TipRuleVersion>
Action Descriptions
AddVersionToRule
Adds a new version to a Tip Rule.
Required Properties: EffectiveDate, ExpirationDate

Chapter 2

Action Parameters

RuleName Name of the Tip Rule that the action Introduced in v6.1; last changed
applies to. in v6.1
Required
Description
Description
Simple description to describe the revision.
Type: String
Optional
Sample values:
Description="First version"
Introduced in v6.1
EffectiveDate
Effective Date
Type: Date
Required
Sample values:
Introduced in v6.1

Chapter 2
ExpirationDate
Expiration Date
Type: Date
Required
Sample values:
Introduced in v6.1
Triggers
Triggers
Type: Zero or more Trigger tags
Optional
Sample values:
<Triggers>
<Trigger LaborAccountPattern="102////501//702">
<Allocations>
</Allocations>
<PayCodes>
</PayCodes>
</Trigger>
</Triggers>
Introduced in v6.1

Chapter 2
TipTrigger Tag
Tip Rule Trigger
It defines a trigger of a Tip Rule. This tag was created for the AddTriggerToRule
action to specify the exact type of a Total Allocation Rule (i.e. Tip Rule) to which
the trigger will be added.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"DeleteByTrigger" |
Parameters→
AddTriggerToRule→
RuleName = String
DeleteByTrigger→
RuleName = String
RuleName = String
Properties→
<TipTrigger
[JobCode = String]
[SequenceNumber = Long]

Chapter 2
[SequenceNumberToMatch = Long] >

<Allocations>
<Allocation>*
</Allocations>
[<PayCodes>
<SimpleValue>*
</PayCodes>]
[<PayCodesToMatch>
<SimpleValue>*
</PayCodesToMatch>]
</TipTrigger>
Action Descriptions
AddTriggerToRule
Adds a new Trigger to a Tip Rule revision.
Required Properties: LaborAccountPattern, Allocations, SequenceNumber
Action Parameters

RuleName Name of the Tip Rule to add this Introduced in v6.1; last changed
trigger to. in v6.1
Required
VersionEffectiveDate The effective date of a Tip Rule Introduced in v6.1; last changed
version to which the trigger will be in v6.1
added.
Required
Date must be valid.
DeleteByTrigger
Deletes a trigger within a Tip Rule revision.

Chapter 2

Action Parameters

RuleName Name of the Tip Rule where the Introduced in v6.1; last changed
trigger will be deleted. in v6.1
Required
VersionEffectiveDate The effective date of a Tip Rule Introduced in v6.1
version to where the trigger will be
deleted.
Required
Date must be valid.
UpdateOnlyByTrigger
Updates a trigger within a Tip Rule revision.
Introduced in v6.1

Chapter 2
Action Parameters

RuleName Name of the Tip Rule containing the Introduced in v6.1
updated trigger.
Required
VersionEffectiveDate The effective date of a Tip Rule Introduced in v6.1
Required
Date must be valid.
Allocations
Allocations
List of Allocations for a Total Allocation Rule. For a Tip Rule, the list consists of
just one Allocation.
Type: Zero or more Allocation tags
Required
Sample values:
<Allocations>
<Allocation PayCode="Bonus$" RateAmount="12.35"/>
</Allocations>

JobCode
Job Code
Type: String
Optional
Sample values:

Chapter 2
Lamps/Line 1/ASSM"

Type: Date
Optional
Sample values:

JobCodeToMatch
Job Code To Match
must match.
Type: String
Optional
Sample values:

Chapter 2
LaborAccountPattern
Type: String
Required
validated to exist.
Sample values:
LaborAccountPattern="10*//307//501//702"

trigger must match.
Type: String
Optional
validated to exist.
Sample values:

Chapter 2
PayCodes
Pay Codes
paycodes.
Optional
The Pay Codes must be hourly pay codes.
Sample values:
<PayCodes>
</PayCodes>

PayCodesToMatch
Pay Codes To Match
trigger must match.
Optional
Sample values:
<PayCodesToMatch>
</PayCodesToMatch>

SequenceNumber
Sequence Number
display and by a processor for the order in which the triggers are used. For the Tip

Chapter 2
Rule the sequence is not important, but necessary for the database. If the
used, it should be unique.
Type: Long
Optional
Sample values:
SequenceNumber="1"

trigger.
Type: Long
Optional
Sample values:

Chapter 2
To Tag
The Kmail recipient
The person to send the kmail to. This tag appears as a child of the Recipients
property of the EmployeeMessage tag.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<To
Address = String
[PersonKey = String] >
</To>
Address
Kmail address
Email address
Type: String
Required
Introduced in v5.2

Chapter 2
PersonKey
Person key
Person key
Type: String
Optional
Introduced in v5.2
PersonNumber
Person ID
person id
Type: String
Optional
Introduced in v5.2

Chapter 2
TokeRule Tag
Toke Rule
The TokeRule tag allows a toke pool rule to be added, updated or deleted. This tag
also allows retrieval of existing toke pool rules.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"Delete" |
"Retrieve" |
"RetrieveAll" |
"Update"
Parameters→
None
Properties→
<TokeRule
[Name = String] >
[<EffTokeRules>
<EffTokeRule>*
</EffTokeRules>]
</TokeRule>
Action Descriptions

Chapter 2
Add
Adds the toke rule and all associated effective toke rules
Required Properties: Name, EffTokeRules
Introduced in v6.1
Delete
Removes the toke rule and all associated effective toke rules
Introduced in v6.1
Retrieve
Returns the toke rule and associated effective toke rules
Return Value Type: TokeRule tag
Introduced in v6.1
RetrieveAll
Returns all toke rules and their associated efefctive toke rules
Return Value Type: Zero or more TokeRule tags
Introduced in v6.1
Retrieves all toke rules and associated efefctive toke rules
Return Value Type: Zero or more TokeRule tags
Introduced in v6.1

Chapter 2
RetrieveAllNames
Returns a list of all of the toke rule names
Introduced in v6.1
RetrieveForUpdate
Retrieves a tokr rule and associated effective toke rule for updating
Return Value Type: TokeRule tag
Introduced in v6.1
Update
Updates the toke rule and associated effective toke rules
Required Properties: Name, EffTokeRules
Introduced in v6.1
EffTokeRules
Effective Toke Rules list
The effective toke pool rules associated with the toke pool rule.
Type: Zero or more EffTokeRule tags
Optional
Introduced in v6.1
Name
Toke pool rule name
The name of the toke pool rule. This name appears in the Toke Amount Entry
workspace and the People Editor.

Chapter 2
Type: String
Optional
Introduced in v6.1

Chapter 2
TopicParameterDefinition Tag
Sorting and Matching Rule Topic Parameter Definition
Gives access to sorting or matching rule's topic's parameter definitions used in
Priority Scheduling Engine. It is a gold data.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveAll" |
"RetrieveAllNames"
Parameters→
None
Properties→
<TopicParameterDefinition
TopicParameterName = String >
</TopicParameterDefinition>
Action Descriptions
Retrieve
Retrieves the sorting or mathcing rule's topic parameter definition object by
name.
Return Value Type: TopicParameterDefinition tag
Required Properties: TopicParameterName

Chapter 2
Introduced in v6.0
RetrieveAll
Retrieves all sorting or matching rule's topic parameter definition objects.
Return Value Type: Zero or more TopicParameterDefinition tags
Introduced in v6.0
RetrieveAllNames
Retrieves all sorting or matching rule's topic parameter definition objects names.
Introduced in v6.0
TopicParameterName
Topic Parameter Definition Name
Represents the sorting and matching rule's topic parameter defintion name.
Type: String
Required Key
Sample values:
PRIMARY_JOB
Introduced in v6.0

Chapter 2
TopicParameterValue Tag
Sorting and Matching Rule Topic Parameter Value
Gives access to sorting or matching rule's topic parameter values used in Priority
Scheduling Engine.
Introduced in v6.0
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
TopicParameterName = String
Value = String >
</TopicParameterValue>
TopicParameterName
Topic parameter name
Represents the name of a sorting or matching rule topic parameter.
Type: String
Required Key
Introduced in v6.0
Value
Topic parameter value
Represents the value of a sorting or matching rule topic parameter.
Type: String
Required

Chapter 2
Introduced in v6.0

Chapter 2
Total Tag
Total
The Total tag describes a total for a PayCode and LaborAccount pair.
Used by: EmployeeSummary, TotalSummary
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<Total
(AmountInCurrency = Currency)
(LaborAccountDescription = String)
(OrgJobDescription = String)
(LaborAccountName = String)
(LaborAccountId = Long)
(OrgJobName = String)
(OrgJobId = Long)
(PayCodeName = String)
(PayCodeId = Long) >
</Total>
AmountInCurrency
A pay code amount, expressed as a currency
Type: Currency
Output Only

Chapter 2
Introduced in v4
AmountInTime
Type: TimeDuration
Output Only
Introduced in v4
IsCurrencyFlag
pay code.
Type: Boolean
Output Only
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 support personnel only. It is recommended that you use the
labor account name instead.
Type: Long
Output Only
Introduced in v4

Chapter 2
LaborAccountName
Labor account
Name of the labor account to which this amount is applied
Type: String
Output Only
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
Type: Long
Output only
Introduced in v5.0
OrgJobName
Organizational job
The full path of the job in the organization
Type: String
Output only
Introduced in v5.0

Chapter 2
PayCodeId
Pay code ID
The unique identifier of the pay code to which this amount is applied. Intended for
use by 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

Chapter 2
TotalBreakException Tag
Total Break Exceptions
This tag is used to configure the exception rule when the total breaks taken by an
employee in a specified shift are too long or too short.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<TotalBreakException
[LongBreak = TimeDuration]
[OriginalShiftLength = TimeDuration]
[PaidAmount = TimeDuration]
[ShiftLength = TimeDuration]
[ShortBreak = TimeDuration]
[delete = Boolean] >
[<SequencedBreaks>
<SequencedBreak>*
</SequencedBreaks>]
</TotalBreakException>
delete
delete
The "delete" flag is used in combination with the OriginalShiftLength property to
indicate that an existing TotalBreakException record is to be deleted.
The OriginalShiftLength value uniquely identifies the record; if delete is set to

true, the record is deleted.

Chapter 2
Type: Boolean
Optional
LongBreak
Long break
The maximum acceptable total break time (after round/grace) for this shift length.
Type: TimeDuration
Optional
Value cannot be null.Value must be greater than or equal to shortBreak
Sample values:
hh:mm
Default value: 24:00

Introduced in v6.1
OriginalShiftLength
Original Shift Length
OriginalShiftLength is used to edit an existing TotalBreakException record. It
indicates the value of the Shift Length property of the TotalBreakException record
which is to be edited, prior to any changes. Since the Shift Length must be unique
among all TotalBreakExceptions for a given Break Rule, this is sufficient to
uniquely identify any TotalBreakException record.
When OriginalShiftLength is present, any other TotalBreakException properties

that are given are interpreted as new values which will overwrite the old values. If
a TotalBreakException property is not specified, its value is left unchanged.
Type: TimeDuration
Optional

Chapter 2
PaidAmount
PaidAmount
Total break paid amount. This is an alternative to using paid amount for individual
breaks. It specifies the total break time within the shift to be paid as worked time.
Break time in excess of this amount will be deducted from the shift.
Type: TimeDuration
Optional
Introduced in v6.1
SequencedBreaks
Break Sequence
This contains zero or more Sequenced Break components. The order of breaks
within a sequence.
Type: Zero or more SequencedBreak tags
Optional
ShiftLength
Shift length
The shift length to which this break exception applies. A worked shift that is equal
to this length, or greater than this length but less than the next length, would be
applicable to this exception.
Type: TimeDuration
Optional
Value is required if shortBreak <
0:00 or longBreak <
24:00.
Sample values:
hh:mm
Introduced in v6.1

Chapter 2
ShortBreak
Short break
The minimum acceptable total break time (after round/grace) for this shift length.
Type: TimeDuration
Optional
Value cannot be null. Value must be less than or equal to longBreak.
Sample values:
hh:mm
Introduced in v6.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<TotaledScheduledPayCodeEdit
(Date = Date)
(<Comments>
<Comment>*
</Comments>)
</TotaledScheduledPayCodeEdit>
Amount of pay code, expressed as a time duration or a currency.
Type: String
Output Only

Chapter 2

Must be consistent with the given pay code
Introduced in v4
Comments
Comments
A list of comments currently returned with this timekeeping item
Output Only
Introduced in v4
Date
Type: Date
Output Only
Sample values:
Introduced in v4
EnteredOnDate
Date of the edit
Type: Date
Output Only
Introduced in v4
EnteredOnTime
Time of the edit
Type: Time
Output Only

Chapter 2
Introduced in v4
IsCurrencyFlag
pay code.
Type: Boolean
Output Only
Introduced in v4
LaborAccountName
Labor account
totaled amount is being edited.
Type: String
Output Only
PayCodeName
Pay code
Type: String
Output Only
Introduced in v4

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<TotaledScheduledPayCodeEditUneditable
(Date = Date)
(<Comments>
<Comment>*
</Comments>)
</TotaledScheduledPayCodeEditUneditable>
Amount of pay code, expressed as a time duration or a currency
Type: String

Chapter 2
Output Only
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
Output Only
Introduced in v4
CommentText
Comment text
A comment
Type: String
Optional
Introduced in v4
Date
Type: Date
Output Only
Sample values:

Chapter 2
Introduced in v4
EnteredOnDate
Date of the edit
Type: Date
Output Only
Introduced in v4
EnteredOnTime
Time of the edit
Type: Time
Output Only
Introduced in v4
IsCurrencyFlag
False indicates that the pay code represents a monetary item
Type: Boolean
Output Only
Introduced in v4
LaborAccountName
Labor account
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

Chapter 2

PayCodeName
Pay code
Type: String
Output Only
Introduced in v4

Chapter 2
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.
Introduced in v4
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<TotaledScheduledWorkedDuration
(Date = Date)
(ScheduledLaborAccountName = String)
(WorkRuleName = String) >
(<Employee>
</Employee>)
(<Exceptions>
<TimekeepingException>*
</Exceptions>)
</TotaledScheduledWorkedDuration>

Chapter 2
AmountInTime
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
with the time.
Output Only
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

Chapter 2
LaborAccountName
Labor account
The labor account associated with this worked duration. The duration is a transfer
to this labor account.
Type: String
Output Only
Introduced in v4
ScheduledLaborAccountName
Scheduled labor account
The portion of the labor account that is automatically derived from any
corresponding scheduled shift
Type: String
Output Only
Introduced in v4
WorkRuleName
Work rule
A work rule associated with this worked duration. The duration is a transfer to this
work rule.
Type: String
Output Only
Introduced in v4

Chapter 2
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
Introduced in v4
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<TotaledSpan
(LaborAccountName = String) >
(<Exceptions>
</Exceptions>)
(<OutPunch>
<Punch>
</OutPunch>)
(<InPunch>
<Punch>
</InPunch>)
</TotaledSpan>
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.

Chapter 2

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
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

Chapter 2
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
Introduced in v4
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<TotalSummary
(<Totals>
<Total>*
</Totals>)
</TotalSummary>
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
Output only
Introduced in v4

Chapter 2
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.
Introduced in v4
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<Transaction
[TransactionSequence = String] >
</Transaction>
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

Chapter 2
TransferEmployee Tag
Transfer Employee
This tag is used to transfer a segment of an employee's shift to a different labour
account or work rule.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<TransferEmployee
TransferStartTime = Time
[<Comments>
<Comment>
</Comments>]
</TransferEmployee>
Comments
Comments
Comments
Type: Comment tag
Optional
Introduced in v5.1

Chapter 2
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

Chapter 2
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAllJobSeniorityDates" |
"Update"
Parameters→
None
Properties→
<TransferJobSeniorityDate
[LocationOrgNodePath = String]
[SeniorityDate = Date] >
</TransferJobSeniorityDate>
Action Descriptions
Load
Retrieves employee seniority information as of an effective date.

Chapter 2
Required Properties: PersonNumber, LocationOrgNodePath, EffectiveDate

LoadAllJobSeniorityDates
Retrieves employee's all transfer job sets seniority dates as of an effective date.
Return Value Type: Zero or more TransferJobSeniorityDate tags
Required Properties: PersonNumber, EffectiveDate
Introduced in v5.1
Update
Updates employee seniority information.
The LocationOrgNodePath must represent an organizational node.
Required Properties: PersonNumber, LocationOrgNodePath, EffectiveDate,
SeniorityDate
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.

Chapter 2
LocationOrgNodePath
Full path for node location
The full path for the organizational node location
Type: String
Optional
Maximum length: 1000
PersonNumber
Person number
Type: String
Required Key
A job transfer set with OrgJobs should be defined and exist on the given effective
date.
The specified person must have a Workforce Scheduler license.
SeniorityDate
Seniority date
The seniority date of a timekeeping employee. This is a factor for a schedule job
list, in which each job has a seniority date associated with it.
Type: Date
Optional

Chapter 2
TreeNodeType Tag
Organizational Tree Node Type
TheTreeNodeType tag lets you add, delete, or modify a location type for use when
adding new locations to an organizational tree.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"addOnly" |
"checkForReferences" |
"delete" |
"retrieveAllForUpdate" |
"retrieveAllNames" |
"retrieveForUpdate" |
"update"
Parameters→
None
Properties→
<TreeNodeType
Name = String
[NewName = String]
[TreeTypeName = String] >
[<GlsegmentDetail>
<GlsegmentDetail>
</GlsegmentDetail>]
</TreeNodeType>
Action Descriptions

Chapter 2
addOnly
Add new tree node type into organizational map
Optional Properties: Description, TreeTypeName, GlsegmentDetail
Introduced in v6.0
checkForReferences
Check this tree node type is referenced by any tree node
Optional Properties: TreeTypeName
delete
delete the tree node type from the system if it is not referenced.
If there are multiple tree node type mapping to the same labor level definition,
and the to be deleted tree node type is in not in the last position of node type list, it
can't be delted.
Introduced in v6.0
retrieveAllForUpdate
Return all tree node type which can be updated
Return Value Type: Zero or more TreeNodeType tags

Chapter 2
Introduced in v6.0
retrieveAllNames
Return all Names
retrieveForUpdate
Retrun tree node type bean if this tree node type is not referenced by any tree node
Return Value Type: TreeNodeType tag
update
update tree node type
Optional Properties: Description, TreeTypeName, GlsegmentDetail, newName
Introduced in v6.0
Description
Description of Node type
Specify an optional description of the tree location type.
Type: String
Optional

Chapter 2

Sample values:
description

GlsegmentDetail
Glsegment Detail
Specify the labor level segment information when two or more location types map
to the same labor level.
Type: GlsegmentDetail tag
Optional
Introduced in v6.0
Name
Node Type Name
Specify the name of the tree location type.
Type: String
Required
The name must be unique and conform to name property standards. Maximum
length: 30 characters
Sample values:
Division

NewName
Node Type New Name
Specify the new name of the changed location type.
Type: String
Optional
The name must be unique and conform to name property standards. Maximum
length: 30 characters

Chapter 2

TreeTypeName
Organization map name
Specify an optional name of the organizational tree.
Type: String
Optional
Sample values:
Organizational Map

Chapter 2
Trigger Tag
Rule Trigger
Defines a trigger of a Total Allocation Rule.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<Trigger
<Allocations>
<Allocation>*
</Allocations>
[JobCode = String]
[OriginalSequenceNumber = Long]
[SequenceNumber = Long] >
[<PayCodes>
<SimpleValue>*
</PayCodes>]
</Trigger>
Allocations
Allocations
A list of Allocations for a Total Allocation Rule. For a Tip Rule, the list consists
of just one Allocation.
Type: Zero or more Allocation tags
Only one Allocation for a TipRule.

Chapter 2
Sample values:
<Allocations>
<Allocation PayCode="Bonus$" RateAmount="12.35"/>
</Allocations>

JobCode
Job Code
Type: String
Optional
Sample values:
Lamps/Line 1/ASSM"

Type: Date
Optional
Sample values:

Chapter 2
LaborAccountPattern
Type: String
Required
validated to exist.
Sample values:
LaborAccountPattern="1*////501//702"

OriginalSequenceNumber
Original Sequence Number
Specifies the original sequence number used when matching bonuses created in
the previous pay period to the sequence number in the current pay period. This
should only be used for a weekly time period that crosses the pay period divide.
NOTE: Used only for Adjustment Rules.
Type: Long
Optional
Sample values:
OriginalSequenceNumber="1"

PayCodes
Pay Codes
A list of Pay Codes in the Total Allocation Rule trigger. When defined in the
trigger, the Pay Codes are matched against Pay Codes in totals.

Chapter 2
Optional
The Pay Codes must be hourly pay codes.
Sample values:
<PayCodes>
</PayCodes>

SequenceNumber
Sequence Number
display and by a processor for the order in which the triggers are used. For the Tip
Rule the sequence is not important, but necessary for the database. If the
used, it should be unique in a version.
Type: Long
Optional
Sample values:
SequenceNumber="1"

TriggerAllocation
Specifies an Allocation: AdjustmentAllocation is used just for the Adjustment
type of the Total Allocation Rule.
Required
Group includes: Allocations

Chapter 2
TrxDataException Tag
Upload Transaction Exceptions
An erroneous or malformed uploaded transaction.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<TrxDataException
(ApplicationServer = String)
(TableName = String)
(DevFilesID = Double)
(ErrorMessage = String)
(ExceptionID = Integer)
(Category = String)
(TrxData = String)
(TrxDataID = Integer)
(LastUpdate = Time) >
</TrxDataException>
ApplicationServer
ApplicationServer
Application server that created the error.
Type: String
Output only
Introduced in v6.1

Chapter 2
Category
Exception Type
Type or error or failure.
Type: String
Output only
Sample values:
MALFORMED
Introduced in v6.1
DevFilesID
DevFilesID
Database ID of originating file when file is located to WDMDEVFILES
Type: Double
Output only
Introduced in v6.1
ErrorMessage
Error Message
Describes cause of exception.
Type: String
Output only
Introduced in v6.1
ExceptionID
Exception ID
Unique identifier for an exception
Type: Integer
Output only
Introduced in v6.1

Chapter 2
LastUpdate
time of last update
Time of last update to exception.
Type: Time
Output only
Introduced in v6.1
TableName
Database Table
Name of database table that contains the failed transacton.
Type: String
Output only
Sample values:
WDMDEVFILES
Introduced in v6.1
TrxData
Transaction Data
Actual data of failed transaction.
Type: String
Output only
Introduced in v6.1
TrxDataID
TrxDataID
Database ID of originating file when file is located in WDMTRXDATA
Type: Integer
Output only
Introduced in v6.1

Chapter 2
TypeOverride Tag
Override for Punch
The TypeOverride tag identifies the override that can be associated with a punch.
Introduced in v4
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load"
Parameters→
None
Properties→
<TypeOverride
(OverrideRuleName = String) >
</TypeOverride>
Action Descriptions
Load
Returns information for each punch type override defined in the system.
Return Value Type: Zero or more TypeOverride tags
Introduced in v4

Chapter 2
OverrideRuleName
Override type name
The name of an override type that can be associated with a punch
Type: String
Output Only
Sample values:
New Shift, In Punch, Out Punch
Introduced in v4

Chapter 2
UnderCoverageSpan Tag
Schedule Assignments Undercoverage Period
Describes an undercoverage period within AssignmentDispatchEngine API
response.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<UnderCoverageSpan
(Duration = TimeDuration)
(EndTime = Time)
(StartTime = Time)
(EndDayNumber = Integer)
(OrgJobPath = String)
(StartDayNumber = Integer) >
</UnderCoverageSpan>
Duration
Coverage Duration
Duration of coverage span in hours.
Type: TimeDuration
Output only
Sample values:
Duration="1:00"

Chapter 2

EndDayNumber
End Day Number
Reference day of span end, relative to start reference days. If satart and end time
of the span are both on the same day, EndDayNumber="1"; if the end time is on
the next day, EndDayNumber="2"; etc.
Type: Integer
Output only
Sample values:
EndDayNumber="2"

EndTime
Coverage End Time
End of the coverage span.
Type: Time
Output only
Sample values:
EndTime="3:00PM"

OrgJobPath
Job Path
Ful path to org. job
Type: String
Output only
Sample values:
OrgJobPath="Organization/Hospitals/Hosp A/Floor 1/ER/
RN"

Chapter 2

StartDayNumber
Start Day Number
Reference number for start day. Always 1.
Type: Integer
Output only
Sample values:
StartDayNumber="1"

StartTime
Coverage Start Time
Start time of the coverage span.
Type: Time
Output only
Sample values:
StartTime="3:00PM"

Chapter 2
User Tag
User
The User tag contains user account and related information.
See the validation rules for the PersonIdentity, PasswordHistory, UserAccount,
and UserAccountLockout tags.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadUserAccount"
Parameters→
None
Properties→
<User
[<CurrencyAssignment>
<UserCurrencyAssignment>
</CurrencyAssignment>]
<Identity>
</Identity>
(<PasswordHistories>
<PasswordHistory>*
</PasswordHistories>)
[<UserAccountData>
<UserAccount>
</UserAccountData>]
(<UserAccountLockouts>

Chapter 2
<UserAccountLockout>*
</UserAccountLockouts>)
</User>
Action Descriptions
Load
Returns the user account, password history, and lockout information for the
specified person.
Return Value Type: User tag
Introduced in v4
LoadUserAccount
Returns user account information for the specified person.
Return Value Type: UserAccount tag
Introduced in v4
CurrencyAssignment
Currency Assignment
User's currency assignment contains currency code and currency locale
information.
Type: UserCurrencyAssignment tag
Optional
Introduced in v6.1

Chapter 2
Identity
Identity
Required Key
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

Chapter 2
UserAccount Tag
User Account
The UserAccount tag returns logon information for the specified person;
including the user's username and password.
Used by: HyperFindResult, User
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<UserAccount
[RecordManagerLockoutFlag = Boolean]
[PasswordUpdateFlag = Boolean]
(PasswordUpdatedDateTime = DateTime)
(LockoutResetDateTime = DateTime)
[LogonProfileName = String]
(ConsecutiveBadLogons = Long)
[UserName = String]
[UserPassword = Password] >
</UserAccount>
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

Chapter 2

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
LogonProfileName
Name of logon profile for the user
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.
• Default
• Background Processor
• DCM Super Access
• Event Manager
• HR- Payroll
• MobileTime
• RecordManager- IS
• Super Access
• TeleTime Logon
• XML
•
Type: String
Optional

Chapter 2
Default value: &DEFAULT_LOGON

PasswordUpdatedDateTime
Date and time of last password update
Date and time that the password was last updated
Type: DateTime
Output Only
Introduced in v4
PasswordUpdateFlag
Change password?
Indicates whether the user must change the password the next time he or she logs
on.
The value can be:
• False if no password change is required
• True if a password change is required
Type: Boolean
Optional
Introduced in v4
RecordManagerLockoutFlag
Access to archive databases
Boolean value that, when true (the default), indicates that the user account will not
have access to the target system after the Record Management system has copied
data to it. If false, the user account will be able to access the target database.
Type: Boolean
Optional
This property can only be used if you have the Record Management system
installed.
Default value: True

Chapter 2

Introduced in v5.0
UserName
User name
This is the user name that allows the user to access the timekeeper system. A
unique logon name is required.
If your system uses authorization that is external to timekeeping, such as the
Windows NT or Lightweight Directory Access Protocol (LDAP), the UserName
must match the logon name for the authorization protocol.
Type: String
Optional
Must be unique for the user for all user accounts, regardless of whether they are
active, inactive, or terminated.
Required: When adding a new user.
Introduced in v4
UserPassword
User password
The user's password must be specified if UserName is specified.
Type: Password
Optional
Do not use an encrypted value for input. However, for output, the value is
encrypted.
Required: When adding a new user
Do not specify: For an existing user

Chapter 2
UserAccountLockout Tag
User Account Lockout
The UserAccountLockout tag returns the date and reason for a user being locked
out of the system.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<UserAccountLockout
(EffectiveDateTime = DateTime)
(LockoutReasonName = String) >
</UserAccountLockout>
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
• 1 for Inactivity Lockout

Chapter 2
• 2 for Password Lockout

• 3 for Maintenance Lockout
Type: String
Output Only
2Password Lockout
3Maintenance Lockout

Chapter 2
UserAccountStatus Tag
User Account Status
The UserAccountStatus tag sets a user's account status to be active or inactive.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadUserAccountStatuses"
Parameters→
None
Properties→
<UserAccountStatus
UserAccountStatusName = String
[ExpirationDate = Date] >
<Identity>
</Identity>
[<Period>
<TimeFramePeriod>
</Period>]
</UserAccountStatus>
Action Descriptions

Chapter 2
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
Introduced in v5.0
EffectiveDate
Date the user account becomes effective
The date when the user account becomes effective
Type: Date
Optional
Default value: The current system date
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.

Chapter 2

Introduced in v4
Identity
Identity
Optional Key
Introduced in v5.0
Period
Time period
The period of time associated with the user account statuses.
Optional
The time frame must evaluate to a span of time. The specified identity shall be
used when the time frame requires an association with a person.
Used for the LoadUserAccountStatuses action.
Introduced in v5.0
UserAccountStatusName
Account status of the user
The User Status column contains a value indicating the status of the user.
• 0 if not applicable
• 1if active
• 2 if inactive
• 3 if terminated
Type: String

Chapter 2
Required
Introduced in v4

Chapter 2
UserCurrencyAssignment Tag
User Currency Assignment
This is for a user's currency assignment. It contains the currency code and
currency locale information that the user will be using.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<UserCurrencyAssignment
CurrencyLocale = String >
</UserCurrencyAssignment>
CurrencyCode
Currency Code
The currency code that a person or a user will be using. For example: "USD".
Type: String
Required
Introduced in v6.1
CurrencyLocale
Currency Locale
The currency locale a person or a user will be using. For example: "en-US". The
locale is constructed with a language code and a country code.
Type: String

Chapter 2
Required
Introduced in v6.1

Chapter 2
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.
Introduced in v5.0a; last changed in v5.1
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Approve" |
"Load" |
"LoadByBidGroupItem" |
"Reject"
Parameters→
None
Properties→
<VacationBid
EndDate = DateTime
[BidGroupItemId = Long]
[Priority = Integer]
StartDate = DateTime
(Status = String)
CreateOpenShift = Boolean
HoursPerDay = TimeDuration
BidId = Long >
[<BidNotes>
<BidNote>*
</BidNotes>]

Chapter 2
</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.
Required Properties: BidId, CreateOpenShift
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
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
Reject
Rejects the vacation bid specified by the vacation bid id.

Chapter 2
For the Reject Action, the BidId property MUST be specified.

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:
11:48:56" HoursPerDay="288000"
</VacationBid>

BidId
Vacation Bid ID
BidId uniquely identifies a row in the WMPVACATIONBID table, which
contains information about vacation bids.
Type: Long
Required Key
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

Chapter 2
property MUST be defined for the ApplyBidNotes, DeleteBidNotes,

BidGroupItem RemoveBids Actions.
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>

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.
Sample values:
"true" or "false"

Chapter 2

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"

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"

Priority
Bid Priority
Specifies the priority of a bid, also know as the bid rank.
Type: Integer

Chapter 2
Optional
Priority cannot be less than 1. Required when adding vacation bids
Sample values:
11:48:56" HoursPerDay="288000"
</VacationBid>

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"

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.
Sample values:
Submitted - 0, Approved - 1, Rejected - 2

Chapter 2
Enumerated value: Submitted - 0, Approved - 1, Rejected - 2


Chapter 2
VolumeDataItem Tag
Volume data for a location and date
This tag is used to hold information about the volume data for a specific location
and a specific date.
Introduced in v6.0
Syntax
None

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAllWageProfiles" |
"LoadById"
Parameters→
None
Properties→
<WageProfile
[WageProfileId = Integer]
[WageProfileName = String] >
</WageProfile>
Action Descriptions
Load
Returns a wage profile, based on WageProfileName.

Chapter 2
Return Value Type: WageProfile tag

Required Properties: WageProfileName
Introduced in v4
LoadAllWageProfiles
Returns a list of all wage profiles in the system.
Return Value Type: Zero or more WageProfile tags
Introduced in v4
LoadById
Returns a wage profile, based on WageProfileID.
ID must be valid
Return Value Type: WageProfile tag
Required Properties: WageProfileID
Introduced in v4
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

Chapter 2
Type: String
Optional
Introduced in v4

Chapter 2
WeekDay Tag
Week Day
The WeekDay tag provides information about a week day as defined in the
system.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAll"
Parameters→
None
Properties→
<WeekDay
Name = String >
</WeekDay>
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

Chapter 2
Introduced in v5.0
LoadAll
Returns all weekday information in the system.
No properties can be specified.
Return Value Type: Zero or more WeekDay tags
Introduced in v5.0
Description
Description
The localized description of the week day. This value is used as the display name
in the user interface.
Type: String
Optional Key
Introduced in v5.0
Name
Week day name
A day of the week
Type: String
Optional Key
You must use the English name for the day, even if your application server is
configured to use a different national language.
Enumerated value: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday,
Saturday
Introduced in v5.0

Chapter 2
WFCGenie Tag
Retrieve data
This tag is used to retrieve a list of the querieis that return a summary of key
information for multiple employees for the specified user, or to retrieve all queries
that the specified user is allowed to run.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAllGenies" |
"LoadMetadata"
Parameters→
None
Properties→
<WFCGenie
HyperFindQueryName = String
GenieName = String
[GenieType = String] >
[<GenieColumns>
<GenieColumn>
</GenieColumns>]
<Period>
<TimeFramePeriod>
</Period>
<Identity>
<PersonIdentity>*
</Identity>
[<GenieRows>
<GenieRow>

Chapter 2
</GenieRows>]
</WFCGenie>
Action Descriptions
Load
Returns the data and metadata for the specified item for the specified HyperFind
query and date span
Return Value Type: (***undefined***): Genie
Required Properties: GenieName
Introduced in v5.2
LoadAllGenies
Returns the names of all items for the specified user.
Introduced in v5.2
LoadMetadata
Returns only the metadata for the specified item.
Required Properties: GenieName
Introduced in v5.2
GenieColumns
Column data
Column metadata returned. Present only in a Load or LoadMetadata response.

Chapter 2
Type: GenieColumn tag

Optional
GenieName
Name
The name of the item to load. Required in a Load or LoadMetadata request; must
be omitted in a LoadAllGenies request.
Type: String
Required
The name must match a valid name found in the Display Profiles for the specified
user.
Introduced in v5.2
GenieRows
Rows
Row data returned. Present only in a Load response.
Type: GenieRow tag
Optional
Introduced in v5.2
GenieType
Type
The type can be Detail, Roll-Up, or Multi-row. Present only in a Load or
LoadMetadata response.
Type: String
Optional
Introduced in v5.2
HyperFindQueryName
HyperFind Query Name
The HyperFind query to use in retrieving the data. Required in a Load request;
must be omitted in a LoadAllGenies or LoadMetadata request.

Chapter 2
Type: String
Required
The names of HyperFind queries can be found in the timekeepingl user interface.
Identity
Person Identity
List of persons to be used, instead of a HyperFind query, in retrieving the data.
Required in a Load request; must be omitted in a LoadAllGenies or LoadMetadata
request.
Required
Period
Period
The time frame used to execute the HyperFind query. Required in a Load request;
must be omitted in a LoadAllGenies request.
Required
Must evaluate to a span of time.
Introduced in v5.2

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"LoadByName" |
"UpdateOnly"
Parameters→
None
Properties→
<WfcJob
[JobTitle = String]
[LLEDesc = String]
[InActiveSw = Boolean]
[JobCode = String]
[WfcJobDesc = String]
WfcJobName = String
[LLEName = String]
[WfcJobNewName = String]
[SortOrder = Long] >
</WfcJob>
Action Descriptions

Chapter 2
AddOnly
Adds a new job to the job hierarchy.
Required Properties: WfcJobName
Optional Properties: WfcJobDesc, JobCode, JobTitle, LLEName, LLEDesc,
InActiveSw, SortOrder
Delete
Marks an existing job for deletion.
LoadByName
Returns information for a job with the specified name.
Return Value Type: WfcJob tag
UpdateOnly
Updates an existing job.
Optional Properties: WfcJobDesc, JobCode, JobTitle, LLEName, LLEDesc,
InActiveSw, SortOrder, WfcJobNewName

Chapter 2
InActiveSw
Is the job inactive?
Indicates whether the job is inactive
Type: Boolean
Optional
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
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
LLEDesc
Description of labor level entry
The description of the labor level entry for the specified job
Type: String

Chapter 2
Optional
LLEName
Labor level entry mapped to job
The name of the labor level entry that is mapped to the specified job.
Type: String
Optional
Required: If the job location type matches a labor level
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
Use only integers that are greater than zero.
WfcJobDesc
Job description
The description for the specified job
Type: String
Optional

Chapter 2
WfcJobName
Job name
Job name
Type: String
Required
Must conform to the name property standards
WfcJobNewName
New name for job
The new job name for an existing job.
Used only for the Update action.
Type: String
Optional

Chapter 2
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
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddComment" |
"AddOnly" |
"Delete"
Parameters→
AddOnly→
Properties→
<WorkedDuration
OrgJobName = String
OrgJobId = String
Date = Date
[ScheduledLaborAccountName = String]
[NewShiftOverrideFlag = Boolean]
[StartTime = Time]

Chapter 2
[<Notes>
<Note>*
</Notes>]
(<Comments>
<Comment>*
</Comments>)
<Employee>
</Employee>
(<Exceptions>
</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:
• LaborAccountName
• WorkRuleName
Required Properties: AmountInTime, Date, Employee, CommentText
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

Chapter 2

Introduced in v4
Action Parameters

Optional
Optional used
of this tag.
Optional
Delete
Marks for deletion all worked durations for the employee and the work duration.
Required Properties: AmountInTime, Date, Employee
Introduced in v4
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.

Chapter 2

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
exist in the organizational structure
Default value: null
Introduced in v5.0
OrgJobId
Organizational job ID
Type: String
Default value: Null
Introduced in v5.0
AmountInTime
Amount of time worked, in time
The amount of time to be added or deleted, expressed as a duration.
Type: TimeDuration
Required
Comments
Comments
The set of comments that are associated with worked durations in the timesheet.
Output Only
Introduced in v4

Chapter 2
CommentText
Comment text
A text string that is attached to the pay code amount or totaled amount.
Type: String
Optional
Introduced in v4
Date
Effective date
The date for which the added or deleted time duration is to be posted.
Type: Date
Required, Key
Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, who is to be
credited with the time.
Required, Key
Introduced in v4
EnteredOnDate
Date of the entry for worked time
The date on which this duration was added to the database
Type: Date
Output Only

Chapter 2
Introduced in v4
EnteredOnTime
Time of the entry for worked time
The time at which this duration was added to the database
Type: Time
Output Only
Introduced in v4
Exceptions
Exceptions
A list of timekeeping exceptions.
Dependency: Returned only when the WorkedDuration is returned as part of a the
Timesheet tag, and only if the most recent totalization detected a timekeeping
exception for this worked duration.
Output Only
Introduced in v4
LaborAccountName
Labor account
The name of the labor account
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
Type: String
Optional
Introduced in v4

Chapter 2
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
Introduced in v4
Notes
Comment notes
The list of notes for the comment to be created with the comment text
Optional
Introduced in v6.0
PayCodeName
Pay code name
Name of Named Duration
Type: String
Optional
Must be a valid Named Duration as defined in Pay Code definition. When a Pay
code name is included, a start time must be included as well.
Introduced in v6.1
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.

Chapter 2
Type: String
Optional
StartTime
Start time
Start time of the worked duration. If a worked duration is a named duration and is
based on an employees scheduled or contract start time, the Start Time is not
required.
Type: Time
Optional
Must be a valid Kronos Ktime value. When a start time is included with the
request, a Pay code name must be included as well
Sample values:
7:45AM
Introduced in v6.1
WorkRuleName
Work rule
The work rule for which the amount is being applied. If left blank, the employee's
default work rule is used.
• &ALL_WORK_RULES
• &EMPTY
Type: String
Optional
You can find values in the Timekeeping Application.

Chapter 2

OrgJob
Organization Job Name or ID: If ID exists, Name is ignored.
Optional
Group includes: OrgJobName, OrgJobId

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"AddOnly" |
"Delete" |
"Load" |
"LoadAll" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<WorkerType
Name = String >
<WorkerTypeElements>
<WorkerTypeElement>*
</WorkerTypeElements>
</WorkerType>
Action Descriptions

Chapter 2
AddOnly
Adds a new worker type to the database.
Required Properties: WorkerTypeElements
Delete
Marks a worker type record for deletion.
This worker type must exist
Load
Returns the specified worker type.
The worker type must exist
Return Value Type: WorkerType tag
LoadAll
Returns all available worker types.
Return Value Type: Zero or more WorkerType tags
Introduced in v5.0
RetrieveAllNames
Returns the names of all worker types (SDM-required action).

Chapter 2

Introduced in v5.1
RetrieveForUpdate
Returns the specified worker type (SDM-required action).
Return Value Type: WorkerType tag
Update
Adds a new worker type or updates an existing one.
UpdateOnly
Updates an existing worker type value.
Name
Worker Type
The name of the worker type.
Type: String
Optional Key

Chapter 2
Sample values:
Full Time, Part Time, Per Diem
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: Zero or more WorkerTypeElement tags
Required

Chapter 2
WorkerTypeElement Tag
WorkerType Elements
The WorkerTypeElement tag defines a worker type. It is used by WorkerType tag.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<WorkerTypeElement
NewName = String
WorkerTypeName = String >
</WorkerTypeElement>
IsActive
Is worker type active?
Specifies whether the worker type is active. If True, it is active.
Type: Boolean
Optional
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.

Chapter 2
Type: String
Optional Key
Introduced in v5.0
WorkerTypeName
Worker type name
The name of the worker type
Type: String
Required Key
Sample values:
Full Time, Part Time, Per Diem
Introduced in v5.0

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"UpdateOnly"
Parameters→
None
Properties→
<WorkflowAccessAssignment
[EmployeeWorkflowProfileName = String]
[ManagerWorkflowProfileName = String] >
<Identity>
</Identity>
</WorkflowAccessAssignment>
Action Descriptions

Chapter 2
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 specified 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
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.
Required Properties: Identity, Either EmployeeWorkflowProfileName and/or
ManagerWorkflowProfileName
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

Chapter 2
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.
Sample values:
EmployeeWorkflowProfileName="All Process Templates"

Identity
Identity
Identifies the subject person. The Identity property MUST be specified for the
UpdateOnly and Load Actions.
Required Key
If the Identity property is defined for an action, the Identity property cannot be
null. The Person or the Person Number must already exist in the database, before
assigning the process profile(s).
Sample values:
<Identity>
<PersonIdentity PersonNumber="207"> </PersonIdentity>
</Identity>

ManagerWorkflowProfileName
Process profile for managers
Name of the manager process profile. The ManagerWorkflowProfileName must
be specified as a property for the UpdateOnly Action, if you wish to assign a
specific process profile name as the manager process profile.
Type: String
Optional
If the ManagerWorkflowProfileName property is defined for an action, the
ManagerWorkflowProfileName cannot be null. The ManagerWorkProfileName

Chapter 2
must be assigned a string value of a process profile name that already exists in the
database.
Sample values:
ManagerWorkflowProfileName="All Process Templates"

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveAllCategories"
Parameters→
None
Properties→
<WorkflowTemplateCategory
Id = Long
Name = String
Originator = Integer >
</WorkflowTemplateCategory>
Action Descriptions
RetrieveAllCategories
This action returns a list of the template categories.
Return Value Type: WorkflowTemplateCategory tag

Chapter 2
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 Key
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 Originator 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

Chapter 2
The Category Originator must be either 0 or 1.

Sample values:
0, 1
Introduced in v5.1

Chapter 2
WorkHourDef Tag
Work Hours Definition
WorkHourDef contains the rules for employment terms.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<WorkHourDef
[contractShift = Boolean]
DatePatternName = String
[PayCode = String]
[amount = Integer]
[UseInGenie = Boolean] >
</WorkHourDef>
amount
Threshold amount
The amount of the threshold.
Type: Integer
Optional
Introduced in v6.1
contractShift
Contract shift
ContractShift indicates that an employee's contract schedule is to be used to
determine the target amount for the period definition.

Chapter 2
Type: Boolean
Optional
If this is true 'pay code' is required, otherwise 'amount' is required.
Introduced in v6.1
DatePatternName
Date pattern name
The name of a date pattern.
Type: String
Optional Key
It must be a valid date pattern name.
Introduced in v6.1
PayCode
Pay code
The pay code.
Type: String
Optional
PayCode is required if either include in averaging or get target amount from
contract schedule is true, otherwise optional. Only hours paycodes are allowed.
Introduced in v6.1
UseInGenie
Use in Genie
Include in Averaging Genie is true, if UseInGenie is set to True.
Type: Boolean
Optional
If 'UseInGenie' is set to 'True,' 'Pay code' is required.
Introduced in v6.1

Chapter 2
WorkloadAuditItem Tag
Workload Audit Record
This tag contains workload information for an audit.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<WorkloadAuditItem
(Action = String)
(Date = Date)
(Job = String)
(New = String)
(Old = String)
(Span = String)
(SpanType = String)
(Type = String)
(User = String) >
</WorkloadAuditItem>
Action
Action
The audited action
Type: String
Output only
Sample values:

Chapter 2
CREATE, DELETE
Introduced in v6.1
DataSource
Data Source
The functional area
Type: String
Output only
Sample values:

Date
Date
The date of the audited workload segment
Type: Date
Output only
Introduced in v6.1
EditDateTime
Edit Date Time
The edit date time of the audit
Type: DateTime
Output only
Job
Job
The job of the audited workload segment
Type: String
Output only

Chapter 2
Introduced in v6.1
New
New
The new value of the audited workload segment
Type: String
Output only
Introduced in v6.1
Old
Old
The old value of the audited workload segment
Type: String
Output only
Introduced in v6.1
Span
Span
The span of the audited workload segment
Type: String
Output only
Sample values:
eves, days
Introduced in v6.1
SpanType
Span Type
The span type of the audited workload segment
Type: String
Output only
Sample values:
By Shift, By Schedule Zone

Chapter 2

Type
Type
The plan type of the audited workload segment
Type: String
Output only
Sample values:
Baseline, Adjusted
Introduced in v6.1
User
User
The audited user
Type: String
Output only
Sample values:
Introduced in v6.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"LoadAllWorkRules"
Parameters→
None
Properties→
<WorkRule
(ManagerHasAccessFlag = Boolean)
(ProfessionalHasAccessFlag = Boolean)
(WorkRuleName = String) >
</WorkRule>
Action Descriptions
LoadAllWorkRules
Returns a list of all work rules in the system

Chapter 2
Return Value Type: Zero or more WorkRule tags

Introduced in v4
ManagerHasAccessFlag
Do managers have access?
Boolean value that indicates, when True, that a manager can access the work rule.
Type: Boolean
Output Only
ProfessionalHasAccessFlag
Do professionals have access?
Boolean value that indicates, when True, that employees can access the work rule.
Type: Boolean
Output Only
WorkRuleName
Work rule name
Name of the work rule. The name is case-insensitive and must be unique.
Type: String
Output Only
Introduced in v4

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Load" |
"LoadAllWorkRuleProfiles" |
"LoadById"
Parameters→
None
Properties→
<WorkRuleProfile
[WorkRuleProfileId = Integer]
[WorkRuleProfileName = String] >
</WorkRuleProfile>
Action Descriptions
Load
Returns a work rule profile, based on WorkruleProfileName.

Chapter 2

Return Value Type: WorkRuleProfile tag
Required Properties: WorkruleProfileName
Introduced in v4
LoadAllWorkRuleProfiles
Returns a list of all work rule profiles in the system.
Return Value Type: Zero or more WorkRuleProfile tags
Introduced in v4
LoadById
Returns a work rule profile, based on WorkruleProfileID.
ID should be valid
Return Value Type: WorkRuleProfile tag
Required Properties: WorkruleProfileID
Introduced in v4
WorkRuleProfileId
Id of work rule profile
Uniquely identifies the work rule data access profile in the database
Type: Integer
Optional
Introduced in v4

Chapter 2
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

Chapter 2
WorkWeek Tag
Work week definition
Defines the work week as it applies to scheduling. For example, work week
definitions specify certain days as not counting towards weekly scheduling limits.
These days, referred to as outside days, are usually defined by retail union rules.
Work week definitions are assigned to employee schedule rule sets. Work week
definitions apply to employees through the employees' rule set.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"GetOutsideDates" |
"Retrieve" |
"Update"
Parameters→
GetOutsideDates→
EndDate = Date
StartDate = Date
Update→
[NewName = String]
Properties→
<WorkWeek
[Active = Boolean]

Chapter 2
Name = String >

[<WorkWeekDays>
<WorkWeekDay>*
</WorkWeekDays>]
</WorkWeek>
Action Descriptions
Delete
Deletes the named work week from the database, it it exists
None
Introduced in v6.0
GetOutsideDates
Generates all dates outside the work week for the given person number within the
given date range
Return Value Type: Date list
Introduced in v6.0

Chapter 2
Action Parameters

EndDate The end date identifies the last date of Introduced in v999; last changed
a date range. The end date will be in v999
included in the date range.
Required
An error will be generated for invalid
dates
PersonNumber The person number is the unique WFC Introduced in v999; last changed
identification string for an employee in v999
in the WFC database. Every customer
may have a different format for person
numbers.
Required
An error is generated if the given
person is not found in the database
StartDate The start date identifies the first date Introduced in v999; last changed
of a date range. The start date will be in v999
included in the date range.
Required
An error will be generated for invalid
dates
Retrieve
Retrieves the WorkWeek with the given name from the system
Name must not be empty
Return Value Type: WorkWeek tag
Introduced in v6.0
RetrieveAllNames
Provides the names of all work weeks in the system

Chapter 2

Introduced in v6.0
RetrieveForUpdate
Retrieves a WorkWeek with the given name, suitable for updating
The name must be non-null and not empty
Return Value Type: Zero or more WorkWeek tags
Introduced in v6.0
Update
Creates or replaces the WorkWeek with the given name
Name must not be empty
Introduced in v6.0
Action Parameters

NewName Specifies a new name for the given Introduced in v999; last changed
work week. in v999
Optional
NewName must not be empty.
Active
Display work week by default?
Describes whether the work week is displayed by default in the work week editor.
Work weeks that are no longer in use should be set inactive.

Chapter 2
Type: Boolean
Optional
None
Sample values:
<Active> false</Active>
Default value: true

Description
Description of work week
The description of the work week. The description appears in the work week
editor.
Type: String
Optional
None
Sample values:
Work week definition for seniority contract CGW, full
time deli dept.

Name
Name of work week
The unique name of the work week definition, used to identify and retrieve the
API object.
Type: String
Required Key
An error occurs if the name is empty
Sample values:
WW CGW FT deli

Chapter 2

WorkWeekDays
Special days/dates in work week
A list of weekdays and dates considered to be special for scheduling purposes.
Type: Zero or more WorkWeekDay tags
Optional
None
Sample values:
<WorkWeekDays>
<WorkWeekDay> <DayOfWeek> Sunday</DayOfWeek> </
WorkWeekDay>
<WorkWeekDay> <Date> 12/25/2006</Date> </WorkWeekDay>
</WorkWeekDays>
Default value: Empty


Chapter 2
WorkWeekAssignments Tag
Work week rule set assignments
Links a work week to one or more employee rule sets
An employee rule set cannot be assigned to more than one work week.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"Update"
Parameters→
None
Properties→
<WorkWeekAssignments
WorkWeekName = String >
<EmployeeRuleSets>
<EmployeeRuleSet>*
</EmployeeRuleSets>
</WorkWeekAssignments>
Action Descriptions
Delete
Deletes all of the rule set assignments to this work week

Chapter 2

Introduced in v6.0
Retrieve
Retrieves all work week assignments to the work week with the given work week
name
Return Value Type: WorkWeekAssignments tag
Introduced in v6.0
RetrieveAllNames
Returns all of the work week names
Introduced in v6.0
RetrieveForUpdate
The assignments for the work week with the given name
Return Value Type: WorkWeekAssignments tag
Introduced in v6.0
Update
Creates or updates the work week assignment in the system
Required Properties: Name, EmployeeRuleSets
Introduced in v6.0

Chapter 2
EmployeeRuleSets
Employee rule set names
The rule sets assigned to the parent work week.
Type: Zero or more EmployeeRuleSet tags
Required
Sample values:
<EmployeeRuleSets>
<RuleSet Name="QaERuleSet02"/>
<RuleSet Name="QaERuleSet02"/>
</EmployeeRuleSets>

WorkWeekName
Name of work week
The name of the work week to which the assignment is made.
Type: String
Required
Sample values:
<WorkWeekAssignments WorkWeekName="Qa002">

Chapter 2
WorkWeekDay Tag
Work week day
A special weekday or a date that has special scheduling properties. For example,
work done on a certain weekday or date may be excluded from the usual weekly
scheduling constraints such as maximum hours worked per week.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WorkWeekDay
DayOfWeek = String
Date = Date
[CountsTowardMaxDaysPerWeek = Boolean]
[CountsTowardMaxHoursPerWeek = Boolean]
[CountsTowardMinHoursPerWeek = Boolean] >
</WorkWeekDay>
Action Descriptions
Update
Updates a WorkWeekDay object into the system.
Required Properties: DayOfWeek, Date,

Chapter 2
Optional Properties: CountsTowardMaxDaysPerWeek,

CountsTowardMaxHoursPerWeek, CountsTowardMinHoursPerWeek
Introduced in v6.0
DayOfWeek
A day of the week
A day of the week. Either DayOfWeek or Date must be specified in a
WorkWeekDay.
Type: String
Sample values:
<WorkWeekDay> <DayOfWeek> Friday</DayOfWeek> </
WorkWeekDay>
Enumerated value: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday,

Sunday
Date
Calendar date
A specific date. Either Date or DayOfWeek must be specified in the
WorkWeekDay.
Type: Date
Standard date validation applies
Sample values:
<WorkWeekDay> <Date> 12/25/2006</Date> </WorkWeekDay>

Chapter 2
CountsTowardMaxDaysPerWeek
Hours worked count toward max days per week limits
If true, and this date is worked, then the day counts toward max days per week
scheduling limits. If false, the day is "outside the work week", and will not be
counted towards weekly limits.
Type: Boolean
Optional
All CountsTowards values in the WorkWeekDay must be identical - either all are
true, or all are false. This may change in the future.
CountsTowardMaxHoursPerWeek
Hours worked count toward the max hours per week limit
If true, and this date is worked, then the hours worked count toward max hours per
week scheduling limits. If false, the day is "outside the work week", and will not
be counted towards weekly limits.
Type: Boolean
Optional
All CountsTowards values in the WorkWeekDay must tbe identical. Either all are
false, or all are true. This may change in the future.
CountsTowardMinHoursPerWeek
Hours worked count toward the min hours per week limit
If true, and this date is worked, then the hours worked count toward the min hours
per week scheduling limit. If false, the day is "outside the work week", and will
not be counted towards weekly limits.
Type: Boolean
Optional

Chapter 2
All CountsTowards values in the WorkWeekDay must tbe identical. Either all are
false, or all are true. This may change in the future.

Day or Date
The weekday or calendar date identifying a day or days that are special for
scheduling purposes.
Required
Group includes: DayOfWeek, Date

Chapter 2
WSAAccrualCode Tag
Setup 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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAAccrualCode
Name = String >
</WSAAccrualCode>
Action Descriptions
Returns all accrual codes for update.
Return Value Type: Zero or more WSAAccrualCode tags
Introduced in v5.1

Chapter 2
RetrieveAllNames
Returns a list of the names of all accrual codes - for example, Vacation, Sick.
Introduced in v5.1
RetrieveForUpdate
Returns the specified accrual code for update.
Return Value Type: WSAAccrualCode tag
Name
Name
Name of an account that identifies a category of time or money that employees
earn.
Type: String
Optional Key
The name can be up to 32 characters long, is case-insensitive, and must be
unique.
Sample values:
Vacation, Sick
Introduced in v5.1

Chapter 2
WSAAccrualDetail Tag
WSA Accrual Detail
The WSAAccrualDetail tag allows you to manage Accrual detail genie setup.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"Update"
Parameters→
None
Properties→
<WSAAccrualDetail
[DisplayDescription = String]
[Name = String] >
[<ColumnSet>
<WSAWfgColumnSet>
</ColumnSet>]
[<DefaultHyperfindQuery>
<WSAHyperfindQuery>
</DefaultHyperfindQuery>]
[<DefaultTimePeriod>
<WSADPTimePeriod>
</DefaultTimePeriod>]

Chapter 2
[<NavbarCategory>
<WSANavbarCategory>
</NavbarCategory>]
</WSAAccrualDetail>
Action Descriptions
Delete
Delete Accrual Detail Genie by name
Retrieve
Retrieve WSA Accrual Detail by name
Return Value Type: WSAAccrualDetail tag
Introduced in v6.0
Retrieve all Accural Detail genies for Update
Return Value Type: Zero or more WSADetail tags
RetrieveAllNames
Retrieve All Accrual Detail Names

Chapter 2
RetrieveForUpdate
Retrieve WSA Accrual Detail by name for update
Return Value Type: WSAAccrualDetail tag
Update
Update the Accrual Detail Genie by Name
Introduced in v6.0
ColumnSet
Column Set
The column set Object
Type: WSAWfgColumnSet tag
Optional
Introduced in v6.0
DefaultHyperfindQuery
Default HyperFind Query
Default HyperFind Query
Type: WSAHyperfindQuery tag
Optional
Introduced in v6.0
DefaultTimePeriod
Default Time Period
Default Time Period

Chapter 2
Type: WSADPTimePeriod tag

Optional
Introduced in v6.0
Description
Description
Description of Accrual Detail
Type: String
Optional
DisplayDescription
Display Descritpion
Display Description of Accrual Detail
Type: String
Optional
Introduced in v6.0
DisplayName
Display Name
Display Name of the AccrualDetail
Type: String
Optional
Name
Name
Name of Accrual Detail genie
Type: String
Optional

Chapter 2
NavbarCategory
navBar Category
navBar Category
Type: WSANavbarCategory tag
Optional
Introduced in v6.0

Chapter 2
WSAAccrualDetailColumnSet Tag
Column set for Accrual Detail
AccrualDetailColumnSet tag allows you to manage Accrual Detail column set
genie configuration.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"Update"
Parameters→
None
Properties→
<WSAAccrualDetailColumnSet
[ExteriorItemNumber = Long]
[ExteriorName = String]
Name = String >
[<ColumnDetail>
<WSAColumnDetail>*
</ColumnDetail>]
</WSAAccrualDetailColumnSet>

Chapter 2
Action Descriptions
Delete
Delete Accrual Detail Column Set by Name
Retrieve
Retrieve Accrual Detail Column Set genie by name.
Return Value Type: WSAAccrualDetailColumnSet tag
Retrieve All Accrual Detail Column Sets for Update
Return Value Type: Zero or more WSAAccrualDetailColumnSet tags
RetrieveAllNames
Retrieve all Accrual Detail Column set names
RetrieveForUpdate
Retrieve Accrual Detail Column set by name for update
Return Value Type: WSAAccrualDetailColumnSet tag

Chapter 2

Update
Update the AccrualDetailColumnSet by Name
ColumnDetail
Column detail
Column details that are assigned
Type: Zero or more WSAColumnDetail tags
Optional
Description
Description
Description of Accrual Detail Column Set genie
Type: String
Optional
Introduced in v6.0
DisplayDescription
display description
Description to display in the user interface
Type: String
Optional
Introduced in v6.0

Chapter 2
DisplayName
display name
Type: String
Optional
Introduced in v6.0
ExteriorItemNumber
Exterior Item Number
Exterior item number
Type: Long
Optional
Introduced in v6.0
ExteriorName
exterior name
Exterior Name
Type: String
Optional
Introduced in v6.0
Name
name
name of Accrual Detail Column Set genie
Type: String
Optional Key

Chapter 2
WSAAccrualPolicy Tag
Accrual Policy
The Accrual Policy tag establishes how and when accrual balances associated
with accrual codes are credited and debited.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"Update"
Parameters→
None
Properties→
<WSAAccrualPolicy
AccrualCode = String
[OverflowAccrualCode = String]
UseScheduleAmount = Boolean
[DatePattern = String]
[OverdraftError = String]
[FutureOverdraftError = String]
[FutureOverdraftWarning = String]
[MaxTakings = Integer]
[MinTakings = String]
[Name = String]
[CurrentDateBalance = Boolean]
[GroupEditOverride = Boolean]

Chapter 2
[ImportOverride = Boolean]
[ProbationPeriod = String]
[RestoreTaking = String]
[RestoreTakingAmount = Integer]
[RestoreTakingAmountUnitOfMeasure = String]
[Granularity = String]
[OverdraftWarning = String] >
[<Grants>
<WSAAccrualPolicyGrant>*
</Grants>]
[<Limits>
<WSAAccrualPolicyLimit>*
</Limits>]
[<AccrualPolicyPayCodes>
<WSAAccrualPolicyPayCode>*
</AccrualPolicyPayCodes>]
[<TakingLimits>
<WSAAccrualPolicyTakingLimit>*
</TakingLimits>]
</WSAAccrualPolicy>
Action Descriptions
Delete
Deletes the specified accrual policy.
Introduced in v5.2
Retrieve
Retrieves the specified accrual policy.
Return Value Type: WSAAccrualPolicy tag
Introduced in v5.2

Chapter 2
Retrieves all accrual policies for update.
Return Value Type: Zero or more WSAAccrualPolicy tags
Introduced in v5.2
RetrieveAllNames
Retrieves a list of the names of all accrual policies (active and inactive).
Introduced in v5.2
RetrieveForUpdate
Retrieves the specified accrual policy for update.
Return Value Type: WSAAccrualPolicy tag
Introduced in v5.2
Update
Updates an existing accrual policy or creates a new one.
Introduced in v5.2
AccrualCode
Accrual
Name of the accrual code that is governed by this accrual policy.
Type: String

Chapter 2
Required
Introduced in v5.2
AccrualPolicyPayCodes
Pay codes
The list of pay codes used for debiting accrual balances for unworked time, such
as vacation and sick time. When time is charged to one or more of these pay
codes, the system debits the accrual balance for the accrual code.
Type: Zero or more WSAAccrualPolicyPayCode tags
Optional
Introduced in v5.2
CurrentDateBalance
Overdraft balance effective date
Determines whether the effective date of an overdraft balance is the current date
(that is, today's date) or the transaction date.
Type: Boolean
Optional
Introduced in v5.2
DatePattern
Date pattern
The name of the date pattern to use in this accrual policy. A date pattern is a
sequence of dates used to determine when the associated grant accrues or the
accrual amount changes. Monthly or yearly sequence subclasses can be made as
well as regular (having a constant number of days per interval) sequences such as
weekly.
Type: String
Optional
Introduced in v5.2

Chapter 2
FutureOverdraftError
Future disallow overdraft amount
Amount by which an employee's future withdrawal of time or money must exceed
the accrued amount for the withdrawal to be disallowed. The future date is relative
to today's date, not to the date of the transaction that causes the overdraft.
Type: String
Optional
Introduced in v5.2
FutureOverdraftWarning
Future overdraft warning amount
Amount by which an employee's future withdrawal of time or money must exceed
the accrued amount for a warning to be issued. The future date is relative to
today's date, not to the date of the transaction that causes the overdraft.
Type: String
Optional
Introduced in v5.2
Grants
Grants
The list of grants for this accrual policy.
Type: Zero or more WSAAccrualPolicyGrant tags
Optional
Introduced in v5.2
Granularity
Taking increment
Specifies that employee takings occur in even multiples of the specified amount.
For example, if you specify a value of 2, an error will occur for a taking of 10.5
hours, because 10.5 is not an even multiple of 2.
Type: String
Optional
Introduced in v5.2

Chapter 2
GroupEditOverride
Override warnings during group edits
Determines whether overdraft warnings should be overridden during group edit
operations.
Type: Boolean
Optional
Introduced in v5.2
ImportOverride
Override warnings during imports
Determines whether overdraft warnings should be overridden during import
operations.
Type: Boolean
Optional
Introduced in v5.2
Limits
Limits
A list of accrual limits associated with this accrual policy. For example, an
earnings limit sets the maximum amount that can accrue for a given accrual code,
and a taking limit specifies the maximum amount that employees can take within
a given time period.
Type: Zero or more WSAAccrualPolicyLimit tags
Optional
Introduced in v5.2
MaxTakings
Maximum taking
THIS FIELD IS NO LONGER USED. It used to be the maximum amount of time
or money that an employee can take or use based on the employee's accrual
balances and organization policy. Now the maximum amount is determined by
the appropriate Taking Limit.
Type: Integer

Chapter 2
Optional
Introduced in v5.2; deprecated in v5.2. This attribute used to be the maximum
amount of time or money that an employee can take or use based on the accrual
balances and organization policy for the employee. Now, the maximum amount is
determined by the appropriate Taking Limit.
MinTakings
Minimum taking
Minimum amount of time or money that an employee can take or use based on the
employee's accrual balances and organization policy.
Type: String
Optional
Introduced in v5.2
Name
Name
The accrual policy name.
Type: String
Optional
Introduced in v5.2
OverdraftError
Disallow overdraft amount
Amount by which an employee's withdrawal of time or money must exceed the
accrued amount for the withdrawal to be disallowed.
Type: String
Optional
Introduced in v5.2
OverdraftWarning
Warning overdraft amount
Amount by which an employee's withdrawal of time or money must exceed the
accrued amount for a warning to be issued.
Type: String

Chapter 2
Optional
Introduced in v5.2
OverflowAccrualCode
Accrual for overflow
The name of the overflow accrual code for this accrual policy.
Type: String
Optional
Introduced in v5.2
ProbationPeriod
Probation period
The name of the probation period for this accrual policy.
Type: String
Optional
Introduced in v5.2
RestoreTaking
Restore taking
Specifies how takings are restored, if at all. Valid values: 0 - Takings are not to be
restored, 1- All Takings from Start are restored, 2 - Each Taking is restored.
Type: String
Optional
Introduced in v5.2
RestoreTakingAmount
Restore taking amount
A number used with RestoreTakingAmountUnitOfMeasure to determine the time
period that must elapse before a taking is restored. The amount must be a positive,
non-zero number. For example, if RestoreTakingAmount is 3 and
RestoreTakingAmountUnitOfMeasure is B (Months), takings are restored every
three months.
Type: Integer
Optional

Chapter 2
Introduced in v5.2
RestoreTakingAmountUnitOfMeasure
Restore taking interval
A time interval used with RestoreTakingAmount to determine the time period that
must elapse before a taking is restored. Valid values: A - Days, B - Months, C -
Pay Periods, D - Years, E - Weeks, or F - Calendar Month. For example, if
RestoreTakingAmount is 1 and RestoreTakingAmountUnitOfMeasure is D
(Years), takings are restored annually.
Type: String
Optional
Introduced in v5.2
TakingLimits
Taking limits
Controls the amounts of time or money that an employee can use or take based on
the employee's accrual balances and organization policy.
Type: Zero or more WSAAccrualPolicyTakingLimit tags
Optional
Introduced in v5.2
UseScheduleAmount
Adjustment to accrual balance
Determines whether scheduled hours or a fixed number of hours is used for
adjusting the accrual balance. A true value means that the adjustment to the
accrual balance should be based on the scheduled hours for the day. A false value
means to use a fixed number of hours.
Type: Boolean
Required
Introduced in v5.2

Chapter 2
WSAAccrualPolicyGrant Tag
Accrual Policy Grant
The Accrual Policy Grant tag defines a grant that is associated with an accrual
policy. It is used only as a subelement of the AccrualPolicy tag.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<WSAAccrualPolicyGrant
[ExpireToAccrual = String]
[Amount = String]
GrantRule = String
[LengthOfService = Integer] >
</WSAAccrualPolicyGrant>
Amount
Amount accrued
The amount accrued by this grant.
Type: String
Optional
Introduced in v5.2
ExpireToAccrual
Accrual for expired grant balance
The accrual to which any remaining balances will be transferred on the specified
expiration date. Transfers are made on all milestones attached to this accrual.

Chapter 2
Type: String
Optional
Introduced in v5.2
GrantRule
Grant
The name of the grant to associate with this policy.
Type: String
Required
Introduced in v5.2
LengthOfService
Length of service
The length of service required before accruals begin. Values other than zero are
valid, depending on the Length of Service Reference.
Type: Integer
Optional
Introduced in v5.2

Chapter 2
WSAAccrualPolicyLimit Tag
Accrual Policy Earning Limit
The Accrual Policy Earning Limit tag defines the earning limits associated with
an accrual policy. It is used only as a subelement of the AccrualPolicy tag.
Earnings can be limited in one of three ways:
• Limit the accrual balance
• Limit the amount earned
• Set a limit that changes based on how much time or money the employee has
taken
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<WSAAccrualPolicyLimit
[Amount = String]
[LengthOfService = Integer]
GrantRule = String >
</WSAAccrualPolicyLimit>
Amount
Amount
The amount of the limit. The amount value should be formatted correctly for the
accrual type. For example, if the accrual is an hour or day amount, specify either
a decimal amount or use the appropriate HH:MM format. If the accrual is a
money type, you must use a decimal format.

Chapter 2
Type: String
Optional
Sample values:
3.00
Introduced in v5.2
GrantRule
Limit
The name of the earning or carryover limit to use.
Type: String
Required
Introduced in v5.2
LengthOfService
Length of service
The length of service. Values other than zero are appropriate depending on the
Length of Service Reference.
Type: Integer
Optional
Introduced in v5.2

Chapter 2
WSAAccrualPolicyPayCode Tag
Accrual Policy Pay Code
The Accrual Policy Pay Code tag specifies the pay code to apply to an earned
grant. It is used only as a subelement of the AccrualPolicy tag.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<WSAAccrualPolicyPayCode
PayCode = String >
</WSAAccrualPolicyPayCode>
PayCode
Pay code
The name of the pay code to apply to the earned grant.
Type: String
Required
Introduced in v5.2

Chapter 2
WSAAccrualPolicyTakingLimit Tag
Accrual Policy Taking Limit
The Accrual Policy Taking Limit tag defines the amount of time or money that an
employee can use or take based on the employee's accrual balances and
organization policy. It is used only as a sublement of the AccrualPolicy tag.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<WSAAccrualPolicyTakingLimit
[DisallowAmount = String]
Name = String
[WarningAmount = String] >
</WSAAccrualPolicyTakingLimit>
DisallowAmount
Disallow amount
The disallow amount. It must be formatted appropriately for the accrual code
type. The amount value should be formatted correctly for the accrual type. For
example, if the accrual is an hour or day amount, specify either a decimal amount
or use the appropriate HH:MM format. If this value is non-zero and the
WarningAmount is non-zero, this value must be greater than the
WarningAmount.
Type: String
Optional

Chapter 2
Introduced in v5.2
Name
Name
The name of the taking limit.
Type: String
Required
Introduced in v5.2
WarningAmount
Warning amount
The warning amount. The amount value should be formatted correctly for the
accrual type. For example, if the accrual is an hour or day amount, specify either
a decimal amount or use the appropriate HH:MM format. If the accrual is a
money type, you must use a decimal format. If this value is non-zero and the
DisallowAmount is non-zero, this value must be less than the DisallowAmount.
Type: String
Optional
Sample values:
3.00
Introduced in v5.2

Chapter 2
WSAAccrualProfile Tag
Setup Accrual Profile
The Accrual Profile tag assembles a combination of accrual policies that can be
assigned collectively to employees with similar characteristics.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"Update"
Parameters→
None
Properties→
<WSAAccrualProfile
[AccrualCode = String]
Name = String >
<AccrualProfilePolicies>
<WSAAccrualProfilePolicy>*
</AccrualProfilePolicies>
</WSAAccrualProfile>
Action Descriptions
Delete
Deletes the specified Accrual Profile.

Chapter 2
The submitted name must be a valid name for an existing Accrual Profile and
must not be in use.
Introduced in v5.2
Retrieve
Returns the specified Accrual Profile.
The name supplied must be a valid name for an Accrual Profile.
Return Value Type: WSAAccrualProfile tag
Introduced in v5.2
Returns a list of all of the Accrual Profiles to be used for the update action.
Return Value Type: Zero or more WSAAccrualProfile tags
Introduced in v5.2
RetrieveAllNames
Returns a list of Accrual Profile names.
Introduced in v5.2
RetrieveForUpdate
Returns the specified Accrual Profile for updating.
The name supplied must be a valid Accrual Profile name.
Return Value Type: WSAAccrualProfile tag

Chapter 2

Introduced in v5.2
Update
Updates an existing Accrual Profile or creates a new Accrual Profile. If the
Accrual Profile does not exist, it is created.
The submitted Accrual Profile must be a valid WSAAccrualProfile object.
Required Properties: WSAAccrualProfile
Introduced in v5.2
AccrualCode
Accrual code name
The name of the pool accrual code for this accrual profile. The pool accrual holds
accrued time or money not associated with an individual employee. Accrual
balances can be transferred from an employee to an accrual pool, or from an
accrual pool to an employee.
Type: String
Optional
Introduced in v5.2
AccrualProfilePolicies
Accrual policy list
The list of Accrual Policies assigned to this Accrual Profile.
Type: Zero or more WSAAccrualProfilePolicy tags
Required
Introduced in v5.2

Chapter 2
Name
Name
The name of the Accrual Profile. Use up to 50 characters. The name must be
unique among Accrual Profiles.
Type: String
Required
Introduced in v5.2

Chapter 2
WSAAccrualProfilePolicy Tag
Accrual Profile Policy
The Accrual Profile Policy tag describes an accrual policy that is included within
an accrual profile.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<WSAAccrualProfilePolicy
AccrualPolicy = String
[Display = Boolean] >
</WSAAccrualProfilePolicy>
AccrualPolicy
Accrual policy name
The Accrual Policy name to be assigned to an Accrual Profile.
Type: String
Required
Introduced in v5.2
Display
Display accrual profile policy on the timecard?
Specifies whether the Profile should appear on the timecard. Specify true to
display the Profile, or false not to display the Profile.
Type: Boolean

Chapter 2
Optional
Introduced in v5.2

Chapter 2
WSAAccrualQualifier Tag
Accrual Qualifier
The Accrual Qualifier tag is used by Probation Qualifier which, in turn, is used by
Probation Period. Qualifiers test for specific conditions, such as the number of
days worked, before ending a probation period. Qualifiers are available only with
single (non-recurring) probation periods.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<WSAAccrualQualifier
[Amount = String]
NumToCheck = Integer
[PayCode = String]
Type = String
[CheckAtLeastMin = Boolean] >
[<Interval>
<WSAInterval>
</Interval>]
</WSAAccrualQualifier>
Amount
Amount
A number that is applied to the Qualifier type to determine the qualifying period.
For example, an Amount of 60 with a Qualifier of Days Active means that
employees must be active for 60 days before the probation can qualify.
Type: String

Chapter 2
Optional
Introduced in v5.2
CheckAtLeastMin
Require the minimum number of intervals?
Specify whether the minimum number of intervals (such as days or weeks) must
meet the qualifier conditions to end probation.
Type: Boolean
Optional
Introduced in v5.2
Interval
Interval
A time period used with "Number of intervals to check" to determine how often
the system checks if the probation period qualifier has been met. For example, if
you specify an Interval of Month(s) with a "Number of intervals to check" of 3,
the system would check every three months.
Type: WSAInterval tag
Optional
Introduced in v5.2
NumToCheck
Number of intervals to check
A number used with Interval to determine how often the system checks if the
probation period qualifier has been met. For example, if you specify a "Number of
intervals to check" of 3 with an Interval of Month(s), the system would check
every three months. Default=1.
Type: Integer
Required
Introduced in v5.2

Chapter 2
PayCode
Pay code
The pay code, if any, associated with the qualifier. You can use Pay Code only
when the Qualifier type is Hours in Pay Code.
Type: String
Optional
Introduced in v5.2
Type
Qualifier
The type of this qualifier. This value is used with Amount to determine the
qualifying period. For example, a Qualifier of Days Active with an Amount of 60
means that employees must be active for 60 days before the probation can qualify.
Type: String
Required
Sample values:
Days Active
Introduced in v5.2

Chapter 2
WSAAPICombination Tag
Combination
The Combination tag defines a combination object.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAAPICombination
ChosenComponent = Integer
ComponentName1 = String
ComponentName2 = String
CombinationComponentType1 = String
CombinationComponentType2 = String >
</WSAAPICombination>
Action Descriptions
Retrieve
Returns the specified Combination
Return Value Type: WSAAPICombination tag

Chapter 2

RetrieveForUpdate
Returns Combination for update
Return Value Type: WSAAPICombination tag
ChosenComponent
Chosen component
The Chosen Component for the given Combination (that is, the one that is
displayed on the right side of the rule).
Type: Integer
Required
Introduced in v5.2
CombinationComponentType1
Type of the first combination component
Specifies the Component Type for the given Combination
Type: String
Required
Introduced in v5.2
CombinationComponentType2
Type of the second combination component
Specifies the Component Type for the 2nd Combination
Type: String
Required
Introduced in v5.2

Chapter 2
ComponentName1
Name of the first combination component
The name for the given Combination
Type: String
Required
Introduced in v5.2
ComponentName2
Name of the second combination component
Specifies the name for the 2nd Combination component
Type: String
Required

Chapter 2
WSAAPICombinationComponent Tag
Combination Component
The Combination Component tag identifies a combination component.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAAPICombinationComponent
[ContinueToCountTO = Boolean]
Name = String
Type = String >
</WSAAPICombinationComponent>
Action Descriptions
Retrieve
Returns the specified Combination Component
Return Value Type: WSAAPICombinationComponent tag

Chapter 2
Introduced in v5.2
RetrieveForUpdate
Return the specified Combination Component
Return Value Type: WSAAPICombinationComponent tag
Introduced in v5.2
ContinueToCountTO
Continue to count toward overtime
A flag specifying whether to continue to count toward this type of Overtime in
case when there are several conflicting combinations toward this type of
Overtime
Type: Boolean
Optional
Introduced in v6.0
Description
Description
The description for the Combination Component
Type: String
Required
Introduced in v5.2
Name
Name
The name for the given Combination Component
Type: String
Required
Introduced in v5.2

Chapter 2
Type
Type
The Type of the Combination Component. The component can be of type Zone,
Limit, Deviation, or Extension Processor.
Type: String
Required
Introduced in v5.2

Chapter 2
WSAAPICombinationRule Tag
Combination Rule
The Combination Rule tag defines a combination rule.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"Update"
Parameters→
None
Properties→
<WSAAPICombinationRule
Name = String >
[<Combinations>
<WSAAPICombination>*
</Combinations>]
[<CombinationTowardOT>
<WSAAPICombinationTowardOT>*
</CombinationTowardOT>]
[<SelectedComponents>
<WSAAPICombinationComponent>*
</SelectedComponents>]
</WSAAPICombinationRule>

Chapter 2
Action Descriptions
Delete
Deletes the specified Combination Rule
Introduced in v5.2
Retrieve
Returns the CombinationRule by the name
Return Value Type: WSAAPICombinationRule tag
Introduced in v5.2
Return a list of Combination Rule ready for Update
Return Value Type: (***undefined***): WSAAPICombinationRule list
RetrieveAllNames
Returns a list of names for all of the Combination Rules
Introduced in v5.2
RetrieveForUpdate
Retrieves a CombinationRule by name for update
Return Value Type: WSAAPICombinationRule tag

Chapter 2
Introduced in v5.2
Update
Updates the combination rule
Required Properties: WSAAPICombinationRule
Combinations
Combination list
A list of Combinations
Type: Zero or more WSAAPICombination tags
Optional
CombinationTowardOT
List of combinations toward overtime
A list of Combinations Toward Overtime associated with the Combination Rule
Type: Zero or more WSAAPICombinationTowardOT tags
Optional
Introduced in v6.0
Name
Name
The name for the given Combination Rule
Type: String
Required
Introduced in v5.2

Chapter 2
SelectedComponents
List of selected combination components
List of CombinationComponents
Type: Zero or more WSAAPICombinationComponent tags
Optional

Chapter 2
WSAAPICombinationTowardOT Tag
Combination Toward Overtime
The Combination Toward Overtime tag defines the combination of a source
component that could count or not count toward the target Overtime component.
Both, the source and the target Overtime components are Selected Combination
Components of the Combination Rule.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAAPICombinationTowardOT
CountsTowardTargetOT = Boolean
SourceRuleComponentType = String
SourceRuleName = String
TargetOTRuleComponentType = String
TargetOTRuleName = String >
</WSAAPICombinationTowardOT>
Action Descriptions
Retrieve
Retrieve a Combination Toward Overtime
Return Value Type: WSAAPICombinationTowardOT tag

Chapter 2

Introduced in v6.0
RetrieveForUpdate
Retrieve a Combination Toward Overtime for update
Return Value Type: WSAAPICombinationTowardOT tag
Introduced in v6.0
CountsTowardTargetOT
Counts Toward Target Overtime
A flag specifying whether the source component of the Combination Toward
Overtime counts toward the target Overtime
Type: Boolean
Required
Introduced in v6.0
SourceRuleComponentType
Source Rule Component Type
The Component Type of the Source Rule of the Combination Toward Overtime
Type: String
Required
Introduced in v6.0
SourceRuleName
Source Rule Name
The name of the source Rule of the Combination Toward Overtime
Type: String
Required

Chapter 2
Introduced in v6.0
TargetOTRuleComponentType
Target Overtime Rule Component Type
The Component Type of the target component of the Combination Toward
Overtime. Currently the target is always an Overtime.
Type: String
Required
Introduced in v6.0
TargetOTRuleName
Target Overtime Rule Name
The Target Overtime Rule Name of the Combination Toward Overtime
Type: String
Required
Introduced in v6.0

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve"
Parameters→
None
Properties→
<WSAAssignmentRule
[Friday = Boolean]
[Monday = Boolean]
[Saturday = Boolean]
[Sunday = Boolean]
[Thursday = Boolean]
[Tuesday = Boolean]
[Wednesday = Boolean]
[Scheduled = Boolean]
[Unscheduled = Boolean]
[ShiftMax = Long]
[ShiftMin = Long]
[OrderNum = Integer]
[ScheduleEndTime = Long]
[ScheduleStartTime = Long]
</WSAAssignmentRule>

Chapter 2
Action Descriptions
Retrieve
Returns the specified assignment rule for update.
Return Value Type: WSAAssignmentRule tag
Introduced in v5.1
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?
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

Chapter 2
Introduced in v5.1
Saturday
Is the rule enabled for Saturday?
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.

Chapter 2
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 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 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?
enabled for Sunday.
Type: Boolean
Optional
Introduced in v5.1
Thursday
Is the rule enabled for Thursday?
enabled for Thursday.
Type: Boolean

Chapter 2
Optional
Introduced in v5.1
Tuesday
Is the rule enabled for Tuesday?
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?
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

Chapter 2
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
scheduling is installed.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve"
Parameters→
None
Properties→
<WSAAutoBreakPlacement
[MinStartTimeForBreak = Long]
[MaxStartTimeForBreak = Long]
[MinTimeBetweenBreaks = Long]
Name = String >
[<ShiftLengths>
<WSAShiftLength>*
</ShiftLengths>]
[<ShiftLengthExclusions>
<WSAShiftLengthExclusion>*
</ShiftLengthExclusions>]
</WSAAutoBreakPlacement>
Action Descriptions

Chapter 2
Retrieve
Returns the specified automated break placement.
Return Value Type: WSAAutoBreakPlacement tag
Introduced in v5.1
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

Chapter 2
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 Key
Introduced in v5.1
ShiftLengthExclusions
Shift lengths to exclude
ShiftLengthExclusions
Type: Zero or more WSAShiftLengthExclusion tags
Optional
ShiftLengths
List of shift lengths
List containing one or more shift lengths.
Type: Zero or more WSAShiftLength tags
Optional
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAAvailabilityPatternDAP
[AllowAll = Boolean]
Name = String >
[<ProfileItems>
<WSAAvailabilityPatternProfileItem>*
</ProfileItems>]
</WSAAvailabilityPatternDAP>
Action Descriptions
Returns all availability pattern data access profiles for update.

Chapter 2
Return Value Type: Zero or more WSAAvailabilityPatternDAP tags

Introduced in v5.1
RetrieveAllNames
Returns a list of all availability pattern data access profiles.
Introduced in v5.1
RetrieveForUpdate
Returns the specified availability pattern data access profile for update.
Return Value Type: WSAAvailabilityPatternDAP tag
Introduced in v5.1
Update
Updates the specified availability pattern data access profile.
Introduced in v5.1
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

Chapter 2
Introduced in v5.1
Description
Description
Description of the availability pattern data access profile.
Type: String
Optional
Introduced in v5.1
Name
The name of the Availability template data access profile
Name of the availability pattern data access profile. The name is case-insensitive
and must be unique.
Type: String
Optional Key
Introduced in v5.1
ProfileItems
Availability templates associated with this data access profile
List of availability templates associated with this availability pattern data access
profile.
Type: Zero or more WSAAvailabilityPatternProfileItem tags
Optional
Introduced in v5.1

Chapter 2
WSAAvailabilityPatternProfileItem Tag
Availability Pattern Profile Item
This is a timekeeping tag that identifies availability pattern profile items
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAAvailabilityPatternProfileItem
Name = String >
</WSAAvailabilityPatternProfileItem>
Action Descriptions
Returns all availability pattern profile items for update.
Return Value Type: Zero or more WSAAvailabilityPatternProfileItem tags
Introduced in v5.1
RetrieveForUpdate
Returns the specified availability pattern profile item for update.

Chapter 2
Return Value Type: WSAAvailabilityPatternProfileItem tag

Introduced in v5.1
Name
Availability pattern profile item name
Name of the availability pattern profile item. The name can be up to 32 characters
long, is case-insensitive, and must be unique.
Type: String
Optional Key
Introduced in v5.1

Chapter 2
WSAAveragingDetail Tag
Averaging Detail
The WSAAveragingDetail tag allows you to manage Averaging detail genie setup.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"Update"
Parameters→
None
Properties→
<WSAAveragingDetail
[ColumnSet = String]
[Name = String] >
<WSAHyperfindQuery>
<WSADPTimePeriod>
[<NavbarCategory>
<WSANavbarCategory>

Chapter 2
</NavbarCategory>]
</WSAAveragingDetail>
Action Descriptions
Delete
Delete Averaging Detail genie by Name.
Introduced in v6.1
Retrieve
Retrieve Averaging Detail genie by name.
Return Value Type: WSAAveragingDetail tag
Introduced in v6.1
Retrieve Averaging Detail genies for update.
Return Value Type: Zero or more WSAAveragingDetail tags
Introduced in v6.1
RetrieveAllNames
Retrieve all Averaging Detail genie names.
Introduced in v6.1
RetrieveForUpdate
Retrieve Averaging Detail genie by name for update.

Chapter 2
Return Value Type: WSAAveragingDetail tag

Introduced in v6.1
Update
Update the Averaging Detai genie by Name.
Introduced in v6.1
ColumnSet
Column set
The Column Set object for the Averaging Detail genie.
Type: String
Optional
Introduced in v6.1
Default HyperFind query
The default HyperFind query object for the Averaging Detail genie.
Optional
Introduced in v6.1
DefaultTimePeriod
Default time period
The default time period object for the Averaging Detail genie.

Chapter 2
Optional
Introduced in v6.1
Description
Description
The description of the Averaging Detail genie.
Type: String
Optional
Introduced in v6.1
DisplayDescription
Display description
The Display description for the Averaging Detail genie.
Type: String
Optional
Introduced in v6.1
DisplayName
Display name
The display name for the Averaging Detail genie.
Type: String
Optional
Introduced in v6.1
Name
Name
The name of the Averaging Detail genie.
Type: String
Optional
Introduced in v6.1
NavbarCategory
Navbar category
The Navigation Bar Category object for the Averaging Detail genie.

Chapter 2

Optional
Introduced in v6.1

Chapter 2
WSAAveragingDetailColumnSet Tag
Averaging Detail Column Set
The AveragingDetailColumnSet tag allows you to manage Averaging Detail
Genie column set configuration.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"Update"
Parameters→
None
Properties→
<WSAAveragingDetailColumnSet
[ExteriorItemNumber = Integer]
Name = String >
[<ColumnDetail>
<WSAColumnDetail>*
</ColumnDetail>]
</WSAAveragingDetailColumnSet>

Chapter 2
Action Descriptions
Delete
Delete Averaging Detail Column Set by Name.
Introduced in v6.1
Retrieve
Retrieve Averaging Detail Column Set genie by name.
Return Value Type: WSAAveragingDetailColumnSet tag
Introduced in v6.1
Retrieve all Averaging Detail Column set names.
Return Value Type: Zero or more WSAAveragingDetailColumnSet tags
Introduced in v6.1
RetrieveAllNames
Retrieve all Averaging Detail Column set names.
Introduced in v6.1
RetrieveForUpdate
Retrieve Averaging Detail Column set by name for update.
Return Value Type: WSAAveragingDetailColumnSet tag

Chapter 2
Introduced in v6.1
Update
Update the Averaging DetailColumnSet by Name.
Introduced in v6.1
ColumnDetail
Column detail
The list of Column Detail objects for the Averaging Detail column set.
Optional
Description
Description
The description of the Averaging Detail column set.
Type: String
Optional
Introduced in v6.1
DisplayDescription
Display description
The Display description for the Averaging Detail column set.
Type: String
Optional
Introduced in v6.1

Chapter 2
DisplayName
Display name
The Display name for the Averaging Detail column set.
Type: String
Optional
Introduced in v6.1
ExteriorItemNumber
The exterior item number for the Averaging Detail column set.
Type: Integer
Optional
Introduced in v6.1
ExteriorName
Exterior name
The exterior name for the Averaging Detail column set.
Type: String
Optional
Introduced in v6.1
Name
Name
The name of the Averaging Detail column set.
Type: String
Optional Key
Introduced in v6.1

Chapter 2
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
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSABonusDeductRule
[Amount = String]
[AtLeastSelected = Boolean]
[BonusQualify = String]
[BreakRule = String]
[Friday = Boolean]
[InWinEtime = Time]
[InWinStime = Time]
[IsCanceledInTimecard = Boolean]
[IsException = Boolean]
[IsShiftRestriction = Boolean]
[Locator = TimeDuration]
[LocatorAtOrAfter = Time]
[LocatorBefore = Time]

Chapter 2
[ShfLenMax = TimeDuration]
MinimumQualifyingInterval = TimeDuration
[ShfLenMin = TimeDuration]
[Monday = Boolean]
Name = String
[PayCode = String]
[PaycodeMax = TimeDuration]
[PaycodeMin = TimeDuration]
[QualifyPerShift = Boolean]
[ShiftReq = Integer]
ShortBreakExceptionDisqualifiesBreak = Boolean
[Sunday = Boolean]
[TimeOfDay = Time]
[TrigpaycodeName = String]
[Tuesday = Boolean]
[Type = String]
UseRoundedShiftBoundaryTimes = Boolean
[WeekStart = Integer] >
</WSABonusDeductRule>
Action Descriptions
Returns all bonus and deduction rules for updating.
Return Value Type: Zero or more WSABonusDeductRule tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all bonus and deduction rules.
Introduced in v5.1

Chapter 2
RetrieveForUpdate
Returns the specified bonus or deduction rule for updating.
Return Value Type: WSABonusDeductRule tag
Introduced in v5.1
Update
Updates the specified bonus or deduction rule.
Introduced in v5.1
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

Chapter 2
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 property can 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.

Chapter 2
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
IsException
Is Exception
A boolean value of IsException flag. This bonus, when achieved by employees,
generates a Bonus exception, which can appear in the timecard, Genies, and
reports.
Type: Boolean
Optional
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

Chapter 2
compared to the Must Work Until time. Employees must end work at or after
InWinEtime. When this 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.

Chapter 2
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
MinimumQualifyingInterval
Minimum Qualifying Interval
The minimum amount of time that can pass during a shift of a sufficient length
without the occurance of a break with the name specified in the "Cancel if break
taken" field before this bonus will be paid.
Type: TimeDuration
Required
Must be a valid time duration
Sample values:
3:45
Default value: 0:00

Introduced in v6.1

Chapter 2
Monday
Monday
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 Key
Introduced in v5.1
PayCode
Pay Code
Pay code for the bonus or deduction.
Type: String
Optional
This element must have a non-empty value if the bonus/deduction rule is of
type="B" (triggered by a pay code).
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.

Chapter 2
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
to Saturday.
Type: Boolean
Optional
Introduced in v5.1

Chapter 2
ShfLenMax
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 cancellation 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
When 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

Chapter 2
ShortBreakExceptionDisqualifiesBreak
Short Break Exception Disqualifies Break
If set to true, this property will cause the "break" to be cancelled if the employee
ends their break early. In other words, the break will not count and therefore the
bonus may be paid as if the break did not occur.
Type: Boolean
Required
must be either true or false
Sample values:
false

Introduced in v6.1
Sunday
Sunday
to Sunday.
Type: Boolean
Optional
Introduced in v5.1
Thursday
Thursday
to Thursday.
Type: Boolean
Optional
Introduced in v5.1

Chapter 2
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
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

Chapter 2
• F: When an employee works at a specified time of day

Type: String
Optional
Introduced in v5.1
UseRoundedShiftBoundaryTimes
Use Rounded Shift Boundary Times
If true, use the rounded times for the shift start and shift end (according to the
appropriate punch rounding rules) when determining the length of a shift or
segment of a shift.
Type: Boolean
Required
Must be either true or false
Sample values:
true
Default value: true

Introduced in v6.1
Wednesday
Wednesday
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

Chapter 2
Optional
Introduced in v5.1

Chapter 2
WSABreakRule Tag
Break Rule
The Break Rule tag enables you to list and update break rules.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
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]

Chapter 2
[StartTime = Time]
[UsePunchRoundingSW = Boolean] >
</WSABreakRule>
Action Descriptions
Returns all break rules for updating.
Return Value Type: Zero or more WSABreakRule tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all break rules.
Introduced in v5.1
RetrieveForUpdate
Returns the specified break rule for updating.
Return Value Type: WSABreakRule tag
Introduced in v5.1
Update
Updates the specified break rule.
Introduced in v5.1

Chapter 2
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

Chapter 2
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

Chapter 2
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 Key
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 employee 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",

Chapter 2
"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

Chapter 2
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
UsePunchRoundingSW
Use Unscheduled Punch Rounding
Select this checkbox to use unscheduled transfer punch rounding instead of
interval rounding for break punches.
When this checkbox is selected, rounds and graces for Short Break, Medium
Break, and Long Break are unavailable.
The default settings are 0:00 for graces, and 0:01 for rounds.
Type: Boolean
Optional
When Use Unscheduled Punch Rounding is selected, the round and grace text
boxes for Short Break, Medium Break, and Long Break are unavailable.
Introduced in v6.1

Chapter 2
WSABreakTime Tag
Break Time
The BreakTime tag allows you to manage break times.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve"
Parameters→
None
Properties→
<WSABreakTime
[BreakRuleName = String]
[MaxStart = Long]
[MinStart = Long]
Name = String
[OrderNum = Long] >
</WSABreakTime>
Action Descriptions
Retrieve
Returns the specified break time.
Return Value Type: WSABreakTime tag

Chapter 2
Introduced in v5.1
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 Key

Chapter 2
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: Long
Optional
Introduced in v5.1

Chapter 2
WSACalendarProfile Tag
Calendar Profile
The Calendar Profile tag allows you to create and manage the calendars that are
displayed for managers or employees. A calendar profile typically includes one or
more generic calendars, but you can also create a calendar profile that does not
include any generic calendar.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSACalendarProfile
Name = String >
</WSACalendarProfile>
Action Descriptions
Returns all calendar profiles for update.
Return Value Type: Zero or more WSACalendarProfile tags

Chapter 2
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all calendar profiles.
Introduced in v5.1
RetrieveForUpdate
Returns the specified calendar profile for update.
Return Value Type: WSACalendarProfile tag
Introduced in v5.1
Name
Name
Name of the calendar profile. The name can be up to 32 characters in length, is
case-insensitive, and must be unique.
Type: String
Optional Key
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
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]

Chapter 2
[UnscheduledShiftLength = TimeDuration] >

</WSACallInRule>
Action Descriptions
Returns all call-in rules for updating.
Return Value Type: Zero or more WSACallInRule tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all call-in rules.
Introduced in v5.1
RetrieveForUpdate
Returns the specified call-in rule for updating.
Return Value Type: WSACallInRule tag
Introduced in v5.1
Update
Updates the specified call-in rule.
Introduced in v5.1

Chapter 2
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.
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.
• Employees stop accruing call-back hours and start accruing regular hours
when the regular shift starts.

Chapter 2
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

Chapter 2
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

Chapter 2
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 Key
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

Chapter 2
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

Chapter 2
WSACfgAccrualCode Tag
Accrual Code for Configuration
The Accrual Code for Configuration tag configures an accrual code.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSACfgAccrualCode
[Display = Boolean]
[HoursPerDay = TimeDuration]
[ManualEdit = Boolean]
Name = String
[TrackingPeriodName = String]
[Type = String] >
</WSACfgAccrualCode>
Action Descriptions
This action retrieves all configuration accrual codes to be used for an update
action.

Chapter 2
Return Value Type: Zero or more WSACfgAccrualCode tags

Introduced in v5.2
RetrieveAllNames
This action retrieves all configuration accrual code names.
Introduced in v5.2
RetrieveForUpdate
This action retrieves a specified configuration accrual code to be used for an
update action.
Return Value Type: WSACfgAccrualCode tag
Introduced in v5.2
Update
This action updates configuration accrual codes.
Introduced in v5.2
Abbreviation
Abbreviation
The abbreviation.
Type: String
Optional

Chapter 2
Introduced in v5.2
Display
Display?
The display switch.
Type: Boolean
Optional
Introduced in v5.2
HoursPerDay
Hours per day
The duration of hours per day.
Type: TimeDuration
Optional
Introduced in v5.2
ManualEdit
Manual edit?
The manual edit switch.
Type: Boolean
Optional
Introduced in v5.2
Name
Name
The name of the accrual code.
Type: String
Required
Introduced in v5.2
TrackingPeriodName
Tracking Period Name
This attribute holds the name of the date pattern entity which is to be associated
with this accrual code as its tracking period.

Chapter 2
Type: String
Optional
The tracking period (actually, the date pattern which is used as the tracking
period) must exist on the target system. Also, this date pattern must have a "site-
wide" date as its basis and it must not have any offset date patterns associated with
it.
Type
Type
This is the type of the accrual code.
Type: String
Optional
Introduced in v5.2

Chapter 2
WSACfgContactType Tag
Contact Type
The Contact Type tag allows you to add and update definitions for the contact type
information configured to store people attributes not supported by the
timekeeping application. These attributes are expected to be sent in all at once as a
list of WSACfgContactType objects.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<WSACfgContactType
[EMailAdress = Integer]
[PhoneNumber = Integer]
[PostalAddress = Integer]
[Deleted = Integer]
[LongName = String]
Name = String
[LabelName = String]
[LabelNumber = Integer] >
</WSACfgContactType>
Deleted
Is the item deleted?
Is the item deleted?
Type: Integer
Optional

Chapter 2

EMailAdress
Index of the e-mail address for this contact
Index of contact's email address
Type: Integer
Optional
LabelName
Name of contact type label
Contact type name
Type: String
Optional
Introduced in v5.2
LabelNumber
Number of contact type label
Contact type number
Type: Integer
Optional
Introduced in v5.2
LongName
Long version of the contact name
Long version of the contact's name
Type: String
Optional
Introduced in v5.2
Name
Name
Contact's name
Type: String

Chapter 2
Optional Key
Introduced in v5.2
PhoneNumber
Index of the phone number for this contact
Contact's phone number
Type: Integer
Optional
Introduced in v5.2
PostalAddress
Index of the postal address for this contact
Contact's postal address
Type: Integer
Optional
Introduced in v5.2

Chapter 2
WSACfgContactTypeList Tag
Contact Type List
The Contact Type List tag allows you to configure contact type information to
store people attributes not supported by the timekeeping application as a list of
WSACfgContactType objects.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSACfgContactTypeList
Name = String >
<WSAContactTypeList>
<WSACfgContactType>*
</WSAContactTypeList>
</WSACfgContactTypeList>
Action Descriptions
This action returns the list which contains all WSACfgContactType objects for
update.

Chapter 2
Return Value Type: Zero or more WSACfgContactTypeList tags

Introduced in v5.2
RetrieveAllNames
This action returns the name of the list of WSACfgContactType names.
Introduced in v5.2
RetrieveForUpdate
This action returns the WSACfgContactTypeList object to update.
Return Value Type: Zero or more WSACfgContactTypeList tags
Introduced in v5.2
Update
This action updates the list of WSACfgContactType objects.
Introduced in v5.2
Name
Name
The name of the list of WSACfgContactType objects to configure.
Type: String
Required
Introduced in v5.2

Chapter 2
WSAContactTypeList
List of contact types
This is the list of WSACfgContactType objects to be configured.
Type: Zero or more WSACfgContactType tags
Required
Introduced in v5.2

Chapter 2
WSACfgCustomData Tag
Custom Data
The Custom Data tag holds definitions for the custom data configured to store
people attributes not supported by the timekeeping application.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<WSACfgCustomData
Deleted = Integer
LabelName = String
LabelNumber = Integer
Name = String >
</WSACfgCustomData>
Deleted
Deleted
The Deleted status of the custom data configuration.
Type: Integer
Required
Introduced in v5.2
Description
Description
The description of the Custom Data.

Chapter 2
Type: String
Optional
Introduced in v5.2
LabelName
Label name
The Label Name to display for the Custom Data.
Type: String
Required
Introduced in v5.2
LabelNumber
Label number
Index of the label in the list of labels.
Type: Integer
Required
Introduced in v5.2
Name
Name
The name of the Custom Data configuration.
Type: String
Required Key
Introduced in v5.2

Chapter 2
WSACfgCustomDataList Tag
Custom Data List
The Custom Data List tag allows you to add and update definitions for the custom
data configured to store people attributes not supported by the timekeeping
application. These attributes are expected to be sent in all at once as a list of
WSACustomData objects.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSACfgCustomDataList
Name = String >
<WSACustomDataList>
<WSACfgCustomData>*
</WSACustomDataList>
</WSACfgCustomDataList>
Action Descriptions

Chapter 2
This action retrieves all of the WSACfgCustomData objects in the system for
update.
Return Value Type: Zero or more WSACfgCustomDataList tags
Introduced in v5.2
RetrieveAllNames
This action retrieves the list of names (list of named lists) or the
WSACfgCustomData objects in the system.
Introduced in v5.2
RetrieveForUpdate
This action retrieves all of the WSACfgCustomData objects in the system for
update.
Return Value Type: Zero or more WSACfgCustomDataList tags
Introduced in v5.2
Update
This action updates all of the WSACfgCustomData objects in the system.
Introduced in v5.2

Chapter 2
Name
Name
This is the name of the list of WSACustomData objects.
Type: String
Required
Introduced in v5.2
WSACustomDataList
List of custom data objects
This is the list of WSACustomData objects associated with this XML API.
Type: Zero or more WSACfgCustomData tags
Required
Introduced in v5.2

Chapter 2
WSACFGDistributionAssignment Tag
Distribution Assignment for Configuration
The Distribution Assignment for Configuration tag configures distribution
assignments. It is used by the Pay Code Distribution for Configuration tag.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSACFGDistributionAssignment
[ScheduledDeviation = String] >
[<ExtensionProcessorComponents>
<WSACFGExtProcessorComponent>*
</ExtensionProcessorComponents>]
[<OvertimeComponents>
<WSACFGOvertimeComponent>*
</OvertimeComponents>]
[<PaycodeAssignments>
<WSACFGPaycodeAssignment>*
</PaycodeAssignments>]
[<ZoneComponents>
<WSACFGZoneComponent>*
</ZoneComponents>]
</WSACFGDistributionAssignment>

Chapter 2
Action Descriptions
Retrieve
This is the action to retrieve a WSA Distribution Assignment for configuration.
Return Value Type: WSACFGDistributionAssignment tag
Introduced in v5.2
RetrieveForUpdate
This is the action to retrieve a WSA Distribution Assignment for configuration.
Return Value Type: WSACFGDistributionAssignment tag
Introduced in v5.2
ExtensionProcessorComponents
Extension processor components list
This is the list of Extension Processor Components for configuration.
Type: Zero or more WSACFGExtProcessorComponent tags
Optional
Introduced in v5.2
OvertimeComponents
Overtime components list
This is the list of Overtime Components for configuration.
Type: Zero or more WSACFGOvertimeComponent tags
Optional
Introduced in v5.2
PaycodeAssignments
Pay code assignment list
This is the list of pay code Assignments for configuration.

Chapter 2
Type: Zero or more WSACFGPaycodeAssignment tags

Optional
Introduced in v5.2
ScheduledDeviation
Schedule deviation component
This is the name of the Scheduled Deviation for the distribution assignment.
Type: String
Optional
Introduced in v5.2
ZoneComponents
Zone components list
This is the list of Zone Components for configuration.
Type: Zero or more WSACFGZoneComponent tags
Optional
Introduced in v5.2

Chapter 2
WSACFGExtProcessorComponent Tag
Extension Processor Component for Configuration
The Extension Processor Component for Configuration tag configures an
extension processor. It is used by the Pay Code Distribution for Configuration tag.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSACFGExtProcessorComponent
ExtentionProcessorName = String >
</WSACFGExtProcessorComponent>
Action Descriptions
Retrieve
This is the action to retrieve a Extension Processor for configuration.
Return Value Type: WSACFGExtProcessorComponent tag
Introduced in v5.2
RetrieveForUpdate
This is the action to retrieve a Extension Processor for configuration.

Chapter 2
Return Value Type: WSACFGExtProcessorComponent tag

Introduced in v5.2
ExtentionProcessorName
Name
This is the name of the Extension Processor for configuration.
Type: String
Required
Introduced in v5.2

Chapter 2
WSACFGOvertimeComponent Tag
Overtime Component for Configuration
The Overtime Component for Configuration tag configures an overtime
component. It is used by the Pay Code Distribution for Configuration tag.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSACFGOvertimeComponent
OvertimeName = String >
</WSACFGOvertimeComponent>
Action Descriptions
Retrieve
This is the action to retrieve a Overtime Component for configuration.
Return Value Type: WSACFGOvertimeComponent tag
Introduced in v5.2
RetrieveForUpdate
This is the action to retrieve a Overtime Component for configuration.

Chapter 2
Return Value Type: WSACFGOvertimeComponent tag

Introduced in v5.2
OvertimeName
Name
This is the name for the Overtime Component for configuration.
Type: String
Required
Introduced in v5.2

Chapter 2
WSACFGPaycodeAssignment Tag
Pay Code Assignment for Configuration
The Pay Code Assignment for Configuration tag configures a paycode
assignment. It is used by the Pay Code Distribution for Configuration tag.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSACFGPaycodeAssignment
PaycodeAssignmentName = String >
</WSACFGPaycodeAssignment>
Action Descriptions
Retrieve
This is the action to retrieve a Paycode Assignment
Return Value Type: WSACFGPaycodeAssignment tag
Introduced in v5.2
RetrieveForUpdate
This is the action to retrieve a Pay Code Assignment.

Chapter 2
Return Value Type: WSACFGPaycodeAssignment tag

Introduced in v5.2
PaycodeAssignmentName
Name
This is the name of the pay code assignment.
Type: String
Required
Introduced in v5.2

Chapter 2
WSACFGPaycodeDistribution Tag
Pay Code Distribution for Configuration
The Pay Code Distribution for Configuration tag configures a pay code
distribution.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"Update"
Parameters→
None
Properties→
<WSACFGPaycodeDistribution
[CombinationRule = String]
Name = String >
[<DistributionAssignments>
<WSACFGDistributionAssignment>*
</DistributionAssignments>]
</WSACFGPaycodeDistribution>
Action Descriptions
Retrieve
This is the action to retrieve a Paycode Distribution for configuration.

Chapter 2
Return Value Type: WSACFGPaycodeDistribution tag

Introduced in v5.2
This is the action to retrieve all Paycode Distributions for configuration update.
Return Value Type: Zero or more WSACFGPaycodeDistribution tags
Introduced in v5.2
RetrieveAllNames
This is the action to retrieve a list of all Paycode Distribution names for
configuration.
Introduced in v5.2
RetrieveForUpdate
This is the action to retrieve a Paycode Distribution for configuration.
Return Value Type: WSACFGPaycodeDistribution tag
Introduced in v5.2
Update
This is the action to update a Paycode Distribution for configuration.
Return Value Type: Zero or more WSACFGPaycodeDistribution tags
Introduced in v5.2

Chapter 2
CombinationRule
Combination rule
This is the Combination Rule name for configuration.
Type: String
Optional
Introduced in v5.2
DistributionAssignments
Distribution assignments for configuration
This is the list of Distribution Assignments for configuration.
Type: Zero or more WSACFGDistributionAssignment tags
Optional
Introduced in v5.2
Name
Name
This is the name of the WSA Paycode Distribution for configuration.
Type: String
Required
Introduced in v5.2

Chapter 2
WSACFGZoneComponent Tag
Zone Component for Configuration
The Zone Component for Configuration tag configures a zone component. It is
used by the Pay Code Distribution for Configuration tag.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSACFGZoneComponent
ZoneName = String >
</WSACFGZoneComponent>
Action Descriptions
Retrieve
This is the action to retrieve a Zone Component for configuration.
Return Value Type: WSACFGZoneComponent tag
RetrieveForUpdate
This is the action to retrieve a Zone Component for configuration.

Chapter 2
Return Value Type: WSACFGZoneComponent tag

Introduced in v5.2
ZoneName
Name
The name of the zone.
Type: String
Required
Introduced in v5.2

Chapter 2
WSAColumnDefinition Tag
Column Definition
The Column Definition tag is used by the Column Set tag to return the columns
composing the set.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<WSAColumnDefinition
[JavaClass = String]
Name = String
[<ColumnDefinitionDataType>
<WSAColumnDefinitionDataType>
</ColumnDefinitionDataType>]
</WSAColumnDefinition>
ColumnDefinitionDataType
Data type for column definition
Column definition data type ID with which this column definition is associated.
Type: WSAColumnDefinitionDataType tag
Optional
Introduced in v5.1

Chapter 2
DisplayName
Default display name of the column definition.
Type: String
Optional
Introduced in v5.1
ExteriorItemNumber
Item number
Unique number that identifies the ExteriorName.
Type: Integer
Optional
Introduced in v5.1
ExteriorName
Item name
Extension name. This is the name of the product.
Type: String
Optional
Introduced in v5.1
JavaClass
Java class
Java class description text.
Type: String
Optional
Introduced in v5.1
Name
Name
Name of this column definition.
Type: String
Optional Key

Chapter 2
Introduced in v5.1

Chapter 2
WSAColumnDefinitionDataType Tag
Data Type for Column Definition
The Data Type for Column Definition tag allows you to manage column
definition data types.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAColumnDefinitionDataType
ColumnDefinitionDataTypeName = String >
</WSAColumnDefinitionDataType>
Action Descriptions
Returns all column definition data types for update.
Return Value Type: Zero or more WSAColumnDefinitionDataType tags

Chapter 2
RetrieveAllNames
Returns a list of the names of all column definition data types.
Introduced in v5.1
RetrieveForUpdate
Returns the specified column definition data type for update.
Return Value Type: WSAColumnDefinitionDataType tag
Required Properties: ColumnDefinitionDataTypeName
Introduced in v5.1
ColumnDefinitionDataTypeName
Name of data type for column definition
Name of the column definition data type.
Type: String
Optional Key
Introduced in v5.1
ExteriorItemNumber
Item number
Unique number that identifies the ExteriorName.
Type: Integer
Optional
Introduced in v5.1
ExteriorName
Item name
Extension name. This is the name of the product.
Type: String

Chapter 2
Optional
Introduced in v5.1

Chapter 2
WSAColumnDetail Tag
Column Detail
The Column Detail tag allows you to manage column detail entities.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAColumnDetail
[AscendingSwitch = Integer]
[ColumnWidth = Integer]
[ContactType = String]
[CustomData = String]
[InPunchType = Integer]
OverrideDisplayName = String
[SortOrderNumber = Integer]
[VisualIndexNumber = Long] >
[<AccrualCode>
<WSAAccrualCode>
</AccrualCode>]
[<ColumnDefinition>
<WSAColumnDefinition>
</ColumnDefinition>]
[<CustomDateType>
<WSACustomDateType>
</CustomDateType>]

Chapter 2
[<ExceptionType>
<WSAExceptionType>
</ExceptionType>]
[<LaborLevelDefinition>
<WSADPLaborLevelDefinition>
</LaborLevelDefinition>]
[<OrganizationType>
<WSAOrganizationType>
</OrganizationType>]
[<PayCode>
<WSADPPayCode>
</PayCode>]
</WSAColumnDetail>
Action Descriptions
RetrieveForUpdate
Returns the specified column detail for update.
Return Value Type: WSAColumnDetail tag
Required Properties: OverrideDisplayName
Introduced in v5.1
AccrualCode
Accrual code
Accrual code assigned to this column detail.
Type: WSAAccrualCode tag
Optional
Introduced in v5.1

Chapter 2
AscendingSwitch
Ascending switch
Value that indicates whether the values retrieved for the sort order column
definition appear in ascending or descending order. The value 1 indicates
ascending; the value 0 (zero) indicates descending.
Type: Integer
Optional
Introduced in v5.1
ColumnDefinition
Column definition
Column definition associated with this column detail.
Type: WSAColumnDefinition tag
Optional
Introduced in v5.1
ColumnWidth
Assigned column width
Column width in number of pixels.
Type: Integer
Optional
Introduced in v5.1
ContactType
Assigned contact type
Contact type name with which this column detail is associated.
Type: String
Optional
Introduced in v5.1
CustomData
Assigned custom data
Custom data definition name with which this column detail is associated.

Chapter 2
Type: String
Optional
Introduced in v5.1
CustomDateType
Custom date type
Custom date type with which this column detail is associated.
Type: WSACustomDateType tag
Optional
Introduced in v5.1
DisplayName
Name in the user interface
Display name of this column detail.
Type: String
Optional
Introduced in v5.1
ExceptionType
Exception type
Exception type assigned to this column detail.
Type: WSAExceptionType tag
Optional
Introduced in v5.1
InPunchType
In punch type
Value that indicates whether the assignment value of a column detail is related to
an In or Out action.
Type: Integer
Optional
Introduced in v5.1

Chapter 2
LaborLevelDefinition
Labor level definition associated with this column detail.
Type: WSADPLaborLevelDefinition tag
Optional
Introduced in v5.1
OrganizationType
Organization type
Identifier of the organization type with which this column detail is associated.
Type: WSAOrganizationType tag
Optional
Introduced in v5.1
OverrideDisplayName
Override name in the user interface
Label name of the column detail.
Type: String
Optional Key
Introduced in v5.1
PayCode
Pay code
Pay code associated with this column detail.
Type: WSADPPayCode tag
Optional
Introduced in v5.1
SortOrderNumber
Sort order
Value that indicates which column detail is used for sorting purposes. The value 1
indicates that the column detail is a sort order column; the value 0 (zero) indicates
that it is not a sort order column.

Chapter 2
Type: Integer
Optional
Introduced in v5.1
VisualIndexNumber
Visual index number
Visual index number that determines how the order in which column details
appear in the GUI. A value of 1 indicates the leftmost column, with increasing
numbers placing columns further to the right.
Type: Long
Optional
Introduced in v5.1

Chapter 2
WSACombinationRule Tag
Combination of Overtime Rules
The Combination of Overtime Rules tag allows you to manage overtime rules. It
is used only as a subelement of the WSAOvertimeCombination tag.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSACombinationRule
[<Item>
<WSAOvertimeRule>
</Item>]
[<Key>
<WSAOvertimeRule>
</Key>]
[<Value>
<WSAOvertimeRule>
</Value>]
</WSACombinationRule>
Action Descriptions
RetrieveForUpdate
Returns the specified combination rule for update.

Chapter 2
Return Value Type: WSACombinationRule tag

Introduced in v5.1
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.
Optional
Value
Value overtime rule
Combination value associated with this combination rule.
Optional
Introduced in v5.1

Chapter 2
WSACombinedPayCodeRule Tag
Combined Pay Code Rule
The Combined Pay Code rule tag allows you to manage combined pay code rules.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSACombinedPayCodeRule
AmountType = String
[MoneyCategory = Boolean]
Name = String
[VisibleInReport = Boolean]
[VisibleToUser = Boolean] >
[<SelectedPayCodes>
<SimpleValue>*
</SelectedPayCodes>]
</WSACombinedPayCodeRule>
Action Descriptions

Chapter 2
Returns all combined pay code rules for updating.
Return Value Type: Zero or more WSACombinedPayCodeRule tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all combined pay code rules.
Introduced in v5.1
RetrieveForUpdate
Returns the specified combined pay code rule for updating.
Return Value Type: WSACombinedPayCodeRule tag
Introduced in v5.1
Update
Updates the specified combined pay code rule.
Introduced in v5.1
AmountType
Amount Type Name
The Name of the amount type associated with this pay code. If this is a "Money"
type, it indicates that the pay code displays as money in the Timecard totals. If a
pay code type of type "hour" is specified, then hours and total wages appear on

Chapter 2
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. A combined pay code of type "Day" contains the total
number of days resulting from summing the day totals for all of the contributing
pay codes during the time frame.
Type: String
Required
Valid values are "Hour", "Day" and "Money" for regular pay codes, "Time" and
(eventually but not for 6.1) "Day" for Cascade and "Time" for Linked Named
Duration.
Introduced in v6.1
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; deprecated in v6.1. This attribute has been replaced by
"Amount Type" which returns one of the following string values "Day", "Hour" or
"Money". If "IsMoneyCategory" returned true before, the value of Amount Type

Chapter 2
would now be "Money". If "IsMoneyCategory" returned false before, the value of

Amount Type would now be "Hour"
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 Key
Introduced in v5.1
SelectedPayCodes
Selected Pay Codes
List of pay codes to be combined.
Optional
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 Scheduling is installed, in the Cost
Summary tab in Schedule.
Type: Boolean
Optional
Introduced in v5.1

Chapter 2
WSAComment Tag
Setup 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
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAComment
[CodeNumber = Integer]
[Active = Boolean]
Text = String >
[<Types>
<WSACommentType>*
</Types>]
</WSAComment>
Action Descriptions

Chapter 2
Returns all comments for update.
Return Value Type: Zero or more WSAComment tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all comments.
Introduced in v5.1
RetrieveForUpdate
Returns the specified comment for update.
Return Value Type: WSAComment tag
Required Properties: Text
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. When creating a new WSAComment, at least one
WSACommentType must be supplied.
If you supply a value for the comment type/category attribute, "Types", or if you
are creating a new WSAComment, you need to provide at least one comment
category for the target comment to be assigned to.
Required Properties: Text

Chapter 2

Introduced in v5.1
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
CodeNumber
Code Number of the comment
Code Number of the comment
Type: Integer
Optional
Introduced in v5.1
Text
Name of the comment
Text of the comment. Each comment can have up to 256 characters and must be
unique. Do not use reserved characters.
Type: String
Optional Key
Required when creating a new WSAComment.
Introduced in v5.1
Types
Types assigned to the comment
One or more types assigned to a comment.
Type: Zero or more WSACommentType tags

Chapter 2
Optional
One or more WSACommentType tags are required when creating a new
WSAComment.
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSACommentType
Name = String >
</WSACommentType>
Action Descriptions
RetrieveForUpdate
Returns the specified comment type for update.
Return Value Type: WSACommentType tag
Introduced in v5.1

Chapter 2
Name
Comment name
Name of the comment type.
Type: String
Optional Key
Introduced in v5.1

Chapter 2
WSAContributingPayCodeRule Tag
Contributing Pay Code Rule
The Contributing Pay Code Rule tag allows you to manage contributing pay code
rules.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAContributingPayCodeRule
[IsContributeShftSw = Boolean]
Name = String
[IsPrepPayrollSw = Boolean] >
[<PayCodeNames>
<SimpleValue>*
</PayCodeNames>]
</WSAContributingPayCodeRule>
Action Descriptions
Returns all contributing pay code rules for updating.

Chapter 2
Return Value Type: Zero or more WSAContributingPayCodeRule tags

Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all contributing pay code rules.
Introduced in v5.1
RetrieveForUpdate
Returns the specified contributing pay code rule for updating.
Return Value Type: WSAContributingPayCodeRule tag
Introduced in v5.1
Update
Updates the specified contributing pay code rule.
Introduced in v5.1
IsContributeShftSw
Contribute Shift Switch
This flag is set if the user wishes to include the set in Contribute Shift. It can be
either 0 or 1.
Type: Boolean
Optional

Chapter 2

IsPrepPayrollSw
Prepare Payroll Switch
This flag defines if the set is to be used as part of Payroll Preparation. It can be
either 0 or 1.
Type: Boolean
Optional
Name
Name
Name of the contributing pay code rule. The name is case-insensitive and must be
unique.
Type: String
Optional Key
Introduced in v5.1
PayCodeNames
Pay code names
List of the names of pay codes that are part of the contributing pay code rule.
Optional
Introduced in v5.1

Chapter 2
WSAContributingShiftRule Tag
Contributing Shift Rule
The Contributing Shift Rule tag allows you to manage contributing shift rules.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAContributingShiftRule
[DaysOfWeekIncludeType = String]
[LookBackTime = Integer]
[LookBackUnit = String]
[MinimumShiftLength = TimeDuration]
Name = String
[ContributingPayCodeRuleName = String] >
[<Days>
<SimpleValue>*
</Days>]
</WSAContributingShiftRule>
Action Descriptions

Chapter 2
Returns all contributing shift rules for updating.
Return Value Type: Zero or more WSAContributingShiftRule tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all contributing shift rules.
Introduced in v5.1
RetrieveForUpdate
Returns the specified contributing shift rule for updating.
Return Value Type: WSAContributingShiftRule tag
Introduced in v5.1
Update
Updates the specified contributing shift rule.
Introduced in v5.1
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.

Chapter 2
Type: String
Optional
Introduced in v5.1
Days
List of days
List of those days of the week (for example, Monday, Tuesday,Wednesday,
Thursday, Friday) that count toward contributing shifts when the Specify option
is selected in the Days of the Week Include Type property.
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.

Chapter 2
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
Type: String
Optional Key
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSACoreHoursRule
[AtLeastSelected = Boolean]
[BreaksViolate_SW = Boolean]
[EndTime = Time]
[Friday = Boolean]
[Monday = Boolean]
Name = String
[StartTime = Time]
[Sunday = Boolean]
[Tuesday = Boolean]
[Wednesday = Boolean] >
</WSACoreHoursRule>

Chapter 2
Action Descriptions
Returns all core hours rules for updating.
Return Value Type: Zero or more WSACoreHoursRule tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all core hours rules.
Introduced in v5.1
RetrieveForUpdate
Returns the specified core hours rule for updating.
Return Value Type: WSACoreHoursRule tag
Introduced in v5.1
Update
Updates the specified core hours rule.
Introduced in v5.1

Chapter 2
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

Chapter 2
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 Key
Introduced in v5.1
Saturday
Saturday
Saturday. By default, this value is False.
Type: Boolean
Optional
Introduced in v5.1

Chapter 2
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
Sunday. By default, this value is False.
Type: Boolean
Optional
Introduced in v5.1
Thursday
Thursday
Thursday. By default, this value is False.
Type: Boolean
Optional
Introduced in v5.1
Tuesday
Tuesday
Tuesday. By default, this value is False.
Type: Boolean
Optional
Introduced in v5.1

Chapter 2
Wednesday
Wednesday
Wednesday. By default, this value is False.
Type: Boolean
Optional
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<WSACreditCalculator
[ApplyHour = Long]
[AverageDaysMinimum = Integer]
[AverageFixedNumber = Integer]
[AverageShiftsMinimum = Integer]
[AverageSwitch = Long]
[CreditFixedAmount = Long]
[CreditWageAmount = String]
[DefinedHolidayZone = Long]
[Grace = TimeDuration]
[HolidayDeduct = String]
[MaxAmount = Long]
[ContributingShiftName = String]
[Round = TimeDuration]
[AsIfWorkedSwitch = Boolean]
[UseAllShiftsSwitch = Boolean]
[Type = Long]
[WageCalculation = Boolean]
[WagePercent = String]
[<CreditPayCodeNames>
<SimpleValue>*
</CreditPayCodeNames>]
</WSACreditCalculator>

Chapter 2
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.

Chapter 2
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 switch for AverageType.
Type: Long
Optional
Introduced in v5.1
ContributingShiftName
Name of the contributing shift rule
Name of the associated contributing shift rule.
Type: String
Optional
Introduced in v5.1
CreditFixedAmount
Credit a fixed amount
Amount of holiday credits issued. The unit, such as amount of time, is determined
by the Type property.
Type: Long
Optional
Introduced in v5.1

Chapter 2
CreditPayCodeNames
Credit pay code rules
A list of one or more credit pay code rule names.
Optional
Introduced in v5.1
CreditWageAmount
Credit wage amount percentage
Percentage of total wages to be paid as a holiday credit. The unit, such as amount
of currency, is determined by the Type property.
Type: String
Optional
Introduced in v5.1
DefinedHolidayZone
Defined holiday zone
Defined holiday zone.
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

Chapter 2
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
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

Chapter 2
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

Chapter 2
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

Chapter 2
WSACriteriaSet Tag
Criteria Set
The Criteria Set tag allows you to manage criteria sets.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSACriteriaSet
Name = String
[EvaluationRuleTypeID = Long] >
</WSACriteriaSet>
Action Descriptions
Returns all criteria sets for update.
Return Value Type: Zero or more WSACriteriaSet tags
Introduced in v5.1

Chapter 2
RetrieveAllNames
Returns a list of the names of all criteria sets.
Introduced in v5.1
RetrieveForUpdate
Returns the specified criteria set for update.
Return Value Type: WSACriteriaSet tag
Introduced in v5.1
Description
Description
Description of the criteria set.
Type: String
Optional
Introduced in v5.1
EvaluationRuleTypeID
Evaluation rule type id
Evaluation rule type id.
Type: Long
Optional
Introduced in v5.1
Name
Criteria set name
Name of the criteria set.
Type: String

Chapter 2
Optional Key
Introduced in v5.1

Chapter 2
WSACustomDate Tag
Custom Date
The Custom Date tag allows you to define and manage custom dates that are
reference dates for date patterns or company wide dates that do not vary.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
Update→
[NewName = String]
Properties→
<WSACustomDate
Date = Date
[SiteWide = Boolean]
Name = String
ReferenceCustomDate = String >
</WSACustomDate>
Action Descriptions
Retrieves all custom dates.
Return Value Type: Zero or more CustomDate tags

Chapter 2

Introduced in v5.2
RetrieveAllNames
Retrieves the names of all the custom dates.
Introduced in v5.2
RetrieveForUpdate
Retrieves the named custom date. Used by Setup Data Manager.
Return Value Type: Zero or more CustomDate tags
Introduced in v5.2
Update
Updates the specified custom date if it exists; otherwise the custom date is added.
Introduced in v5.2
Action Parameters

NewName New name for the custom date. Introduced in v5.2
Optional
Date
Date
The calendar date for a site wide date.

Chapter 2
Type: Date
Required
Introduced in v5.2
Name
Name
Name of the custom date. Length must be between 1 and 30 characters.
Type: String
Required Key
Introduced in v5.2
ReferenceCustomDate
Reference custom date
The custom date that the current custom date inherits from if this is a person
specific date.
Type: String
Required
Introduced in v5.2
SiteWide
Is the date site wide?
Set to true to indicate that this custom date is a site wide date.
Type: Boolean
Optional
Introduced in v5.2

Chapter 2
WSACustomDateType Tag
Custom Date Type
The Custom Date Type tag allows you to define and manage custom date types.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSACustomDateType
ShortName = String >
</WSACustomDateType>
Action Descriptions
Returns all custom date types for update.
Return Value Type: Zero or more WSACustomDateType tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all custom date types.

Chapter 2

Introduced in v5.1
RetrieveForUpdate
Updates the specified custom date type.
Return Value Type: WSACustomDateType tag
Required Properties: ShortName
Introduced in v5.1
ShortName
Name of custom date type
Name of the custom date.
Type: String
Optional Key
Introduced in v5.1

Chapter 2
WSACustomUrl Tag
Custom URL
The Custom URL tag allows you to define and manage custom URLs.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSACustomUrl
[Popup = Boolean]
[NavBar = Boolean]
[OrderNum = Integer]
[UrlText = String] >
</WSACustomUrl>
Action Descriptions
Returns all custom URLs for update.
Return Value Type: Zero or more WSACustomUrl tags

Chapter 2
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all custom URLs.
Introduced in v5.1
RetrieveForUpdate
Returns the specified URL for update.
Return Value Type: WSACustomUrl tag
Introduced in v5.1
Update
Updates the specified URL.
Introduced in v5.1
DisplayName
Name in the user interface
Display name of the URL.
Type: String
Optional Key
Introduced in v5.1

Chapter 2
NavBar
Navigation bar
Boolean value that, when True, indicates that the URL has been marked as having
a window with a navigation bar.
Type: Boolean
Optional
Introduced in v5.1
OrderNum
Order number
Position of the URL within the URL profile.
Type: Integer
Optional
Introduced in v5.1
Popup
Is the item marked as a popup?
Boolean value that, when True, indicates that the URL has been marked as a
popup.
Type: Boolean
Optional
Introduced in v5.1
UrlText
Text in the URL
The Url Text
Type: String
Optional
Introduced in v5.1

Chapter 2
WSACustomUrlProfile Tag
Profile for Custom URL
The Profile for Custom URL tag allows you to define and manage custom URL
profiles.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSACustomUrlProfile
Name = String
[<Urls>
<WSACustomUrl>*
</Urls>]
[<GeniesUrls>
<WSACustomUrl>*
</GeniesUrls>]
</WSACustomUrlProfile>
Action Descriptions

Chapter 2
Returns all custom URL profiles for update.
Return Value Type: Zero or more WSACustomUrlProfile tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all custom URL profiles.
RetrieveForUpdate
Returns the specified URL profile for update.
Return Value Type: WSACustomUrlProfile tag
Introduced in v5.1
Update
Updates the specified URL profile.
Introduced in v5.1
Description
Description
Description of this URL profile.
Type: String

Chapter 2
Optional
Introduced in v5.1
DisplayDescription
Description that is displayed in the user interface for this URL profile.
Type: String
Optional
Introduced in v5.1
DisplayName
Name that is displayed in the user interface for this URL profile.
Type: String
Optional
Introduced in v5.1
GeniesUrls
URLs list
List of one or more URLs.
Type: Zero or more WSACustomUrl tags
Optional
Introduced in v5.1
Name
Name
Name of the external URL.
Type: String
Optional Key
Introduced in v5.1
Urls
Available URLs
List of one or more URLs associated with this profile.

Chapter 2
Type: Zero or more WSACustomUrl tags

Optional
Introduced in v5.1

Chapter 2
WSADateFinder Tag
Date Finder
The Date Finder tag stores various date configurations for Accruals.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSADateFinder
[CustomDateType = String]
DayOfInterval = Integer
MonthOfInterval = Integer
StartStrategyType = String
TimeUnitType = String
DateFinderType = String >
</WSADateFinder>
Action Descriptions
Retrieve
Retrieves a WSADateFinder object
Return Value Type: WSADateFinder tag

Chapter 2

RetrieveForUpdate
Returns a WSADateFinder bean
Return Value Type: WSADateFinder tag
Introduced in v5.2
CustomDateType
Custom date type
The custom Date Type Name
Type: String
Optional
DateFinderType
Type
The Date Finder Type
Type: String
Required
DayOfInterval
Day of interval
The Day of interval
Type: Integer
Required
MonthOfInterval
Month of interval
The Month of Interval

Chapter 2
Type: Integer
Required
StartStrategyType
Start strategy type
The Start Strategy Type.
Type: String
Required
TimeUnitType
Time unit type
The Time Unit Type
Type: String
Required

Chapter 2
WSADatePattern Tag
Date Pattern
The Date Pattern tag defines a predictable sequence of dates; for example, the first
of every year, the seventh day of every pay period, and Monday of each week.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"Update"
Parameters→
None
Properties→
<WSADatePattern
ExpectedHours = TimeDuration
[Name = String]
OffsetAmount = Integer
[OffsetDateName = String] >
[<DateFinder>
<WSADateFinder>
</DateFinder>]
<Interval>
<WSAInterval>
</Interval>
</WSADatePattern>

Chapter 2
Action Descriptions
Delete
Deletes a Date Pattern
Introduced in v5.2
Retrieve
Retrieves a DatePattern bean
Return Value Type: WSADatePattern tag
Introduced in v5.2
Retrieve a list of Date Pattern Beans
Return Value Type: Zero or more WSADatePattern tags
Introduced in v5.2
RetrieveAllNames
Retrieves all DatePattern Names.
Introduced in v5.2
RetrieveForUpdate
Retrieves a Date Pattern bean.
Return Value Type: WSADatePattern tag

Chapter 2

Update
Updates a Date Pattern Bean
Introduced in v5.2
DateFinder
Date finder
A DateFinder object.
Type: WSADateFinder tag
Optional
ExpectedHours
Expected hours
The expected hours attribute.
Type: TimeDuration
Required
Introduced in v5.2
Interval
Interval
A WSAInterval bean
Required
Introduced in v5.2

Chapter 2
Name
Name
The name of the Date Pattern.
Type: String
Optional
OffsetAmount
Offset amount
The offset amount attribute.
Type: Integer
Required
Introduced in v5.2
OffsetDateName
Offset date name
The Offset Date Name.
Type: String
Optional
Introduced in v5.2

Chapter 2
WSADayMonthSpan Tag
Day-Month Span
The Day-Month Span tag corresponds to the DayMonthSpan object that is used by
Limits and Taking Limits.
It stores values for start day, start month, end day, and end month. This tag is used
only in conjunction with other top levels objects, such as Limits and Taking
Limits.
All attributes are non-nullable
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSADayMonthSpan
[EndDay = Integer]
[EndMonth = Integer]
[StartDay = Integer]
[StartMonth = Integer] >
</WSADayMonthSpan>
Action Descriptions

Chapter 2
Retrieve
Returns an instance of WSADayMonthSpan (uninitialized).
Return Value Type: WSADayMonthSpan tag
Introduced in v5.2
RetrieveForUpdate
Returns an instance of WSADayMonthSpan (uninitialized).
Return Value Type: WSADayMonthSpan tag
Introduced in v5.2
EndDay
End Day
End Day of the span.
Type: Integer
Optional
Introduced in v5.2
EndMonth
End Month
End month of the span. For January the value is 1.
Type: Integer
Optional
Introduced in v5.2
StartDay
Start Day
Start Day of the span.
Type: Integer
Optional

Chapter 2
Introduced in v5.2
StartMonth
Start Month
Start month of the span. For January the value is 1.
Type: Integer
Optional
Introduced in v5.2

Chapter 2
WSADaysOfWeek Tag
Days of Week
Internal use only. For use with Zone/Zone Combination rules.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSADaysOfWeek
[Friday = Boolean]
[Monday = Boolean]
[Sunday = Boolean]
[Tuesday = Boolean]
[AtLeastSelected = Boolean] >
</WSADaysOfWeek>
Action Descriptions
RetrieveForUpdate
Retrieve the specified instance from the DB
Return Value Type: WSADaysOfWeek tag

Chapter 2
Introduced in v5.1
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

Chapter 2
Sunday
Is Sunday included?
Boolean value that, when True, indicates that Sunday is included.
Type: Boolean
Optional
Introduced in v5.1
Thursday
Is Thursday 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

Chapter 2
WSADetail Tag
Detail Records
The Detail Records tag allows you to manage detail records.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSADetail
Name = String
[<NavbarCategory>
<WSANavbarCategory>
</NavbarCategory>]
[<ColumnSet>
<WSAWfgColumnSet>
</ColumnSet>]
<WSAHyperfindQuery>
<WSADPTimePeriod>

Chapter 2
</WSADetail>
Action Descriptions
Retrieve all instances from the DB
Return Value Type: Zero or more WSADetail tags
Introduced in v5.1
RetrieveAllNames
Retrieve the names of all instances in the DB
RetrieveForUpdate
Return Value Type: WSADetail tag
Introduced in v5.1
Update
Update the specified instance
Introduced in v5.1

Chapter 2
ColumnSet
Column set that is assigned
The assigned Column Set
Optional
Introduced in v5.1
Default query that is assigned
The assigned Default Hyperfind Query
Optional
Introduced in v5.1
DefaultTimePeriod
Default time period that is assigned
The assigned Default Time Period
Optional
Introduced in v5.1
Description
Description
The Description
Type: String
Optional
Introduced in v5.1
DisplayDescription
The Display Description
Type: String
Optional

Chapter 2
Introduced in v5.1
DisplayName
The Display Name
Type: String
Optional
Introduced in v5.1
Name
Name
Name of the specified instance
Type: String
Optional Key
Introduced in v5.1
NavbarCategory
Category of the assigned navigation bar
The assigned Navbar Category
Optional
Introduced in v5.1

Chapter 2
WSADetailColumnSet Tag
Detail Column Set
The Detail Column Set tag allows you to manage detail column sets.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSADetailColumnSet
Name = String
[<ColumnDetail>
<WSAColumnDetail>*
</ColumnDetail>]
</WSADetailColumnSet>
Action Descriptions

Chapter 2
Return Value Type: Zero or more WSADetailColumnSet tags
Introduced in v5.1
RetrieveAllNames
Retrieve the names of all instances in the system
RetrieveForUpdate
Return Value Type: WSADetailColumnSet tag
Introduced in v5.1
Update
Introduced in v5.1
ColumnDetail
The set of assigned column details

Chapter 2
Optional
Introduced in v5.1
Description
Description
The Description
Type: String
Optional
Introduced in v5.1
DisplayDescription
Type: String
Optional
Introduced in v5.1
DisplayName
The Display Name
Type: String
Optional
Introduced in v5.1
ExteriorItemNumber
Item number
The Exterior Item Number
Type: Long
Optional
Introduced in v5.1
ExteriorName
Item name
The Exterior Name

Chapter 2
Type: String
Optional
Introduced in v5.1
Name
Name
The Name of the instance
Type: String
Optional Key
Introduced in v5.1

Chapter 2
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 timekeeping. 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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSADisplayOrder
Name = String >
[<PaycodesList>
<WSADispOrdOptionalRule>*
</PaycodesList>]
</WSADisplayOrder>
Action Descriptions

Chapter 2
Returns all display orders for updating.
Return Value Type: Zero or more WSADisplayOrder tags
RetrieveAllNames
Returns a list of the names of all display orders.
Introduced in v5.1
RetrieveForUpdate
Returns the specified display order for updating.
Return Value Type: WSADisplayOrder tag
Introduced in v5.1
Update
Updates the specified display order.
Introduced in v5.1
Name
Name of the display order
Name of the display order. The name is case-insensitive and must be unique.
Type: String

Chapter 2
Optional Key
Introduced in v5.1
PaycodesList
Pay codes list
Ordered list of paycodes.
Type: Zero or more WSADispOrdOptionalRule tags
Optional
Introduced in v5.1

Chapter 2
WSADisplayProfile Tag
Display Profile
The Display Profile profile tag allows you to manage display profiles.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"Update"
Parameters→
None
Properties→
<WSADisplayProfile
(AccrualDetailGenieForTimeCardDisplayName = String)
[AccrualDetailGenieForScheduleEditorName = String]
[AccrualDetailGenieForTimeCardName = String]
[AccrualTotalsAccrualBalanceOnSelectedDateLabelText =
String]
[AccrualTotalsAccrualCodeLabelText = String]
[AccrualTotalsAccrualUnitsLabelText = String]
[EditFutureTimecardsSwitch = Boolean]
[UseShorthandLaborAccountNotationSwitch = Boolean]
(AveragingDetailGenieForTimeCardDisplayName = String)
[AveragingDetailGenieForTimeCardName = String]
[AveragingTabLabelOnTimeCard = String]
[DayDurationDisplaySwitch = Boolean]

Chapter 2
[DisplayAccrualsInScheduleEditorLegacyDisplaySwitch =
Boolean]
[DisplayAccrualsOnScheduleSwitch = Boolean]
[DisplayAccrualsOnTimeCardLegacySwitch = Boolean]
[DisplayAccrualsOnTimeCardReportingPeriodSwitch = Boolean]
[DisplayAccrualsOnTimeCardSwitch = Boolean]
[DisplayAccrualsTotalsBalancesInMainTimeCardViewSwitch =
Boolean]
[ScheduledShiftDisplaySwitch = Boolean]
[DisplayFormatSwitch = Boolean]
[IsDefaultSwitch = Boolean]
[LegacyAccrualsTabLabelOnTimeCard = String]
Name = String
[CalendarProfileName = String]
[WorkforceGenieProfileName = String]
[CustomUrlProfileName = String]
[HyperfindQueryProfileName = String]
[WorkloadPlannerProfileName = String]
[NavProfileName = String]
[NumberOfFutureDays = Integer]
[ProjectViewStartDay = Long]
[ReportingPeriodAccrualsTabLabelOnTimeCard = String]
[SchedulePeriodName = String]
[ShowJobLocationDescriptionSwitch = Boolean]
[ShowLaborLevelEntryDescriptionSwitch = Boolean]
[DurationDisplaySwitch = Boolean]
[DisplayTimecardEditorTotalsSwitch = Boolean]
[DefaultAttendanceTab = String] >
[<LaborLevelNames>
<SimpleValue>*
</LaborLevelNames>]
[<LaborLevelSwitches>
<SimpleValue>*
</LaborLevelSwitches>]
</WSADisplayProfile>
Action Descriptions

Chapter 2
Delete
This action delete display profile by name
Introduced in v6.0
Retrieve
This action retrieves Display Profile by name
Return Value Type: WSADisplayProfile tag
Introduced in v6.0
Return Value Type: Zero or more WSADisplayProfile tags
Introduced in v5.1
RetrieveAllNames
Introduced in v5.1
RetrieveForUpdate
Return Value Type: WSADisplayProfile tag
Introduced in v5.1

Chapter 2
Update
On Create, "DisplayName" and "SchedulePeriodName" are required but "Name"
is not. On an update, both "Name" and "DisplayName" are required.
Required Properties: DisplayName, Name, SchedulePeriodName
AccrualDetailGenieForScheduleEditorName
Accrual Detail Genie Name for Schedule Editor
Accrual Detail Genie name for scheduler editor
Type: String
Optional
Introduced in v6.0
AccrualDetailGenieForTimeCardDisplayName
Accrual Detai lGenie For Time Card Display Name
The accrual Detail Genie For Time Card Display Name. If an
ìAccrualDetailGenieForTimeCardDisplayNameî value is passed in through an
update request to the DisplayProfile API, its value will be ignored.
Type: String
Output only
Introduced in v6.0
AccrualDetailGenieForTimeCardName
Accrual Detail Genie name for Time Card
Accrual Detail Genie (WSAAccuralDetail) name for Time card.
Type: String
Optional

Chapter 2
Introduced in v6.0
AccrualTotalsAccrualBalanceOnSelectedDateLabelText
Accrual Totals Accrual Balance On selected Date Label Text
Label text of Accrual Totals Accrual Balance on selected date
Type: String
Optional
Introduced in v6.0
AccrualTotalsAccrualCodeLabelText
Accrual Totals Accrual Code Label Text
Accrual Totals Accrual Code Label Text
Type: String
Optional
Introduced in v6.0
AccrualTotalsAccrualUnitsLabelText
Accrual totals Accrual Units Label text
Label text of Accrual totals Accrual Units
Type: String
Optional
Introduced in v6.0
AveragingDetailGenieForTimeCardDisplayName
Averaging Detail Genie DisplayName For TimeCard
Averaging Detail Genie DisplayName For TimeCard
Type: String
Output only
Introduced in v6.1
AveragingDetailGenieForTimeCardName
Averaging Detail Genie Name For TimeCard
Averaging Detail Genie Name For TimeCard
Type: String

Chapter 2
Optional
Introduced in v6.1
AveragingTabLabelOnTimeCard
Averaging Reporting Period Genie Tab Label On TimeCard
Averaging Reporting Period Genie Tab Label On TimeCard
Type: String
Optional
Introduced in v6.1
CalendarProfileName
Name of calendar profile
The associated Calendar Profile Name
Type: String
Optional
Introduced in v5.1
CustomUrlProfileName
Name of the associated custom URL profile
The associated Custom Url Profile Name
Type: String
Optional
Introduced in v5.1
DayDurationDisplaySwitch
Day-Based Duration Display Format Selector
Determines how day-based accruals duration values are displayed. If this attribute
is set to "true", then these values are displayed using the pattern "DD.dd" (days
and hundredths of days) whereas if this is set to "false", they are displayed using
the pattern "DD:HH:mm" (days, hours and minutes).
Type: Boolean
Optional

Chapter 2
Introduced in v6.0
DefaultAttendanceTab
The name of the default tab in the attendance editor
The name of the default tab in the attendance editor
Type: String
Optional
Introduced in v6.0
Description
Description
The Description
Type: String
Optional
Introduced in v5.1
DisplayAccrualsInScheduleEditorLegacyDisplaySwitch
Display Accrual In Schedule Editor Legacy Display Switch
Display Accrual In Schedule Editor Original Display Switch.
Type: Boolean
Optional
Introduced in v6.0
DisplayAccrualsOnScheduleSwitch
Display Accrual On Schedule Switch
Display Accrual on Schedule Switch
Type: Boolean
Optional
Introduced in v6.0
DisplayAccrualsOnTimeCardLegacySwitch
Display Accrual On TimeCard Legacy Switch
Display Accrual On TimeCard Legacy Switch
Type: Boolean

Chapter 2
Optional
Introduced in v6.0
DisplayAccrualsOnTimeCardReportingPeriodSwitch
Display Accruals On TimeCard Reporting Period Switch
Display Accruals On TimeCard Reporting Period Switch
Type: Boolean
Optional
Introduced in v6.0
DisplayAccrualsOnTimeCardSwitch
Display Accruals On TimeCard Switch
Display Accruals On TimeCard Switch
Type: Boolean
Optional
Introduced in v6.0
DisplayAccrualsTotalsBalancesInMainTimeCardViewSwitch
Display Accruals Totals Balances In Main Time Card View Switch
Display Accruals Totals Balances In Main Time Card View Switch
Type: Boolean
Optional
Introduced in v6.0
DisplayDescription
Type: String
Optional
Introduced in v5.1
DisplayFormatSwitch
Is the format switch displayed?
The Display Format Switch

Chapter 2
Type: Boolean
Optional
Introduced in v5.1
DisplayName
The Display Name
Type: String
Optional
Introduced in v5.1
DisplayTimecardEditorTotalsSwitch
Show totals from timecard editor?
The Display Timecard Editor Totals Switch
Type: Boolean
Optional
Introduced in v5.1
DurationDisplaySwitch
Show time duration?
The Duration Display Switch
Type: Boolean
Optional
Introduced in v5.1
EditFutureTimecardsSwitch
Allow editing of future timecards?
The Edit Future Timecards Switch
Type: Boolean
Optional
Introduced in v5.1

Chapter 2
HyperfindQueryProfileName
Name of the assoicated Hyperfind Query Profile
This property allows a Hyperfind Query Profile to be associated with a group of
employees/users.
All the public Hyperfind Queries held in a user's Hyperfind Query Profile can be
accessed by this user.
There are two special Hyperfind Query Profiles:
&ALL_HFQUERYS Holds all public Hyperfind Queries.
&EMPTY Holds no Hyperfind Query at all.
Type: String
Optional
Introduced in v6.1
IsDefaultSwitch
Is this the default display profile?
The Is Default Switch. If the attribute is specified, the value must be true which
will make the specified Display Profile the default and set any other existing
default Display Profile's default switch to false. If the attribute is not specified,
then the Display Profile's IsDefaultSwitch will not be altered. For a new Display
Profile, the switch's value is set to false when not specified.
Type: Boolean
Optional
LaborLevelNames
Labor level names
The list of Labor Level Names (Strings)
Optional
Introduced in v5.1

Chapter 2
LaborLevelSwitches
Switches in the set of labor levels
The collection of Labor Level Switches (Booleans)
Optional
Introduced in v5.1
LegacyAccrualsTabLabelOnTimeCard
Legacy Accruals Tab Label On TimeCard
Legacy Accruals Tab Label On TimeCard
Type: String
Optional
Introduced in v6.0
Name
Name
The Name of the entity.
Type: String
Optional Key
Introduced in v5.1
NavProfileName
Type: String
Optional
Introduced in v6.0
NumberOfFutureDays
Number of days in the future that are shown
The Number Of Future Days
Type: Integer
Optional

Chapter 2
Introduced in v5.1
ProjectViewStartDay
Project view start day
The Project View Start Day
Type: Long
Optional
Introduced in v5.1
ReportingPeriodAccrualsTabLabelOnTimeCard
Reporting Period Accruals Tab Label On Time Card
Reporting Period Accruals Tab Label On Time Card
Type: String
Optional
Introduced in v6.0
ScheduledShiftDisplaySwitch
Is a scheduled shift displayed?
The Scheduled Shift Display Switch
Type: Boolean
Optional
Introduced in v5.1
SchedulePeriodName
The Schedule Period Name
Type: String
Optional
Introduced in v5.1
ShowJobLocationDescriptionSwitch
Show the description of the job location?
Show Job Location Description Switch
Type: Boolean

Chapter 2
Optional
Introduced in v5.1
ShowLaborLevelEntryDescriptionSwitch
Show the description of the labor level entry?
Show LaborLevel Entry Description Switch
Type: Boolean
Optional
Introduced in v5.1
UseShorthandLaborAccountNotationSwitch
Allow shorthand labor account entries?
Use Shorthand Labor Account Notation Switch
Type: Boolean
Optional
Introduced in v5.1
WorkforceGenieProfileName
Name of profile
The name of WorkforceGenieProfileName
Type: String
Optional
Introduced in v5.1
WorkloadPlannerProfileName
Name of the workload planner profile
The Workload Planner Profile Name
Type: String
Optional
Introduced in v5.1

Chapter 2
WSADisplayProfileWorkforceGenieProfile Tag
Building Block for Display Profile
This tag retrieves a specified display profile building block.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSADisplayProfileWorkforceGenieProfile
Name = String >
</WSADisplayProfileWorkforceGenieProfile>
Action Descriptions
RetrieveForUpdate
Return Value Type: WSADisplayProfileWorkforceGenieProfile tag
Introduced in v5.1

Chapter 2
Name
Name of the building block
The name of the building block to be retrieved.
Type: String
Optional Key
Introduced in v5.1

Chapter 2
WSADispOrdOptionalRule Tag
Display Order Optional Rule
The Display Order Optional Rule tag allows you to manage the display order
optional rule.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSADispOrdOptionalRule
Name = String
[ListOrder = Integer] >
</WSADispOrdOptionalRule>
Action Descriptions
RetrieveForUpdate
Retrieves for Update
Return Value Type: WSADispOrdOptionalRule tag
Introduced in v5.1

Chapter 2
ListOrder
Order of the list
The List Order
Type: Integer
Optional
Introduced in v5.1
Name
Name
The Name
Type: String
Optional Key
Introduced in v5.1

Chapter 2
WSADPLaborLevelDefinition Tag
Labor Level Definition for Display Preferences
The Labor Level Definition for Display Preferences tag allows you to manage
labor level definitions within the context of the display preferences module.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSADPLaborLevelDefinition
[CheckedOnRollup = Boolean]
Name = String >
</WSADPLaborLevelDefinition>
Action Descriptions
Retrieve All the instances defined in the DB
Return Value Type: Zero or more WSADPLaborLevelDefinition tags
Introduced in v5.1

Chapter 2
RetrieveAllNames
Introduced in v5.1
RetrieveForUpdate
Return Value Type: WSADPLaborLevelDefinition tag
Introduced in v5.1
CheckedOnRollup
Is the rollup flag checked?
The Checked On Rollup Flag
Type: Boolean
Optional
Introduced in v5.1
Name
Name
Type: String
Optional Key
Introduced in v5.1

Chapter 2
WSADPPayCode Tag
Pay Code for Display Preferences
The Pay Code for Display Preferences tag allows you to manage pay codes within
the context of the display preferences module.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSADPPayCode
Name = String >
</WSADPPayCode>
Action Descriptions
Return Value Type: Zero or more WSADPPayCode tags
Introduced in v5.1

Chapter 2
RetrieveAllNames
Introduced in v5.1
RetrieveForUpdate
Return Value Type: WSADPPayCode tag
Introduced in v5.1
Name
Name
Type: String
Optional Key
Introduced in v5.1

Chapter 2
WSADPTimePeriod Tag
Time Period for Display Preferences
The Time Period for Display Preferences tag allows you to manage time periods
within the context of the display preferences module.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSADPTimePeriod
Name = String >
</WSADPTimePeriod>
Action Descriptions
Return Value Type: Zero or more WSADPTimePeriod tags
Introduced in v5.1

Chapter 2
RetrieveAllNames
Introduced in v5.1
RetrieveForUpdate
Return Value Type: WSADPTimePeriod tag
Introduced in v5.1
Name
Name
Type: String
Optional Key
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve"
Parameters→
None
Properties→
<WSAEffectivePayRule
[LaborAccountAndJobTransfers = Boolean]
[FixedRuleName = String]
[HolidayCreditRuleName = String]
[SequenceRuleName = String]
[WorkRuleName = String]
[CancelPFSOnHolidays = Boolean]
EffectiveDate = Long
[ApplyOnly = Boolean]
[PayFromSchedule = Boolean]
[ScheduleTotal = Boolean]
[WorkRuleTransfers = Boolean]
[TransferRegularHome = Boolean]
[ExtensionProcessorNames = String list]

Chapter 2
Name = String
[QualifiedSignOffRuleName = String]
[TerminalRuleName = String]
[PrepopulateProject = 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
Introduced in v5.1
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

Chapter 2
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
CancelPFSOnHolidays
Cancel pay from schedule on holidays
This attribute controls whether the pay from schedule feature is enabled for the
represented version of the pay rule on holidays or not.
Type: Boolean
Optional
Either true or false
Sample values:
false

Introduced in v6.0
EffectiveDate
Effective date
Effective date span of this pay rule version.
Type: Long
Optional Key
Introduced in v5.1
ExtensionProcessorNames
List of extension processor names

Chapter 2
Type: String list

Optional
Introduced in v5.2
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

Chapter 2
Optional
Introduced in v5.1
Name
Name
Name of the pay rule. The name is case-insensitive and must be unique.
Type: String
Optional Key
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

Chapter 2
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
TransferRegularHome
Is transfer regular home enabled?
Boolean value that, when True, enables regular home transfer for this effective
pay rule.
Type: Boolean
Optional
Introduced in v5.2

Chapter 2
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

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve"
Parameters→
None
Properties→
<WSAEffectiveWorkRule
[CallInRuleName = String]
[DayDivideOverride = String]
EffectiveDate = Long
[ExceptionRuleName = String]
[ExtensionProcessorNames = String list]
[PayCodeDistributionName = String]
[RoundRuleName = String]
[ShiftGuaranteeName = String]
Name = String
[UnapprovedOvertimePayCodeName = String] >
[<AutoBreakPlacement>
<WSAAutoBreakPlacement>
</AutoBreakPlacement>]
[<WorkRuleGeneral>
<WSAWorkRuleGeneral>
</WorkRuleGeneral>]
[<WorkRulePCDistr>

Chapter 2
<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
Introduced in v5.1
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

Chapter 2
Optional
Introduced in v5.1
EffectiveDate
Effective date
Effective date span of this work rule version.
Type: Long
Optional Key
Introduced in v5.1
ExceptionRuleName
Exception rule
Name of associated exception rule.
Type: String
Optional
Introduced in v5.1
ExtensionProcessorNames
A list of Work Rule Processor names
Type: String list
Optional
Name
Name of the work rule version
Name of the work rule version. The name is case-insensitive and must be unique.
Type: String
Optional Key
Introduced in v5.1
PayCodeDistributionName
Name of pay code distribution
Name of associated pay code distribution.

Chapter 2
Type: String
Optional
Introduced in v5.1
RoundRuleName
Name of rounding rule
Name of associated interval round rule or punch round rule.
Type: String
Optional
Introduced in v5.1
ShiftGuaranteeName
Name of shift guarantee
Name of associated shift guarantee.
Type: String
Optional
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

Chapter 2
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

Chapter 2
WSAEligibilityDeterminer Tag
Eligibility Requirements
The Eligibility Requirements tag allows you to manage the requirements an
employee must meet to be eligible for holiday credits.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<WSAEligibilityDeterminer
[MinimumTimeActiveValue = Integer]
[ScheduledShiftTypeSwitch = Boolean]
[MinimumTimeEmployedValue = Integer]
[AfterHolidaySwitch = Boolean]
[EitherBeforeOrAfterHolidaySwitch = Boolean]
[BeforeHolidaySwitch = Boolean]
[OnHolidaySwitch = Boolean]
[AlternateHolidayCreditRuleName = String]
[MustSatisfyAllSwitch = Boolean]
[MinimumTimeActiveUnit = String]
[MinimumTimeEmployedUnit = String] >
[<EligibilityWorkHistoryQualifierNames>
<SimpleValue>*
</EligibilityWorkHistoryQualifierNames>]
</WSAEligibilityDeterminer>

Chapter 2
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
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

Chapter 2
EligibilityWorkHistoryQualifierNames
Work history qualifiers
One or more work history qualifiers that must be satisfied in order for an
employee to receive this credit.
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 eligible 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 minimum 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

Chapter 2
MinimumTimeEmployedValue
Minimum time employed 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
Dependency: If specified, MinimumTimeEmployedUnit must also be specified.
Introduced in v5.1
MustSatisfyAllSwitch
Satisfy all work history qualifiers?
Boolean value that, when True, indicates that the employee must satisfy all
selected work history qualifiers to be eligible for this credit.
Type: Boolean
Optional
Introduced in v5.1
OnHolidaySwitch
Must the employee work on the holiday?
Boolean value that, when True, indicates that the employee must work on the
Type: Boolean
Optional
Introduced in v5.1
ScheduledShiftTypeSwitch
Is the scheduled shift type used?
Boolean value that, when True, indicates that the employee must work the
scheduled shift to receive this credit. When this value is False, the employee can
work any shift on the day of her or his scheduled shift.
Type: Boolean
Optional
Introduced in v5.1

Chapter 2
WSAExceptionRule Tag
Exception Rule
The Exception Rule tag allows you to define and manage rules by that identify
employees who arrive at work early or late, leave work early or late, forget to
punch out, work when not scheduled, have total break minutes that are too long or
too short within a shift, or have breaks that are taken out of sequence.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAExceptionRule
[EarlyOutNdPayCodeName = String]
[InEarly = TimeDuration]
[InLate = TimeDuration]
[InVeryEarly = TimeDuration]
[LateInNdPayCodeName = String]
[LongInterval = TimeDuration]
Name = String
[OutEarly = TimeDuration]
[OutLate = TimeDuration]
[OutVeryLate = TimeDuration]

Chapter 2
[ShortShift = TimeDuration]
[Unscheduled = Boolean] >
[<TotalBreakExceptions>
<TotalBreakException>*
</TotalBreakExceptions>]
</WSAExceptionRule>
Action Descriptions
Returns all exception rules for updating.
Return Value Type: Zero or more WSAExceptionRule tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all exception rules.
Introduced in v5.1
RetrieveForUpdate
Returns the specified exception rule for updating.
Return Value Type: WSAExceptionRule tag
Introduced in v5.1
Update
Updates the specified exception rule.

Chapter 2
Introduced in v5.1
EarlyOutNdPayCodeName
Early out duration pay code name
This field holds the name of the named duration pay code which is used as the
default named duration to use when creating named duration make up edits in the
case of an early out exception being detected on the time card and the user
choosing to resolve that exception automatically (using a right mouse click/
resolve exception or using the menu item both on the time card).
Type: String
Optional
If a name is supplied for this field, it must represent a pay code which previously
exists in the database which is of the type "duration" (representing a named
duration).
Sample values:
My Named Duration Pay Code Name
Default value: Null (empty)

Introduced in v6.1
Grace
Grace
The grace period used for time in excess of the total paid break amount.
Type: TimeDuration
Optional
Default value: 0:00
Introduced in v6.1

Chapter 2
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
LateInNdPayCodeName
Late in duration pay code name
This field holds the name of the named duration pay code which is used as the
default named duration to use when creating named duration make up edits in the
case of an late in exception being detected on the time card and the user choosing
to resolve that exception automatically (using a right mouse click/resolve
exception or using the menu item both on the time card).

Chapter 2
Type: String
Optional
If a name is supplied for this field, it must represent a pay code which previously
exists in the database which is of the type "duration" (representing a named
duration).
Sample values:
My Named Duration Pay Code Name
Introduced in v6.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
Name of exception rule. The name can be up to 32 characters long, is case-
Type: String
Optional Key
Introduced in v5.1
OutEarly
Out Early
Amount for early out-punches in HH:mm format. Exceptions occur when
employees punch out before their scheduled end times and at or before the early
out amount. The default is 24:00, which disables these exceptions.

Chapter 2
Type: TimeDuration
Optional
Introduced in v5.1
OutLate
Out Late
Amount for late out-punches in HH:mm format. Exceptions occur when
employees punch out after their scheduled end times and at or after the late out
amount.
Type: TimeDuration
Optional
Introduced in v5.1
OutVeryLate
Out Very Late
Amount for very late out-punches in HH:mm format. Exceptions occur when
employees punch out after their scheduled end times and at or after the very late
out amount. The default is 24:00, which disables these exceptions.
Type: TimeDuration
Optional
Introduced in v5.1
Round
Round
The rounding period used for time in excess of the total paid break amount.
Type: TimeDuration
Optional
Round must be greater than the corresponding grace.
Default value: 0:01
Introduced in v6.1

Chapter 2
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
TotalBreakExceptions
Total Break Exceptions
This contains one or more TotalBreakException components.
Type: Zero or more TotalBreakException tags
Optional
Introduced in v6.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

Chapter 2
WSAExceptionType Tag
Exception Type
The Exception Type tag allows you to manage exception types.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAExceptionType
ShortName = String >
</WSAExceptionType>
Action Descriptions
Return Value Type: Zero or more WSAExceptionType tags
Introduced in v5.1
RetrieveAllNames

Chapter 2

Introduced in v5.1
RetrieveForUpdate
Return Value Type: WSAExceptionType tag
Required Properties: ShortName
Introduced in v5.1
ShortName
Name
The name of the entity (ShortName)
Type: String
Optional Key
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAFixedRule
[ApplyToDate = String]
Name = String >
[<PayPeriodType>
<WSAPayPeriod>
</PayPeriodType>]
</WSAFixedRule>
Action Descriptions
Returns all fixed rules for updating.
Return Value Type: Zero or more WSAFixedRule tags

Chapter 2

Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all fixed rules.
Introduced in v5.1
RetrieveForUpdate
Returns the specified fixed rule for updating.
Return Value Type: WSAFixedRule tag
Introduced in v5.1
Update
Updates the specified fixed rule.
Introduced in v5.1
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

Chapter 2
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-
Type: String
Optional Key
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

Chapter 2
WSAFunctionAccessProfile Tag
Setup 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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAFunctionAccessProfile
[AllowsAll = Boolean]
Name = String
[IsDefault = Boolean] >
[<Permissions>
<WSAPermission>*
</Permissions>]
</WSAFunctionAccessProfile>
Action Descriptions

Chapter 2
Returns all function access profiles for updating.
Return Value Type: Zero or more WSAFunctionAccessProfile tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all function access profiles.
Introduced in v5.1
RetrieveForUpdate
Returns the specified function access profile for updating.
Return Value Type: WSAFunctionAccessProfile tag
Introduced in v5.1
Update
Updates the specified function access profile.
Introduced in v5.1
AllowsAll
Does the profile allow all?
Boolean value that, when True, indicates that the function access profile includes
all functions in the system.

Chapter 2
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 Key
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.

Chapter 2
Type: Zero or more WSAPermission tags

Optional
Introduced in v5.1

Chapter 2
WSAGenie Tag
Defining the building block
This tag allows you to setup the building block for display profiles.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAGenie
Name = String
[OrderNum = Integer] >
[<NavbarCategory>
<WSANavbarCategory>
</NavbarCategory>]
</WSAGenie>
Action Descriptions

Chapter 2
Return Value Type: Zero or more WSAGenie tags

Introduced in v5.1
RetrieveAllNames
RetrieveForUpdate
Return Value Type: WSAGenie tag
Introduced in v5.1
Description
Description of the building block
The description of the building block.
Type: String
Optional
Introduced in v5.1
DisplayDescription
Type: String
Optional
Introduced in v5.1

Chapter 2
DisplayName
The Display Name
Type: String
Optional
Introduced in v5.1
Name
Name of the building block
The name of the building block.
Type: String
Optional Key
Introduced in v5.1
NavbarCategory
The Navbar Category to which it is assigned
Optional
Introduced in v5.1
OrderNum
Order number in the navigation bar
The Order Number (relative order in the nav bar)
Type: Integer
Optional
Introduced in v5.1

Chapter 2
WSAGrant Tag
Grant
The Grant tag defines grants for Accruals.
The Name, GrantType and WSAInterval properties are required.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"Update"
Parameters→
None
Properties→
<WSAGrant
GrantType = String
[ExtraHours = Boolean]
[CoreSetDate = String]
[GrantOnce = Boolean]
[IncrementAmount = String]
[Increment = Boolean]
[Carryover = Boolean]
[Name = String]
[PayCode = String]
[Prorate = Boolean] >
[<AccrualQualifiers>

Chapter 2
<WSAAccrualQualifier>*
</AccrualQualifiers>]
<Interval>
<WSAInterval>
</Interval>
</WSAGrant>
Action Descriptions
Delete
This is the action which deletes an Accrual Grant object.
Introduced in v5.2
Retrieve
This is the action which returns a Grant object for an Accrual.
Return Value Type: WSAGrant tag
Introduced in v5.2
This is the action which returns all Accrual Grant objects to be used for the
Update action.
Return Value Type: Zero or more WSAGrant tags
Introduced in v5.2
RetrieveAllNames
This is the action which returns all the names of the Accrual Grant objects.

Chapter 2
Introduced in v5.2
RetrieveForUpdate
This is the action which returns a Grant object for an Accrual to be used by the
Update action.
Return Value Type: WSAGrant tag
Introduced in v5.2
Update
This is the action which updates an Accrual Grant object if it exists. If the Grant
Object does not exist, it adds it.
Introduced in v5.2
AccrualQualifiers
Accrual qualifiers list
This is the property which holds the list of Accrual Qualifiers for this Grant.
Type: Zero or more WSAAccrualQualifier tags
Optional
Introduced in v5.2
Carryover
Is there a carryover for this grant?
This is the property which holds the carryover flag for this Grant.
Type: Boolean
Optional
Introduced in v5.2

Chapter 2
CoreSetDate
Date pattern for the core set
This is the property which holds the Core Set date Pattern for this Grant.
Type: String
Optional
Introduced in v5.2
DatePattern
Date pattern
Defines a date pattern for this grant. If the extra hours property is true, the pay
code property must be defined and the expected hours property of the date pattern
must be greater than 0. A fixed grant requires a date pattern.
Type: String
Optional
Introduced in v5.2
ExtraHours
Are there extra hours for this grant?
This is the property which holds the extraHours flag for this Grant. If extra hours,
you must have a paycode and the datepattern expected hours must be
0.
Type: Boolean
Optional
Introduced in v5.2
GrantOnce
Grant once?
This is the property which holds the grantOnce flag for this Grant.
Type: Boolean
Optional
Introduced in v5.2

Chapter 2
GrantType
Accrual grant type
This property contains the Accrual Grant Type. Currently, the valid types are "F"
for Fixed and "E" for Earned:
• An earned grant uses one or more earning pay codes to calculate the amount
to credit an accrual balance. When a new total is computed for the pay code,
the appropriate accrual balances are automatically adjusted. The pay code
property is required for an earned grant.
• A fixed grant defines periodic accrual increases in preset amounts. The date
pattern property is required for a fixed grant.
Type: String
Required
This must be a valid accrual grant type.
Introduced in v5.2
Increment
Increment?
This is the property which holds the increment flag for this Grant.
Type: Boolean
Optional
Introduced in v5.2
IncrementAmount
Increment amount
This is the property which holds the increment amount for this Grant. This value
is a string holding either a string representation of a decimal value (for earned
grants which have a money-type of pay code associated with them) or a string
representation of a duration (HOURS:MINUTES, each two digits) for those
earned grants not associated with a money-type pay code.
Type: String
Optional
Introduced in v5.2

Chapter 2
Interval
Interval
This is the property which hold the Grant Interval.
Required
Introduced in v5.2
Name
Name
This is the name of the grant.
Type: String
Optional
Introduced in v5.2
PayCode
Pay code name
This is the property which holds the Pay Code name for this Grant. If extra hours
you must have a paycode and the datepattern expected hours must be
0. An earned grant requires a pay code.
Type: String
Optional
Introduced in v5.2
Prorate
Prorate?
This is the property which holds the prorate flag for this Grant.
Type: Boolean
Optional
Introduced in v5.2

Chapter 2
WSAHoliday Tag
Setup 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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Update"
Parameters→
None
Properties→
<WSAHoliday
[EndDate = Date]
[EndTime = Time]
[StartDate = Date]
[StartTime = Time]
Name = String
[Code = String] >
[<WSAHolidayDates>
<WSAHolidayDate>*
</WSAHolidayDates>]
</WSAHoliday>

Chapter 2
Action Descriptions
Delete
Delete Holiday and Holiday Dates.
Required Properties: Name, WSAHolidayDates
Introduced in v6.0
Returns all holidays for updating.
Return Value Type: Zero or more WSAHoliday tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all holidays.
Introduced in v5.1
RetrieveForUpdate
Returns the specified holiday for updating.
Return Value Type: WSAHoliday tag
Introduced in v5.1
Update
Updates the specified holiday.

Chapter 2
Introduced in v5.1
Code
Short holiday code name
Short holiday code name. Maximum length is 6.
Type: String
Optional
Introduced in v6.0
DisplayName
Holiday Display Name
Holiday display name.
Type: String
Optional
Introduced in v6.0
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; last changed in v6.0; deprecated in v6.0. EndDate, EndTime,
StartDate and StartTime properties are moved to the WSAHolidayDate tag.
EndTime
Holiday end time
Time when holiday ends, in HH:mm format.
Type: Time
Optional

Chapter 2

Name
Name of WSA holiday
Name of the holiday.
Type: String
Optional Key
Introduced in v5.1
StartDate
Holiday start date
Date when holiday starts, 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
StartTime
Holiday start time
Time when holiday starts, in HH:mm format.
Type: Time
Optional
WSAHolidayDates
Holiday Dates
List of holiday dates.
Type: Zero or more WSAHolidayDate tags
Optional
Introduced in v6.0

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAHolidayCreditRule
[DayOvertimeLimitType = Integer]
Name = String
[OvertimeLimitType = Integer]
[DayOvertimeLimitPayCodeName = String]
[OvertimeLimitPayCodeName = String] >
[<WSACreditCalculator>
<WSACreditCalculator>
</WSACreditCalculator>]
[<WSAEligibilityDeterminer>
<WSAEligibilityDeterminer>
</WSAEligibilityDeterminer>]
</WSAHolidayCreditRule>

Chapter 2
Action Descriptions
Returns all holiday credit rules for updating.
Return Value Type: Zero or more WSAHolidayCreditRule tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all holiday credit rules.
Introduced in v5.1
RetrieveForUpdate
Returns the specified holiday credit rule for updating.
Return Value Type: WSAHolidayCreditRule tag
Introduced in v5.1
Update
Updates the specified holiday credit rule.
Introduced in v5.1
DayOvertimeLimitPayCodeName
Pay Code for Daily Overtime Limit
Consecutive day overtime pay code.

Chapter 2
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
Type: String
Optional Key
Introduced in v5.1
OvertimeLimitPayCodeName
Pay Code for Overtime Limit
Overtime pay code.

Chapter 2
Type: String
Optional
Introduced in v5.1
OvertimeLimitType
Overtime Limit Type
Value that indicates whether the holiday credits count toward 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
WSACreditCalculator
Credit calculator
Name of credit calculator associated with this holiday credit rule.
Type: WSACreditCalculator tag
Optional
Introduced in v5.1
WSAEligibilityDeterminer
Eligibility determiners
List of one or more eligibility determiners associated with this holiday credit rule.
Type: WSAEligibilityDeterminer tag
Optional
Introduced in v5.1

Chapter 2
WSAHolidayDate Tag
Setup Holiday Dates
It holds multiple dates for the holiday. This API is not meant to be a standalone
API. It must be accessed through the WSAHoliday tag.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<WSAHolidayDate
[EndDate = Date]
[EndTime = Time]
StartDate = Date
[StartTime = Time] >
</WSAHolidayDate>
EndDate
Holiday end date
Date when the holiday ends.
Type: Date
Optional
Introduced in v6.0
EndTime
Holiday end time
Time when the holiday ends.

Chapter 2
Type: Time
Optional
Introduced in v6.0
StartDate
Holiday start date
Date when the holiday starts.
Type: Date
Required
Introduced in v6.0
StartTime
Holiday start time
Time when the holiday starts.
Type: Time
Optional
Introduced in v6.0

Chapter 2
WSAHyperfindQuery Tag
HyperFind Query
The Hyperfind Query tag allows you to manage Hyperfind queries.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAHyperfindQuery
[LongDescription = String]
[HyperfindQueryTypeID = Long]
Name = String
[QueryVisibleType = Long] >
</WSAHyperfindQuery>
Action Descriptions
Return Value Type: Zero or more WSAHyperfindQuery tags
Introduced in v5.1

Chapter 2
RetrieveAllNames
Introduced in v5.1
RetrieveForUpdate
Return Value Type: WSAHyperfindQuery tag
Introduced in v5.1
HyperfindQueryTypeID
Id for the query visibility type
The Hyperfind Query Type ID
Type: Long
Optional
Introduced in v5.1
LongDescription
Description
The Long Description
Type: String
Optional
Introduced in v5.1
Name
Name
Type: String

Chapter 2
Optional Key
Introduced in v5.1
QueryVisibleType
Visibility type for the query
The Query Visible Type
Type: Long
Optional
Introduced in v5.1

Chapter 2
WSAInitialGrant Tag
Initial Grant
This API holds the data for the Accrual Policy's initial grants. This API is not
meant to be a standalone API. It must be accessed through the WSAAccrualPolicy
API.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<WSAInitialGrant
AccrualRule = String
GranRule = String
InitialValue = String >
[<SubsequentGrants>
<WSASubsequentGrant>*
</SubsequentGrants>]
</WSAInitialGrant>
AccrualRule
Accrual rule
The Accrual Policy Rule associated with this initial grant.
Type: String
Required
Introduced in v5.2

Chapter 2
ExpireToAccrual
Type: String
Optional
Introduced in v5.2
GranRule
Grant rule
The Grant Rule associated with this initial grant.
Type: String
Required
Introduced in v5.2
InitialValue
Initial grant
The value of the accrual policy rule's initial grant.
Type: String
Required
This value must be valid for the accrual policy rule's date pattern specified in the
accrual rule.
Introduced in v5.2
SubsequentGrants
Subsequent grants
The list of subsequent grants for this Accrual Policy rule.
Type: Zero or more WSASubsequentGrant tags
Optional
Introduced in v5.2

Chapter 2
WSAInterval Tag
Interval
The Interval tag stores values for time unit type and number of intervals. This tag
is used only in conjunction with other top levels objects, such as Probation Period.
The most immediate containing object for Interval is Accrual Qualifier.
Both of its attributes are non-nullable
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAInterval
numIntervals = Integer
timeUnitType = String >
</WSAInterval>
Action Descriptions
Retrieve
Returns an instance of WSAInterval (uninitialized).
Return Value Type: WSAInterval tag

Chapter 2
Introduced in v5.2
RetrieveForUpdate
Returns an instance of WSAInterval (uninitialized).
Return Value Type: WSAInterval tag
numIntervals
Number of intervals
an Integer representative of the number of time unit types
Type: Integer
Required
Introduced in v5.2
timeUnitType
Time unit type
a String representative of the time unit type
Type: String
Required
Introduced in v5.2

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAIntervalRoundRule
[IsMissedOutException = Boolean]
Name = String
[UseScheduledOut = Boolean] >
</WSAIntervalRoundRule>
Action Descriptions
Returns all interval round rules for updating.

Chapter 2
Return Value Type: Zero or more WSAIntervalRoundRule tags

Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all interval round rules.
Introduced in v5.1
RetrieveForUpdate
Returns the specified interval round rule for updating.
Return Value Type: WSAIntervalRoundRule tag
Introduced in v5.1
Update
Updates the specified interval round rule.
Introduced in v5.1
Grace
Grace period
Grace period, in HH:mm format.
Type: TimeDuration
Optional
Introduced in v5.1

Chapter 2
IsMissedOutException
Is a missed-out exception reported?
Boolean value that, when True, causes an exception to be flagged when an
employee misses a punch and the missed-out limit has been reached. You
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 of the interval rounding rule
Name of the interval rounding rule. The name can be up to 32 characters long, is
Type: String
Optional Key
Introduced in v5.1
Round
Number of minutes in the round
Round value, in HH:mm format, for start or end shift rounding intervals.
Type: TimeDuration
Optional
Introduced in v5.1
UseScheduledOut
Should scheduled end time be used if there is no check out?
Boolean value that, when True, causes the scheduled end time to be used when an
employee does not punch out.
Type: Boolean
Optional
Introduced in v5.1

Chapter 2
WSAIsrProfile Tag
India Statutory Report Profile
A profile of an employee that is used in India Statutory Reports. The profile will
be assigned to a person.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"Update"
Parameters→
None
Properties→
<WSAIsrProfile
[Active = Boolean]
[FactoryAddress1 = String]
[FactoryName = String]
[FathersNameFieldName = String]
Name = String
[NatureOfWorkFieldName = String]
[ShowNonWorkedTime = Boolean]
[ShowWorkedTimeHoliday = Boolean]
[TokenFieldName = String] >

Chapter 2
[<Holidays>
<SimpleValue>*
</Holidays>]
[<WorkCodes>
<SimpleValue>*
</WorkCodes>]
</WSAIsrProfile>
Action Descriptions
Delete
Deletes an India Statutory Report profile.
Introduced in v6.1
Retrieve
Retrieves an India Statutory Report profile.
Return Value Type: WSAIsrProfile tag
Introduced in v6.1
Retrieves a list of all India Statutory Report profiles.
Return Value Type: Zero or more WSAIsrProfile tags
Introduced in v6.1
RetrieveAllNames
Retrieves the names of all India Statutory Report profiles.

Chapter 2
Introduced in v6.1
RetrieveForUpdate
Retrieves an India Statutory Report profile by name.
Return Value Type: WSAIsrProfile tag
Introduced in v6.1
Update
Creates or updates an India Statutory Report profile.
Optional Properties:
Description,Active,FactoryName,FactoryAddress1,FactoryAddress2,FactoryAdd
ress3,FathersNameFieldName,NatureOfWorkFieldNameLaborLevelName,Show
NonWorkedTime,ShowWorkedTimeHoliday,LeaveCodes,WorkCodes,Holidays
Introduced in v6.1
Active
Active status
Specifies whether the profile is active; that is, it can be assigned to an employee.
Type: Boolean
Optional
Sample values:
true
Default value: true

Introduced in v6.1

Chapter 2
Description
Description
Describes the India Statutory Reports profile.
Type: String
Optional
Sample values:
Profile assigned to all workers in North Factory
Introduced in v6.1
FactoryAddress1
Factory address line 1
Specifies the first line of the address of the factory, for India Statutory Reports.
Type: String
Optional
Sample values:
123 Main Street
Introduced in v6.1
FactoryAddress2
Specifies the second line of the address of the factory, for India Statutory Reports.
Type: String
Optional
Sample values:
Suite 101
Introduced in v6.1

Chapter 2
FactoryAddress3
Specifies the third line of the address of the factory, for India Statutory Reports.
Type: String
Optional
Sample values:
Chelmsford, MA 00000
Introduced in v6.1
FactoryName
Factory name
Specifies name of the factory to be included in India Statutory Reports.
Type: String
Optional
Sample values:
North Factory
Introduced in v6.1
FathersNameFieldName
Father name field name
Specifies the name of the custom data field that contains the employee's father's
name which is in the Additional Info section of the People record.
Type: String
Optional
Sample values:
FathersName
Introduced in v6.1

Chapter 2
Holidays
Holidays
Specifies the list of holidays to be included in the National and Festivals Holidays
report.
Optional
Up to 15 holidays may be specified.
Sample values:
<SimpleValue Value="New Years Day"/>
<SimpleValue Value="Labor Day"/>
Introduced in v6.1
Name
Name
The name of the India Statutory Reports profile.
Type: String
Required Key
Sample values:
North Factory Profile
Introduced in v6.1
NatureOfWorkFieldName
Nature of work field name
Specifies the name of the custom data field that records the employee's nature of
work which is in the Additional Info section of the People record.
Type: String
Optional
Introduced in v6.1

Chapter 2
ShowNonWorkedTime
Show non worked time
Indicates whether time off will be shown in the Muster Roll and Service Card
reports.
Type: Boolean
Optional
Default value: true
Introduced in v6.1
ShowWorkedTimeHoliday
Show worked time in Holiday report
Indicates whether the National and Festival Holidays report notes when an
employee worked on the holiday.
Type: Boolean
Optional
Default value: true
Introduced in v6.1
TokenFieldName
Token field name
Represents the name of the custom data field used to represent and hold the token
or ticket number which is in the Additional Info section of the People record.
Type: String
Optional
Must represent the name of a valid, custom data field that already exists in the
database.
Introduced in v6.1
WorkCodes
Work pay codes
Specifies the list of pay code names that are considered working time.

Chapter 2
Optional
Sample values:
<SimpleValue Value="Regular"/>
<SimpleValue Value="Weekend"/>
Introduced in v6.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSALaborLevel
[CanOverrideMinMaxSwitch = Boolean]
EncodedName = String
[MaxNameLength = Integer]
[MinNameLength = Integer]
[ValidateAllNewEntriesSwitch = Boolean] >
</WSALaborLevel>
Action Descriptions

Chapter 2
Returns all labor levels for updating.
Return Value Type: Zero or more WSALaborLevel tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all labor levels.
Introduced in v5.1
RetrieveForUpdate
Returns the specified labor level for updating.
Return Value Type: WSALaborLevel tag
Required Properties: EncodedName
Introduced in v5.1
Update
Updates the specified labor level.
Introduced in v5.1
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.

Chapter 2
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 Key
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

Chapter 2
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

Chapter 2
WSALaborLevelEntry Tag
Setup 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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSALaborLevelEntry
[ReadOnly = Boolean]
[Inactive = Boolean]
EncodedName = String >
</WSALaborLevelEntry>
Action Descriptions
Returns all labor level entries for updating.
Return Value Type: Zero or more WSALaborLevelEntry tags

Chapter 2

Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all labor level entries.
Introduced in v5.1
RetrieveForUpdate
Returns the specified labor level entry for updating.
Return Value Type: WSALaborLevelEntry tag
Introduced in v5.1
Update
Updates the specified labor level entry.
Introduced in v5.1
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

Chapter 2
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.
Type: String
Optional Key
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

Chapter 2
WSALeaveCaseDetail Tag
Leave Case Detail
The Leave Case Detail tag allows you to manage Leave Case Detail records.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSALeaveCaseDetail
[Name = String]
[<ColumnSet>
<WSAWfgColumnSet>
</ColumnSet>]
<WSAHyperfindQuery>
<WSADPTimePeriod>
[<NavbarCategory>
<WSANavbarCategory>

Chapter 2
</NavbarCategory>]
</WSALeaveCaseDetail>
Action Descriptions
Retrieve all instances for update
Return Value Type: Zero or more WSALeaveCaseDetail tags
Introduced in v5.2
RetrieveAllNames
Return all Leave Case Detail instance names
RetrieveForUpdate
Retrieve instance for update
Return Value Type: WSALeaveCaseDetail tag
Introduced in v5.2
Update
Update the instance.
Introduced in v5.2

Chapter 2
ColumnSet
Column set
Column set that is assigned.
Optional
Introduced in v5.2
Default HyperFind query
Optional
DefaultTimePeriod
Default time period
Default Time Period that is assigned.
Optional
Introduced in v5.2
Description
Description
Description
Type: String
Optional
Introduced in v5.2
DisplayDescription
Description to display in user interface
Description to display in the user interface.
Type: String
Optional

Chapter 2
Introduced in v5.2
DisplayName
Name to display in user interface
Name to Display in the user interface.
Type: String
Optional
Introduced in v5.2
Name
Name
Name
Type: String
Optional
Introduced in v5.2
NavbarCategory
Navigation bar category
Optional
Introduced in v5.2

Chapter 2
WSALeaveCaseDetailColumnSet Tag
Leave Case Detail Column Set
The Leave Case Detail Column Set tag allows you to manage Leave Case Detail
Column Sets.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSALeaveCaseDetailColumnSet
[Name = String]
[<ColumnDetail>
<WSAColumnDetail>*
</ColumnDetail>]
</WSALeaveCaseDetailColumnSet>
Action Descriptions

Chapter 2
Retrieve all for Update
Return Value Type: Zero or more WSALeaveCaseDetailColumnSet tags
Introduced in v5.2
RetrieveAllNames
Returns all names
Introduced in v5.2
RetrieveForUpdate
Retrieve for Update
Return Value Type: WSALeaveCaseDetailColumnSet tag
Introduced in v5.2
Update
Updates the entity
Introduced in v5.2
ColumnDetail
Column detail
Column Details that are assigned

Chapter 2
Optional
Introduced in v5.2
Description
Description
Description
Type: String
Optional
Introduced in v5.2
DisplayDescription
Description to display in user interface
Type: String
Optional
Introduced in v5.2
DisplayName
Name to display in user interface
Type: String
Optional
Introduced in v5.2
ExteriorItemNumber
Item number
Type: Long
Optional
Introduced in v5.2
ExteriorName
Exterior item name
Item Name

Chapter 2
Type: String
Optional
Introduced in v5.2
Name
Name
Name
Type: String
Optional
Introduced in v5.2

Chapter 2
WSALimit Tag
Limit
The Limit tag reads, writes, updates, and deletes limits and taking limits. The
Taking Limit tag defines the amounts of time or money that an employee can use
or take based on the employee's accrual balances and organization policy.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"Update"
Parameters→
Update→
[NewName = String]
Properties→
<WSALimit
[ForgivenBalance = Boolean]
[LimitType = String]
[MaxLimit = Boolean]
Name = String >
[<DayMonthSpan>
<WSADayMonthSpan>
</DayMonthSpan>]
[<Interval>
<WSAInterval>

Chapter 2
</Interval>]
</WSALimit>
Action Descriptions
Delete
Delete the specified instance
Required Properties: Name, LimitType
Retrieve
Return Value Type: WSALimit tag
Required Properties: Name, LimitType
Introduced in v5.2
Return Value Type: Zero or more WSALimit tags
Introduced in v5.2
RetrieveAllNames
RetrieveForUpdate

Chapter 2
Return Value Type: WSALimit tag

Introduced in v5.2
Update
Introduced in v5.2
Action Parameters

NewName This parameter is used to five a new Introduced in v5.2
name to the WSALimit object
Optional
DatePattern
Date pattern
The date pattern property is required for the CarryOver Limit limit type. It is
selectable for the Earning Amount Limit limit type.
Type: String
Optional
Introduced in v5.2
DayMonthSpan
Day-month span
The Day-month span property is selectable for the Earning Amount Limit limit
type.
Type: WSADayMonthSpan tag

Chapter 2
Optional
Introduced in v5.2
ForgivenBalance
Forgiven balance
The Forgiven balance property is required for the Carryover Limit limit type.
Type: Boolean
Optional
Introduced in v5.2
Interval
Interval
The Interval property is selectable for the Earning Amount Limit limit type.
Optional
Introduced in v5.2
LimitType
Limit type
There are 3 limit types:
• A (Earning Amount Limit)
• B (Balance Limit)
• C (Carryover Limit)
Type: String
Optional
Introduced in v5.2
MaxLimit
Maximum limit
The Maximum limit property is required for the Carryover Limit limit type.
Type: Boolean
Optional

Chapter 2
Introduced in v5.2
Name
Name
The name of the limit. The name property is required for all limit types.
Type: String
Optional Key
Introduced in v5.2

Chapter 2
WSALimitAlert Tag
Limit Alert
Specifies alerts which can be triggered when an overtime limit is reached or near.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<WSALimitAlert
[BeforeTime = TimeDuration]
Name = String >
</WSALimitAlert>
BeforeTime
Before time
Specifies the amount of time before the limit is reached to trigger the alert.
Type: TimeDuration
Optional
Must be a valid positive time value.
Sample values:
BeforeTime="2:00"
Introduced in v6.1

Chapter 2
Name
Name
Name of the notification alert.
Type: String
Required Key
Must be a valid Workflow notification alert.
Sample values:
<WSALIMITALERT Name="Overtime Warning"
BeforeSeconds="2:00"/>
Introduced in v6.1

Chapter 2
WSALogonProfile Tag
Setup Logon Profile
The WSALogonProfile tag allows you to define the settings for a user's password
and restrictions on timekepping sessions. The LogonProfile and
WSALogonProfile tags are used by the same database object.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSALogonProfile
[AccLockoutDuration = Long]
[IsDefault = Boolean]
[InactivityTimeOut = Long]
Name = String
[MaxCharacterRepeatInPwd = Integer]
[MaxCharacterSequenceInPwd = Integer]
[PwdMinLength = Integer]
[AccLockoutAfter = Integer]
[PwdExpiredDays = Integer]
[PwdMaxHistory = Integer]
[AccLockoutSwitch = Boolean]
[InactivityTimeOutSwitch = Boolean]

Chapter 2
[AllowSpacesInPwdSwitch = Boolean]
[AllowUserNameInPwdSwitch = Boolean]
[AllowForbiddenWordAsPwdSwitch = Boolean]
[PwdMinLengthSwitch = Boolean]
[MaxCharacterRepeatInPwdSwitch = Boolean]
[MaxCharacterSequenceInPwdSwitch = Boolean]
[PwdExpiredDaysSwitch = Boolean]
[PwdMaxHistorySwitch = Boolean]
[RequireLowerCaseInPwdSwitch = Boolean]
[RequireNonAlphaNumericsInPwdSwitch = Boolean]
[RequireNumericsInPwdSwitch = Boolean]
[RequireUpperCaseInPwdSwitch = Boolean] >
</WSALogonProfile>
Action Descriptions
Returns all logon profiles for updating.
Return Value Type: Zero or more WSALogonProfile tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all login profiles.
Introduced in v5.1
RetrieveForUpdate
Returns the specified login profile for updating.
Return Value Type: WSALogonProfile tag
Introduced in v5.1

Chapter 2
Update
Updates the specified logon profile.
Introduced in v5.1
AccLockoutAfter
Number of attempts before locking user out
When the AccLockoutSwitch property is True, number of invalid logon attempts
users can make before the system locks them out and will not accept another
logon attempt.
If this property is empty, users can attempt to log on to the system endlessly
without supplying a proper ID and password.
Type: Integer
Optional
Introduced in v5.1
AccLockoutDuration
Duration of lockout
When the AccLockoutSwitch property is True, time, specified in HH:mm format,
during which a user is locked out of the account. The user remains locked put for
this length of time or until an administrator manually unlocks the user's account.
Type: Long
Optional
Introduced in v5.1

Chapter 2
AccLockoutSwitch
Should account be locked out?
Boolean value that, when True, enables account lockout management. If this
value is False, the AccLockoutAfter and AccLockoutDuration properties are
ignored.
Type: Boolean
Optional
Introduced in v5.1
AllowForbiddenWordAsPwdSwitch
Should the system allow the password to match a word in the forbidden list?
Boolean value that, when True, indicates that the system will allow the password
to match a word in the forbidden list.
Type: Boolean
Optional
Introduced in v6.1
AllowSpacesInPwdSwitch
Should the system allow the password to contain the spaces?
to contain the spaces.
Type: Boolean
Optional
Introduced in v6.1
AllowUserNameInPwdSwitch
Should the system allow the password to contain the user name?
to contain the user name.
Type: Boolean
Optional
Introduced in v6.1

Chapter 2
Description
Description
Description of the logon profile.
Type: String
Optional
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; last changed in v5.2; deprecated in v5.2. This attribute was
associated with the "fat client" Smalltalk-based Configuration Applications editor
as opposed to the new Java/Web-based version in 5.2. This attribute is no longer
needed in 5.2 and is therefore obsolete.
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; last changed in v5.2; deprecated in v5.2. This attribute was
associated with the "fat client" Smalltalk-based Configuration Applications editor
as opposed to the new Java/Web-based version in 5.2. This attribute is no longer
needed in 5.2 and is therefore obsolete.
IsDefault
Is this the default logon profile?
Boolean value that, when True, makes this login profile the default for all new
users.

Chapter 2
Type: Boolean
Optional
Introduced in v5.1
MaxCharacterRepeatInPwd
Maximum consecutive identical characters allowed in a password
When the MaxCharacterRepeatInPwdSwitch property is set to True, maximum
consecutive identical characters allowed in a password.
Type: Integer
Optional
Introduced in v6.1
MaxCharacterRepeatInPwdSwitch
Should the system enforce the maximum consecutive identical characters setting?
Boolean value that, when True, indicates that the system will enforce the
maximum consecutive identical characters setting. If this value is False, the
MaxCharacterRepeatInPwd property is ignored.
Type: Boolean
Optional
Introduced in v6.1
MaxCharacterSequenceInPwd
Maximum consecutive sequential numbers or letters allowed in a password
When the MaxCharacterSequenceInPwdSwitch property is set to True, maximum
consecutive sequential numbers or letters allowed in a password.
Type: Integer
Optional
Introduced in v6.1
MaxCharacterSequenceInPwdSwitch
Should the system enforce the maximum consecutive sequential numbers or letters

Chapter 2
setting?
Boolean value that, when True, indicates that the system will enforce the
maximum consecutive sequential numbers or letters setting (e.g abc, 987). If this
value is False, the MaxCharacterSequenceInPwd property is ignored.
Type: Boolean
Optional
Introduced in v6.1
Name
Logon profile name
Name of the logon profile. The name can be up to 32 characters long, is case-
Type: String
Optional Key
Introduced in v5.1
PwdExpiredDays
Number of days until password expires
When the PwdExpiredDaysSwitch property is set to True, interval, specified as a
number of days, during which a new password remains valid. After this interval,
a new password must be selected.
Type: Integer
Optional
Introduced in v5.1
PwdExpiredDaysSwitch
Should the system provide password expiration services?
Boolean value that, when True, enables password expiration services. If this
value is False, the PwdExpiredDays property is ignored.
Type: Boolean
Optional
Introduced in v5.1

Chapter 2
PwdMaxHistory
Number of passwords to remember
When the PwdMaxHistorySwitch property is set to True, maximum number of
passwords the system will remember so that the system can monitor password
reuse.
Type: Integer
Optional
Introduced in v5.1
PwdMaxHistorySwitch
Should the system remember past passwords?
Boolean value that, when True, indicates that the system should remember past
passwords. If this value is set to False, The PwdMaxHistory property is ignored.
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 minimum
password length. If this value is False, the PwdMinLength property is ignored.
Type: Boolean
Optional
Introduced in v5.1

Chapter 2
RequireLowerCaseInPwdSwitch
Should the system require that the password contain at least 1 lowercase letter?
Boolean value that, when True, indicates that the system will require that the
password contains at least 1 lowercase letter.
Type: Boolean
Optional
Introduced in v6.1
RequireNonAlphaNumericsInPwdSwitch
Should the system require that the password contain at least 1 non-alphanumeric
symbol?
password contains at least 1 non-alphanumeric character (e.g. ! * - ( ) | / ?).
Type: Boolean
Optional
Introduced in v6.1
RequireNumericsInPwdSwitch
Should the system require that the password contain at least 1 numeric character?
password contains at least 1 numeric character.
Type: Boolean
Optional
Introduced in v6.1
RequireUpperCaseInPwdSwitch
Should the system require that the password contain at least 1 uppercase letter?
password contains at least 1 uppercase letter.
Type: Boolean
Optional
Introduced in v6.1

Chapter 2
WSAMainTab Tag
Main Tab
The Main Tab tag allows you to manage Main Tab instances.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAMainTab
Name = String
[ComponentName = String] >
</WSAMainTab>
Action Descriptions
Return Value Type: Zero or more WSAMainTab tags
Introduced in v5.1

Chapter 2
RetrieveAllNames
Introduced in v5.1
RetrieveForUpdate
Return Value Type: WSAMainTab tag
Introduced in v5.1
ComponentName
Name of the component
The Component Name
Type: String
Optional
Introduced in v5.1
Name
Name
Type: String
Optional Key
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAMajorityRule
[IncludeDeducts = Boolean]
[IncludePunchedBreaks = Boolean]
[IncludeRegular = Boolean]
Name = String
[EqualIntervalUse = String] >
[<SelectedZones>
<WSAOptionalRule>*
</SelectedZones>]
</WSAMajorityRule>
Action Descriptions

Chapter 2
Returns all majority rules for updating.
Return Value Type: Zero or more WSAMajorityRule tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all majority rules.
Introduced in v5.1
RetrieveForUpdate
Returns the specified majority rule for updating.
Return Value Type: WSAMajorityRule tag
Introduced in v5.1
Update
Updates the specified majority rule.
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:

Chapter 2
• "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.

Chapter 2
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-
Type: String
Optional Key
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

Chapter 2
WSANavbarCategory Tag
Category for Navigation Bar
The Category for Navigation Bar tag allows you to manage navigation bar
categories.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSANavbarCategory
[GenieItemIndicator = Integer]
Name = String >
</WSANavbarCategory>
Action Descriptions
Return Value Type: Zero or more WSANavbarCategory tags
Introduced in v5.1

Chapter 2
RetrieveAllNames
Introduced in v5.1
RetrieveForUpdate
Return Value Type: WSANavbarCategory tag
Introduced in v5.1
GenieItemIndicator
Iitem number
The item indicator
Type: Integer
Optional
Introduced in v5.1
Name
Name
The entity's name in the DB
Type: String
Optional Key
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAOptionalRule
[ListOrder = Integer]
Name = String
MajorityRuleName = String >
</WSAOptionalRule>
Action Descriptions
RetrieveForUpdate
Return Value Type: WSAOptionalRule tag
Required Properties: Name, MajorityRuleName
Introduced in v5.1

Chapter 2
ListOrder
List order
The assigned List Order
Type: Integer
Optional
Introduced in v5.1
MajorityRuleName
Name of associated majority rule
The parent's Majority Rule Name.
Type: String
Optional Key
Introduced in v5.1
Name
Name
Name of the optional rule
Type: String
Optional Key
Introduced in v5.1

Chapter 2
WSAOrganizationType Tag
Organization Type
The Organization Type tag allows you to manage organization types.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAOrganizationType
[IsDefaultSwitch = Integer]
[LanguageCD = String]
[LeafNodeSwitch = Integer]
Name = String
[DisplayOrderNumber = Integer] >
[<TreeType>
<WSATreeType>
</TreeType>]
</WSAOrganizationType>
Action Descriptions

Chapter 2
Return Value Type: Zero or more WSAOrganizationType tags
Introduced in v5.1
RetrieveAllNames
Introduced in v5.1
RetrieveForUpdate
Return Value Type: WSAOrganizationType tag
Introduced in v5.1
Description
Description
The Description
Type: String
Optional
Introduced in v5.1
DisplayName
The Display Name
Type: String

Chapter 2
Optional
Introduced in v5.1
DisplayOrderNumber
Number for order to display pay codes in the user interface
The Display Order Number
Type: Integer
Optional
Introduced in v5.1
IsDefaultSwitch
Is this the default organization type?
The Is Default Switch
Type: Integer
Optional
Introduced in v5.1
LanguageCD
Language CD
The Language CD
Type: String
Optional
Introduced in v5.1
LeafNodeSwitch
Leaf Node Switch
The Leaf Node Switch
Type: Integer
Optional
Introduced in v5.1
Name
Name

Chapter 2
Type: String
Optional Key
Introduced in v5.1
TreeType
Tree Type
The Tree Type
Type: WSATreeType tag
Optional
Introduced in v5.1

Chapter 2
WSAOverridePayCode Tag
Override Pay Code
This tag identifies an Override Pay Code associated with the Overtime Rule.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveForUpdate"
Parameters→
None
Action Descriptions
Retrieve
Retrieve
Return Value Type: WSAOverridePayCode tag
Introduced in v6.0
RetrieveForUpdate
Retrieve for update
Return Value Type: WSAOverridePayCode tag

Chapter 2

Introduced in v6.0

Chapter 2
WSAOvertimeAllocation Tag
Overtime Allocation
The Overtime Allocation tag allows you to specify the order and reasons for
Overtime Allocation.
If overtime allocation is used, all three types of overtime allocations must be set:
Call-in, Extra Shift, and Float.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<WSAOvertimeAllocation
[LaborLevel1Name = String]
LimitAllocationTypeId = Integer
ProcessOrder = Integer
</WSAOvertimeAllocation>
LaborLevel1Name
Labor Level 1 Name
The labor level 1 entry for the Extra Shift or Float Limit Allocation. The Float
Limit Allocation can use one or more labor levels provided that the Extra Shift

Chapter 2
Limit Allocation does not use the same labor level. The Extra Shift Limit
Allocation can only use one labor level provided that labor level is not used by the
Float Limit Allocation.
Type: String
Optional
Must match an existing labor level entry name already defined in the system.
This value is invalid for the Call-in Limit Allocation.
LaborLevel2Name
Labor Level 2 Name
Type: String
Optional
LaborLevel3Name
Labor Level 3 Name
Type: String

Chapter 2
Optional
LaborLevel4Name
Labor Level 4 Name
Type: String
Optional
LaborLevel5Name
Labor Level 5 Name
Type: String
Optional

Chapter 2

LaborLevel6Name
Labor Level 6 Name
Type: String
Optional
LaborLevel7Name
Labor Level 7 Name
Type: String
Optional

Chapter 2
LimitAllocationTypeId
Limit Allocation Type Id
The Limit Allocation Type Id is used to identify one of the following overtime
allocation types: Callñin, Extra Shift, Float
Type: Integer
Required
Only one of each Limit Allocation Type Ids can be used per overtime rule.
The Limit Allocation Type Id must be one of the following: -1 for Callñin, -2 for
Extra Shift, -3 for Float.
ProcessOrder
Process Order
The process order specifies when this overtime allocation is processed in relation
to other overtime allocations.
Type: Integer
Required
The process order must be one of the following values: 1, 2, 3.
All other values are invalid. Each value can only be used once for each overtime
allocation setup.
WorkRuleName
Work Rule Name
Name of the work rule. A work rule applies specific payroll rules to shifts that
determine how employee hours accrue.
Type: String
Optional
Must match a work rule already defined in the system.
This value is invalid for the Float Limit Allocation.

Chapter 2

Chapter 2
WSAOvertimeCombination Tag
Overtime Combination Rules
This tag defines and manages rules that determine which overtime rule to apply
when overtime conditions overlap.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAOvertimeCombination
Name = String >
[<CombinationRules>
<WSACombinationRule>*
</CombinationRules>]
[<SelectedOvertimeRules>
<WSAOvertimeRule>*
</SelectedOvertimeRules>]
</WSAOvertimeCombination>
Action Descriptions
Returns all overtime combination rules for updating.

Chapter 2
Return Value Type: Zero or more WSAOvertimeCombination tags

RetrieveAllNames
Returns a list of the names of all overtime combination rules.
Introduced in v5.1
RetrieveForUpdate
Returns the specified overtime combination rule for updating.
Return Value Type: WSAOvertimeCombination tag
Introduced in v5.1
Update
Updates the specified overtime combination rule.
Introduced in v5.1
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

Chapter 2
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 Key
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

Chapter 2
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. It can
also be used to track amount of worked time towards a ceratin target amount over
a period of time.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAOvertimeRule
[Amount = TimeDuration]
[Minimum = TimeDuration]
[AmountOffset = TimeDuration]
[ResetDate = Date]
[ResetDay = Integer]
[IsPreSequencerSortedProcessing = Boolean]
[RequiresApproval = Boolean]
[ConPreShifts = Boolean]
[IsOverridePayCodes = Boolean]
[LimitChargeOrder = Integer]
[MakeupPayCode = String]

Chapter 2
[TrackStart = String]
Name = String
[ResetAtTime = Time]
[Type = String]
[UseEmployeeHours = Boolean]
[UseBreakVar = Boolean]
[ResetAfter = Long]
[UseRoundedTime = Boolean] >
[<LimitAlerts>
<WSALimitAlert>*
</LimitAlerts>]
[<OverridePayCodes>
<WSAOverridePayCode>*
</OverridePayCodes>]
[<LimitAllocation>
<WSAOvertimeAllocation>*
</LimitAllocation>]
</WSAOvertimeRule>
Action Descriptions
Returns all overtime rules for updating.
Return Value Type: Zero or more WSAOvertimeRule tags
RetrieveAllNames
Returns a list of the names of all overtime rules.
RetrieveForUpdate
Returns the specified overtime rule for updating.
Return Value Type: WSAOvertimeRule tag

Chapter 2

Introduced in v5.1
Update
Updates the specified overtime rule.
Introduced in v5.1
Amount
Amount
Amount of the overtime rule.
Type: TimeDuration
Optional
AmountOffset
Amount offset
The time added to the value in the employee's employment terms used for the
overtime amount.
Type: TimeDuration
Optional
AmountOffset should be non-zero only if UseEmployeeHours=true.
Sample values:
AmountOffset="2:00"
Introduced in v6.1

Chapter 2
ConPreShifts
Does this rule have a conditional pre-shift?
Defines if the rule has a condional pre-shift.
Type: Boolean
Optional
Introduced in v5.1
DatePattern
Date pattern
The date pattern for computing reset dates for this overtime.
Type: String
Optional
DatePattern must be a valid site-wide date pattern. Date Pattern is required if
Type=Q.
Sample values:
DatePattern="Yearly from 1-1"
Introduced in v6.1
IsOverridePayCodes
Is override pay codes
A flag specifying whether the overtime rule has associated override pay codes.
Type: Boolean
Optional
Introduced in v6.0
IsPreSequencerSortedProcessing
Determine overtime before applying processing order
Determine overtime before applying processing order.
Type: Boolean
Optional
Only use "true" or "false". All other values are not valid.

Chapter 2

LimitAlerts
Limit alerts
List of up to two WSALimitAlert objects to be triggered when overtime is
approaching or reached.
Type: Zero or more WSALimitAlert tags
Optional
Up to two limit alerts may be specified, one a warning alert and one a limit
reached alert.
Sample values:
<LimitAlerts>
<WSALimitAlert Name="Overtime Warning"
BeforeTime="2:00"/>
<WSALimitAlert Name="Overtime Starting"/>
</LimitAlerts>
Introduced in v6.1
LimitAllocation
Overtime allocations
Used to determine how overtime is to be allocated for work rule or labor level
transfers.
Type: Zero or more WSAOvertimeAllocation tags
Optional
If overtime allocation is used, all three types of overtime allocations must be set:
Call-in, Extra Shift, and Float.
LimitChargeOrder
Limit charge order
Indicates how overtime allocations are computed: Chronological, Reverse
Chronological, or Prorated.
Type: Integer

Chapter 2
Optional
The Limit Charge Order must be one of the following: -1 for Chronological, -2 for
Reverse Chronological, -3 for Prorated.
MakeupPayCode
Makeup pay code
MakeupPayCode specifies the pay code which will be automatically generated if
the employee works less than the targeted hours for the period specified in the
DatePattern.
Type: String
Optional
MakeupPayCode is only valid if Type=Q and DatePattern is supplied.
MakeupPayCode must be an hours-based regular or cascade pay code.
Introduced in v6.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
Type: String
Optional Key

Chapter 2
OverridePayCodes
Override pay codes
The list of override pay codes associated with the overtime rule.
Type: Zero or more WSAOverridePayCode tags
Optional
Introduced in v6.0
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 accumulator
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
Time at which the overtime accumulator resets
Valid only with type A.
Type: Time
Optional
Introduced in v5.1

Chapter 2
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
Method for tracking start time within 24-hour rule
Method for tracking start time when the 24-hour rule is in effect. Valid values
include:
• TrackingStartActual
• TrackingStartSchedule
• TrackingStartEarlier
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:

Chapter 2
• 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.
• Q -- Reset at specified date pattern.
• 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

UseBreakVar
Use in-punches of breaks?
Use in-punches of breaks?
Type: Boolean
Optional
Introduced in v5.1
UseEmployeeHours
Use employee hours
If true, the overtime the amount used for this overtime rule is retireved from the
employee's employment terms, using the date pattern as an index to the correct
amount.
Type: Boolean

Chapter 2
Optional
Amount should not be specified if UseEmployeeHours is true. A date pattern must
be specified if UseEmployeeHours is true.
Introduced in v6.1
UseRoundedTime
use Rounded Time flag
use Rounded Time flag. The rounded punch is used by default, unless you
deselect the Use Rounded Time check box. If you deselect the check box, the
system counts time from the actual punch time, rather than the rounded punch
time, when deciding if the next shift should be overtime. Usually, the Specified
amount of time is three or four hours. The default is 0:00.
Type: Boolean
Optional
Introduced in v6.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAPatternTemplateDAP
Name = String >
[<ProfileItems>
<WSAPatternTemplateProfileItem>*
</ProfileItems>]
</WSAPatternTemplateDAP>
Action Descriptions
Returns all pattern template data access profiles for updating.

Chapter 2
Return Value Type: Zero or more WSAPatternTemplateDAP tags

Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all pattern template data access profiles.
Introduced in v5.1
RetrieveForUpdate
Returns the specified pattern template data access profile for updating.
Return Value Type: WSAPatternTemplateDAP tag
Introduced in v5.1
Update
Updates the specified pattern template data access profile.
Introduced in v5.1
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

Chapter 2
Introduced in v5.1
Description
Description
Description of the pattern template data access profile.
Type: String
Optional
Introduced in v5.1
Name
Pattern template data access profile name
Name of the pattern template data access profile. The name can be up to 32
characters long, is case-insensitive, and must be unique.
Type: String
Optional Key
Introduced in v5.1
ProfileItems
Profile items associated with the data access
List of pattern template profile items associated with this data access profile.
Type: Zero or more WSAPatternTemplateProfileItem tags
Optional
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAPatternTemplateProfileItem
Name = String >
</WSAPatternTemplateProfileItem>
Action Descriptions
Returns all pattern template data access profiles for updating.
Return Value Type: Zero or more WSAPatternTemplateProfileItem tags

Chapter 2
Introduced in v5.1
RetrieveForUpdate
Returns the specified pattern template for updating.
Return Value Type: WSAPatternTemplateProfileItem tag
Introduced in v5.1
Name
Pattern template name
Name of a pattern template. The name can be up to 32 characters long, is case-
Type: String
Optional Key
Introduced in v5.1

Chapter 2
WSAPayCode Tag
Setup Pay Code Definition
The WSAPayCode tag allows you to manage pay code definitions. The PayCode
and WSAPayCode tags refer to the same database object.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAPayCode
AmountType = String
[AssociatedDurationPayCodeName = String]
[CheckAvlbltySw = Boolean]
[TerminalCdNum = Integer]
[IsMoneyCategory = Boolean]
[DurationWorkRule = String]
[EditAffShfTotal = Boolean]
[EditCntToCdotSw = Boolean]
[EditCntToOt = Boolean]
[EditExcuseAbsn = Boolean]
[PersistPceSw = Boolean]
Name = String
[ScheduleHoursType = String]
[AbbreviationChar = String]

Chapter 2
[Type = String]
[VisibleInMainArea = Boolean]
[VisibleInReport = Boolean]
[VisibleToUser = Boolean]
[WageAddition = Double]
[WageMultiply = Double] >
</WSAPayCode>
Action Descriptions
Returns all pay codes for updating.
Return Value Type: Zero or more WSAPayCode tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all pay codes.
Introduced in v5.1
RetrieveForUpdate
Returns the specified pay code for updating.
Return Value Type: WSAPayCode tag
Introduced in v5.1
Update
Updates the specified pay code.

Chapter 2
Introduced in v5.1
AbbreviationChar
Short name
Abbreviated name for the pay code. The short name is for device display
purposes.
Type: String
Optional
Introduced in v5.1
AmountType
Amount type name
The name of the amount type associated with this pay code.
Type: String
Required
Valid values are "Hour", "Day" and "Money" for regular pay codes, "Time" and
(eventually but not for 6.1) "Day" for Cascade and "Time" for Linked Named
Duration.
AssociatedDurationPayCodeName
Associated duration pay code name
The name of the default duration pay code to use when creating make-up edits in
the timecard. This field is only applicable for day-based pay codes. For all other
pay code types, this field should be an empty string.
Type: String
Optional
Must represent the name of a duration pay code which already exists in the
database.
Sample values:
My Duration Pay Code

Chapter 2
Default value: null

Introduced in v6.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
DurationWorkRule
Duration work rule name
The name of the work rule associated with the duration pay code. Other pay code
types should have this set to null (the model will do this for them during update/
insert in any case).
Type: String
Optional
Must represent the name of a valid work rule already in the database. This is really
only valid for Duration pay codes. For other pay code types, this field will be
nulled out on save regardless of what is specified in this attribute.
Introduced in v6.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

Chapter 2
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; last changed in v6.1; deprecated in v6.1. This attribute has
been replaced by "Amount Type" which returns one of the following string values
"Day", "Hour" or "Money". If "IsMoneyCategory" returned true before, the value

Chapter 2
of Amount Type would now be "Money". If "IsMoneyCategory" returned false

before, the value of Amount Type would now be "Hour"
Name
Pay code name
Name of the pay code. The name can be up to 32 characters long, is case-
Type: String
Optional Key
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 Scheduling. 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 can be included or not included in the total
scheduled hours, depending on the configuration.
Type: String
Optional
Introduced in v5.1
TerminalCdNum
Device code number
A four-character number that enables users to look up pay codes at a device. The
code number must be unique, numeric, and greater than 0 (zero).

Chapter 2
Type: Integer
Optional
Introduced in v5.1
Type
Type
The type of the pay code "P" for primitive (Regular), "C" for Cascading.
Type: String
Optional
Enumerated value: "P" "C"
Introduced in v6.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 Scheduling 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 Scheduling is installed, in the Cost Summary tab in
Schedule.

Chapter 2
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

Chapter 2
WSAPayCodeDAP Tag
Pay Code Data Access Profile
The Pay Code Data Access Profile tag allows you to define a group of pay codes
that an employee or manager can use to record time or money.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAPayCodeDAP
Name = String >
[<ProfileItems>
<WSAPayCodeProfileItem>*
</ProfileItems>]
</WSAPayCodeDAP>
Action Descriptions
Returns all pay code data access profiles for updating.

Chapter 2
Return Value Type: Zero or more WSAPayCodeDAP tags

Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all pay code data access profiles.
Introduced in v5.1
RetrieveForUpdate
Returns the specified pay code data access profile for updating.
Return Value Type: WSAPayCodeDAP tag
Introduced in v5.1
Update
Updates the specified pay code data access profile.
Introduced in v5.1
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

Chapter 2
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
Type: String
Optional Key
Introduced in v5.1
ProfileItems
Items in the data access profile
List of pay codes associated with this data access profile.
Type: Zero or more WSAPayCodeProfileItem tags
Optional
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAPayCodeDistribution
[Deviations = String list]
Name = String
[OvertimeCombination = String]
[ZoneCombination = String] >
[<Distribution>
<WSAPayDistributionAssociation>*
</Distribution>]
</WSAPayCodeDistribution>
Action Descriptions

Chapter 2
Returns all pay code distribution rules for updating.
Return Value Type: Zero or more WSAPayCodeDistribution tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all pay code distribution rules.
Introduced in v5.1
RetrieveForUpdate
Returns the specified pay code distribution rule for updating.
Return Value Type: WSAPayCodeDistribution tag
Introduced in v5.1
Update
Updates the specified pay code distribution rule.
Introduced in v5.1
Deviations
Deviations
List of one or more schedule deviations.
Type: String list

Chapter 2
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 Key
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

Chapter 2
Introduced in v5.1

Chapter 2
WSAPayCodeProfileItem Tag
Pay Code Profile Item
The Pay Code Profile Item tag allows you to list and update pay code profile
items.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAPayCodeProfileItem
Name = String >
</WSAPayCodeProfileItem>
Action Descriptions
Returns all pay code profile items for updating.
Return Value Type: Zero or more WSAPayCodeProfileItem tags
Introduced in v5.1
RetrieveForUpdate
Returns the specified pay code profile item for update.

Chapter 2
Return Value Type: WSAPayCodeProfileItem tag

Introduced in v5.1
Name
Pay code profile item name
Name of a pay code profile item. The name can be up to 32 characters long, is
Type: String
Optional Key
Introduced in v5.1

Chapter 2
WSAPayDistributionAssociation Tag
Pay Distribution Association
The Pay Distribution Association tag allows you to manage pay distribution
associations.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAPayDistributionAssociation
Deviation = String
Name = String
Overtimes = String list
[PayCodes = String list]
Zones = String list >
</WSAPayDistributionAssociation>
Action Descriptions
RetrieveForUpdate
Returns the specified pay distribution association for update.
Return Value Type: WSAPayDistributionAssociation tag
Required Properties: Name, Overtimes, Zones, Deviation

Chapter 2
Introduced in v5.1
Deviation
Deviation
Deviation
Type: String
Optional Key
Introduced in v5.1
Name
Name
name of the distribution
Type: String
Optional Key
Introduced in v5.1
Overtimes
Overtimes
Overtimes
Type: String list
Optional Key
Introduced in v5.1
PayCodes
Pay Codes
Pay Codes
Type: String list
Optional
Introduced in v5.1

Chapter 2
Zones
Zones
Zones
Type: String list
Optional Key
Introduced in v5.1

Chapter 2
WSAPayPeriod Tag
Pay Period
The Pay Period tag describes the details of a pay period.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAPayPeriod
[Length = Integer]
[ReferenceDate = Date]
[ReferenceDay = Integer]
[DayDivide = Time]
TypeCode = String >
</WSAPayPeriod>
Action Descriptions
RetrieveForUpdate
Returns the specified pay period for update.
Return Value Type: WSAPayPeriod tag
Required Properties: TypeCode

Chapter 2
Introduced in v5.1
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: Integer
Optional
Introduced in v5.1

Chapter 2
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 Key
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAPayRule
Name = String >
[<EffectivePayRules>
<WSAEffectivePayRule>*
</EffectivePayRules>]
</WSAPayRule>
Action Descriptions
Returns all pay rules for updating.
Return Value Type: Zero or more WSAPayRule tags

Chapter 2

Introduced in v5.1; last changed in v6.1; deprecated in v6.1
RetrieveAllNames
Returns a list of the names of all pay rules.
Introduced in v5.1
RetrieveForUpdate
Returns the specified pay rule for updating.
Return Value Type: WSAPayRule tag
Introduced in v5.1
Update
Updates the specified pay rule.
Introduced in v5.1
EffectivePayRules
Effectively dated pay rule
One or more associated effectively dated pay rules.
Type: Zero or more WSAEffectivePayRule tags
Optional
Introduced in v5.1

Chapter 2
Name
Name of the pay rule
Name of the pay rule. The name can be up to 32 characters long, is case-
Type: String
Optional Key
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve"
Parameters→
None
Properties→
<WSAPayRuleHoliday
[CreditRuleNames = String list]
[HolidayName = String]
[Selected = Boolean] >
</WSAPayRuleHoliday>
Action Descriptions
Retrieve
Returns the specified pay rule for holiday credit.
Return Value Type: WSAPayRuleHoliday tag
Introduced in v5.1

Chapter 2
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

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAPermission
ControlPointKey = String
ActionName = String
ScopeName = String >
</WSAPermission>
Action Descriptions
RetrieveForUpdate
Returns the specified permission for updating.
Return Value Type: WSAPermission tag
Required Properties: ControlPointKey, ActionName, ScopeName

Chapter 2
Introduced in v5.1
ActionName
Action name
Action for which the permission has been granted. Possible actions are:
• ALLOWED
• EDIT
• ADD
• DELETE
• VIEW
Type: String
Optional Key
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.
Type: String
Optional Key
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

Chapter 2
Type: String
Optional Key
Introduced in v5.1

Chapter 2
WSAProbationPeriod Tag
Probation Period
The Probation Period tag is the top-level configuration API for probation periods.
This tag contains an optional list of probation qualifiers.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAProbationPeriod
[EndAmount = Integer]
[Name = String]
Type = String >
[<ProbationQualifiers>
<WSAProbationQualifier>*
</ProbationQualifiers>]
</WSAProbationPeriod>
Action Descriptions

Chapter 2
Retrieve
The Retrieve action will return the Probation Period Object based upon the passed
in name.
The name must be the name of a valid Probation Period
Return Value Type: WSAProbationPeriod tag
Introduced in v5.2
The RetrieveAllForUpdate action will return a list of all available Probation
Period Objects.
Return Value Type: Zero or more WSAProbationPeriod tags
Introduced in v5.2
RetrieveAllNames
The RetrieveAllNames action will return a list of names of all available Probation
Periods.
Introduced in v5.2
RetrieveForUpdate
The RetrieveForUpdate action will return the Probation Period Object based upon
the passed in name.
The name must be the name of a valid Probation Period
Return Value Type: WSAProbationPeriod tag
Introduced in v5.2

Chapter 2
DatePattern
Date pattern
This attribute contains the date pattern of a probation period.
Type: String
Optional
Introduced in v5.2
EndAmount
Ending amount
This attribute contains the ending amount of the probation period.
Type: Integer
Optional
Introduced in v5.2
Name
Name
This is the name of the probation period.
Type: String
Optional
Introduced in v5.2
ProbationQualifiers
List of probation qualifiers
This is a list of probation qualifiers for the probation period
Type: Zero or more WSAProbationQualifier tags
Optional
Introduced in v5.2
Type
Type
This attribute contains the type of the Probation Period. Can be "S" or "R".

Chapter 2
Type: String
Required
Introduced in v5.2

Chapter 2
WSAProbationQualifier Tag
Probation qualifier
The Probation Qualifier object contained by the Probation Period object
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAProbationQualifier
Amount = Integer
[ConsecSwitch = Boolean] >
<AccrualQualifier>
<WSAAccrualQualifier>
</AccrualQualifier>
</WSAProbationQualifier>
Action Descriptions
Retrieve
Return a WSAProbationQualifier object
Return Value Type: WSAProbationQualifier tag

Chapter 2
Introduced in v5.2
Returns a list of Probation Qualifiers for update
Return Value Type: Zero or more WSAProbationQualifier tags
Introduced in v5.2
RetrieveForUpdate
Return a WSAProbationQualifier object for update
Return Value Type: WSAProbationQualifier tag
Introduced in v5.2
AccrualQualifier
Accrual qualifier
This attribute holds an Accrual Qualifier object
Type: WSAAccrualQualifier tag
Required
Introduced in v5.2
Amount
Amount
This attribute represents the amount for the probation qualifier
Type: Integer
Required
Introduced in v5.2
ConsecSwitch
Is the probation consecutive?
This property details whether or not the probation is consecutive
Type: Boolean

Chapter 2
Optional
Introduced in v5.2

Chapter 2
WSAProcessingOrderRule Tag
Processing Order Rule
The Processing Order Rule tag identifies the Processing Order rule that defines
the order in which hour types are processed. The Processing Order Rule is one
step in the Totalizer process.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAProcessingOrderRule
Name = String >
[<DoFirstList>
<WSASequencedItem>*
</DoFirstList>]
[<DoLastList>
<WSASequencedItem>*
</DoLastList>]
</WSAProcessingOrderRule>

Chapter 2
Action Descriptions
Returns a list of all of the WSA Processing Order Rules for update.
Return Value Type: Zero or more WSAProcessingOrderRule tags
RetrieveAllNames
Returns a list of names for all the Processing Order Rules.
RetrieveForUpdate
Returns the specified WSA Processing Order Rule for update.
Return Value Type: WSAProcessingOrderRule tag
Update
Does not return anything. Updates the specified Processing Order Rule.
DoFirstList
Do first List
A list of items to process first

Chapter 2
Type: Zero or more WSASequencedItem tags

Optional
Introduced in v5.2
DoLastList
Do last list
List of items to process last
Optional
Introduced in v5.2
Name
Name of the Processing Order Rule
The name of the processing order rule
Type: String
Optional Key
Introduced in v5.2

Chapter 2
WSAPunchRoundRule Tag
Punch Round Rule
The Punch Round Rule tag allows to create rounding rules for your site. Rounding
is a way to simplify payroll accounting and reporting, and to enforce shift start
and end times.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
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]

Chapter 2
[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] >
</WSAPunchRoundRule>
Action Descriptions
Returns all punch round rules for updating.
Return Value Type: Zero or more WSAPunchRoundRule tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all punch round rules.
Introduced in v5.1
RetrieveForUpdate
Returns the specified punch round rule for updating.
Return Value Type: WSAPunchRoundRule tag

Chapter 2

Introduced in v5.1
Update
Updates the specified punch round rule.
Introduced in v5.1
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

Chapter 2
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
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

Chapter 2
InPunchEarlyOutsideRound
In Punch Early Outside Round
In Punch Early Outside Round, in HH:mm format. Early outside rounds apply to
(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
3, 4, 5, 6, 10, 12, 15. 20, and 30). Legal values are in the range of 00:00 to 99:59.
Type: TimeDuration
Optional
Introduced in v5.1
InPunchLateChangePoint
In Punch Late Change Point
In Punch Late Change Point, in HH:mm format. This value defines how in-
punches are treated by the round rules when scheduled employees are late for the
beginning of their shifts. Change points determine when inside and outside
Type: TimeDuration
Optional
Introduced in v5.1
InPunchLateInsideGrace
In Punch Late Inside Grace
In 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

Chapter 2
Type: TimeDuration
Optional
Introduced in v5.1
InPunchLateInsideRound
In Punch Late Inside Round
In Punch Late Inside Round, in HH:mm format. Late inside rounds apply to
scheduled start or end time and before the change point). They establish the
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
Type: TimeDuration
Optional
Introduced in v5.1

Chapter 2
InPunchLateOutsideRound
In Punch Late Outside Round
In Punch Late Outside Round, in HH:mm format. Late outside rounds apply to
(after the scheduled start or end time and before the change point). They establish
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-
Type: String
Optional Key
Introduced in v5.1

Chapter 2
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
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
change point and before the scheduled start or end time). They determine when
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
change point and before the scheduled start or end time). They establish the

Chapter 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
(after the change point and before the scheduled start or end time). They
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
Type: TimeDuration
Optional
Introduced in v5.1

Chapter 2
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
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
scheduled start or end time and before the change point). They determine when
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
scheduled start or end time and before the change point). They establish the

Chapter 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
(after the scheduled start or end time and before the change point). They
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
(after the scheduled start or end time and before the change point). They establish
Type: TimeDuration
Optional
Introduced in v5.1

Chapter 2
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
is 00:00.
Type: TimeDuration
Optional
Introduced in v5.1

Chapter 2
UnscheduledInRound
Unscheduled In Round
Round value, in HH:mm format, to be applied to in-punches by unscheduled
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
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
Type: TimeDuration
Optional
Introduced in v5.1

Chapter 2
UseScheduledOut
Use Scheduled Out
Boolean value that, when True, indicates that, when employees forget to punch
out and 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

Chapter 2
WSAQuickFind Tag
Quick Find
The Quick Find tag allows you to manage Quick Finds
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAQuickFind
Name = String
[<ColumnSet>
<WSAWfgColumnSet>
</ColumnSet>]
[<NavbarCategory>
<WSANavbarCategory>
</NavbarCategory>]
<WSADPTimePeriod>
</WSAQuickFind>

Chapter 2
Action Descriptions
Return Value Type: Zero or more WSAQuickFind tags
Introduced in v5.1
RetrieveAllNames
RetrieveForUpdate
Return Value Type: WSAQuickFind tag
Introduced in v5.1
Update
Introduced in v5.1
ColumnSet
Assigned column set

Chapter 2

Optional
Introduced in v5.1
DefaultTimePeriod
Optional
Introduced in v5.1
Description
Description
The Description
Type: String
Optional
Introduced in v5.1
DisplayDescription
Type: String
Optional
Introduced in v5.1
DisplayName
The Display Name
Type: String
Optional
Introduced in v5.1

Chapter 2
Name
Name
Type: String
Optional Key
Introduced in v5.1
NavbarCategory
Optional
Introduced in v5.1

Chapter 2
WSAReportDAP Tag
Report Data Access Profile
The Report Data Access Profile tag allows you to define which reports the
manager can access.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAReportDAP
Name = String >
[<ProfileItems>
<WSAReportProfileItem>*
</ProfileItems>]
</WSAReportDAP>
Action Descriptions
Returns all report data access profiles for updating.

Chapter 2
Return Value Type: Zero or more WSAReportDAP tags

Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all report data access profiles.
Introduced in v5.1
RetrieveForUpdate
Returns the specified report data access profile for updating.
Return Value Type: WSAReportDAP tag
Introduced in v5.1
Update
Updates the specified report data access profile.
Introduced in v5.1
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

Chapter 2
Description
Description
Description of the report data access profile.
Type: String
Optional
Introduced in v5.1
Name
Name
Name of the report data access profile. The name can be up to 32 characters long,
is case-insensitive, and must be unique.
Type: String
Optional Key
Introduced in v5.1
ProfileItems
Items in this data access profile
List of one or more report profile items associated with this data access profile.
Type: Zero or more WSAReportProfileItem tags
Optional
Introduced in v5.1

Chapter 2
WSAReportProfileItem Tag
Report Profile Item
The Report Profile Item tag allows you to list and update report profile items.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAReportProfileItem
Name = String >
</WSAReportProfileItem>
Action Descriptions
Returns all report profile items for updating.
Return Value Type: Zero or more WSAReportProfileItem tags
Introduced in v5.1
RetrieveForUpdate
Returns the specified report profile item for update.

Chapter 2
Return Value Type: WSAReportProfileItem tag

Introduced in v5.1
Name
Report profile item name
Name of the report profile item. The name can be up to 32 characters long, is
Type: String
Optional Key
Introduced in v5.1

Chapter 2
WSARollup Tag
Rollup
The Rollup tag allows you to manage rollups.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSARollup
Name = String
[<NavbarCategory>
<WSANavbarCategory>
</NavbarCategory>]
[<ColumnSet>
<WSAWfgColumnSet>
</ColumnSet>]
<WSAHyperfindQuery>
<WSADPTimePeriod>

Chapter 2
</WSARollup>
Action Descriptions
Return Value Type: Zero or more WSARollup tags
Introduced in v5.1
RetrieveAllNames
RetrieveForUpdate
Return Value Type: WSARollup tag
Introduced in v5.1
Update
Introduced in v5.1

Chapter 2
ColumnSet
Column set that is assigned.
Optional
Introduced in v5.1
The assigned Default Hyperfind Query
Optional
Introduced in v5.1
DefaultTimePeriod
Optional
Introduced in v5.1
Description
Description
The Description
Type: String
Optional
Introduced in v5.1
DisplayDescription
Type: String
Optional
Introduced in v5.1

Chapter 2
DisplayName
The Display Name
Type: String
Optional
Introduced in v5.1
Name
Name
Type: String
Optional Key
Introduced in v5.1
NavbarCategory
Optional
Introduced in v5.1

Chapter 2
WSARollupColumnSet Tag
Rollup Column Set
The Rollup Column Set tag allows you to manage rollup column sets.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSARollupColumnSet
Name = String
[<LaborLevel>
<WSADPLaborLevelDefinition>*
</LaborLevel>]
[<ColumnDetail>
<WSAColumnDetail>*
</ColumnDetail>]
</WSARollupColumnSet>

Chapter 2
Action Descriptions
Return Value Type: Zero or more WSARollupColumnSet tags
Introduced in v5.1
RetrieveAllNames
RetrieveForUpdate
Return Value Type: WSARollupColumnSet tag
Introduced in v5.1
Update
Introduced in v5.1
ColumnDetail
The collection of Column Details

Chapter 2

Optional
Introduced in v5.1
Description
Description
The Description
Type: String
Optional
Introduced in v5.1
DisplayDescription
Type: String
Optional
Introduced in v5.1
DisplayName
The Display Name
Type: String
Optional
Introduced in v5.1
ExteriorItemNumber
Item number
Type: Long
Optional
Introduced in v5.1

Chapter 2
ExteriorName
Item name
The Exterior Name
Type: String
Optional
Introduced in v5.1
LaborLevel
Assigned Labor Levels
The set of assigned Labor Levels
Type: Zero or more WSADPLaborLevelDefinition tags
Optional
Introduced in v5.1
Name
Name
Type: String
Optional Key
Introduced in v5.1

Chapter 2
WSAScheduleAssistant Tag
Schedule Assistant
The Schedule Assistant tag allows you to manage schedule assistants.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAScheduleAssistant
[CriteriaSet = String]
[DefaultHyperfindQuery = String]
Name = String
</WSAScheduleAssistant>
Action Descriptions

Chapter 2
Return Value Type: Zero or more WSAScheduleAssistant tags

Introduced in v5.1
RetrieveAllNames
RetrieveForUpdate
Return Value Type: WSAScheduleAssistant tag
Introduced in v5.1
Update
Introduced in v5.1
ColumnSet
Assigned column set name
The assigned Column Set name
Type: String
Optional
Introduced in v5.1

Chapter 2
CriteriaSet
Assigned criteria set name
The assigned Criteria Set name
Type: String
Optional
Introduced in v5.1
Default query that is assigned name
The assigned Default Hyperfind Query name
Type: String
Optional
Introduced in v5.1
Description
Description
The Description
Type: String
Optional
Introduced in v5.1
DisplayDescription
Type: String
Optional
Introduced in v5.1
DisplayName
The Display Name
Type: String
Optional
Introduced in v5.1

Chapter 2
Name
Name
Type: String
Optional Key
Introduced in v5.1

Chapter 2
WSAScheduleAssistantColumnSet Tag
Column Set for Schedule Assistant
The Column Set for Schedule Assistant tag allows you to manage schedule
assistant column sets.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAScheduleAssistantColumnSet
Name = String
[<ColumnDetail>
<WSAColumnDetail>*
</ColumnDetail>]
</WSAScheduleAssistantColumnSet>
Action Descriptions

Chapter 2
Return Value Type: Zero or more WSAScheduleAssistantColumnSet tags
Introduced in v5.1
RetrieveAllNames
RetrieveForUpdate
Return Value Type: WSAScheduleAssistantColumnSet tag
Introduced in v5.1
Update
Introduced in v5.1
ColumnDetail
The set of assigned Column Details

Chapter 2
Optional
Introduced in v5.1
Description
Description
The Description
Type: String
Optional
Introduced in v5.1
DisplayDescription
Type: String
Optional
Introduced in v5.1
DisplayName
The DisplayName
Type: String
Optional
Introduced in v5.1
ExteriorItemNumber
Item number
Type: Long
Optional
Introduced in v5.1
ExteriorName
Item name
The Exterior Name

Chapter 2
Type: String
Optional
Introduced in v5.1
Name
Name
Type: String
Optional Key
Introduced in v5.1

Chapter 2
WSAScheduleAssistantTab Tag
Schedule Assistant Tab
The Schedule Assistant Tab tag allows you to manage schedule assistant tabs.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAScheduleAssistantTab
[ComponentName = String]
Name = String >
</WSAScheduleAssistantTab>
Action Descriptions
Return Value Type: Zero or more WSAScheduleAssistantTab tags
Introduced in v5.1

Chapter 2
RetrieveAllNames
Introduced in v5.1
RetrieveForUpdate
Return Value Type: WSAScheduleAssistantTab tag
Introduced in v5.1
ComponentName
Component name
The Component Name
Type: String
Optional
Introduced in v5.1
Name
Name
Type: String
Optional Key
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAScheduleDeviationRule
[AfterShift = Boolean]
[BeforeShift = Boolean]
Name = String
[NotScheduled = Boolean]
[RequiresApproval = Boolean] >
</WSAScheduleDeviationRule>
Action Descriptions
Returns all schedule deviation rules for updating.

Chapter 2
Return Value Type: Zero or more WSAScheduleDeviationRule tags

Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all schedule deviation rules.
Introduced in v5.1
RetrieveForUpdate
Returns the specified schedule deviation rule for updating.
Return Value Type: WSAScheduleDeviationRule tag
Introduced in v5.1
Update
Updates the specified schedule deviation rule.
Introduced in v5.1
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

Chapter 2
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
Type: String
Optional Key
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

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAScheduledHoursType
Name = String
[SchedHrsProdMonSw = Boolean]
[SchedHrsInclSw = Boolean] >
</WSAScheduledHoursType>
Action Descriptions
Returns all scheduled hours types for update.
Return Value Type: Zero or more WSAScheduledHoursType tags
Introduced in v5.1

Chapter 2
RetrieveAllNames
Returns a list of the names of all scheduled hours types.
Introduced in v5.1
RetrieveForUpdate
Returns the specified scheduled hours type for update.
Return Value Type: WSAScheduledHoursType tag
Introduced in v5.1
Update
Updates the specified scheduled hours type.
Introduced in v5.1
Name
Name
Name of the scheduled hours type. The name can be up to 32 characters long, is
Type: String
Optional Key
Introduced in v5.1

Chapter 2
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
SchedHrsProdMonSw
Should scheduled hours be included in Productivity Monitor?
When "false", appropriate hours are excluded from the Productivity Monitor.
Type: Boolean
Optional
Default value: true
Introduced in v5.2

Chapter 2
WSAScheduleEditor Tag
Schedule Editor
Set up a Schedule Editor to display the schedules of employees.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAScheduleEditor
[DefaultAccrualAmounts = Boolean]
[DefaultBreaks = Boolean]
[DefaultShiftViewType = String]
[DefaultTotals = Boolean]
Name = String
[DefaultScheduleIntervalViewType = String] >
[<ColumnSet>
<WSAWfgColumnSet>
</ColumnSet>]
[<ScheduleTabs>
<WSAScheduleAssistantTab>*
</ScheduleTabs>]

Chapter 2
[<ScheduleMainTabs>
<WSAMainTab>*
</ScheduleMainTabs>]
[<NavbarCategory>
<WSANavbarCategory>
</NavbarCategory>]
<WSAHyperfindQuery>
[<DefaultMainTab>
<WSAMainTab>
</DefaultMainTab>]
<WSADPTimePeriod>
</WSAScheduleEditor>
Action Descriptions
Return Value Type: Zero or more WSAScheduleEditor tags
Optional Properties: ScheduleTabs,ScheduleMainTabs
RetrieveAllNames
RetrieveForUpdate
Return Value Type: WSAScheduleEditor tag

Chapter 2

Update
Optional Properties: ScheduleTabs, ScheduleMainTabs
ColumnSet
Column set name
Specify the name of the column set that the Schedule Editor will use to retrieve
schedule data.
Optional
Introduced in v5.1
DefaultAccrualAmounts
Default accrual amounts
Default Accrual Amounts
Type: Boolean
Optional
DefaultBreaks
Default breaks
Default Breaks
Type: Boolean

Chapter 2
Optional
Query name
Specify the name of the query the Schedule Editor will use to retrieve schedule
data.
Optional
Introduced in v5.1
DefaultMainTab
Tab name
Specify the name of the tab for this Schedule Editor.
Type: WSAMainTab tag
Optional
Introduced in v5.1
DefaultScheduleIntervalViewType
Schedule interval view type
Default Schedule Interval View Type
Type: String
Optional
DefaultShiftViewType
Default shift view type
Default Shift View Type
Type: String
Optional

Chapter 2
DefaultTimePeriod
Time period
Specify a time period that has been defined for scheduling; for example, previous,
current, or next.
Optional
Introduced in v5.1
DefaultTotals
Default totals
Default Totals
Type: Boolean
Optional
Description
Schedule Editor description
Provide a description of the information this Schedule Editor will retrieve.
Type: String
Optional
Introduced in v5.1
DisplayDescription
Provide a description for this Schedule Editor that will be displayed in the user
interface.
Type: String
Optional
Introduced in v5.1
DisplayName
The Display Name

Chapter 2
Type: String
Optional
Introduced in v5.1
Name
Schedule Editor name
Specify a Schedule Editor name; for a new Schedule Editor, specify a name that is
different than existing Schedule Editor names; for changing data, specify a name
of an existing Schedule Editor.
Type: String
Optional Key
Introduced in v5.1
NavbarCategory
Specify the category of the navigation bar where this Schedule Editor will be
listed.
Optional
Introduced in v5.1
ScheduleMainTabs
List of Schedule Main Tab Names
This is a list of Schedule Main Tab names. Passing valid main tab names to this
API will cause those main tabs to be visible to the user having this schedule Editor
genie associated to his/her genie profile.
Type: Zero or more WSAMainTab tags
Optional
Sample values:
<ScheduleMainTabs>
<WSAMainTab Name ="&EMPLOYEE_TAB />
<WSAMainTab Name ="&GROUP_TAB />
<WSAMainTab Name ="&JOB_TAB />
<WSAMainTab Name ="&EMPLOYMENT_TERMS_TAB />

Chapter 2
</ScheduleMainTabs>
Introduced in v6.1
ScheduleTabs
List of Schedule Assistant Tab Names
This is a list of Schedule Assistant Tab names. Passing valid tab names to this API
will cause those tabs to be visible to the user having this schedule editor genie
associated to his/her genie profile
Type: Zero or more WSAScheduleAssistantTab tags
Optional
Sample values:
<ScheduleTabs>
<WSAScheduleAssistantTab Name="&COMMENTS_TAB"/>
Name="&TARGET_HOURS_TAB"/>
</ScheduleTabs>
Introduced in v6.1

Chapter 2
WSAScheduleEditorColumnSet Tag
Column Set for Schedule Editor
The Column Set for Schedule Editor tag allows you to manage schedule editor
column sets.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAScheduleEditorColumnSet
Name = String
[<ColumnDetail>
<WSAColumnDetail>*
</ColumnDetail>]
</WSAScheduleEditorColumnSet>

Chapter 2
Action Descriptions
Return Value Type: Zero or more WSAScheduleEditorColumnSet tags
Introduced in v5.1
RetrieveAllNames
RetrieveForUpdate
Return Value Type: WSAScheduleEditorColumnSet tag
Introduced in v5.1
Update
Introduced in v5.1
ColumnDetail
The set of assigned Column Details

Chapter 2

Optional
Introduced in v5.1
Description
Description
The Description
Type: String
Optional
Introduced in v5.1
DisplayDescription
Type: String
Optional
Introduced in v5.1
DisplayName
The Display Name
Type: String
Optional
Introduced in v5.1
ExteriorItemNumber
Item number
Type: Long
Optional
Introduced in v5.1

Chapter 2
ExteriorName
Item name
The ExteriorName
Type: String
Optional
Introduced in v5.1
Name
Name
Type: String
Optional Key
Introduced in v5.1

Chapter 2
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 schedule.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"Update"
Parameters→
None
Properties→
<WSAScheduleGroupDAP
Name = String >
[<ProfileItems>
<WSAScheduleGroupProfileItem>*
</ProfileItems>]
</WSAScheduleGroupDAP>
Action Descriptions
Retrieve
Returns the specified schedule group data access profile.

Chapter 2
Return Value Type: WSAScheduleGroupDAP tag

Introduced in v6.0
Return all schedule group data access profiles for update.
Return Value Type: Zero or more WSAScheduleGroupDAP tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all schedule group data access profiles.
Introduced in v5.1
RetrieveForUpdate
Returns the specified schedule group data access profile for update.
Return Value Type: WSAScheduleGroupDAP tag
Introduced in v5.1
Update
Updates the specified schedule group data access profile.
Introduced in v5.1

Chapter 2
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 of DAP
Description of the schedule group data access profile.
Type: String
Optional
Name
Name of DAP
Name of the schedule group data access profile. The name can be up to 32
Type: String
Optional Key
ProfileItems
Items in data access profile
List of one or more schedule group profile items associated with the schedule
group data access profile.
Type: Zero or more WSAScheduleGroupProfileItem tags
Optional
Introduced in v5.1

Chapter 2
WSAScheduleGroupDetail Tag
Schedule group detail records
This tag allows you to manage schedule group detail records.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"Update"
Parameters→
None
Properties→
<WSAScheduleGroupDetail
Name = String
[<NavbarCategory>
<WSANavbarCategory>
</NavbarCategory>]
[<ColumnSet>
<WSAWfgColumnSet>
</ColumnSet>]
[<DefaultHyperFindQuery>
<WSAHyperfindQuery>
</DefaultHyperFindQuery>]

Chapter 2
<WSADPTimePeriod>
</WSAScheduleGroupDetail>
Action Descriptions
Retrieve
Returns the specified schedule group detail.
Return Value Type: WSAScheduleGroupDetail tag
Introduced in v6.0
Retrieve all schedule group detail records, returning only properties that are valid
to supply to an update operation
Return Value Type: Zero or more WSAScheduleGroupDetail tags
Introduced in v5.2
RetrieveAllNames
Retrieve the names of all instances in the system
RetrieveForUpdate
Retrieve all the updateable information for the specified schedule group detail
record
Return Value Type: WSAScheduleGroupDetail tag
Introduced in v5.2

Chapter 2
Update
Modify the schedule group detail record. If an object with the specified name
does not exist, it's automatically created.
Introduced in v5.2
ColumnSet
The assigned column set
Optional
Introduced in v5.2
DefaultHyperFindQuery
Default HyperFind query that is assigned
The assigned default hyperfind query
Optional
DefaultTimePeriod
The assigned default time period
Optional
Introduced in v5.2

Chapter 2
Description
Description
The description. It may be a gold/silver data variable, in which case it begins with
an ampersand.
Type: String
Optional
Introduced in v5.2
DisplayDescription
The description to display in the user interface. If the description is a gold/silver
data variable, this value will be the string that variable represents.
Type: String
Optional
Introduced in v5.2
DisplayName
The name of this schedule group detail to display in the user interface. If the
name is a gold/silver data variable, this value will be the string that variable
represents.
Type: String
Optional
Introduced in v5.2
Name
Name
The name for the schedule group detail definition. It may contain a gold/silver
data variable, in which case the value will start with an ampersand.
Type: String
Required Key
Introduced in v5.2

Chapter 2
NavbarCategory
Optional
Introduced in v5.2

Chapter 2
WSAScheduleGroupDetailColumnSet Tag
Schedule Group Detail Column Set
The Schedule Group Detail Column Set tag allows you to manage schedule group
detail column sets.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"Update"
Parameters→
None
Properties→
<WSAScheduleGroupDetailColumnSet
Name = String
[<ColumnDetail>
<WSAColumnDetail>*
</ColumnDetail>]
</WSAScheduleGroupDetailColumnSet>

Chapter 2
Action Descriptions
Retrieve
Returns the specified schedule group detail coulmn set.
Return Value Type: WSAScheduleGroupDetailColumnSet tag
Introduced in v6.0
Retrieve all the schedule group detail column set definitions, returning only
properties that are valid to supply to an update operation.
Return Value Type: Zero or more WSAScheduleGroupDetailColumnSet tags
Introduced in v5.2
RetrieveAllNames
Retrieve the names of all the schedule group detail column set definitions in the
system
RetrieveForUpdate
Retrieve the schedule group detail column set definition with the specified name,
returning only properties that are valid to supply to an update operation
Return Value Type: WSAScheduleGroupDetailColumnSet tag
Introduced in v5.2
Update
Modifies the schedule group detail column set definition identified by the name.
If an object with the specified name does not exist, it's automatically created.

Chapter 2

Introduced in v5.2
ColumnDetail
Optional
Introduced in v5.2
Description
Description
an ampersand.
Type: String
Optional
Introduced in v5.2
DisplayDescription
Type: String
Optional
Introduced in v5.2

Chapter 2
DisplayName
The name of this schedule group detail column set to display in the user interface.
If the name is a gold/silver data variable, this value will be the string that variable
represents.
Type: String
Optional
Introduced in v5.2
ExteriorItemNumber
Item number
The exterior item number
Type: Long
Optional
Introduced in v5.2
ExteriorName
Item name
The exterior name
Type: String
Optional
Introduced in v5.2
Name
Name
The name for the schedule group detail column set definition. It may contain a
gold/silver data variable, in which case the value will start with an ampersand.
Type: String
Optional Key
Introduced in v5.2

Chapter 2
WSAScheduleGroupProfileItem Tag
Schedule Group Profile Item
The Schedule Group Profile Item tag allows you to list and update schedule group
items.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAScheduleGroupProfileItem
Name = String >
</WSAScheduleGroupProfileItem>
Action Descriptions
Retrieve
Returns the specified schedule group profile item.
Return Value Type: WSAScheduleGroupProfileItem tag
Introduced in v6.0

Chapter 2
Returns all schedule group profile items for update.
Return Value Type: Zero or more WSAScheduleGroupProfileItem tags
Introduced in v5.1
RetrieveForUpdate
Returns the specified schedule group profile item for update.
Return Value Type: WSAScheduleGroupProfileItem tag
Introduced in v5.1
Name
Schedule group profile item name
Name of the schedule group profile item. The name can be up to 32 characters
Type: String
Optional Key
Introduced in v5.1

Chapter 2
WSAScheduleGroupRollup Tag
Schedule group rollup records
This tag allows you to manage schedule group rollup definitions.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"Update"
Parameters→
None
Properties→
<WSAScheduleGroupRollup
Name = String
[<NavbarCategory>
<WSANavbarCategory>
</NavbarCategory>]
[<ColumnSet>
<WSAWfgColumnSet>
</ColumnSet>]
[<DefaultHyperFindQuery>
<WSAHyperfindQuery>
</DefaultHyperFindQuery>]

Chapter 2
<WSADPTimePeriod>
</WSAScheduleGroupRollup>
Action Descriptions
Retrieve
Returns the specified schedule group rollup.
Return Value Type: WSAScheduleGroupRollup tag
Introduced in v6.0
Retrieve all the schedule group roll-up definitions, returning only properties that
are valid to supply to an update operation.
Return Value Type: Zero or more WSAScheduleGroupRollup tags
Introduced in v5.2
RetrieveAllNames
Retrieve the names of all the Schedule Group Roll-up definitions in the system
RetrieveForUpdate
Retrieve the schedule group roll-up definition with the specified name, returning
only properties that are valid to supply to an update operation
Return Value Type: WSAScheduleGroupRollup tag
Introduced in v5.2

Chapter 2
Update
Modifies the schedule group roll-up definition identified by the name. If an object
with the specified name does not exist, it's automatically created.
Optional Properties: ColumnSet, DefaultHyperfindQuery, DefaultTimePeriod,
Description, DisplayDescription, DisplayName, NavbarCategory
Introduced in v5.2
ColumnSet
The assigned column set
Optional
Introduced in v5.2
DefaultHyperFindQuery
Default HyperFind query that is assigned
The assigned default hyperfind query
Optional
DefaultTimePeriod
The assigned default time period
Optional
Introduced in v5.2

Chapter 2
Description
Description
An optional description for the schedule group rollup. It may contain a gold/silver
data variable, in which case it will start with an ampersand.
Type: String
Optional
Introduced in v5.2
DisplayDescription
Type: String
Optional
Introduced in v5.2
DisplayName
The name of this schedule group roll-up to display in the user interface. If the
name is a gold/silver data variable, this value will be the string that variable
represents.
Type: String
Optional
Introduced in v5.2
Name
Name
The name for the schedule group roll-up definition. It may be a gold/silver data
variable, in which case the value will start with an ampersand.
Type: String
Required Key
Introduced in v5.2

Chapter 2
NavbarCategory
The assigned category for the navigation bar
Optional
Introduced in v5.2

Chapter 2
WSAScheduleGroupRollupColumnSet Tag
Schedule group rollup column set
This tag allows you to manage schedule group rollup column sets.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"Update"
Parameters→
None
Properties→
<WSAScheduleGroupRollupColumnSet
Name = String
[<ColumnDetail>
<WSAColumnDetail>*
</ColumnDetail>]
</WSAScheduleGroupRollupColumnSet>

Chapter 2
Action Descriptions
Retrieve
Returns the specified schedule group rollup column set.
Return Value Type: WSAScheduleGroupRollupColumnSet tag
Introduced in v6.0
Retrieve all the schedule group roll-up column set definitions, returning only
properties that are valid to supply to an update operation.
Return Value Type: Zero or more WSAScheduleGroupRollupColumnSet tags
Introduced in v5.2
RetrieveAllNames
Retrieve the names of all the schedule group roll-up column set definitions in the
system
RetrieveForUpdate
Retrieve the schedule group roll-up column set definition with the specified name,
returning only properties that are valid to supply to an update operation
Return Value Type: WSAScheduleGroupRollupColumnSet tag
Introduced in v5.2
Update
Modifies the schedule group roll-up column set definition identified by the name.
If an object with the specified name does not exist, it's automatically created.

Chapter 2

Introduced in v5.2
ColumnDetail
Optional
Introduced in v5.2
Description
Description
an ampersand.
Type: String
Optional
Introduced in v5.2
DisplayDescription
Type: String
Optional
Introduced in v5.2

Chapter 2
DisplayName
The name of this schedule group roll-up column set to display in the user
interface. If the name is a gold/silver data variable, this value will be the string
that variable represents.
Type: String
Optional
Introduced in v5.2
ExteriorItemNumber
Item number
The exterior item number
Type: Long
Optional
Introduced in v5.2
ExteriorName
Item name
The exterior name
Type: String
Optional
Introduced in v5.2
Name
Name
The name for the schedule group roll-up column set definition. It may contain a
gold/silver data variable, in which case the value will start with an ampersand.
Type: String
Optional Key
Introduced in v5.2

Chapter 2
WSASchedulePeriod Tag
Schedule Period
The Schedule Period tag allows you to manage schedule periods within the
context of Display Preferences.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSASchedulePeriod
Name = String >
</WSASchedulePeriod>
Action Descriptions
Return Value Type: Zero or more WSASchedulePeriod tags
Introduced in v5.1

Chapter 2
RetrieveAllNames
Introduced in v5.1
RetrieveForUpdate
Return Value Type: WSASchedulePeriod tag
Introduced in v5.1
Name
Specify the name of the schedule period.
Type: String
Optional Key
Introduced in v5.1

Chapter 2
WSASchedulePlanner Tag
Schedule Planner
This tag lets you manage schedule planners within the context of Display
Preferences.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSASchedulePlanner
[DefaultAccrualAmounts = Boolean]
[DefaultAvailability = Boolean]
[DefaultBreaks = Boolean]
[DefaultDailyCosts = Boolean]
[DefaultDailyCoverage = Boolean]
[DefaultOpenShifts = Boolean]
[DefaultTotals = Boolean]
[DefaultScheduleIntervalViewType = String]
[DefaultShiftViewType = String]
[DefaultZones = Boolean]
[NavbarCategory = String]

Chapter 2
[DefaultHyperfindQuery = String]
[ScheduleAssistant = String]
Name = String
[DefaultMainTab = String]
[DefaultScheduleAssistantTab = String]
[DefaultTimePeriod = String] >
[<ScheduleTabs>
<WSAScheduleAssistantTab>*
</ScheduleTabs>]
[<ScheduleMainTabs>
<WSAMainTab>*
</ScheduleMainTabs>]
</WSASchedulePlanner>
Action Descriptions
Return Value Type: Zero or more WSASchedulePlanner tags
RetrieveAllNames
RetrieveForUpdate
Return Value Type: WSASchedulePlanner tag

Chapter 2

Update
ColumnSet
Name of column set
Specify the name of the column set that will return the requested data.
Type: String
Optional
Introduced in v5.1
DefaultAccrualAmounts
Default accrual amounts
Default Accrual Amounts
Type: Boolean
Optional
DefaultAvailability
Default availability
Default Availability
Type: Boolean
Optional

Chapter 2
DefaultBreaks
Default breaks
Default Breaks
Type: Boolean
Optional
DefaultDailyCosts
Default daily costs
Default Daily Costs
Type: Boolean
Optional
DefaultDailyCoverage
Default daily coverage
Default Daily Coverage
Type: Boolean
Optional
Query name
Specify the name of the query that will be used to request the Schedule Planner
data.
Type: String
Optional
Introduced in v5.1
DefaultMainTab
Tab name
The tab name to be assigned to this Schedule Planner.
Type: String

Chapter 2
Optional
Introduced in v5.1
DefaultOpenShifts
Default open shifts
Default Open Shifts
Type: Boolean
Optional
DefaultScheduleAssistantTab
Tab name for schedule assistant
Specify the name of the tab for the schedule assistant.
Type: String
Optional
Introduced in v5.1
DefaultScheduleIntervalViewType
Default view type (schedule interval)
Default Schedule Interval View Type
Type: String
Optional
DefaultShiftViewType
Default view type (shift)
Default Shift View Type
Type: String
Optional

Chapter 2
DefaultTimePeriod
Time period name
Specify a time period that has been defined for scheduling; for example, previous,
current, or next.
Type: String
Optional
Introduced in v5.1
DefaultTotals
Default totals
Default Totals
Type: Boolean
Optional
DefaultZones
Default zones
Default Zones
Type: Boolean
Optional
Description
Schedule Planner description
Provide a description about what information this Schedule Planner retrieves.
Type: String
Optional
Introduced in v5.1
DisplayDescription
Provide a description of this schedule planner that will be displayed in the user
interface.

Chapter 2
Type: String
Optional
Introduced in v5.1
DisplayName
Specify a name for this schedule planner that will be displayed in the user
interface.
Type: String
Optional
Introduced in v5.1
Name
Schedule planner name
Specify the name of this schedule planner that can be used to reference it in an
XML call.
Type: String
Optional Key
Introduced in v5.1
NavbarCategory
Specify the category of the navigation bar where this Schedule Planner will be
listed.
Type: String
Optional
Introduced in v5.1
ScheduleAssistant
Schedule assistant name
Specify the name of the schedule assistant.
Type: String
Optional
Introduced in v5.1

Chapter 2
ScheduleMainTabs
List of Schedule Main Tab Names
This is a list of Schedule Main Tab names. Passing valid main tab names to this
API will cause those main tabs to be visible to the user having this schedule
planner genie associated to his/her genie profile.
Type: Zero or more WSAMainTab tags
Optional
Sample values:
<ScheduleMainTabs>
<WSAMainTab Name ="&EMPLOYEE_TAB />
<WSAMainTab Name ="&GROUP_TAB />
<WSAMainTab Name ="&JOB_TAB />
<WSAMainTab Name ="&EMPLOYMENT_TERMS_TAB />
</ScheduleMainTabs>
Introduced in v6.1
ScheduleTabs
List of Schedule Assistant Tab Names
This is a list of Schedule Assistant Tab names. Passing valid tab names to this API
will cause those tabs to be visible to the user having this schedule planner genie
associated to his/her genie profile.
Type: Zero or more WSAScheduleAssistantTab tags
Optional
Sample values:
<ScheduleTabs>
Name="&SCHEDULE_ASSISTANT_TAB"/>
<WSAScheduleAssistantTab Name="&CALL_LIST_TAB"/
>
<WSAScheduleAssistantTab Name="&METRICS_TAB"/>
</ScheduleTabs

Chapter 2
WSASchedulePlannerColumnSet Tag
Column Set for Schedule Planner
The Column Set for Schedule Planner tag allows you to manage schedule planner
column sets.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSASchedulePlannerColumnSet
Name = String
[<ColumnDetail>
<WSAColumnDetail>*
</ColumnDetail>]
</WSASchedulePlannerColumnSet>

Chapter 2
Action Descriptions
Return Value Type: Zero or more WSASchedulePlannerColumnSet tags
Introduced in v5.1
RetrieveAllNames
RetrieveForUpdate
Return Value Type: WSASchedulePlannerColumnSet tag
Introduced in v5.1
Update
Introduced in v5.1
ColumnDetail
The list of assigned Column Details

Chapter 2

Optional
Introduced in v5.1
Description
Description
The Description
Type: String
Optional
Introduced in v5.1
DisplayDescription
Type: String
Optional
Introduced in v5.1
DisplayName
The Display Name
Type: String
Optional
Introduced in v5.1
ExteriorItemNumber
Item number
Type: Long
Optional
Introduced in v5.1

Chapter 2
ExteriorName
Item name
The Exterior Name
Type: String
Optional
Introduced in v5.1
Name
Name
Type: String
Optional Key
Introduced in v5.1

Chapter 2
WSASequencedItem Tag
Sequenced Item
The Sequenced Item tag allows you to manage sequenced items. For internal use
with Processing Order Rules. (Now known as Processing Order rules in the v5.1
GUI.)
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSASequencedItem
Name = String
TypeCode = String >
</WSASequencedItem>
Action Descriptions
RetrieveForUpdate
Returns the specified sequenced item for update.
Return Value Type: WSASequencedItem tag
Required Properties: Name, TypeCode
Introduced in v5.1

Chapter 2
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 Key
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 Key
Introduced in v5.1

Chapter 2
WSASequencerRule Tag
Sequencer Rule
The Sequencer Rule tag identifies the Sequencer rule that defines the order in
which accumulated hour types are processed. The Sequencer is one step in the
Totalizer process.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSASequencerRule
Name = String >
[<DoFirstList>
<WSASequencedItem>*
</DoFirstList>]
[<DoLastList>
<WSASequencedItem>*
</DoLastList>]
</WSASequencerRule>

Chapter 2
Action Descriptions
Retrieve all sequencer rules for update.
Return Value Type: Zero or more WSAProcessingOrderRule tags
RetrieveAllNames
Returns a list of the names of all sequencer rules.
RetrieveForUpdate
Returns the specified sequencer rule for update.
Return Value Type: WSAProcessingOrderRule tag
Update
Updates the specified sequencer rule.

Chapter 2
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.
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.
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 Key
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAShiftGuarantee
[Friday = TimeDuration]
[Monday = TimeDuration]
Name = String
[ReductByAmountTardy = Boolean]
[Saturday = TimeDuration]
[Sunday = TimeDuration]
[Thursday = TimeDuration]
[Tuesday = TimeDuration]
[Wednesday = TimeDuration]
[WorkRule = String] >
</WSAShiftGuarantee>

Chapter 2
Action Descriptions
Returns all shift guarantees for update.
Return Value Type: Zero or more WSAShiftGuarantee tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all shift guarantees.
Introduced in v5.1
RetrieveForUpdate
Returns the specified shift guarantee for update.
Return Value Type: WSAShiftGuarantee tag
Introduced in v5.1
Update
Updates the specified shift guarantee.
Introduced in v5.1
Friday
Friday
Length of the guaranteed shift for Friday.

Chapter 2
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-
Type: String
Optional Key
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

Chapter 2
Saturday
Saturday
Length of the guaranteed shift for Saturday.
Type: TimeDuration
Optional
Introduced in v5.1
Sunday
Sunday
Length of the guaranteed shift for Sunday.
Type: TimeDuration
Optional
Introduced in v5.1
Thursday
Thursday
Length of the guaranteed shift for Thursday.
Type: TimeDuration
Optional
Introduced in v5.1
Tuesday
Tuesday
Length of the guaranteed shift for Tuesday.
Type: TimeDuration
Optional
Introduced in v5.1
Wednesday
Wednesday
Length of the guaranteed shift for Wednesday.
Type: TimeDuration
Optional
Introduced in v5.1

Chapter 2
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

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve"
Parameters→
None
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
Introduced in v5.1

Chapter 2
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 Key
Introduced in v5.1

Chapter 2
WSAShiftLengthExclusion Tag
Shift length to exclude
WSAShiftLengthExclusion
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<WSAShiftLengthExclusion
Length = String >
</WSAShiftLengthExclusion>
Length
Length
Length
Type: String
Required

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAShiftTemplateDAP
Name = String
[AllowAll = Boolean] >
[<ProfileItems>
<WSAShiftTemplateProfileItem>*
</ProfileItems>]
</WSAShiftTemplateDAP>
Action Descriptions
Returns all shift template data access profiles for update.

Chapter 2
Return Value Type: Zero or more WSAShiftTemplateDAP tags

Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all shift template data access profiles.
Introduced in v5.1
RetrieveForUpdate
Returns the specified shift template data access profile for update.
Return Value Type: WSAShiftTemplateDAP tag
Introduced in v5.1
Update
Updates the specified shift template data access profile.
Introduced in v5.1
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

Chapter 2
Description
Description
Description of the shift template data access profile.
Type: String
Optional
Introduced in v5.1
Name
Data access profile name
Name of the shift template data access profile. The name can be up to 32
Type: String
Optional Key
Introduced in v5.1
ProfileItems
Shift templates in the data access profile
List of one or more shift templates associated with this shift template data access
profile.
Type: Zero or more WSAShiftTemplateProfileItem tags
Optional

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<WSAShiftTemplateProfileItem
Name = String >
</WSAShiftTemplateProfileItem>
Name
Shift template name
Name of a shift template. The name can be up to 32 characters long, is case-
Type: String
Optional Key
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSASignOffRestriction
[DisallowIfMissingPunches = Boolean]
[DisallowIfUnexcusedAbsences = Boolean]
[DisallowIfZeroHours = Boolean]
Name = String
[PayCodeForZeroHours = String] >
</WSASignOffRestriction>
Action Descriptions
Returns all sign-off restrictions for update.
Return Value Type: Zero or more WSASignOffRestriction tags

Chapter 2

Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all sign-off restrictions.
Introduced in v5.1
RetrieveForUpdate
Returns the specified sign-off restriction for update.
Return Value Type: WSASignOffRestriction tag
Introduced in v5.1
Update
Updates the specified sign-off restriction.
Introduced in v5.1
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

Chapter 2
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
Type: String
Optional Key
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.

Chapter 2
Type: String
Optional
Introduced in v5.1

Chapter 2
WSASubsequentGrant Tag
Subsequent Grant
This API holds the data for the Accrual Policy's subsequent grant. A subsequent
grant is awarded one or more times after the initial grant - for example, after a
period of time defined by a date pattern.
This API is not meant to be a standalone API. It must be accessed through the
WSAAccrualPolicy API.
Syntax
Request→
Parameters >
Properties
</Request>
Properties→
<WSASubsequentGrant
AccrualRule = String
Amount = String
GrantRule = String
MilestoneNumber = Integer >
</WSASubsequentGrant>
AccrualRule
Accrual rule
The Accrual Policy Rule associated with this subsequent grant.
Type: String
Required
Introduced in v5.2

Chapter 2
Amount
Amount accrued
The amount accrued by this grant.
Type: String
Required
This value must be valid for the accrual policy rule's date pattern specified in the
accrual rule.
Introduced in v5.2
ExpireToAccrual
Type: String
Optional
Introduced in v5.2
GrantRule
Grant rule
The Grant Rule associated with this subsequent grant.
Type: String
Required
Introduced in v5.2
MilestoneNumber
Milestone number
Represents the milestone for this grant. Typically, a grant is awarded or its amount
changes when a milestone occurs.
Type: Integer
Required
Introduced in v5.2

Chapter 2
WSATimePeriod Tag
Time Period
The Time Period tag returns information about one or more time periods.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveForUpdate"
Parameters→
None
Action Descriptions
Retrieve
Return the Time Period with the given name.
Return Value Type: WSATimePeriod tag
Introduced in v5.2
Returns a list of WSATimePeriods

Chapter 2

Introduced in v5.2
RetrieveAllNames
Return a list of all the names of all the Time Periods
Introduced in v5.2
RetrieveForUpdate
Returns the WSA Time Period with the given name.
Return Value Type: WSATimePeriod tag
Introduced in v5.2

Chapter 2
WSATkTerminalRule Tag
Punch Interpretation Rule (formerly Terminal Rule)
This 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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Delete" |
"Retrieve" |
"Update"
Parameters→
None
Properties→
<WSATkTerminalRule
[UnscheduledIn = Boolean]
[AllowOverrides = Boolean]
[EnforceBreaks = Boolean]
[EarlyStart = TimeDuration]
[EarlyScheduleMargin = TimeDuration]
[LateEndBreakMargin = TimeDuration]
[LateStartBreakMargin = TimeDuration]
[LateStart = TimeDuration]
[LateScheduleMargin = TimeDuration]
[LateEnd = TimeDuration]
[LateEndMargin = TimeDuration]

Chapter 2
[EarlyStartBreakMargin = TimeDuration]
[MaximumShiftLength = TimeDuration]
[MinimumMeal = TimeDuration]
Name = String
[RuleNumber = Integer]
[PunchRestrictions = Boolean]
[BeginEarlyEnd = TimeDuration]
[MaximumOut = TimeDuration]
[LiftEarlyEnd = TimeDuration]
[UnscheduledShiftLength = TimeDuration] >
</WSATkTerminalRule>
Action Descriptions
Delete
Delete the Terminal Rule with the specified name.
Introduced in v5.2
Retrieve
Retrieve the specified Terminal Rule.
Return Value Type: WSATkTerminalRule tag
Introduced in v5.2
Returns all terminal rules for update.
Return Value Type: Zero or more WSATkTerminalRule tags
Introduced in v5.1

Chapter 2
RetrieveAllNames
Returns a list of the names of all terminal rules.
Introduced in v5.1
RetrieveForUpdate
Returns the specified terminal rule for update.
Return Value Type: WSATkTerminalRule tag
Introduced in v5.1
Update
Updates the specified terminal rule.
Introduced in v5.1
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

Chapter 2
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 device.
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 device.
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

Chapter 2
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
LateEnd
Late punch-out
Value, specified in HH:mm format, that determines how late an employee is
allowed to punch out using a device.
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

Chapter 2
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 device.
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

Chapter 2
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
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 device rule
Name of the device rule. The name can be up to 32 characters long, is case-

Chapter 2
Type: String
Optional Key
Introduced in v5.1
PunchRestrictions
Specifies Full or Simple punch restrictions
Boolean value that, when True, indicates Full, 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 TerminalRule tag.
Type: Boolean
Optional
Introduced in v5.1
RuleNumber
Rule number
The assigned Rule Number. It will be a value between 0 and 15. This value is
used for internal purposes. As of v5.2 this attribute is no longer returned by
RetrieveForUpdate and RetrieveAllForUpdate actions. It is, though, returned for
the Retrieve action. It can be specified when executing an Update action, but it
isn't necessary. In fact, it is recommended that it not be provided in an Update
request.
Type: Integer
Optional
UnscheduledIn
Are unscheduled in-punches allowed?
Boolean value that, when True, allows an employee without a scheduled shift to
punch in.
Type: Boolean
Optional
Introduced in v5.1

Chapter 2
UnscheduledShiftLength
Unscheduled shift length
Value, specified in HH:mm format, used to calculate the expected end to an
unscheduled shift.
Type: TimeDuration
Optional
Introduced in v5.1

Chapter 2
WSATreeType Tag
Tree Type
The Tree Type tag allows you to manage tree types.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSATreeType
[LeafNodeSupportSwitch = Integer]
[IsDefaultSwitch = Integer]
[LanguageCD = String]
Name = String
[TreeTypeCD = String] >
</WSATreeType>
Action Descriptions
Return Value Type: Zero or more WSATreeType tags
Introduced in v5.1

Chapter 2
RetrieveAllNames
Introduced in v5.1
RetrieveForUpdate
Return Value Type: WSATreeType tag
Introduced in v5.1
Description
Description
The Description
Type: String
Optional
Introduced in v5.1
IsDefaultSwitch
Is this the default tree type?
The Is Default Switch
Type: Integer
Optional
Introduced in v5.1
LanguageCD
Language CD
The Language CD
Type: String

Chapter 2
Optional
Introduced in v5.1
LeafNodeSupportSwitch
Does the tree support leaf nodes?
Does the tree support leaf nodes (nodes which do not allow children)?
Type: Integer
Optional
Introduced in v5.1
Name
Name
Type: String
Optional Key
Introduced in v5.1
TreeTypeCD
Tree Type CD
The Tree Type CD
Type: String
Optional
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAULLE
[Name = String] >
</WSAULLE>
Action Descriptions
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

Chapter 2
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
Introduced in v5.1
RetrieveAllNames
Returns a list containing the name of 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.)
Introduced in v5.1
RetrieveForUpdate
Returns the one logical unspecified labor level entry for update. (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: WSAULLE tag
Introduced in v5.1
Update
Updates the one logical unspecified labor level entry. (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.)
Introduced in v5.1

Chapter 2
Description
Description
Description of the unspecified labor level entry.
Type: String
Optional
Introduced in v5.1
Name
Name
Name of the unspecified labor level entry. The name can be up to 32 characters
Type: String
Optional
Introduced in v5.1

Chapter 2
WSAWageAdjustment Tag
Wage Adjustment
The Wage Adjustment tag allows you to define an adjustment to a wage profile to
include an amount that changes an employee's base wage.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAWageAdjustment
[Amount = String]
LaborLevelEntryName = String
LaborLevelName = String
[Type = Integer]
WageProfileName = String
LaborLevelEntryWildcard = String >
</WSAWageAdjustment>
Action Descriptions
RetrieveForUpdate
Returns the specified wage adjustment for update.
Return Value Type: WSAWageProfile tag

Chapter 2
Required Properties: WageProfileName, LaborLevelName,

LaborLevelEntryName, LaborLevelEntryWildcard
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 Key
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 Key
Introduced in v5.1

Chapter 2
LaborLevelName
Labor level name
Name of the associated labor level.
Type: String
Optional Key
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 Key
Introduced in v5.1

Chapter 2
WSAWageProfile Tag
Setup 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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAWageProfile
[OverrideIfHomeSwitch = Boolean]
[UseHighestWageSwitch = Boolean]
Name = String >
[<WgpPayCodes>
<WSAWageProfilePayCode>*
</WgpPayCodes>]
[<WageProfileLLDef>
<WSAWageProfileLaborLevelLinkage>*
</WageProfileLLDef>]
</WSAWageProfile>

Chapter 2
Action Descriptions
Returns all wage profiles for update.
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all wage profiles.
Introduced in v5.1
RetrieveForUpdate
Returns the specified wage profile for update.
Introduced in v5.1
Update
Updates the specified wage profile.
Introduced in v5.1

Chapter 2
Name
WSA Wage Profile Name
Name of the wage profile. The name can be up to 32 characters long, is case-
Type: String
Optional Key
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

Chapter 2
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

Chapter 2
WSAWageProfileLaborLevelLinkage Tag
Wage Profile to Labor Level Mapping
This tag links a wage profile to labor levels. Internal use by WSAWageProfile.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAWageProfileLaborLevelLinkage
LaborLevelName = String
WageProfileName = String >
[<Adjustments>
<WSAWageAdjustment>*
</Adjustments>]
</WSAWageProfileLaborLevelLinkage>
Action Descriptions
RetrieveForUpdate
Returns the specified wage profile labor level linkage.
Return Value Type: WSAWageProfileLaborLevelLinkage tag
Required Properties: WageProfileName, LaborLevelName
Introduced in v5.1

Chapter 2
Adjustments
List of adjustments applying to the linkage
List of adjustments applying to the linked labor level and wage profile.
Type: Zero or more WSAWageAdjustment tags
Optional
LaborLevelName
Labor level name
Name of associated labor level.
Type: String
Optional Key
Introduced in v5.1
WageProfileName
Wage profile name
Name of the associated wage profile.
Type: String
Optional Key

Chapter 2
WSAWageProfilePayCode Tag
Wage Profile Pay Code
Internal Use by WSAWageProfile
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAWageProfilePayCode
Name = String >
</WSAWageProfilePayCode>
Action Descriptions
RetrieveForUpdate
Returns the specified wage profile pay code for update.
Return Value Type: WSAWageProfilePayCode tag
Introduced in v5.1

Chapter 2
Name
Name
Name of the wage profile pay code. The name is case-insensitive and must be
unique.
Type: String
Optional Key
Introduced in v5.1

Chapter 2
WSAWfgColumnSet Tag
Column Set
The Column Set tag allows you to create and manage column sets.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAWfgColumnSet
TypeExteriorName = String
TypeExteriorNumber = Long
Name = String >
</WSAWfgColumnSet>
Action Descriptions
Retrieve
Returns the specified column set.
Return Value Type: WSAWfgColumnSet tag
Required Properties: Name, TypeExteriorName, TypeExteriorNumber
Introduced in v5.2

Chapter 2
RetrieveForUpdate
Returns the specified column set for update.
Return Value Type: WSAWfgColumnSet tag
Required Properties: Name, TypeExteriorName, TypeExteriorNumber
Introduced in v5.1
Name
Name
Name of the column set. The name is case-insensitive and must be unique.
Type: String
Optional Key
Introduced in v5.1
TypeExteriorName
Exterior name of the Summary View type
Summary View Type Exterior Name
Type: String
Optional Key
Introduced in v5.2
TypeExteriorNumber
Exterior number of the Summary View type
Exterior Number of the Summary View Type
Type: Long
Optional Key
Introduced in v5.2

Chapter 2
WSAWorkforceGenieProfile Tag
Profile building block
The Profile building block tag allows you to create and maintain profiles that
contain the set of queries (except Workload Planners, which use Workload
Planner profiles) that are listed on the navigation bar for employees assigned to
them.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAWorkforceGenieProfile
Name = String
[<Genies>
<WSAGenie>*
</Genies>]
</WSAWorkforceGenieProfile>

Chapter 2
Action Descriptions
Returns all profiles for update.
Return Value Type: Zero or more WSAWorkforceGenieProfile tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all profiles.
RetrieveForUpdate
Returns the specified profile for update.
Return Value Type: WSAWorkforceGenieProfile tag
Introduced in v5.1
Update
Updates the specified profile.
Introduced in v5.1
Description
Description
Description of the profile building block.

Chapter 2
Type: String
Optional
Introduced in v5.1
DisplayDescription
Description of the profile building block that is displayed in the user interface.
Type: String
Optional
Introduced in v5.1
DisplayName
Name of the profile building block to be displayed in the user interface.
Type: String
Optional
Introduced in v5.1
Genies
Items that are assigned
List of one or more items associated with this profile building block.
Type: Zero or more WSAGenie tags
Optional
Introduced in v5.1
Name
Name
Name of the profile building block. The name is case-insensitive and must be
unique.
Type: String
Optional Key
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAWorkHistoryQualifierRule
[AmountUnits = String]
[ContributingShiftRuleName = String]
Name = String
[Type = String] >
</WSAWorkHistoryQualifierRule>
Action Descriptions
Returns all work history qualifier rules for update.
Return Value Type: Zero or more WSAWorkHistoryQualifierRule tags

Chapter 2

Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all work history qualifier rules.
Introduced in v5.1
RetrieveForUpdate
Returns the specified work history qualifier rule for update.
Return Value Type: WSAWorkHistoryQualifierRule tag
Introduced in v5.1
Update
Updates the specified work history qualifier rule.
Introduced in v5.1
AmountUnits
Minimum or maximum number of hours, days, or shifts
Amount of the minimum or maximum number of hours, days or shifts, depending
on the Type property. The returned String will be "converted" to type
KTimeDuration for types B and E, Integer for the others.
Type: String
Optional
Introduced in v5.1

Chapter 2
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
Type: String
Optional Key
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

Chapter 2
WSAWorkloadPlannerProfile Tag
Workload Planner Profile
The Workload Planner Profile tag allows you to create and manage a profile that
determine which Workload Planners an employee can access and where on the
navigation bar the Workload Planner names appear.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAWorkloadPlannerProfile
Name = String >
</WSAWorkloadPlannerProfile>
Action Descriptions
Returns all workload planner profiles for update.
Return Value Type: Zero or more WSAWorkloadPlannerProfile tags
Introduced in v5.1

Chapter 2
RetrieveAllNames
Returns a list of the names of all workload planner profiles.
Introduced in v5.1
RetrieveForUpdate
Returns a specific workload planner profile for update.
Return Value Type: WSAWorkloadPlannerProfile tag
Introduced in v5.1
Name
Name
Name of the workload planner profile. The name is case-insensitive and must be
unique.
Type: String
Optional Key
Introduced in v5.1

Chapter 2
WSAWorkRule Tag
Setup 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
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAWorkRule
Name = String >
[<EffectiveWorkRules>
<WSAEffectiveWorkRule>*
</EffectiveWorkRules>]
</WSAWorkRule>
Action Descriptions
Returns all work rules for update.
Return Value Type: Zero or more WSAWorkRule tags

Chapter 2

Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all work rules.
Introduced in v5.1
RetrieveForUpdate
Returns the specified work rule for update.
Return Value Type: WSAWorkRule tag
Introduced in v5.1
Update
Updates the specified work rule.
Introduced in v5.1
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

Chapter 2
Name
Name of WSA work rule
Name of the work rule. The name can be up to 32 characters long, is case-
Type: String
Optional Key
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAWorkRuleDAP
Name = String >
[<ProfileItems>
<WSAWorkRuleProfileItem>*
</ProfileItems>]
</WSAWorkRuleDAP>
Action Descriptions
Returns all work rule data access profiles for update.

Chapter 2
Return Value Type: Zero or more WSAWorkRuleDAP tags

Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all work rule data access profiles.
Introduced in v5.1
RetrieveForUpdate
Returns the specified work rule data access profile for update.
Return Value Type: WSAWorkRuleDAP tag
Introduced in v5.1
Update
Updates the specified work rule data access profile.
Introduced in v5.1
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

Chapter 2
Description
Description
Description of the work rule data access profile.
Type: String
Optional
Introduced in v5.1
Name
Work rule data access profile name
Name of the work rule data access profile. The name can be up to 32 characters
Type: String
Optional Key
Introduced in v5.1
ProfileItems
Work rules included in the data access profile
List of one or more work rule profile items associated with this work rule data
access profile.
Type: Zero or more WSAWorkRuleProfileItem tags
Optional
Introduced in v5.1

Chapter 2
WSAWorkRuleGeneral Tag
General work rule components
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve"
Parameters→
None
Properties→
<WSAWorkRuleGeneral
[BreakRuleNames = String list]
Name = String >
[<BonusDeductRuleNames>
<SimpleValue>*
</BonusDeductRuleNames>]
[<CoreHoursRuleNames>
<SimpleValue>*
</CoreHoursRuleNames>]
</WSAWorkRuleGeneral>
Action Descriptions
Retrieve
Returns the specified general work rule.
Return Value Type: WSAWorkRuleGeneral tag

Chapter 2

Introduced in v5.1
BonusDeductRuleNames
Bonuses and deductions rule name
List of one or more bonus/deduction rules associated with this general rule.
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.
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.
Optional

Chapter 2
Name
Name of the general work rule
Name of the general work rule. The name can be up to 32 characters long, is case-
Type: String
Optional Key
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve"
Parameters→
None
Properties→
<WSAWorkRulePCDistr
Name = String >
[<ExtensionNames>
<SimpleValue>*
</ExtensionNames>]
[<MajorityRuleNames>
<SimpleValue>*
</MajorityRuleNames>]
[<OvertimeRuleNames>
<SimpleValue>*
</OvertimeRuleNames>]
[<ScheduleDeviationRuleNames>
<SimpleValue>*
</ScheduleDeviationRuleNames>]
[<ZoneRuleNames>
<SimpleValue>*

Chapter 2
</ZoneRuleNames>]
</WSAWorkRulePCDistr>
Action Descriptions
Retrieve
Returns the specified pay code distribution.
Return Value Type: WSAWorkRulePCDistr tag
Introduced in v5.1
ExtensionNames
List of extension processors
Optional
MajorityRuleNames
Majority rules
List of one or more majority rules associated with this pay code distribution.
Optional
Name
Name of the pay code distribution
Name of the pay code distribution. The name can be up to 32 characters long, is
Type: String

Chapter 2
Optional Key
Introduced in v5.1
OvertimeRuleNames
Overtime rules
List of one or more overtime rules associated with this pay code distribution.
Optional
ScheduleDeviationRuleNames
Schedule deviation rules
List of one or more schedule deviation rules associated with this pay code
distribution.
Optional
ZoneRuleNames
Zone rule
List of one or more zone rules associated with this pay code distribution.
Optional

Chapter 2
WSAWorkRuleProfileItem Tag
Work Rule Profile Item
The Work Rule Profile Item tag allows you to list and update work rule profile
items.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetreiveAllForUpdate" |
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAWorkRuleProfileItem
Name = String >
</WSAWorkRuleProfileItem>
Action Descriptions
RetreiveAllForUpdate
Returns all work rule profile items for update.
Return Value Type: Zero or more WSAWorkRuleProfileItem tags
Introduced in v5.1
RetrieveForUpdate
Returns the specified work rule profile item for update.

Chapter 2
Return Value Type: WSAWorkRuleProfileItem tag

Introduced in v5.1
Name
Work rule profile item name
Name of the work rule profile item. The name can be up to 32 characters long, is
Type: String
Optional Key
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAZone
[StartWorkAfterTime = Time]
[EndWorkAfterTime = Time]
[StartWorkBeforeTime = Time]
[EndWorkBeforeTime = Time]
[EndWorkAfterTimeSwitch = Boolean]
[StartWorkBeforeTimeSwitch = Boolean]
[StartWorkAfterTimeSwitch = Boolean]
[EndWorkBeforeTimeSwitch = Boolean]
[QualifiersUnscheduled = Boolean]
[StartNumberOfDay = Integer]
[EndNumberOfDay = Integer]
[HolidayPolicyTypeId = String]
[HolidayDeductTypeId = String]
[MinimumHoursWithinZone = TimeDuration]
[ConsecutiveLastDayMinimumTime = TimeDuration]
[MinimumHoursWithinShift = TimeDuration]
[ConsecutiveMinimumTime = TimeDuration]

Chapter 2
[ConsecutiveDayNumber = Integer]
[NumberOfDay = Integer]
[ExpansionMarginsLateTime = TimeDuration]
[ExpansionMarginsEarlyTime = TimeDuration]
[StartTime = Time]
[EndTime = Time]
[ConsecutiveType = String]
[DaysOfWeekZonesAppliesType = Boolean]
[QualifiersBasedOnType = 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
Introduced in v5.1
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).

Chapter 2
Type: Integer
Optional
Introduced in v5.1
ConsecutiveLastDayMinimumTime
Minimum 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 milliseconds.
Introduced in v5.1
ConsecutiveType
Type of qualifying 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.

Chapter 2
• 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

Chapter 2
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 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

Chapter 2
Optional
Introduced in v5.1
EndWorkBeforeTime
Allowable amount of time before zone ends
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?
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 differential 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

Chapter 2
ExpansionMarginsLateTime
Time after zone when an employee can earn shift differential
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
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.

Chapter 2

Use Fixed Rule Setting.
Scheduled In-day.
Scheduled Out-day.
Day With Majority Hours.
belong to Use Fixed Rule Setting.
belong to Scheduled In-day.
belong to Scheduled Out-day.
belong to Day With Majority Hours.
Type: String
Optional
Introduced in v5.1
MinimumHoursWithinShift
Minimum time to qualify for shift differential
of time, in HH:mm format, that an employee's rounded shift length must equal for
the employee to qualify for the shift differential.
Type: TimeDuration
Optional
Default value: 0.00
Introduced in v5.1

Chapter 2
MinimumHoursWithinZone
Minimum time in zone to qualify for shift differential.
When zone type is daily shift differential or weekend differential, the minimum
amount of time, in HH:mm format, an employee must work to qualify for the shift
differential. Time worked within an expansion window is not included.
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

Chapter 2
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
Unscheduled ó Select this option to allow unscheduled employees to earn this
type of zone hour. If this option is not selected, only scheduled employees can
earn hours in this zone.
Introduced in v5.1
SelectedHolidays
Selected holidays
When the zone type is holiday, list of selected holiday zone rules.
Type: Zero or more WSAZoneRuleHoliday tags
Optional
Introduced in v5.1
SelectedLimits
Selected limits
The list of Selected Limits
Type: Zero or more WSAZoneRuleLimit tags
Optional
Introduced in v5.1
StartNumberOfDay
Day the zone begins
When zone type is daily shift differential or weekend differential, the number of
the day when the zone starts and the employee starts accumulating zone hours.
Type: Integer
Optional
Introduced in v5.1

Chapter 2
StartTime
Time the zone begins
When zone type is daily shift differential or weekend differential, the time of day,
in HH:mm format, when the zone begins. Employees are required to punch in at
or after the start time to qualify for the zone. Rounded punches are compared to
the start time. If the start time and end time are the same, the zone is 24 hours
long.
Type: Time
Optional
Introduced in v5.1
StartWorkAfterTime
Allowable amount of time after zone begins
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

Chapter 2
StartWorkBeforeTime
Allowable amount of time before zone begins
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?
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 Key
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAZoneCombinationRule
Name = String >
[<SelectedZoneRules>
<WSAZoneCombinationZoneRule>*
</SelectedZoneRules>]
[<CombinationRules>
<WSAZoneCombinationSpecificationRule>*
</CombinationRules>]
</WSAZoneCombinationRule>

Chapter 2
Action Descriptions
Returns all zone combination rules for update.
Return Value Type: Zero or more WSAZoneCombinationRule tags
Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all zone combination rules.
Introduced in v5.1
RetrieveForUpdate
Returns the specified zone combination rule for update.
Return Value Type: WSAZoneCombinationRule tag
Introduced in v5.1
Update
Updates the specified zone combination rule.
Introduced in v5.1
CombinationRules
Zone combination rules
List of one or more combination rules to be applied to this zone combination rule.

Chapter 2
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 Key
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

Chapter 2
WSAZoneCombinationSpecificationRule Tag
Zone Combination Specification Rule
Allows the management of zone combination specification rules. This is an
internal tag used within WSAZoneCombinationRule.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAZoneCombinationSpecificationRule
KeyName = String
ValueName = String
ItemName = String >
</WSAZoneCombinationSpecificationRule>
Action Descriptions
RetrieveForUpdate
Return Value Type: WSAZoneCombinationSpecificationRule tag
Required Properties: ItemName, KeyName, ValueName
Introduced in v5.1

Chapter 2
ItemName
Zone rule
The name of the zone rule.
Type: String
Optional Key
Introduced in v5.1
KeyName
Key name
The name of a zone rule.
Type: String
Optional Key
Introduced in v5.1
ValueName
Value name
The name of a zone rule.
Type: String
Optional Key
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAZoneCombinationZoneRule
Name = String >
</WSAZoneCombinationZoneRule>
Action Descriptions
RetrieveForUpdate
Return Value Type: WSAZoneCombinationZoneRule tag
Introduced in v5.1

Chapter 2
Name
Name of zone combination zone rule
Name of the zone combination zone rule. The name can be up to 32 characters
Type: String
Optional Key
Introduced in v5.1

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Update"
Parameters→
None
Properties→
<WSAZoneRule
[RequiresApproval = Boolean]
Name = String >
[<Zone>
<WSAZone>
</Zone>]
</WSAZoneRule>
Action Descriptions
Returns all zone rules for update.
Return Value Type: Zero or more WSAZoneRule tags

Chapter 2

Introduced in v5.1
RetrieveAllNames
Returns a list of the names of all zone rules.
Introduced in v5.1
RetrieveForUpdate
Returns the specified zone rule for update.
Return Value Type: WSAZoneRule tag
Introduced in v5.1
Update
Updates the specified zone rule.
Introduced in v5.1
Name
Name of zone rule
Name of the zone rule. The name can be up to 32 characters long, is case-
Type: String
Optional Key
Introduced in v5.1

Chapter 2
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

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAZoneRuleHoliday
Name = String
[StartDateTime = DateTime] >
</WSAZoneRuleHoliday>
Action Descriptions
RetrieveForUpdate
Returns the specified zone holiday rule for update,
Return Value Type: WSAZoneRuleHoliday tag
Introduced in v5.1

Chapter 2
Name
Name of holiday zone rule
Name of the holiday type zone rule. The name can be up to 32 characters long, is
Type: String
Optional Key
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; last changed in v6.0; deprecated in v6.0. Defaults to the
current date and time. Multiple start dates are associated with the holiday. For
example, Christmas holiday can have the following start dates: 12/25/2004, 12/25/
2005, 12/25/2006, 12/25/2007, 12/25/2010, ect.

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"RetrieveForUpdate"
Parameters→
None
Properties→
<WSAZoneRuleLimit
Name = String >
</WSAZoneRuleLimit>
Action Descriptions
RetrieveForUpdate
Returns the specified zone rule limit for update.
Return Value Type: WSAZoneRuleLimit tag
Introduced in v5.1

Chapter 2
Name
Name of zone rule limit
Name of the zone rule limit. The name can be up to 32 characters long, is case-
Type: String
Optional Key
Introduced in v5.1

Chapter 2
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 actions.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Retrieve" |
"RetrieveAll" |
"Update"

Chapter 2
Parameters→
None
Properties→
<WTDEmployeeAssignment
[HazardousWorker = Boolean]
Id = Long
Name = String
WtdRuleName = String >
[<OptOutStatuses>
<OptOutStatusList>*
</OptOutStatuses>]
<Person>
<PersonIdentity>
</Person>
</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
RetrieveAll
Returns all Employee Assignments.
Return Value Type: Zero or more WTDEmployeeAssignment tags
Introduced in v5.1
Returns all WTDEmployeeAssignments for SDM update.
Return Value Type: Zero or more WTDEmployeeAssignment tags

Chapter 2

RetrieveAllNames
Returns the names of all Employee Assignments. This is formatted as <Name
|<WTKEmployeeId

Introduced in v5.1
RetrieveForUpdate
Retrieves a single WTDEmplyoeeAssignement for SDM update.
Return Value Type: WTDEmployeeAssignment tag
Introduced in v5.1
Update
Adds or updates an WTDEmployeeAssignment.
Required Properties: Person WtdRuleName
HazardousWorker
Hazardous Worker
Flag indicating if the employee's job is hazardous.
Type: Boolean
Optional

Chapter 2
Sample values:
True
Introduced in v5.1
Id
Id
The primary key of a Working Time Directive rule.
Type: Long
Required Key
not null
Introduced in v5.1; last changed in v6.1; deprecated in v6.1. Deprecated after
fixing the issue TAL-13544
Name
Name
The name of the employee/rule assignment.
Type: String
Required
Introduced in v5.1
OptOutStatuses
OptOutStatusList
The list of effective dated OptOutStatuses
Type: Zero or more OptOutStatusList tags
Optional
Person
Person
The Person that this rule is being assigned to.
Required

Chapter 2
not null
Sample values:
<Person> <PersonIdentity PersonNumber="6"/> </Person>
Introduced in v6.1
WtdRuleName
WTD Rule Name
The Working Time Directive rule that is being assigned to an employee.
Type: String
Required
not null
Sample values:
TestRule
Introduced in v6.1

Chapter 2
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
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"DeleteOnly" |
"Retrieve" |
"RetrieveAll" |
"Update" |
"UpdateOnly"
Parameters→
None
Properties→
<WTDGlobal

Chapter 2
[BreakPayCode = Long]
[BreakPayCodeName = String]
[ExcludedPayCodeName = String]
Id = Long
IncludedPayCode = Long
Name = String
IncludedPayCodeName = String
[ExcludedPayCode = Long]
(UpdateDateTime = String) >
</WTDGlobal>
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.
Required Properties: IncludedPayCode
Optional Properties: Id BreakPayCode ExcludedPayCode
AddOnly
Adds a new instance. If an object exist for this Id then a duplicate exception is
thrown.
Id and IncludedPayCode cannot be null
Required Properties: Id IncludedPayCode
Optional Properties: ExcludedPayCode BreakPayCode

Chapter 2

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.
DeleteOnly
Deletes an instance. If the object is not found then
OBJECT_NOT_FOUND_KEY is thrown.
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
RetrieveAll
Returns all global configurations, which should equal exactly 1 configuration
object. Implemented for future enhancements.
Return Value Type: Zero or more WTDGlobal tags
Introduced in v5.1
Returns all for SDM update.

Chapter 2
Return Value Type: Zero or more WTDGlobal tags

Introduced in v5.1
RetrieveAllNames
Returns all names for the Setup Data Manager (SDM).
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
Update
Updates a global configuration. If it does not exist then it is created.
Id IncludedPayCode cannot be null
Required Properties: IncludedPayCode IncludedPayCodeName
Optional Properties: Id ExcludedPayCode BreakPayCode
UpdateOnly
updates only. If the object is not found then OBJECT_NOT_FOUND_KEY is
thrown.
Id and IncludedPayCode cannot be null.

Chapter 2
Required Properties: Id IncludedPayCode

Optional Properties: BreakPayCode ExcludedPayCode
Introduced in v5.1
BreakPayCode
Break Pay Code
One or more pay codes that you use to identify workers' breaks.
Type: Long
Optional
BreakPayCodeName
Break Pay Code Name
name of the break pay code
Type: String
Optional
Introduced in v5.1
ExcludedPayCode
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
ExcludedPayCodeName
Excluded Pay Code Name
name of the exclude paycode

Chapter 2
Type: String
Optional
Introduced in v5.1
Id
Id
Primary key of the global configuration.
Type: Long
Required Key
cannot be null
Introduced in v5.1
IncludedPayCode
Included Pay Code
The pay codes to include when applying the Working Time Directive rules. You
can choose specific pay codes, or you can choose All Regular pay codes.
Type: Long
Required
cannot be null
IncludedPayCodeName
Pay Code Name
Name of the included pay code
Type: String
Required Key
Introduced in v5.1
Name
Name
Name of the global configuration.
Type: String
Required
Introduced in v5.1

Chapter 2
UpdateDateTime
Updated Date and Time
Represents the Date and time when this WTD Global Configuration was last
updated.
Type: String
Output only

Chapter 2
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.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"Add" |
"AddOnly" |
"Delete" |
"DeleteOnly" |
"Retrieve" |
"RetrieveAll" |
"Update" |
"UpdateOnly"
Parameters→

Chapter 2
None
Properties→
<WTDRule
WorkedAveragePeriod = Integer
[EndNightPeriod = DateTime]
ExcludedHours = Integer
FirstDayOfWeek = Integer
MaxAdultWork = Integer
[MaxHazardousNightHours = Integer]
[MaxNightHours = Integer]
MaxYoungWork = Integer
[YoungWorkerMaxWeeklyHours = Integer]
MaxWeeklyHours = Integer
MinAdultDailyRest = Integer
MinAdultBreak = Integer
MinAdultWeeklyRest = Integer
[MinPercentNightHours = Double]
MinYoungDailyRest = Integer
MinYoungBreak = Integer
MinYoungWeeklyRest = Integer
NumberOfIterations = Integer
OffAveragePeriod = Long
ExceptionsOnly = Integer
Name = String
RuleId = Long
[StartNightPeriod = DateTime]
WorkWeekLength = Integer
[YoungWorkerAge = Integer]
[YoungWorkerMaxDailyHours = Integer] >
</WTDRule>
Action Descriptions
Add
Adds a new WTDRule. If the object already exists a new one is created.
Required Properties: Name WorkWeekLength FirstDayOfWeek
NumberOfIterations ExceptionsOnly MaxWeeklyHours ExcludedHours

Chapter 2
WorkedAveragePeriod MaxAdultWork MinAdultBreak MinAdultDailyRest

MinAdultWeeklyRest OffAveragePeriod MaxYoungWork MinYoungBreak
MinYoungDailyRest MinYoungWeeklyRest
Optional Properties: StartNightPeriod EndNightPeriod MinPercentNightHours
MaxNightHours MaxHazardousNightHours YoungWorkerAge
YoungWorkerMaxDailyHours YoungWorkerMaxWeeklyHours
Introduced in v5.1
AddOnly
Adds a new WTDRule. If the object exists already a duplicate exception is
thrown.
Required Properties: Name WorkWeekLength FirstDayOfWeek
NumberOfIterations ExceptionsOnly MaxWeeklyHours ExcludedHours
WorkedAveragePeriod MaxAdultWork MinAdultBreak MinAdultDailyRest
MinAdultWeeklyRest OffAveragePeriod MaxYoungWork MinYoungBreak
MinYoungDailyRest MinYoungWeeklyRest
Optional Properties: StartNightPeriod EndNightPeriod MinPercentNightHours
MaxNightHours MaxHazardousNightHours YoungWorkerAge
YoungWorkerMaxDailyHours YoungWorkerMaxWeeklyHours
Introduced in v5.1
Delete
Deletes the rule if exists. If it does not exist nothing happens.
RuleId cannot be null
Required Properties: RuleId
Introduced in v5.1

Chapter 2
DeleteOnly
If the rule exists it will be deleted if it does not then an object key not found
RuleId cannot be null
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
RetrieveAll
Retrieves all Working Time Directive rules.
Return Value Type: Zero or more WTDRule tags
Returns all rules for SDM update.
Introduced in v5.1
RetrieveAllNames
Returns the names of all Working Time Directive rules.

Chapter 2

RetrieveForUpdate
Returns a Working Time Directive rule for a name provided for SDM update. If
the rule does not exist and an Object key is not found, an exception is thrown.
Return Value Type: WTDRule tag
Update
Updates a rule with new properties. If the rule does not exist one is created.
Not Enough Room
Optional Properties: Not Enough Room
Introduced in v5.1
UpdateOnly
Updates a rule. If the rule does not exist then an object key not found exception is
thrown.
Not Enough Room
Optional Properties: Not Enough Room
Introduced in v5.1

Chapter 2
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.
Introduced in v5.1

Chapter 2
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
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
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
MaxHazardousNightHours
Maximum Hazardous Night Hours
The maximum number of hours an employee should work during the night
performing hazardous work.
Type: Integer
Optional
Introduced in v5.1

Chapter 2
MaxNightHours
Maximum Night Hours
The maximum number of hours an employee should work at night.
Type: Integer
Optional
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
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
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

Chapter 2
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
MinAdultWeeklyRest
Minimum Adult Weekly Rest
The minimum number of hours a week an adult worker should have to rest.
Type: Integer
Required
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
0
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

Chapter 2
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
MinYoungWeeklyRest
Minimum Young Worker Rest Break Length
The minimum number of hours weekly a young worker should have to rest.
Type: Integer
Required
Name
Rule Name
The name of the rule.
Type: String
Required
Cannot be null. Cannot exceed 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
Introduced in v5.1

Chapter 2
OffAveragePeriod
Off Time Average Period.
The number of weeks used in off time averaging calculations.
Type: Long
Required
Introduced in v5.1
RuleId
RuleId
Primary key of a rule.
Type: Long
Required Key
Cannot be null
Introduced in v5.1
StartNightPeriod
Start Night Period
The time that marks the beginning of the night period
Type: DateTime
Optional
Must be a valid 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
Introduced in v5.1

Chapter 2
WorkWeekLength
Work Week Length
The length of the work week, expressed as a number of days.
Type: Integer
Required
Must be greater than 1
YoungWorkerAge
Young Worker Age
The age for which an employee is considered a Young Worker for Working Time
Directive. Employees whose age is less than or equal to the age listed will be
considered as Young Workers.
Type: Integer
Optional
YoungWorkerMaxDailyHours
Young Worker Max Daily Hours
The maximum number of hours a young worker should work per day.
Type: Integer
Optional
Introduced in v5.1
YoungWorkerMaxWeeklyHours
Maximum Young Worker Weekly Hours
The maximum number of ours an employee should work per week.
Type: Integer
Optional
Introduced in v5.1

Chapter 2
WTKEmployee Tag
Employee Information
The WTKEmployee tag returns pay rules, accrual, wage, and other information
associated with a person.
When the WTKEmployee tag is used by the Personality tag to add employee
information, the PayRuleName must be specified.
Syntax
Request→
Parameters >
Properties
</Request>
Actions→
"GetPayPeriodDates" |
"Load"
Parameters→
GetPayPeriodDates→
TimeFrameName = String
Properties→
<WTKEmployee
(ManagerSignoffThruDateTime = Date)
(PayrollLockoutThruDateTime = Date)
[DeviceGroupName = String]
[PayRuleName = String]
[TimeZoneName = String]
[WageProfileName = String] >
<Identity>
</Identity>

Chapter 2
</WTKEmployee>
Action Descriptions
GetPayPeriodDates
Returns the applicable pay period dates for an employee for a given time frame.
Return Value Type: TimeFramePeriod tag
Action Parameters

TimeFrameName Introduced in v4; last changed in
Required v5.0; deprecated in v5.0
This name must be one of the pay
period time frame names.
Load
Returns WTKEmployee information for the specified person.
Return Value Type: WTKEmployee tag
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

Chapter 2
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
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
JobAssignmentDetails tag instead.
Identity
Identity
Required Key

Chapter 2
ManagerSignoffThruDateTime
Date of manager signoff
Date of the last manager signoff
Type: Date
Output Only
Person tag instead.
PayrollLockoutThruDateTime
Date of payroll lockout
Date of the last payroll lockout
Type: Date
Output Only
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
Required: For a new TimeKeeper user
Required: When a person is tracked
ScheduleGroupName
Schedule group name

Chapter 2
Type: String
Optional
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
Programmer's Guide.
WageProfileName
Wage profile
The name of the person's wage profile
Type: String
Optional

Kronos WFC 4500 Developers Toolkit Reference

Загружено:

Сведения о документе

Исходное описание:

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

Kronos WFC 4500 Developers Toolkit Reference

Загружено:

Авторское право:

Доступные форматы

Workforce Central ®

Developer’s Toolkit Reference

An alphabetical listing of the XML application programming

Kronos Workforce Central Suite

Document Part Number: 4704277-001

Published by Kronos Incorporated

For links to information about international subsidiaries of Kronos Incorporated, go to

Document Revision History

Document Revision Product Version Release Date

About This Guide

Chapter 2: Workforce Timekeeper XML API Tag Definitions

APIHolidayProfileDataSet Tag ..................................................................121

CancelDeductions Tag ............................................................................... 223

Developers Toolkit Reference Guide 5

DayLockAuditItem Tag .............................................................................319

EmploymentTermVersion Tag .................................................................. 432

Developers Toolkit Reference Guide 7

HomeAccount Tag .....................................................................................556

LightWeightQuery Tag ............................................................................. 680

Developers Toolkit Reference Guide 9

OrgSet Tag .................................................................................................776

PostalAddress Tag ..................................................................................... 905

Developers Toolkit Reference Guide 11

RequestSubtype Tag ................................................................................1055

ScheduleMarkPosted Tag ........................................................................ 1180

Developers Toolkit Reference Guide 13

SignatureItem Tag ....................................................................................1299

TotalSummary Tag .................................................................................. 1406

Developers Toolkit Reference Guide 15

WSAAccrualDetailColumnSet Tag .........................................................1521

WSACFGZoneComponent Tag .............................................................. 1645

Developers Toolkit Reference Guide 17

WSAExceptionType Tag .........................................................................1776

WSAPayCodeProfileItem Tag ................................................................ 1908

Developers Toolkit Reference Guide 19

WSAShiftLength Tag ..............................................................................2039

Developers Toolkit Reference Guide 21dex

Organization of this guide

Users of this guide

Abbreviations and terms

Developers Toolkit Reference Guide 25

Workforce Timekeeper documentation

Using the tag descriptions

Developers Toolkit Reference Guide 29

The syntax conventions are described in the following table.

Syntax Description Example

Syntax Description Example

Parts of a syntax statement

The five optional parts of a syntax statement are:

The action description includes the following information:

Developers Toolkit Reference Guide 31

• Groups of Mutually Exclusive Properties specifies if any of the properties in a

Developers Toolkit Reference Guide 33

Developers Toolkit Programmer’s Guide 37

Default value: &EMPTY

Introduced in v5.0; last changed in v5.1

Developers Toolkit Programmer’s Guide 39

Developers Toolkit Programmer’s Guide 41

Developers Toolkit Programmer’s Guide 43

Default value: The Empty Data Access Profile.

Developers Toolkit Programmer’s Guide 45

Parameter Name Description Additional information

Introduced in v4; last changed in v5.0