Professional Documents
Culture Documents
An alphabetical listing of the XML application programming interface (API) tag definitions that are used by the Workforce Central platform and Workforce Timekeeper.
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 2007. 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 HR, Workforce Leave, Workforce Manager, Workforce MobileTime, Workforce Operations Planner, Workforce Payroll, Workforce Record Manager, Workforce Recruiter, Workforce Scheduler with Optimization, Workforce Scheduler, Workforce Smart Scheduler, Workforce Tax Filing, Workforce Timekeeper, and Workforce View are trademarks of Kronos Incorporated or a related company. 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 A Product Version Workforce Central 6.0 Release Date June 2007
Contents
About This Guide Organization of this guide ........................................................................... 20 Abbreviations and terms .............................................................................. 21 Chapter 1: Introduction Using the tag descriptions ........................................................................... 24 Chapter 2: Workforce Timekeeper XML API Tag Definitions AccessAssignment Tag ............................................................................... 32 AccessProfile Tag ........................................................................................ 43 AccrualBalanceSummary Tag ..................................................................... 49 AccrualCode Tag ......................................................................................... 57 AccrualData Tag .......................................................................................... 60 AccrualMove Tag ........................................................................................ 63 AccrualPatternElement Tag ......................................................................... 67 AccrualProfile Tag ...................................................................................... 68 AdHocLaborAccount Tag ........................................................................... 71 APICallList Tag ........................................................................................... 73 APIOutsideDate Tag ................................................................................... 75 APIPSEEngine Tag ..................................................................................... 76 APIPunchRestrictionOverride Tag .............................................................. 78 APISCGEngine Tag .................................................................................... 84 APIStableDateSpans Tag ............................................................................ 86 APIVolumeDataService Tag ....................................................................... 88 AppendShifts Tag ........................................................................................ 90 ApplicationCalendar Tag ............................................................................. 93 ApplicationCalendarAPIFacade Tag ........................................................... 95 ApproveSignoff Tag .................................................................................... 96 Attribute Tag ............................................................................................. 100
Contents
AuditItem Tag ............................................................................................102 AuditTrail Tag ............................................................................................107 AuthenticationType Tag ............................................................................111 BadgeAssignment Tag ...............................................................................113 BaseWageRate Tag ....................................................................................117 Bid Tag .......................................................................................................120 BidGroup Tag ............................................................................................125 BidGroupItem Tag .....................................................................................132 BidNote Tag ...............................................................................................138 BidRequest Tag ..........................................................................................140 BulkAccruals Tag ......................................................................................150 BulkTotals Tag ...........................................................................................153 CalendarProfile Tag ...................................................................................156 CalendarProfileAPIFacade Tag .................................................................162 CallListEmployee Tag ...............................................................................164 CallListOpenShift Tag ...............................................................................165 CancelDeductions Tag ...............................................................................166 CertificationItem Tag .................................................................................169 CheckAdvice Tag .......................................................................................171 CheckAdviceDetailDeductions Tag ...........................................................177 CheckAdviceDetailDirectDeposit Tag ......................................................179 CheckAdviceDetailGrossPay Tag ..............................................................181 CheckAdviceDetailTaxes Tag ...................................................................184 Comment Tag .............................................................................................186 ConnectToSchedule Tag ............................................................................189 ConnectToScheduleItem Tag .....................................................................191 CoverageDetail Tag ...................................................................................195 CoverageSettings Tag ................................................................................196 CoverageSettingsValue Tag .......................................................................202 CoverShiftStatus Tag .................................................................................204 CurrentUser Tag .........................................................................................206 CustomData Tag ........................................................................................210 CustomDate Tag ........................................................................................212 CustomOperator Tag ..................................................................................214
Kronos Incorporated
Contents
DataAccessGroup Tag ............................................................................... 215 DataElementAPIFacade Tag ..................................................................... 222 DataSetAPIFacade Tag ............................................................................. 224 DataSource Tag ......................................................................................... 226 DateTotals Tag .......................................................................................... 228 DeductRule Tag ......................................................................................... 230 DelegateAuthorityTask Tag ...................................................................... 232 DelegateProfile Tag ................................................................................... 237 DeviceGroup Tag ...................................................................................... 243 EarnedAccrual Tag .................................................................................... 246 EffectiveWorkload Tag ............................................................................. 250 EligibleJobs Tag ........................................................................................ 254 EmailAddress Tag ..................................................................................... 257 EmployeeGroupAssign Tag ...................................................................... 259 EmployeeGroupItem Tag .......................................................................... 262 EmployeeGroupProfile Tag ....................................................................... 264 EmployeeMessage Tag .............................................................................. 267 EmployeePreferredZone Tag ..................................................................... 271 EmployeeSummary Tag ............................................................................ 274 EmploymentStatus Tag ............................................................................. 276 Error Tag ................................................................................................... 280 ExpectedHours Tag ................................................................................... 284 FailedXMLTransaction Tag ...................................................................... 286 FPAAllocation Tag .................................................................................... 294 FPARule Tag ............................................................................................. 297 FPARuleVersion Tag ................................................................................ 302 FPATrigger Tag ......................................................................................... 306 From Tag ................................................................................................... 311 FunctionAccessProfile Tag ....................................................................... 313 GDAPAssignment Tag .............................................................................. 316 GDAPAssignmentDefaultSwitch Tag ....................................................... 323 GDAPItem Tag .......................................................................................... 325 GenericEmployeeCalendar Tag ................................................................. 327 GenericEmployeeCalendarAPIFacade Tag ............................................... 333
Contents
GenericManagerCalendar Tag ...................................................................335 GenericManagerCalendarAPIFacade Tag .................................................342 GenieColumn Tag ......................................................................................344 GenieRow Tag ...........................................................................................346 GlsegmentDetail Tag .................................................................................348 GroupMembership Tag ..............................................................................351 Headcount Tag ...........................................................................................353 HeadcountPattern Tag ................................................................................355 HistoricalPayCodeEdit Tag ........................................................................357 HistoricalPayCodeMove Tag .....................................................................366 HistoryDetails Tag .....................................................................................375 Holiday Tag ................................................................................................376 HolidayEditHours Tag ...............................................................................378 HolidayEditWages Tag ..............................................................................381 HomeAccount Tag .....................................................................................384 HoursSummary Tag ...................................................................................386 HoursSummaryService Tag .......................................................................388 HPPDItem Tag ...........................................................................................390 HPPDService Tag ......................................................................................393 HPPDSummary Tag ...................................................................................396 HPPDSummaryService Tag .......................................................................399 HyperFindQuery Tag .................................................................................401 HyperFindResult Tag .................................................................................406 ImportBatchStatus Tag ..............................................................................409 JobAssignment Tag ....................................................................................415 JobAssignmentDetails Tag ........................................................................419 Kronos_WFC Tag ......................................................................................424 KTimeZone Tag .........................................................................................426 LaborAccount Tag .....................................................................................429 LaborAccountEntry Tag ............................................................................432 LaborAccountEntryData Tag .....................................................................435 LaborAccountSet Tag ................................................................................437 LaborAccountSetProfile Tag .....................................................................442 LaborLevelDefinition Tag .........................................................................445
Kronos Incorporated
Contents
LaborLevelEntry Tag ................................................................................ 449 LaunchHistory Tag .................................................................................... 455 LicenseType Tag ....................................................................................... 460 LightWeightPerson Tag ............................................................................. 464 LocationId Tag .......................................................................................... 466 LocationProfileSettings Tag ...................................................................... 467 LockedDataCorrection Tag ....................................................................... 473 LogonProfile Tag ....................................................................................... 475 ManagerRoleAvailabilityPatternProfile Tag ............................................. 478 ManagerRoleScheduleGroupProfile Tag .................................................. 481 ManagerRoleSchedulePatternProfile Tag ................................................. 484 ManagerRoleShiftCodeProfile Tag ........................................................... 487 MarkForTotalization Tag .......................................................................... 490 Menu Tag ................................................................................................... 493 MenuItem Tag ........................................................................................... 495 MinimunHoursNoModification Tag ......................................................... 498 NameList Tag ............................................................................................ 501 Names Tag ................................................................................................. 503 NavProfile Tag .......................................................................................... 504 NonCancellingPayCodeEdit Tag ............................................................... 510 Note Tag .................................................................................................... 518 OnCall Tag ................................................................................................ 520 OpenShift Tag ........................................................................................... 522 OpenShiftItem Tag .................................................................................... 523 OpenShiftVolunteer Tag ........................................................................... 524 OptOutStatus Tag ...................................................................................... 530 OptOutStatusList Tag ................................................................................ 532 OrgDirect_IndirectPct Tag ........................................................................ 534 OrgJob Tag ................................................................................................ 535 OrgLocation Tag ....................................................................................... 536 OrgLocationsImport Tag ........................................................................... 541 OrgMapIntegration Tag ............................................................................. 543 OrgSet Tag ................................................................................................. 545 OrgSetEntry Tag ........................................................................................ 550
Contents
OrgSetJob Tag ............................................................................................552 OrgWorkAllocationEntry Tag ...................................................................554 OvertimeApproval Tag ..............................................................................556 PasswordHistory Tag .................................................................................561 PatternElement Tag ....................................................................................562 PayCode Tag ..............................................................................................566 PayCodeEdit Tag .......................................................................................570 PayCodeMove Tag .....................................................................................580 PayCodeProfile Tag ...................................................................................589 PayFromSchedule Tag ...............................................................................592 PayFromScheduleStopEvent Tag ..............................................................595 PayRuleProfile Tag ....................................................................................598 PeriodTotals Tag ........................................................................................601 Permission Tag ...........................................................................................603 Person Tag ..................................................................................................605 PersonAccessAssignment Tag ...................................................................614 Personality Tag ..........................................................................................618 PersonalOvertimeAssignment Tag ............................................................623 PersonalOvertimeLimit Tag .......................................................................628 PersonalOvertimeRule Tag ........................................................................630 PersonAuthenticationType Tag ..................................................................632 PersonCertificationAssign Tag ..................................................................634 PersonCertificationItem Tag ......................................................................637 PersonIdentity Tag .....................................................................................640 PersonInformation Tag ..............................................................................645 PersonLicenseType Tag .............................................................................654 PersonShiftTemplateAssignment Tag ........................................................656 PersonSkillAssign Tag ...............................................................................658 PersonSkillItem Tag ...................................................................................661 PostalAddress Tag ......................................................................................663 PreferenceProfile Tag ................................................................................666 PrimaryLaborAccount Tag ........................................................................669 Procedure Tag ............................................................................................674 ProcedureAction Tag .................................................................................679
Kronos Incorporated
Contents
ProcedureContext Tag ............................................................................... 681 ProcedureParameter Tag ........................................................................... 683 ProcedureParameterDefinition Tag ........................................................... 685 ProcedureSet Tag ....................................................................................... 687 ProcedureSetItem Tag ............................................................................... 693 Process Tag ................................................................................................ 695 ProcessorToEmployee Tag ........................................................................ 703 ProcessProfile Tag ..................................................................................... 709 ProcessSchedule Tag ................................................................................. 712 ProcessTask Tag ........................................................................................ 716 ProcessTemplate Tag ................................................................................. 725 ProjectingOvertime Tag ............................................................................ 750 Punch Tag .................................................................................................. 752 PunchStatus Tag ........................................................................................ 764 RBSRule Tag ............................................................................................. 768 RBSRuleVersion Tag ................................................................................ 772 ReportProfile Tag ...................................................................................... 777 Request Tag ............................................................................................... 780 RequestToCover Tag ................................................................................. 784 RequestToCoverItem Tag ......................................................................... 790 ResetAccrual Tag ...................................................................................... 792 Response Tag ............................................................................................. 797 RoleProfileKBO Tag ................................................................................. 799 RuleSetEmployeeAssign Tag .................................................................... 804 SchedGenSettings Tag ............................................................................... 807 SchedGenSettingsValue Tag ..................................................................... 813 SchedRule Tag ........................................................................................... 815 SchedRuleContext Tag .............................................................................. 822 SchedRuleOperator Tag ............................................................................ 824 SchedRuleSet Tag ..................................................................................... 826 SchedRuleSortOrder Tag ........................................................................... 832 SchedRuleTopic Tag ................................................................................. 834 SchedRuleValueType Tag ......................................................................... 836 Schedule Tag ............................................................................................. 838
Contents
ScheduleAccrualAmountEdit Tag .............................................................852 ScheduleAccrualPattern Tag ......................................................................856 ScheduleCostPaycode Tag .........................................................................862 ScheduleCostResult Tag ............................................................................864 ScheduleCostSummary Tag .......................................................................866 ScheduleCoverage Tag ..............................................................................868 ScheduleGroup Tag ....................................................................................871 ScheduleGroupProfile Tag .........................................................................876 ScheduleHours Tag ....................................................................................879 ScheduleHoursAccrualViolation Tag ........................................................885 ScheduleHoursDailyStatus Tag .................................................................886 ScheduleHoursException Tag ....................................................................888 ScheduleHoursStatus Tag ..........................................................................889 ScheduleMarkPosted Tag ..........................................................................892 ScheduleOff Tag ........................................................................................894 SchedulePattern Tag ..................................................................................899 SchedulePayCodeEdit Tag .........................................................................906 SchedulePeriod Tag ...................................................................................914 ScheduleRuleOverride Tag ........................................................................918 ScheduleRuleOverrideDetails Tag .............................................................923 ScheduleShift Tag ......................................................................................926 ScheduleShiftSwap Tag .............................................................................932 ScheduleUnavailable Tag ..........................................................................934 ScheduleZone Tag ......................................................................................940 ServerTime Tag ..........................................................................................943 SettingsParamDefinition Tag .....................................................................945 SettingsParamValue Tag ............................................................................948 SettingsType Tag .......................................................................................950 ShiftBuilder Tag .........................................................................................953 ShiftCode Tag ............................................................................................956 ShiftCountSpan Tag ...................................................................................960 ShiftHistory Tag .........................................................................................962 ShiftSegment Tag .......................................................................................966 ShiftStartTimeBand Tag ............................................................................971
10
Kronos Incorporated
Contents
ShiftTemplateAssignment Tag .................................................................. 976 ShiftTemplateItem Tag .............................................................................. 978 ShiftValidation Tag ................................................................................... 980 Signature Tag ............................................................................................. 983 SignatureItem Tag ..................................................................................... 987 SimplePair Tag .......................................................................................... 988 SimpleValue Tag ....................................................................................... 990 StaffingRequirement Tag .......................................................................... 991 StandardShift Tag ...................................................................................... 992 SuiteProduct Tag ....................................................................................... 994 Supervisor Tag ........................................................................................... 997 SwapShiftEmployees Tag ......................................................................... 998 SwapShiftJobs Tag .................................................................................. 1001 SwitchRoleEngine Tag ............................................................................ 1004 SystemSettings Tag ................................................................................. 1007 TelephoneNumber Tag ............................................................................ 1010 TimeEntry Tag ......................................................................................... 1012 TimeFramePeriod Tag ............................................................................. 1015 TimekeepingException Tag ..................................................................... 1018 Timesheet Tag ......................................................................................... 1022 To Tag ..................................................................................................... 1028 TopicParameterDefinition Tag ................................................................ 1030 TopicParameterValue Tag ....................................................................... 1032 Total Tag ................................................................................................. 1033 TotaledScheduledPayCodeEdit Tag ........................................................ 1037 TotaledScheduledPayCodeEditUneditable Tag ...................................... 1040 TotaledScheduledWorkedDuration Tag .................................................. 1044 TotaledSpan Tag ...................................................................................... 1047 TotalSummary Tag .................................................................................. 1049 Transaction Tag ....................................................................................... 1050 TransferEmployee Tag ............................................................................ 1051 TransferJobSeniorityDate Tag ................................................................. 1054 TreeNodeType Tag .................................................................................. 1057 TypeOverride Tag ................................................................................... 1062
11
Contents
User Tag ...................................................................................................1064 UserAccount Tag .....................................................................................1067 UserAccountLockout Tag ........................................................................1072 UserAccountStatus Tag ............................................................................1074 VacationBid Tag ......................................................................................1078 VolumeDataItem Tag ...............................................................................1085 WageProfile Tag ......................................................................................1086 WeekDay Tag ..........................................................................................1089 WFCGenie Tag ........................................................................................1091 WfcJob Tag ..............................................................................................1095 WorkedDuration Tag ...............................................................................1100 WorkerType Tag ......................................................................................1108 WorkerTypeElement Tag .........................................................................1112 WorkflowAccessAssignment Tag ............................................................1114 WorkflowTemplateCategory Tag ............................................................1118 WorkRule Tag ..........................................................................................1121 WorkRuleProfile Tag ...............................................................................1124 WorkWeek Tag ........................................................................................1127 WorkWeekAssignments Tag ...................................................................1133 WorkWeekDay Tag .................................................................................1136 WSAAccrualCode Tag ............................................................................1140 WSAAccrualDetail Tag ...........................................................................1142 WSAAccrualDetailColumnSet Tag .........................................................1147 WSAAccrualPolicy Tag ...........................................................................1151 WSAAccrualPolicyGrant Tag ..................................................................1161 WSAAccrualPolicyLimit Tag ..................................................................1163 WSAAccrualPolicyPayCode Tag ............................................................1165 WSAAccrualPolicyTakingLimit Tag ......................................................1166 WSAAccrualProfile Tag ..........................................................................1168 WSAAccrualProfilePolicy Tag ................................................................1172 WSAAccrualQualifier Tag ......................................................................1174 WSAAPICombination Tag ......................................................................1177 WSAAPICombinationComponent Tag ....................................................1180 WSAAPICombinationRule Tag ...............................................................1183
12
Kronos Incorporated
Contents
WSAAPICombinationTowardOT Tag .................................................... 1187 WSAAssignmentRule Tag ...................................................................... 1190 WSAAutoBreakPlacement Tag ............................................................... 1196 WSAAvailabilityPatternDAP Tag ........................................................... 1199 WSAAvailabilityPatternProfileItem Tag ................................................ 1202 WSABonusDeductRule Tag .................................................................... 1204 WSABreakRule Tag ................................................................................ 1216 WSABreakTime Tag ............................................................................... 1223 WSACalendarProfile Tag ........................................................................ 1226 WSACallInRule Tag ............................................................................... 1228 WSACfgAccrualCode Tag ...................................................................... 1235 WSACfgContactType Tag ...................................................................... 1239 WSACfgContactTypeList Tag ................................................................ 1242 WSACfgCustomData Tag ....................................................................... 1245 WSACfgCustomDataList Tag ................................................................. 1247 WSACFGDistributionAssignment Tag ................................................... 1250 WSACFGExtProcessorComponent Tag ................................................. 1253 WSACFGOvertimeComponent Tag ....................................................... 1255 WSACFGPaycodeAssignment Tag ......................................................... 1257 WSACFGPaycodeDistribution Tag ........................................................ 1259 WSACFGZoneComponent Tag .............................................................. 1262 WSAColumnDefinition Tag .................................................................... 1264 WSAColumnDefinitionDataType Tag .................................................... 1267 WSAColumnDetail Tag .......................................................................... 1270 WSACombinationRule Tag ..................................................................... 1276 WSACombinedPayCodeRule Tag .......................................................... 1278 WSAComment Tag ................................................................................. 1282 WSACommentType Tag ......................................................................... 1286 WSAContributingPayCodeRule Tag ....................................................... 1288 WSAContributingShiftRule Tag ............................................................. 1291 WSACoreHoursRule Tag ........................................................................ 1296 WSACreditCalculator Tag ...................................................................... 1302 WSACriteriaSet Tag ................................................................................ 1310 WSACustomDate Tag ............................................................................. 1313
13
Contents
WSACustomDateType Tag .....................................................................1316 WSACustomUrl Tag ................................................................................1318 WSACustomUrlProfile Tag .....................................................................1321 WSADateFinder Tag ................................................................................1325 WSADatePattern Tag ...............................................................................1328 WSADayMonthSpan Tag ........................................................................1332 WSADaysOfWeek Tag ............................................................................1335 WSADetail Tag ........................................................................................1339 WSADetailColumnSet Tag ......................................................................1343 WSADisplayOrder Tag ............................................................................1347 WSADisplayProfile Tag ..........................................................................1350 WSADisplayProfileWorkforceGenieProfile Tag ....................................1363 WSADispOrdOptionalRule Tag ..............................................................1365 WSADPLaborLevelDefinition Tag .........................................................1367 WSADPPayCode Tag ..............................................................................1369 WSADPTimePeriod Tag ..........................................................................1371 WSAEffectivePayRule Tag .....................................................................1373 WSAEffectiveWorkRule Tag ..................................................................1381 WSAEligibilityDeterminer Tag ...............................................................1386 WSAExceptionRule Tag ..........................................................................1391 WSAExceptionType Tag .........................................................................1396 WSAFixedRule Tag .................................................................................1398 WSAFunctionAccessProfile Tag .............................................................1401 WSAGenie Tag ........................................................................................1405 WSAGrant Tag ........................................................................................1408 WSAHoliday Tag .....................................................................................1415 WSAHolidayCreditRule Tag ...................................................................1420 WSAHolidayDate Tag .............................................................................1425 WSAHyperfindQuery Tag .......................................................................1427 WSAInitialGrant Tag ...............................................................................1430 WSAInterval Tag .....................................................................................1432 WSAIntervalRoundRule Tag ...................................................................1434 WSALaborLevel Tag ...............................................................................1438 WSALaborLevelEntry Tag ......................................................................1442
14
Kronos Incorporated
Contents
WSALeaveCaseDetail Tag ...................................................................... 1446 WSALeaveCaseDetailColumnSet Tag .................................................... 1450 WSALimit Tag ........................................................................................ 1454 WSALogonProfile Tag ............................................................................ 1459 WSAMainTab Tag .................................................................................. 1466 WSAMajorityRule Tag ........................................................................... 1468 WSANavbarCategory Tag ....................................................................... 1472 WSAOptionalRule Tag ........................................................................... 1474 WSAOrganizationType Tag .................................................................... 1476 WSAOverridePayCode Tag .................................................................... 1480 WSAOvertimeCombination Tag ............................................................. 1482 WSAOvertimeRule Tag .......................................................................... 1485 WSAPatternTemplateDAP Tag ............................................................... 1492 WSAPatternTemplateProfileItem Tag .................................................... 1495 WSAPayCode Tag ................................................................................... 1497 WSAPayCodeDAP Tag ........................................................................... 1504 WSAPayCodeDistribution Tag ............................................................... 1507 WSAPayCodeProfileItem Tag ................................................................ 1511 WSAPayDistributionAssociation Tag ..................................................... 1513 WSAPayPeriod Tag ................................................................................. 1516 WSAPayRule Tag ................................................................................... 1519 WSAPayRuleHoliday Tag ....................................................................... 1522 WSAPermission Tag ............................................................................... 1524 WSAProbationPeriod Tag ....................................................................... 1527 WSAProbationQualifier Tag ................................................................... 1531 WSAProcessingOrderRule Tag ............................................................... 1534 WSAPunchRoundRule Tag ..................................................................... 1537 WSAQuickFind Tag ................................................................................ 1551 WSAReportDAP Tag .............................................................................. 1555 WSAReportProfileItem Tag .................................................................... 1558 WSARollup Tag ...................................................................................... 1560 WSARollupColumnSet Tag .................................................................... 1564 WSAScheduleAssistant Tag .................................................................... 1568 WSAScheduleAssistantColumnSet Tag .................................................. 1572
15
Contents
WSAScheduleAssistantTab Tag ..............................................................1576 WSAScheduleDeviationRule Tag ............................................................1578 WSAScheduledHoursType Tag ...............................................................1582 WSAScheduleEditor Tag .........................................................................1585 WSAScheduleEditorColumnSet Tag .......................................................1590 WSAScheduleGroupDAP Tag .................................................................1594 WSAScheduleGroupDetail Tag ...............................................................1598 WSAScheduleGroupDetailColumnSet Tag .............................................1603 WSAScheduleGroupProfileItem Tag ......................................................1608 WSAScheduleGroupRollup Tag ..............................................................1610 WSAScheduleGroupRollupColumnSet Tag ............................................1615 WSASchedulePeriod Tag ........................................................................1620 WSASchedulePlanner Tag .......................................................................1622 WSASchedulePlannerColumnSet Tag .....................................................1627 WSASequencedItem Tag .........................................................................1631 WSASequencerRule Tag .........................................................................1633 WSAShiftGuarantee Tag .........................................................................1636 WSAShiftLength Tag ..............................................................................1641 WSAShiftLengthExclusion Tag ..............................................................1643 WSAShiftTemplateDAP Tag ...................................................................1644 WSAShiftTemplateProfileItem Tag ........................................................1647 WSASignOffRestriction Tag ...................................................................1648 WSASubsequentGrant Tag ......................................................................1652 WSATimePeriod Tag ...............................................................................1654 WSATkTerminalRule Tag .......................................................................1656 WSATreeType Tag ..................................................................................1666 WSAULLE Tag .......................................................................................1669 WSAWageAdjustment Tag ......................................................................1672 WSAWageProfile Tag .............................................................................1675 WSAWageProfileLaborLevelLinkage Tag ..............................................1679 WSAWageProfilePayCode Tag ...............................................................1681 WSAWfgColumnSet Tag ........................................................................1683 WSAWorkforceGenieProfile Tag ............................................................1686 WSAWorkHistoryQualifierRule Tag ......................................................1690
16
Kronos Incorporated
Contents
WSAWorkloadPlannerProfile Tag .......................................................... 1694 WSAWorkRule Tag ................................................................................ 1696 WSAWorkRuleDAP Tag ........................................................................ 1699 WSAWorkRuleGeneral Tag .................................................................... 1702 WSAWorkRulePCDistr Tag ................................................................... 1705 WSAWorkRuleProfileItem Tag .............................................................. 1708 WSAZone Tag ......................................................................................... 1710 WSAZoneCombinationRule Tag ............................................................ 1723 WSAZoneCombinationSpecificationRule Tag ....................................... 1726 WSAZoneCombinationZoneRule Tag .................................................... 1728 WSAZoneRule Tag ................................................................................. 1730 WSAZoneRuleHoliday Tag .................................................................... 1733 WSAZoneRuleLimit Tag ........................................................................ 1735 WTDEmployeeAssignment Tag ............................................................. 1737 WTDGlobal Tag ...................................................................................... 1742 WTDRule Tag ......................................................................................... 1749 WTKEmployee Tag ................................................................................. 1762 Index
17
Contents
18
Kronos Incorporated
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 20 Abbreviations and terms on page 21
20
Kronos Incorporated
21
22
Kronos Incorporated
Chapter 1
Introduction
This reference guide is for programmers, system integrators, and Web developers who need to understand the Kronos Workforce Central 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.
Chapter 1
Introduction
24
Kronos Incorporated
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 points 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
25
Chapter 1
Introduction
[ 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 Variable, which must be replaced by a value in the XML code. Optional elements Example CommentText = String where String tells you to add comments here. [CommentText = String] where [] mean that the CommentText property is not required in the tag. Output only properties (AccrualCodeId = Long) identifies AccrualCodeId as a property that is only used for output.
monospace italic
Brackets [ ]
Parenthesis ()
26
Kronos Incorporated
Syntax
Example
Array of zero or more occurrences <Comment>* An array of comments can be specified. Array of one or more occurrences
Parts of a syntax statement The five optional parts of a syntax statement are: RequestAn 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. ActionsIf the syntax statement contains actions, an Actions part identifies all the actions supported by the XML tag. ParametersIf any actions use parameters, a Parameters part identifies them. PropertiesThe properties part of the syntax statement identifies all properties that are available for a tag, including required and optional properties. Contained API tagsIf 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.
27
Chapter 1
Introduction
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
28
Kronos Incorporated
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,
29
Chapter 1
Introduction
30
Kronos Incorporated
Chapter 2
This chapter lists, in alphabetic order, the XML API Tag descriptions
Chapter 2
Syntax
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>
32
Kronos Incorporated
AccessAssignment Tag
Property Descriptions
AccessProfileName
Type: String Optional Maximum length: 50 characters Default value: Specified in the Access Profile Editor in Timekeeping Setup Introduced in v4; last changed in v5.1 AvailabilityPatternName
33
Chapter 2
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
Type: String Optional Maximum length: 50 characters Dependency: Only specify for a person who has a manager's license Default value: The Empty Data Access Profile
34
Kronos Incorporated
AccessAssignment Tag
Type: String Optional Maximum length: 30 characters Must have a labor account set type of Employee Groups (Manager) or All Sets (Both Manager and Transfer) Introduced in v4; last changed in v5.1 ManagerPayCodeName
Type: String Optional Maximum length: 50 characters Dependency: Only specify for a person who has a manager's license. Introduced in v4; last changed in v5.2
35
Chapter 2
ManagerTransferSetName
Type: String Optional Maximum length: 50 characters Dependency: Only specify for a person who has a manager's license.
36
Kronos Incorporated
AccessAssignment Tag
Type: String Optional Maximum length: 30 characters Dependency: Only specify for a person who has a manager's license. Introduced in v4; last changed in v5.1 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 Maximum length: 30 characters Default value: &DEFAULT_PREFERENCE Enumerated value: &DEFAULT_PREFERENCE, &SUPER_USER_PREFERENCE, Monday Manager, Tuesday Manager, Friday Manager, Timekeeper, Scheduler, Professional Employees
37
Chapter 2
Type: String Optional Maximum length: 30 characters Dependency: Only specify for an employee who has a user account user. Introduced in v4; last changed in v5.1 ProfessionalTransferSetName
Type: String Optional Maximum length: 30 characters Dependency: The specified person must have a Type of Employee Groups (Manager) or All Sets (Both Manager and Transfer)
38
Kronos Incorporated
AccessAssignment Tag
Dependency: Only specify for an employee who has a user account. Introduced in v4; last changed in v5.1 ProfessionalWorkRuleName
Type: String Optional Maximum length: 30 characters Dependency: Only specify for an employee who has a user account user. Introduced in v4; last changed in v5.1 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. The following predefined data values are available: &ALL_REPORTS &EMPTY
39
Chapter 2
Dependency: Only specify for a person who has a manager license. Introduced in v4; last changed in v5.1 SchedulePatternName
Type: String Optional Maximum length: 50 characters Dependency: Only specify for a person who has a manager license. You can find values in Setup Application. Default value: The Empty Data Access Profile Introduced in v5.0; last changed in v5.1 ShiftCodeName
Type: String
40
Kronos Incorporated
AccessAssignment Tag
Optional Maximum length: 50 characters Dependency: Only specify for a person who has a manager license Default value: The Empty Data Access Profile. Introduced in v5.0; last changed in v5.1 TimeEntryTypeName
Type: String Optional Maximum length: 1 character Enumerated value: 1, 2, 3, 4 Introduced in v4; last changed in v5.1 TransferEmployeeFlag
Type: Boolean
41
Chapter 2
42
Kronos Incorporated
AccessProfile Tag
Function Access Control Point: API.AccessProfile Introduced in v4; last changed in v5.2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "IsPermitted" | "Load" | "LoadAllAccessControlPointNames" | "LoadAllActionNames" | "LoadAllowedPermissions" | "LoadAllSuiteProductNames" Parameters IsPermitted AccessControlPointName = String ActionName = String [PersonNumber = String]
43
Chapter 2
SuiteProductName = String 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
44
Kronos Incorporated
AccessProfile Tag
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. Required This name must be identified in the names in the Permission Type table. Otherwise, the system returns False. The person number used to determine 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. The suite product being checked. Required This name must be listed in the Suite Product table. Otherwise, the system returns False. Introduced in v4
PersonNumber
Introduced in v4
SuiteProductName
Introduced in v4
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 Access Control Point Name: View
45
Chapter 2
Introduced in v4; last changed in v5.0 LoadAllAccessControlPointNames Returns all access control points. Return Value Type: Zero or more SimpleValue tags Access Control Point Name: View Introduced in v4 LoadAllActionNames Returns all action names. Return Value Type: Zero or more SimpleValue tags Access Control Point Name: View 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 Access Control Point Name: View Introduced in v4 LoadAllSuiteProductNames Returns all suite product names. Return Value Type: Zero or more SimpleValue tags Required Properties: None Access Control Point Name: View Introduced in v4
Property Descriptions
AccessProfileName
46
Kronos Incorporated
AccessProfile Tag
The name of the person's function access profile. The function access profile 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 GuideTimekeeping for an explanation of the roles. The following predefined data values are available: &OTHER_MANAGER &PAYROLL_MANAGER &IS &TIMESTAMP_EMPLOYEE &WORKFORCE_EMPLOYEE &DEFAULT
Type: String Optional, Key Maximum length: 50 characters Default value: As specified in the Access Profile editor of the Setup Introduced in v4; last changed in v5.0 Description
Description
Describes the access profile. Type: String Output Only Maximum length: 250 characters Introduced in v4
47
Chapter 2
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
48
Kronos Incorporated
AccrualBalanceSummary Tag
Syntax
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>
Property Descriptions
49
Chapter 2
AccrualCodeId
Accrual code Id
A unique identifier for the accrual code. Type: Long Output Only Introduced in v4 AccrualCodeName
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
50
Kronos Incorporated
AccrualBalanceSummary Tag
Type: Currency Output Only Contains a value if the accrual is a monetary type Introduced in v4 EncumberedBalanceInTime
51
Chapter 2
ProbationaryBalanceInTime
52
Kronos Incorporated
AccrualBalanceSummary Tag
ProjectedDate
Projected date
The date used in determining the projected balance. Type: Date Output Only Introduced in v4; last changed in v5.1 ProjectedGrantAmountInCurrency
53
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: Currency Output only Introduced in v5.0; last changed in v5.1 ProjectedProbationaryBalanceInTime
54
Kronos Incorporated
AccrualBalanceSummary Tag
Output Only Contains a value if the accrual is a time type Introduced in v4; last changed in v5.1 ProjectedVestedBalanceInCurrency
55
Chapter 2
VestedBalanceInTime
56
Kronos Incorporated
AccrualCode Tag
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View
57
Chapter 2
Property Descriptions
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
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
58
Kronos Incorporated
AccrualCode Tag
HoursPerDay
59
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" Parameters None Properties <AccrualData BalanceDate = Date > (<AccrualBalances> <AccrualBalanceSummary>* </AccrualBalances>) <Employee> <CurrentUser> | <PersonIdentity> </Employee> </AccrualData>
Action Descriptions
Load Returns one summary for each accrual code for the specified employee and date.
60
Kronos Incorporated
AccrualData Tag
Only returns one employee Return Value Type: AccrualData tag Required Properties: Employee, BalanceDate Access Control Point Name: View Introduced in v4
Property Descriptions
AccrualBalances
The balance amounts in all accrual codes for the specified employee
One or more sets of accrual summaries that represent all accrual codes found for the employee at the specified date. Type: Zero or more AccrualBalanceSummary tags Output Only Introduced in v4; last changed in v5.1 BalanceDate
The date specified for the accrual balances being retrieved. Balance date is required.
The date specified for the accrual balances. The vested balance is as of this date. Type: Date Required, Key Introduced in v4; last changed in v5.1 Employee
61
Chapter 2
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
62
Kronos Incorporated
AccrualMove Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Update" Parameters None Properties <AccrualMove AmountInCurrency = Currency AmountInTime = TimeDuration GivingEmployeeAccrualCodeName = String TakingEmployeeAccrualCodeName = String Date = Date > <GivingEmployee> <CurrentUser> | <PersonIdentity> </GivingEmployee> <TakingEmployee> <CurrentUser> | <PersonIdentity> </TakingEmployee>
63
Chapter 2
</AccrualMove>
Action Descriptions
Update Moves an accrual amount from one employee accrual code to another. The amount of the accrual is also required. Specify either an AmountInCurrency or an AmountInTime. Return Value Type: None Required Properties: GivingEmployeeAccrualCodeName, TakingEmployeeAccrualCodeName, Date, GivingEmployee, TakingEmployee Access Control Point Name: Edit Introduced in v4
Property Descriptions
AmountInCurrency
64
Kronos Incorporated
AccrualMove Tag
Date
Effective date
The date when the accrual move takes effect. Type: Date Required Introduced in v4; last changed in v5.1 GivingEmployee
65
Chapter 2
One employee, as specified in a PersonIdentity or CurrentUser tag, to whom the accrual will be assigned. This employee can be the same as the GivingEmployee, or it can be a different employee. Type: Either CurrentUser or PersonIdentity tag Required Key Must uniquely identify an existing and active employee Introduced in v4; last changed in v5.1 TakingEmployeeAccrualCodeName
66
Kronos Incorporated
AccrualPatternElement Tag
Syntax
Properties <AccrualPatternElement DayNumber = Integer > </AccrualPatternElement>
Property Descriptions
DayNumber
67
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "LoadAllAccrualProfiles" | "LoadById" Parameters None Properties <AccrualProfile [AccrualProfileName = String] [AccrualProfileId = Integer] > </AccrualProfile>
Action Descriptions
Load Returns an accrual profile.
68
Kronos Incorporated
AccrualProfile Tag
Name should be valid Return Value Type: AccrualProfile tag Required Properties: AccrualProfileName Access Control Point Name: View Introduced in v4 LoadAllAccrualProfiles Returns all accrual profiles in the system. Return Value Type: Zero or more AccrualProfile tags Access Control Point Name: View Introduced in v4 LoadById Returns an accrual profile, based on the specified AccrualProfileId. Return Value Type: AccrualProfile tag Required Properties: AccrualProfileID Access Control Point Name: View Introduced in v4
Property Descriptions
AccrualProfileId
Accrual profile Id
A unique identifier for the accrual profile. Type: Integer Optional Introduced in v4 AccrualProfileName
Accrual profile
69
Chapter 2
The accrual profile to be used for a person or group. Accrual profiles are based on your company's accrual rules and policies that apply to similar groups of employees. The rules determine how employees accrue their time or money, or both. When an employee uses accrued time or money, specified amounts are deducted from the balance. When an employee receives or earns time or money, specified amounts are credited to the balances. Type: String Optional Maximum length: 50 characters You can find values in the Setup Application. Sample values: VAC and Sick Only Introduced in v4
70
Kronos Incorporated
AdHocLaborAccount Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "CreateAdHoc" Parameters None Properties <AdHocLaborAccount FieldDefinitionName = String LaborAccountName = String > </AdHocLaborAccount>
Action Descriptions
CreateAdHoc Adds an ad hoc labor account Return Value Type: None Required Properties: LaborAccountName
71
Chapter 2
Property Descriptions
FieldDefinitionName
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 employees primary labor account, you can enter @H for those labor levels instead of entering the labor entry names. Type: String Required Maximum length: 356 characters The user and labor level account must allow ad hoc access Introduced in v4
72
Kronos Incorporated
APICallList Tag
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View Introduced in v6.0
73
Chapter 2
Action Parameters Parameter Name EndDate ProcedureSetName StartDate Description The end date of the scheduling period. Required The name of the script to execute. Required The start date of the scheduling period. Required Additional information Introduced in v6.0 Introduced in v6.0 Introduced in v6.0
74
Kronos Incorporated
APIOutsideDate Tag
Syntax
Properties <APIOutsideDate OutsideDate = Date > </APIOutsideDate>
Property Descriptions
OutsideDate
75
Chapter 2
Syntax
Request <Request Action = Actions 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. Return Value Type: None Access Control Point Name: Edit Introduced in v6.0
76
Kronos Incorporated
APIPSEEngine Tag
Action Parameters Parameter Name EndDate ProcedureSetName StartDate Description The end date of the scheduling period. Required The name of the script to execute. Required The start date of the scheduling period. Required Additional information Introduced in v6.0 Introduced in v6.0 Introduced in v6.0
77
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveForUpdate" | "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
78
Kronos Incorporated
APIPunchRestrictionOverride Tag
RetrieveForUpdate Retrieves the punch restriction override information (if any is present in the DB) for a given employee. Person Number should represent the employee id of an existing employee. Return Value Type: APIPunchRestrictionOverride tag Required Properties: PersonNumber Access Control Point Name: View 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. Return Value Type: None Required Properties: PersonNumber Access Control Point Name: Edit Introduced in v6.0
Property Descriptions
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
79
Chapter 2
80
Kronos Incorporated
APIPunchRestrictionOverride Tag
Specify whether to override the amount of time after a scheduled shift starts before an employees punch is rejected. Type: Boolean Optional Must be either "true" or "false". Sample values: true Default value: false Introduced in v6.0 LateOutRestrictionFlag
81
Chapter 2
Must be either "true" or "false". Sample values: true Default value: false 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
82
Kronos Incorporated
APIPunchRestrictionOverride Tag
83
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "run" Parameters run EndDate = Date OptionSetName = String StartDate = Date
Action Descriptions
run Runs the Schedule Generator engine. Return Value Type: None Access Control Point Name: Edit Introduced in v6.0
84
Kronos Incorporated
APISCGEngine Tag
Action Parameters Parameter Name EndDate OptionSetName Description The end date. Required Represents the schedule generator location settings name. Required The start date. Required Additional information Introduced in v6.0 Introduced in v6.0
StartDate
Introduced in v6.0
85
Chapter 2
Syntax
Request <Request Action = Actions 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
86
Kronos Incorporated
APIStableDateSpans Tag
Property Descriptions
Locations
87
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Retrieve" Parameters None Properties <APIVolumeDataService QueryDateSpan = String > [<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 Required Properties: QueryDateSpan Optional Properties: Locations
88
Kronos Incorporated
APIVolumeDataService Tag
Property Descriptions
Locations
Locations
Specify a list of locations, such as hospital, floor, or department. Type: Zero or more LocationItem tags Optional Sample values: <Locations> <LocationItem Location="Organization/Hospitals/Hosp A/Floor 1/ER"/> <LocationItem Location="Organization/Hospitals/Hosp A/Floor 1/Pediatrics"/> </Locations> Introduced in v6.0 QueryDateSpan
89
Chapter 2
Syntax
Properties <AppendShifts AppendDurationAmount = TimeDuration AppendToBeginOrEnd = Boolean EffectiveDate = Date [LaborAccountName = String] [OrgJobPath = String] [WorkRuleName = String] > </AppendShifts>
Property Descriptions
AppendDurationAmount
90
Kronos Incorporated
AppendShifts Tag
Effective date
EffectiveDate property Type: Date Required Introduced in v5.1 LaborAccountName
Labor account
LaborAccountName property. Type: String Optional Introduced in v5.1 OrgJobPath
Work rule
WorkRuleName property. Type: String Optional
91
Chapter 2
92
Kronos Incorporated
ApplicationCalendar Tag
Syntax
Properties <ApplicationCalendar ViewType = Integer MonthWidth = Integer ApplicationName = String DataSetName = String > </ApplicationCalendar>
Property Descriptions
ApplicationName
93
Chapter 2
94
Kronos Incorporated
ApplicationCalendarAPIFacade Tag
Syntax None
95
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Approve" | "PeriodIsApproved" | "PeriodIsSignedOff" | "RemoveApproval" | "RemoveOthersApproval" | "RemoveSignOff" | "SignOff" Parameters None Properties <ApproveSignoff [DataSource = String] [UserName = String] > <Employee> <CurrentUser> | <PersonIdentity> </Employee> [<Period> <TimeFramePeriod> </Period>] </ApproveSignoff>
96
Kronos Incorporated
ApproveSignoff Tag
Action Descriptions
Approve Approves the specified employee's timesheet. Return Value Type: None Required Properties: Employee, Period Access Control Point Name: Edit Introduced in v4 PeriodIsApproved Returns a True or False, depending on whether the specified employee's timesheet is approved. Return Value Type: SimpleValue tag Required Properties: Employee, Period Access Control Point Name: View Introduced in v4 PeriodIsSignedOff Returns True or False, depending on whether the specified employee's timesheet is signed off. Return Value Type: SimpleValue tag Required Properties: Employee, Period Access Control Point Name: View Introduced in v4 RemoveApproval Removes the approval from the employee. Return Value Type: None Required Properties: Employee Access Control Point Name: Edit Introduced in v4
97
Chapter 2
RemoveOthersApproval Removes an approval that was added by someone other than the current user. Return Value Type: None Required Properties: Employee, Period, UserName, DataSource Access Control Point Name: Edit Introduced in v4 RemoveSignOff Removes the latest signoff for the employee. Return Value Type: None Required Properties: Employee Access Control Point Name: Edit Introduced in v4 SignOff Adds a sign off to the specified employee's timesheet. Return Value Type: None Required Properties: Employee Access Control Point Name: Edit Introduced in v4
Property Descriptions
DataSource
Data source
The data source that identifies the user who performed a timecard approval. This value is only relevant for the RemoveOthersApproval action. Type: String Optional Maximum length: 10 characters
98
Kronos Incorporated
ApproveSignoff Tag
Introduced in v4 Employee
Employee
One employee whose time is to be approved or signed off, 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 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 Maximum length: 70 characters Default value: The logged on user Introduced in v4
99
Chapter 2
Syntax
Properties <Attribute Name = String Value = String > </Attribute>
Property Descriptions
Name
Attribute name
Name of the attribute. Each attribute must contain both a name and a value. Type: String Required Key Maximum length: 255 characters Sample values: HRAdministrator Introduced in v5.1 Value
Attribute value
100
Kronos Incorporated
Attribute Tag
The value for the attribute. Each attribute must contain both a name and a value. Type: String Required Introduced in v5.1
101
Chapter 2
Syntax
Properties <AuditItem (AfterImage = String) (AssociatedId = Long) (AssociatedName = String) (AuditAction = String) (AuditBeginDtm = DateTime) (AuditEndDtm = DateTime) (AuditType = String) (BeforeImage = String) (EnteredOnDtm = DateTime) (PersonNumber = String) > (<AuditItemChildren> <AuditItem>* </AuditItemChildren>) (<DataSource> <DataSource> </DataSource>) </AuditItem>
Property Descriptions
AfterImage
After image
The value of the audited information after the change. Type: String
102
Kronos Incorporated
AuditItem Tag
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 AuditBeginDtm
103
Chapter 2
The date and time that the audited action began. Type: DateTime Output only Introduced in v6.0 AuditEndDtm
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
104
Kronos Incorporated
AuditItem Tag
Sample values: Person Access Assignment Introduced in v6.0 BeforeImage or Schedule Validation Rules
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
Person number
105
Chapter 2
The employee identification number of the person whose information was changed. Type: String Output only Introduced in v6.0
106
Kronos Incorporated
AuditTrail Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAuditTrail" Parameters None Properties <AuditTrail DateSpan = DateSpan DateTimeSpan = DateTimeSpan [AuditType = String] [PersonNumber = String] [UserName = 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.
107
Chapter 2
Return Value Type: AuditTrail tag Required Properties: DateSpan, DateTimeSpan Optional Properties: AuditType, UserName, PersonNumber Access Control Point Name: View Introduced in v6.0
Property Descriptions
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
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
108
Kronos Incorporated
AuditTrail Tag
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 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
109
Chapter 2
110
Kronos Incorporated
AuthenticationType Tag
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View Introduced in v5.1
111
Chapter 2
Property Descriptions
AuthTypeName
Authentication type
Name of the authentication type. Type: String Output only Introduced in v5.1
112
Kronos Incorporated
BadgeAssignment Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "LoadBadgeAssignments" Parameters None Properties <BadgeAssignment BadgeNumber = String EffectiveDate = DateTime [ExpirationDate = DateTime] > <Identity> <CurrentUser> | <PersonIdentity> </Identity> [<Period> <TimeFramePeriod> </Period>] </BadgeAssignment>
Action Descriptions
113
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 Access Control Point Name: View Introduced in v5.0; last changed in v5.1
Property Descriptions
BadgeNumber
Badge number
The badge number that you want to assign to the employee. The system can be configured to allow multiple badges for employees using the global.BadgeAssignment.allowsOverlap property. For information, see the System Settings information in online help. If an employee is assigned multiple badge numbers, each badge number and associated information is added in a separate request. If an employee is assigned multiple badge numbers and you want to remove one of the badge numbers, first remove all existing badge numbers and then reassign the badge number that you want to keep. Type: String Required Maximum length: 25 characters Must be unique for the specified date span. Validation is done after a person is associated with a badge, using the PersonInformation tag. Introduced in v4; last changed in v5.1
114
Kronos Incorporated
BadgeAssignment Tag
EffectiveDate
Identity
The person to whom the badge number is assigned, as specified in a PersonIdentity or CurrentUser tag. Type: Either CurrentUser or PersonIdentity tag Optional Key Must uniquely identify a person.
115
Chapter 2
Time period
The time span that is associated with the badge assignments. Type: TimeFramePeriod tag Optional The specified identity is used when the time frame requires an association with a person. Used for the LoadBadgeAssignments action. Default value: From the current date until January 1, 3000 Introduced in v5.0
116
Kronos Incorporated
BaseWageRate Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "LoadBaseWageRateHistory" Parameters None Properties <BaseWageRate EffectiveDate = Date (ExpirationDate = Date) HourlyRate = Currency (Period = DateSpan) > <Identity> <CurrentUser> | <PersonIdentity> </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
117
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 Required Properties: Identity Access Control Point Name: View Introduced in v5.2; last changed in v5.2
Property Descriptions
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
118
Kronos Incorporated
BaseWageRate Tag
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. Type: Either CurrentUser or PersonIdentity tag 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
119
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "ApplyBidNotes" | "DeleteBidNotes" Parameters None Properties <Bid BidId = Long BidGroupItemId = Long Priority = Integer (Status = String) > [<BidNotes> <BidNote>* </BidNotes>] </Bid>
120
Kronos Incorporated
Bid Tag
Action Descriptions
ApplyBidNotes Applies the specified bid notes to the bid specified by the bid id. Existing bid notes are deleted and the specified ones are inserted. For the ApplyBidNotes Action, the BidId property and the BidNotes property MUST be defined. Return Value Type: None Required Properties: BidId, BidNotes Access Control Point Name: Edit Introduced in v5.0; last changed in v5.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. Return Value Type: None Required Properties: BidId Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0a
Property Descriptions
BidGroupItemId
121
Chapter 2
Sample values: <VacationBid BidGroupItemId="3" Priority="5" StartDate="04/01/2004 00:00:00" EndDate="05/01/2004 11:48:56" HoursPerDay="288000" CreateOpenShift="false"> </VacationBid> Introduced in v5.0; last changed in v5.0a 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. Introduced in v5.0; last changed in v5.0a 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>
122
Kronos Incorporated
Bid Tag
<BidNote Sequence="1" Text="For vacation bid with Id=501"> </BidNote> </BidNotes> </VacationBid> Introduced in v5.0; last changed in v5.0a Priority
Bid priority
Bid priority. Also known as rank. Type: Integer Required If the Priority property is defined for an action, the Priority property cannot be null. The Priority cannot be less than 1. Sample values: <VacationBid BidGroupItemId="3" Priority="1" StartDate="04/01/2004 00:00:00" EndDate="05/01/2004 11:48:56" HoursPerDay="288000" CreateOpenShift="false"> </VacationBid> Introduced in v5.0; last changed in v5.0a 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
123
Chapter 2
Default value: Submitted, 0 Enumerated value: Submitted - 0, Approved - 1, Rejected - 2 Introduced in v5.0; last changed in v5.0a
124
Kronos Incorporated
BidGroup Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddOnly" | "Delete" | "Load" | "LoadByBidRequest" | "Update" | "UpdateOnly" Parameters None Properties <BidGroup [Description = String] BidGroupId = Long Name = String BidRequestId = Long CloseDate = DateTime [NotificationText = String] OpenDate = DateTime ShiftOverride = Boolean >
125
Chapter 2
</BidGroup>
Action Descriptions
AddOnly Adds a new bid group. For the AddOnly Action, the BidRequestId property, the Name property, the OpenDate property, the CloseDate property, and the ShiftOverride property MUST be specified and valid values. The BidGroupId MUST NOT be specified for the AddOnly Action. Return Value Type: BidGroup tag Required Properties: BidRequestId, Name, OpenDate, CloseDate, ShiftOverride Optional Properties: NotificationText Access Control Point Name: Edit Introduced in v5.0a; last changed in v5.0a Delete Deletes a bid group. For the Delete Action, the BidGroupId MUST be specified and set to a valid BidGroupId value. Return Value Type: None Required Properties: BidGroupId Access Control Point Name: Edit Introduced in v5.0a; last changed in v5.0a Load Loads bid group given the specific BidGroupID. For the Load Action, the BidGroupId MUST be specified and set to a valid BidGroupId value. Return Value Type: BidGroup tag Required Properties: BidGroupId Access Control Point Name: View
126
Kronos Incorporated
BidGroup Tag
Introduced in v5.0a; last changed in v5.0a 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 Access Control Point Name: View Introduced in v5.0a; last changed in v5.0a 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. Return Value Type: None Required Properties: BidGroupId, BidRequestId, OpenDate, CloseDate Optional Properties: ShiftOverride, NotificationText Access Control Point Name: Edit Introduced in v5.0a; last changed in v5.0a 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. Return Value Type: None Required Properties: BidGroupId Optional Properties: Name, Description, OpenDate, CloseDate, ShiftOverride, NotificationText
127
Chapter 2
Access Control Point Name: Edit Introduced in v5.0a; last changed in v5.0a
Property Descriptions
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. Introduced in v5.0a; last changed in v5.0a 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. Introduced in v5.0a; last changed in v5.0a CloseDate
Close Date
Date on which bidding closes. Type: DateTime
128
Kronos Incorporated
BidGroup Tag
Required If defined for an Action, the CloseDate property cannot be null. The CloseDate property must be defined for AddOnly and Update Actions. Sample values: "04/20/2004 11:48:56" Introduced in v5.0a; last changed in v5.0a Description
Notification Text
Text of the notification sent when the parent bid request is sent to the bidding participants.
129
Chapter 2
Type: String Optional If defined for an Action, the NotificationText property cannot be null. The NotificationText property MUST be less than or equal to 4000 characters in length. Introduced in v5.0a; last changed in v5.0a OpenDate
Open Date
Date on which bidding opens. Type: DateTime Required If defined for an Action, OpenDate property cannot be null. The OpenDate property MUST be specified for the AddOnly and Update Actions. Sample values: "04/20/2004 00:00:00" Introduced in v5.0a; last changed in v5.0a 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"
130
Kronos Incorporated
BidGroup Tag
131
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddBids" | "AddOnly" | "Delete" | "Load" | "LoadByBidGroupAndPerson" | "RemoveBids" Parameters None Properties <BidGroupItem BidGroupId = Long BidGroupItemId = Long (BidSubmissionStatus = String)
132
Kronos Incorporated
BidGroupItem Tag
[BidReceived = DateTime] [LastSubmitted = DateTime] PersonId = Long > [<BidList> <VacationBid>* </BidList>] </BidGroupItem>
Action Descriptions
AddBids Adds bids to an existing bid group item given the BidGroupItemId. For the AddBids Action, the BidGroupItemId property and the BidList property MUST be specified. Return Value Type: BidGroupItem tag Required Properties: BidGroupItemId Optional Properties: BidGroupId, PersonId, LastSubmitted, BidReceived Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0a AddOnly Adds a new bid group item. For AddOnly Action, the BidGroupItemId and the BidSubmissionStatus should not be specified. The BidGroupId and PersonId should be valid id values and specified for the AddOnly Action. Return Value Type: BidGroupItem tag Required Properties: BidGroupId, PersonId Optional Properties: LastSubmitted, BidReceived Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0a Delete Deletes a bid group item given its BidGroupItemId.
133
Chapter 2
For the Delete Action, the BidGroupItemId MUST be specified. Return Value Type: None Required Properties: BidGroupItemId Optional Properties: BidGroupId, PersonId, LastSubmitted, BidReceived Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0a Load Loads the specific bid group item given its BidGroupItemId. For the Load Action, the BidGroupItemId must be specified. Return Value Type: BidGroupItem tag Required Properties: BidGroupItemId Optional Properties: BidGroupId, PersonId, LastSubmitted, BidReceived Access Control Point Name: View Introduced in v5.0; last changed in v5.0a LoadByBidGroupAndPerson Retrieves the specific bid group item given the BidGroupId and PersonId. For the LoadByBidGroupAndPerson Action, the BidGroupId and PersonId property must be specified. Return Value Type: BidGroupItem tag Required Properties: BidGroupId, PersonId Optional Properties: BidGroupItemId, LastSubmitted, BidReceived Access Control Point Name: View Introduced in v5.0; last changed in v5.0a 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. Return Value Type: BidGroupItem tag
134
Kronos Incorporated
BidGroupItem Tag
Required Properties: BidGroupItemId Optional Properties: BidGroupId, PersonId, LastSubmitted, BidReceived Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0a
Property Descriptions
BidGroupId
Bid Group Id
The id value for a specific bidding group. The BidGroupId is the id of the bid group this bid group item belongs to. Type: Long Required 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. Introduced in v5.0; last changed in v5.0 BidGroupItemId
135
Chapter 2
BidList
Bid List
List of Bids to add to the bid group item. 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. Introduced in v5.0; last changed in v5.0 BidReceived
136
Kronos Incorporated
BidGroupItem Tag
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 Introduced in v5.0; last changed in v5.0a LastSubmitted
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. Introduced in v5.0; last changed in v5.0a
137
Chapter 2
Syntax
Properties <BidNote Text = String Sequence = Integer > </BidNote>
Property Descriptions
Sequence
Sequence Number
Sequence number for a bid note in the set of bid notes for a given bid. Type: Integer Required If defined for a BidNote, the Sequence property cannot be null. The Sequence property MUST be defined for a BidNote within BidNotes list when running the Bid or VacationBid ApplyBidNotes Action. The Sequence value cannot be less than 1. Sample values: <BidNotes> <BidNote Sequence="1" Text="This text is for vacation bid with Id=501"> </BidNote> </BidNotes>
138
Kronos Incorporated
BidNote Tag
139
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddOnly" | "Delete" | "Load" | "LoadByManager" | "PostToSchedule" | "SendToParticipants" | "Update" | "UpdateOnly" Parameters None Properties <BidRequest [PeriodStartDate = DateTime] [Description = String] BidRequestId = Long [Name = String] Type = String GroupScheduleProfileName = String
140
Kronos Incorporated
BidRequest Tag
[MaxBids = Integer] [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 Access Control Point Name: Edit Introduced in v5.0a; last changed in v5.0a Delete Deletes a bid request given the BidRequestId. For the Delete Action, the BidRequestId property MUST be specified. Return Value Type: None Required Properties: BidRequestId Access Control Point Name: Edit Introduced in v5.0a; last changed in v5.0a
141
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 Required Properties: BidRequestId Access Control Point Name: View Introduced in v5.0a; last changed in v5.0a 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 Access Control Point Name: View Introduced in v5.0a; last changed in v5.0a 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. Return Value Type: None Required Properties: BidRequestId Access Control Point Name: Edit Introduced in v5.0a; last changed in v5.0a 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.
142
Kronos Incorporated
BidRequest Tag
Return Value Type: None Required Properties: BidRequestId Access Control Point Name: Edit Introduced in v5.0a; last changed in v5.0a Update Updates or inserts a bid request depending respectively on whether a bid request having the specified BidRequestId, already exists or not. When the update implies addition of a new bid request, the BidRequestId, if any is specified, is ignored. For the Update Action, you must specify the following properties: Manager, PeriodStartDate, PeriodEndDate, Name, MaxBids, Type, based on Type specify either VacationPayCodeName, ShiftCodeProfileName, SchedulePatternProfileName, GroupScheduleProfileName. Return Value Type: None Required Properties: BidRequestId, Manager, PeriodStartDate, PeriodEndDate, Name, MaxBids, Type, Either VacationPayCodeName, ShiftCodeProfileName, SchedulePatternProfileName, or GroupScheduleProfileName Optional Properties: Description, NotificationDate Access Control Point Name: Edit Introduced in v5.0a; last changed in v5.0a UpdateOnly Updates the bid request given the BidRequestId. For the UpdateOnly Action, the BidRequestId property MUST be specified. If you specify the Type property, based on Type specified you MUST specify either VacationPayCodeName, ShiftCodeProfileName, SchedulePatternProfileName, or GroupScheduleProfileName. Return Value Type: None Required Properties: BidRequestId Optional Properties: Manager, PeriodStartDate, PeriodEndDate, Name, Description, MaxBids, NotificationDate, Type and Either VacationPayCodeName, ShiftCodeProfileName, SchedulePatternProfileName, GroupScheduleProfileName
143
Chapter 2
Access Control Point Name: Edit Introduced in v5.0a; last changed in v5.0a
Property Descriptions
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. Introduced in v5.0a; last changed in v5.0a Description
144
Kronos Incorporated
BidRequest Tag
Required Key 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. Introduced in v5.0a; last changed in v5.0a Manager
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. Introduced in v5.0a; last changed in v5.0a
145
Chapter 2
Name
Notification Date
Date on which notification about this bid request was last sent to bidding participants. Type: DateTime Optional If defined for an Action, the Notification cannot be null. Sample values: "04/20/2004 11:48:56" Introduced in v5.0a; last changed in v5.0a PeriodEndDate
146
Kronos Incorporated
BidRequest Tag
Sample values: "04/20/2004 11:48:56" Introduced in v5.0a; last changed in v5.0a PeriodStartDate
147
Chapter 2
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 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. Introduced in v5.0a; last changed in v5.0a 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 Introduced in v5.0a; last changed in v5.0a 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.
148
Kronos Incorporated
BidRequest Tag
149
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "LoadAccruals" Parameters None Properties <BulkAccruals AccrualCodeNames = String > (<EmployeeSummary> <EmployeeSummary> </EmployeeSummary>) <Employees> <PersonIdentity> </Employees> <Period> <TimeFramePeriod> </Period> </BulkAccruals>
Action Descriptions
150
Kronos Incorporated
BulkAccruals Tag
LoadAccruals Returns detailed data about the specified set of accruals. This action uses the EmployeeSummary tag, which in turn uses the AccrualBalanceSummary tag to list details about the specified accruals. Return Value Type: Zero or more EmployeeSummary tags Required Properties: Employees, AccrualCodeNames, Period Access Control Point Name: View Introduced in v4
Property Descriptions
AccrualCodeNames
Employees
One or more people, as specified in a PersonIdentity tag, for whom accruals are requested. Type: PersonIdentity tag
151
Chapter 2
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
Type: TimeFramePeriod tag Required Enumerated value: 1, 13 Introduced in v4; last changed in v5.0
152
Kronos Incorporated
BulkTotals Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "LoadPayCodeTotals" Parameters None Properties <BulkTotals PayCodeNames = String > (<EmployeeSummary> <EmployeeSummary> </EmployeeSummary>) <Employees> <PersonIdentity> </Employees> <Period> <TimeFramePeriod> </Period> </BulkTotals>
Action Descriptions
153
Chapter 2
LoadPayCodeTotals Returns totals for a given list of employees in their respective current pay periods. Return Value Type: Zero or more EmployeeSummary tags Required Properties: Employees, PayCodeNames, Period Access Control Point Name: View Introduced in v4
Property Descriptions
Employees
Employees
One or more people, as specified in a PersonIdentity tag, for whom totals are requested. Type: PersonIdentity tag Required Introduced in v4 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; last changed in v5.2 PayCodeNames
Pay codes
A comma-separated list of pay code names Type: String Required
154
Kronos Incorporated
BulkTotals Tag
Introduced in v4 Period
Time period
Two timeframes are supported: 1 or Current_Pay_Period 13 or Today
Type: TimeFramePeriod tag Required Default value: 1, 13 Introduced in v4; last changed in v5.0
155
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Add" | "AddOnly" | "Delete" | "RetrieveAll" | "RetrieveAllByName" | "RetrieveAllByNameAndActive" | "RetrieveById" | "RetrieveByName" | "Update" Parameters None Properties <CalendarProfile Name = String [Description = String] [GenericEmployeeCalendarNames = String list] [GenericManagerCalendarNames = String list] [Active = Boolean] > [<ApplicationCalendars>
156
Kronos Incorporated
CalendarProfile Tag
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. Return Value Type: None Required Properties: Name, Description, Active Optional Properties: GenericEmployeeCalendarNames, GenericManagerCalendarNames, ApplicationCalendars Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1 AddOnly Adds a calendar profile. If a calendar profile exists with the same name, the operation will fail. Return Value Type: None Required Properties: Name, Description, Active Optional Properties: GenericEmployeeCalendarNames, GenericManagerCalendarNames, ApplicationCalendars Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1 Delete Deletes an existing calendar profile. The operation will fail if the calendar profile doesn't exist. Return Value Type: None Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1
157
Chapter 2
RetrieveAll Returns all calendar profiles. Return Value Type: Zero or more CalendarProfile tags Access Control Point Name: View Introduced in v5.1; last changed in v5.1 RetrieveAllByName Searches for calendar profiles by name and returns a list of calendar profiles. Return Value Type: Zero or more CalendarProfile tags Required Properties: Name Access Control Point Name: View Introduced in v5.1; last changed in v5.1 RetrieveAllByNameAndActive Searches for calendar profiles by name and active, and returns a list of calendar profiles. Return Value Type: Zero or more CalendarProfile tags Required Properties: Name, Active Access Control Point Name: View Introduced in v5.1; last changed in v5.1 RetrieveById Returns the specified calendar profile. The operation will fail if the calendar profile doesn't exist. Return Value Type: CalendarProfile tag Access Control Point Name: View Introduced in v5.1; last changed in v5.1 RetrieveByName Returns the specified calendar profile. The operation will fail if the calendar profile doesn't exist. Return Value Type: CalendarProfile tag Required Properties: Name
158
Kronos Incorporated
CalendarProfile Tag
Access Control Point Name: View Introduced in v5.1; last changed in v5.1 Update Updates an existing calendar profile. If the calendar profile doesn't exist, it will be added. Return Value Type: None Required Properties: Name Optional Properties: NewName, Description, Active, GenericEmployeeCalendarNames, GenericManagerCalendarNames, ApplicationCalendars Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1
Property Descriptions
Active
Application calendars
The list of the application calendars in a calendar profile.
159
Chapter 2
Type: Zero or more ApplicationCalendar tags Optional Introduced in v5.1; last changed in v5.1 Description
Description
The description of a calendar profile. Type: String Optional Introduced in v5.1; last changed in v5.1 GenericEmployeeCalendarNames
160
Kronos Incorporated
CalendarProfile Tag
161
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <CalendarProfileAPIFacade Name = String > </CalendarProfileAPIFacade>
Action Descriptions
RetrieveAllNames Retrieves all names of calendar profiles. Return Value Type: Zero or more NameList tags Access Control Point Name: View
162
Kronos Incorporated
CalendarProfileAPIFacade Tag
Introduced in v5.2 RetrieveForUpdate Retrieves the calendar profile corresponding to the specified name. Return Value Type: CalendarProfileAPIFacade tag Required Properties: Name Access Control Point Name: View Introduced in v5.2 Update Updates the calendar profile Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
Name
Name
The calendar profile name. Type: String Required Introduced in v5.2
163
Chapter 2
Syntax None
164
Kronos Incorporated
CallListOpenShift Tag
Syntax None
165
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Update" Parameters None Properties <CancelDeductions Date = Date [ManagerName = String] Time = Time > <Employee> <CurrentUser> | <PersonIdentity> </Employee> </CancelDeductions>
166
Kronos Incorporated
CancelDeductions Tag
Action Descriptions
Update Flags the indicated shift so that automatic deductions are not applied to the totals for that shift. Return Value Type: None Required Properties: Employee, Date, Time Access Control Point Name: Edit Introduced in v4
Property Descriptions
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 PersonIdentity or CurrentUser tag. Type: Either CurrentUser or PersonIdentity tag Required Must uniquely identify an existing and active employee Introduced in v4 ManagerName
Manager name
The name used to replace the user name in audit.
167
Chapter 2
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
168
Kronos Incorporated
CertificationItem Tag
Syntax
Properties <CertificationItem [Abbreviation = String] Name = String [IsActive = Boolean] > </CertificationItem>
Property Descriptions
Abbreviation
169
Chapter 2
170
Kronos Incorporated
CheckAdvice Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddOnly" 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> <CurrentUser> | <PersonIdentity> </Employee>
171
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 Return Value Type: None Required Properties: Employee, CheckNumber, CheckDate, NetPay, StartDate, EndDate, PaymentType Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0
Property Descriptions
CheckDate
Date of check
Payment date Type: Date Required Introduced in v5.0; last changed in v5.0 CheckNumber
Check number
172
Kronos Incorporated
CheckAdvice Tag
The check number for this transaction Type: String Required Key Maximum length: 50 characters Introduced in v5.0; last changed in v5.0 Deductions
List of deductions
One or more deductions that were applied to the payment. Type: Zero or more CheckAdviceDetailDeductions tags Optional If there are any values in DeductionsList, then Deductions must be specified. Introduced in v5.0; last changed in v5.0 DirectDepositList
173
Chapter 2
Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag. Type: Either CurrentUser or PersonIdentity tag Required Must uniquely identify an existing and active employee Introduced in v5.0; last changed in v5.0 EndDate
Gross pay
The amount of the check before adjustments are made Type: String Optional Maximum length: 50 characters Introduced in v5.0; last changed in v5.0 GrossPayList
174
Kronos Incorporated
CheckAdvice Tag
Net pay
The gross pay with adjustments, such as deductions and taxes, applied Type: String Required Maximum length: 50 characters Introduced in v5.0; last changed in v5.0 PaymentType
Method of payment
The method of payment Type: String Required Maximum length: 50 characters Sample values: Direct Deposit, Check Introduced in v5.0; last changed in v5.0 StartDate
Taxes
175
Chapter 2
Total amount of taxes for items identified as detail taxes that is deducted from the gross payment Type: String Optional Maximum length: 50 characters Introduced in v5.0; last changed in v5.0 TaxesList
List of taxes
Details about the taxes applied to the check. Dependency: May not be specified if the Taxes property is not specified. Type: Zero or more CheckAdviceDetailTaxes tags Optional Introduced in v5.0; last changed in v5.0 TotalHours
Total hours
The total number of hours for which the employee is being paid Type: String Optional Maximum length: 50 characters Introduced in v5.0; last changed in v5.0
176
Kronos Incorporated
CheckAdviceDetailDeductions Tag
Syntax
Properties <CheckAdviceDetailDeductions Amount = String Description = String EmployeePaid = String AmountYTD = String EmployeePaidYTD = String > </CheckAdviceDetailDeductions>
Property Descriptions
Amount
Amount of deduction
Amount of the specified deduction Type: String Required Introduced in v5.0; last changed in v5.0 AmountYTD
177
Chapter 2
Description
An explanation of the deduction Type: String Required Introduced in v5.0; last changed in v5.0 EmployeePaid
178
Kronos Incorporated
CheckAdviceDetailDirectDeposit Tag
Syntax
Properties <CheckAdviceDetailDirectDeposit AccountNumber = String Amount = String Description = String RoutingNumber = String > </CheckAdviceDetailDirectDeposit>
Property Descriptions
AccountNumber
Account number
The account number to which the direct deposit is posted. Type: String Required Introduced in v5.0; last changed in v5.1 Amount
Amount of deposit
Amount of the direct deposit Type: String Required
179
Chapter 2
Description
An explanation of the item listed for the direct deposit Type: String Required Introduced in v5.0; last changed in v5.0 RoutingNumber
Routing number
The routing number of the bank to which the direct deposit is posted. Type: String Required Introduced in v5.0; last changed in v5.1
180
Kronos Incorporated
CheckAdviceDetailGrossPay Tag
Syntax
Properties <CheckAdviceDetailGrossPay Amount = String Date = Date Description = String Hours = String Rate = String AmountYTD = String > </CheckAdviceDetailGrossPay>
Property Descriptions
Amount
181
Chapter 2
Date of check
Date of the check Type: Date Required Introduced in v5.0; last changed in v5.0 Description
Description
The explanation that the specified amount is the gross pay Type: String Required Introduced in v5.0; last changed in v5.0 Hours
Hours paid
Number of hours for which payment is made Type: String Required Must match an existing field definition name Introduced in v5.0; last changed in v5.0 Rate
Pay rate
Rate at which payment was made
182
Kronos Incorporated
CheckAdviceDetailGrossPay Tag
183
Chapter 2
Syntax
Properties <CheckAdviceDetailTaxes Amount = String Description = String TaxableWages = String TaxesYTD = String > </CheckAdviceDetailTaxes>
Property Descriptions
Amount
Amount of tax
Amount of the specified tax Type: String Required Introduced in v5.0; last changed in v5.0 Description
Description
An explanation of the specified tax Type: String
184
Kronos Incorporated
CheckAdviceDetailTaxes Tag
Taxable wages
Wages for which taxes are paid Type: String Required Introduced in v5.0; last changed in v5.0 TaxesYTD
185
Chapter 2
Syntax
Request <Request Action = Actions 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
186
Kronos Incorporated
Comment Tag
Access Control Point Name: View Introduced in v4 LoadCommentCategories Returns a list of comment beans with CommentCategory properties set to all categories available in the system. Return Value Type: Zero or more Comment tags Access Control Point Name: View Introduced in v5.1
Property Descriptions
CommentCategory
Comment category
Specify the comment category name string. Only the comments for the given category will be loaded. If unspecified, all active comments will be loaded. If the name is invalid, an empty result will be return (no error). Type: String Optional None 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
187
Chapter 2
Comment Notes
The list of notes for the comment Type: Zero or more Note tags Optional Introduced in v6.0
188
Kronos Incorporated
ConnectToSchedule Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Update" Parameters None Properties <ConnectToSchedule <ConnectToScheduleItems> <ConnectToScheduleItem>* </ConnectToScheduleItems> </ConnectToSchedule>
Action Descriptions
Update Adds the specified items into schedule period Return Value Type: None Required Properties: ConnectToScheduleItems Access Control Point Name: Edit
189
Chapter 2
Introduced in v5.1
Property Descriptions
ConnectToScheduleItems
190
Kronos Incorporated
ConnectToScheduleItem Tag
Syntax
Properties <ConnectToScheduleItem [CommentText = String] [StartDate = Date] EmployeeId = String [LaborAccountName = String] [OrgJobPath = String] RequestCode = Integer [Duration = TimeDuration] [StartTime = Time] [WorkRuleName = String] > [<Notes> <Note>* </Notes>] </ConnectToScheduleItem>
Property Descriptions
CommentText
Comment
A comment about the shift Type: String Optional Maximum length: 255 characters
191
Chapter 2
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 Type: Zero or more Note tags
192
Kronos Incorporated
ConnectToScheduleItem Tag
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 Introduced in v5.1; last changed in v5.1 StartDate
193
Chapter 2
194
Kronos Incorporated
CoverageDetail Tag
Syntax None
195
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Add" | "AddOnly" | "Delete" | "DeleteOnly" | "Retrieve" | "RetrieveAll" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" | "UpdateOnly" Parameters None Properties <CoverageSettings SettingsName = String [Description = String] > [<SettingsParamValues> <SettingsParamValue>*
196
Kronos Incorporated
CoverageSettings Tag
Action Descriptions
Add Add a coverage type setting object into the system. If it already exists an update is performed. Return Value Type: None Required Properties: SettingsName Optional Properties: Description, SettingsParamValues, OrgPaths Access Control Point Name: Edit Introduced in v6.0 AddOnly Add a coverage type setting object into the system. If it already exists an error is thrown. Return Value Type: None Required Properties: SettingsName Optional Properties: Description, SettingsParamValues, OrgPaths Access Control Point Name: Edit Introduced in v6.0 Delete Delete a coverage type settings object. If the object doesn't exist, no exception will be thrown. Return Value Type: None Required Properties: SettingsName Access Control Point Name: Edit Introduced in v6.0
197
Chapter 2
DeleteOnly Delete a coverage type settings object. If doesn't exist an exception is thrown. Return Value Type: None Required Properties: SettingsName Access Control Point Name: View Introduced in v6.0 Retrieve Return the coverage type setting object by name. Return Value Type: (***undefined***): CoverageSetting Required Properties: SettingsName Access Control Point Name: View Introduced in v6.0 RetrieveAll Return all the coverage type setting objects. Return Value Type: Zero or more CoverageSettings tags Access Control Point Name: View Introduced in v6.0 RetrieveAllForUpdate Return a list of coverage type setting objects. This action is used for future updates. Return Value Type: Zero or more CoverageSettings tags Access Control Point Name: View Introduced in v6.0 RetrieveAllNames Return the coverage type setting name objects. Return Value Type: (***undefined***): KBusinessObjectNameList Access Control Point Name: View Introduced in v6.0
198
Kronos Incorporated
CoverageSettings Tag
RetrieveForUpdate Return the coverage type setting object. This action is used for future updates. Return Value Type: CoverageSettings tag Required Properties: SettingsName Access Control Point Name: View Introduced in v6.0 Update Update the coverage type setting object.If it does not exist an add is performed. Return Value Type: None Required Properties: SettingsName Optional Properties: Description, SettingsParamValues, OrgPaths Access Control Point Name: Edit Introduced in v6.0 UpdateOnly Update a coverage type setting object. If it does not exist an error is thrown. Return Value Type: None Required Properties: SettingsName Optional Properties: Description, SettingsParamValues, OrgPaths Access Control Point Name: Edit Introduced in v6.0
Property Descriptions
Description
199
Chapter 2
Sample values: <CoverageSettings SettingsName="coverage setting 3" Description="sample setting"> Introduced in v6.0; last changed in v6.0 OrgPaths
Location paths
Specify the list of associated organizational location type paths. Type: Zero or more SimpleValue tags 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> Introduced in v6.0; last changed in v6.0 SettingsName
200
Kronos Incorporated
CoverageSettings Tag
SettingsParamValues
201
Chapter 2
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View Introduced in v6.0
202
Kronos Incorporated
CoverageSettingsValue Tag
Action Parameters Parameter Name orgPath Description Path of the location from which to find the setting and its parameter value. Required The name of parameter definition for which the value is requested. Required Must be an existing sched gen parameter defintion Additional information Introduced in v6.0
paramDefinitionName
Introduced in v6.0
Property Descriptions
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> Introduced in v6.0; last changed in v6.0
203
Chapter 2
Syntax
Properties <CoverShiftStatus (Date = Date) (IsShiftExists = Boolean) (IsShiftCovered = Boolean) > (<RequestToCoverItems> <RequestToCoverItem>* </RequestToCoverItems>) </CoverShiftStatus>
Property Descriptions
Date
Date
The date of the daily status. Type: Date Output only Introduced in v5.1 IsShiftCovered
204
Kronos Incorporated
CoverShiftStatus Tag
205
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "LoadIdentities" Parameters None Properties <CurrentUser BadgeNumber = String EmployeeKey = Long PersonKey = Long PersonNumber = String UserKey = Long </CurrentUser>
Action Descriptions
206
Kronos Incorporated
CurrentUser Tag
LoadIdentities Returns current user information for the logged on user. Return Value Type: CurrentUser tag Required Properties: None Access Control Point Name: View Introduced in v4
Property Descriptions
BadgeNumber
Badge number
Contains an employee badge number that is assigned to the employee. The system can be configured to allow multiple badges for employees. Specify whether to allow multiple badge assignments in 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 Maximum length: 25 characters Must be unique for the specified date span. Validation is done after a person is associated with a badge, using the PersonInformation tag. Introduced in v4 EmployeeKey
207
Chapter 2
Type: Long Maximum value = 2,147,488, 848 Must identify only one person Introduced in v4; last changed in v5.0 PersonKey
Person number
Person number of the specified person Type: String Maximum length: 15 characters Introduced in v4 UserKey
208
Kronos Incorporated
CurrentUser Tag
Identifier A single value that identifies the current user Required Group includes: BadgeNumber, EmployeeKey, PersonKey, PersonNumber, UserKey
209
Chapter 2
Syntax
Properties <CustomData Text = String CustomDataTypeName = String > </CustomData>
Property Descriptions
CustomDataTypeName
210
Kronos Incorporated
CustomData Tag
seniority number, mother's maiden name, Social Security Number Introduced in v4 Text
Text
The text of the custom string Type: String Required Maximum length: 80 characters Introduced in v4
211
Chapter 2
Syntax
Properties <CustomDate Date = Date CustomDateTypeName = String > </CustomDate>
Property Descriptions
CustomDateTypeName
Date name
Contains the name of a person-specific date for an employee Type: String Required Key Maximum length: 50 characters You can find values in the Workforce Timekeeper user interface. Sample values: 401K Enrollment Date Introduced in v4
212
Kronos Incorporated
CustomDate Tag
Date
Date
Specifies a custom date field to be used by the Person tag. Type: Date Required Introduced in v4
213
Chapter 2
Syntax
Properties <CustomOperator OperatorName = String Value = String > </CustomOperator>
Property Descriptions
OperatorName
214
Kronos Incorporated
DataAccessGroup Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddGDAPItem" | "AddOnly" | "Delete" | "DeleteAllGDAPItem" | "DeleteGDAPItem" | "Duplicate" | "GetGDAPItemTypeList" | "Retrieve" | "RetrieveAll" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" | "UpdateOnly" Parameters Retrieve AllowItemList [GDAPItemType RetrieveAll AllowItemList [GDAPItemType UpdateOnly
215
Chapter 2
[NewName = String] Properties <DataAccessGroup Name = String [Description = 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 Return Value Type: None Required Properties: Name, GDAPItemList Access Control Point Name: Edit Introduced in v6.0 AddOnly Create a new GDAP and Assign it the current User Check whether the Name property already in the Database Return Value Type: None Required Properties: Name Optional Properties: Description,GDAPItemList Access Control Point Name: Edit Introduced in v6.0 Delete Delete the GDAP and any associated GDAP Items Return Value Type: None
216
Kronos Incorporated
DataAccessGroup Tag
Required Properties: Name Access Control Point Name: Edit Introduced in v6.0 DeleteAllGDAPItem Delete all the GDAPItems that associated with this GDAP Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v6.0 DeleteGDAPItem Delete the GDAP Items in the GDAPItemList Return Value Type: None Required Properties: Name,GDAPItemList Access Control Point Name: Edit 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. Return Value Type: None Required Properties: Name Access Control Point Name: Edit 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 Required Properties: Name
217
Chapter 2
Access Control Point Name: Edit Introduced in v6.0; last changed in v6.0 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 Return Value Type: DataAccessGroup tag Required Properties: Name Access Control Point Name: Edit Introduced in v6.0; last changed in v6.0
Action Parameters Parameter Name AllowItemList Description set AllowItemList=TRUE to get GDAPItems showed in the response Required Default value: False What kind of GDAPItemType you want to retrieve Optional Default value: False Additional information Introduced in v6.0; last changed in v6.0
GDAPItemType
Introduced in v6.0
RetrieveAll Retrieves a list of Data Access Groups Return Value Type: Collection Access Control Point Name: View Introduced in v6.0
218
Kronos Incorporated
DataAccessGroup Tag
Action Parameters Parameter Name AllowItemList Description set AllowItemList = true to indicate that you want the GDAP items showed in the response Required Default value: False What kind of GDAPItemType you want to retrieve Optional Default value: FALSE Additional information Introduced in v6.0; last changed in v6.0
GDAPItemType
Introduced in v6.0
RetrieveAllForUpdate Returns all Generic Data Access Profile for updating. Return Value Type: Zero or more DataAccessGroup tags Access Control Point Name: View Introduced in v6.0 RetrieveAllNames Returns a list of the names of all Generic Data Access Profile in user's GDAP context Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v6.0; last changed in v6.0 RetrieveForUpdate Returns the specified Generic Data Access Profile for updating. Return Value Type: DataAccessGroup tag Required Properties: Name Access Control Point Name: View Introduced in v6.0
219
Chapter 2
Update Update the specified Generic Data Access Profile. The specified Generic Data Access Profile must in database. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v6.0 UpdateOnly Update the GDAP with Description or change the GDAP with the NewName Return Value Type: None Required Properties: Name Optional Properties: NewName, Description Access Control Point Name: Edit Introduced in v6.0; last changed in v6.0
Action Parameters Parameter Name NewName Description DataAccessGroup Name . The new name should be unique. Optional The new name should be unique. Additional information Introduced in v6.0; last changed in v6.0
Property Descriptions
Description
220
Kronos Incorporated
DataAccessGroup Tag
221
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <DataElementAPIFacade Name = String > </DataElementAPIFacade>
Action Descriptions
RetrieveAllNames Retrieves All Names Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.2
222
Kronos Incorporated
DataElementAPIFacade Tag
RetrieveForUpdate Retrieve for update through SDM Return Value Type: DataElementAPIFacade tag Required Properties: Name Access Control Point Name: View Introduced in v5.2 Update Updates using SDM Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
Name
Name
Name Type: String Required Key Introduced in v5.2
223
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <DataSetAPIFacade Name = String > </DataSetAPIFacade>
Action Descriptions
RetrieveAllNames Retrieves All names of Calendar Data Set objects. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.2
224
Kronos Incorporated
DataSetAPIFacade Tag
RetrieveForUpdate Retrieves the Calendar Data Set object corresponding to the name. Return Value Type: DataSetAPIFacade tag Required Properties: Name Access Control Point Name: View Introduced in v5.2 Update Updates the Calendar data Set object corresponding to the name. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
Name
225
Chapter 2
Syntax
Properties <DataSource (ClientName = String) (FunctionalAreaCode = Integer) (ServerName = String) (UserName = String) > </DataSource>
Property Descriptions
ClientName
Client name
Name that specifies the client's identity Type: String Output Only Introduced in v4 FunctionalAreaCode
226
Kronos Incorporated
DataSource Tag
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
227
Chapter 2
Syntax
Properties <DateTotals (Date = Date) > (<Totals> <TotalSummary> </Totals>) </DateTotals>
Property Descriptions
Date
Set of Totals
A list of totals for this date, broken out by labor account and pay code Type: TotalSummary tag Output only
228
Kronos Incorporated
DateTotals Tag
Introduced in v4
229
Chapter 2
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View Introduced in v5.0; last changed in v5.0
Property Descriptions
230
Kronos Incorporated
DeductRule Tag
DeductRuleName
231
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveByProxyMgrPersonNumber" Parameters RetrieveByProxyMgrPersonNumber PersonNumber = String 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>
232
Kronos Incorporated
DelegateAuthorityTask Tag
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 Required Properties: PersonNumber Access Control Point Name: View Introduced in v5.2; last changed in v5.2
Action Parameters Parameter Name PersonNumber Description The person number for the delegate (the proxy manager). Required This parameter is always required for the action. Additional information Introduced in v5.2
Property Descriptions
EndDate
233
Chapter 2
MgrId
Proxy manager ID
Proxy manager's person ID. Type: String Output only Introduced in v5.2; last changed in v5.2 MgrName
Name of a manager
Manager's name. Type: String Output only Introduced in v5.2; last changed in v5.2 ProxyMgrId
234
Kronos Incorporated
DelegateAuthorityTask Tag
ProxyMgrNumber
235
Chapter 2
TaskId
ID of a delegate task
Delegate task ID. Type: Long Output only Introduced in v5.2; last changed in v5.2 TaskString
Description of a task
Task string. Type: String Output only Introduced in v5.2; last changed in v5.2
236
Kronos Incorporated
DelegateProfile Tag
Syntax
Request <Request Action = Actions 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 [Description = String] > <Delegates> <LightWeightPerson>* </Delegates> </DelegateProfile>
237
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. Return Value Type: None Required Properties: Name, Delegates Optional Properties: Description Access Control Point Name: View Introduced in v5.2; last changed in v5.2 Delete The name of an existing delegate profile. The name of an existing delegate profile. Return Value Type: None Required Properties: Name Access Control Point Name: View 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. Return Value Type: None Access Control Point Name: View Introduced in v5.2; last changed in v5.2
238
Kronos Incorporated
DelegateProfile Tag
Action Parameters Parameter Name Name Description The Name should be the name of an existing delegate profile. Required The Name should be the name of an existing delegate profile. Additional information Introduced in v5.2
Retrieve Specify the name of the delegate profile to be retrieved; the name should not exceed 50 characters. The length of the name should not exceed 50. Return Value Type: (***undefined***): Required Properties: Name Access Control Point Name: View Introduced in v5.2; last changed in v5.2 RetrieveAll No special validation No special validation Return Value Type: (***undefined***): Access Control Point Name: View 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. Return Value Type: None
239
Chapter 2
Required Properties: Name, Delegates Optional Properties: NewName, Description Access Control Point Name: Edit Introduced in v6.0; last changed in v6.0
Action Parameters Parameter Name NewName Description The name for the delegete profile should be unique. Optional The name for the delegete profile should be unique. Additional information Introduced in v6.0
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. 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. Return Value Type: None Required Properties: Name,Delegates Optional Properties: NewName, Description Access Control Point Name: View Introduced in v5.2; last changed in v5.2
240
Kronos Incorporated
DelegateProfile Tag
Action Parameters Parameter Name NewName Description The new name should be unique. Optional The new name should be unique. Additional information Introduced in v5.2
Property Descriptions
Delegates
241
Chapter 2
Required 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
242
Kronos Incorporated
DeviceGroup Tag
Syntax
Request <Request Action = Actions 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
243
Chapter 2
Access Control Point Name: View Introduced in v4 LoadAllDeviceGroups Returns all device groups in the system. Return Value Type: Zero or more DeviceGroup tags Access Control Point Name: View Introduced in v4 LoadById Returns information about a device group, based on DeviceGroupId. Return Value Type: DeviceGroup tag Required Properties: DeviceGroupId Optional Properties: DeviceGroupId Access Control Point Name: View Introduced in v4
Property Descriptions
DeviceGroupId
Device group ID
A unique identifier for a device group Type: Integer Optional Introduced in v4 DeviceGroupName
244
Kronos Incorporated
DeviceGroup Tag
Maximum length: 50 characters You can find values in the Workforce Timekeeper Setup Application. Introduced in v4
245
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Update" Parameters None Properties <EarnedAccrual AmountInCurrency = Currency AmountInTime = TimeDuration AmountInTimeOrCurrency = String AccrualCodeName = String Date = Date > <Employee> <CurrentUser> | <PersonIdentity> </Employee> </EarnedAccrual>
246
Kronos Incorporated
EarnedAccrual Tag
Action Descriptions
Update Updates an accrual amount for a specified employee. If the accrual code does not exist for the employee, this action adds it. The type of the accrual code determines the amount that can be specified: either a time duration, or a currency. The format of the accrual amount must match the type of the accrual code. Return Value Type: None Required Properties: AccrualCodeName, Date, Employee, One member of the AccrualAmount group Access Control Point Name: Edit Introduced in v4; last changed in v5.0
Property Descriptions
AmountInCurrency
247
Chapter 2
Type: TimeDuration Maximum length: 30 characters AmountInTime belongs to the AccrualAmount group. To specify a time value, use either the AmountInTime or the AmountInTimeOrCurrency property. Introduced in v4; last changed in v5.1 AmountInTimeOrCurrency
Date
248
Kronos Incorporated
EarnedAccrual Tag
The date to which the accrual transaction applies Type: Date Required Introduced in v4 Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag. Type: Either CurrentUser or PersonIdentity tag Required Key Must uniquely identify an existing and active employee Introduced in v4
249
Chapter 2
Syntax
Properties <EffectiveWorkload (AnchorDate = Date) (EffectiveDate = Date) (ExpirationDate = Date) OrgJobPath = String [PatternDurationType = String] (WorkloadType = String) WorkloadPatternType = String WorkloadPlanType = String > <HeadcountPatterns> <HeadcountPattern>* </HeadcountPatterns> </EffectiveWorkload>
Property Descriptions
AnchorDate
250
Kronos Incorporated
EffectiveWorkload Tag
EffectiveDate
251
Chapter 2
The LocationOrgNodePath in the WorkloadPlan tag, which represents the fully qualified path name for the organization node on the organization tree, must be the parent of the OrgJobPath. Sample values: If the LocationOrgNodePath path is A/B/C, then the OrgJobPath is A/B/C/D. Introduced in v5.0 PatternDurationType
252
Kronos Incorporated
EffectiveWorkload Tag
Type of workload
Type of workload Type: String Output only This value is system-generated. Introduced in v5.0
253
Chapter 2
Syntax
Request <Request Action = Actions 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.
254
Kronos Incorporated
EligibleJobs Tag
The specified employee must be an active employee. Return Value Type: Zero or more LocationItem tags Required Properties: Employee, StartDate Optional Properties: EndDate Access Control Point Name: View Introduced in v5.1; last changed in v5.1
Property Descriptions
Employee
Employee
This property represents the employee who requests the action. Type: PersonIdentity tag 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. Introduced in v5.1; last changed in v5.1 LocationItems
Location Items
255
Chapter 2
A list of location items. Type: Zero or more LocationItem tags Output only 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. Introduced in v5.1; last changed in v5.1
256
Kronos Incorporated
EmailAddress Tag
Syntax
Properties <EmailAddress Address = String ContactTypeName = String > </EmailAddress>
Property Descriptions
Address
Type of contact
The name of the contact category Type: String
257
Chapter 2
258
Kronos Incorporated
EmployeeGroupAssign Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "Update" Parameters None Properties <EmployeeGroupAssign (PersonNumber = Integer) > <Employees> <CurrentUser> | <PersonIdentity> </Employees> <EmployeeGroupItems> <EmployeeGroupItem>* </EmployeeGroupItems> </EmployeeGroupAssign>
Action Descriptions
259
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 Return Value Type: String Required Properties: PersonNumber Optional Properties: Period,TimeFramePeriod, PeriodDateSpan Access Control Point Name: View Introduced in v5.1; last changed in v5.1 Update Update action assigns a list of employees to one or more groups of a certain date range. EmployeeGroupItems shouldn't be null Return Value Type: String Required Properties: EmployeeGroupItems, Employees Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1
Property Descriptions
EmployeeGroupItems
Employees
260
Kronos Incorporated
EmployeeGroupAssign Tag
A list of schedule employees Type: Either CurrentUser or PersonIdentity tag Required Introduced in v5.1; last changed in v5.1 PersonNumber
Person number
PersonNumber is a required property for load action only. Type: Integer Output only Introduced in v5.1; last changed in v5.1
261
Chapter 2
Syntax
Properties <EmployeeGroupItem ExpirationDate = Time EndDate = Time EffectiveDate = Time Name = String > </EmployeeGroupItem>
Property Descriptions
ExpirationDate
262
Kronos Incorporated
EmployeeGroupItem Tag
263
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "LoadAllEmployeeGroupProfiles" | "LoadById" Parameters None Properties <EmployeeGroupProfile [EmployeeGroupProfileId = Integer] [EmployeeGroupProfileName = String] > </EmployeeGroupProfile>
Action Descriptions
264
Kronos Incorporated
EmployeeGroupProfile Tag
Load Returns the specified employee group profile, based on EmployeeGroupProfileName. Return Value Type: EmployeeGroupProfile tag Required Properties: EmployeeGroupProfileName Access Control Point Name: View Introduced in v4 LoadAllEmployeeGroupProfiles Returns all employee group profiles in the system. Return Value Type: Zero or more EmployeeGroupProfile tags Access Control Point Name: View Introduced in v4 LoadById Returns the specified employee group profile, based on EmployeeGroupProfileId. Return Value Type: EmployeeGroupProfile tag Required Properties: EmployeeGroupProfileId Access Control Point Name: View Introduced in v4
Property Descriptions
EmployeeGroupProfileId
265
Chapter 2
EmployeeGroupProfileName
266
Kronos Incorporated
EmployeeMessage Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Delete" | "Load" | "LoadAllMessages" | "Send" Parameters None Properties <EmployeeMessage MessageSubject = String TypeId = String > <Recipients> <HyperFindQuery> | <To> </Recipients> <Sender> <From> </Sender> </EmployeeMessage>
267
Chapter 2
Action Descriptions
Delete validation done in the bean validation done in the bean Return Value Type: None Required Properties: MessageId,Sender Access Control Point Name: Edit Introduced in v5.2 Load validation done in the bean validation done in the bean Return Value Type: Zero or more EmployeeMessage tags Required Properties: Sender Access Control Point Name: View Introduced in v5.2 LoadAllMessages bean does the validation bean does the validation Return Value Type: (***undefined***): APIBeanList Required Properties: Identity Access Control Point Name: View Introduced in v5.2; last changed in v5.2 Send validation done in the bean validation done in the bean Return Value Type: None Required Properties: TypeId,Sender,Recipients,MessageSubject
268
Kronos Incorporated
EmployeeMessage Tag
Optional Properties: MessageBody,MessageId Access Control Point Name: Edit Introduced in v5.2; last changed in v5.2
Property Descriptions
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 validation done in the bean Introduced in v5.2 Sender
Sender
Validation done in the bean Type: From tag Required
269
Chapter 2
Message Type ID
The acceptable values are 1, 2 or 3. Type: String Required The acceptable values are 1, 2 or 3. Sample values: 1, 2 or 3 Introduced in v5.2
270
Kronos Incorporated
EmployeePreferredZone Tag
Syntax
Request <Request Action = Actions 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. Return Value Type: None Required Properties: PersonNumber
271
Chapter 2
Access Control Point Name: Edit 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 Required Properties: PersonNumber Access Control Point Name: View 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. Return Value Type: None Required Properties: PersonNumber, PreferredZoneSet, PreferredZone Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
PersonNumber
Person number
The person number of the employee that you are assigning or deleting the preferred zone for. Type: Integer Required Introduced in v5.2; last changed in v5.2 PreferredZone
272
Kronos Incorporated
EmployeePreferredZone Tag
The name of the zone that is being assigned to an employee Type: String Optional Introduced in v5.2; last changed in v5.2 PreferredZoneSet
273
Chapter 2
Syntax
Properties <EmployeeSummary (<Accruals> <AccrualBalanceSummary>* </Accruals>) (<Employee> <PersonIdentity> </Employee>) (<Totals> <Total>* </Totals>) </EmployeeSummary>
Property Descriptions
Accruals
Accruals
One or more accruals for the specified employee, as requested by the BulkAccruals tag. Type: Zero or more AccrualBalanceSummary tags Output Only Introduced in v4
274
Kronos Incorporated
EmployeeSummary Tag
Employee
Employee
One employee, as specified in a PersonIdentity tag, for whom the accruals or totals are returned. Type: PersonIdentity tag Output Only Must uniquely identify an existing and active employee 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
275
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "LoadEmploymentStatuses" Parameters None Properties <EmploymentStatus [EffectiveDate = Date] EmploymentStatusName = String [ExpirationDate = Date] > <Identity> <CurrentUser> | <PersonIdentity> </Identity> [<Period> <TimeFramePeriod> </Period>] </EmploymentStatus>
Action Descriptions
276
Kronos Incorporated
EmploymentStatus Tag
LoadEmploymentStatuses Returns information associated with the employment status for one person over the specified period of time. If the period of time is not specified, the current date through January 1, 3000 is used. The information returned for the Identity and Period properties is added to the first tag in the resulting list. If no data for the person is found, the value returned consists of just the Identity and Period properties. The person must exist and the user must have access to that person. Return Value Type: Zero or more EmploymentStatus tags Required Properties: Identity Optional Properties: Period Access Control Point Name: View Introduced in v5.0; last changed in v5.0
Property Descriptions
EffectiveDate
Effective date
The beginning date of the employment status that this tag sets. Type: Date Optional Must occur before the expiration date Default value: The date of the import Introduced in v4; last changed in v5.1 EmploymentStatusName
277
Chapter 2
Values can be: 0 for not applicable 1 for an active employee 2 for an inactive employee 3 for a terminated employee
Type: String Required Maximum length: 1 character 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. Default value: January 1, 3000 Introduced in v4; last changed in v5.1 Identity
Identity
One person, as specified in a PersonIdentity or CurrentUser tag. Type: Either CurrentUser or PersonIdentity tag Optional Key Must uniquely identify a person. Introduced in v5.0
278
Kronos Incorporated
EmploymentStatus Tag
Period
Time period
The time span that is associated with an employment status Type: TimeFramePeriod tag Optional The specified identity shall be used when the time frame requires an association with a person. Used for the LoadEmploymentStatuses action Default value: From the current date until January 1, 3000 Introduced in v5.0
279
Chapter 2
Syntax
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>
Property Descriptions
ActionName
280
Kronos Incorporated
Error Tag
Introduced in v4 BeanName
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
281
Chapter 2
Message
Error message
An error message that describes the error Type: String Required Introduced in v4 ParameterName
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
282
Kronos Incorporated
Error Tag
PropertyName
283
Chapter 2
Syntax
Properties <ExpectedHours Quantity = TimeDuration TimePeriodTypeName = String > </ExpectedHours>
Property Descriptions
Quantity
Number of hours
The number of hours the employee is expected to work for the time span identified in TimePeriodTypeName. Type: TimeDuration Required Maximum length: 6 characters The value can be an integer or a decimal amount, such as 8, 8.0 or 8.5. Do not use colons, for example, 8:00 to separate hours and minutes. Introduced in v4; last changed in v5.0 TimePeriodTypeName
284
Kronos Incorporated
ExpectedHours Tag
The span of time associated with the number of hours reported in Quantity. Type: String Required Key Maximum length: 10 characters Enumerated value: Daily, Weekly, Monthly, Annually, Pay Period, Schedule Period Introduced in v4; last changed in v5.0
285
Chapter 2
Syntax
Request <Request Action = Actions 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]
286
Kronos Incorporated
FailedXMLTransaction Tag
[ErrorRecordNumber = Integer] [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 Return Value Type: None Required Properties: SourceName, BatchStatId, XMLRequestEndDate, XMLRequestEndTime, TransactionType, XMLRequestHeaderText, XMLRequestBodyText Access Control Point Name: Edit Introduced in v5.0 Delete Removes the failed transaction record with matching property values from the database. SourceName or TransactionType must be specified. Return Value Type: None Required Properties: XMLRequestEndDate, XMLRequestEndTime Access Control Point Name: Edit Introduced in v5.0 Load Returns all failed transactions for the specified SourceName and TransactionType. You must specify at least one of these properties with the Load action; if you do not, an error is returned. Return Value Type: Zero or more FailedXMLTransaction tags Optional Properties: SourceName, TransactionType Access Control Point Name: Edit
287
Chapter 2
Introduced in v5.0
Property Descriptions
APIBeanName
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 Maximum length: 10 characters Introduced in v5.0 ErrorCode
Error code
A identification for the error that was returned Type: Integer Optional Introduced in v5.0
288
Kronos Incorporated
FailedXMLTransaction Tag
ErrorRecordNumber
Description of error
A description of the error that was returned Type: String Optional Maximum length: 250 characters Introduced in v5.0 PropertyName
289
Chapter 2
290
Kronos Incorporated
FailedXMLTransaction Tag
Sample values: Accrual Dates, Accruals, Activities, Activities People, Availability Templates, Certifications, Customers, Labor Level Entries, Labor Level Sets, Organizational Maps, Pay Code Edits, People, Punches, Results, Schedule Assistant Criteria, Schedule Rules, Schedules, Skills, Staffing, Workforce Activities, Workforce Scheduler Introduced in v5.0 XMLRequestBeginDate
291
Chapter 2
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="13011" DayLightSavingsFlag=" True"> <Employee> < PersonIdentity BadgeNumber=" 28" /> < /Employee> < /Punch> < /Request> Introduced in v5.0 XMLRequestEndDate
292
Kronos Incorporated
FailedXMLTransaction Tag
Type: String Optional Maximum length: 1000 characters 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
293
Chapter 2
Syntax
Properties <FPAAllocation [LaborAccountName = String] Percentage = Double [WageAdjustmentAmount = Double] [WageAdjustmentType = Integer] > </FPAAllocation>
Property Descriptions
LaborAccountName
Percentage
294
Kronos Incorporated
FPAAllocation Tag
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
295
Chapter 2
Introduced in v5.2
296
Kronos Incorporated
FPARule Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Delete" | "Retrieve" | "RetrieveAll" | "RetrieveAllNames" | "RetrieveByName" | "RetrieveForUpdate" | "Update" Parameters None Properties <FPARule Name = String > <FPARuleVersions> <FPARuleVersion>* </FPARuleVersions> </FPARule>
Action Descriptions
297
Chapter 2
Delete Deletes an FPARule name must not be null and should be between 1 and 30 characters Return Value Type: None Required Properties: name Access Control Point Name: Edit 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 Required Properties: name Access Control Point Name: View Introduced in v5.2 RetrieveAll Returns all FPA rules in the system Return Value Type: Zero or more FPARule tags Access Control Point Name: View Introduced in v5.2 RetrieveAllNames Returns the names of all FPARules in the system Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.2; last changed in v5.2 RetrieveByName Returns a FPARule for a given name name must not be null and between 1 and 30 characters Return Value Type: FPARule tag
298
Kronos Incorporated
FPARule Tag
Required Properties: name Access Control Point Name: View 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 Return Value Type: FPARule tag Required Properties: name Access Control Point Name: View 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 Return Value Type: None Required Properties: name Optional Properties: FPARuleVersions Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
FPARuleVersions
299
Chapter 2
Sample values: <FPARuleVersions> <FPARuleVersion EndEffectiveDate="01/01/3000" StartEffectiveDate="01/01/1753" Description="BOT EOT"> <Triggers> <FPATrigger LaborAccountPattern="//////701" SequenceNumber="1"> <PayCodes> <SimpleValue value="All Regular"/> <SimpleValue value="Regular"/> </PayCodes> <Allocations> <FPAAllocation LaborAccountName="101//303// 504//701" WageAdjustmentType="1" Percentage="50" WageAdjustmentAmount="5.00" /> <FPAAllocation LaborAccountName="101//303// 504//702" WageAdjustmentType="2" Percentage="50" WageAdjustmentAmount="12.00" /> </Allocations> </FPATrigger> <FPATrigger JobCode="Line 1/QCE" JobCodeEffectiveDate="11/15/2005" SequenceNumber="1"> <PayCodes> <SimpleValue value="Regular"/> </PayCodes> <Allocations> <FPAAllocation LaborAccountName="101//303// 504//701" WageAdjustmentType="1" Percentage="50" WageAdjustmentAmount="5.00" /> <FPAAllocation LaborAccountName="101//303// 504//702" WageAdjustmentType="2" Percentage="50" WageAdjustmentAmount="12.00" /> </Allocations> </FPATrigger> </Triggers> </FPARuleVersion> </FPARuleVersions> Introduced in v5.2
300
Kronos Incorporated
FPARule Tag
Name
301
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddVersionToRule" Parameters AddVersionToRule ruleName = String Properties <FPARuleVersion [Description = String] EndEffectiveDate = Date StartEffectiveDate = Date > [<Triggers> <FPATrigger>* </Triggers>] </FPARuleVersion>
Action Descriptions
AddVersionToRule Adds a new FPA Version to a rule Return Value Type: None
302
Kronos Incorporated
FPARuleVersion Tag
Required Properties: StartEffectiveDate Optional Properties: Description Triggers Access Control Point Name: Edit Introduced in v6.0
Action Parameters Parameter Name ruleName Description Name of the urle to add this version to Required Additional information Introduced in v6.0
Property Descriptions
Description
Description
Simple description to describe the revision Type: String Optional Sample values: Description="Initial Version" Introduced in v5.2 EndEffectiveDate
303
Chapter 2
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"/> <SimpleValue value="Regular"/> </PayCodes> <Allocations> <FPAAllocation LaborAccountName="101//303// 504//701" WageAdjustmentType="1" Percentage="50" WageAdjustmentAmount="5.00" />
304
Kronos Incorporated
FPARuleVersion Tag
<FPAAllocation LaborAccountName="101//303// 504//702" WageAdjustmentType="2" Percentage="50" WageAdjustmentAmount="12.00" /> </Allocations> </FPATrigger> <FPATrigger JobCode="Line 1/QCE" JobCodeEffectiveDate="11/15/2005" SequenceNumber="1"> <PayCodes> <SimpleValue value="Regular"/> </PayCodes> <Allocations> <FPAAllocation LaborAccountName="101//303// 504//701" WageAdjustmentType="1" Percentage="50" WageAdjustmentAmount="5.00" /> <FPAAllocation LaborAccountName="101//303// 504//702" WageAdjustmentType="2" Percentage="50" WageAdjustmentAmount="12.00" /> </Allocations> </FPATrigger> </Triggers> Introduced in v5.2
305
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddTriggerToRule" Parameters AddTriggerToRule ruleName = String versionStartDate = Date Properties <FPATrigger [JobCode = String] [JobCodeEffectiveDate = Date] LaborAccountPattern = String SequenceNumber = Long > [<Allocations> <FPAAllocation>* </Allocations>] [<PayCodes> <SimpleValue>* </PayCodes>] </FPATrigger>
Action Descriptions
306
Kronos Incorporated
FPATrigger Tag
AddTriggerToRule Adds a new trigger to a rule Return Value Type: None Required Properties: SequenceNumber LaborAccountPattern Allocations Optional Properties: JobCode JobCodeEffectiveDate Access Control Point Name: Edit Introduced in v6.0
Action Parameters Parameter Name ruleName versionStartDate Description name of the rule to add this trigger to Required The start date of this version. Required Validate the date format. Additional information Introduced in v6.0 Introduced in v6.0
Property Descriptions
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> <FPAAllocation LaborAccountName="101//303// 504//701" WageAdjustmentType="1" Percentage="50" WageAdjustmentAmount="5.00" />
307
Chapter 2
<FPAAllocation LaborAccountName="101//303// 504//702" WageAdjustmentType="2" Percentage="50" WageAdjustmentAmount="12.00" /> </Allocations> Introduced in v5.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 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: JobCode="Line 1/QCE" Introduced in v5.2 JobCodeEffectiveDate
308
Kronos Incorporated
FPATrigger Tag
LaborAccountPattern
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 also use one of those paycodes in order to match. Type: Zero or more SimpleValue tags Optional Sample values: <PayCodes> <SimpleValue value="Regular"/> </PayCodes> Introduced in v5.2; last changed in v5.2 SequenceNumber
Sequence Number
309
Chapter 2
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
310
Kronos Incorporated
From Tag
Syntax
Properties <From Address = String [PersonNumber = String] [PersonKey = String] > </From>
Property Descriptions
Address
Email address
email address Type: String Required Validation done in the bean Introduced in v5.2 PersonKey
Person key
Person Key Type: String
311
Chapter 2
Person id
Person id Type: String Optional validation done in the bean Introduced in v5.2
312
Kronos Incorporated
FunctionAccessProfile Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "LoadAllFunctionAccessProfiles" | "LoadById" Parameters None Properties <FunctionAccessProfile [FunctionAccessProfileId = Integer] [FunctionAccessProfileName = String] > </FunctionAccessProfile>
Action Descriptions
313
Chapter 2
Load Returns a function access profile, based on FunctionAccessProfileName. Return Value Type: FunctionAccessProfile tag Required Properties: FunctionAccessProfileName Access Control Point Name: View Introduced in v4 LoadAllFunctionAccessProfiles Returns all function access profiles in the system. Return Value Type: Zero or more FunctionAccessProfile tags Access Control Point Name: View Introduced in v4 LoadById Returns a function access profile, based on FunctionAccessProfileId. ID must be valid Return Value Type: FunctionAccessProfile tag Required Properties: FunctionAccessProfileId Access Control Point Name: View Introduced in v4
Property Descriptions
FunctionAccessProfileId
314
Kronos Incorporated
FunctionAccessProfile Tag
FunctionAccessProfileName
Type: String Optional Maximum length: 50 characters Default value: Default Introduced in v4
315
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddOnly" | "Delete" | "ExpireNow" | "Load" | "RetrieveByGDAPName" | "RetrieveByPersonId" | "RetrieveByPersonIdAndRole" | "Update" | "UpdateOnly" Parameters None Properties <GDAPAssignment DefaultSwitch = Boolean [EffectiveDate = Date] [ExpirationDate = Date] GDAPName = String [OriginalEffectiveDate = Date] [OriginalExpirationDate = Date] Role = String > <Identity> <PersonIdentity>
316
Kronos Incorporated
GDAPAssignment Tag
</Identity> </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. Return Value Type: None Required Properties: Identity, GDAPName, EffectiveDate, ExpirationDate, Role, DefaultSwitch Access Control Point Name: Edit 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. Return Value Type: None Required Properties: Identity, GDAPName, EffectiveDate and/or ExpirationDate Access Control Point Name: Edit 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. Return Value Type: None Required Properties: Identity, GDAPName, EffectiveDate, Role Access Control Point Name: Edit
317
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 Required Properties: Identity Access Control Point Name: View 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. Return Value Type: Collection list Required Properties: GDAPName Access Control Point Name: View 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. Return Value Type: Collection list Required Properties: Identity Access Control Point Name: View 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
318
Kronos Incorporated
GDAPAssignment Tag
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. Return Value Type: Collection list Required Properties: Identity Optional Properties: Role Access Control Point Name: View Introduced in v6.0 Update Updates an existing GDAP assignment. 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. Return Value Type: None Required Properties: Identity, GDAPName, Role, EffectiveDate, ExpirationDate, DefaultSwitch, OriginalEffectiveDate, OriginalExpirationDate Access Control Point Name: Edit Introduced in v6.0 UpdateOnly Updates an existing GDAP assignment object. 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. Return Value Type: None Required Properties: Identity, GDAPName, Role, EffectiveDate, ExpirationDate, DefaultSwitch, OriginalEffectiveDate, OriginalExpirationDate Access Control Point Name: Edit Introduced in v6.0
Property Descriptions
319
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 Default value: false 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
320
Kronos Incorporated
GDAPAssignment Tag
Specify the name of the generic data access profile to be assigned. Type: String Required Introduced in v6.0 Identity
Identity
Specify the identity of the person who will be assigned the generic data access profile. Type: PersonIdentity tag Required Introduced in v6.0 OriginalEffectiveDate
OriginalEffective Date
Specify the original effective date of the generic data access profile, which you can use later for updates. Type: Date Optional Introduced in v6.0; last changed in v6.0 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
321
Chapter 2
Role
322
Kronos Incorporated
GDAPAssignmentDefaultSwitch Tag
Syntax
Request <Request Action = Actions 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 Access Control Point Name: Edit
323
Chapter 2
Introduced in v6.0
Property Descriptions
GDAPName
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
324
Kronos Incorporated
GDAPItem Tag
Syntax
Properties <GDAPItem Name = String Type = String > </GDAPItem>
Property Descriptions
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. Type: String
325
Chapter 2
326
Kronos Incorporated
GenericEmployeeCalendar Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Add" | "AddOnly" | "Delete" | "RetrieveAll" | "RetrieveAllByName" | "RetrieveAllByNameAndActive" | "RetrieveById" | "RetrieveByName" | "Update" Parameters None Properties <GenericEmployeeCalendar [TimePeriodId = Integer]
327
Chapter 2
[MonthWidth = Integer] [ViewType = Integer] [Description = String] [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. Return Value Type: None Required Properties: Name, Description, active, dataSetName, displayName, viewType, monthWidth, timePeriodId Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1 AddOnly Adds a generic employee calendar, the operation will fail if a calendar with the same name exists. Return Value Type: None Required Properties: Name, Description, active, dataSetName, displayName, viewType, monthWidth, timePeriodId Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1 Delete Deletes a generic employee calendar. The operation will fail if the calendar doesn't exist. Return Value Type: None Access Control Point Name: Edit
328
Kronos Incorporated
GenericEmployeeCalendar Tag
Introduced in v5.1; last changed in v5.1 RetrieveAll Returns all the generic employee calendars. Return Value Type: Zero or more GenericEmployeeCalendar tags Access Control Point Name: View Introduced in v5.1; last changed in v5.1 RetrieveAllByName Searches for generic employee calendars by name. Return Value Type: Zero or more GenericEmployeeCalendar tags Required Properties: Name Access Control Point Name: View Introduced in v5.1; last changed in v5.1 RetrieveAllByNameAndActive Searches for generic employee calendars by name and active. Return Value Type: Zero or more GenericEmployeeCalendar tags Required Properties: Name, Active Access Control Point Name: View Introduced in v5.1; last changed in v5.1 RetrieveById Returns the specified employee generic calendar. The operation will fail if the calendar doesn't exist. Return Value Type: GenericEmployeeCalendar tag Access Control Point Name: View Introduced in v5.1; last changed in v5.1 RetrieveByName Returns the specified generic employee calendar. The operation will fail if the calendar doesn't exist. Return Value Type: GenericEmployeeCalendar tag
329
Chapter 2
Required Properties: Name Access Control Point Name: View Introduced in v5.1; last changed in v5.1 Update Updates a generic employee calendar. If the calendar doesn't exist, it will be added. Return Value Type: None Required Properties: name Optional Properties: newName, Description, active, dataSetId, displayName, viewType, monthWidth, timePeriodId Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1
Property Descriptions
Active
330
Kronos Incorporated
GenericEmployeeCalendar Tag
331
Chapter 2
The unique name of the default view to use for the employee calendar. Type: String Required Key Introduced in v5.1; last changed in v5.1 TimePeriodId
332
Kronos Incorporated
GenericEmployeeCalendarAPIFacade Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <GenericEmployeeCalendarAPIFacade Name = String > </GenericEmployeeCalendarAPIFacade>
Action Descriptions
RetrieveAllNames Retrieves all names of Generic Employee Calendars. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.2
333
Chapter 2
RetrieveForUpdate Retrieves the Generic Employee calendar corresponding to the name. Return Value Type: GenericEmployeeCalendarAPIFacade tag Required Properties: Name Access Control Point Name: View Introduced in v5.2 Update Updates the Generic Employee calendar corresponding to name. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
Name
334
Kronos Incorporated
GenericManagerCalendar Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Add" | "AddOnly" | "Delete" | "RetrieveAll" | "RetrieveAllByName" | "RetrieveAllByNameAndActive" | "RetrieveById" | "RetrieveByName" | "Update" Parameters None Properties <GenericManagerCalendar
335
Chapter 2
[NavBarCategoryId = Long] DataSetName = Long [Description = String] 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. Return Value Type: None Required Properties: name, Description, active, dataSetName, displayName, viewType, monthWidth, timePeriodId, hperFindQueryId, navBarCategoryId Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1 AddOnly Adds a generic manager calendar, the operation will fail if a calendar with the same name exists. Return Value Type: None Required Properties: name, Description, active, dataSetName, displayName, viewType, monthWidth, timePeriodId, hperFindQueryId, navBarCategoryId Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1 Delete Deletes a generic manager calendar. The operation will fail if the calendar doesn't exist.
336
Kronos Incorporated
GenericManagerCalendar Tag
Return Value Type: None Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1 RetrieveAll Returns all the generic manager calendars. Return Value Type: Zero or more GenericManagerCalendar tags Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1 RetrieveAllByName Searches for generic manager calendars by name. Return Value Type: Zero or more GenericManagerCalendar tags Required Properties: Name Access Control Point Name: View Introduced in v5.1; last changed in v5.1 RetrieveAllByNameAndActive Searches for generic manager calendars by name and active. Return Value Type: Zero or more GenericManagerCalendar tags Required Properties: Name, Active Access Control Point Name: View Introduced in v5.1; last changed in v5.1 RetrieveById Returns the specified generic manager calendar. The operation will fail if the calendar doesn't exist. Return Value Type: GenericManagerCalendar tag Access Control Point Name: View Introduced in v5.1; last changed in v5.1
337
Chapter 2
RetrieveByName Returns the specified generic manager calendar. The operation will fail if the calendar doesn't exist. Return Value Type: GenericManagerCalendar tag Required Properties: Name Access Control Point Name: View Introduced in v5.1; last changed in v5.1 Update Updates a generic manager calendar. If the calendar doesn't exist, it will be added. Return Value Type: None Required Properties: name Optional Properties: newName, Description, active, dataSetId, displayName, viewType, monthWidth, timePeriodId, hperFindQueryId, navBarCategoryId Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1
Property Descriptions
Active
338
Kronos Incorporated
GenericManagerCalendar Tag
DataSetName
Description
The description of a generic manager calendar. Type: String Optional Introduced in v5.1; last changed in v5.1 DisplayName
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
339
Chapter 2
Width of Month
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 Optional Introduced in v5.1; last changed in v5.1 Name
Time Period Id
340
Kronos Incorporated
GenericManagerCalendar Tag
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 Introduced in v5.1; last changed in v5.1 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 Enumerated value: 1,2,3 Introduced in v5.1; last changed in v5.1
341
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllNames" | "RetrieveForUpdate" Parameters None Properties <GenericManagerCalendarAPIFacade Name = String > </GenericManagerCalendarAPIFacade>
Action Descriptions
RetrieveAllNames Retrieves all names of Generic Manager calendars. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.2
342
Kronos Incorporated
GenericManagerCalendarAPIFacade Tag
RetrieveForUpdate Retrieves the Generic manager calendar corresponding to the name for update using the SDM API. Return Value Type: GenericManagerCalendarAPIFacade tag Required Properties: Name Access Control Point Name: View Introduced in v5.2
Property Descriptions
Name
Name
Name Type: String Required Key Introduced in v5.2
343
Chapter 2
Syntax
Properties <GenieColumn ColumnNumber = Integer ExitNum = Integer Label = String Product = String Width = Integer > </GenieColumn>
Property Descriptions
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 Type: Integer
344
Kronos Incorporated
GenieColumn Tag
Label
The column label, which can be found in Display Preferences Setup. Type: String Required Introduced in v5.2; last changed in v5.2 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
345
Chapter 2
Syntax
Properties <GenieRow ColumnN = String RowKey = Integer > </GenieRow>
Property Descriptions
ColumnN
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 Schedule Roll-Up: schedule group name
Type: Integer
346
Kronos Incorporated
GenieRow Tag
347
Chapter 2
Syntax
Properties <GlsegmentDetail [AllowNewLLEntries = Boolean] [endSeparatorCharacter = String] [FillCharacter = String] [FillPosition = String] [LaborLevelName = String] [SegmentLength = Integer] [SegmentNumber = Integer] > </GlsegmentDetail>
Property Descriptions
AllowNewLLEntries
348
Kronos Incorporated
GlsegmentDetail Tag
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" Introduced in v6.0; last changed in v6.0 LaborLevelName
349
Chapter 2
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 Introduced in v6.0; last changed in v6.0
350
Kronos Incorporated
GroupMembership Tag
Syntax
Properties <GroupMembership EffectiveDateSpan = DateSpan > <Employee> <CurrentUser> | <PersonIdentity> </Employee> </GroupMembership>
Property Descriptions
EffectiveDateSpan
Employee
One employee who belongs to the group, as specified in a PersonIdentity or CurrentUser tag.
351
Chapter 2
Type: Either CurrentUser or PersonIdentity tag Required Must uniquely identify an existing and active employee Introduced in v4
352
Kronos Incorporated
Headcount Tag
Syntax
Properties <Headcount DayOfWeek = String NumberOfStaffs = Integer > </Headcount>
Property Descriptions
DayOfWeek
353
Chapter 2
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 Introduced in v5.0; last changed in v5.1 NumberOfStaffs
354
Kronos Incorporated
HeadcountPattern Tag
Syntax
Properties <HeadcountPattern WorkloadSpanName = String > <Headcounts> <Headcount>* </Headcounts> </HeadcountPattern>
Property Descriptions
Headcounts
355
Chapter 2
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
356
Kronos Incorporated
HistoricalPayCodeEdit Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddComment" | "AddOnly" | "Delete" Parameters AddOnly [AccrualOverride = Boolean] [allowAdHoc = Boolean] [EchoData = Boolean] Properties <HistoricalPayCodeEdit [ImpactsAccrualsFlag = Boolean] AmountInTimeOrCurrency = String [CommentText = String] (EnteredOnDate = Date) HistoricalDate = Date Date = Date [PaidFlag = Boolean] [LaborAccountName = String] PayCodeName = String (EnteredOnTime = Time) [WorkRuleName = String] >
357
Chapter 2
[<Notes> <Note>* </Notes>] (<Comments> <Comment>* </Comments>) <Employee> <CurrentUser> | <PersonIdentity> </Employee> </HistoricalPayCodeEdit>
Action Descriptions
AddComment Adds a comment to the set of comments associated with the existing historical pay code edit. Acceptable values can be found in the Setup Application. Return Value Type: None Required Properties: AmountInTimeOrCurrency, CommentText, Date, HistoricalDate, Employee, PayCodeName Access Control Point Name: Edit Introduced in v4 AddOnly Adds a new historical pay code edit for the specified employee. There is no limit to the number of historical pay code edits that an employee can have. Return Value Type: HistoricalPayCodeEdit tag Required Properties: AmountInTimeOrCurrency, Date, HistoricalDate, Employee, PayCodeName Access Control Point Name: Edit Introduced in v4
358
Kronos Incorporated
HistoricalPayCodeEdit Tag
Action Parameters Parameter Name AccrualOverride Description If the action results in an accrual warning, the warning is overridden when AccrualOverride = True. Optional Default value: False Specifies whether an ad hoc labor level is allowed. Optional Default value: False If True, the Response includes a copy of this tag. Optional Default value: False Additional information Introduced in v4
allowAdHoc
Introduced in v5.0; last changed in v5.0; deprecated in v5.0. Not used Introduced in v4
EchoData
Delete Marks for deletion all historical pay code edits for this employee, matching the given date, time, and labor account. At least one historical pay code edit must exist for the specified employee whose required properties match the supplied properties. Return Value Type: None Required Properties: AmountInTimeOrCurrency, Date, HistoricalDate, Employee, PayCodeName Access Control Point Name: Edit Introduced in v4
Property Descriptions
AmountInTimeOrCurrency
359
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. Introduced in v4; last changed in v5.1 Comments
Comments
The set of comments currently associated with this timekeeping item. Type: Zero or more Comment tags Output only Introduced in v4 CommentText
Comment text
Text that is attached to the pay code amount or totaled amount. Note: A comment entered as part of a historical amount is not used as part of the criteria when an import delete is issued for the same historical amount. Type: String Optional Maximum length: 254 characters Must exactly match an applicable comment that already exists. The string matching is case-sensitive. You can find values in the Workforce Timekeeper Setup Application. Introduced in v4 Date
360
Kronos Incorporated
HistoricalPayCodeEdit Tag
Employee
One employee for whom the edit applies, 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 EnteredOnDate
361
Chapter 2
Type: Date Required, Key The specified date must be within a locked pay period. Introduced in v4 ImpactsAccrualsFlag
Type: Boolean Optional Default value: False Enumerated value: True, False 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.
362
Kronos Incorporated
HistoricalPayCodeEdit Tag
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, you can enter @H for those labor levels instead of entering the labor entry names. Type: String Optional Maximum length: 356 characters. Default value: Primary account for the employee Introduced in v4; last changed in v5.0 Notes
Comment Note
The list of notes for the comment to be created from comment text Type: Zero or more Note tags Optional Introduced in v6.0 PaidFlag
363
Chapter 2
Enumerated value: True, False Introduced in v4; last changed in v5.1 PayCodeName
Pay code
Identifies the name of the pay code that is being applied to an amount associated with a historical amount. A pay code represents an amount in time or 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
Work rule
DEPRECATED. Name of the work rule. A work rule applies specific payroll rules to shifts that determine how employee hours accrue. The following predefined data values are provided: &ALL_WORK_RULES &EMPTY
364
Kronos Incorporated
HistoricalPayCodeEdit Tag
Type: String Optional Maximum length: 50 characters You can find values in Setup. Introduced in v4; deprecated in v5.0
365
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddComment" | "AddOnly" | "Delete" Parameters AddOnly [AccrualOverride = Boolean] [allowAdHoc = Boolean] [EchoData = Boolean] Properties <HistoricalPayCodeMove AmountInTimeOrCurrency = String [ImpactsAccrualsFlag = Boolean] [CommentText = String] (EnteredOnDate = Date) Date = Date HistoricalDate = Date [LaborAccountName = String] FromLaborAccountName = String PayCodeName = String
366
Kronos Incorporated
HistoricalPayCodeMove Tag
FromPayCodeName = String (EnteredOnTime = Time) [WorkRuleName = String] > [<Notes> <Note>* </Notes>] (<Comments> <Comment>* </Comments>) <Employee> <CurrentUser> | <PersonIdentity> </Employee> </HistoricalPayCodeMove>
Action Descriptions
AddComment Adds a comment to the set of comments associated with this historical pay code move. Return Value Type: None Required Properties: AmountInTimeOrCurrency, CommentText, Date, FromLaborAccountName, FromPayCodeName, HistoricalDate, Employee, PayCodeName Access Control Point Name: Edit Introduced in v4 AddOnly Adds a new historical pay code edit with the specified properties for this employee. There is no limit to the number of historical pay code edits that you can add for an employee. Return Value Type: HistoricalPayCodeMove tag Required Properties: AmountInTimeOrCurrency, Date, FromLaborAccountName, FromPayCodeName, HistoricalDate, Employee, PayCodeName Access Control Point Name: Edit Introduced in v4
367
Chapter 2
Action Parameters Parameter Name AccrualOverride Description If the action results in an accrual warning, the warning is overridden when AccrualOverride = True. Optional Default value: False Specifies whether an ad hoc labor level is allowed. Optional Default value: False If True, the Response includes a copy of this tag. Optional Default value: False Additional information Introduced in v4
allowAdHoc
Introduced in v5.0; last changed in v5.0; deprecated in v5.0. Not used Introduced in v4
EchoData
Delete Marks all historical pay code edits for an employee that match a set of specified requirements for deletion. Return Value Type: None Required Properties: AmountInTimeOrCurrency, Date, FromLaborAccountName, FromPayCodeName, HistoricalDate, Employee, PayCodeName Access Control Point Name: Edit Introduced in v4
Property Descriptions
AmountInTimeOrCurrency
368
Kronos Incorporated
HistoricalPayCodeMove Tag
Maximum length: 30 characters 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. Type: Zero or more Comment tags Output Only Introduced in v4 CommentText
Comment text
A comment that you can add with this edit Type: String Optional Maximum length: 254 characters Must match exactly an applicable comment that already exists in the database. The string matching is case-sensitive. You can find values in the Workforce Timekeeper Setup Application. Introduced in v4 Date
369
Chapter 2
Employee
The employee for whom the edit applies, 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; last changed in v5.1 EnteredOnDate
370
Kronos Incorporated
HistoricalPayCodeMove Tag
Type: String Optional, Key Maximum length: 356 characters Ad hoc creation of labor level entries is not supported; the labor level entries must exist. Default value: Primary account for the employee Introduced in v4; last changed in v5.1 FromPayCodeName
371
Chapter 2
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 historical amount entered 1 if the employee's accrual balances should be adjusted based upon the historical amount entered
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 employees 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 Do not specify labor levels that are not changing. If any of the labor levels are the same as the employees primary labor account, you can enter @H for those labor levels instead of entering the labor entry names. Type: String Optional
372
Kronos Incorporated
HistoricalPayCodeMove Tag
Maximum length: 356 characters Default value: Primary account for the employee Introduced in v4; last changed in v5.1 Notes
Comment Notes
The list of notes for the comment to be created from comment text Type: Zero or more Note tags Optional Introduced in v6.0 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 Maximum length: 50 characters Both PayCodeName and FromPayCodeName must be associated with the same type of payment; either time or currency. Introduced in v4; last changed in v5.1 WorkRuleName
Work rule
Name of the work rule The following predefined data values are provided: &ALL_WORK_RULES &EMPTY
Type: String
373
Chapter 2
Optional Maximum length: 50 characters You can find values in Setup. Introduced in v4; deprecated in v5.0
374
Kronos Incorporated
HistoryDetails Tag
Syntax None
375
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "LoadAllHolidaysInSpan" Parameters None Properties <Holiday DateTimeSpan = DateTimeSpan [Name = String] > </Holiday>
Action Descriptions
Load Returns the named holiday for the specified time span. Return Value Type: Holiday tag Required Properties: Name, DateTimeSpan Access Control Point Name: View
376
Kronos Incorporated
Holiday Tag
Introduced in v4; last changed in v5.1 LoadAllHolidaysInSpan Returns all holidays that are effective within the specified date span. Return Value Type: Zero or more Holiday tags Required Properties: DateTimeSpan Access Control Point Name: View Introduced in v4
Property Descriptions
DateTimeSpan
Holiday
The name of the holiday Type: String Optional Introduced in v4; last changed in v5.0
377
Chapter 2
Syntax
Properties <HolidayEditHours (AmountInTimeOrCurrency = String) (Date = Date) (HolidayName = String) (IsCurrencyFlag = Boolean) (PayCodeName = String) > </HolidayEditHours>
Property Descriptions
AmountInTimeOrCurrency
378
Kronos Incorporated
HolidayEditHours Tag
Type: Date Output Only Sample values: 8:00 Vacation on 4/2/2001 Introduced in v4 HolidayName
Holiday
The name of the holiday Type: String Output Only Introduced in v4 IsCurrencyFlag
Pay code
The pay code to be credited with the amount Type: String Output Only Enumerated value: Holiday
379
Chapter 2
Introduced in v4
380
Kronos Incorporated
HolidayEditWages Tag
Syntax
Properties <HolidayEditWages (AmountInTimeOrCurrency = String) (Date = Date) (HolidayName = String) (IsCurrencyFlag = Boolean) (PayCodeName = String) > </HolidayEditWages>
Property Descriptions
AmountInTimeOrCurrency
381
Chapter 2
Type: Date Output Only Sample values: 8:00 Vacation on 4/2/2001 Introduced in v4 HolidayName
Holiday
The name of the holiday Type: String Output Only Introduced in v4 IsCurrencyFlag
Pay code
The pay code to be credited with the amount Type: String Output Only Enumerated value: Holiday
382
Kronos Incorporated
HolidayEditWages Tag
Introduced in v4
383
Chapter 2
Syntax
Properties <HomeAccount EffectiveDate = Date [ExpirationDate = Date] LaborAccountName = String > </HomeAccount>
Property Descriptions
EffectiveDate
Effective date
The date when the home labor account status becomes effective Type: Date Required Must occur before the expiration date Introduced in v4; last changed in v5.0; deprecated in v5.0. Use this property in the PrimaryLaborAccount tag instead. ExpirationDate
Expiration date
The date when the home labor account expires
384
Kronos Incorporated
HomeAccount Tag
Type: Date Optional Must occur after the effective date Default value: January 1, 3000 Introduced in v4; last changed in v5.0; deprecated in v5.0. Use this property in the PrimaryLaborAccount tag instead. LaborAccountName
385
Chapter 2
Syntax
Properties <HoursSummary Amount = String OrgPath = String SummaryType = String ValueType = String > </HoursSummary>
Property Descriptions
Amount
Amount
Specify the amount of hours. Type: String Required Sample values: 42.5000 Introduced in v6.0 OrgPath
Organizational Path
Specify the organizational node path.
386
Kronos Incorporated
HoursSummary Tag
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
387
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Retrieve" Parameters None Properties <HoursSummaryService QueryDateSpan = String > [<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
388
Kronos Incorporated
HoursSummaryService Tag
Required Properties: QueryDateSpan Optional Properties: Locations Access Control Point Name: View Introduced in v6.0
Property Descriptions
Locations
389
Chapter 2
Syntax
Properties <HPPDItem [DataTypeName = String] [Contribute = String] EffectiveDate = Date [ValueTypeName = String] [Amount = String] OrgPath = String > </HPPDItem>
Property Descriptions
Amount
390
Kronos Incorporated
HPPDItem Tag
Type: String Optional For action update, it must be one of the follows: Direct, Indirect. Introduced in v5.2; last changed in v5.2 DataTypeName
391
Chapter 2
ValueTypeName holds the one of the following values: HPPD, Hours, or Volume. Type: String Optional It must be "HPPD" for action update. Introduced in v5.2; last changed in v5.2
392
Kronos Incorporated
HPPDService Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Retrieve" | "RetrieveForUpdate" | "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
393
Chapter 2
Required Properties: OrgPath, QueryDateSpan Access Control Point Name: View Introduced in v5.2; last changed in v5.2 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 Access Control Point Name: View Introduced in v5.2; last changed in v5.2 Update This action will either insert or update a list of HPPD items onto a database table. Return Value Type: None Required Properties: Items Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
Items
HPPD items
A list of HPPD items. Type: Zero or more HPPDItem tags Optional Introduced in v5.2 OrgPath
394
Kronos Incorporated
HPPDService Tag
Date span
This property represents a date span for query the hppd values. Type: DateSpan Optional Introduced in v5.2
395
Chapter 2
Syntax
Properties <HPPDSummary Amount = String Contribute = String DataTypeName = String OrgPath = String ValueType = String > </HPPDSummary>
Property Descriptions
Amount
Amount
Specify the hours per patient day summary amount value. Type: String Required Sample values: 12.50 Introduced in v6.0 Contribute
Contribute
396
Kronos Incorporated
HPPDSummary Tag
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
397
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
398
Kronos Incorporated
HPPDSummaryService Tag
Syntax
Request <Request Action = Actions 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
399
Chapter 2
Required Properties: QueryDateSpan Optional Properties: Locations Access Control Point Name: View Introduced in v6.0
Property Descriptions
Locations
Locations
Represents the locations for the hppd summary data to be retrieved. Type: Zero or more LocationItem tags Optional Sample values: Organization/Hospitals/Hosp A/Floor 1/ER Introduced in v6.0 QueryDateSpan
400
Kronos Incorporated
HyperFindQuery Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "GetQueryCount" | "LoadAllQueries" | "RunQuery" Parameters None Properties <HyperFindQuery [QueryPersonOrEmployee = String] (Description = String) HyperFindQueryName = String [QueryIncludeWTKEmployeeFlag = Boolean] [QueryIncludePersonFlag = Boolean] [QueryIncludeUserFlag = Boolean] [QueryDateSpan = DateSpan] VisibilityCode = String > </HyperFindQuery>
Action Descriptions
401
Chapter 2
GetQueryCount Returns the number of people that can be returned by the HyperFind query. Return Value Type: SimpleValue tag Required Properties: HyperFindQueryName, VisibilityCode, QueryDateSpan, QueryPersonOrEmployee Access Control Point Name: View Introduced in v4 LoadAllQueries Returns a list of all HyperFind queries. Return Value Type: Zero or more HyperFindQuery tags Required Properties: VisibilityCode Access Control Point Name: View Introduced in v4 RunQuery Returns a list of people and associated information for the specified HyperFind query. Return Value Type: Zero or more HyperFindResult tags Required Properties: HyperFindQueryName, VisibilityCode, QueryDateSpan, QueryPersonOrEmployee Access Control Point Name: View Introduced in v4
Property Descriptions
Description
Description of query
Describes the HyperFind query Type: String Output Only
402
Kronos Incorporated
HyperFindQuery Tag
403
Chapter 2
QueryIncludeUserFlag
404
Kronos Incorporated
HyperFindQuery Tag
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 Introduced in v4; last changed in v5.1
405
Chapter 2
Syntax
Properties <HyperFindResult (FullName = String) (PersonNumber = String) > (<WTKEmployeeData> <WTKEmployee> </WTKEmployeeData>) (<PersonData> <Person> </PersonData>) (<UserAccountData> <UserAccount> </UserAccountData>) </HyperFindResult>
Property Descriptions
FullName
Full name
Name of the resulting person Type: String Output Only Maximum length: 64 characters Introduced in v4
406
Kronos Incorporated
HyperFindResult Tag
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
Person number of the specified person Type: String Output Only Introduced in v4 UserAccountData
Employee data
WTKEmployee tag for the resulting person Type: WTKEmployee tag
407
Chapter 2
Output Only Contains a value when the QueryIncludeWTKEmployeeFlag property in the HyperFindQuery is True Introduced in v4
408
Kronos Incorporated
ImportBatchStatus Tag
Syntax
Request <Request Action = Actions 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>
409
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 Access Control Point Name: Edit 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 Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0 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. Return Value Type: None Required Properties: BatchStatId, TransactionType, BatchProcessStatus Optional Properties: ErrorText, TotalRecordCount, SuccessRecordCount, FailedRecordCount Access Control Point Name: Edit Introduced in v5.0
Property Descriptions
410
Kronos Incorporated
ImportBatchStatus Tag
BatchDescription
Batch description
The BatchDescription contains the same value as BatchName. Type: String Output only Maximum length: 30 characters Introduced in v5.0 BatchName
Batch name
A user defined Import Batch name. Type: String Optional Maximum length: 30 characters Batch Name must uniquely identify an Import Batch. Existing batch names can be found in the user interface. Required: For an AddOnly action Introduced in v5.0 BatchProcessStatus
411
Chapter 2
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 You can find values in the Workforce Timekeeper user interface. Introduced in v5.0 BatchType
Description of error
The error text for the batch Type: String Optional Maximum length: 250 characters Sample values: Normal Completion Introduced in v5.0
412
Kronos Incorporated
ImportBatchStatus Tag
FailedRecordCount
Transaction type
413
Chapter 2
The type of transaction Type: String Optional If more than one transaction type is being imported in the batch, transaction type is set to XML. Sample values: Accrual Dates, Accruals, Activities, Activities People, Availability Templates, Certifications, Customers, Labor Level Entries, Labor Level Sets, Organizational Maps, Pay Code Edits, People, Punches, Result", Schedule Assistant Criteria, Schedule Rules, Schedules, Skills, Staffing, Workforce Activities, Workforce Scheduler, XML Introduced in v5.0; last changed in v5.0
414
Kronos Incorporated
JobAssignment Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" Parameters None Properties <JobAssignment (HasPersonalOvertimeFlag = Boolean) [ScheduleGroupName = String] > <Identity> <CurrentUser> | <PersonIdentity> </Identity> [<JobAssignmentDetailsData> <JobAssignmentDetails> </JobAssignmentDetailsData>] [<PersonalOvertimeAssignments> <PersonalOvertimeAssignment>* </PersonalOvertimeAssignments>] [<PrimaryLaborAccounts> <PrimaryLaborAccount>* </PrimaryLaborAccounts>]
415
Chapter 2
Action Descriptions
Load Returns all information associated with the job and overtime assignments for the specified person and period. Return Value Type: JobAssignment tag Required Properties: Identity Optional Properties: Period Access Control Point Name: View Introduced in v5.0
Property Descriptions
HasPersonalOvertimeFlag
Identity
One employee, as specified in a PersonIdentity or CurrentUser tag. Type: Either CurrentUser or PersonIdentity tag Optional Key
416
Kronos Incorporated
JobAssignment Tag
Time period
The specified time frame Type: TimeFramePeriod tag Optional Must evaluate to a span of time. Identity is used when the time frame requires association with a person. Used for the Load action. Default value: From the current date until January 1, 3000 Introduced in v5.0 PersonalOvertimeAssignments
417
Chapter 2
PrimaryLaborAccounts
418
Kronos Incorporated
JobAssignmentDetails Tag
Syntax
Properties <JobAssignmentDetails [BaseWageHourly = Currency] [BaseWageEffectiveDate = Date] [DeviceGroupName = String] [PayRuleName = String] [SupervisorName = String] [SeniorityRankDate = Date] [SupervisorPersonNumber = String] [TimeZoneName = String] [WageProfileName = String] [WorkerTypeName = String] > </JobAssignmentDetails>
Property Descriptions
BaseWageEffectiveDate
419
Chapter 2
Device group
The Device Group represents all of the data collection devices that the employee can access. Type: String Optional Maximum length: 50 characters You can find values in the Workforce Timekeeper Setup Application. Introduced in v5.0; last changed in v5.1 PayRuleName
Pay rule
The name of the pay rule that is assigned to the employee. A pay rule contains general payroll rules such as type of pay period (for example, weekly). A complete pay rule controls such items as the pay period length, the day divide, when punches link to schedules, when data collection devices accept and reject
420
Kronos Incorporated
JobAssignmentDetails Tag
punches, which holidays give holiday credits, and the order that hour types are processed. Type: String Optional Maximum length: 50 characters Required: For a new Workforce Timekeeper Employee or Timekeeper Employee that tracks their time in Workforce Central. You can find values in the Workforce Timekeeper Setup Application. Introduced in v5.0; last changed in v5.1 SeniorityRankDate
Seniority date
The date when the individual became qualified to work the job or was assigned to the job. Type: Date Optional Introduced in v5.0; last changed in v5.1 SupervisorName
Reports to
The name of a person's manager Type: String Optional Maximum length: 64 characters 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
421
Chapter 2
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 Optional Maximum length: 30 characters Required: When a value is also specified for DeviceGroupName For a list of values, see "Time Zone Definitions" in Appendix B in the Workforce Timekeeper DTK Reference Guide. Default value: Default time zone Introduced in v5.0 WageProfileName
Wage profile
422
Kronos Incorporated
JobAssignmentDetails Tag
The name of the person's wage profile. The Wage Profile allows an employee to have multiple wage rates. Type: String Optional Maximum length: 50 characters Introduced in v5.0; last changed in v5.1 WorkerTypeName
Worker type
The worker type identifies the category of worker (for example, full-time, parttime, or other types that your site might define). Type: String Optional Maximum length: 50 characters Introduced in v5.0; last changed in v5.1
423
Chapter 2
Syntax
Properties <Kronos_WFC [TimeStamp = String] Version = String (WFCVersion = String) > </Kronos_WFC>
Property Descriptions
TimeStamp
Time stamp
The timestamp can refer to the request or the response. This value is ignored by the API XML, but can be used for documenting request times. For a response, it is set to the execution time. Type: String Optional Introduced in v4
424
Kronos Incorporated
Kronos_WFC Tag
Version
425
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "LoadAllKTimeZones" | "LoadById" Parameters None Properties <KTimeZone [KTimeZoneId = Integer] [KTimeZoneName = String] > </KTimeZone>
Action Descriptions
Load Returns time zone information, based on KTimeZoneName. Name should be valid Return Value Type: KTimeZone tag Required Properties: KTimeZoneName
426
Kronos Incorporated
KTimeZone Tag
Access Control Point Name: View Introduced in v4 LoadAllKTimeZones Returns a list of all time zones in the system. Return Value Type: Zero or more KTimeZone tags Required Properties: None Access Control Point Name: View Introduced in v4 LoadById Returns time zone information, based on KTimeZoneId. ID should be valid Return Value Type: KTimeZone tag Required Properties: KTimeZoneId Access Control Point Name: View Introduced in v4
Property Descriptions
KTimeZoneId
Time zone ID
Uniquely identifies the time zone in the database Type: Integer Optional Sample values: 13011 Introduced in v4
427
Chapter 2
KTimeZoneName
428
Kronos Incorporated
LaborAccount Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "Update" | "UpdateAndLoad" Parameters None Properties <LaborAccount [Description = String] LaborAccountName = String > [<LaborLevelEntries> <LaborLevelEntry>* </LaborLevelEntries>] </LaborAccount>
Action Descriptions
Load Returns labor account information for the specified labor account
429
Chapter 2
Return Value Type: LaborAccount tag Optional Properties: LaborAccountName, LaborAccountId Access Control Point Name: View Introduced in v4; last changed in v6.0 Update Adds a new labor account or updates an existing one Return Value Type: None Required Properties: LaborAccountName Access Control Point Name: Edit 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 Required Properties: None Optional Properties: LaborAccountName, LaborAccountId Access Control Point Name: Edit Introduced in v4
Property Descriptions
Description
430
Kronos Incorporated
LaborAccount Tag
LaborAccountName
Labor account
The name of the labor 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 Do not specify labor levels that are not changing. Type: String Required Key Maximum length: 356 characters Each component in the name must correspond to the name and sort order position of an existing labor level entry. The name must contain only legal naming characters. Introduced in v4 LaborLevelEntries
431
Chapter 2
Function Access Control Point: API.DataAccess Introduced in v4; last changed in v5.0
Syntax
Properties <LaborAccountEntry [AddEntries = String] [RemoveEntries = String] [ReplaceEntries = String] LaborLevelDefinitionName = String > </LaborAccountEntry>
Property Descriptions
AddEntries
432
Kronos Incorporated
LaborAccountEntry Tag
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. Introduced in v4; last changed in v5.0 LaborLevelDefinitionName
433
Chapter 2
Optional Maximum length: 146 characters Each semicolon-delimited entry is validated against the labor level definitions length requirements, and checked for invalid characters. Except for wildcards, all labor level entry must exist. Introduced in v4; last changed in v5.0
434
Kronos Incorporated
LaborAccountEntryData Tag
Syntax
Properties <LaborAccountEntryData (Descriptions = String) (Adhoc = Boolean) (LaborLevelDefinitionName = String) (Entries = String) > </LaborAccountEntryData>
Property Descriptions
Adhoc
Is ad hoc allowed?
True or False, based on whether ad hoc is allowed Type: Boolean Output only Enumerated value: True, False Introduced in v5.0 Descriptions
435
Chapter 2
436
Kronos Incorporated
LaborAccountSet Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddOnly" | "Load" | "LoadLaborAccountData" | "LoadLaborAccountUpdatedData" | "Update" | "UpdateOnly" Parameters None Properties <LaborAccountSet LaborAccountSetKey = String LaborAccountSetName = String [NewName = String] [Description = String] [LaborAccountSetTypeName = String] [UpdatedDate = String] > [<EntryList> <LaborAccountEntry>*
437
Chapter 2
</EntryList>] </LaborAccountSet>
Action Descriptions
AddOnly Adds a new labor account set Return Value Type: None Required Properties: LaborAccountSetName, LaborAccountSetTypeName Access Control Point Name: Edit Introduced in v4 Load Returns information for the specified labor account set name Return Value Type: LaborAccountSet tag Required Properties: LaborAccountSetName Access Control Point Name: View Introduced in v4 LoadLaborAccountData Returns all labor account set data for the specified labor account set key. Return Value Type: Zero or more LaborAccountSet tags Required Properties: LaborAccountSetKey Access Control Point Name: View Introduced in v5.0; last changed in v5.0 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. Return Value Type: LaborAccountSet tag Required Properties: LaborAccountSetKey, UpdatedDate Access Control Point Name: View
438
Kronos Incorporated
LaborAccountSet Tag
Introduced in v5.1; last changed in v5.2 Update Adds a new labor account set or updates an existing one Return Value Type: None Required Properties: LaborAccountSetName. If adding a new labor account set, LaborAccountSetTypeName is required. Access Control Point Name: Edit Introduced in v4 UpdateOnly Updates an existing labor account set Return Value Type: None Required Properties: LaborAccountSetName Access Control Point Name: Edit Introduced in v4
Property Descriptions
Description
439
Chapter 2
Optional Each labor level account entry in the list is validated individually. Introduced in v4 LaborAccountSetKey
440
Kronos Incorporated
LaborAccountSet Tag
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 Maximum length: 1 character Enumerated value: 1, 2, 3 Introduced in v4 NewName
Updated Date
The date when the entries of the specified labor account set are updated Type: String Optional Introduced in v5.1; last changed in v5.1
441
Chapter 2
Syntax
Request <Request Action = Actions 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. Name should be valid
442
Kronos Incorporated
LaborAccountSetProfile Tag
Return Value Type: LaborAccountSetProfile tag Required Properties: LaborAccountSetProfileName Access Control Point Name: View Introduced in v4 LoadAllLaborAccountSetProfiles Returns all labor account set profiles in the system. Return Value Type: Zero or more LaborAccountSetProfile tags Required Properties: None Access Control Point Name: View 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 Access Control Point Name: View Introduced in v4
Property Descriptions
LaborAccountSetProfileId
443
Chapter 2
The name for the common set of labor accounts that a group of users can access; for example, F Snow Employees. Type: String Optional Maximum length: 30 characters Sample values: All Labor Account Introduced in v4
444
Kronos Incorporated
LaborLevelDefinition Tag
Syntax
Request <Request Action = Actions 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
445
Chapter 2
GetNumberOfLaborLevels Returns a count of labor level definitions Return Value Type: SimpleValue tag Access Control Point Name: View Introduced in v4 LoadAllDefinitions Returns all labor level definition names Return Value Type: Zero or more LaborLevelDefinition tags Access Control Point Name: View Introduced in v4
Property Descriptions
AddAtTerminalFlag
446
Kronos Incorporated
LaborLevelDefinition Tag
MaxNameLength
447
Chapter 2
SortOrder
448
Kronos Incorporated
LaborLevelEntry Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddOnly" | "GetCountByLaborLevelWithFilter" | "GetCountsByLaborLevel" | "Load" | "LoadByWildcard" | "Update" | "UpdateOnly" Parameters GetCountByLaborLevelWithFilter LaborLevelDefinitionName = String Wildcard = String LoadByWildcard LaborLevelDefinitionName = String WildCard = String
449
Chapter 2
Properties <LaborLevelEntry [Description = String] [InactiveFlag = Boolean] LaborLevelDefinitionName = String LaborLevelEntryName = String NewName = String > </LaborLevelEntry>
Action Descriptions
AddOnly Adds a new labor level entry Return Value Type: None Required Properties: LaborLevelEntryName, LaborLevelDefinitionName Access Control Point Name: Edit Introduced in v4 GetCountByLaborLevelWithFilter Returns the number of visible labor level entries for the specified level Return Value Type: SimpleValue tag Access Control Point Name: View Introduced in v4
Action Parameters Parameter Name Description Additional information Introduced in v5.1 Introduced in v4.0 Required
GetCountsByLaborLevel Returns the number of labor level entries for each labor level in the system
450
Kronos Incorporated
LaborLevelEntry Tag
Return Value Type: Zero or more SimpleValue tags Access Control Point Name: View Introduced in v4 Load Returns the specified labor level entry Return Value Type: LaborLevelEntry tag Required Properties: LaborLevelEntryName, LaborLevelDefinitionName Access Control Point Name: View Introduced in v4 LoadByWildcard Returns the labor level entries that match the wildcard name or description pattern for the specified labor level definition Return Value Type: Zero or more LaborLevelEntry tags Required Properties: None Access Control Point Name: View Introduced in v4
Action Parameters Parameter Name Description Additional information Introduced in v4 Introduced in v4
LaborLevelDefinitionNa The name of the labor level definition me Required WildCard The pattern with which to search the description field Required
Update Adds a new labor level entry or updates an existing one Return Value Type: None Required Properties: LaborLevelEntryName, LaborLevelDefinitionName
451
Chapter 2
Access Control Point Name: Edit Introduced in v4 UpdateOnly Updates an existing labor level entry Return Value Type: None Required Properties: LaborLevelEntryName, LaborLevelDefinitionName Access Control Point Name: Edit Introduced in v4
Property Descriptions
Description
Description
Contains text that describes the labor level entry specified in LaborLevelEntryName. It is ignored when you inactivate or reactivate a labor level entry. Type: String Optional Maximum length: 250 characters Introduced in v4 InactiveFlag
452
Kronos Incorporated
LaborLevelEntry Tag
LaborLevelDefinitionName
453
Chapter 2
LaborLevelEntryName 402 has a corresponding Description value of Welding LaborLevelEntryName 403 has a corresponding Description value of Painting LaborLevelEntryName 404 has a corresponding Description value of Inspection
Type: String Optional Key Maximum length: 50 characters Introduced in v4; last changed in v5.0 NewName
454
Kronos Incorporated
LaunchHistory Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAll" | "RetrieveByDate" | "RetrieveByDatePerson" | "RetrieveByPerson" | "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
455
Chapter 2
Action Descriptions
RetrieveAll Retrieve all existing LaunchHistory. No properties are required. Return Value Type: Zero or more LaunchHistory tags Access Control Point Name: View Introduced in v6.0 RetrieveByDate Retrieve all the launch history for a specific date. Will throw an exception if the date string is invalid Return Value Type: Zero or more LaunchHistory tags Access Control Point Name: View Introduced in v6.0
Action Parameters Parameter Name Date Description String for the date. Required Additional information Introduced in v6.0; last changed in v6.0
RetrieveByDatePerson Retrieve all the launch history for a specific employee on a date. Return Value Type: Zero or more LaunchHistory tags Access Control Point Name: View Introduced in v6.0
456
Kronos Incorporated
LaunchHistory Tag
Action Parameters Parameter Name Date Person Description String for the date. Required The name of the person employee. Required Additional information Introduced in v6.0; last changed in v6.0 Introduced in v6.0; last changed in v6.0
RetrieveByPerson Retrieve all the launch history for a specific employee. Return Value Type: Zero or more LaunchHistory tags Access Control Point Name: View Introduced in v6.0
Action Parameters Parameter Name Person Description The name of the employee. Required Additional information Introduced in v6.0; last changed 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. Return Value Type: Zero or more LaunchHistory tags Access Control Point Name: View Introduced in v6.0
457
Chapter 2
Action Parameters Parameter Name ProcedureSet Description The name of the procedure. Required Additional information Introduced in v6.0; last changed 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. Return Value Type: Zero or more LaunchHistory tags Access Control Point Name: View Introduced in v6.0
Action Parameters Parameter Name ProcedureSet UserName Description The name of the procedure set. Required The name of the user. Required Additional information Introduced in v6.0; last changed in v6.0 Introduced in v6.0; last changed in v6.0
RetrieveByUser Retrieve all the launch history for a specific user. Return Value Type: Zero or more LaunchHistory tags Access Control Point Name: View Introduced in v6.0
458
Kronos Incorporated
LaunchHistory Tag
Action Parameters Parameter Name UserName Description The user name of the LaunchHistory to retrieve. Required Additional information Introduced in v6.0; last changed in v6.0
459
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "LoadAssignable" Parameters None Properties <LicenseType (CategoryName = String) LicenseTypeName = String (LimitCount = Integer) (InUseCount = Integer) (AvailableCount = Integer) > </LicenseType>
Action Descriptions
460
Kronos Incorporated
LicenseType Tag
Load Returns the category and count information associated with the specified license type. The license type name must be specified and identify an existing license within the system. Return Value Type: LicenseType tag Required Properties: LicenseTypeName Access Control Point Name: View 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 Required Properties: None Access Control Point Name: View Introduced in v5.0
Property Descriptions
AvailableCount
License type
The name of the license category Type: String
461
Chapter 2
Type: String Optional Key Maximum length: 2 characters Specify @ to make no change to the existing license type. Enumerated value: @, 1, 2, 3, 5, 9, 10, 12
462
Kronos Incorporated
LicenseType Tag
463
Chapter 2
Syntax
Properties <LightWeightPerson (Name = String) PersonNumber = String > </LightWeightPerson>
Property Descriptions
Name
Person Name
This is output only. Type: String Output only This is output only. Introduced in v5.2 PersonNumber
Person Number
The PersonNumber of existing person. Type: String Required The PersonNumber of existing person.
464
Kronos Incorporated
LightWeightPerson Tag
465
Chapter 2
Syntax
Properties <LocationId NodeId = String > </LocationId>
Property Descriptions
NodeId
Node ID
An existing node in the Organizational Map Type: String Required You can find values in the Workforce Timekeeper user interface. Introduced in v5.0
466
Kronos Incorporated
LocationProfileSettings Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Add" | "AddOnly" | "Delete" | "DeleteOnly" | "Retrieve" | "RetrieveAll" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" | "UpdateOnly" Parameters None Properties <LocationProfileSettings [Description = String] SettingsName = String > <OrgPaths> <SimpleValue>* </OrgPaths> <SettingsParamValues> <SettingsParamValue>*
467
Chapter 2
</SettingsParamValues> </LocationProfileSettings>
Action Descriptions
Add Adds a pse settings object into the system. If the object already exists, an update will be performed. Return Value Type: None Required Properties: SettingsName, SettingsParamValues, OrgPaths Optional Properties: description Access Control Point Name: Edit 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. Return Value Type: None Required Properties: SettingsName, SettingsParamValues, OrgPaths Optional Properties: Description Access Control Point Name: Edit Introduced in v6.0 Delete Deletes a pse settings object from the system. If the object doesn't exists, no exception is thrown. Return Value Type: None Required Properties: SettingsName Access Control Point Name: Edit Introduced in v6.0
468
Kronos Incorporated
LocationProfileSettings Tag
DeleteOnly Deletes a pse settings object from the system. If the object doesn't exist, an exception is thrown. Return Value Type: None Required Properties: SettingsName Access Control Point Name: Edit Introduced in v6.0 Retrieve Returns the pse setting object by name. Return Value Type: (***undefined***): PSESettings Required Properties: SettingsName Access Control Point Name: View Introduced in v6.0 RetrieveAll Returns all the pse settings objects. Return Value Type: (***undefined***): PSESettings Access Control Point Name: View Introduced in v6.0 RetrieveAllForUpdate Returns all pse settings objects. The ouput will be used as input by the update method by the SDM. Return Value Type: (***undefined***): PSESettings Access Control Point Name: View Introduced in v6.0 RetrieveAllNames Returns all pse settings objects names. Return Value Type: String list Access Control Point Name: View
469
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. Return Value Type: (***undefined***): PSESettings Required Properties: SettingsName Access Control Point Name: View Introduced in v6.0 Update Updates a pse settings object into the system. If the obejct doesn't exists, an exception is thrown. Return Value Type: None Required Properties: SettingsName, SettingsParamValues, OrgPaths Optional Properties: Description Access Control Point Name: Edit Introduced in v6.0 UpdateOnly Updates a pse settings objects into the system. If the object doesn't exists, an exception is thrown. Return Value Type: None Required Properties: SettingsName, SettingsParamValues, OrgPaths Optional Properties: Description Access Control Point Name: Edit Introduced in v6.0
Property Descriptions
Description
Description
470
Kronos Incorporated
LocationProfileSettings Tag
The pse settings object's description. Type: String Optional Sample values: <Description> This is a description</Description> Introduced in v6.0 OrgPaths
Settings Name
The pse settings object name. Type: String Required Key Sample values: <SettingsName> PSESettingsName</SettingsName> Introduced in v6.0
471
Chapter 2
SettingsParamValues
472
Kronos Incorporated
LockedDataCorrection Tag
Syntax
Properties <LockedDataCorrection (Date = Date) > (<Employee> <CurrentUser> | <PersonIdentity> </Employee>) (<Totals> <Total>* </Totals>) </LockedDataCorrection>
Property Descriptions
Date
Date
473
Chapter 2
The date on which the edit is credited Type: Date Output Only Sample values: 8:00 Vacation on 4/2/2001 Introduced in v4 Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, to whom the amount is credited. Type: Either CurrentUser or PersonIdentity tag Output Only Must uniquely identify an existing and active employee Introduced in v4 Totals
Totals
The totals constituting the correction Type: Zero or more Total tags Output Only Introduced in v4
474
Kronos Incorporated
LogonProfile Tag
Syntax
Request <Request Action = Actions 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.
475
Chapter 2
Return Value Type: LogonProfile tag Required Properties: LogonProfileName Access Control Point Name: View Introduced in v4; last changed in v5.0 LoadAllLogonProfiles Returns all assignable logon profiles in the system. Only logon profiles with a database key of -1 or greater shall be returned. Return Value Type: Zero or more LogonProfile tags Required Properties: None Access Control Point Name: View Introduced in v4; last changed in v5.0 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 Access Control Point Name: View Introduced in v4; last changed in v5.0
Property Descriptions
LogonProfileId
Logon profile Id
Uniquely identifies the logon profile in the database Type: Integer Optional Introduced in v4
476
Kronos Incorporated
LogonProfile Tag
LogonProfileName
Type: String Optional Maximum length: 50 characters Sample values: MobileTime Logon Default value: &DEFAULT_LOGON Introduced in v4
477
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "LoadAll" Parameters None Properties <ManagerRoleAvailabilityPatternProfile AvailabilityPatternProfileName = String (Description = 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
478
Kronos Incorporated
ManagerRoleAvailabilityPatternProfile Tag
Access Control Point Name: View Introduced in v5.0 LoadAll Load all of the AvailabilityPattern profiles in the database. Return Value Type: Zero or more ManagerRoleAvailabilityPatternProfile tags Access Control Point Name: View Introduced in v5.0; last changed in v5.0
Property Descriptions
AvailabilityPatternProfileName
Description
Description of the profile Type: String Output only Maximum length: 250 characters Introduced in v5.0 IsAllowAll
479
Chapter 2
Type: Boolean Output only Enumerated value: True, False Introduced in v5.0; last changed in v5.0
480
Kronos Incorporated
ManagerRoleScheduleGroupProfile Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "LoadAll" Parameters None Properties <ManagerRoleScheduleGroupProfile (Description = String) (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
481
Chapter 2
Access Control Point Name: View Introduced in v5.0; last changed in v5.1 LoadAll Load all of the Schedule Group Profiles in the database. Return Value Type: Zero or more ManagerRoleScheduleGroupProfile tags Access Control Point Name: View Introduced in v5.0; last changed in v5.1
Property Descriptions
Description
Description
Description of the profile. Type: String Output only Introduced in v5.0 IsAllowAll
482
Kronos Incorporated
ManagerRoleScheduleGroupProfile Tag
Type: String Optional Key Maximum length: 50 characters Introduced in v5.0; last changed in v5.0
483
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "LoadAll" Parameters None Properties <ManagerRoleSchedulePatternProfile (Description = String) (IsAllowAll = Boolean) 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
484
Kronos Incorporated
ManagerRoleSchedulePatternProfile Tag
Access Control Point Name: View Introduced in v5.0 LoadAll Load all of the SchedulePattern profiles in the database. Return Value Type: Zero or more ManagerRoleSchedulePatternProfile tags Access Control Point Name: View Introduced in v5.0; last changed in v5.0
Property Descriptions
Description
Description
Description of the profile Required: For a load action Type: String Output only Maximum length: 30 characters Introduced in v5.0 IsAllowAll
485
Chapter 2
The name of SchedulePatternProfile Type: String Optional Key Maximum length: 250 characters Introduced in v5.0
486
Kronos Incorporated
ManagerRoleShiftCodeProfile Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "LoadAll" Parameters None Properties <ManagerRoleShiftCodeProfile (Description = String) (IsAllowAll = Boolean) 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
487
Chapter 2
Access Control Point Name: View Introduced in v5.0 LoadAll Load all of the ShiftCode profiles in the database. Return Value Type: Zero or more ManagerRoleShiftCodeProfile tags Access Control Point Name: View Introduced in v5.0; last changed in v5.0
Property Descriptions
Description
Description
Description of the profile Type: String Output only Introduced in v5.0 IsAllowAll
488
Kronos Incorporated
ManagerRoleShiftCodeProfile Tag
489
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Update" Parameters None Properties <MarkForTotalization [RuleChangedFlag = Boolean] [ScheduleChangedFlag = Boolean] > <Employee> <CurrentUser> | <PersonIdentity> </Employee> </MarkForTotalization>
Action Descriptions
Update Updates the specified flag or flags for the employee. Return Value Type: None Required Properties: Employee
490
Kronos Incorporated
MarkForTotalization Tag
Optional Properties: RuleChangeFlag, ScheduleChangedFlag Access Control Point Name: Edit Introduced in v4
Property Descriptions
Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, to be marked for totalization Type: Either CurrentUser or PersonIdentity tag Required Key Must uniquely identify an existing and active employee Introduced in v4 RuleChangedFlag
491
Chapter 2
Default value: False Enumerated value: True, False Introduced in v4; last changed in v5.0
492
Kronos Incorporated
Menu Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" Parameters None Properties <Menu (<MenuItems> <MenuItem>* </MenuItems>) <User> <CurrentUser> | <PersonIdentity> </User> </Menu>
Action Descriptions
Load Returns a list of menu items for the specified user or the currently logged-on user. Return Value Type: Menu tag
493
Chapter 2
Property Descriptions
MenuItems
Menu items
A list of menu items for the user Type: Zero or more MenuItem tags Output Only Introduced in v4 User
User
One person, as specified in a PersonIdentity or CurrentUser tag, to whom the menu is assigned Type: Either CurrentUser or PersonIdentity tag Optional Key Default value: Logged on user Introduced in v4
494
Kronos Incorporated
MenuItem Tag
Syntax
Properties <MenuItem (AccessControlPointName = String) (Depth = Integer) (ExternalFlag = Boolean) (Label = String) (MenuItemName = String) (URL = String) > </MenuItem>
Property Descriptions
AccessControlPointName
495
Chapter 2
Depth of this item in the menu Type: Integer Output Only Must be greater than or equal to 0 Introduced in v4 ExternalFlag
Menu item
Name of the menu item Type: String Output Only Introduced in v4
496
Kronos Incorporated
MenuItem Tag
URL
497
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" Parameters None Properties <MinimunHoursNoModification (MinimunHoursRequired = Time) (IsBeyondMinimunHours = Boolean) QueryDate = Date StartTime = Time > </MinimunHoursNoModification>
Action Descriptions
498
Kronos Incorporated
MinimunHoursNoModification Tag
Load This action determines whether the request is made at an acceptable time. Return Value Type: MinimunHoursNoModification tag Required Properties: QueryDate, StartTime Access Control Point Name: View Introduced in v5.1Beta
Property Descriptions
IsBeyondMinimunHours
Start date
The date when the request is submitted
499
Chapter 2
Start time
The time of day when the shift begins Type: Time Required Introduced in v5.1Beta
500
Kronos Incorporated
NameList Tag
Syntax
Properties <NameList (PropertyName = String) > (<Names> </Names>) </NameList>
Property Descriptions
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 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
501
Chapter 2
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
502
Kronos Incorporated
Names Tag
Syntax
Properties <Names (<SimpleValues> <SimpleValue>* </SimpleValues>) </Names>
Property Descriptions
SimpleValues
503
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Delete" | "Retrieve" | "RetrieveAll" | "RetrieveAllNames" | "RetrieveForUpdate" | "RetrieveForUpdateFactory" | "Update" Parameters None Properties <NavProfile [Active = String] [HomePagePath = String] [Description = String] Name = String [Type = String] [RootNodePath = String] [LegacyHomePage = String] > </NavProfile>
504
Kronos Incorporated
NavProfile Tag
Action Descriptions
Delete Deletes the named NavProfile. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v6.0 Retrieve Retrieves the NavProfile item Return Value Type: NavProfile tag Required Properties: Name Access Control Point Name: View Introduced in v6.0; last changed in v6.0 RetrieveAll Retrieves all the NavProfiles in the system. Return Value Type: Zero or more NavProfile tags Required Properties: None Access Control Point Name: View Introduced in v6.0; last changed in v6.0 RetrieveAllNames Retrieves the names of all the NavProfiles in the system. Required method for Setup Data Manager. Return Value Type: String list Required Properties: None Access Control Point Name: View Introduced in v6.0
505
Chapter 2
RetrieveForUpdate Retrieves the named NavProfile for update. Method required for Setup Data Manager. Return Value Type: NavProfile tag Required Properties: Name Access Control Point Name: Edit Introduced in v6.0 RetrieveForUpdateFactory Retrieves the named NavProfile for updating. Return Value Type: NavProfile tag Required Properties: Name Access Control Point Name: Edit Introduced in v6.0 Update Updates the profile or inserts a new NavProfile if it doesn't exist. Return Value Type: None Optional Properties: Name, Type, Active, LegacyHomePage, Description, RootNodePath, HomePagePath Access Control Point Name: Edit Introduced in v6.0; last changed in v6.0
Property Descriptions
Active
506
Kronos Incorporated
NavProfile Tag
true Default value: true Enumerated value: true, false Introduced in v6.0; last changed in v6.0 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
UsersHomePage'
Specify the page to load for advanced users when they log on. Type: String Optional Sample values: /QUICKFIND
507
Chapter 2
508
Kronos Incorporated
NavProfile Tag
Default value: Basic Enumerated value: Advanced, Basic Introduced in v6.0; last changed in v6.0
509
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddComment" | "AddOnly" | "Delete" Parameters AddOnly [AccrualOverride = Boolean] [allowAdHoc = Boolean] [EchoData = Boolean] Properties <NonCancellingPayCodeEdit AmountInTimeOrCurrency = String ScheduleAmountType = String OrgJobId = String OrgJobName = String [CommentText = String] (EnteredOnDate = Date) Date = Date (IsCurrencyFlag = Boolean)
510
Kronos Incorporated
NonCancellingPayCodeEdit Tag
LaborAccountName = String [ManagerName = String] [OverrideAccrualDays = Double] PayCodeName = String [StartTime = Time] (EnteredOnTime = Time) > [<Notes> <Note>* </Notes>] (<Comments> <Comment>* </Comments>) <Employee> <CurrentUser> | <PersonIdentity> </Employee> </NonCancellingPayCodeEdit>
Action Descriptions
AddComment Adds a comment to each pay code edit associated with the specified employee. The CommentText must exactly match an entry in the Comment table. Return Value Type: None Required Properties: AmountInTimeOrCurrency, CommentText, Date, Employee, PayCodeName Access Control Point Name: Edit Introduced in v4 AddOnly Adds a new pay code edit with the specified properties. Return Value Type: PayCodeEdit tag Required Properties: AmountInTimeOrCurrency, Date, Employee, PayCodeName Access Control Point Name: Edit Introduced in v4
511
Chapter 2
Action Parameters Parameter Name AccrualOverride Description If the action results in an accrual warning, the warning is overridden when AccrualOverride=True. Optional Default value: False Specifies whether an ad hoc labor level is allowed. Optional Default value: False If True, the Response includes a copy of this tag. Optional Default value: False Additional information Introduced in v4
allowAdHoc
Introduced in v5.0; last changed in v5.0; deprecated in v5.0. Not used Introduced in v4
EchoData
Delete Marks for deletion all pay code edits for the employee with matching properties. Return Value Type: None Required Properties: AmountInTimeOrCurrency, Date, Employee, PayCodeName Access Control Point Name: Edit Introduced in v4
Property Descriptions
AmountInTimeOrCurrency
512
Kronos Incorporated
NonCancellingPayCodeEdit Tag
Whether the value is expressed as a time duration or a currency depends on the pay code. Introduced in v4; last changed in v5.1 ScheduleAmountType
ID of job in organization
ID of job in organization Type: String Introduced in v6.0 OrgJobName
Comments
The set of comments currently returned with this timekeeping item Type: Zero or more Comment tags Output Only Introduced in v4 CommentText
Comment text
513
Chapter 2
A comment Type: String Optional Maximum length: 254 characters The comment must match exactly an applicable comment that already exists in the database. The string matching is case-sensitive. You can find values in the Workforce Timekeeper Setup Application. Introduced in v4; last changed in v5.0 Date
Employee
One employee to be credited with the amount, 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 EnteredOnDate
514
Kronos Incorporated
NonCancellingPayCodeEdit Tag
The server date on which the edit is added to the database Type: Date Output Only Introduced in v4 EnteredOnTime
Labor account
The name of the labor account. LaborAccountName is required when the pay code edit, historical edit, or totaled amount being deleted or commented contained an explicit value. It need not be specified if the pay code amount or totaled amount applies to the employee's primary account. Enter data for labor accounts in the same format as they appear in the timekeeping 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.
515
Chapter 2
Do not specify labor levels that are not changing. If any of the labor levels are the same as the employee's primary labor account, you can enter @H for those labor levels instead of entering the labor entry names. Type: String Optional, Key Maximum length: 356 characters Default value: Primary account for the employee Introduced in v4; last changed in v5.0 ManagerName
Manager name
Manager Name Type: String Optional Introduced in v6.0 Notes
Comment Notes
Comment Notes Type: Zero or more Note tags Optional Introduced in v6.0 OverrideAccrualDays
516
Kronos Incorporated
NonCancellingPayCodeEdit Tag
PayCodeName
Pay code
The pay code to be edited. Type: String Required, Key Must be associated with an hourly or monetary pay code edit Introduced in v4; last changed in v5.1 StartTime
Start Time
Start Time Type: Time Optional Introduced in v6.0
517
Chapter 2
Syntax
Properties <Note Text = String [Timestamp = DateTime] > [<DataSource> <DataSource> </DataSource>] </Note>
Property Descriptions
DataSource
Data Source
Specify the person who created the note. Type: DataSource tag Optional Introduced in v6.0 Text
Note Text
Specify the text of the note. Type: String Required
518
Kronos Incorporated
Note Tag
Note Timestamp
Specify the time when you created the note. Type: DateTime Optional Introduced in v6.0
519
Chapter 2
Syntax
Properties <OnCall (AmountInTime = TimeDuration) (Date = Date) (LaborAccountName = String) > (<Employee> <CurrentUser> | <PersonIdentity> </Employee>) </OnCall>
Property Descriptions
AmountInTime
Date
520
Kronos Incorporated
OnCall Tag
The date on which the edit is credited Type: Date Output Only Sample values: 4/2/2001 Introduced in v4 Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, to be credited with the amount. Type: Either CurrentUser or PersonIdentity tag Output Only Must uniquely identify an existing and active employee Introduced in v4 LaborAccountName
Labor account
The labor account associated with the edit. If not specified in the PayCodeEdit tag, the employee's primary account is used. Type: String Output Only Maximum length:356 characters Introduced in v4; last changed in v5.0
521
Chapter 2
Syntax None
522
Kronos Incorporated
OpenShiftItem Tag
Syntax
Properties <OpenShiftItem (DATE_TIME_SPAN = DateTimeSpan) > </OpenShiftItem>
Property Descriptions
DATE_TIME_SPAN
523
Chapter 2
Syntax
Request <Request Action = Actions 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>
524
Kronos Incorporated
OpenShiftVolunteer Tag
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 Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1 GetOpenShiftsForJob This action will load all open shifts for a specified job within a specified date range. OrgJobPath must be a valid organization job path and QueryDate must be a valid date. Return Value Type: Zero or more OpenShiftItem tags Required Properties: QueryDate, OrgJobPath Access Control Point Name: View Introduced in v5.1; last changed in v5.1
Property Descriptions
Employee
Employee
This property represents the employee who requests the action to cover an open shift. Type: PersonIdentity tag
525
Chapter 2
Required Key It must be an active employee. Introduced in v5.1; last changed in v5.1 IsCheckRules
526
Kronos Incorporated
OpenShiftVolunteer Tag
OrgJobPath
527
Chapter 2
Optional Must be a valid date. Introduced in v5.1; last changed in v5.1 PartialStartTime
Query date
This property is used to query for open shifts in the specified date. Type: Date Optional Must be a valid date. Introduced in v5.1; last changed in v5.1 QueryDateTimeSpan
Rule violations
528
Kronos Incorporated
OpenShiftVolunteer Tag
This is a set of rule violations that was generated by the tag. Type: Zero or more RuleViolation tags Output only none Introduced in v5.1; last changed in v5.1
529
Chapter 2
Syntax
Properties <OptOutStatus [EffectiveDate = DateTime] [ExpirationDate = DateTime] [In = Boolean] WtdEmployeeAssgnmntId = Long > </OptOutStatus>
Property Descriptions
EffectiveDate
Effective Date
The date on which this status is effective. Type: DateTime Optional Introduced in v5.1
530
Kronos Incorporated
OptOutStatus Tag
ExpirationDate
Expiration Date
The date on which this status expires. Not used. Type: DateTime Optional Introduced in v5.1 In
531
Chapter 2
Syntax
Properties <OptOutStatusList [WtdAssignmentId = Long] > [<OptOutStatuses> <OptOutStatus>* </OptOutStatuses>] </OptOutStatusList>
Property Descriptions
OptOutStatuses
WTD Assignment Id
Set on insertion into WTDEmployeeAssignment. Not necessary to set. Type: Long
532
Kronos Incorporated
OptOutStatusList Tag
533
Chapter 2
Syntax
Request <Request Action = Actions 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 Access Control Point Name: Edit Introduced in v5.2; last changed in v5.2
534
Kronos Incorporated
OrgJob Tag
Syntax
Properties <OrgJob [FullPath = String] (NodeId = Long) > </OrgJob>
Property Descriptions
FullPath
Organizational node id
The id for the organizational node Type: Long Output only Introduced in v5.1Beta
535
Chapter 2
Syntax
Properties <OrgLocation [Description = String] [EndEffectiveDate = Date] [StartEffectiveDate = Date] [Seasonal = Boolean] [LLEntryName = String] ParentLocationNum = Long [LocationType = String] LocationNum = Long [LocationName = String] > [<OrgWorkAllocationEntryList> <OrgWorkAllocationEntry>* </OrgWorkAllocationEntryList>] </OrgLocation>
Property Descriptions
Description
Description
Describes the node.
536
Kronos Incorporated
OrgLocation Tag
Type: String Optional You can find values in the Workforce Timekeeper Setup Application. Sample values: Registered Nurse Introduced in v5.0 EndEffectiveDate
537
Chapter 2
LocationName
Node Id
A unique identifier for the node. Type: Long Required Key Maximum length: 12 Introduced in v5.0 LocationType
Location type
The category of the node in the organization. Type: String Optional You can find values in the Workforce Timekeeper user interface. Required: If you add a new node, you must specify an already existing LocationType. Sample values: Facility, Job, Division
538
Kronos Incorporated
OrgLocation Tag
539
Chapter 2
540
Kronos Incorporated
OrgLocationsImport Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Update" Parameters None Properties <OrgLocationsImport ChangeDate = Date > <OrgLocations> <OrgLocation>* </OrgLocations> </OrgLocationsImport>
Action Descriptions
Update Imports one or more organizational tree nodes. If a specified node already exists, it is updated. If it does not exist, it is added.
541
Chapter 2
If you are adding a node, you must specify existing LocationType and LocationName properties in the OrgLocation tag. Return Value Type: None Required Properties: ChangeDate, OrgLocations Access Control Point Name: Edit Introduced in v5.0
Property Descriptions
ChangeDate
Date of import
The date when the specified nodes are imported Type: Date Required Introduced in v5.0 OrgLocations
Organization locations
One or more organization locations Type: Zero or more OrgLocation tags Required Introduced in v5.0
542
Kronos Incorporated
OrgMapIntegration Tag
Syntax
Request <Request Action = Actions 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: Zero or more OrgMapIntegration tags Required Properties: None Access Control Point Name: View Introduced in v5.2 RetrieveAll Validation done in the KBO
543
Chapter 2
Validation done in the KBO Return Value Type: (***undefined***): OrgNodeIntegration Required Properties: Kdate Access Control Point Name: View Introduced in v5.2 RetrievePartial validation done in the KBO validation done in the KBO Return Value Type: (***undefined***): OrgNodeIntegration Required Properties: Date, OrgPath, Depth Access Control Point Name: View Introduced in v5.2
544
Kronos Incorporated
OrgSet Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddOnly" | "Load" | "Update" | "UpdateEntryList" | "UpdateOnly" Parameters None Properties <OrgSet [Description = String] OrgSetName = String [OrgSetTypeName = String] [Name = String] (OrgSetId = Long) > [<EntryList>
545
Chapter 2
Action Descriptions
AddOnly Adds a new organizational set. Return Value Type: None Required Properties: OrgSetName,OrgSetTypeName, EntryList, Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0 Load Returns information for all organization sets. When type is not specified, orgsetids and effectiveDate are required when type is "orgJobs". Return Value Type: Zero or more OrgSet tags Required Properties: orgsetName Optional Properties: TYPE, orgsetids, effectiveDate, fullPath Access Control Point Name: View Introduced in v5.0; last changed in v6.0 Update Adds a new organizational set or updates an existing one. When adding a new organizational set, Description, orgSetTypeName and EntryList are required. Return Value Type: None Required Properties: orgsetName Optional Properties: Description, OrgSetTypeName, EntryList Access Control Point Name: Edit Introduced in v5.0
546
Kronos Incorporated
OrgSet Tag
UpdateEntryList Updates all jobs in the organizational set. Return Value Type: None Required Properties: OrgSetName, EntryList Invalid Properties: Description, OrgSetTypeName Access Control Point Name: Edit Introduced in v6.0 UpdateOnly Updates information for an existing organization set. Return Value Type: None Required Properties: OrgSetName Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0
Property Descriptions
Description
Description
Describes the organization set, which consists of locations and jobs. Type: String Optional You can find values in the Workforce Timekeeper user interface. Introduced in v5.0 EntryList
547
Chapter 2
Jobs in set
One or more jobs in the organization job set Type: Zero or more OrgSetJob tags Output only Introduced in v5.0; last changed in v5.0 OrgSetName
548
Kronos Incorporated
OrgSet Tag
549
Chapter 2
Syntax
Properties <OrgSetEntry EffectiveDate = Date (OrgId = Long) [AddEntries = String] [Name = String] [ReplaceEntries = String] > </OrgSetEntry>
Property Descriptions
AddEntries
Effective date
The date when the specified jobs become effective
550
Kronos Incorporated
OrgSetEntry Tag
551
Chapter 2
Syntax
Properties <OrgSetJob (OrgJobId = String) (OrgJobName = String) > </OrgSetJob>
Property Descriptions
OrgJobId
Job Id
A unique identifier for a job in the organization Type: String Output only You must have Functional Access for Job Transfers. A node with this Id must exist in the organizational structure. Introduced in v5.0; last changed in v5.0 OrgJobName
Job name
The full path of the job in the organization
552
Kronos Incorporated
OrgSetJob Tag
Note: OrgJobName string matching is case-sensitive on a server that connects to an Oracle database. Type: String Output only Maximum length: 1000 characters You must have Functional Access for Job Transfers. A node with this Id must exist in the organizational structure. Introduced in v5.0; last changed in v5.0
553
Chapter 2
Syntax
Properties <OrgWorkAllocationEntry OrgWorkPct = Integer OrgWorkTypeName = String > </OrgWorkAllocationEntry>
Property Descriptions
OrgWorkPct
554
Kronos Incorporated
OrgWorkAllocationEntry Tag
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
555
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddComment" | "ApproveAll" | "ApproveNone" | "ApproveSome" Parameters None Properties <OvertimeApproval [AmountInTime = TimeDuration] [CommentText = String] Date = Date (EnteredOnDate = Date) (EnteredOnTime = Time) > (<Comments> <Comment>* </Comments>) <Employee> <CurrentUser> | <PersonIdentity>
556
Kronos Incorporated
OvertimeApproval Tag
</Employee> </OvertimeApproval>
Action Descriptions
AddComment Adds a comment along with the action taken. Return Value Type: None Required Properties: Employee, Date, CommentText, AmountInTime Access Control Point Name: Edit Introduced in v4 ApproveAll Approve all overtime for the specified day. Return Value Type: None Required Properties: Employee, Date Access Control Point Name: Edit Introduced in v4; last changed in v5.1 ApproveNone Does not approve any overtime requested or submitted for the specified day. Return Value Type: None Required Properties: Employee, Date Access Control Point Name: Edit Introduced in v4; last changed in v5.1 ApproveSome Approve only a portion of the overtime hours that the employee submitted or requested. Return Value Type: None Required Properties: Employee, Date, AmountInTime Access Control Point Name: Edit
557
Chapter 2
Property Descriptions
AmountInTime
Comments
The set of comments currently returned with this timekeeping item Type: Zero or more Comment tags Output Only Introduced in v4 CommentText
Comment text
A comment Type: String Optional Maximum length: 254 characters The comment must match exactly an applicable comment that already exists in the database. The string matching is case-sensitive. You can find values in the Workforce Timekeeper Setup Application.
558
Kronos Incorporated
OvertimeApproval Tag
Introduced in v4 Date
Date of overtime
The date for which the overtime hours are being approved Type: Date Required Key Introduced in v4 Employee
Employee
One employee for whom overtime hours are to be approved, as specified in a PersonIdentity or CurrentUser tag. Type: Either CurrentUser or PersonIdentity tag Required Key Must uniquely identify an existing and active employee Introduced in v4 EnteredOnDate
559
Chapter 2
Introduced in v4
560
Kronos Incorporated
PasswordHistory Tag
Syntax
Properties <PasswordHistory (EffectiveDateTime = DateTime) (Password = Password) > </PasswordHistory>
Property Descriptions
EffectiveDateTime
Password
Encrypted password of the user account Type: Password Output Only Introduced in v4; last changed in v5.0
561
Chapter 2
Syntax
Properties <PatternElement AmountInCurrency = Currency AmountInTime = TimeDuration PayCodeName = String ShiftCodeName = String (CommentText = String) DayNumber = Integer [DisplayTime = Time] > (<Comments> <Comment>* </Comments>) </PatternElement>
Property Descriptions
PayCodeName
562
Kronos Incorporated
PatternElement Tag
Introduced in v4 ShiftCodeName
Comments
User comments
563
Chapter 2
Type: Zero or more Comment tags Output only Introduced in v5.0 CommentText
Comment text
A text string that is returned Type: String Output only Maximum length: 254 characters Introduced in v5.0 DayNumber
564
Kronos Incorporated
PatternElement Tag
AccrualAmount AccrualAmount Optional Group includes: AmountInCurrency, AmountInTime PatternElementCode A Schedule Pattern element is either a Shift or PayCode Required Group includes: PayCodeName, ShiftCodeName
565
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "LoadAllPayCodes" Parameters None Properties <PayCode (ManagerAccessFlag = Boolean) (IsVisibleFlag = Boolean) (ProfessionalAccessFlag = Boolean) (ExcuseAbsenceFlag = Boolean) (IsCombinedFlag = Boolean) (IsCurrencyFlag = Boolean) (DisplayOrder = Integer) (PayCodeName = String) > </PayCode>
Action Descriptions
566
Kronos Incorporated
PayCode Tag
LoadAllPayCodes Returns a list of all pay codes. Return Value Type: Zero or more PayCode tags Required Properties: None Access Control Point Name: View Introduced in v4
Property Descriptions
DisplayOrder
567
Chapter 2
568
Kronos Incorporated
PayCode Tag
PayCodeName
Pay code
Name of the pay code Type: String Output Only Introduced in v4 ProfessionalAccessFlag
569
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddComment" | "AddOnly" | "Delete" Parameters AddOnly [AccrualOverride = Boolean] [allowAdHoc = Boolean] [EchoData = Boolean] Properties <PayCodeEdit ScheduleAmountType = String AmountInTimeOrCurrency = String OrgJobId = String OrgJobName = String [CommentText = String] (EnteredOnDate = Date) Date = Date (IsCurrencyFlag = Boolean) LaborAccountName = String [ManagerName = String]
570
Kronos Incorporated
PayCodeEdit Tag
[OverrideAccrualDays = Double] PayCodeName = String [StartTime = Time] (EnteredOnTime = Time) > [<Notes> <Note>* </Notes>] (<Comments> <Comment>* </Comments>) <Employee> <CurrentUser> | <PersonIdentity> </Employee> </PayCodeEdit>
Action Descriptions
AddComment Adds a comment to each pay code edit associated with the specified employee. Depending on the type of edit, you may need to specify LaborAccountName. Return Value Type: None Required Properties: AmountInTimeOrCurrency, CommentText, Date, Employee, PayCodeName Access Control Point Name: Edit Introduced in v4 AddOnly Adds a new pay code edit with the specified properties. Return Value Type: PayCodeEdit tag Required Properties: AmountInTimeOrCurrency, Date, Employee, PayCodeName Access Control Point Name: Edit Introduced in v4
571
Chapter 2
Action Parameters Parameter Name AccrualOverride Description If the action results in an accrual warning, the warning is overridden when AccrualOverride=True. Optional Default value: False Specifies whether an ad hoc labor level is allowed. Optional Default value: False If True, the Response includes a copy of this tag. Optional Default value: False Additional information Introduced in v4
allowAdHoc
Introduced in v5.0; last changed in v5.0; deprecated in v5.0. Not used Introduced in v4
EchoData
Delete Marks for deletion all pay code edits for the employee with matching properties. Return Value Type: None Required Properties: AmountInTimeOrCurrency, Date, Employee, PayCodeName Access Control Point Name: Edit Introduced in v4
Property Descriptions
ScheduleAmountType
572
Kronos Incorporated
PayCodeEdit Tag
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
Type: String Maximum length: 1 character Enumerated value: 1 , 2 Introduced in v4.3; last changed in v5.0 AmountInTimeOrCurrency
Type: String Maximum length: 30 characters Introduced in v4; last changed in v5.0 OrgJobId
ID of job in organization
A unique identifier for a job in the organization Type: String Default value: Null Introduced in v5.0 OrgJobName
573
Chapter 2
The name of the organizational job path for the employee whose pay code amount or totaled amount is being edited. It is optional when you add a pay code, historical edit, or totaled amount. It is not used if the punch applies to the employee's primary organizational job. Enter data for OrgJobName in the same format as it appears in the database. Note: OrgJobName string matching is case-sensitive on a server that connects to an Oracle database. Type: String Maximum length: 1000 characters You must have Functional Access for Job Transfers. A node with this Id must exist in the organizational structure. Default value: Null Introduced in v5.0 Comments
Comments
The set of comments currently returned with this timekeeping item Type: Zero or more Comment tags Output Only Introduced in v4 CommentText
Comment text
A 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 Maximum length: 254 characters
574
Kronos Incorporated
PayCodeEdit Tag
Must match exactly an applicable comment that already exists in the database. The string matching is case-sensitive. You can find values in the Workforce Timekeeper Setup Application. Introduced in v4 Date
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, to be credited with the amount. Type: Either CurrentUser or PersonIdentity tag Required, Key Must uniquely identify an existing and active employee Introduced in v4; last changed in v5.0 EnteredOnDate
575
Chapter 2
EnteredOnTime
Labor account
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 being deleted or commented contained an explicit value. It need not be specified if the pay code amount or totaled amount applies to the employee's primary account. Enter data for labor accounts in the same format as they appear in the 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. 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.
576
Kronos Incorporated
PayCodeEdit Tag
Type: String Optional, Key Maximum length: 356 characters Default value: Primary account for the employee Introduced in v4; last changed in v5.0 ManagerName
Manager name
The name that replaces the user name in audit. Type: String Optional Maximum length: 70 characters Introduced in v5.0a Notes
Comment Notes
The list of notes for the comment to be created from comment text Type: Zero or more Note tags Optional Introduced in v6.0 OverrideAccrualDays
577
Chapter 2
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 to a historical amount. This is always required when importing a pay code edit or a historical edit. A pay code represents an amount in time or 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
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
578
Kronos Incorporated
PayCodeEdit Tag
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
579
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddComment" | "AddOnly" | "Delete" Parameters AddOnly [AccrualOverride = Boolean] [allowAdHoc = Boolean] [EchoData = Boolean] Properties <PayCodeMove OrgJobId = String OrgJobName = String AmountInTimeOrCurrency = String [CommentText = String] Date = Date (EnteredOnDate = Date) [LaborAccountName = String] FromLaborAccountName = String [ManagerName = String] PayCodeName = String FromPayCodeName = String
580
Kronos Incorporated
PayCodeMove Tag
(EnteredOnTime = Time) > [<Notes> <Note>* </Notes>] (<Comments> <Comment>* </Comments>) <Employee> <CurrentUser> | <PersonIdentity> </Employee> </PayCodeMove>
Action Descriptions
AddComment Adds a comment to the set of comments associated with the pay code move item. Return Value Type: None Required Properties: AmountInTimeOrCurrency, CommentText, Date, FromLaborAccountName, FromPayCodeName, PayCodeName Access Control Point Name: Edit Introduced in v4 AddOnly Adds a new pay code move item with the specified properties. Return Value Type: PayCodeMove tag Required Properties: AmountInTimeOrCurrency, Date, FromLaborAccountName, FromPayCodeName, PayCodeName Access Control Point Name: Edit Introduced in v4
581
Chapter 2
Action Parameters Parameter Name AccrualOverride Description If the action results in an accrual warning, the warning is overridden when AccrualOverride=True. Optional Default value: False Specifies whether an ad hoc labor level is allowed. Optional Default value: False If True, the Response includes a copy of this tag Optional Default value: False Additional information Introduced in v4
allowAdHoc
Introduced in v5.0; last changed in v5.0; deprecated in v5.0. Not used Introduced in v4
EchoData
Delete Marks for deletion an existing pay code move item. Return Value Type: None Required Properties: AmountInTimeOrCurrency, Date, FromLaborAccountName, FromPayCodeName, PayCodeName Access Control Point Name: Edit Introduced in v4
Property Descriptions
OrgJobId
ID of job in organization
A unique identifier for a job in the organization Type: String Default value: Null
582
Kronos Incorporated
PayCodeMove Tag
Comments
The set of comments currently returned with this timekeeping item Type: Zero or more Comment tags
583
Chapter 2
Comment text
A comment Type: String Optional Maximum length: 254 characters Must match exactly an applicable comment that already exists in the database. The string matching is case-sensitive. You can find values in the Workforce Timekeeper Setup Application. Introduced in v4 Date
Date
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 PersonIdentity or CurrentUser tag. Type: Either CurrentUser or PersonIdentity tag Required, Key Must uniquely identify an existing and active employee Introduced in v4
584
Kronos Incorporated
PayCodeMove Tag
EnteredOnDate
585
Chapter 2
Maximum length: 356 characters Default value: Primary account for the employee Introduced in v4; last changed in v5.0 FromPayCodeName
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 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. Do not specify labor levels that are not changing. If any of the labor levels are the same as the employee's primary labor account, you can enter @H for those labor levels instead of entering the labor entry names. Type: String Optional Maximum length: 356 characters Default value: Primary account for the employee
586
Kronos Incorporated
PayCodeMove Tag
Manager Name
The name to replace the user name in audit. Type: String Optional Maximum length: 70 characters Introduced in v5.0a Notes
Comment Notes
The list of notes for the comment to be created from comment text Type: Zero or more Note tags Optional Introduced in v6.0 PayCodeName
Pay code
The pay code to be credited with the moved amount Type: String Required, Key Maximum length: 50 characters Introduced in v4
587
Chapter 2
588
Kronos Incorporated
PayCodeProfile Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "LoadAllPayCodeProfiles" | "LoadById" | "LoadPayCodesForProfileName" Parameters None Properties <PayCodeProfile [PayCodeProfileId = Integer] [PayCodeProfileName = String] > </PayCodeProfile>
Action Descriptions
589
Chapter 2
Load Returns a pay code profile, based on PayCodeProfileName. Name should be valid Return Value Type: PayCodeProfile tag Required Properties: PayCodeProfileName Access Control Point Name: View Introduced in v4 LoadAllPayCodeProfiles Returns a list of all pay code profiles in the system. Return Value Type: Zero or more PayCodeProfile tags Required Properties: None Access Control Point Name: View Introduced in v4 LoadById Returns a pay code profile, based on PayCodeProfileId. ID must be valid Return Value Type: PayCodeProfile tag Required Properties: PayCodeProfileId Access Control Point Name: View 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 Access Control Point Name: View Introduced in v5.1
590
Kronos Incorporated
PayCodeProfile Tag
Property Descriptions
PayCodeProfileId
591
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddOnly" | "Delete" Parameters None Properties <PayFromSchedule [CommentText = String] EndDate = Date StartDate = Date > <Employee> <PersonIdentity> </Employee> </PayFromSchedule>
Action Descriptions
592
Kronos Incorporated
PayFromSchedule Tag
AddOnly Adds a record to the timesheet that identifies an employee and a time period when pay is based on a schedule. The employee must exist. Return Value Type: None Required Properties: Employee, StartDate, EndDate Access Control Point Name: Edit Introduced in v4 Delete Marks all existing pay from schedule items for deletion for the specified employee and time span. Return Value Type: None Required Properties: Employee, StartDate, EndDate Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0
Property Descriptions
CommentText
Comment text
A comment Type: String Optional Maximum length: 254 characters Must match exactly an applicable comment that already exists in the database. The string matching is case-sensitive. You can find values in the Workforce Timekeeper Setup Application. Introduced in v4
593
Chapter 2
Employee
Employee
One employee who is paid from a schedule, as specified in a PersonIdentity tag. Type: PersonIdentity tag Required Must uniquely identify an existing and active employee Introduced in v4 EndDate
End date
The end date of the schedule period Type: Date Required Introduced in v4 StartDate
Start date
The start date of the schedule period Type: Date Required Introduced in v4
594
Kronos Incorporated
PayFromScheduleStopEvent Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddOnly" | "Delete" Parameters None Properties <PayFromScheduleStopEvent [CommentText = String] 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.
595
Chapter 2
Return Value Type: None Required Properties: Employee, Date Access Control Point Name: Edit Introduced in v4 Delete Marks the record to stop an employee from being paid according to the schedule for deletion. The employee must exist Return Value Type: None Required Properties: Employee, Date Access Control Point Name: Edit Introduced in v5.0
Property Descriptions
CommentText
Comment text
A comment Type: String Optional Maximum length: 254 characters Must match exactly an applicable comment that already exists in the database. The string matching is case-sensitive. You can find values in the Workforce Timekeeper Setup Application. Introduced in v4 Date
Date of event
596
Kronos Incorporated
PayFromScheduleStopEvent Tag
The date when the event occurred employee that caused payment to be stopped. An example of such an event is an absence. Type: Date Required Introduced in v4 Employee
Employee
One employee, as specified in a PersonIdentity tag, who is paid from schedule and was absent. Type: PersonIdentity tag Required Must uniquely identify an existing and active employee Introduced in v4
597
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "LoadAllPayRuleProfiles" | "LoadById" Parameters None Properties <PayRuleProfile [PayRuleProfileId = Integer] [PayRuleProfileName = String] > </PayRuleProfile>
Action Descriptions
598
Kronos Incorporated
PayRuleProfile Tag
Load Returns a pay rule profile, based on PayRuleProfileName. Return Value Type: PayRuleProfile tag Required Properties: PayRuleProfileName Access Control Point Name: View Introduced in v4 LoadAllPayRuleProfiles Returns a list of all pay rule profiles in the system. Return Value Type: Zero or more PayRuleProfile tags Required Properties: None Access Control Point Name: View Introduced in v4 LoadById Returns a pay rule profile, based on PayRuleProfileId. Return Value Type: PayRuleProfile tag Required Properties: PayRuleProfileId Access Control Point Name: View Introduced in v4
Property Descriptions
PayRuleProfileId
599
Chapter 2
PayRuleProfileName
600
Kronos Incorporated
PeriodTotals Tag
Syntax
Properties <PeriodTotals (PeriodDateSpan = DateSpan) > (<Totals> <TotalSummary> </Totals>) </PeriodTotals>
Property Descriptions
PeriodDateSpan
Span of dates
The start and end dates separated by a dash for the specified period; that is, the period for which the totals apply. Type: DateSpan Output Only Sample values: 04/03/2001-04/09/2001 Introduced in v4
601
Chapter 2
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
602
Kronos Incorporated
Permission Tag
Syntax
Properties <Permission (AccessControlPointName = String) (ActionName = String) (SuiteProductName = String) (ScopeName = String) > </Permission>
Property Descriptions
AccessControlPointName
Action name
Action for which the permission has been granted: add, edit, delete, or view.
603
Chapter 2
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
604
Kronos Incorporated
Person Tag
Syntax
Properties <Person [AccrualProfileName = String] [BaseWageHourly = Currency] [BirthDate = Date] (ManagerSignoffThruDateTime = Date) (PayrollLockoutThruDateTime = Date) [FirstName = String] (FullName = String) [HireDate = Date] [FingerRequiredFlag = Boolean] [LastName = String] [MiddleInitial = String] [FullTimePercentage = Long] [PersonNumber = String] [PhoneticFullName = String] [EmployeeStandardHours = Double] [FullTimeStandardHours = Double] [RomanizedFullName = String] [ShortName = String] > </Person>
Property Descriptions
605
Chapter 2
AccrualProfileName
Accrual profile
The accrual profile to be used for a person or group. An accrual profile can contain one or more accrual rules. Accrual profiles are assigned to similar groups of employees. For example, all full-time employees might have the same accrual profile. Type: String Optional Maximum length: 50 characters You can find values in the Workforce Timekeeper Setup Application. Sample values: VAC and Sick Only Introduced in v5.0; last changed in v5.1 BaseWageHourly
Birth date
The person's date of birth
606
Kronos Incorporated
Person Tag
Type: Date Optional Must occur before the hire date when the hire date is also specified Introduced in v4 EmployeeStandardHours
607
Chapter 2
Indicates when a finger scan (biometric) entry is required for the person Type: Boolean Optional Default value: False Enumerated value: True, False Introduced in v5.0; last changed in v5.0 FirstName
First name
The person's first name. Type: String Optional Maximum length: 30 characters Introduced in v4 FullName
Full name
Name of the person. This name is usually listed in the browser. Type: String Output Only Maximum length: 64 characters This property is derived from other properties in the person tag. Introduced in v4 FullTimePercentage
608
Kronos Incorporated
Person Tag
which benefits accrue for an employee who is not scheduled to work a full standard work week. For example, suppose this employee is scheduled to work 20 hours, and a fulltime employee works 40 hours per week. The full-time percentage for this person is therefore 50%. To use this property for a part-time employee, use an integer value between 1 and 100. You can alternatively specify the employee's full-time equivalency as a ratio of scheduled hours to standard hours. To do this, use the EmployeeStandardHours and FullTimeStandardHours properties. If you enter a value for EmployeeStandardHours and FullTimeStandardHours, do NOT enter a value for FullTimePercentage. Type: Long Optional Maximum length: 15 characters, including decimals It must be between 0 and 100. Default value: 100.0 Introduced in v4; last changed in v5.1 FullTimeStandardHours
609
Chapter 2
For example, suppose this employee is scheduled to work 30 hours, and a fulltime 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. Introduced in v4; last changed in v5.1 HireDate
Hire date
The date on which the person was hired. Type: Date Optional If you provide a value, it must be later than the birth date. Required: When adding a new employee. Default value: The date when the record for the new hire is imported. Introduced in v4; last changed in v5.0 LastName
Last name
The person's last name. A value for this column is required when adding a new person. Type: String
610
Kronos Incorporated
Person Tag
Middle initial
The person's middle initial Type: String Optional Maximum length: 1 character Introduced in v4 PayrollLockoutThruDateTime
Person number
Person number of the specified person. This property is used to set, change, or display the Person Number assignment.
611
Chapter 2
Type: String Optional Maximum length: 15 characters This number must be unique regardless of whether the person is active, inactive, or terminated. Required: When creating a new person Introduced in v4; last changed in v5.0 PhoneticFullName
612
Kronos Incorporated
Person Tag
Maximum length: 20 characters Default value: The first 20 characters of the first name. Introduced in v4
613
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "LoadPersonAccessAssignments" Parameters None Properties <PersonAccessAssignment [EffectiveDate = Date] [ExpirationDate = Date] [ProfessionalTransferOrganizationSetName = String] [ManagerTransferOrganizationSetName = String] [ManagerAccessOrganizationSetName = String] > <Identity> <CurrentUser> | <PersonIdentity> </Identity> [<Period> <TimeFramePeriod> </Period>] </PersonAccessAssignment>
614
Kronos Incorporated
PersonAccessAssignment Tag
Action Descriptions
LoadPersonAccessAssignments Returns information associated with person access assignments over the specified time period. If the period is not specified, the current date through January 1, 3000 is used. The Identity and Period information associated with the request are added to the item in the returned list. If there are no data for the person and time period, one list item is returned containing only the Identity and Period properties. The person must exist within the system and the user must have access to that person. Return Value Type: Zero or more PersonAccessAssignment tags Required Properties: Identity Optional Properties: Period Access Control Point Name: View Introduced in v5.0
Property Descriptions
EffectiveDate
615
Chapter 2
Type: Date Optional Must occur after the effective date Default value: January 1, 3000 Introduced in v5.0 Identity
Identity
One person, as specified in a PersonIdentity or CurrentUser tag. Type: Either CurrentUser or PersonIdentity tag Optional Key Must uniquely identify a person. Introduced in v5.0 ManagerAccessOrganizationSetName
Organizational group
An organizational group that a manager can use. Type: String Optional Maximum length: 30 characters Default value: The Empty Organization Set Enumerated value: All Organizational Sets, Organizational Groups Introduced in v5.0; last changed in v5.0 ManagerTransferOrganizationSetName
616
Kronos Incorporated
PersonAccessAssignment Tag
Maximum length: 30 characters Default value: The Empty Organization Set Enumerated value: All Organizational Sets, Job Transfer Sets Introduced in v5.0; last changed in v5.1 Period
Time period
The span of time associated with the person access assignments Type: TimeFramePeriod tag Optional Used for the LoadPersonAccessAssignments action Default value: From the current date until January 1, 3000 Introduced in v5.0 ProfessionalTransferOrganizationSetName
617
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddOnly" | "Delete" | "DeleteOnly" | "Load" | "Update" | "UpdateOnly" Parameters None Properties <Personality [<WTKEmployeeData> <WTKEmployee> </WTKEmployeeData>] [<GDAPAssignments> <GDAPAssignment>* </GDAPAssignments>] <Identity> <CurrentUser> | <PersonIdentity> </Identity> [<JobAssignmentData> <JobAssignment>
618
Kronos Incorporated
Personality Tag
</JobAssignmentData>] [<PersonInformationData> <PersonInformation> </PersonInformationData>] [<Period> <TimeFramePeriod> </Period>] [<UserData> <User> </UserData>] </Personality>
Action Descriptions
AddOnly Adds a new person to the system. Return Value Type: None Required Properties: PersonInformationData Invalid Properties: Identity Access Control Point Name: Edit Introduced in v4 Delete Marks a person for deletion. Return Value Type: None Required Properties: Identity Access Control Point Name: Edit Introduced in v5.0 DeleteOnly Marks a person for deletion. Return Value Type: None Required Properties: Identity Access Control Point Name: Edit
619
Chapter 2
Introduced in v4; last changed in v5.0; deprecated in v5.0 Load Returns a person's demographic, user, and employee information. Return Value Type: Personality tag Required Properties: Identity Access Control Point Name: View Introduced in v4 Update Adds information for a new person or updates an existing one. Return Value Type: None Required Properties: If Identity is not specified, PersonInformationData is required, and a new person is added. If Identity is specified, the record is updated or added, depending on whether it already exists. Access Control Point Name: Edit Introduced in v4 UpdateOnly Updates an existing person. Return Value Type: None Required Properties: Identity Access Control Point Name: Edit Introduced in v4
Property Descriptions
GDAPAssignments
620
Kronos Incorporated
Personality Tag
Identity
One person, as specified in a PersonIdentity or CurrentUser tag. Type: Either CurrentUser or PersonIdentity tag Optional Key Introduced in v4 JobAssignmentData
Time period
A span of time that may or may not be associated with a person Type: TimeFramePeriod tag Optional Used for narrowing the effective date of the request Default value: From the current date until January 1, 3000 Introduced in v5.0; last changed in v5.0 PersonInformationData
Person data
The person information of the person Type: PersonInformation tag
621
Chapter 2
Optional Required: When creating a new person Introduced in v4; last changed in v5.1 UserData
User data
The user information for the person Type: User tag Optional Introduced in v4 WTKEmployeeData
Employee data
Specifies the WTKEmployee information for the person Type: WTKEmployee tag Optional Introduced in v4; last changed in v5.0; deprecated in v5.0. Use the properties in the Person and JobAssignmentDetails tags.
622
Kronos Incorporated
PersonalOvertimeAssignment Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" Parameters None Properties <PersonalOvertimeAssignment [StopOvertimeFlag = Boolean] [EffectiveDate = Date] [ExpirationDate = Date] OvertimeLevel = Long OvertimeTypeName = String > <Identity> <CurrentUser> | <PersonIdentity> </Identity> [<PersonalOvertimeRuleData> <PersonalOvertimeRule> </PersonalOvertimeRuleData>] <Period> <TimeFramePeriod> </Period> </PersonalOvertimeAssignment>
623
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 Required Properties: Identity Optional Properties: Period Access Control Point Name: View Introduced in v5.0
Property Descriptions
EffectiveDate
Effective date
The date when the personal overtime assignment becomes effective Type: Date Optional Must occur before the expiration date Default value: Current system date Introduced in v5.0 ExpirationDate
Expiration date
The date when the personal overtime assignment expires
624
Kronos Incorporated
PersonalOvertimeAssignment Tag
Type: Date Optional Must occur after the effective date Default value: January 1, 3000 Introduced in v5.0 Identity
Identity
One employee, as specified in a PersonIdentity or CurrentUser tag Type: Either CurrentUser or PersonIdentity tag Optional Key Must uniquely identify an existing and active employee. 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 Maximum length: 2 characters 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
625
Chapter 2
Time period
The specified time frame Type: TimeFramePeriod tag 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 Default value: January 1, 3000 Introduced in v5.0 PersonalOvertimeRuleData
626
Kronos Incorporated
PersonalOvertimeAssignment Tag
Introduced in v5.0
627
Chapter 2
Syntax
Properties <PersonalOvertimeLimit [MinimumAmount = TimeDuration] [Amount = TimeDuration] PersonalOvertimeAmountTypeName = String > </PersonalOvertimeLimit>
Property Descriptions
Amount
628
Kronos Incorporated
PersonalOvertimeLimit Tag
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
629
Chapter 2
Syntax
Properties <PersonalOvertimeRule (PersonalOvertimeRuleDisplayName = String) [UseScheduleFlag = Boolean] > [<PersonalOvertimeLimits> <PersonalOvertimeLimit>* </PersonalOvertimeLimits>] </PersonalOvertimeRule>
Property Descriptions
PersonalOvertimeLimits
630
Kronos Incorporated
PersonalOvertimeRule Tag
PersonalOvertimeRuleDisplayName
631
Chapter 2
Syntax
Properties <PersonAuthenticationType ActiveFlag = Boolean AuthenticationTypeName = String > </PersonAuthenticationType>
Property Descriptions
ActiveFlag
632
Kronos Incorporated
PersonAuthenticationType Tag
633
Chapter 2
Syntax
Request <Request Action = Actions 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
634
Kronos Incorporated
PersonCertificationAssign Tag
LoadAll Returns all certification assignments for an employee. Return Value Type: PersonCertificationAssign tag Required Properties: PersonNumber Access Control Point Name: View Introduced in v5.0; last changed in v5.0 LoadCertificationAssignments Returns certification assignments for an employee for the specified timeframe. If Period is not specified, this action returns all assignments from the current date to January 1, 3000 Return Value Type: PersonCertificationAssign tag Required Properties: PersonNumber Optional Properties: Period Access Control Point Name: View Introduced in v5.0; last changed in v5.0 Update Assigns certifications to one or more employees. Return Value Type: None Required Properties: PersonCertificationItems, Employees Access Control Point Name: Edit Introduced in v5.0
Property Descriptions
Employees
Employees
One or more employees, as specified in one or more PersonIdentity tags, for whom the certification is assigned. Type: Zero or more PersonIdentity tags
635
Chapter 2
Optional Each employee must have a WFS license. Introduced in v5.0 Period
Time period
The time span when the assignment is in effect. Type: TimeFramePeriod tag Optional Introduced in v5.0; last changed in v5.0 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 Maximum length: 15 characters Introduced in v5.0
636
Kronos Incorporated
PersonCertificationItem Tag
Syntax
Properties <PersonCertificationItem Name = String [CertificationNumber = String] EffectiveDate = Date ExpirationDate = Date [OldCertificationNumber = String] [OldEffectiveDate = Date] [OldExpirationDate = Date] > </PersonCertificationItem>
Property Descriptions
CertificationNumber
Certification number
Certification number Type: String Optional Maximum length: 12 characters Introduced in v5.0; last changed in v5.0
637
Chapter 2
EffectiveDate
Effective date
The date when the certification assignment becomes effective for the employee previously specified Type: Date Required Introduced in v5.0; last changed in v5.0 ExpirationDate
Expiration date
The date when the assignment of this certification to the previously specified employee expires Type: Date Required Introduced in v5.0; last changed in v5.0 Name
Certification name
The unique name of a legal certification Type: String Required Maximum length: 40 characters You can find values in the Workforce Timekeeper user interface. Introduced in v5.0; last changed in v5.0 OldCertificationNumber
638
Kronos Incorporated
PersonCertificationItem Tag
Dependency: If any one of OldCertificationNumber, OldEffectiveDate, or OldExpirationDate is specified, the other two must also be specified. To update a certification number, you must specify the certification number and these three properties. Type: String Optional Maximum length: 12 characters Introduced in v5.0; last changed in v5.0 OldEffectiveDate
639
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "LoadIdentities" Parameters None Properties <PersonIdentity BadgeNumber = String EmployeeKey = Long PersonKey = Long <PersonIdentityList> <CurrentUser> | <PersonIdentity> </PersonIdentityList> PersonNumber = String UserKey = Long [<FilterQueryName> <HyperFindQuery> </FilterQueryName>] </PersonIdentity>
Action Descriptions
640
Kronos Incorporated
PersonIdentity Tag
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 Required Properties: PersonNumber Optional Properties: None Access Control Point Name: View Introduced in v4; last changed in v5.1
Property Descriptions
BadgeNumber
Badge number
Contains an employee badge number that is assigned to the employee. The system can be configured to allow multiple badges for employees. Specify whether to allow multiple badge assignments in 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 Maximum length: 25 characters Must be unique for the specified date span. Validation is done after a person is associated with a badge, using the PersonInformation tag. The effective date is the date of the server Introduced in v4
641
Chapter 2
EmployeeKey
642
Kronos Incorporated
PersonIdentity Tag
PersonNumber
Person number
The person's identification number. A member of the Identifier group. If you are importing data from another system, this may be a convenient identifier to use. Type: String Maximum length: 15 characters Non-numeric values are permitted. Introduced in v4; last changed in v5.0 UserKey
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
643
Chapter 2
The default value, All Home, only returns Active employees. Default value: All Home Introduced in v5.0; last changed in v5.0
644
Kronos Incorporated
PersonInformation Tag
Function Access Control Point: API.Person Introduced in v4; last changed in v5.1
Syntax
Request
645
Chapter 2
<Request Action = Actions Parameters > Properties </Request> Actions "Load" | "LoadAllBadgeAssignments" | "LoadAllEmploymentStatus" | "LoadAllHomeAccounts" | "LoadAllUserAccountStatus" Parameters None Properties <PersonInformation [<PersonAccessAssignments> <PersonAccessAssignment>* </PersonAccessAssignments>] [<AccessAssignmentData> <AccessAssignment> </AccessAssignmentData>] [<CustomDataList> <CustomData>* </CustomDataList>] [<PersonAuthenticationTypes> <PersonAuthenticationType>* </PersonAuthenticationTypes>] [<BadgeAssignments> <BadgeAssignment>* </BadgeAssignments>] [<EMailAddresses> <EmailAddress>* </EMailAddresses>] [<EmploymentStatusList> <EmploymentStatus>* </EmploymentStatusList>] <Identity> <CurrentUser> | <PersonIdentity> </Identity> [<HomeAccounts> <HomeAccount>* </HomeAccounts>]
646
Kronos Incorporated
PersonInformation Tag
[<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 Required Properties: Identity Access Control Point Name: View Introduced in v4 LoadAllBadgeAssignments Returns all badge assignments for the specified person. Return Value Type: Zero or more BadgeAssignment tags
647
Chapter 2
Required Properties: Identity Access Control Point Name: View Introduced in v4; last changed in v5.0; deprecated in v5.0 LoadAllEmploymentStatus Returns all employment statuses for the specified person. Return Value Type: Zero or more EmploymentStatus tags Required Properties: Identity Access Control Point Name: View Introduced in v4; last changed in v5.0; deprecated in v5.0 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 Required Properties: Identity Access Control Point Name: View Introduced in v4; last changed in v5.0; deprecated in v5.0 LoadAllUserAccountStatus Returns all user account statuses for the specified person. Return Value Type: Zero or more UserAccountStatus tags Required Properties: Identity Access Control Point Name: View Introduced in v4; last changed in v5.0; deprecated in v5.0
Property Descriptions
AccessAssignmentData
Access rights
A set of access rights and preferences
648
Kronos Incorporated
PersonInformation Tag
Badge assignments
One or more badge numbers and associated time frames Type: Zero or more BadgeAssignment tags Optional Introduced in v4 CustomDataList
Additional information
One or more sets of information for site-specified data categories Type: Zero or more CustomData tags Optional Introduced in v4 CustomDates
Person dates
One or more sets of date type information for site-specified date categories that can be assigned to a person Type: Zero or more CustomDate tags Optional Introduced in v4 EMailAddresses
E-mail addresses
Specifies the person's e-mail address. Type: Zero or more EmailAddress tags
649
Chapter 2
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 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.
650
Kronos Incorporated
PersonInformation Tag
Identity
Identity
One person, 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 PersonAccessAssignments
Authentication Types
The list of one or more authentication types, and the status (either active or inactive) for each type, for the current person. Only one authentication type should be active at a given time for each person. The authentication types include the following: Kronos, NT, LDAP, KRONOS_CUSTOM. Type: Zero or more PersonAuthenticationType tags Optional Default value: Kronos Introduced in v5.1 PersonData
Person data
Basic name and employment information for a person
651
Chapter 2
Type: Person tag Optional Required: When creating a new person Introduced in v4 PersonLicenseTypes
Status of licenses
The licenses for a specific person. Type: Zero or more PersonLicenseType tags Optional Introduced in v4; last changed in v5.1 PostalAddresses
Postal addresses
Postal addresses for the specified address types Type: Zero or more PostalAddress tags Optional Introduced in v4 SupervisorData
Supervisor data
The person who is logically defined as this person's supervisor Type: Supervisor tag Optional Introduced in v4; last changed in v5.0; deprecated in v5.0. Use the JobAssignmentDetails tag to assign a supervisor. TelephoneNumbers
Telephone numbers
The telephone numbers for the given telephone number types
652
Kronos Incorporated
PersonInformation Tag
653
Chapter 2
Syntax
Properties <PersonLicenseType ActiveFlag = Boolean LicenseTypeName = String > </PersonLicenseType>
Property Descriptions
ActiveFlag
Type of license
The name or the Id of the license type. There are nine valid licenses, but not all are assignable to employees
654
Kronos Incorporated
PersonLicenseType Tag
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 Maximum length: 2 characters Specify @ to make no change to the existing license type. Enumerated value: @, 1, 2, 3, 5, 9 Introduced in v4; last changed in v5.0
655
Chapter 2
Syntax
Request <Request Action = Actions 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 Required Properties: Employee
656
Kronos Incorporated
PersonShiftTemplateAssignment Tag
Access Control Point Name: View Introduced in v5.1Beta Update Assigns a specified shift template to a specified employee. Taken together, the shift template and employee must be unique in the system. Return Value Type: None Required Properties: Employee, ShiftTemplateProfileName Access Control Point Name: Edit Introduced in v5.1Beta
Property Descriptions
Employee
Employee
One employee, as specified in a PersonIdentity tag Type: PersonIdentity tag Required Key Must uniquely identify an existing and active employee Introduced in v5.1Beta; last changed in v5.0a ShiftTemplateProfileName
657
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "LoadAll" | "LoadSkillAssignments" | "Update" Parameters None Properties <PersonSkillAssign [PersonNumber = String] > [<Employees> <PersonIdentity>* </Employees>] [<PersonSkillItems> <PersonSkillItem>* </PersonSkillItems>] [<Period> <TimeFramePeriod> </Period>] </PersonSkillAssign>
Action Descriptions
658
Kronos Incorporated
PersonSkillAssign Tag
LoadAll Returns all skill assignments for an employee. Return Value Type: PersonSkillAssign tag Required Properties: PersonNumber Access Control Point Name: View Introduced in v5.0; last changed in v5.0 LoadSkillAssignments Returns skill assignments for an employee for the specified timeframe. Return Value Type: PersonSkillAssign tag Required Properties: PersonNumber Access Control Point Name: View Introduced in v5.0; last changed in v5.0 Update Assigns skills to one or more employees. Return Value Type: None Required Properties: PersonSkillItems, Employees Access Control Point Name: Edit Introduced in v5.0
Property Descriptions
Employees
Employees
One or more people, as specified in one or more PersonIdentity tags. The skills that are specified in PersonSkillItems are assigned to this list of people. Type: Zero or more PersonIdentity tags Optional Each employee must have a WFS license. Introduced in v5.0
659
Chapter 2
Period
Time period
The span of time during which the skill assignments are in effect for the specified employees. Type: TimeFramePeriod tag Optional Introduced in v5.0 PersonNumber
Person number
The person number of a person about whom information is returned. Type: String Optional Maximum length: 15 characters Introduced in v5.0 PersonSkillItems
660
Kronos Incorporated
PersonSkillItem Tag
Syntax
Properties <PersonSkillItem [EffectiveDate = Date] (ExpirationDate = Date) [IsActive = Boolean] Name = String > </PersonSkillItem>
Property Descriptions
EffectiveDate
Effective date
The date when the skill becomes available for assignment Type: Date Optional Introduced in v5.0 ExpirationDate
Expiration date
The date when the skill will no longer be available for assignment Type: Date
661
Chapter 2
Skill name
The name of a skill Type: String Required Maximum length: 40 characters You can see the list of existing skills in the user interface. Introduced in v5.0; last changed in v5.0
662
Kronos Incorporated
PostalAddress Tag
Syntax
Properties <PostalAddress ContactTypeName = String [City = String] [Country = String] [State = String] [Street = String] [PostalCode = String] > </PostalAddress>
Property Descriptions
City
City
The city or town portion of the person's address Type: String Optional Maximum length: 25 characters Introduced in v4 ContactTypeName
663
Chapter 2
The name of the contact category Type: String Required Key Maximum length: 30 characters Introduced in v4 Country
Country
The country portion of the person's address Type: String Optional Maximum length: 25 characters Introduced in v4 PostalCode
Zip code
The postal code portion of the person's address Type: String Optional Maximum length: 25 characters Introduced in v4 State
State/Province
The state or province of the person's address Type: String Optional Maximum length: 25 characters Introduced in v4; last changed in v5.0
664
Kronos Incorporated
PostalAddress Tag
Street
Street
The numerical and street name portion of the person's address Type: String Optional Maximum length: 100 characters Introduced in v4
665
Chapter 2
Syntax
Request <Request Action = Actions 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. Name should be valid
666
Kronos Incorporated
PreferenceProfile Tag
Return Value Type: PreferenceProfile tag Required Properties: PreferenceProfileName Access Control Point Name: View Introduced in v4; last changed in v5.1 LoadAllPreferenceProfiles Returns all preference profiles in the system. Return Value Type: Zero or more PreferenceProfile tags Required Properties: None Access Control Point Name: View Introduced in v4 LoadById Returns a preference profile, based on PreferenceProfileId. Return Value Type: PreferenceProfile tag Required Properties: PreferenceProfileId Access Control Point Name: View Introduced in v4
Property Descriptions
PreferenceProfileId
Id of display profile
Uniquely identifies the preference profile in the database Type: Integer Optional Introduced in v4 PreferenceProfileName
667
Chapter 2
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 Required Introduced in v4
668
Kronos Incorporated
PrimaryLaborAccount Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "LoadPrimaryLaborAccounts" Parameters None Properties <PrimaryLaborAccount [EffectiveDate = Date] [ExpirationDate = Date] [LaborAccountName = String] [OrganizationPath = String] > <Identity> <CurrentUser> | <PersonIdentity> </Identity> [<Period> <TimeFramePeriod>
669
Chapter 2
</Period>] </PrimaryLaborAccount>
Action Descriptions
LoadPrimaryLaborAccounts Loads information associated with the primary labor account for a specified person over a specified period. If the period is not specified, the current date through January 1, 3000 is used. The Identity and Period information associated with the request is added to the item in the list. If no data is found, just the Identity and Period properties are returned. Return Value Type: Zero or more PrimaryLaborAccount tags Required Properties: Identity Optional Properties: Period Access Control Point Name: View Introduced in v5.0; last changed in v5.0
Property Descriptions
EffectiveDate
Effective date
The date when the primary labor account becomes effective Type: Date Optional Must occur before the expiration date Default value: Current date Introduced in v5.0 ExpirationDate
Expiration date
670
Kronos Incorporated
PrimaryLaborAccount Tag
The date when the primary labor account expires Type: Date Optional Must occur after the effective date Default value: January 1, 3000 Introduced in v5.0 Identity
Identity
One person, as specified in a PersonIdentity or CurrentUser tag. Type: Either CurrentUser or PersonIdentity tag Optional Key Must uniquely identify a person Introduced in v5.0; last changed in v5.0 LaborAccountName
Labor account
The name of the employee's primary labor account. Type: String Optional Maximum length: 356 characters Required for an employee's primary labor account name. You can find values in the Workforce Timekeeper user interface. Sample values: The following is an example of a primary account name (depending on how labor levels and accounts are defined in your system): 112/222/332/401/501/601/701. You can use shorthand for the primary labor account in any labor account entry if you are also importing an organizational path.
671
Chapter 2
Time period
The period of time associated with the primary account Type: TimeFramePeriod tag
672
Kronos Incorporated
PrimaryLaborAccount Tag
Optional Identity is used if a person is required in association with the time frame. Used for the LoadPrimaryLaborAccounts action Default value: From the current date until January 1, 3000 Introduced in v5.0
673
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Add" | "AddOnly" | "Delete" | "DeleteOnly" | "Retrieve" | "RetrieveAll" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" | "UpdateOnly" Parameters None Properties <Procedure [ContextName = String] [Description = String] ProcedureName = String > </Procedure>
Action Descriptions
674
Kronos Incorporated
Procedure Tag
Add Inserts one Procedure object in the database . If it's already there a rule with the same name nothing happens. Return Value Type: None Required Properties: ProcedureName, ContextName Access Control Point Name: Edit Introduced in v6.0 AddOnly Inserts one Procedure object in the database . If it's already there an error is thrown. Return Value Type: None Required Properties: ProcedureName, ContextName Access Control Point Name: Edit 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. Return Value Type: None Required Properties: ProcedureName Access Control Point Name: Edit 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. Return Value Type: None Required Properties: ProcedureName Access Control Point Name: Edit Introduced in v6.0
675
Chapter 2
Retrieve Retrieves the Procedure object that has the same name as the one specified in the ProcedureName. Return Value Type: Procedure tag Required Properties: ProcedureName Access Control Point Name: View Introduced in v6.0 RetrieveAll Retrieves all the Procedure objects. Return Value Type: Zero or more Procedure tags Access Control Point Name: View Introduced in v6.0 RetrieveAllForUpdate Retrieves all the Procedure objects. Return Value Type: Zero or more Procedure tags Access Control Point Name: View Introduced in v6.0 RetrieveAllNames Retrieves all the names for all Procedure objects. Return Value Type: String list Access Control Point Name: View 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 Required Properties: ProcedureName Access Control Point Name: View
676
Kronos Incorporated
Procedure Tag
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. Return Value Type: None Required Properties: ProcedureName Access Control Point Name: Edit Introduced in v6.0 UpdateOnly Updates one Procedure object in the database . If it's not there an error is thrown. Return Value Type: None Required Properties: ProcedureName Access Control Point Name: Edit Introduced in v6.0
Property Descriptions
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
677
Chapter 2
Procedure name
Defines the name of the Procedure object. Type: String Required Introduced in v6.0
678
Kronos Incorporated
ProcedureAction Tag
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View Introduced in v6.0
679
Chapter 2
RetrieveAll Retrieves all the ProcedureAction objects. Return Value Type: Zero or more ProcedureAction tags Access Control Point Name: View Introduced in v6.0
Property Descriptions
ProcedureActionName
680
Kronos Incorporated
ProcedureContext Tag
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View
681
Chapter 2
Introduced in v6.0 RetrieveAll Retrieves all the ProcedureContext objects. Return Value Type: Zero or more ProcedureContext tags Access Control Point Name: View Introduced in v6.0 RetrieveAllNames Retrieves all the names for all ProcedureContext objects. Return Value Type: String list Access Control Point Name: View Introduced in v6.0
Property Descriptions
ProcedureContextName
682
Kronos Incorporated
ProcedureParameter Tag
Syntax
Properties <ProcedureParameter ParameterValue = String ProcedureParameterName = String ProcedureParameterDefinitionName = String > </ProcedureParameter>
Property Descriptions
ParameterValue
Parameter value
Defines the value of this ProcedureParameter object. Type: String Required Key Introduced in v6.0 ProcedureParameterDefinitionName
683
Chapter 2
ProcedureParameterName
684
Kronos Incorporated
ProcedureParameterDefinition Tag
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View
685
Chapter 2
Introduced in v6.0; last changed in v6.0 RetrieveAll Retrieves all the sorting and matching ProcedureParameterDefinition objects. Return Value Type: Zero or more ProcedureParameterDefinition tags Access Control Point Name: View Introduced in v6.0 RetrieveAllNames Retrieves all the names for all ProcedureParameterDefinition objects. Return Value Type: String list Access Control Point Name: View Introduced in v6.0
Property Descriptions
ProcedureParameterName
686
Kronos Incorporated
ProcedureSet Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Add" | "AddOnly" | "Delete" | "DeleteOnly" | "Retrieve" | "RetrieveAll" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" | "UpdateOnly" Parameters None Properties <ProcedureSet ContextName = String [Description = String] ProcedureSetName = String > [<ProcedureSetItems> <ProcedureSetItem>*
687
Chapter 2
</ProcedureSetItems>] </ProcedureSet>
Action Descriptions
Add Inserts one ProcedureSet object in the database. If it's already there a Procedure with the same name nothing happens. Return Value Type: None Required Properties: ProcedureSetName, ContextName Optional Properties: Description Access Control Point Name: Edit Introduced in v6.0 AddOnly Inserts one ProcedureSet object in the database . If it's already there an error is thrown. Return Value Type: None Required Properties: ProcedureSetName, ContextName Access Control Point Name: Edit 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. Return Value Type: None Required Properties: ProcedureSetName Access Control Point Name: Edit 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.
688
Kronos Incorporated
ProcedureSet Tag
Return Value Type: None Required Properties: ProcedureSetName Access Control Point Name: Edit 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 Required Properties: ProcedureSetName Access Control Point Name: View Introduced in v6.0 RetrieveAll Retrieves all the ProcedureSet objects. Return Value Type: Zero or more ProcedureSet tags Access Control Point Name: View Introduced in v6.0 RetrieveAllForUpdate Retrieves all the ProcedureSet objects. Return Value Type: Zero or more ProcedureSet tags Access Control Point Name: View Introduced in v6.0 RetrieveAllNames Retrieves all the names for all ProcedureSet objects. Return Value Type: String list Access Control Point Name: View Introduced in v6.0
689
Chapter 2
RetrieveForUpdate Retrieves the ProcedureSet object that has the same name as the one specified in the ProcedureSetName. Return Value Type: ProcedureSet tag Required Properties: ProcedureSetName Access Control Point Name: View 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. Return Value Type: None Required Properties: ProcedureSetName, ContextName Optional Properties: Description Access Control Point Name: Edit Introduced in v6.0 UpdateOnly Updates one ProcedureSet object in the database . If it's not there an error is thrown. Return Value Type: None Required Properties: ProcedureSetName, ContextName Optional Properties: Description Access Control Point Name: Edit Introduced in v6.0
Property Descriptions
ContextName
Context Name
Represents the procedure set context name.
690
Kronos Incorporated
ProcedureSet Tag
691
Chapter 2
692
Kronos Incorporated
ProcedureSetItem Tag
Syntax
Properties <ProcedureSetItem GenerateAudit = Boolean ProcedureName = String > [<ProcedureParameters> <ProcedureParameter>* </ProcedureParameters>] </ProcedureSetItem>
Property Descriptions
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 Required Key
693
Chapter 2
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
694
Kronos Incorporated
Process Tag
Syntax
Request <Request Action = Actions 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>
695
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 Access Control Point Name: Edit Introduced in v5.1
696
Kronos Incorporated
Process Tag
Action Parameters Parameter Name ResourceId Description The ResourceId is a required action 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 Maximum length: 30 characters Additional information Introduced in v5.1
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.
697
Chapter 2
Optional Properties: ProcessAttributes Access Control Point Name: Edit Introduced in v5.1
Action Parameters Parameter Name ResourceId Description The ResourceId is the required action 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 Minimum length: 1 character Maximum length: 30 characters Additional information Introduced in v5.1
DeleteOnly The DeleteOnly method deletes a single process specified by the process id. The ProcessId must be greater than 0. Return Value Type: None Required Properties: ProcessId Access Control Point Name: Edit Introduced in v5.1 Retrieve This action returns a specific process. The ProcessId must be greater than 0. Return Value Type: Process tag
698
Kronos Incorporated
Process Tag
Required Properties: ProcessId Access Control Point Name: View 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. Return Value Type: Process tag Required Properties: ProcessId Optional Properties: ProcessStateCode, ProcessAttributes Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
AdminTemplateId
Administrator Template Id
The identifier for the process template from which the process was created, used for administration purposes. Type: Integer Required The AdminTemplateId is a required property on the Process. The AdminTemplateId must not be null and must be greater than 0. The
699
Chapter 2
AdminTemplateId is an optional property on the Process Add and AddWithWebForm actions. Introduced in v5.1 KProcessUniqueKey
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>
700
Kronos Incorporated
Process Tag
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 Maximum length: 50 characters 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.
701
Chapter 2
702
Kronos Incorporated
ProcessorToEmployee Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Add" | "AddOnly" | "Delete" | "Retrieve" | "RetrieveAll" | "RetrieveByPerson" | "RetrieveByPersonAndEffectiveDate" | "RetrieveByProcessor" | "RetrieveForUpdate" | "Update" | "UpdateOnly" Parameters None Properties <ProcessorToEmployee [EffectiveDate = Date] [ExpirationDate = Date] Processor = String > <Person> <PersonIdentity>
703
Chapter 2
</Person> </ProcessorToEmployee>
Action Descriptions
Add Adds a new association of an extension processor to an employee, or updates an existing one. Return Value Type: None Required Properties: Processor, Person Optional Properties: EffectiveDate, ExpirationDate, NewProcessor, NewEffectiveDate Access Control Point Name: Edit Introduced in v5.2 AddOnly Adds a new association of an extension processor to an employee. Return Value Type: None Required Properties: Processor, Person Optional Properties: EffectiveDate, ExpirationDate Access Control Point Name: Edit 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). Return Value Type: None Required Properties: Processor, Person Optional Properties: EffectiveDate Access Control Point Name: Edit Introduced in v5.2
704
Kronos Incorporated
ProcessorToEmployee Tag
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 Required Properties: Processor, Person Optional Properties: EffectiveDate Access Control Point Name: View Introduced in v5.2 RetrieveAll Retrieves a list of all of the ProcessorToEmployee associations. Return Value Type: Zero or more ProcessorToEmployee tags Access Control Point Name: View Introduced in v5.2 RetrieveByPerson Retrieves the list of ProcessorToEmployee associations for a given employee. Person must be a valid PersonIdentity. Return Value Type: Zero or more ProcessorToEmployee tags Required Properties: Person Access Control Point Name: View Introduced in v5.2 RetrieveByPersonAndEffectiveDate Retrieve the list of ProcessorToEmployee associations for the given person that are in effect on the given effective date. Person must be a valid PersonIdentity, and EffectiveDate must be a valid date. Return Value Type: Zero or more ProcessorToEmployee tags Required Properties: Person, EffectiveDate Access Control Point Name: View Introduced in v5.2
705
Chapter 2
RetrieveByProcessor Retrieves the list of ProcessorToEmployee associations for a given extension processor. Must specify a valid Processor name. Return Value Type: Zero or more ProcessorToEmployee tags Required Properties: Processor Access Control Point Name: View 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 Required Properties: Processor, Person Optional Properties: EffectiveDate Access Control Point Name: View Introduced in v5.2 Update Updates an existing association of an extension processor to an employee, or add one if it does not exist. Return Value Type: None Required Properties: Processor, Person Optional Properties: EffectiveDate, ExpirationDate, NewProcessor, NewEffectiveDate Access Control Point Name: Edit Introduced in v5.2 UpdateOnly Updates an existing association of an extension processor to an employee. Return Value Type: None Required Properties: Processor, Person
706
Kronos Incorporated
ProcessorToEmployee Tag
Optional Properties: EffectiveDate, ExpirationDate, NewProcessor, NewEffectiveDate Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
EffectiveDate
Effective date
The effective date of the association of an extension processor and an employee. Type: Date Optional Must be a valid date. 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 Must be a valid date. Default value: 01/01/3000 (forever) Introduced in v5.2 Person
Person
The PersonIdentity of the employee to be associated with an extension processor. Type: PersonIdentity tag
707
Chapter 2
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
708
Kronos Incorporated
ProcessProfile Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "LoadAllProcessProfiles" | "LoadById" Parameters None Properties <ProcessProfile ProcessProfileId = Long [ProcessProfileName = String] > </ProcessProfile>
Action Descriptions
709
Chapter 2
Load Loads the process profile from the database given the ProcessProfileName property. An example of the ProcessProfileName may be "All Process Templates". The ProcessProfileName must already exist in the database, prior to calling the Load action. Return Value Type: (***undefined***): WorkflowProfile Required Properties: ProcessProfileName Access Control Point Name: View Introduced in v5.0; last changed in v5.0 LoadAllProcessProfiles Loads all process profiles in the database, returning a list of APIWorkflowProfileBeans. Return Value Type: (***undefined***): WorkflowProfile Required Properties: None Access Control Point Name: View Introduced in v5.0; last changed in v5.0 LoadById Loads the Process Profile from the database given the ProcessProfileId property. The ProcessProfileId which uniquely identifies a process profile must already exist in the database, prior to calling the LoadById action. Return Value Type: (***undefined***): WorkflowProfile Required Properties: ProcessProfileId Access Control Point Name: View Introduced in v5.0; last changed in v5.0
Property Descriptions
ProcessProfileId
Process Profile Id
710
Kronos Incorporated
ProcessProfile Tag
The Id of a specific process profile, which identifies a unique process profile. Type: Long Required Key Introduced in v5.0; last changed in v5.0 ProcessProfileName
711
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "CoverShift" | "SwapShifts" Parameters None Properties <ProcessSchedule [SaveData = Boolean] QueryDateSpan = DateSpan [CheckRules = Boolean] > <Employees> <CurrentUser> | <PersonIdentity> </Employees> [<ScheduleItems> <ScheduleAccrualAmountEdit> | <ScheduleOff> | <SchedulePayCodeEdit> | <ScheduleShift> | <ScheduleShiftSwap> | <ScheduleUnavailable> </ScheduleItems>] </ProcessSchedule>
712
Kronos Incorporated
ProcessSchedule Tag
Action Descriptions
CoverShift Assign an employee to cover a shift for another employee, as specified by a ScheduleShiftSwap tag in the ScheduleItems property. The Employees list must contain exactly two employees. These must be the same employees as those identified in the ScheduleShiftSwap tag. The ScheduleItems list must contain exactly two shifts. Return Value Type: Zero or more RuleViolation tags Required Properties: Employees, QueryDateSpan, ScheduleItems Optional Properties: SaveData, CheckRules Access Control Point Name: Edit Introduced in v5.0; last changed in v5.1 SwapShifts Swap the employee assignments for the two specified shifts, as identified by ScheduleShiftSwap tags in the ScheduleItems property. The Employees list must contain exactly two employees. These must be the same employees as those identified in the ScheduleShiftSwap tag. The ScheduleItems list must contain exactly two shifts. Return Value Type: Zero or more RuleViolation tags Required Properties: Employees, QueryDateSpan, ScheduleItems Optional Properties: SaveData, CheckRules Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0
Property Descriptions
CheckRules
713
Chapter 2
Indicates whether schedule validation will take place on the modified schedule from an action Type: Boolean Optional SaveData and CheckRules cannot both be false. If CheckRules is True, any rule violations from employees or jobs that are affected by the action are returned by the action. If it is False, then null is returned. Default value: False Introduced in v5.0 Employees
Employees
One or more employees for whom the action will be processed, as specified in one or more PersonIdentity or CurrentUser tags. Type: Either CurrentUser or PersonIdentity tag 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
714
Kronos Incorporated
ProcessSchedule Tag
Type: Boolean Optional SaveData and CheckRules cannot both be false. 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
715
Chapter 2
Syntax
Request <Request Action = Actions 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
716
Kronos Incorporated
ProcessTask Tag
Action Descriptions
Retrieve The Retrieve action returns the ProcessTask specified by the TaskId. Return Value Type: ProcessTask tag Required Properties: TaskId Access Control Point Name: View Introduced in v5.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 Required Properties: ProcessId Optional Properties: TaskStateCode, ResourceId Access Control Point Name: View Introduced in v5.1 RetrieveAllByResourceId This action returns a list of tasks for a given process. By specifying the ResourceId, TaskStateCode, CategoryName, you can retrieve a list of process tasks by resource, or by resource id and task state, or by resource id, task state, and category name, or by resource id and by category name. If you specify an active
717
Chapter 2
task state with a TaskStateCode of 1, a list of all active tasks that are assigned to the specified resource for all processes is returned. If you specify a CategoryName and a specific ResourceId, a list of all tasks assigned to that resource and also correspond to a process template that belong to the specified category will be returned. If you specify 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 Access Control Point Name: View Introduced in v5.1
Action Parameters Parameter Name CategoryName Description The CategoryName is an optional 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. Additional information Introduced in v5.1
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.
718
Kronos Incorporated
ProcessTask Tag
Return Value Type: ProcessTask tag Required Properties: TaskId Optional Properties: TaskStateCode, TaskAttributes Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
EndDate
End date
The date on which the process task ends Type: Date Required EndDate is a required property on the ProcessTask. The EndDate must not be null and must be a valid Date. Introduced in v5.1 Locations
719
Chapter 2
the previous tasks have no assigned resources, an empty string is returned. This can occur with synch tasks. Type: String Optional Introduced in v5.1 ProcessId
Process identifier
The identifier of the process to which this process task belongs. Type: Integer Required Must be greater than zero. 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
720
Kronos Incorporated
ProcessTask Tag
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 Maximum length: 30 characters Introduced in v5.1 ResourceName
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
721
Chapter 2
One or more Attribute tags that identify who belongs to the process task. Each TaskAttribute has a name and value pair. Type: Zero or more Attribute tags Optional TaskAttributes list is an optional property on the ProcessTask and an optional property on ProcessTask UpdateOnly action. For each task attribute specified, the task attribute Name cannot be null and must be 1 char and <= 255 chars in length. Sample values: <TaskAttributes> <Attribute Name="roleAttribute" Value="${employee}.manager> </Attribute> </TaskAttributes> Introduced in v5.1 TaskId
Task identifier
The identifier of the process task. Type: Integer Required Key Must be greater than zero. Introduced in v5.1 TaskName
Task name
The name of the process task Type: String Required
722
Kronos Incorporated
ProcessTask Tag
The TaskName is a required property on the ProcessTask. The TaskName must not be null and must be greater than 1 character and less than 50 characters in length. Sample values: Approval Form Introduced in v5.1 TaskState
Task state
The state of the process task Type: String Required If specified, the TaskState must be one of the valid task states. Sample values: "Ready","Active","Complete","Failed","Passive" Introduced in v5.1 TaskStateCode
Task URL
723
Chapter 2
The url of the web task in a process Type: String Optional Introduced in v5.1
724
Kronos Incorporated
ProcessTemplate Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Add" | "DeleteOnly" | "Retrieve" | "RetrieveAll" | "RetrieveAllByCategory" | "RetrieveAllByResourceId" | "RetrieveAllForEmployee" | "RetrieveAllForManager" | "RetrieveByDisplayName" | "RetrieveByUniqueKey" | "UpdateOnly" Parameters RetrieveAllByCategory [IncludeTemplateData = Boolean] RetrieveAllByResourceId GetHiddenActions = Boolean [IncludeTemplateData = Boolean] ResourceId = String RetrieveAllForEmployee [CategoryName = String]
725
Chapter 2
GetHiddenActions = Boolean [IncludeTemplateData = Boolean] RetrieveAllForManager [CategoryName = String] GetHiddenActions = Boolean [IncludeTemplateData = Boolean] ResourceId = String RetrieveByDisplayName [IncludeTemplateData = Boolean] RetrieveByUniqueKey [IncludeTemplateData = Boolean] UpdateOnly [IncludeTemplateData = Boolean] Properties <ProcessTemplate AdminTemplateId = Long [KProcessUniqueKey = String] [CommentText = String] EffectiveDate = DateTime 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
726
Kronos Incorporated
ProcessTemplate Tag
Optional Properties: ActiveSwitch, ActionListSwitch, CommentText, MaxPoolSize, CategoryNames Access Control Point Name: Edit Introduced in v5.1 DeleteOnly This action deletes a process template specified by the AdminTemplateId. Return Value Type: None Required Properties: AdminTemplateId Access Control Point Name: Edit Introduced in v5.1 Retrieve This action returns the process template for the specified template identifier. The AdminTemplateId must be greater than 0. Return Value Type: ProcessTemplate tag Required Properties: AdminTemplateId Access Control Point Name: View 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.
727
Chapter 2
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 Optional Properties: Filter, IncludeTemplateData Access Control Point Name: View 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. Return Value Type: Zero or more ProcessTemplate tags Required Properties: CategoryName Optional Properties: IncludeTemplateData Access Control Point Name: View Introduced in v5.1
728
Kronos Incorporated
ProcessTemplate Tag
Action Parameters Parameter Name IncludeTemplateData Description The IncludeTempateData specifies 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". Default value: "false" Additional information Introduced in v5.1
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
729
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". Return Value Type: Zero or more ProcessTemplate tags Required Properties: ResourceId, GetHiddenActions Optional Properties: IncludeTemplateData Access Control Point Name: View Introduced in v5.1
730
Kronos Incorporated
ProcessTemplate Tag
Action Parameters Parameter Name GetHiddenActions Description The GetHiddenActions action 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". Default value: "false" Additional information Introduced in v5.1
731
Chapter 2
Description The IncludeTempateData specifies 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 the IncludeTemplateData action parameter is set to "false", TemplateData is returned for each process template. If you do not specify 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 IncludeTemplateData is an optional action parameter on RetrieveAllByResourceId action. It must be set to either "true" or "false". Default value: "false"
732
Kronos Incorporated
ProcessTemplate Tag
Description The ResourceId is a required action parameter on the RetrieveAllByResourceId action. It 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
733
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". Return Value Type: Zero or more ProcessTemplate tags Required Properties: GetHiddenActions Optional Properties: CategoryName, IncludeTemplateData Access Control Point Name: View Introduced in v5.1; last changed in v6.0
734
Kronos Incorporated
ProcessTemplate Tag
Action Parameters Parameter Name CategoryName Description The CategoryName is an optional action parameter on the 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 RetrieveAllForEmployee action. It must be greater than 1 character and less than or equal to 50 characters in length. The GetHiddenActions action parameter is a required action parameter on the RetrieveAllForEmployee 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 RetrieveAllForEmployee action. It can either be set to "true" or "false". Default value: "false" Additional information Introduced in v5.1
GetHiddenActions
Introduced in v5.1
735
Chapter 2
Description The IncludeTempateData specifies 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 the IncludeTemplateData action parameter is set to "false", TemplateData is not returned for each process template. If you do not specify 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 RetrieveAllForEmployee action. It must be set to either "true" or "false". Default value: "false"
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
736
Kronos Incorporated
ProcessTemplate Tag
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". Return Value Type: Zero or more ProcessTemplate tags Required Properties: ResourceId, GetHiddenActions Optional Properties: CategoryName, IncludeTemplateData Access Control Point Name: View Introduced in v5.1
737
Chapter 2
Action Parameters Parameter Name CategoryName Description The CategoryName is an optional 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. The GetHiddenActions action parameter is a required action parameter on the RetrieveAllForManager 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 RetrieveAllForManager action. It must be set to either "true" or "false". Default value: "false" Additional information Introduced in v5.1
GetHiddenActions
Introduced in v5.1
738
Kronos Incorporated
ProcessTemplate Tag
Description The IncludeTempateData specifies whether information that is returned should include TemplateData. If the IncludeTemplateData action parameter is set to "true", TemplateData is returned for each process template. Optional IncludeTemplateData is an optional action parameter on the RetrieveAllForManager action. It can only be set to "true" or "false". Default value: "false" The ResourceId is a required action 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.
ResourceId
Introduced in v5.1
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
739
Chapter 2
IncludeTemplateData action parameter is set to "true", the TemplateData property will be displayed within the XML Response of the returned process template. If the IncludeTemplateData action parameter is set to "false", the TemplateData property will not be displayed within the returned process template as part of the XML Response. By default, the IncludeTemplateData action parameter is set to "false". If you do not specify the IncludeTemplateData action parameter, the IncludeTemplateData is set to "false" and the TemplateData property will not be displayed for each returned process template. The DisplayName is a required property and must be greater than 1 character and <= 50 characters in length. The IncludeTemplateData is an optional action parameter to RetrieveByDisplayName action. It can only be either "true" or "false" value. Return Value Type: ProcessTemplate tag Required Properties: DisplayName Optional Properties: IncludeTemplateData Access Control Point Name: View Introduced in v5.1
740
Kronos Incorporated
ProcessTemplate Tag
Action Parameters Parameter Name IncludeTemplateData Description The IncludeTemplateData action parameter specifies whether information that is returned should include TemplateData property. If the IncludeTemplateData action parameter is set to "true", 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 IncludeTemplateData is an optional action parameter on the RetrieveByDisplayName action. It can only be set to "true" or "false". Default value: "false" Additional information Introduced in v5.1
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 IncludeTemplateData action parameter is set to "true", the TemplateData property will be displayed within the returned process template within the XML Response. If the IncludeTemplateData action parameter is set to "false", the TemplateData property will not be displayed within the returned process template in the returned XML Response. By default, the IncludeTemplateData action parameter is set to "false". If you do not specify the IncludeTemplateData action parameter, the 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
741
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. Return Value Type: ProcessTemplate tag Required Properties: KProcessUniqueKey Optional Properties: IncludeTemplateData Access Control Point Name: View Introduced in v5.1
Action Parameters Parameter Name IncludeTemplateData Description The IncludeTempateData specifies 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 the process template returned. Optional IncludeTemplateData is an optional action parameter on the RetrieveByUniqueKey action. It can only be set to "true" or "false". Default value: "false" Additional information Introduced in v5.1
UpdateOnly This method updates a process template. The following ProcessTemplate properties cannot be updated through this method: the TemplateId, AdminTemplateId, AdminTemplateName, Version, UsedBy,
742
Kronos Incorporated
ProcessTemplate Tag
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 IncludeTemplateData action parameter is set to "true", the TemplateData property 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. Return Value Type: ProcessTemplate tag Required Properties: AdminTemplateId Optional Properties: DisplayName, ActiveSwitch, EffectiveDate, ExpirationDate, ActionListSwitch, CommentText, MaxPoolSize, CategoryNames, IncludeTemplateData Access Control Point Name: Edit Introduced in v5.1
743
Chapter 2
Action Parameters Parameter Name IncludeTemplateData Description The IncludeTempateData specifies 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 the process template returned. Optional IncludeTemplateData is an optional action parameter on the UpdateOnly action. It must be set to either "true" or "false". Default value: "false" Additional information Introduced in v5.1
Property Descriptions
ActionListSwitch
744
Kronos Incorporated
ProcessTemplate Tag
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 Must be greater than zero Sample values: 2101 Introduced in v5.1; last changed in v5.1 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 Maximum length: 60 characters Sample values: Employee_Award.template Introduced in v5.1
745
Chapter 2
CategoryNames
Set of categories
A comma separated list of categories that this process template belongs to. 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 Maximum length: 255 characters Introduced in v5.1 DisplayName
Effective date
746
Kronos Incorporated
ProcessTemplate Tag
The effective date of this process. Type: DateTime Required Must be a valid KDateTime. Sample values: 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
747
Chapter 2
LastDeployed
Template XML
A based-64 encoded string that represents the process template XML. Type: String Required Maximum length: 1 character Introduced in v5.1 TemplateId
Template identifier
The identifier of the process template. Corresponds to the WPMWORKFLOWID column in the WPMWORKFLOW table.
748
Kronos Incorporated
ProcessTemplate Tag
Type: Long Required Key Must be greater than zero Introduced in v5.1 UsedBy
749
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" Parameters None Properties <ProjectingOvertime QueryDateSpan = String > [<Locations> <LocationItem>* </Locations>] </ProjectingOvertime>
Action Descriptions
Load Returns the projecting overtime data. Return Value Type: ProjectingOvertime tag Required Properties: QueryDateSpan Optional Properties: Locations
750
Kronos Incorporated
ProjectingOvertime Tag
Property Descriptions
Locations
751
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddComment" | "AddOnly" | "AddOnlyWithRestrictions" | "Delete" | "RemoveWorkRule" Parameters AddOnly [AccrualOverride = Boolean] [allowAdHoc = Boolean] [EchoData = Boolean] AddOnlyWithRestrictions [AccrualOverride = Boolean] [EchoData = Boolean] RemoveWorkRule [EchoData = Boolean] Properties <Punch OrgJobId = String OrgJobName = String [CommentText = String] Date = Date
752
Kronos Incorporated
Punch Tag
(EnteredOnDate = Date) [CancelDeductRuleName = String] [DaylightSavingsFlag = Boolean] [LaborAccountName = String] [ManagerName = String] Time = Time (EnteredOnTime = Time) [KronosTimeZone = String] [OverrideTypeName = String] [WorkRuleName = String] > [<Notes> <Note>* </Notes>] (<Comments> <Comment>* </Comments>) <Employee> <CurrentUser> | <PersonIdentity> </Employee> </Punch>
Action Descriptions
AddComment Adds a comment to an existing punch. Depending on the type of punch, you may need to specify one of the following properties: LaborAccountName WorkRuleName OverrideTypeName KronosTimeZone
Return Value Type: None Required Properties: CommentText, Date, Employee, Time Access Control Point Name: Edit Introduced in v4
753
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 Required Properties: Employee Optional Properties: Date, Time Access Control Point Name: Edit Introduced in v4
754
Kronos Incorporated
Punch Tag
Action Parameters Parameter Name AccrualOverride Description If the action results in an accrual warning, the warning is overridden when AccrualOverride=True. Optional Default value: False Specifies whether an ad hoc labor level is allowed. Optional Default value: False If True, the Response includes a copy of the tag. Optional Default value: False Additional information Introduced in v4
allowAdHoc
Introduced in v5.0; last changed in v5.0; deprecated in v5.0. Not used Introduced in v4
EchoData
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 Return Value Type: Punch tag Required Properties: Employee Optional Properties: Date, Time Access Control Point Name: Edit Introduced in v6.0; last changed in v6.0
755
Chapter 2
Action Parameters Parameter Name AccrualOverride Description If the action results in an accrual warning, the warning is overridden when AccrualOverride=True. Optional Default value: false If True, the Response includes a copy of the tag. Optional Default value: false Additional information Introduced in v6.0; last changed in v6.0
EchoData
Delete Marks an existing punch for deletion. Return Value Type: None Required Properties: Date, Employee, Time Access Control Point Name: Edit Introduced in v4 RemoveWorkRule Removes the work rule transfer from an existing punch. Return Value Type: Punch tag Required Properties: Date, Employee, Time Access Control Point Name: Edit Introduced in v4
756
Kronos Incorporated
Punch Tag
Action Parameters Parameter Name EchoData Description If True, the Response includes a copy of this tag. Optional Default value: False Additional information Introduced in v4
Property Descriptions
OrgJobId
ID of job in organization
A unique identifier for a job in the organization Type: String You must have Functional Access for Job Transfers. A node with this Id must exist in the organizational structure Default value: Null Introduced in v5.0 OrgJobName
757
Chapter 2
Comments
The set of comments that are returned with this timekeeping item Type: Zero or more Comment tags Output Only Introduced in v4 CommentText
Comment text
Use comment text to provide details about the punch. It contains a comment string that is attached to the punch. Type: String Optional Maximum length: 254 characters Must match exactly an applicable comment that already exists in the database. The string matching is case-sensitive. You can find values in the Workforce Timekeeper Setup Application.
758
Kronos Incorporated
Punch Tag
Introduced in v4 Date
Date of punch
Date contains one of the following entries: The date of a punch that is being added or deleted The date of a punch for which you are adding a comment The date of a punch for which the work rule is being cleared
Type: Date Optional Key Dependency: If Date is specified, Time must also be specified. Introduced in v4; last changed in v5.0 DaylightSavingsFlag
Employee
One employee for whom the punch is credited, as specified in a PersonIdentity or CurrentUser tag. Type: Either CurrentUser or PersonIdentity tag Required, Key
759
Chapter 2
Must uniquely identify an existing and active employee Introduced in v4; last changed in v5.0 EnteredOnDate
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 Maximum length: 30 characters For a list of values, see "Time Zone Definitions" in Appendix B in the Timekeeping DTK Reference Guide. Sample values: 13011, Eastern
760
Kronos Incorporated
Punch Tag
Manager name
The name to replace the user name in audit. Type: String Optional
761
Chapter 2
Comment Notes
The list of notes for the comment to be created from comment text Type: Zero or more Note tags Optional Introduced in v6.0 OverrideTypeName
Type of override
The type of override Type: String Optional Maximum length: 30 characters 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
762
Kronos Incorporated
Punch Tag
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. The following predefined data values are provided: &ALL_WORK_RULES &EMPTY
Type: String Optional Maximum length: 50 characters You can find values in Timekeeping Setup. Sample values: Salaried, Part Time Introduced in v4
763
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "CheckStatus" Parameters None Properties <PunchStatus [Time = DateTime] [DaylightSavingsFlag = Boolean] [KronosTimeZone = Integer] > <Employee> <PersonIdentity> </Employee> (<LaborAccountName> <LaborAccount> </LaborAccountName>) </PunchStatus>
Action Descriptions
764
Kronos Incorporated
PunchStatus Tag
CheckStatus Returns the status (In or Out) of the punch. Return Value Type: PunchStatus tag Required Properties: Employee Access Control Point Name: View Introduced in v5.0; last changed in v5.1
Property Descriptions
DaylightSavingsFlag
Employee
One employee, as specified in a PersonIdentity tag. Type: PersonIdentity tag Required Must uniquely identify an existing and active employee Introduced in v5.0 KronosTimeZone
Time zone
765
Chapter 2
The timezone associated with the date and time. When returning within status, it is the timezone of the punch. Type: Integer Optional For a list of values, see "Time Zone Definitions" in Appendix B in the Timekeeping DTK Reference Guide. Sample values: 13011 Default value: The application server timezone Introduced in v5.0; last changed in v5.0 LaborAccountName
Labor account
If the punch status is in, returns the current labor account transfer Type: LaborAccount tag Output only Maximum length:356 characters Introduced in v5.0 Time
766
Kronos Incorporated
PunchStatus Tag
767
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Delete" | "Retrieve" | "RetrieveAll" | "RetrieveAllNames" | "RetrieveByName" | "RetrieveForUpdate" | "Update" Parameters None Properties <RBSRule Name = String > [<RBSRuleVersions> <RBSRuleVersion>* </RBSRuleVersions>] </RBSRule>
Action Descriptions
Delete Delete the named RBS Rule
768
Kronos Incorporated
RBSRule Tag
Rule cannot be deleted if linked to a work rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2 Retrieve Returns the RBS Rule with the given name. Return Value Type: RBSRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.2 RetrieveAll Retrieve all RBS rules. Return Value Type: Zero or more RBSRule tags Access Control Point Name: View Introduced in v5.2 RetrieveAllNames Returns the names of all RBS Rules defined in the system. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.2 RetrieveByName Retrieve named RBS rule. Return Value Type: RBSRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.2
769
Chapter 2
RetrieveForUpdate Retrieve RBSRule For Update. Name length should be between 1 to 30. Return Value Type: RBSRule tag Required Properties: Name Access Control Point Name: Edit Introduced in v5.2 Update Updates the RBS Rule with the given name. If the rule does not exist, then it will be created. Return Value Type: None Required Properties: Name Optional Properties: RBSRuleVersions Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
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
770
Kronos Incorporated
RBSRule Tag
The data versions of the RBS Rule Type: Zero or more RBSRuleVersion tags Optional Introduced in v5.2
771
Chapter 2
Syntax
Properties <RBSRuleVersion ApplyPremiumToEntireShift = Boolean IsRestIntervalContinuous = Boolean [MaxRestPremiumDuration = TimeDuration] [MinRestPremiumDuration = TimeDuration] [MinShiftLengthDuration = TimeDuration] [Description = String] RuleName = String RequiredRestDuration = TimeDuration LookbackDuration = TimeDuration OutPunchOption = Integer InPunchOption = Integer UnscheduledShiftIsRest = Boolean > </RBSRuleVersion>
Property Descriptions
ApplyPremiumToEntireShift
772
Kronos Incorporated
RBSRuleVersion Tag
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
773
Chapter 2
LookbackDuration
774
Kronos Incorporated
RBSRuleVersion Tag
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
775
Chapter 2
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 Default value: false Introduced in v5.2
776
Kronos Incorporated
ReportProfile Tag
Syntax
Request <Request Action = Actions 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. Name should be valid Return Value Type: ReportProfile tag Required Properties: ReportProfileName
777
Chapter 2
Access Control Point Name: View Introduced in v4 LoadAllReportProfiles Returns a list of all report profiles in the system. Return Value Type: Zero or more ReportProfile tags Required Properties: None Access Control Point Name: View Introduced in v4 LoadById Returns a report profile, based on ReportProfileId. ID must be valid Return Value Type: ReportProfile tag Required Properties: ReportProfileId Access Control Point Name: View Introduced in v4
Property Descriptions
ReportProfileId
Id of report profile
Uniquely identifies the report data access profile in the database Type: Integer Optional Introduced in v4 ReportProfileName
778
Kronos Incorporated
ReportProfile Tag
779
Chapter 2
Syntax
Properties <Request Action = String [OnError = String] [DataSource = String] [Password = Password] [ProcessAsManager = Boolean] [Sequence = String] [Object = String] [FailureURL = String] [SuccessURL = String] [UserName = String] > </Request>
Property Descriptions
Action
780
Kronos Incorporated
Request Tag
781
Chapter 2
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 Introduced in v4; last changed in v5.0 ProcessAsManager
Type: Boolean Optional Sample values: true Default value: false Introduced in v5.1; last changed in v5.1 Sequence
Sequence
782
Kronos Incorporated
Request Tag
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
User name
The logon user id Type: String Optional Required: For logon Action Introduced in v4
783
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AssignCoverShift" | "LoadEligibleEmployees" | "LoadShifts" Parameters None Properties <RequestToCover [IsCheckRules = Boolean] [QueryDate = Date] (IsShiftExists = Boolean) [PartialEndDate = Date] [PartialEndTime = Time] [IsSaveData = Boolean] [QueryDateTimeSpan = DateTimeSpan] [PartialStartDate = Date] [PartialStartTime = Time] > (<RequestToCoverItems> <RequestToCoverItem>* </RequestToCoverItems>) (<RequestToCoverStatus> <CoverShiftStatus>
784
Kronos Incorporated
RequestToCover Tag
</RequestToCoverStatus>) <Employee> <Personality> </Employee> (<RuleViolations> <RuleViolation>* </RuleViolations>) <Employees> <PersonIdentity>* </Employees> </RequestToCover>
Action Descriptions
AssignCoverShift AssignCoverShift assigns a shift to an employee to cover another shift. Return Value Type: Zero or more RuleViolation tags Required Properties: QueryDateTimeSpan, Employees Optional Properties: PartialStartDate,PartialEndDate,PartialStartTime,PartialEndTime,IsSaveData,IsC heckRules Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1 LoadEligibleEmployees LoadEligibleEmployees returns eligible employees who can work for the specified shift. Return Value Type: RequestToCover tag Required Properties: QueryDateTimeSpan, Employee Access Control Point Name: View Introduced in v5.1; last changed in v5.1 LoadShifts The LoadShifts action will load all shifts for the specified employee and a query date.
785
Chapter 2
Return Value Type: RequestToCover tag Required Properties: QueryDate,Employee Access Control Point Name: View Introduced in v5.1; last changed in v5.1
Property Descriptions
Employee
Requesting employee
The employee who requests his/her shift to be covered. Type: Personality tag Optional Key It must be an active employee. Introduced in v5.1; last changed in v5.2 Employees
Check rules?
This property indicates whether schedule rule validation should be checked. Type: Boolean Optional
786
Kronos Incorporated
RequestToCover Tag
Save changes?
This property indicates whether the changes made by an action will be persisted to the database. Type: Boolean Optional Introduced in v5.1; last changed in v5.1 IsShiftExists
787
Chapter 2
Date to query
The date to query for a specified employee's shifts. Type: Date Optional It must be a valid date. Introduced in v5.1; last changed in v5.2 QueryDateTimeSpan
788
Kronos Incorporated
RequestToCover Tag
This property represents the start date and time and end date and time of a schedule. Type: DateTimeSpan Optional It must be a valid date time span. Introduced in v5.1; last changed in v5.1 RequestToCoverItems
789
Chapter 2
Syntax
Properties <RequestToCoverItem (DateTimeSpan = DateTimeSpan) > (<OrgJobPaths> <LocationItem>* </OrgJobPaths>) </RequestToCoverItem>
Property Descriptions
DateTimeSpan
790
Kronos Incorporated
RequestToCoverItem Tag
791
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Update" Parameters None Properties <ResetAccrual AmountInCurrency = Currency AmountInTime = TimeDuration AmountInTimeOrCurrency = String ProbationAmountInCurrency = Currency ProbationAmountInTime = TimeDuration AccrualCodeName = String Date = Date > <Employee> <CurrentUser> | <PersonIdentity> </Employee> </ResetAccrual>
792
Kronos Incorporated
ResetAccrual Tag
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. Return Value Type: None Required Properties: AccrualCodeName, Date, Employee Access Control Point Name: Edit Introduced in v4
Property Descriptions
AmountInCurrency
793
Chapter 2
AmountInTimeOrCurrency
794
Kronos Incorporated
ResetAccrual Tag
Date
The date when the accrual transaction is effective Type: Date Required Introduced in v4 Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag. Type: Either CurrentUser or PersonIdentity tag Required Key Must uniquely identify an existing and active employee
795
Chapter 2
Introduced in v4
796
Kronos Incorporated
Response Tag
Syntax
Properties <Response (Message = String) (Sequence = String) (Status = String) (TransactionSequence = String) > </Response>
Property Descriptions
Message
797
Chapter 2
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
798
Kronos Incorporated
RoleProfileKBO Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddOnly" | "Delete" | "Duplicate" | "Retrieve" | "RetrieveAll" | "RetrieveAllNames" | "RetrieveForUpdate" | "RetrieveRoleProfiles" | "Update" | "UpdateOnly" Parameters Update [NewName = String] UpdateOnly [NewName = String] Properties <RoleProfileKBO [AccessProfileName = String] [Description = String] [PreferenceProfileName = String] [Name = String] > </RoleProfileKBO>
799
Chapter 2
Action Descriptions
AddOnly Adds the role profile with the given [Name] to the database. Return Value Type: None Required Properties: Name,AccessProfileName,PreferenceProfileName Optional Properties: Description Access Control Point Name: Edit Introduced in v5.2; last changed in v5.2 Delete Deletes the role profile by name Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2; last changed in v5.2 Duplicate Creates a duplicate of the existing role profile with the name "copy of [Name]" Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2; last changed in v5.2 Retrieve The length of the name should not exceed 50. The length of the name should not exceed 50. Return Value Type: (***undefined***): Required Properties: Name Access Control Point Name: View
800
Kronos Incorporated
RoleProfileKBO Tag
Introduced in v5.2 RetrieveAll Retrieves all the available RoleProfile objects. Return Value Type: Zero or more RoleProfileKBO tags Access Control Point Name: View Introduced in v5.2 RetrieveAllNames Return the collection of names of RoleProfile objects required for Setup Data Manager. Return Value Type: Collection list Access Control Point Name: View Introduced in v5.2 RetrieveForUpdate Returns a single instance of RoleProfileKBO which can be used for Update by SDM. Return Value Type: RoleProfileKBO tag Required Properties: Name Access Control Point Name: View Introduced in v5.2 RetrieveRoleProfiles Retrieves list of all profiles in the database Return Value Type: (***undefined***): Access Control Point Name: View Introduced in v5.2 Update This method will update if the RoleProfile object exists with the given name otherwise creates a new a object. Return Value Type: None Required Properties: Name
801
Chapter 2
Optional Properties: Description Access Control Point Name: Edit Introduced in v5.2; last changed in v5.2
Action Parameters Parameter Name NewName Description RoleProfile will be created with the given NewName if it doesn't exist already. Optional Additional information Introduced in v5.2
UpdateOnly Updates the role profile info in the delegaterole table name should not exceed 50 chars Return Value Type: None Required Properties: Name Optional Properties: Description, AccessProfileName, PreferenceProfileName Access Control Point Name: Edit Introduced in v5.2; last changed in v5.2
Action Parameters Parameter Name NewName Description The new name of the RoleProfile that will be updated as the given New Name parameter. Optional Additional information Introduced in v5.2
Property Descriptions
AccessProfileName
802
Kronos Incorporated
RoleProfileKBO Tag
The function Access Profile Name that will be included as part of the Role Profile. Type: String Optional Introduced in v5.2 Description
Description
Role Profile Description Type: String Optional Introduced in v5.2 Name
803
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "Update" Parameters None Properties <RuleSetEmployeeAssign [PersonNumber = String] > <Employees> <PersonIdentity>* </Employees> <EmployeeRuleSetItems> <EmployeeRuleSetItem>* </EmployeeRuleSetItems> </RuleSetEmployeeAssign>
Action Descriptions
Load Returns the rule set assignments for an employee
804
Kronos Incorporated
RuleSetEmployeeAssign Tag
Required Properties: PersonNumber Access Control Point Name: View Introduced in v5.0 Update Assigns rule sets to one or more employees. Return Value Type: None Required Properties: EmployeeRuleSetItems, Employees Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0
Property Descriptions
EmployeeRuleSetItems
Employees
One or more employees for whom the rule set is assigned, as specified in one or more PersonIdentity tags. Type: Zero or more PersonIdentity tags Required Each employee specified must have a WFS license. Introduced in v5.0; last changed in v5.0 PersonNumber
Person number
805
Chapter 2
Person number of the person about whom information is returned Type: String Optional Maximum length: 15 characters This person must have WFS license. Introduced in v5.0; last changed in v5.0
806
Kronos Incorporated
SchedGenSettings Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Add" | "AddOnly" | "Delete" | "DeleteOnly" | "Retrieve" | "RetrieveAll" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" | "UpdateOnly" Parameters None Properties <SchedGenSettings [Description = String] SettingsName = String > [<OrgPaths> <SimpleValue>* </OrgPaths>] [<SettingsParamValues> <SettingsParamValue>*
807
Chapter 2
</SettingsParamValues>] </SchedGenSettings>
Action Descriptions
Add Add a schedule generator settings object into the system. If it already exists an update is performed. Return Value Type: None Required Properties: SettingsName Optional Properties: Description, SettingsParamValues, OrgPaths Access Control Point Name: Edit Introduced in v6.0 AddOnly Add a new schedule generator settings object into the system. If it already exists an error is thrown. Return Value Type: None Required Properties: SettingsName Optional Properties: Description, SettingsParamValues, OrgPaths Access Control Point Name: Edit Introduced in v6.0 Delete Delete a schedule generator settings object. If the object doesn't exist, no exception is thrown. Return Value Type: None Required Properties: SettingsName Access Control Point Name: Edit Introduced in v6.0
808
Kronos Incorporated
SchedGenSettings Tag
DeleteOnly Delete a schedule generator settings object with the specified name. If the object doesn't exist, an error is thrown. Return Value Type: None Required Properties: SettingsName Access Control Point Name: Edit Introduced in v6.0 Retrieve Return the schedule generator settings object with the specified name. Return Value Type: SchedGenSettings tag Required Properties: SettingsName Access Control Point Name: View Introduced in v6.0 RetrieveAll Return all the schedule generator settings objects. Return Value Type: Zero or more SchedGenSettings tags Access Control Point Name: View Introduced in v6.0 RetrieveAllForUpdate Return a list of schedule generator settings objects. This action is used for future updates. Return Value Type: Zero or more SchedGenSettings tags Access Control Point Name: View Introduced in v6.0 RetrieveAllNames Return a schedule generator settings names list. Return Value Type: (***undefined***): KBusinessObjectNameList Access Control Point Name: View
809
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 Required Properties: SettingsName Access Control Point Name: View Introduced in v6.0 Update Update the schedule generator settings object. If it does not exist an add is performed. Return Value Type: None Required Properties: SettingsName Optional Properties: Description, SettingsParamValues, OrgPaths Access Control Point Name: Edit Introduced in v6.0 UpdateOnly Update a schedule generator settings object. If it does not exist an error is thrown. Return Value Type: None Required Properties: SettingsName Optional Properties: Description, SettingsParamValues, OrgPaths Access Control Point Name: Edit Introduced in v6.0
Property Descriptions
Description
810
Kronos Incorporated
SchedGenSettings Tag
Type: String Optional Sample values: <Description> This is a description.</Description> Introduced in v6.0; last changed in v6.0 OrgPaths
Location path
Represents the organizational nodes associated to a schedule generator settings object. Type: Zero or more SimpleValue tags Optional Path must be valid on this date. Path must be acessible to logged-on user. Sample values: <OrgPaths> <SimpleValue Value="Organization/Hospitals/Hosp A/ Floor 1" /> </OrgPaths> Introduced in v6.0; last changed in v6.0 SettingsName
811
Chapter 2
SettingsParamValues
Settings objectsparametersvalues'
Represents the schedule generator settings object's parameters values. Type: Zero or more SettingsParamValue tags Optional Parameter names must be SchedGenSettings type parameters. Sample values: <SettingsParamValues> <SettingsParamValue Name="PARAM" Value="test"/> </SettingsParamValues> Introduced in v6.0; last changed in v6.0
812
Kronos Incorporated
SchedGenSettingsValue Tag
Syntax
Request <Request Action = Actions 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
813
Chapter 2
Required Properties: OrgPaths Access Control Point Name: View Introduced in v6.0
Property Descriptions
OrgPaths
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 Introduced in v6.0; last changed in v6.0
814
Kronos Incorporated
SchedRule Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Add" | "AddOnly" | "Delete" | "DeleteOnly" | "Retrieve" | "RetrieveAll" | "RetrieveAllNames" | "RetrieveForUpdate" | "RetrievesAllForUpdate" | "Update" | "UpdateOnly" Parameters None Properties <SchedRule ContextName = String [Description = String] RuleName = String SortOrderName = String TopicName = String > [<CustomOperators>
815
Chapter 2
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. Return Value Type: None Required Properties: RuleName, ContextName, TopicName, SortOrderName Optional Properties: Description, TopicParameterValues, CustomOperators Access Control Point Name: Edit Introduced in v6.0 AddOnly Adds a sorting or matching rule object into the system . If it is already there an error is thrown. Return Value Type: None Required Properties: RuleName, ContextName, TopicName, SortOrderName Optional Properties: Description, TopicParameterValues, CustomOperators Access Control Point Name: Edit Introduced in v6.0 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. Return Value Type: None Required Properties: RuleName Access Control Point Name: Edit
816
Kronos Incorporated
SchedRule Tag
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. Return Value Type: None Required Properties: RuleName Access Control Point Name: Edit Introduced in v6.0 Retrieve Retrieves the sorting or matching rule object by name. Return Value Type: SchedRule tag Required Properties: RuleName Access Control Point Name: View Introduced in v6.0 RetrieveAll Retrieves all sorting or matching rule objects. Return Value Type: Zero or more SchedRule tags Access Control Point Name: View Introduced in v6.0 RetrieveAllNames Retrieves all sorting or matching rule objects names. Return Value Type: String list Access Control Point Name: View Introduced in v6.0 RetrieveForUpdate Retrieves the sorting or matching rule object specified by name for future updates. Return Value Type: SchedRule tag Required Properties: RuleName
817
Chapter 2
Access Control Point Name: View 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 Access Control Point Name: View 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. Return Value Type: None Required Properties: RuleName Optional Properties: ContextName, TopicName, SortOrderName, Description, TopicParameterValues, CustomOperators Access Control Point Name: Edit Introduced in v6.0 UpdateOnly Updates a sorting or matching rule object into the system. If it is not there an error is thrown. Return Value Type: None Required Properties: RuleName Optional Properties: ContextName, TopicName, SortOrderName, Description, TopicParameterValues, CustomOperators Access Control Point Name: Edit Introduced in v6.0
Property Descriptions
ContextName
818
Kronos Incorporated
SchedRule Tag
The name of the context. Type: String Required Sample values: SORTING_SHIFTS Introduced in v6.0 CustomOperators
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: <Description> This is a description</Description>
819
Chapter 2
Rule Name
The name of the rule. Type: String Required Key Sample values: <RuleName> test Rule</RuleName> Introduced in v6.0 SortOrderName
820
Kronos Incorporated
SchedRule Tag
821
Chapter 2
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View
822
Kronos Incorporated
SchedRuleContext Tag
Introduced in v6.0 RetrieveAll Retrieves all sorting or mathcing rule's context objects from the database. Return Value Type: Zero or more SchedRuleContext tags Access Control Point Name: View Introduced in v6.0 RetrieveAllNames Retrieves the names of all sorting or matching rule's context objects. Return Value Type: String list Access Control Point Name: View Introduced in v6.0
Property Descriptions
ContextName
Context Name
The name of the context to retrieve. Type: String Required Key Introduced in v6.0
823
Chapter 2
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View
824
Kronos Incorporated
SchedRuleOperator Tag
Introduced in v6.0 RetrieveAll Retrieves all sorting or matching rule's operator objects. Return Value Type: Zero or more SchedRuleOperator tags Access Control Point Name: View Introduced in v6.0 RetrieveAllNames Retrieves all sorting or matching rule's operator objects names. Return Value Type: String list Access Control Point Name: View Introduced in v6.0
Property Descriptions
OperatorName
Operator Name
Represents the sorting and matching rule operator name. Type: String Required Key Sample values: EQUAL Introduced in v6.0
825
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Add" | "AddOnly" | "Delete" | "DeleteOnly" | "Retrieve" | "RetrieveAll" | "RetrieveAllNames" | "RetrieveForUpdate" | "RetrievesAllForUpdate" | "Update" | "UpdateOnly" Parameters None Properties <SchedRuleSet ContextName = String [Description = String] RuleSetName = String > [<SchedRules> <SchedRule>* </SchedRules>]
826
Kronos Incorporated
SchedRuleSet Tag
</SchedRuleSet>
Action Descriptions
Add Adds a sorting or matching rule set object into the system. If already exists nothing happens. Return Value Type: None Required Properties: RuleSetName, ContextName Optional Properties: Description Access Control Point Name: Edit Introduced in v6.0 AddOnly Adds a sorting or matching rule set object into the system. If already exists an error is thrown. Return Value Type: None Required Properties: RuleSetName, ContextName Optional Properties: Description Access Control Point Name: Edit Introduced in v6.0 Delete Deletes a sorting or matching rule set object from the system. If already exists nothing happens. Return Value Type: None Required Properties: RuleSetName Access Control Point Name: Edit Introduced in v6.0
827
Chapter 2
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. Return Value Type: None Required Properties: RuleSetname Access Control Point Name: Edit Introduced in v6.0 Retrieve Retrieves a sorting or matching rule set object by name. Return Value Type: SchedRuleSet tag Required Properties: RuleSetName Access Control Point Name: View Introduced in v6.0 RetrieveAll Retrieves all sorting or matching rule set objects. Return Value Type: Zero or more SchedRuleSet tags Access Control Point Name: View Introduced in v6.0 RetrieveAllNames Retrieves all sorting or matching rule set objects names. Return Value Type: String list Access Control Point Name: View 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 Required Properties: RuleSetName
828
Kronos Incorporated
SchedRuleSet Tag
Access Control Point Name: View Introduced in v6.0 RetrievesAllForUpdate Retrieves all sorting and matching rule set objects. Return Value Type: Zero or more SchedRuleSet tags Access Control Point Name: View Introduced in v6.0 Update Updates a sorting or matching rule set object into the system. If doesn't exists it will be updated. Return Value Type: None Required Properties: RuleSetName Access Control Point Name: Edit Introduced in v6.0 UpdateOnly Updates a sorting or matching rule set object into the system. If doesn't exists an error is thrown. Return Value Type: None Required Properties: RuleSetName Access Control Point Name: Edit Introduced in v6.0
Property Descriptions
ContextName
829
Chapter 2
830
Kronos Incorporated
SchedRuleSet Tag
Optional Sample values: <SchedRules> <SchedRule RuleName=Shift Start Time Rule Description=This will sort shifts based on their start time. TopicName=SHIFT_START_TIME ContextName=SORTING_SHIFTS SortOrderName=ASCENDING /> </ SchedRules > Introduced in v6.0
831
Chapter 2
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View
832
Kronos Incorporated
SchedRuleSortOrder Tag
Introduced in v6.0 RetrieveAll Retrieves all sorting or matching rule's sort order objects. Return Value Type: Zero or more SchedRuleSortOrder tags Access Control Point Name: View Introduced in v6.0 RetrieveAllNames Retrieves all sorting or matching rule's sort order objects names. Return Value Type: String list Access Control Point Name: View Introduced in v6.0
Property Descriptions
SortOrderName
833
Chapter 2
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View
834
Kronos Incorporated
SchedRuleTopic Tag
Introduced in v6.0 RetrieveAll Retrieves all sorting or matching rule's topic objects. Return Value Type: Zero or more SchedRuleTopic tags Access Control Point Name: View Introduced in v6.0 RetrieveAllNames Retrieves all sorting or matching rule's topic objects names. Return Value Type: String list Access Control Point Name: View Introduced in v6.0
Property Descriptions
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
835
Chapter 2
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View
836
Kronos Incorporated
SchedRuleValueType Tag
Introduced in v6.0 RetrieveAll Retrieves all sorting or matching rule's value type objects. Return Value Type: Zero or more SchedRuleValueType tags Access Control Point Name: View Introduced in v6.0 RetrieveAllNames Retrieves all sorting or matching rule's value type objects names. Return Value Type: String list Access Control Point Name: View Introduced in v6.0
Property Descriptions
ValueTypeName
837
Chapter 2
Syntax
Request <Request Action = Actions 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
838
Kronos Incorporated
Schedule Tag
Properties <Schedule [IsForeverPattern = Boolean] [IsOpenShift = Boolean] [OrgJobPath = String] [SaveData = Boolean] QueryDateSpan = DateSpan [CheckRules = Boolean] > [<AppendShifts> <AppendShifts>* </AppendShifts>] <Employees> <CurrentUser> | <PersonIdentity> </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>* </TransferEmployees>] </Schedule>
839
Chapter 2
Action Descriptions
AddScheduleItems Adds the specified items into the schedule for the identified people and time period Return Value Type: None Required Properties: ScheduleItems, QueryDateSpan Access Control Point Name: Edit Introduced in v4 AddShiftRemovingOverlaps Adds the specified shift item for an employee, and removes any existing shift item that overlaps within the time span QueryDateSpan must identify just one day. Employees must specify just one employee. ScheduleItems must contain just one ScheduleShift tag. Return Value Type: Zero or more RuleViolation tags Required Properties: QueryDateSpan, Employees, ScheduleItems Optional Properties: SaveData, CheckRules Access Control Point Name: Edit Introduced in v5.0 AppendShift Appends shift for specified employees. At lease one of the optional properties must be present. Return Value Type: None Required Properties: AppendShifts, QueryDateSpan Optional Properties: Employees, ScheduleGroups Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1
840
Kronos Incorporated
Schedule Tag
AssignBreaks Assigns breaks, based on the break placement rules, to the shift identified by the query date span and employee The query date span and each employee, taken together, must identify an existing shift Return Value Type: None Required Properties: QueryDateSpan, Employees Access Control Point Name: Edit Introduced in v5.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. Return Value Type: Zero or more RuleViolation tags Required Properties: QueryDateSpan, Employees, OrgJobPath, OpenShiftItems Optional Properties: SaveData, CheckRules Access Control Point Name: Edit Introduced in v5.0; last changed in v5.1 CheckRuleViolations Returns all rule violations that exist in the current schedule for the specified employees and/or jobs. At least one of the optional properties must be present. Return Value Type: Zero or more RuleViolation tags Required Properties: QueryDateSpan Optional Properties: Employees, OrgJobPath, OrgJobPaths Access Control Point Name: View Introduced in v5.0; last changed in v5.1
841
Chapter 2
Delete Marks all schedule items for deletion from the identified schedule period. At least one of the optional properties must be present. Return Value Type: None Required Properties: QueryDateSpan Optional Properties: Employees, ScheduleGroups Access Control Point Name: Edit Introduced in v4; last changed in v5.1 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. Return Value Type: None Required Properties: QueryDateSpan Optional Properties: Employees, ScheduleGroups Access Control Point Name: Edit Introduced in v4; last changed in v5.1 EditScheduleItems Modifies one or more existing schedule items. At least one of the optional properties must be present. Return Value Type: None Required Properties: ScheduleItems, QueryDateSpan Optional Properties: Employees, ScheduleGroups Access Control Point Name: Edit Introduced in v5.0; last changed in v5.1 Load Returns all schedule items and patterns for the specified people and time period. Any item that is not currently active returns a value of True for the IsDeleted property. At least one of the optional properties must be present.
842
Kronos Incorporated
Schedule Tag
Return Value Type: Schedule tag Required Properties: QueryDateSpan Optional Properties: Employees, ScheduleGroups, IsOpenShift, OrgJobPath Access Control Point Name: View Introduced in v4; last changed in v6.0 LockDays Locks the days for specified employees. At least one of the optional properties must be present. Return Value Type: None Required Properties: QueryDateSpan Optional Properties: Employees, ScheduleGroups Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1 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 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.
843
Chapter 2
If Locations, OrgJobPath, or Employees is specified, QueryDateSpan must also be specified. Return Value Type: None Required Properties: QueryDateSpan Optional Properties: Locations, OrgJobPaths, Employees, ScheduleItems Access Control Point Name: Edit Introduced in v5.0; last changed in v5.1 RemoveScheduleItems Removes the specified items for the specified identified time period Return Value Type: None Required Properties: ScheduleItems, QueryDateSpan Access Control Point Name: Edit Introduced in v4 RemoveSpecifiedScheduleItems Removes the specified items for the specified identified time period Return Value Type: None Required Properties: ScheduleItems, QueryDateSpan Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1 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 values to 1 when performing a replaceshifts action. Return Value Type: None Required Properties: QueryDateSpan Optional Properties: Employees, ScheduleGroups
844
Kronos Incorporated
Schedule Tag
Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1 TransferEmployees Transfers employees to other jobs. At least one of the optional properties must be present. Return Value Type: None Required Properties: TransferEmployees, QueryDateSpan Optional Properties: Employees, ScheduleGroups Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1 UnLockDays UnLockDays for the specified employees. At least one of the optional properties must be present. Return Value Type: None Required Properties: QueryDateSpan Optional Properties: Employee, ScheduleGroups Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1 UnlockShifts Locks schedule shifts can be used for the following cases: QueryDateSpan and one or more Locations QueryDateSpan and one or more OrgJobPaths QueryDateSpan and one or more Employees QueryDateSpan spanning 1 day, one employee
845
Chapter 2
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 Required Properties: QueryDateSpan Optional Properties: Locations, OrgJobPaths, Employees, ScheduleItems Access Control Point Name: Edit Introduced in v5.0; last changed in v5.1 Update Replaces the specified items and patterns from the schedule period At least one employee or group must be specified. Return Value Type: None Required Properties: ScheduleItems, QueryDateSpan Access Control Point Name: Edit Introduced in v4
Property Descriptions
AppendShifts
Append shifts
AppendShifts Type: Zero or more AppendShifts tags Optional Introduced in v5.1
846
Kronos Incorporated
Schedule Tag
CheckRules
Employees
One or more employees for whom the schedule is valid, as specified in one or more PersonIdentity or CurrentUser tags. Type: Either CurrentUser or PersonIdentity tag Optional Key Introduced in v4; last changed in v5.0 IsForeverPattern
847
Chapter 2
Specifies whether the shift is open. If True, the shift is open. Type: Boolean Optional Enumerated value: True, False Introduced in v5.0; last changed in v5.0 Locations
Locations
Locations property is used to load the schedule for a specific locations into the container that gets created. Used for locking/unlocking shifts Type: Zero or more LocationItem tags Optional Introduced in v5.1 OpenShiftItems
848
Kronos Incorporated
Schedule Tag
Organizational jobs
OrgJobPaths specifies a list of OrgJobs. It is similar to multiple OrgJobPath properties. Type: Zero or more LocationItem tags Optional All items in the list must identity organizational jobs. Introduced in v5.0 PartialShiftItems
849
Chapter 2
SaveData indicates whether the modified schedule will be saved. Type: Boolean Optional 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
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.
850
Kronos Incorporated
Schedule Tag
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 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
851
Chapter 2
Syntax
Properties <ScheduleAccrualAmountEdit AmountInCurrency = Currency AmountInTime = TimeDuration AccrualCodeName = String (IsDeleted = Boolean) [ScheduleGroupName = String] Startdate = Date > [<Employee> <CurrentUser> | <PersonIdentity> </Employee>] </ScheduleAccrualAmountEdit>
Property Descriptions
AmountInCurrency
852
Kronos Incorporated
ScheduleAccrualAmountEdit Tag
AmountInTime
Employee
One employee who is assigned to the shift, as specified in a PersonIdentity or CurrentUser tag. Type: Either CurrentUser or PersonIdentity tag Optional Must uniquely identify an existing and active employee Introduced in v4
853
Chapter 2
IsDeleted
Type: Boolean Output only Enumerated value: True, False Introduced in v5.0; last changed in v5.0 ScheduleGroupName
Start date
The start date for this item Type: Date Required Must be within the span of the containing schedule Introduced in v4
854
Kronos Incorporated
ScheduleAccrualAmountEdit Tag
855
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Delete" | "Update" Parameters None Properties <ScheduleAccrualPattern AmountInCurrency = Currency AmountInTime = TimeDuration AccrualCodeName = String IsForeverPattern = Boolean (PeriodLengthInDays = Integer) [PeriodLength = Integer] QueryDateSpan = DateSpan [AnchorDate = Date] [PeriodCodeName = String] > <AccrualPatternElements> <AccrualPatternElement>* </AccrualPatternElements> [<Employees> <PersonIdentity> </Employees>]
856
Kronos Incorporated
ScheduleAccrualPattern Tag
Action Descriptions
Delete Marks an existing accrual pattern from an employee or a group for deletion The existing pattern anchor time must be within the query data span. Return Value Type: None Required Properties: AccrualCodeName Access Control Point Name: Edit Introduced in v4 Update Adds a new pattern or updates an existing one for an employee or a group Return Value Type: None Required Properties: AccrualCodeName Access Control Point Name: Edit Introduced in v4
Property Descriptions
AmountInCurrency
857
Chapter 2
AmountInTime
858
Kronos Incorporated
ScheduleAccrualPattern Tag
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. Type: PersonIdentity tag Optional Must uniquely identify an existing and active employee Introduced in v4 IsForeverPattern
859
Chapter 2
Enumerated value: Daily, Weekly, Monthly, Annually, Pay Period, Schedule Period Introduced in v4 PeriodLength
Number of units
The number of units in the availability pattern, as specified by the PeriodCodeName. For example, if the PeriodCodeName is Weeks and PeriodLength is 3, this number specifies three weeks. Type: Integer Optional Introduced in v4 PeriodLengthInDays
860
Kronos Incorporated
ScheduleAccrualPattern Tag
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
861
Chapter 2
Syntax
Properties <ScheduleCostPaycode (Hours = Time) (Label = String) (Wages = Currency) > </ScheduleCostPaycode>
Property Descriptions
Hours
Paycode label
A label for the paycode
862
Kronos Incorporated
ScheduleCostPaycode Tag
Type: String Output only none Sample values: Summary Default value: none Introduced in v5.0a; last changed in v5.0a Wages
863
Chapter 2
Syntax
Properties <ScheduleCostResult (Label = String) > (<Paycodes> <ScheduleCostPaycode>* </Paycodes>) </ScheduleCostResult>
Property Descriptions
Label
864
Kronos Incorporated
ScheduleCostResult Tag
Paycodes
865
Chapter 2
Syntax
Properties <ScheduleCostSummary SummaryType = String Grouping = String [Updated = Boolean] > (<Results> <ScheduleCostResult>* </Results>) </ScheduleCostSummary>
Property Descriptions
Grouping
Job or account?
Specifies whether the results should be indexed by job or by account. Type: String Required Enumerated value: job, account Introduced in v5.0a; last changed in v5.0a Results
866
Kronos Incorporated
ScheduleCostSummary Tag
Type: Zero or more ScheduleCostResult tags Output only Introduced in v5.0a; last changed in v5.0a 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 Introduced in v5.0a; last changed in v5.0a Updated
867
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAll" | "RetrieveDetails" | "RetrieveOpenShifts" | "RetrieveSummary" Parameters None Properties <ScheduleCoverage QueryDateSpan = String > [<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.
868
Kronos Incorporated
ScheduleCoverage Tag
Return Value Type: ScheduleCoverage tag Required Properties: QueryDateSpan Optional Properties: Locations Access Control Point Name: View Introduced in v6.0 RetrieveDetails This will retrieve data that may be either from the cache or the calculation by the Schedule container for coverage details. Return Value Type: Zero or more CoverageDetail tags Required Properties: QueryDateSpan Optional Properties: Locations Access Control Point Name: View Introduced in v6.0 RetrieveOpenShifts This will retrieve data that may be either from the cache or the calculation by the Schedule container for open shifts. Return Value Type: Zero or more OpenShift tags Required Properties: QueryDateSpan Optional Properties: Locations Access Control Point Name: View Introduced in v6.0 RetrieveSummary This will retrieve data that may be either from the cache or the calculation by the Schedule container for staffing requirements summary. Return Value Type: Zero or more StaffingRequirement tags Required Properties: QueryDateSpan Optional Properties: Locations Access Control Point Name: View
869
Chapter 2
Introduced in v6.0
Property Descriptions
Locations
870
Kronos Incorporated
ScheduleGroup Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddEmployees" | "Delete" | "Load" | "LoadAllGroups" | "RemoveEmployees" | "RemoveEmployeesByDateSpan" | "Update" Parameters None Properties <ScheduleGroup [QueryDateSpan = DateSpan] [AllowsInheritance = Boolean] [AllowContract = Boolean] [IsOverrideConflict = Boolean] [ScheduleGroupName = String] > [<GroupMemberships> <GroupMembership>*
871
Chapter 2
</GroupMemberships>] </ScheduleGroup>
Action Descriptions
AddEmployees Adds one or more employees to the existing group for the specified period of time Return Value Type: None Required Properties: ScheduleGroupName, Group Memberships Access Control Point Name: Edit Introduced in v4 Delete Marks a specified group for deletion Return Value Type: None Required Properties: ScheduleGroupName Access Control Point Name: Edit 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 Access Control Point Name: View Introduced in v4 LoadAllGroups Returns all groups in the system Return Value Type: Zero or more ScheduleGroup tags Required Properties: None Access Control Point Name: View Introduced in v4
872
Kronos Incorporated
ScheduleGroup Tag
RemoveEmployees Removes one or more employees from the schedule group for the specified period of time Return Value Type: None Required Properties: ScheduleGroupName, GroupMemberships Access Control Point Name: Edit Introduced in v4 RemoveEmployeesByDateSpan Removes one or more employees from the specified group for the specified date range All of the employees to be removed must be specified in the GroupMembership list. Return Value Type: None Required Properties: GroupMemberships Access Control Point Name: Edit Introduced in v4 Update Modifies the employee list for the specified group and date span Return Value Type: None Required Properties: ScheduleGroupName, QueryDateSpan Access Control Point Name: Edit Introduced in v4
Property Descriptions
AllowContract
873
Chapter 2
Optional Default value: false Introduced in v6.0; last changed in v6.0 AllowsInheritance
874
Kronos Incorporated
ScheduleGroup Tag
The range of dates when the schedule is valid for the group members Type: DateSpan Optional Introduced in v4 ScheduleGroupName
875
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "Load" | "LoadAllScheduleGroupProfiles" | "LoadById" Parameters None Properties <ScheduleGroupProfile [ScheduleGroupId = Integer] [ScheduleGroupName = String] > </ScheduleGroupProfile>
Action Descriptions
Load Returns a schedule group. Name should be valid
876
Kronos Incorporated
ScheduleGroupProfile Tag
Return Value Type: ScheduleGroup tag Access Control Point Name: View Introduced in v4 Load Returns a schedule group, based on ScheduleGroupName. Name should be valid Return Value Type: ScheduleGroupProfile tag Required Properties: ScheduleGroupName Access Control Point Name: View Introduced in v4; last changed in v5.1 LoadAllScheduleGroupProfiles Returns all schedule group profiles in the system. Return Value Type: Zero or more ScheduleGroup tags Required Properties: None Access Control Point Name: View Introduced in v4 LoadById Returns a schedule group, based on ScheduleGroupId. ID must be valid Return Value Type: ScheduleGroup tag Required Properties: ScheduleGroupId Access Control Point Name: View Introduced in v4; last changed in v5.1
Property Descriptions
ScheduleGroupId
877
Chapter 2
Uniquely identifies the schedule group in the database Type: Integer Optional Introduced in v4; last changed in v6.0 ScheduleGroupName
878
Kronos Incorporated
ScheduleHours Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddOnly" | "CancelTimeOff" Parameters None Properties <ScheduleHours [AmountInTime = TimeDuration] [IsAllDays = Boolean] [IsCreateOpenShift = Boolean] QueryDateSpan = DateSpan [IsOverride = Boolean] PaycodeName = String [IsSaveData = Boolean] [UnavailableDuration = TimeDuration] [DisplayTime = Time] [UnavailableStartTime = Time] [IsCheckRules = Boolean] > <Employee> <PersonIdentity> </Employee> </ScheduleHours>
879
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. Return Value Type: Zero or more RuleViolation tags Required Properties: Employee, QueryDateSpan, PaycodeName Optional Properties: AmountInTime, DisplayTime, IsAllDays,UnavailableDuration, IsCreateOpenShift, IsOverride, IsSaveData, IsCheckRules Access Control Point Name: Edit 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 Access Control Point Name: Edit Introduced in v5.1Beta
Property Descriptions
AmountInTime
880
Kronos Incorporated
ScheduleHours Tag
Dependency: If AmountInTime is used, the pay code must be associated with time, rather than currency. Introduced in v5.0 DisplayTime
Employee
One employee, as specified in a PersonIdentity tag Type: PersonIdentity tag 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
881
Chapter 2
Dependency: If True, AmountInTime and DisplayTime must be specified. Default value: False Introduced in v5.0; last changed in v5.2 IsCheckRules
882
Kronos Incorporated
ScheduleHours Tag
Type: Boolean Optional Dependency: If IsCreateOpenShift is True, IsOverride must also be True. Default value: True Introduced in v5.0 IsSaveData
Pay code
The pay code that will override or add to the person scheduled hours Type: String Required Maximum length: 50 characters The pay code must be a monetary type. Introduced in v5.0 QueryDateSpan
883
Chapter 2
884
Kronos Incorporated
ScheduleHoursAccrualViolation Tag
Syntax
Properties <ScheduleHoursAccrualViolation (ViolationMessage = String) > </ScheduleHoursAccrualViolation>
Property Descriptions
ViolationMessage
Violation message
The violation message Type: String Output only Cannot be null. Introduced in v5.1Beta; last changed in v5.1
885
Chapter 2
Syntax
Properties <ScheduleHoursDailyStatus (Date = Date) (ScheduledShiftExist = Boolean) (IsPayCodeEditCreated = Boolean) > </ScheduleHoursDailyStatus>
Property Descriptions
Date
886
Kronos Incorporated
ScheduleHoursDailyStatus Tag
887
Chapter 2
Syntax
Properties <ScheduleHoursException (ViolationMessage = String) > </ScheduleHoursException>
Property Descriptions
ViolationMessage
Violation message
This is an output only property; it displays exception messages that will be used by process manager. Type: String Output only Cannot be null. Introduced in v5.1Beta; last changed in v5.1
888
Kronos Incorporated
ScheduleHoursStatus Tag
Syntax
Properties <ScheduleHoursStatus (Date = Date) > (<AccrualViolation> <ScheduleHoursAccrualViolation> </AccrualViolation>) (<RuleViolations> <RuleViolation>* </RuleViolations>) (<DailyStatus> <ScheduleHoursDailyStatus>* </DailyStatus>) (<Exception> <ScheduleHoursException> </Exception>) </ScheduleHoursStatus>
Property Descriptions
889
Chapter 2
AccrualViolation
Accrual violation
An accrual violation as shown in the ScheduleHoursAccrualViolation tag Type: ScheduleHoursAccrualViolation tag Output only Introduced in v5.1Beta DailyStatus
Date
The date for which information is requested Type: Date Output only Introduced in v5.1Beta Exception
890
Kronos Incorporated
ScheduleHoursStatus Tag
RuleViolations
891
Chapter 2
Syntax
Request <Request Action = Actions 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 Return Value Type: None Required Properties: QueryDateSpan, OrgJobLocation
892
Kronos Incorporated
ScheduleMarkPosted Tag
Property Descriptions
OrgJobLocation
893
Chapter 2
Syntax
Properties <ScheduleOff <ShiftSegments> <ShiftSegment>* </ShiftSegments> ShiftCodeName = String [CommentText = String] (IsDeleted = Boolean) [IsOpenShift = Boolean] StartDate = Date [ShiftTypeName = String] > [<Notes> <Note>* </Notes>] (<Comments> <Comment>* </Comments>) [<Employee> <CurrentUser> | <PersonIdentity> </Employee>] </ScheduleOff>
894
Kronos Incorporated
ScheduleOff Tag
Property Descriptions
ShiftSegments
Segments in shift
The set of segments that comprise the shift code schedule Type: Zero or more ShiftSegment tags Introduced in v4; last changed in v5.0 ShiftCodeName
Comments
The set of comments currently returned with this timekeeping item Type: Zero or more Comment tags Output only Introduced in v5.0 CommentText
Comment text
A text string that is attached to the shift, rather than to a shift segment. The comment must be applicable for this category. Type: String Optional Maximum length: 254 characters
895
Chapter 2
Must match exactly an applicable comment that already exists in the database. The string matching is case-sensitive. You can find values in the Workforce Timekeeper Setup Application. Introduced in v5.0; last changed in v5.0 Employee
Employee
One employee who is assigned to the shift, as specified in a PersonIdentity or CurrentUser tag. Type: Either CurrentUser or PersonIdentity tag Optional Must uniquely identify an existing and active employee Introduced in v4 IsDeleted
Type: Boolean Output only Enumerated value: True, False Introduced in v5.0; last changed in v5.0 IsOpenShift
896
Kronos Incorporated
ScheduleOff Tag
Default value: False Enumerated value: True, False Introduced in v5.0; last changed in v5.0 Notes
Comment Notes
The list of notes for the comment to be created from comment text Type: Zero or more Note tags Optional Introduced in v6.0 ShiftTypeName
Type of shift
Name of shift type Type: String Optional You can find values in the Workforce Timekeeper user interface. Introduced in v5.0 StartDate
897
Chapter 2
If the action is to insert a transfer in a shift, it contains the start date of the transfer being imported. If the action is to import a new off day, it contains the start date of the off day being imported. If the action is to delete all scheduled shifts and off days that begin on the specified date, it contains the start date of the shift or off day being deleted. If the action is to add an off shift (a shift for an off day on which a person is available to work, if necessary), it contains the start date of the off shift being imported.
898
Kronos Incorporated
SchedulePattern Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddPatternElements" | "Delete" | "Load" | "LoadAllPatterns" | "LoadTemplatePatterns" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <SchedulePattern (EffectiveDateSpan = DateSpan) [Description = String] (Employee = String) [IsTemplateFlag = Boolean] (PeriodLengthInDays = Integer) [PeriodLength = Integer] SchedulePatternName = String (ScheduleGroupName = String)
899
Chapter 2
Action Descriptions
AddPatternElements Adds a list of specified pattern elements to an existing pattern or adds a new pattern if one does not already exist If a pattern is added, it must be a template pattern. Return Value Type: None Required Properties: SchedulePatternName Access Control Point Name: Edit Introduced in v4 Delete Marks a pattern for deletion Must be a template pattern Return Value Type: None Required Properties: SchedulePatternName Access Control Point Name: Edit Introduced in v4 Load Returns a single pattern by name Return Value Type: SchedulePattern tag Required Properties: SchedulePatternName Access Control Point Name: View Introduced in v4
900
Kronos Incorporated
SchedulePattern Tag
LoadAllPatterns Returns a list of defined patterns, including templates Return Value Type: Zero or more SchedulePattern tags Required Properties: None Access Control Point Name: View Introduced in v4 LoadTemplatePatterns Returns information about all template patterns Return Value Type: Zero or more SchedulePattern tags Required Properties: None Access Control Point Name: View Introduced in v4 RetrieveAllForUpdate SDM optional action to retrieve all Schedule Patterns. Return Value Type: Zero or more SchedulePattern tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames SDM required action to retrieve all the names of the Schedule Patterns. Return Value Type: (***undefined***): KBusinessObjectNameList Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate SDM required action to retrieve a Schedule Pattern by name. Return Value Type: SchedulePattern tag Required Properties: SchedulePatternName Access Control Point Name: View Introduced in v5.1
901
Chapter 2
Update Adds a new pattern or updates an existing one Must be a template pattern Return Value Type: None Required Properties: SchedulePatternName, AnchorDate, PatternElements, PeriodLength, PeriodCodeName Access Control Point Name: Edit Introduced in v4
Property Descriptions
AnchorDate
902
Kronos Incorporated
SchedulePattern Tag
Employee
The PersonNumber for the specified employee Type: String Output only Must uniquely identify an existing and active employee Introduced in v5.0 IsTemplateFlag
903
Chapter 2
The unit of time used for the PeriodLength Type: String Optional Maximum length: 10 characters Enumerated value: Days, Weeks Introduced in v4 PeriodLength
Number of units
The number of units in the availability pattern, as specified by the PeriodCodeName. For example, if the PeriodCodeName is Weeks and PeriodLength is 3, it specifies three weeks. Type: Integer Optional Introduced in v4 PeriodLengthInDays
904
Kronos Incorporated
SchedulePattern Tag
You can find values in the Workforce Timekeeper user interface. Introduced in v5.0 SchedulePatternName
905
Chapter 2
Syntax
Properties <SchedulePayCodeEdit AmountInTimeOrCurrency = String AmountInCurrency = Currency AmountInTime = TimeDuration [CommentText = String] (IsDeleted = Boolean) [LaborAccountName = String] [OrgJobPath = String] [IsOverrideAccrual = Boolean] [IsPartialOverride = Boolean] [IsOverride = Boolean] [PayCodeName = String] [StartDate = Date] [UnavailableStartTime = Time] [UnavailableDuration = TimeDuration] DisplayTime = Time > [<Notes> <Note>* </Notes>] (<Comments> <Comment>* </Comments>) [<Employee> <CurrentUser> | <PersonIdentity> </Employee>]
906
Kronos Incorporated
SchedulePayCodeEdit Tag
</SchedulePayCodeEdit>
Property Descriptions
AmountInTimeOrCurrency
Comments
907
Chapter 2
The set of comments that are returned with this timekeeping item Type: Zero or more Comment tags Output Only Introduced in v4 CommentText
Comment text
A comment string that is attached to the scheduled pay code edit. Type: String Optional Maximum length: 254 characters Must match exactly an applicable comment that already exists in the database. The string matching is case-sensitive. You can find values in the Workforce Timekeeper Setup Application. Introduced in v4; last changed in v5.0 DisplayTime
Employee
Either a PersonIdentity or CurrentUser tag. Specifies the employee assigned to the paycode edit. Type: Either CurrentUser or PersonIdentity tag Optional
908
Kronos Incorporated
SchedulePayCodeEdit Tag
Must uniquely identify an existing and active employee. Introduced in v5.0 IsDeleted
Type: Boolean Output only Enumerated value: True, False Introduced in v5.0; last changed in v5.0 IsOverride
Type: Boolean Optional Default value: False Enumerated value: True, False Introduced in v5.0; last changed in v5.0 IsOverrideAccrual
909
Chapter 2
Type: Boolean Optional Default value: False Enumerated value: True, False Introduced in v5.0 IsPartialOverride
Labor account
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 LaborAccountName is required if the scheduled pay code edit applies to a labor account other than the employee's primary account
910
Kronos Incorporated
SchedulePayCodeEdit Tag
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 Maximum length: 356 characters. Introduced in v4; last changed in v5.1 Notes
Comment notes
The list of notes for the comment to be created from comment text Type: Zero or more Note tags Optional Introduced in v6.0; last changed in v6.0 OrgJobPath
911
Chapter 2
The organizational job path of the employee whose scheduled pay code edit is being imported. Enter data for OrgJobPath in the same format as it appears in the database. The OrgJobPath string matching is case-sensitive on a server that connects to an Oracle database. @P is a short-hand of employee's primary job. Required: If you are adding a comment to a scheduled pay code edit that had an explicit value for OrgJobPath when it was imported Type: String Optional Maximum length: 1000 characters Dependency: This is required if the scheduled pay code edit applies to an organizational job other than the employee's primary organizational job. Introduced in v5.0; last changed in v5.0 PayCodeName
Pay code
The pay code that is associated with the pay code edit Type: String Optional Maximum length: 50 characters Introduced in v4 StartDate
Start date
The date of the scheduled pay code edit. Type: Date Optional Introduced in v5.0
912
Kronos Incorporated
SchedulePayCodeEdit Tag
UnavailableDuration
913
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Delete" | "Load" | "LoadAllPeriods" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <SchedulePeriod [Description = String] PeriodLength = Integer SchedulePeriodName = String StartDate = Date PeriodCodeName = String > </SchedulePeriod>
Action Descriptions
914
Kronos Incorporated
SchedulePeriod Tag
Delete Marks an existing schedule period for deletion Return Value Type: None Required Properties: SchedulePeriodName Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0 Load Returns all existing schedule period in the database Return Value Type: None Required Properties: SchedulePeriodName Access Control Point Name: View Introduced in v5.0; last changed in v5.0 LoadAllPeriods Load all schedule periods from the database. Return Value Type: Zero or more SchedulePeriod tags Required Properties: None Access Control Point Name: View Introduced in v5.0 RetrieveAllForUpdate SDM optional action to retrieve all Schedule Periods. Return Value Type: Zero or more SchedulePeriod tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames SDM required action to retrieve all the names of the Schedule Periods. Return Value Type: (***undefined***): KBusinessObjectNameList Access Control Point Name: View Introduced in v5.1
915
Chapter 2
RetrieveForUpdate SDM required action to retrieve a Schedule Period by name. Return Value Type: SchedulePeriod tag Required Properties: SchedulePeriodName Access Control Point Name: View Introduced in v5.1 Update Adds a new schedule period or updates an existing one Return Value Type: None Required Properties: PeriodCodeName, PeriodLength, StartDate, SchedulePeriodName Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0
Property Descriptions
Description
Description
Describes the schedule period Type: String Optional Maximum length: 250 characters Introduced in v5.0 PeriodCodeName
916
Kronos Incorporated
SchedulePeriod Tag
Default value: Days Enumerated value: Days, Weeks Introduced in v5.0 PeriodLength
Number of units
The number of units in the availability pattern, as specified by the PeriodCodeName. For example, if the PeriodCodeName is Weeks and PeriodLength is 3, it specifies three weeks. Type: Integer Required Introduced in v5.0 SchedulePeriodName
917
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddOnly" | "Delete" | "Retrieve" | "RetrieveAll" | "Update" Parameters None Properties <ScheduleRuleOverride (DetailsSummary = String) [EffectiveDate = DateTime] (EmployeeId = Long) [ExpirationDate = DateTime] [Name = String] [PersonNumber = String] [SchedRuleId = Long] > [<ScheduleRuleOverrideDetailsList> <ScheduleRuleOverrideDetails>* </ScheduleRuleOverrideDetailsList>] </ScheduleRuleOverride>
918
Kronos Incorporated
ScheduleRuleOverride Tag
Action Descriptions
AddOnly Adds the schedule rule override Return Value Type: ScheduleRuleOverride tag Required Properties: PersonNumber, SchedRuleId, EffectiveDate, ExpirationDate, ScheduleRuleOverrideDetailsList Access Control Point Name: Edit Introduced in v6.0 Delete Deletes the schedule rule override Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v6.0 Retrieve Retrieves the ScheduleruleOverride for a specfied name Return Value Type: ScheduleRuleOverride tag Required Properties: Name Access Control Point Name: View Introduced in v6.0 RetrieveAll Retrieves the list of available schedule rule override. Return Value Type: ScheduleRuleOverride tag Required Properties: PersonNumber Access Control Point Name: View Introduced in v6.0 Update Changes to the schedule rule override
919
Chapter 2
Return Value Type: ScheduleRuleOverride tag Required Properties: Name, ScheduleRuleOverrideDetailsList Access Control Point Name: Edit Introduced in v6.0
Property Descriptions
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 Introduced in v6.0; last changed in v6.0 ExpirationDate
Expiration date
920
Kronos Incorporated
ScheduleRuleOverride Tag
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 Type: Long Optional Introduced in v6.0 ScheduleRuleOverrideDetailsList
921
Chapter 2
Type: Zero or more ScheduleRuleOverrideDetails tags Optional Introduced in v6.0; last changed in v6.0
922
Kronos Incorporated
ScheduleRuleOverrideDetails Tag
Syntax
Properties <ScheduleRuleOverrideDetails ParamQty = Double ParamTypeMMId = Long ParamTypeId = Long (ParamValue = String) ParamValTypeId = Long [WeekDayId = Long] > </ScheduleRuleOverrideDetails>
Property Descriptions
ParamQty
Parameter quantity
Parameter quantity Type: Double Required Introduced in v6.0; last changed in v6.0 ParamTypeId
Parameter type id
Parameter type id Type: Long
923
Chapter 2
Parameter type MM id
Parameter type MM id Type: Long Required Introduced in v6.0 ParamValTypeId
Parameter value
Parameter value Type: String Output only Introduced in v6.0; last changed in v6.0 WeekDayId
Week day id
Week day id Type: Long Optional
924
Kronos Incorporated
ScheduleRuleOverrideDetails Tag
Introduced in v6.0
925
Chapter 2
Syntax
Properties <ScheduleShift <ShiftSegments> <ShiftSegment>* </ShiftSegments> ShiftCodeName = String [CommentText = String] (IsDeleted = Boolean) [IsOpenShift = Boolean] [OrgJobPath = String] [ScheduleGroupName = String] [ShiftTypeName = String] StartDate = Date > [<Notes> <Note>* </Notes>] (<Comments> <Comment>* </Comments>) [<Employee> <CurrentUser> | <PersonIdentity> </Employee>] </ScheduleShift>
926
Kronos Incorporated
ScheduleShift Tag
Property Descriptions
ShiftSegments
Segments in shift
The set of segments that comprise the shift code schedule Type: Zero or more ShiftSegment tags Introduced in v4 ShiftCodeName
Comments
The set of comments returned with this shift Type: Zero or more Comment tags 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
927
Chapter 2
Maximum length: 254 characters Must match exactly an applicable comment that already exists in the database. The string matching is case-sensitive. You can find values in the Workforce Timekeeper Setup Application. Introduced in v5.0 Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, who is assigned to the shift. Specify either ScheduleGroupName or Employee, but not both. Type: Either CurrentUser or PersonIdentity tag Optional Must uniquely identify an existing and active employee Introduced in v4 IsDeleted
Type: Boolean Output only Enumerated value: True, False Introduced in v5.0; last changed in v5.0 IsOpenShift
928
Kronos Incorporated
ScheduleShift Tag
Optional Enumerated value: True, False Introduced in v5.0; last changed in v5.0 Notes
Comment Notes
The list of notes for the comment to be created from comment text Type: Zero or more Note tags Optional Introduced in v6.0 OrgJobPath
929
Chapter 2
Type: String Optional Maximum length: 30 characters You can find values in the Workforce Timekeeper user interface. Introduced in v4 ShiftTypeName
930
Kronos Incorporated
ScheduleShift Tag
If the action is to import a new off day, it contains the start date of the off day being imported. If the action is to delete all scheduled shifts and off days that begin on the specified date, it contains the start date of the shift or off day being deleted. If the action is to add an off shift (a shift for an off day on which a person is available to work, if necessary), it contains the start date of the off shift being imported.
Type: Date Required Maximum length: 15 characters Must be within the date span of the containing schedule. Introduced in v4; last changed in v5.0
931
Chapter 2
Syntax
Properties <ScheduleShiftSwap EndDate = Date EndTime = Time StartDate = Date StartTime = Time > <Employee> <CurrentUser> | <PersonIdentity> </Employee> </ScheduleShiftSwap>
Property Descriptions
Employee
Employee
One employee who is assigned to the shift, as specified in a PersonIdentity or CurrentUser tag. Type: Either CurrentUser or PersonIdentity tag Required Must uniquely identify an existing and active employee Introduced in v5.0
932
Kronos Incorporated
ScheduleShiftSwap Tag
EndDate
933
Chapter 2
Syntax
Properties <ScheduleUnavailable [CommentText = String] EndDate = Date EndTime = Time (IsDeleted = Boolean) (IsLockedFlag = Boolean) [ScheduleGroupName = String] StartDate = Date StartTime = Time > [<Notes> <Note>* </Notes>] (<Comments> <Comment>* </Comments>) [<Employee> <CurrentUser> | <PersonIdentity> </Employee>] </ScheduleUnavailable>
Property Descriptions
Comments
Comments
934
Kronos Incorporated
ScheduleUnavailable Tag
The set of comments currently returned with this unavailable shift Type: Zero or more Comment tags Output only Introduced in v5.0 CommentText
Comment text
A text string that is attached to the shift, rather than to a shift segment. The comment must be applicable for this category. Type: String Optional Maximum length: 254 characters String matching is case-sensitive. You can find values in the Workforce Timekeeper Setup Application. Introduced in v5.0 Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, who is unavailable. Type: Either CurrentUser or PersonIdentity tag Optional Must uniquely identify an existing and active employee Introduced in v4 EndDate
935
Chapter 2
936
Kronos Incorporated
ScheduleUnavailable Tag
True if the schedule item has been locked. A schedule might be locked because the timecard has been signed off. Type: Boolean Output Only Enumerated value: True, False Introduced in v4; last changed in v5.0 Notes
Comment Notes
The list of notes for the comment to be created from comment text Type: Zero or more Note tags Optional Introduced in v6.0 ScheduleGroupName
Start date
Contains information that depends on the action you are taking as follows: - If the action is to delete all scheduled shifts, pay codes, and off days that begin on the specified date, it contains the start date of the shift, pay code, or off day being deleted.
937
Chapter 2
- If the action is to begin importing a new shift, it contains the start date of the shift being imported. - If the action is to insert a break in a shift, it contains the start date of the break being imported. - If the action is to insert a transfer in a shift, it contains the start date of the transfer being imported. - If the action is to import a new off day, it contains the start date of the off day being imported. - If the action is to delete all scheduled shifts and off days that begin on the specified date, it contains the start date of the shift or off day being deleted. - If the action is to add an off shift (a shift for an off day on which a person is available to work, if necessary), it contains the start date of the off shift being imported. Required: If you delete all scheduled shifts, import a shift, insert a break, insert a transfer, import an off day, or import an off shift. Type: Date Required Must be within the date span of the containing schedule. Introduced in v4; last changed in v5.2 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.
938
Kronos Incorporated
ScheduleUnavailable Tag
- If you import a new off day, the start time of the off day being imported. - If you add an off shift (a shift for an off day on which a person is available to work, if necessary), the start time of the off shift being imported. This column is required whenever you import a shift, insert a break in a shift, insert a transfer in a shift, or import an off shift. It is optional when importing an off day. If you do not specify a value, the off day start time defaults to the start of the day. If you specify StartTime, you must have previously specified the UserAccountStatusName in the UserAccountStatus tag. Type: Time Required If StartDate is the same as EndDate, then StartTime must be less than EndTime. Introduced in v4; last changed in v5.2
939
Chapter 2
Syntax
Properties <ScheduleZone [ZoneDescription = String] EndTime = Time [NewName = String] ZoneName = String [isDeleted = Boolean] BeginTime = Time > </ScheduleZone>
Property Descriptions
BeginTime
Start time
The starting time for a zone time span Type: Time Required Introduced in v5.0 EndTime
End time
The ending time for a zone time span
940
Kronos Incorporated
ScheduleZone Tag
941
Chapter 2
Type: String Required Maximum length: 30 characters You can find values in the Workforce Timekeeper user interface under the Scheduler Setup Workload Setup menu. Sample values: Morning, Evening, 7AM-3PM Introduced in v5.0
942
Kronos Incorporated
ServerTime Tag
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View Introduced in v4
943
Chapter 2
Property Descriptions
DateTime
944
Kronos Incorporated
SettingsParamDefinition Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Retrieve" | "RetrieveAll" | "RetrieveAllNames" Parameters None Properties <SettingsParamDefinition SettingsParameterDefinitionName = String (ValueTypeName = String) > </SettingsParamDefinition>
Action Descriptions
Retrieve Return a parameter definition object given the name. Return Value Type: SettingsParamDefinition tag Required Properties: SettingsParameterDefinitionName Access Control Point Name: View
945
Chapter 2
Introduced in v6.0 RetrieveAll Returns all parameter definitions. Return Value Type: Zero or more SettingsParamDefinition tags Access Control Point Name: View Introduced in v6.0 RetrieveAllNames Return all parameter definitions objects names. Return Value Type: (***undefined***): KBusinessObjectNameList Access Control Point Name: View Introduced in v6.0
Property Descriptions
SettingsParameterDefinitionName
946
Kronos Incorporated
SettingsParamDefinition Tag
947
Chapter 2
Syntax
Properties <SettingsParamValue Name = String Value = String > </SettingsParamValue>
Property Descriptions
Name
Parameter value
948
Kronos Incorporated
SettingsParamValue Tag
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"/> Introduced in v6.0; last changed in v6.0
949
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Retrieve" | "RetrieveAll" | "RetrieveAllNames" Parameters Retrieve SettingsTypeName = String Properties <SettingsType (Description = String) SettingsTypeName = String > </SettingsType>
Action Descriptions
Retrieve Retrieve a setting type object by name. Return Value Type: SettingsType tag Required Properties: SettingsTypeName
950
Kronos Incorporated
SettingsType Tag
RetrieveAll Retrieves all settings type objects. Return Value Type: Zero or more SettingsType tags Access Control Point Name: View Introduced in v6.0 RetrieveAllNames Retrieves all settings type objects names. Return Value Type: (***undefined***): KBusinessObjectNameList Access Control Point Name: View Introduced in v6.0
Property Descriptions
Description
951
Chapter 2
Representa a settings type object name. Type: String Required Key Sample values: <SettingsTypeName> ThisIsAName</SettingsTypeName> Introduced in v6.0; last changed in v6.0
952
Kronos Incorporated
ShiftBuilder Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "BuildShifts" | "LoadPopulatedThroughDate" | "PurgeShiftBuilderErrorDetails" | "ResubmitFailedShiftBuilderTasks" Parameters None Properties <ShiftBuilder (PopulatedThroughDate = Date) [UserName = String] > </ShiftBuilder>
Action Descriptions
BuildShifts Invokes the shift builder process Return Value Type: None Access Control Point Name: Edit
953
Chapter 2
Introduced in v4 LoadPopulatedThroughDate To get the PopulatedThroughDate. Return Value Type: None Access Control Point Name: View Introduced in v5.1Beta; last changed in v5.1 PurgeShiftBuilderErrorDetails Purge shift builder error details in the SHIFTBUILDERDTL table, any records older than certain number of days will be purged from the database. Return Value Type: None Access Control Point Name: Edit Introduced in v6.0 ResubmitFailedShiftBuilderTasks Resubmit the failed shift builder entries that are stuck in the SCHEDULEPROC table so they can be retried again. Return Value Type: None Access Control Point Name: Edit Introduced in v6.0
Property Descriptions
PopulatedThroughDate
954
Kronos Incorporated
ShiftBuilder Tag
UserName
955
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Delete" | "Load" | "LoadAllShiftCodes" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <ShiftCode [Description = String] [Label = String] ShiftCodeName = String > [<ShiftSegments> <ShiftSegment>* </ShiftSegments>] </ShiftCode>
Action Descriptions
956
Kronos Incorporated
ShiftCode Tag
Delete Marks the specified shift code for deletion Return Value Type: None Required Properties: ShiftCodeName Access Control Point Name: Edit Introduced in v4 Load Returns the specified shift code Return Value Type: ShiftCode tag Required Properties: ShiftCodeName Access Control Point Name: View Introduced in v4 LoadAllShiftCodes Returns all user-defined shift codes Return Value Type: Zero or more ShiftCode tags Required Properties: None Access Control Point Name: View Introduced in v4 RetrieveAllForUpdate SDM optional action to retrieve all Shift Codes. Return Value Type: Zero or more ShiftCode tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames SDM required action to retrieve all the names of the Shift Codes. Return Value Type: (***undefined***): KBusinessObjectNameList Access Control Point Name: View Introduced in v5.1
957
Chapter 2
RetrieveForUpdate SDM required action to retrieve a Shift Code by name. Return Value Type: ShiftCode tag Required Properties: ShiftCodeName Access Control Point Name: View Introduced in v5.1 Update Adds a new shift code or updates an existing one Return Value Type: None Required Properties: ShiftCodeName, ShiftSegments Access Control Point Name: Edit Introduced in v4; last changed in v5.0
Property Descriptions
Description
958
Kronos Incorporated
ShiftCode Tag
Segments in shift
The set of segments that comprise the specified shift code Type: Zero or more ShiftSegment tags Optional Introduced in v4
959
Chapter 2
Syntax
Properties <ShiftCountSpan EndTime = Time BeginTime = Time > </ShiftCountSpan>
Property Descriptions
BeginTime
Start time
The starting time for a shift count span Type: Time Required Introduced in v5.0 EndTime
End time
The ending time for a shift count span Type: Time Required
960
Kronos Incorporated
ShiftCountSpan Tag
Introduced in v5.0
961
Chapter 2
Syntax
Request <Request Action = Actions 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) DateTimeSpan = DateTimeSpan (UserName = String) > </ShiftHistory>
Action Descriptions
962
Kronos Incorporated
ShiftHistory Tag
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. Access Control Point Name: View Introduced in v5.2
Property Descriptions
Employee
Employee
The employee to whom the schedule applies. Type: PersonIdentity tag Employee and OrgJobPath are mutually exclusive. Introduced in v5.2; last changed in v5.2 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. Introduced in v5.2; last changed in v5.2 Action
Action
The shift history action. Type: String Output only
963
Chapter 2
Comment
The comment of the modification. Type: String Output only Introduced in v5.2; last changed in v5.2 DateTime
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 Introduced in v5.2; last changed in v5.2
964
Kronos Incorporated
ShiftHistory Tag
NewShift
New shift
Information of the new created shift. Type: String Output only Introduced in v5.2; last changed in v5.2 Reason
Reason
The Book-Off, Book-On or Relief Not Needed reason. Type: String Output only Introduced in v5.2; last changed in v5.2 UserName
965
Chapter 2
Syntax
Properties <ShiftSegment EndTime = Time [LaborAccountName = String] [OrgJobPath = String] EndDayNumber = Integer StartDayNumber = Integer [SegmentTypeName = String] [StartTime = Time] [WorkRuleName = String] > </ShiftSegment>
Property Descriptions
EndDayNumber
966
Kronos Incorporated
ShiftSegment Tag
EndTime
End time
The segment end time within its end day Type: Time Required If StartDayNumber is the same as EndDayNumber, then StartTime must be less than EndTime. Introduced in v4 LaborAccountName
Labor account
This is the name of the labor account to charge for this activity. Enter data for labor accounts in the same format as they appear in the 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 Do not specify labor levels that are not changing. Type: String Optional Maximum length: 356 characters Introduced in v4 OrgJobPath
967
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 Maximum length: 1000 characters Introduced in v5.0; last changed in v5.2 SegmentTypeName
Segment type
The type of activity that the segment represents Type: String Optional Maximum length: 30 characters Default value: Regular Enumerated value: Regular, Unavailable, Transfer, Break, Off, Regular PCE, Availability PCE, Accrual Edit Introduced in v4; last changed in v5.2 StartDayNumber
Start time
Contains information that depends on the action being taken, as follows:
968
Kronos Incorporated
ShiftSegment Tag
- If you begin importing a new shift, it contains the start time of the shift being imported. - If you insert a break in a shift, it contains the start time of the break being imported. - If you insert a transfer in a shift, it contains the start time of the transfer being imported. - If you import a new off day, the start time of the off day being imported. - If you add an off shift (a shift for an off day on which a person is available to work, if necessary), the start time of the off shift being imported. This column is required whenever you import a shift, insert a break in a shift, insert a transfer in a shift, or import an off shift. It is optional when importing an off day. If you do not specify a value, the off day start time defaults to the start of the day. Type: Time Optional Maximum length: 15 characters If StartDate is the same as EndDate, then StartTime must be less than EndTime. Dependency: If you specify StartTime, you must have previously the UserAccountStatusName in the UserAccountStatus tag. Introduced in v4; last changed in v5.2 WorkRuleName
Work rule
Name of the work rule that describes the activity The following predefined data values are provided: &ALL_WORK_RULES &EMPTY Type: String
969
Chapter 2
Optional Maximum length: 50 characters You can find values in the Timekeeping Application. Introduced in v4; last changed in v5.2
970
Kronos Incorporated
ShiftStartTimeBand Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "addOnly" | "deleteOnly" | "retrieve" | "retrieveAll" | "update" | "updateOnly" Parameters None Properties <ShiftStartTimeBand [ActiveSwitch = Boolean] Name = String DisplayName = String [NewName = String] StartTime = Time > </ShiftStartTimeBand>
Action Descriptions
971
Chapter 2
addOnly Stores shift start band in the database. Returns an error if object with the same name exists Validate all properties including optional Return Value Type: Boolean Required Properties: Name, DisplayName, StartTime Optional Properties: ActiveFlag Access Control Point Name: Edit 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. Return Value Type: Boolean Required Properties: Name Access Control Point Name: Edit 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 Required Properties: Name Access Control Point Name: View Introduced in v5.1 retrieveAll Retrieves all ShiftStartTimeBand objects from the database Return Value Type: (***undefined***): List of ShiftStartTimeBand Access Control Point Name: View
972
Kronos Incorporated
ShiftStartTimeBand Tag
Introduced in v5.1 update Persists the shift start time band object in the database or updates with new data if object exists. Validate all properties including optional. Return Value Type: Boolean Required Properties: Name Optional Properties: NewName, DisplayName, StartTime, ActiveSwitch Access Control Point Name: Edit 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 Return Value Type: Boolean Required Properties: Name Optional Properties: NewName, DisplayName, StartTime, ActiveSwitch Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
ActiveSwitch
973
Chapter 2
DisplayName
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. Introduced in v5.1; last changed in v5.2 StartTime
Start Time
The shift start time (required for add, optional for update) Type: Time
974
Kronos Incorporated
ShiftStartTimeBand Tag
975
Chapter 2
Syntax
Request <Request Action = Actions 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.
976
Kronos Incorporated
ShiftTemplateAssignment Tag
All ShiftTemplateItem tags that are returned must identify the same existing employee. Return Value Type: ShiftTemplateAssignment tag Required Properties: ShiftTemplateItems Access Control Point Name: View Introduced in v5.1Beta LoadAll Loads all shift template profiles in the system. Return Value Type: Zero or more ShiftTemplateItem tags Required Properties: none Access Control Point Name: View Introduced in v5.1Beta Update Updates a person's shift template profile. Return Value Type: None Required Properties: ShiftTemplateItems Access Control Point Name: Edit Introduced in v5.1Beta
Property Descriptions
ShiftTemplateItems
977
Chapter 2
Syntax
Properties <ShiftTemplateItem ShiftTemplateProfileName = String > <Employee> <PersonIdentity> </Employee> </ShiftTemplateItem>
Property Descriptions
Employee
Employee
The employee to whom the shift code template profile is assigned Type: PersonIdentity tag Required Key Must be a unique and existing employee Introduced in v5.1Beta ShiftTemplateProfileName
978
Kronos Incorporated
ShiftTemplateItem Tag
979
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" Parameters None Properties <ShiftValidation (IsShiftExists = Boolean) 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.
980
Kronos Incorporated
ShiftValidation Tag
Return Value Type: ShiftValidation tag Required Properties: QueryDate, StartTime, EndTime, Employee Access Control Point Name: View Introduced in v5.1Beta
Property Descriptions
Employee
Employee
One employee, as specified in a PersonIdentity tag Type: PersonIdentity tag Required Key Must uniquely identify an existing and active employee Introduced in v5.1Beta EndTime
981
Chapter 2
QueryDate
982
Kronos Incorporated
Signature Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Add" | "AddOnly" | "Delete" | "DeleteOnly" | "Retrieve" | "RetrieveAll" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" | "UpdateOnly" Parameters None Properties <Signature SignatureName = String > </Signature>
Action Descriptions
983
Chapter 2
Add Inserts one Signature object in the database . If it's already there a rule with the same name nothing happens. Return Value Type: None Required Properties: SignatureName Access Control Point Name: Edit Introduced in v6.0 AddOnly Inserts one Signature object in the database . If it's already there an error is thrown. Return Value Type: None Required Properties: SignatureName Access Control Point Name: Edit 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. Return Value Type: None Required Properties: SignatureName Access Control Point Name: Edit 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. Return Value Type: None Required Properties: SignatureName Access Control Point Name: Edit Introduced in v6.0
984
Kronos Incorporated
Signature Tag
Retrieve Retrieves the Signature object that has the same name as the one specified in the SignatureName. Return Value Type: Signature tag Required Properties: SignatureName Access Control Point Name: View Introduced in v6.0 RetrieveAll Retrieves all the Signature objects. Return Value Type: Zero or more Signature tags Access Control Point Name: View Introduced in v6.0 RetrieveAllForUpdate Retrieves all the Signature objects. Return Value Type: Zero or more Signature tags Access Control Point Name: View Introduced in v6.0; last changed in v6.0 RetrieveAllNames Retrieves all the names for all Signature objects. Return Value Type: String list Access Control Point Name: View 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 Required Properties: SignatureName Access Control Point Name: View
985
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. Return Value Type: None Required Properties: SignatureName Access Control Point Name: Edit Introduced in v6.0 UpdateOnly Updates one Signature object in the database . If it's not there an error is thrown. Return Value Type: None Required Properties: SignatureName Access Control Point Name: Edit Introduced in v6.0
Property Descriptions
SignatureName
Signature Name
Defines the name property of the Signature object. Type: String Required Key Introduced in v6.0
986
Kronos Incorporated
SignatureItem Tag
Syntax
Properties <SignatureItem ProcedureParameterDefinitionName = String ProcedureParameterName = String > </SignatureItem>
Property Descriptions
ProcedureParameterDefinitionName
987
Chapter 2
Syntax
Properties <SimplePair Key = String Value = String > </SimplePair>
Property Descriptions
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
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
988
Kronos Incorporated
SimplePair Tag
989
Chapter 2
Syntax
Properties <SimpleValue Value = String > </SimpleValue>
Property Descriptions
Value
Value
A primitive value whose format depends on the action or property that returns it, and can represent an alphanumeric string, an integer, or a boolean type. Type: String Required This property represents one value. Introduced in v4
990
Kronos Incorporated
StaffingRequirement Tag
Syntax None
991
Chapter 2
Syntax
Properties <StandardShift [ShiftDescription = String] EndTime = Time ShiftName = String BeginTime = Time > </StandardShift>
Property Descriptions
BeginTime
Start time
The starting time for the shift Type: Time Required Introduced in v5.0 EndTime
End time
The ending time for the shift Type: Time Required
992
Kronos Incorporated
StandardShift Tag
Description
Describes the shift Type: String Optional Maximum length: 250 characters Introduced in v5.0 ShiftName
Shift name
The name of the shift Type: String Required Maximum length: 30 characters You can find values in the Workforce Timekeeper user interface under the Scheduler Setup Workload Setup menu. Introduced in v5.0
993
Chapter 2
Syntax
Request <Request Action = Actions 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.
994
Kronos Incorporated
SuiteProduct Tag
Return Value Type: Zero or more SuiteProduct tags Access Control Point Name: View Introduced in v5.0; last changed in v5.0 LoadByName Returns information about the requested suite product. Return Value Type: SuiteProduct tag Required Properties: SuiteProductName Access Control Point Name: View Introduced in v5.0; last changed in v5.0
Property Descriptions
IndependentProductSw
995
Chapter 2
LicensedSw
996
Kronos Incorporated
Supervisor Tag
Syntax None
997
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "LoadEligibleEmployees" Parameters None Properties <SwapShiftEmployees EndTime = Time QueryDate = Date StartTime = Time > <Employee> <PersonIdentity> </Employee> </SwapShiftEmployees>
Action Descriptions
998
Kronos Incorporated
SwapShiftEmployees Tag
LoadEligibleEmployees This action returns one or more employees who can swap with the specified shift. Return Value Type: Zero or more Person tags Required Properties: Employee, QueryDate, StartTime, EndTime Access Control Point Name: View Introduced in v5.1Beta
Property Descriptions
Employee
Employee
One employee, as specified in a PersonIdentity tag. Type: PersonIdentity tag Required Must uniquely identify an existing and active employee. If the employee has a Workforce_Scheduler_Employee license and specifies True for IsCreateOpenShift, you will be able to create open shifts. Otherwise IsCreateOpenShift will have no effect. Introduced in v5.1Beta EndTime
999
Chapter 2
1000
Kronos Incorporated
SwapShiftJobs Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "LoadJobs" Parameters None Properties <SwapShiftJobs EndTime = Time QueryDate = Date StartTime = Time > <Employee> <PersonIdentity> </Employee> (<OrgJobs> <OrgJob>* </OrgJobs>) </SwapShiftJobs>
Action Descriptions
1001
Chapter 2
LoadJobs This action returns one or more jobs for the shift within the specified date and time span. Return Value Type: Zero or more OrgJob tags Access Control Point Name: View Introduced in v5.1Beta
Property Descriptions
Employee
Employee
One employee, as specified in a PersonIdentity tag. Type: PersonIdentity tag Required Must uniquely identify an existing and active employee. Introduced in v5.1Beta EndTime
Organization jobs
This property is a tag list property that represent a list of organization jobs. Type: Zero or more OrgJob tags Output only
1002
Kronos Incorporated
SwapShiftJobs Tag
1003
Chapter 2
Syntax
Request <Request Action = Actions 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. Return Value Type: None Required Properties: none Access Control Point Name: Edit
1004
Kronos Incorporated
SwitchRoleEngine Tag
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 Return Value Type: None Required Properties: Delegator Identifier, Role Profile Name Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
delegatorFullName
1005
Chapter 2
Type: String Required Maximum length: 50 characters Introduced in v5.2; last changed in v5.2
1006
Kronos Incorporated
SystemSettings Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" Parameters Load KeyNames = String Properties <SystemSettings (Key = String) (Value = String) > </SystemSettings>
Action Descriptions
1007
Chapter 2
Load Returns system settings that match parameter values. There can be more than one system setting that matches a parameter. For example, a parameter of site.local would return all site.local.* system settings. Return Value Type: Zero or more SystemSettings tags Access Control Point Name: View Introduced in v5.0
Action Parameters Parameter Name KeyNames Description A comma separated list of system setting keys. Each item in the list represents one or more system settings. Required Additional information Introduced in v5.0
Property Descriptions
Key
1008
Kronos Incorporated
SystemSettings Tag
1009
Chapter 2
Syntax
Properties <TelephoneNumber PhoneNumber = String ContactTypeName = String > </TelephoneNumber>
Property Descriptions
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 Maximum length: 30 characters Values for CustomTypeName can be changed through the Workforce Central Setup Application. Sample values: Home Phone, Work Phone, Mobile Phone
1010
Kronos Incorporated
TelephoneNumber Tag
Phone number
The telephone number for the specified contact type Type: String Required Maximum length: 35 characters A maximum of three phone numbers can be specified for a person in Workforce Timekeeper. Introduced in v4
1011
Chapter 2
Syntax
Request <Request Action = Actions 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. Name should be valid Return Value Type: TimeEntry tag
1012
Kronos Incorporated
TimeEntry Tag
Required Properties: TimeEntryName Access Control Point Name: View Introduced in v4 LoadAllTimeEntries Returns all time entries in the system. Return Value Type: Zero or more TimeEntry tags Required Properties: None Access Control Point Name: View Introduced in v4 LoadById Returns a time entry, based on TimeEntryID. ID must be valid Return Value Type: TimeEntry tag Required Properties: TimeEntryID Access Control Point Name: View Introduced in v4
Property Descriptions
TimeEntryId
Id of time entry
Uniquely identifies the TimeEntryProfile in the database Type: Integer Optional Introduced in v4 TimeEntryName
1013
Chapter 2
Type: String Optional Enumerated value: Timestamp, Timestamp & Hourly View, Hourly View, Project View Introduced in v4
1014
Kronos Incorporated
TimeFramePeriod Tag
Syntax
Request <Request Action = Actions 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
1015
Chapter 2
Required Properties: None Access Control Point Name: View 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 Access Control Point Name: View Introduced in v5.2; last changed in v5.2
Property Descriptions
PeriodDateSpan
Span of dates
The start and end dates, dash separated, for the specified period Type: DateSpan Optional For input, the value is the time span for the period. For output, the value is the time span for the resulting information. Introduced in v4 TimeFrameDate
Reference date
A date for a time span that requires a reference date Type: Date Optional
1016
Kronos Incorporated
TimeFramePeriod Tag
If the value of the TimeFrameName is Specific-Date, this property contains the value of that date. Introduced in v4 TimeFrameName
Type: String Required Maximum length: 1 character Enumerated value: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 13 Introduced in v4; last changed in v5.0
1017
Chapter 2
Syntax
Properties <TimekeepingException (MissedOutDateTime = DateTime) (DifferenceToLimit = TimeDuration) (ExceptionTypeName = String) (AssociatedWithInPunchFlag = Boolean) (MinimumNumberOfActiveDays = Integer) (ActualNumberOfActiveDays = Integer) (NumberOfWorkedDays = Integer) (DurationOfException = TimeDuration) > </TimekeepingException>
Property Descriptions
ActualNumberOfActiveDays
1018
Kronos Incorporated
TimekeepingException Tag
AssociatedWithInPunchFlag
1019
Chapter 2
ExceptionTypeName
Exception type
The name of the exception. Type: String Output Only You can find values in the Workforce Timekeeper user interface. Sample values: Canceled Deduction, Core Hours Violation, Early Introduced in v4 MinimumNumberOfActiveDays
1020
Kronos Incorporated
TimekeepingException Tag
This value is meaningful only for a WorkHistory exception Type: Integer Output Only Introduced in v4
1021
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "LoadDailyTotals" | "LoadPeriodTotals" Parameters None Properties <Timesheet (TotalsUpToDateFlag = Boolean) (LastTotalizationDateTime = DateTime) (ManagerSignoffDateTime = DateTime) > <Employee> <CurrentUser> | <PersonIdentity> </Employee> (<DailyTotals> <DateTotals>* </DailyTotals>) <Period> <TimeFramePeriod> </Period>
1022
Kronos Incorporated
Timesheet Tag
(<TotaledPayCodeEdits> <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 Required Properties: Employee, Period Access Control Point Name: View Introduced in v4 LoadDailyTotals Returns a timesheet whose daily totals contain the most recent totalization for the specified period and employee. Return Value Type: Timesheet tag Required Properties: Employee, Period
1023
Chapter 2
Access Control Point Name: View Introduced in v4 LoadPeriodTotals Returns a timesheet whose period totals contain totals for the specified period and employee. Return Value Type: Timesheet tag Required Properties: Employee, Period Access Control Point Name: View Introduced in v4
Property Descriptions
DailyTotals
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, for whom the action is requested. Type: Either CurrentUser or PersonIdentity tag Required Must uniquely identify an existing and active employee Introduced in v4
1024
Kronos Incorporated
Timesheet Tag
LastTotalizationDateTime
Time period
The time period for the data being retrieved Type: TimeFramePeriod tag Required Introduced in v4 PeriodTotalData
1025
Chapter 2
TotaledPayCodeEdits
1026
Kronos Incorporated
Timesheet Tag
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
Untotaled punches
A list of Punch tags that have not been totalized Type: Zero or more Punch tags Output Only Introduced in v4 UntotaledWorkedDurations
1027
Chapter 2
Syntax
Properties <To Address = String [PersonNumber = String] [PersonKey = String] > </To>
Property Descriptions
Address
Kmail address
Email address Type: String Required validation done in the bean Introduced in v5.2 PersonKey
Person key
Person key Type: String
1028
Kronos Incorporated
To Tag
Person ID
person id Type: String Optional validation done in the bean Introduced in v5.2
1029
Chapter 2
Syntax
Request <Request Action = Actions 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
1030
Kronos Incorporated
TopicParameterDefinition Tag
Access Control Point Name: View Introduced in v6.0 RetrieveAll Retrieves all sorting or matching rule's topic parameter definition objects. Return Value Type: Zero or more TopicParameterDefinition tags Access Control Point Name: View Introduced in v6.0 RetrieveAllNames Retrieves all sorting or matching rule's topic parameter definition objects names. Return Value Type: String list Access Control Point Name: View Introduced in v6.0
Property Descriptions
TopicParameterName
1031
Chapter 2
Syntax
Properties <TopicParameterValue TopicParameterName = String Value = String > </TopicParameterValue>
Property Descriptions
TopicParameterName
1032
Kronos Incorporated
Total Tag
Syntax
Properties <Total (AmountInCurrency = Currency) (AmountInTime = TimeDuration) (LaborAccountDescription = String) (OrgJobDescription = String) (IsCurrencyFlag = Boolean) (LaborAccountName = String) (LaborAccountId = Long) (OrgJobName = String) (OrgJobId = Long) (PayCodeName = String) (PayCodeId = Long) > </Total>
Property Descriptions
AmountInCurrency
1033
Chapter 2
AmountInTime
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
1034
Kronos Incorporated
Total Tag
Labor account
Name of the labor account to which this amount is applied Type: String Output Only Maximum length: 356 characters Each component in the name corresponds to the name and sort order position of an existing labor level entry. The name must contain only legal naming characters. Introduced in v4 OrgJobDescription
Organizational job ID
A unique identifier for a job in the organization Type: Long Output only Introduced in v5.0 OrgJobName
Organizational job
The full path of the job in the organization
1035
Chapter 2
Type: String Output only Maximum length: 1000 characters Introduced in v5.0 PayCodeId
Pay code ID
The unique identifier of the pay code to which this amount is applied. Intended for use by 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
1036
Kronos Incorporated
TotaledScheduledPayCodeEdit Tag
Syntax
Properties <TotaledScheduledPayCodeEdit (AmountInTimeOrCurrency = String) (EnteredOnDate = Date) (Date = Date) (IsCurrencyFlag = Boolean) (LaborAccountName = String) (PayCodeName = String) (EnteredOnTime = Time) > (<Comments> <Comment>* </Comments>) </TotaledScheduledPayCodeEdit>
Property Descriptions
AmountInTimeOrCurrency
1037
Chapter 2
Introduced in v4 Comments
Comments
A list of comments currently returned with this timekeeping item Type: Zero or more Comment tags Output Only Introduced in v4 Date
1038
Kronos Incorporated
TotaledScheduledPayCodeEdit Tag
Labor account
This is the name of the labor account of the employee whose pay code amount or totaled amount is being edited. Type: String Output Only Maximum length: 356 characters Default value: Primary account for the employee Introduced in v4; last changed in v5.0 PayCodeName
Pay code
The pay code to be credited with the amount Type: String Output Only Must be associated with an hourly or monetary pay code edit Introduced in v4
1039
Chapter 2
Syntax
Properties <TotaledScheduledPayCodeEditUneditable (AmountInTimeOrCurrency = String) [CommentText = String] (EnteredOnDate = Date) (Date = Date) (IsCurrencyFlag = Boolean) (LaborAccountName = String) (PayCodeName = String) (EnteredOnTime = Time) > (<Comments> <Comment>* </Comments>) </TotaledScheduledPayCodeEditUneditable>
Property Descriptions
AmountInTimeOrCurrency
1040
Kronos Incorporated
TotaledScheduledPayCodeEditUneditable Tag
An amount expressed as a TimeDuration or Currency depending on the pay code. Must be consistent with the given pay code. Introduced in v4 Comments
Comments
A list of comments currently returned with this timekeeping item Type: Zero or more Comment tags Output Only Introduced in v4 CommentText
Comment text
A comment Type: String Optional Maximum length: 254 characters Must match exactly an applicable comment that already exists in the database. The string matching is case-sensitive. You can find values in the Workforce Timekeeper Setup Application. Introduced in v4 Date
1041
Chapter 2
Introduced in v4 EnteredOnDate
Labor account
This is the name of the labor account of the employee whose pay code amount or totaled amount is being loaded. A seven-level labor account will appear using the following format: 101/202/303/404/504/603/702. Type: String
1042
Kronos Incorporated
TotaledScheduledPayCodeEditUneditable Tag
Output Only Maximum length: 356 characters Default value: Primary account for the employee Introduced in v4; last changed in v5.0 PayCodeName
Pay code
The pay code to be credited with the amount Type: String Output Only Must be associated with an hourly or monetary pay code edit Introduced in v4
1043
Chapter 2
Syntax
Properties <TotaledScheduledWorkedDuration (AmountInTime = TimeDuration) (Date = Date) (LaborAccountName = String) (ScheduledLaborAccountName = String) (WorkRuleName = String) > (<Employee> <CurrentUser> | <PersonIdentity> </Employee>) (<Exceptions> <TimekeepingException>* </Exceptions>) </TotaledScheduledWorkedDuration>
Property Descriptions
AmountInTime
1044
Kronos Incorporated
TotaledScheduledWorkedDuration Tag
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, to be credited with the time. Type: Either CurrentUser or PersonIdentity tag Output Only Must uniquely identify an existing and active employee Introduced in v4 Exceptions
Timekeeping exceptions
A list of timekeeping exceptions. Dependency: Returned only when the WorkedDuration tag is returned as part of a Timesheet tag, and only if the most recent totalization detects one or more timekeeping exceptions for this WorkedDuration. Type: Zero or more TimekeepingException tags Output Only Introduced in v4
1045
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 Maximum length:356 characters Introduced in v4 ScheduledLaborAccountName
Work rule
A work rule associated with this worked duration. The duration is a transfer to this work rule. Type: String Output Only Maximum length: 50 characters Introduced in v4
1046
Kronos Incorporated
TotaledSpan Tag
Syntax
Properties <TotaledSpan (LaborAccountName = String) > (<Exceptions> <TimekeepingException>* </Exceptions>) (<OutPunch> <Punch> </OutPunch>) (<InPunch> <Punch> </InPunch>) </TotaledSpan>
Property Descriptions
Exceptions
1047
Chapter 2
Introduced in v4 InPunch
Labor account
The name of the labor account for which the span is charged Type: String Output Only Maximum length:356 characters Introduced in v4 OutPunch
1048
Kronos Incorporated
TotalSummary Tag
Syntax
Properties <TotalSummary (<Totals> <Total>* </Totals>) </TotalSummary>
Property Descriptions
Totals
Set of Totals
A list of totals, each of which reports an amount of time or currency for a unique combination of labor account and pay code Type: Zero or more Total tags Output only Introduced in v4
1049
Chapter 2
Syntax
Properties <Transaction [TransactionSequence = String] > </Transaction>
Property Descriptions
TransactionSequence
Transaction sequence
A number supplied by the client application that is returned in each Response tag for the Transaction Type: String Optional Introduced in v4
1050
Kronos Incorporated
TransferEmployee Tag
Syntax
Properties <TransferEmployee EffectiveDate = Date [LaborAccountName = String] [OrgJobPath = String] TransferStartTime = Time [WorkRuleName = String] > [<Comments> <Comment> </Comments>] </TransferEmployee>
Property Descriptions
Comments
Comments
Comments Type: Comment tag Optional Introduced in v5.1 EffectiveDate
Effective date
1051
Chapter 2
Work rule
WorkRuleName
1052
Kronos Incorporated
TransferEmployee Tag
1053
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "LoadAllJobSeniorityDates" | "Update" Parameters None Properties <TransferJobSeniorityDate EffectiveDate = Date [LocationOrgNodePath = String] PersonNumber = String [SeniorityDate = Date] > </TransferJobSeniorityDate>
Action Descriptions
Load Retrieves employee seniority information as of an effective date. Return Value Type: Collection
1054
Kronos Incorporated
TransferJobSeniorityDate Tag
Required Properties: PersonNumber, LocationOrgNodePath, EffectiveDate Access Control Point Name: View Introduced in v5.0; last changed in v5.0 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 Access Control Point Name: View Introduced in v5.1 Update Updates employee seniority information. The LocationOrgNodePath must represent an organizational node. Return Value Type: None Required Properties: PersonNumber, LocationOrgNodePath, EffectiveDate, SeniorityDate Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0
Property Descriptions
EffectiveDate
Effective date
The date when the job transfer set was assigned to the employee Type: Date Required Job Transfer Set with OrgJobs must be defined and exist on the given effective date. Introduced in v5.0; last changed in v5.0
1055
Chapter 2
LocationOrgNodePath
Person number
Person number of the specified person Type: String Required Key Maximum length: 15 characters 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. Introduced in v5.0; last changed in v5.0 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 Introduced in v5.0; last changed in v5.0
1056
Kronos Incorporated
TreeNodeType Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "addOnly" | "checkForRefrences" | "delete" | "retrieveAllForUpdate" | "retrieveAllNames" | "retrieveForUpdate" | "update" Parameters None Properties <TreeNodeType [Description = String] Name = String [NewName = String] [TreeTypeName = String] > [<GlsegmentDetail> <GlsegmentDetail> </GlsegmentDetail>] </TreeNodeType>
1057
Chapter 2
Action Descriptions
addOnly Add new tree node type into organizational map Return Value Type: None Required Properties: Name Optional Properties: Description, TreeTypeName, GlsegmentDetail Access Control Point Name: Edit Introduced in v6.0 checkForRefrences Check this tree node type is referenced by any tree node Return Value Type: Boolean Required Properties: Name Optional Properties: TreeTypeName Access Control Point Name: View Introduced in v6.0 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. Return Value Type: None Required Properties: name Access Control Point Name: Edit Introduced in v6.0 retrieveAllForUpdate Return all tree node type which can be updated Return Value Type: Zero or more TreeNodeType tags Optional Properties: TreeTypeName
1058
Kronos Incorporated
TreeNodeType Tag
Access Control Point Name: View Introduced in v6.0 retrieveAllNames Return all Names Return Value Type: String Optional Properties: TreeTypeName Access Control Point Name: View Introduced in v6.0; last changed in v6.0 retrieveForUpdate Retrun tree node type bean if this tree node type is not referenced by any tree node Return Value Type: TreeNodeType tag Required Properties: Name Optional Properties: TreeTypeName Access Control Point Name: View Introduced in v6.0; last changed in v6.0 update update tree node type Return Value Type: None Required Properties: Name Optional Properties: Description, TreeTypeName, GlsegmentDetail, newName Access Control Point Name: Edit Introduced in v6.0
Property Descriptions
Description
1059
Chapter 2
Type: String Optional Maximum length: 250 characters Sample values: description Introduced in v6.0; last changed in v6.0 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
1060
Kronos Incorporated
TreeNodeType Tag
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 Introduced in v6.0; last changed in v6.0 TreeTypeName
1061
Chapter 2
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View Introduced in v4
Property Descriptions
1062
Kronos Incorporated
TypeOverride Tag
OverrideRuleName
1063
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "LoadUserAccount" Parameters None Properties <User <Identity> <CurrentUser> | <PersonIdentity> </Identity> (<PasswordHistories> <PasswordHistory>* </PasswordHistories>) [<UserAccountData> <UserAccount> </UserAccountData>] (<UserAccountLockouts> <UserAccountLockout>* </UserAccountLockouts>)
1064
Kronos Incorporated
User Tag
</User>
Action Descriptions
Load Returns the user account, password history, and lockout information for the specified person. Return Value Type: User tag Required Properties: Identity Access Control Point Name: View Introduced in v4 LoadUserAccount Returns user account information for the specified person. Return Value Type: UserAccount tag Required Properties: Identity Access Control Point Name: View Introduced in v4
Property Descriptions
Identity
Identity
One employee, as specified in a PersonIdentity or CurrentUser tag. Type: Either CurrentUser or PersonIdentity tag Required Key Must uniquely identify an existing and active employee Introduced in v4 PasswordHistories
Password histories
1065
Chapter 2
Encrypted passwords for the specified dates and times Type: Zero or more PasswordHistory tags Output Only Introduced in v4 UserAccountData
1066
Kronos Incorporated
UserAccount Tag
Syntax
Properties <UserAccount [RecordManagerLockoutFlag = Boolean] [PasswordUpdateFlag = Boolean] (PasswordUpdatedDateTime = DateTime) (LockoutResetDateTime = DateTime) [LogonProfileName = String] (ConsecutiveBadLogons = Long) [UserName = String] [UserPassword = Password] > </UserAccount>
Property Descriptions
ConsecutiveBadLogons
1067
Chapter 2
LockoutResetDateTime
1068
Kronos Incorporated
UserAccount Tag
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
1069
Chapter 2
This property can only be used if you have the Record Management system installed. Default value: True Enumerated value: True, False 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 Maximum length: 70 characters 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 Maximum length: 30 characters Do not use an encrypted value for input. However, for output, the value is encrypted. Required: When adding a new user
1070
Kronos Incorporated
UserAccount Tag
Do not specify: For an existing user Introduced in v4; last changed in v5.0
1071
Chapter 2
Syntax
Properties <UserAccountLockout (EffectiveDateTime = DateTime) (LockoutReasonName = String) > </UserAccountLockout>
Property Descriptions
EffectiveDateTime
1072
Kronos Incorporated
UserAccountLockout Tag
Type: String Output Only Enumerated value: 1, 2, 3 2Password Lockout 3Maintenance Lockout Introduced in v4; last changed in v5.0
1073
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "LoadUserAccountStatuses" Parameters None Properties <UserAccountStatus UserAccountStatusName = String [EffectiveDate = Date] [ExpirationDate = Date] > <Identity> <CurrentUser> | <PersonIdentity> </Identity> [<Period> <TimeFramePeriod> </Period>] </UserAccountStatus>
Action Descriptions
1074
Kronos Incorporated
UserAccountStatus Tag
LoadUserAccountStatuses Returns information associated with the user account status for the specified person over the period specified. If the period is not specified, the current date through January 1, 3000 is used. The Identity and Period information associated with the request will be added to the first tag in the resulting list. An empty tag (with just the Identity and Period properties) will be returned when no data for the person or period is found. The person must exist within the system and the user must have access to that person. Return Value Type: Zero or more UserAccountStatus tags Required Properties: Identity Optional Properties: Period Access Control Point Name: View Introduced in v5.0
Property Descriptions
EffectiveDate
1075
Chapter 2
Optional Must occur after the effective date. Default value: January 1, 3000 Introduced in v4 Identity
Identity
One person, as specified in a PersonIdentity or CurrentUser tag. Type: Either CurrentUser or PersonIdentity tag Optional Key Must uniquely identify a person. Introduced in v5.0 Period
Time period
The period of time associated with the user account statuses. Type: TimeFramePeriod tag 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. Default value: From the current date until January 1, 3000 Introduced in v5.0 UserAccountStatusName
1076
Kronos Incorporated
UserAccountStatus Tag
1077
Chapter 2
Syntax
Request <Request Action = Actions 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>*
1078
Kronos Incorporated
VacationBid Tag
</BidNotes>] </VacationBid>
Action Descriptions
Approve Approve the vacation bid specified by the vacation bid id and upon approval be able to specify true or false value for creating an open shift or not. For the Approve Action, the BidId property and the CreateOpenShift property MUST be specified. Return Value Type: None Required Properties: BidId, CreateOpenShift Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0a Load Loads the vacation bid given the bid id value. For the Load Action, the BidId property must be specified. Return Value Type: VacationBid tag Required Properties: BidId Access Control Point Name: View Introduced in v5.0; last changed in v5.0a LoadByBidGroupItem Loads the vacation bid(s) given the bid group item id. For the LoadBidGroupItemId, the BidGroupItemId property MUST be specified. Return Value Type: Zero or more VacationBid tags Required Properties: BidGroupItemId Access Control Point Name: View Introduced in v5.0; last changed in v5.0a
1079
Chapter 2
Reject Rejects the vacation bid specified by the vacation bid id. For the Reject Action, the BidId property MUST be specified. Return Value Type: None Required Properties: BidId Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0a
Property Descriptions
BidGroupItemId
Vacation Bid ID
BidId uniquely identifies a row in the WMPVACATIONBID table, which contains information about vacation bids.
1080
Kronos Incorporated
VacationBid Tag
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. Introduced in v5.1; last changed in v5.1 BidNotes
Bid Notes
List of Bid Notes to add a specific bid. Type: Zero or more BidNote tags Optional If defined for an Action, the BidNotes property cannot be null. The contents of the BidNotes list cannot be null. The BidNotes property MUST contain one or more BidNote elements. The BidNotes property MUST be specified for the ApplyBidBNotes Action. Sample values: <VacationBid Id="501"> <BidNotes> <BidNote Sequence="1" Text="For vacation bid with Id=501"> </BidNote> </BidNotes> </VacationBid> Introduced in v5.1; last changed in v5.1 CreateOpenShift
1081
Chapter 2
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" Default value: "false" Introduced in v5.0; last changed in v5.1 EndDate
1082
Kronos Incorporated
VacationBid Tag
Bid Priority
Specifies the priority of a bid, also know as the bid rank. Type: Integer Optional Priority cannot be less than 1. Required when adding vacation bids Sample values: <VacationBid BidGroupItemId="3" Priority="1" StartDate="04/01/2004 00:00:00" EndDate="05/01/2004 11:48:56" HoursPerDay="288000" CreateOpenShift="false"> </VacationBid> Introduced in v5.1; last changed in v5.1 StartDate
1083
Chapter 2
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 Enumerated value: Submitted - 0, Approved - 1, Rejected - 2 Introduced in v5.1; last changed in v5.1
1084
Kronos Incorporated
VolumeDataItem Tag
Syntax None
1085
Chapter 2
Syntax
Request <Request Action = Actions 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.
1086
Kronos Incorporated
WageProfile Tag
Name should be valid Return Value Type: WageProfile tag Required Properties: WageProfileName Access Control Point Name: View Introduced in v4 LoadAllWageProfiles Returns a list of all wage profiles in the system. Return Value Type: Zero or more WageProfile tags Required Properties: None Access Control Point Name: View Introduced in v4 LoadById Returns a wage profile, based on WageProfileID. ID must be valid Return Value Type: WageProfile tag Required Properties: WageProfileID Access Control Point Name: View Introduced in v4
Property Descriptions
WageProfileId
Id of wage profile
Uniquely identifies the wage profile in the database Type: Integer Optional Introduced in v4
1087
Chapter 2
WageProfileName
1088
Kronos Incorporated
WeekDay Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "LoadAll" Parameters None Properties <WeekDay Description = String 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
1089
Chapter 2
Access Control Point Name: View 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 Access Control Point Name: View Introduced in v5.0
Property Descriptions
Description
Description
The localized description of the week day. This value is used as the display name in the user interface. Type: String Optional Key Introduced in v5.0 Name
1090
Kronos Incorporated
WFCGenie Tag
Syntax
Request <Request Action = Actions 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>
1091
Chapter 2
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 Access Control Point Name: View Introduced in v5.2 LoadAllGenies Returns the names of all items for the specified user. Return Value Type: (***undefined***): Genie Required Properties: None Access Control Point Name: View Introduced in v5.2 LoadMetadata Returns only the metadata for the specified item. Return Value Type: (***undefined***): Genie Required Properties: GenieName Access Control Point Name: View Introduced in v5.2
Property Descriptions
GenieColumns
Column data
1092
Kronos Incorporated
WFCGenie Tag
Column metadata returned. Present only in a Load or LoadMetadata response. Type: GenieColumn tag Optional Introduced in v5.2; last changed in v5.2 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
1093
Chapter 2
HyperFindQueryName
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. Type: Zero or more PersonIdentity tags Required Introduced in v5.2; last changed in v5.2 Period
Period
The time frame used to execute the HyperFind query. Required in a Load request; must be omitted in a LoadAllGenies request. Type: TimeFramePeriod tag Required Must evaluate to a span of time. Introduced in v5.2
1094
Kronos Incorporated
WfcJob Tag
Syntax
Request <Request Action = Actions 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
1095
Chapter 2
AddOnly Adds a new job to the job hierarchy. Return Value Type: None Required Properties: WfcJobName Optional Properties: WfcJobDesc, JobCode, JobTitle, LLEName, LLEDesc, InActiveSw, SortOrder Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0 Delete Marks an existing job for deletion. Return Value Type: None Required Properties: WfcJobName Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0 LoadByName Returns information for a job with the specified name. Return Value Type: WfcJob tag Required Properties: WfcJobName Access Control Point Name: View Introduced in v5.0; last changed in v5.0 UpdateOnly Updates an existing job. Return Value Type: None Required Properties: WfcJobName Optional Properties: WfcJobDesc, JobCode, JobTitle, LLEName, LLEDesc, InActiveSw, SortOrder, WfcJobNewName Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0
1096
Kronos Incorporated
WfcJob Tag
Property Descriptions
InActiveSw
Job code
The job code name can be used to identify a job. It is often used when the job has been imported from another system. Type: String Optional Maximum length: 30 characters Introduced in v5.0; last changed in v5.0 JobTitle
1097
Chapter 2
LLEDesc
Sort order
The sort order number controls the order in which the job appears in functions such as Schedule Planner or Staff Planner. Type: Long Optional Maximum length: 9 characters Use only integers that are greater than zero. Introduced in v5.0; last changed in v5.0 WfcJobDesc
Job description
1098
Kronos Incorporated
WfcJob Tag
The description for the specified job Type: String Optional Maximum length: 250 characters Introduced in v5.0; last changed in v5.0 WfcJobName
Job name
Job name Type: String Required Maximum length: 30 characters Must conform to the name property standards Introduced in v5.0; last changed in v5.0 WfcJobNewName
1099
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddComment" | "AddOnly" | "Delete" Parameters AddOnly [AccrualOverride = Boolean] [allowAdHoc = Boolean] [EchoData = Boolean] Properties <WorkedDuration OrgJobName = String OrgJobId = String AmountInTime = TimeDuration [CommentText = String] (EnteredOnDate = Date) Date = Date [LaborAccountName = String] [ScheduledLaborAccountName = String] [NewShiftOverrideFlag = Boolean]
1100
Kronos Incorporated
WorkedDuration Tag
(EnteredOnTime = Time) [WorkRuleName = String] > [<Notes> <Note>* </Notes>] (<Comments> <Comment>* </Comments>) <Employee> <CurrentUser> | <PersonIdentity> </Employee> (<Exceptions> <TimekeepingException>* </Exceptions>) </WorkedDuration>
Action Descriptions
AddComment Adds a comment for the specified worked durations for the specified employee. Depending on the type of worked duration, you may need to specify one of the following properties: LaborAccountName WorkRuleName
Return Value Type: None Required Properties: AmountInTime, Date, Employee, CommentText Access Control Point Name: Edit Introduced in v4 AddOnly Adds a new worked duration with the specified amount and date for the specified employee. You can add multiple worked durations with identical amount and date values, for the same employee. Return Value Type: WorkedDuration tag Required Properties: AmountInTime, Date, Employee
1101
Chapter 2
allowAdHoc
Introduced in v5.0; last changed in v5.0; deprecated in v5.0. Not used Introduced in v4
EchoData
Delete Marks for deletion all worked durations for the employee and the work duration. Return Value Type: None Required Properties: AmountInTime, Date, Employee Access Control Point Name: Edit Introduced in v4
Property Descriptions
OrgJobName
Organizational job
The name of the organizational job path of the employee whose pay code amount or totaled amount is being edited.
1102
Kronos Incorporated
WorkedDuration Tag
Enter data for OrgJobName in the same format as it appears in the database. Note: OrgJobName string matching is case-sensitive on a server that connects to an Oracle database. Required: When the pay code edits, historical edit, or totaled amount being deleted or commented contained an explicit OrgJobName value Type: String Maximum length: 1000 characters You must have Functional Access for Job Transfers. A node with this Id must exist in the organizational structure Default value: null Introduced in v5.0 OrgJobId
Organizational job ID
A unique identifier for a job in the organization Type: String Default value: Null Introduced in v5.0 AmountInTime
Comments
The set of comments that are associated with worked durations in the timesheet.
1103
Chapter 2
Comment text
A text string that is attached to the pay code amount or totaled amount. Type: String Optional Maximum length: 254 characters Must match exactly an applicable comment that already exists in the database. The string matching is case-sensitive. You can find values in the Workforce Timekeeper Setup Application. Introduced in v4 Date
Effective date
The date for which the added or deleted time duration is to be posted. Type: Date Required, Key Introduced in v4; last changed in v5.1 Employee
Employee
One employee, as specified in a PersonIdentity or CurrentUser tag, who is to be credited with the time. Type: Either CurrentUser or PersonIdentity tag Required, Key Must uniquely identify an existing and active employee
1104
Kronos Incorporated
WorkedDuration Tag
Introduced in v4 EnteredOnDate
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. Type: Zero or more TimekeepingException tags Output Only Introduced in v4 LaborAccountName
Labor account
The name of the labor account
1105
Chapter 2
Enter data for labor accounts in the same format as they appear in the timekeeping database. For example, if you have a seven-level labor account, specify a value for each labor level, using the following format: 101/202/303/404/504/603/702 Do not specify labor levels that are not changing. If any of the labor levels are the same as the employee's primary labor account, you can enter @H for those labor levels instead of entering the labor entry names. Type: String Optional Maximum length: 356 characters. Introduced in v4 NewShiftOverrideFlag
Comment Notes
The list of notes for the comment to be created with the comment text Type: Zero or more Note tags Optional Introduced in v6.0
1106
Kronos Incorporated
WorkedDuration Tag
ScheduledLaborAccountName
Work rule
The work rule for which the amount is being applied. If left blank, the employee's default work rule is used. The following predefined data values are provided: &ALL_WORK_RULES &EMPTY
Type: String Optional Maximum length: 50 characters You can find values in the Timekeeping Application. Introduced in v4; last changed in v5.1
1107
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "AddOnly" | "Delete" | "Load" | "LoadAll" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" | "UpdateOnly" Parameters None Properties <WorkerType Name = String > <WorkerTypeElements> <WorkerTypeElement>* </WorkerTypeElements> </WorkerType>
1108
Kronos Incorporated
WorkerType Tag
Action Descriptions
AddOnly Adds a new worker type to the database. Return Value Type: None Required Properties: WorkerTypeElements Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0 Delete Marks a worker type record for deletion. This worker type must exist Return Value Type: None Required Properties: WorkerTypeElements Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0 Load Returns the specified worker type. The worker type must exist Return Value Type: WorkerType tag Required Properties: WorkerTypeElements Access Control Point Name: View Introduced in v5.0; last changed in v5.0 LoadAll Returns all available worker types. Return Value Type: Zero or more WorkerType tags Access Control Point Name: View Introduced in v5.0 RetrieveAllNames Returns the names of all worker types (SDM-required action).
1109
Chapter 2
Return Value Type: (***undefined***): KBusinessObjectNameList Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified worker type (SDM-required action). Return Value Type: WorkerType tag Required Properties: Name Access Control Point Name: View Introduced in v5.1; last changed in v5.1 Update Adds a new worker type or updates an existing one. Return Value Type: None Required Properties: WorkerTypeElements Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0 UpdateOnly Updates an existing worker type value. Return Value Type: None Required Properties: WorkerTypeElements Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0
Property Descriptions
Name
Worker Type
The name of the worker type. Type: String
1110
Kronos Incorporated
WorkerType Tag
Optional Key Maximum length: 50 characters Sample values: Full Time, Part Time, Per Diem Introduced in v5.1 WorkerTypeElements
1111
Chapter 2
Syntax
Properties <WorkerTypeElement [IsActive = Boolean] NewName = String WorkerTypeName = String > </WorkerTypeElement>
Property Descriptions
IsActive
1112
Kronos Incorporated
WorkerTypeElement Tag
1113
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "UpdateOnly" Parameters None Properties <WorkflowAccessAssignment [EmployeeWorkflowProfileName = String] [ManagerWorkflowProfileName = String] > <Identity> <CurrentUser> | <PersonIdentity> </Identity> </WorkflowAccessAssignment>
1114
Kronos Incorporated
WorkflowAccessAssignment Tag
Action Descriptions
Load Retrieves a process profile access assignment given the Identity of a person. The Identity property must be specified for the Load Action. The Identity property must be 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 Required Properties: Identity Access Control Point Name: View Introduced in v5.0; last changed in v5.0 UpdateOnly Assigns a person to a specific employee process profile and/or a manager process profile. For the UpdateOnly action, the Identity property MUST be specified, and EmployeeWorkflowProfileName and/or the ManagerWorkflowProfileName MUST be specified. Return Value Type: None Required Properties: Identity, Either EmployeeWorkflowProfileName and/or ManagerWorkflowProfileName Access Control Point Name: Edit Introduced in v5.0; last changed in v5.0
Property Descriptions
EmployeeWorkflowProfileName
1115
Chapter 2
Optional If the EmployeeWorkflowProfileName is defined for an action, the EmployeeWorkflowProfileName cannot be null. The EmployeerWorkProfileName must be assigned a string value of a process profile name that already exists in the database. Sample values: EmployeeWorkflowProfileName="All Process Templates" Introduced in v5.0; last changed in v5.0 Identity
Identity
Identifies the subject person. The Identity property MUST be specified for the UpdateOnly and Load Actions. Type: Either CurrentUser or PersonIdentity tag 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> Introduced in v5.0; last changed in v5.0 ManagerWorkflowProfileName
1116
Kronos Incorporated
WorkflowAccessAssignment Tag
Optional If the ManagerWorkflowProfileName property is defined for an action, the ManagerWorkflowProfileName cannot be null. The ManagerWorkProfileName must be assigned a string value of a process profile name that already exists in the database. Sample values: ManagerWorkflowProfileName="All Process Templates" Introduced in v5.0; last changed in v5.0
1117
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllCategories" Parameters None Properties <WorkflowTemplateCategory [Description = String] Id = Long Name = String Originator = Integer > </WorkflowTemplateCategory>
Action Descriptions
RetrieveAllCategories This action returns a list of the template categories. Return Value Type: WorkflowTemplateCategory tag Access Control Point Name: Edit
1118
Kronos Incorporated
WorkflowTemplateCategory Tag
Property Descriptions
Description
Category description
A description of the category. Type: String Optional Maximum Length: 250 characters Introduced in v5.1 Id
Category identifier
The category's Id. Type: Long Required Key Must be greater than zero 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
1119
Chapter 2
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 The Category Originator must be either 0 or 1. Sample values: 0, 1 Introduced in v5.1
1120
Kronos Incorporated
WorkRule Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "LoadAllWorkRules" Parameters None Properties <WorkRule (ManagerHasAccessFlag = Boolean) (ProfessionalHasAccessFlag = Boolean) (WorkRuleName = String) > </WorkRule>
Action Descriptions
1121
Chapter 2
LoadAllWorkRules Returns a list of all work rules in the system Return Value Type: Zero or more WorkRule tags Required Properties: None Access Control Point Name: View Introduced in v4
Property Descriptions
ManagerHasAccessFlag
1122
Kronos Incorporated
WorkRule Tag
1123
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Load" | "LoadAllWorkRuleProfiles" | "LoadById" Parameters None Properties <WorkRuleProfile [WorkRuleProfileId = Integer] [WorkRuleProfileName = String] > </WorkRuleProfile>
Action Descriptions
1124
Kronos Incorporated
WorkRuleProfile Tag
Load Returns a work rule profile, based on WorkruleProfileName. Name should be valid Return Value Type: WorkRuleProfile tag Required Properties: WorkruleProfileName Access Control Point Name: View Introduced in v4 LoadAllWorkRuleProfiles Returns a list of all work rule profiles in the system. Return Value Type: Zero or more WorkRuleProfile tags Required Properties: None Access Control Point Name: View Introduced in v4 LoadById Returns a work rule profile, based on WorkruleProfileID. ID should be valid Return Value Type: WorkRuleProfile tag Required Properties: WorkruleProfileID Access Control Point Name: View Introduced in v4
Property Descriptions
WorkRuleProfileId
1125
Chapter 2
Introduced in v4 WorkRuleProfileName
1126
Kronos Incorporated
WorkWeek Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Delete" | "GetOutsideDates" | "Retrieve" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters GetOutsideDates EndDate = Date PersonNumber = String StartDate = Date Update [NewName = String] Properties <WorkWeek
1127
Chapter 2
[Description = String] [Active = Boolean] Name = String > [<WorkWeekDays> <WorkWeekDay>* </WorkWeekDays>] </WorkWeek>
Action Descriptions
Delete Deletes the named work week from the database, it it exists None Return Value Type: None Required Properties: Name Access Control Point Name: Edit 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 Access Control Point Name: View Introduced in v6.0
1128
Kronos Incorporated
WorkWeek Tag
Action Parameters Parameter Name EndDate Description The end date identifies the last date of a date range. The end date will be included in the date range. Required An error will be generated for invalid dates Additional information Introduced in v999; last changed in v999
PersonNumber
The person number is the unique WFC Introduced in v999; last changed in v999 identification string for an employee 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 The start date identifies the first date of a date range. The start date will be included in the date range. Required An error will be generated for invalid dates Introduced in v999; last changed in v999
StartDate
Retrieve Retrieves the WorkWeek with the given name from the system Name must not be empty Return Value Type: WorkWeek tag Required Properties: Name Access Control Point Name: Edit Introduced in v6.0 RetrieveAllNames Provides the names of all work weeks in the system Return Value Type: String list
1129
Chapter 2
Access Control Point Name: View 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 Required Properties: Name Access Control Point Name: Edit Introduced in v6.0 Update Creates or replaces the WorkWeek with the given name Name must not be empty Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v6.0
Action Parameters Parameter Name NewName Description Specifies a new name for the given work week. Optional NewName must not be empty. Additional information Introduced in v999; last changed in v999
Property Descriptions
Active
1130
Kronos Incorporated
WorkWeek Tag
Type: Boolean Optional None Sample values: <Active> false</Active> Default value: true Introduced in v6.0; last changed in v6.0 Description
1131
Chapter 2
1132
Kronos Incorporated
WorkWeekAssignments Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Delete" | "Retrieve" | "RetrieveAllNames" | "RetrieveForUpdate" | "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
1133
Chapter 2
Return Value Type: None Required Properties: Name Access Control Point Name: Edit 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 Required Properties: Name Access Control Point Name: View Introduced in v6.0 RetrieveAllNames Returns all of the work week names Return Value Type: String list Access Control Point Name: View Introduced in v6.0 RetrieveForUpdate The assignments for the work week with the given name Return Value Type: WorkWeekAssignments tag Required Properties: Name Access Control Point Name: Edit Introduced in v6.0 Update Creates or updates the work week assignment in the system Return Value Type: None Required Properties: Name, EmployeeRuleSets Access Control Point Name: Edit Introduced in v6.0
1134
Kronos Incorporated
WorkWeekAssignments Tag
Property Descriptions
EmployeeRuleSets
1135
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Update" Parameters None Properties <WorkWeekDay Date = Date DayOfWeek = String [CountsTowardMaxHoursPerWeek = Boolean] [CountsTowardMinHoursPerWeek = Boolean] [CountsTowardMaxDaysPerWeek = Boolean] > </WorkWeekDay>
Action Descriptions
Update Updates a WorkWeekDay object into the system. Return Value Type: None
1136
Kronos Incorporated
WorkWeekDay Tag
Required Properties: DayOfWeek, Date, Optional Properties: CountsTowardMaxDaysPerWeek, CountsTowardMaxHoursPerWeek, CountsTowardMinHoursPerWeek Access Control Point Name: Edit Introduced in v6.0
Property Descriptions
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> Introduced in v6.0 DayOfWeek
weekday
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 Introduced in v6.0
1137
Chapter 2
CountsTowardMaxDaysPerWeek
work on the date counts 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. Default value: false Introduced in v6.0 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. Default value: false Introduced in v6.0 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
1138
Kronos Incorporated
WorkWeekDay Tag
Optional All CountsTowards values in the WorkWeekDay must tbe identical. Either all are false, or all are true. This may change in the future. Default value: false Introduced in v6.0
1139
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" Parameters None Properties <WSAAccrualCode Name = String > </WSAAccrualCode>
Action Descriptions
RetrieveAllForUpdate Returns all accrual codes for update. Return Value Type: Zero or more WSAAccrualCode tags Access Control Point Name: View
1140
Kronos Incorporated
WSAAccrualCode Tag
Introduced in v5.1 RetrieveAllNames Returns a list of the names of all accrual codes - for example, Vacation, Sick. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified accrual code for update. Return Value Type: WSAAccrualCode tag Required Properties: Name Access Control Point Name: View Introduced in v5.1; last changed in v5.1
Property Descriptions
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
1141
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Delete" | "Retrieve" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAAccrualDetail [Description = String] [DisplayDescription = String] [DisplayName = String] [Name = String] > [<ColumnSet> <WSAWfgColumnSet> </ColumnSet>] [<DefaultHyperfindQuery> <WSAHyperfindQuery> </DefaultHyperfindQuery>] [<DefaultTimePeriod> <WSADPTimePeriod>
1142
Kronos Incorporated
WSAAccrualDetail Tag
Action Descriptions
Delete Delete Accrual Detail Genie by name Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v6.0; last changed in v6.0 Retrieve Retrieve WSA Accrual Detail by name Return Value Type: WSAAccrualDetail tag Required Properties: Name Access Control Point Name: View Introduced in v6.0 RetrieveAllForUpdate Retrieve all Accural Detail genies for Update Return Value Type: Zero or more WSADetail tags Access Control Point Name: View Introduced in v6.0; last changed in v6.0 RetrieveAllNames Retrieve All Accrual Detail Names Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v6.0; last changed in v6.0
1143
Chapter 2
RetrieveForUpdate Retrieve WSA Accrual Detail by name for update Return Value Type: WSAAccrualDetail tag Required Properties: Name Access Control Point Name: View Introduced in v6.0; last changed in v6.0 Update Update the Accrual Detail Genie by Name Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v6.0
Property Descriptions
ColumnSet
Column Set
The column set Object Type: WSAWfgColumnSet tag Optional Introduced in v6.0 DefaultHyperfindQuery
1144
Kronos Incorporated
WSAAccrualDetail Tag
DefaultTimePeriod
Description
Description of Accrual Detail Type: String Optional Introduced in v6.0; last changed in v6.0 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 Introduced in v6.0; last changed in v6.0
1145
Chapter 2
Name
Name
Name of Accrual Detail genie Type: String Optional Introduced in v6.0; last changed in v6.0 NavbarCategory
navBar Category
navBar Category Type: WSANavbarCategory tag Optional Introduced in v6.0
1146
Kronos Incorporated
WSAAccrualDetailColumnSet Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Delete" | "Retrieve" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAAccrualDetailColumnSet [Description = String] [ExteriorItemNumber = Long] [DisplayDescription = String] [DisplayName = String] [ExteriorName = String] Name = String > [<ColumnDetail> <WSAColumnDetail>* </ColumnDetail>] </WSAAccrualDetailColumnSet>
1147
Chapter 2
Action Descriptions
Delete Delete Accrual Detail Column Set by Name Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v6.0; last changed in v6.0 Retrieve Retrieve Accrual Detail Column Set genie by name. Return Value Type: WSAAccrualDetailColumnSet tag Required Properties: Name Access Control Point Name: View Introduced in v6.0; last changed in v6.0 RetrieveAllForUpdate Retrieve All Accrual Detail Column Sets for Update Return Value Type: Zero or more WSAAccrualDetailColumnSet tags Access Control Point Name: View Introduced in v6.0; last changed in v6.0 RetrieveAllNames Retrieve all Accrual Detail Column set names Return Value Type: String list Access Control Point Name: View Introduced in v6.0; last changed in v6.0 RetrieveForUpdate Retrieve Accrual Detail Column set by name for update Return Value Type: WSAAccrualDetailColumnSet tag Required Properties: Name Access Control Point Name: View
1148
Kronos Incorporated
WSAAccrualDetailColumnSet Tag
Introduced in v6.0; last changed in v6.0 Update Update the AccrualDetailColumnSet by Name Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v6.0; last changed in v6.0
Property Descriptions
ColumnDetail
Column detail
Column details that are assigned Type: Zero or more WSAColumnDetail tags Optional Introduced in v6.0; last changed in v6.0 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
1149
Chapter 2
display name
Name to display in the user interface Type: String Optional Introduced in v6.0 ExteriorItemNumber
exterior name
Exterior Name Type: String Optional Introduced in v6.0 Name
name
name of Accrual Detail Column Set genie Type: String Optional Key Introduced in v6.0; last changed in v6.0
1150
Kronos Incorporated
WSAAccrualPolicy Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Delete" | "Retrieve" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "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]
1151
Chapter 2
[GroupEditOverride = Boolean] [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. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2 Retrieve Retrieves the specified accrual policy. Return Value Type: WSAAccrualPolicy tag Required Properties: Name Access Control Point Name: View Introduced in v5.2
1152
Kronos Incorporated
WSAAccrualPolicy Tag
RetrieveAllForUpdate Retrieves all accrual policies for update. Return Value Type: Zero or more WSAAccrualPolicy tags Access Control Point Name: View Introduced in v5.2 RetrieveAllNames Retrieves a list of the names of all accrual policies (active and inactive). Return Value Type: String list Access Control Point Name: View Introduced in v5.2 RetrieveForUpdate Retrieves the specified accrual policy for update. Return Value Type: WSAAccrualPolicy tag Required Properties: Name Access Control Point Name: View Introduced in v5.2 Update Updates an existing accrual policy or creates a new one. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
AccrualCode
Accrual
Name of the accrual code that is governed by this accrual policy.
1153
Chapter 2
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
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
1154
Kronos Incorporated
WSAAccrualPolicy Tag
FutureOverdraftError
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.
1155
Chapter 2
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
1156
Kronos Incorporated
WSAAccrualPolicy Tag
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 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
1157
Chapter 2
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
Probation period
The name of the probation period for this accrual policy. Type: String Optional Introduced in v5.2 RestoreTaking
Restore taking
1158
Kronos Incorporated
WSAAccrualPolicy Tag
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
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.
1159
Chapter 2
1160
Kronos Incorporated
WSAAccrualPolicyGrant Tag
Syntax
Properties <WSAAccrualPolicyGrant [ExpireToAccrual = String] [Amount = String] GrantRule = String [LengthOfService = Integer] > </WSAAccrualPolicyGrant>
Property Descriptions
Amount
Amount accrued
The amount accrued by this grant. Type: String Optional Introduced in v5.2 ExpireToAccrual
1161
Chapter 2
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
1162
Kronos Incorporated
WSAAccrualPolicyLimit Tag
Function Access Control Point: API.Accruals Introduced in v5.2; last changed in v5.2
Syntax
Properties <WSAAccrualPolicyLimit [Amount = String] [LengthOfService = Integer] GrantRule = String > </WSAAccrualPolicyLimit>
Property Descriptions
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. Type: String Optional
1163
Chapter 2
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
1164
Kronos Incorporated
WSAAccrualPolicyPayCode Tag
Syntax
Properties <WSAAccrualPolicyPayCode PayCode = String > </WSAAccrualPolicyPayCode>
Property Descriptions
PayCode
Pay code
The name of the pay code to apply to the earned grant. Type: String Required Introduced in v5.2
1165
Chapter 2
Syntax
Properties <WSAAccrualPolicyTakingLimit [DisallowAmount = String] Name = String [WarningAmount = String] > </WSAAccrualPolicyTakingLimit>
Property Descriptions
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 Introduced in v5.2
1166
Kronos Incorporated
WSAAccrualPolicyTakingLimit Tag
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
1167
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Delete" | "Retrieve" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAAccrualProfile [AccrualCode = String] Name = String > <AccrualProfilePolicies> <WSAAccrualProfilePolicy>* </AccrualProfilePolicies> </WSAAccrualProfile>
Action Descriptions
1168
Kronos Incorporated
WSAAccrualProfile Tag
Delete Deletes the specified Accrual Profile. The submitted name must be a valid name for an existing Accrual Profile and must not be in use. Return Value Type: None Required Properties: Name Access Control Point Name: Edit 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 Required Properties: Name Access Control Point Name: View Introduced in v5.2 RetrieveAllForUpdate Returns a list of all of the Accrual Profiles to be used for the update action. Return Value Type: Zero or more WSAAccrualProfile tags Access Control Point Name: View Introduced in v5.2 RetrieveAllNames Returns a list of Accrual Profile names. Return Value Type: String list Access Control Point Name: View Introduced in v5.2 RetrieveForUpdate Returns the specified Accrual Profile for updating. The name supplied must be a valid Accrual Profile name.
1169
Chapter 2
Return Value Type: WSAAccrualProfile tag Required Properties: Name Access Control Point Name: View 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. Return Value Type: None Required Properties: WSAAccrualProfile Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
AccrualCode
1170
Kronos Incorporated
WSAAccrualProfile Tag
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
1171
Chapter 2
Syntax
Properties <WSAAccrualProfilePolicy AccrualPolicy = String [Display = Boolean] > </WSAAccrualProfilePolicy>
Property Descriptions
AccrualPolicy
1172
Kronos Incorporated
WSAAccrualProfilePolicy Tag
Introduced in v5.2
1173
Chapter 2
Syntax
Properties <WSAAccrualQualifier [Amount = String] NumToCheck = Integer [PayCode = String] Type = String [CheckAtLeastMin = Boolean] > [<Interval> <WSAInterval> </Interval>] </WSAAccrualQualifier>
Property Descriptions
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 Optional Introduced in v5.2
1174
Kronos Incorporated
WSAAccrualQualifier Tag
CheckAtLeastMin
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
Pay code
1175
Chapter 2
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
1176
Kronos Incorporated
WSAAPICombination Tag
Syntax
Request <Request Action = Actions 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 Required Properties: Name
1177
Chapter 2
Access Control Point Name: View Introduced in v5.2; last changed in v5.2 RetrieveForUpdate Returns Combination for update Return Value Type: WSAAPICombination tag Required Properties: Name Access Control Point Name: View Introduced in v5.2; last changed in v5.2
Property Descriptions
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
1178
Kronos Incorporated
WSAAPICombination Tag
1179
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Retrieve" | "RetrieveForUpdate" Parameters None Properties <WSAAPICombinationComponent [ContinueToCountTO = Boolean] Description = String Name = String Type = String > </WSAAPICombinationComponent>
Action Descriptions
Retrieve Returns the specified Combination Component Return Value Type: WSAAPICombinationComponent tag Required Properties: Name Access Control Point Name: View
1180
Kronos Incorporated
WSAAPICombinationComponent Tag
Introduced in v5.2 RetrieveForUpdate Return the specified Combination Component Return Value Type: WSAAPICombinationComponent tag Required Properties: Name Access Control Point Name: View Introduced in v5.2
Property Descriptions
ContinueToCountTO
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
1181
Chapter 2
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
1182
Kronos Incorporated
WSAAPICombinationRule Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Delete" | "Retrieve" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAAPICombinationRule Name = String > [<Combinations> <WSAAPICombination>* </Combinations>] [<CombinationTowardOT> <WSAAPICombinationTowardOT>* </CombinationTowardOT>] [<SelectedComponents> <WSAAPICombinationComponent>* </SelectedComponents>] </WSAAPICombinationRule>
1183
Chapter 2
Action Descriptions
Delete Deletes the specified Combination Rule Return Value Type: None Required Properties: Name Access Control Point Name: View Introduced in v5.2 Retrieve Returns the CombinationRule by the name Return Value Type: WSAAPICombinationRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.2 RetrieveAllForUpdate Return a list of Combination Rule ready for Update Return Value Type: (***undefined***): WSAAPICombinationRule list Access Control Point Name: View Introduced in v5.2; last changed in v5.2 RetrieveAllNames Returns a list of names for all of the Combination Rules Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.2 RetrieveForUpdate Retrieves a CombinationRule by name for update Return Value Type: WSAAPICombinationRule tag Required Properties: Name Access Control Point Name: View
1184
Kronos Incorporated
WSAAPICombinationRule Tag
Introduced in v5.2 Update Updates the combination rule Return Value Type: None Required Properties: WSAAPICombinationRule Access Control Point Name: View Introduced in v5.2; last changed in v5.2
Property Descriptions
Combinations
Combination list
A list of Combinations Type: Zero or more WSAAPICombination tags Optional Introduced in v5.2; last changed in v5.2 CombinationTowardOT
Name
The name for the given Combination Rule Type: String Required
1185
Chapter 2
1186
Kronos Incorporated
WSAAPICombinationTowardOT Tag
Syntax
Request <Request Action = Actions 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
1187
Chapter 2
Return Value Type: WSAAPICombinationTowardOT tag Required Properties: Name Access Control Point Name: View Introduced in v6.0 RetrieveForUpdate Retrieve a Combination Toward Overtime for update Return Value Type: WSAAPICombinationTowardOT tag Required Properties: Name Access Control Point Name: Edit Introduced in v6.0
Property Descriptions
CountsTowardTargetOT
1188
Kronos Incorporated
WSAAPICombinationTowardOT Tag
The name of the source Rule of the Combination Toward Overtime Type: String Required Introduced in v6.0 TargetOTRuleComponentType
1189
Chapter 2
Syntax
Request <Request Action = Actions 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] [WorkRuleName = String] >
1190
Kronos Incorporated
WSAAssignmentRule Tag
</WSAAssignmentRule>
Action Descriptions
Retrieve Returns the specified assignment rule for update. Return Value Type: WSAAssignmentRule tag Access Control Point Name: View Introduced in v5.1
Property Descriptions
Friday
1191
Chapter 2
1192
Kronos Incorporated
WSAAssignmentRule Tag
ScheduleStartTime
1193
Chapter 2
Boolean value that, when True (the default), indicates that the assignment rule is enabled for Sunday. Type: Boolean Optional Introduced in v5.1 Thursday
1194
Kronos Incorporated
WSAAssignmentRule Tag
Wednesday
Work Rule
Name of the work rule that applies to this shift. Type: String Optional Introduced in v5.1
1195
Chapter 2
Syntax
Request <Request Action = Actions 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
1196
Kronos Incorporated
WSAAutoBreakPlacement Tag
Retrieve Returns the specified automated break placement. Return Value Type: WSAAutoBreakPlacement tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
Property Descriptions
MaxStartTimeForBreak
1197
Chapter 2
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
1198
Kronos Incorporated
WSAAvailabilityPatternDAP Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAAvailabilityPatternDAP [Description = String] [AllowAll = Boolean] Name = String > [<ProfileItems> <WSAAvailabilityPatternProfileItem>* </ProfileItems>] </WSAAvailabilityPatternDAP>
Action Descriptions
1199
Chapter 2
RetrieveAllForUpdate Returns all availability pattern data access profiles for update. Return Value Type: Zero or more WSAAvailabilityPatternDAP tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of all availability pattern data access profiles. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified availability pattern data access profile for update. Return Value Type: WSAAvailabilityPatternDAP tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified availability pattern data access profile. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
AllowAll
1200
Kronos Incorporated
WSAAvailabilityPatternDAP Tag
Description
Description of the availability pattern data access profile. Type: String Optional Introduced in v5.1 Name
1201
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveForUpdate" Parameters None Properties <WSAAvailabilityPatternProfileItem Name = String > </WSAAvailabilityPatternProfileItem>
Action Descriptions
RetrieveAllForUpdate Returns all availability pattern profile items for update. Return Value Type: Zero or more WSAAvailabilityPatternProfileItem tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified availability pattern profile item for update.
1202
Kronos Incorporated
WSAAvailabilityPatternProfileItem Tag
Return Value Type: WSAAvailabilityPatternProfileItem tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
Property Descriptions
Name
1203
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSABonusDeductRule [Amount = String] [AtLeastSelected = Boolean] [BonusQualify = String] [BreakRule = String] [Friday = Boolean] [InWinEtime = Time] [InWinStime = Time] [IsCanceledInTimecard = Boolean] [IsShiftRestriction = Boolean] [Locator = TimeDuration] [LocatorAtOrAfter = Time] [LocatorBefore = Time]
1204
Kronos Incorporated
WSABonusDeductRule Tag
[ShfLenMax = TimeDuration] [ShfLenMin = TimeDuration] [Monday = Boolean] Name = String [PayCode = String] [PaycodeMax = TimeDuration] [PaycodeMin = TimeDuration] [QualifyPerShift = Boolean] [Saturday = Boolean] [ShiftReq = Integer] [Sunday = Boolean] [Thursday = Boolean] [TimeOfDay = Time] [TrigpaycodeName = String] [Tuesday = Boolean] [Type = String] [Wednesday = Boolean] [WeekStart = Integer] > </WSABonusDeductRule>
Action Descriptions
RetrieveAllForUpdate Returns all bonus and deduction rules for updating. Return Value Type: Zero or more WSABonusDeductRule tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all bonus and deduction rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified bonus or deduction rule for updating. Return Value Type: WSABonusDeductRule tag
1205
Chapter 2
Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified bonus or deduction rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
Amount
Amount
The amount of the bonus or deduction that will be deducted from or added to timecards. The Amount can be decimal or time. If you specify a pay code, the pay code type determines the amount type. A money pay code indicates a decimal amount. A time pay code indicates a time amount. The default is time in HH:mm format (00:00). Type: String Optional Introduced in v5.1 AtLeastSelected
At Least Selected
At Least Selected Type: Boolean Optional Introduced in v5.1
1206
Kronos Incorporated
WSABonusDeductRule Tag
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
1207
Chapter 2
If a shift restriction exists on the bonus or deduction, earliest time that a shift may end in order to qualify for the bonus or deduction. This value is expressed in HH:mm AM|PM format. Type: Time Optional Introduced in v5.1 InWinStime
Is Canceled In Timecard
Boolean value that, when True (the default), allows this deduction or bonus to be canceled when canceling all deductions in Timecard. Type: Boolean Optional Introduced in v5.1 IsShiftRestriction
Is Shift Restriction
Boolean value that, when True, enables shift restriction. When shift restriction is enabled, employees must start at or before InWinStime. Rounded out-punches are compared to the Must Work Until time. Employees must end work at or after InWinEtime. When 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.
1208
Kronos Incorporated
WSABonusDeductRule Tag
Locator
When the trigger is length of shift (Type property is D), time (specified in HH:mm format) at which the bonus or deduction occurs in the shift. If employees earn a daily shift differential, the automatic bonus or deduction could affect the time earned in that zone. When a locator is not specified, the bonus or deduction is taken at the beginning of the shift. For example, the locator is 4:00, the daily shift differential is 11:00 P.M. to 8:00 A.M., an employee punches in at 7:00 A.M. and punches out at 4:00 P.M. The shift length is 8 hours and the employee earns 1 hour of daily shift differential. The locator appears at 11:00 A.M. If the locator is 0:00, the shift length is still 8:00, but the employee does not earn any shift differential. The default locator is 4:00. Type: TimeDuration Optional Introduced in v5.1 LocatorAtOrAfter
Locator At Or After
When the trigger is length of shift (Type property is D), time at or after which the locator must occur for the shift to qualify for the bonus or deduction. The value is expressed in HH:mm AM|PM format. LocatorAtOrAfter is the beginning of the fixed range during which the locator must appear for the bonus or deduction to occur. Along with LocatorBefore, this property restricts when a bonus or deduction occurs; for example, just at lunch or dinner time. To determine the fixed range, add the locator to the rounded in-punch. If the resulting time occurs at or after the start of the range, and before the end of the range, the shift meets this requirement. The default is 12:00 AM. Type: Time Optional
1209
Chapter 2
Locator Before
When the trigger is length of shift (Type property is D), time before which the locator must occur for the shift to qualify for the bonus or deduction. This value is expressed in seconds, starting at midnight. The LocatorBefore property specifies the end of the fixed range during which the locator must appear for the bonus or deduction to occur. Along with the LocatorAtOrAfter property, it restricts when a bonus or deduction occurs; for example, just at lunch or dinner time. To determine the fixed range, add the locator to the rounded in-punch. If the resulting time occurs at or after the start of the range, and before the end of the range, the shift meets this requirement. Type: Time Optional Introduced in v5.1 Monday
Monday
Boolean value that, when True, indicates that the bonus or deduction rule applies to Monday. Type: Boolean Optional Introduced in v5.1 Name
Name
The bonus or deduction rule name. The name can be up to 32 characters long, is case insensitive, and must be unique. Type: String Optional Key Introduced in v5.1
1210
Kronos Incorporated
WSABonusDeductRule Tag
PayCode
Pay Code
Pay code for the bonus or deduction. Type: String Optional Introduced in v5.1 PaycodeMax
1211
Chapter 2
QualifyPerShift
Saturday
Boolean value that, when True, indicates that the bonus or deduction rule applies to Saturday. Type: Boolean Optional Introduced in v5.1 ShfLenMax
1212
Kronos Incorporated
WSABonusDeductRule Tag
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 Sunday
Sunday
Boolean value that, when True, indicates that the bonus or deduction rule applies to Sunday. Type: Boolean Optional Introduced in v5.1 Thursday
Thursday
Boolean value that, when True, indicates that the bonus or deduction rule applies to Thursday.
1213
Chapter 2
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
Tuesday
Boolean value that, when True, indicates that the bonus or deduction rule applies to Tuesday. Type: Boolean Optional Introduced in v5.1
1214
Kronos Incorporated
WSABonusDeductRule Tag
Type
Type
Deduct rule type that triggers the bonus or deduction. It can have one of the following values: B: After a specified amount of time has accumulated in a certain pay code D: After a specified shift length F: When an employee works at a specified time of day
Wednesday
Boolean value that, when True, indicates that the bonus or deduction rule applies to Wednesday. Type: Boolean Optional Introduced in v5.1 WeekStart
Week Start
When the trigger is pay code (Type property is B) and BonusQualify is week, number of the day of the week on which the timeframe accumulator resets. The default is 1 (Monday). Type: Integer Optional Introduced in v5.1
1215
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "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]
1216
Kronos Incorporated
WSABreakRule Tag
Action Descriptions
RetrieveAllForUpdate Returns all break rules for updating. Return Value Type: Zero or more WSABreakRule tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all break rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified break rule for updating. Return Value Type: WSABreakRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified break rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
1217
Chapter 2
Property Descriptions
EndTime
End Time
"Before" time in HH:mm format. This value, relative to the time in the RelativeTo property, defines the end of a range of time in which the break rule applies. The default is 0:00. Type: Time Optional Introduced in v5.1 LongChgPoint
Long 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
1218
Kronos Incorporated
WSABreakRule Tag
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.
1219
Chapter 2
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
1220
Kronos Incorporated
WSABreakRule Tag
Relative To
Value that determines how the values expressed in the StartTime and EndTime properties are used. Valid values of the RelativeTo property are: "midnight", "scheduledStart", and "actualStart". Relative to "midnight" sets the StartTime and EndTime properties as fixed points in time, whereas Relative to "scheduledStart" or "actualStart" makes them variable. "scheduledStart" depends on the employee linking to a schedule, whereas "actualStart" does not. The default is "midnight". Type: String Optional Introduced in v5.1 ShortChgPoint
Short 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.
1221
Chapter 2
Short Grace
Grace rule (in HH:mm format) that applies to the short break interval. The default is 0:00. Type: TimeDuration Optional Introduced in v5.1 ShortRound
Short Round
Round rule (in HH:mm format) that applies to the short break interval. The default is 0:01. Type: TimeDuration Optional Introduced in v5.1 StartTime
Start Time
"At or After" time in HH:mm format. This value, relative to the time in the RelativeTo property, defines the beginning of a range of time in which the break rule applies. The default is 0:00. Type: Time Optional Introduced in v5.1
1222
Kronos Incorporated
WSABreakTime Tag
Syntax
Request <Request Action = Actions 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 Required Properties: Name Access Control Point Name: View
1223
Chapter 2
Introduced in v5.1
Property Descriptions
BreakRuleName
Name
1224
Kronos Incorporated
WSABreakTime Tag
Name of the break schedule time. The name is case-insensitive and must be unique. Type: String Optional Key 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
1225
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" Parameters None Properties <WSACalendarProfile Name = String > </WSACalendarProfile>
Action Descriptions
RetrieveAllForUpdate Returns all calendar profiles for update. Return Value Type: Zero or more WSACalendarProfile tags Access Control Point Name: View
1226
Kronos Incorporated
WSACalendarProfile Tag
Introduced in v5.1 RetrieveAllNames Returns a list of the names of all calendar profiles. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified calendar profile for update. Return Value Type: WSACalendarProfile tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
Property Descriptions
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
1227
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "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]
1228
Kronos Incorporated
WSACallInRule Tag
Action Descriptions
RetrieveAllForUpdate Returns all call-in rules for updating. Return Value Type: Zero or more WSACallInRule tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all call-in rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified call-in rule for updating. Return Value Type: WSACallInRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified call-in rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
1229
Chapter 2
Property Descriptions
EarlyScheduleMargin
1230
Kronos Incorporated
WSACallInRule Tag
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.
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
1231
Chapter 2
from the total on-call hours is deducted. This option is available only if you selected Deduct call-back from On-Call. Type: Boolean Optional Introduced in v5.1 IsPaidBothRegularAndCallback
Is 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
1232
Kronos Incorporated
WSACallInRule Tag
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 callback hours. The default is 0:00. Type: TimeDuration Optional Introduced in v5.1 Name
Name
Name of the call-in rule. The name is case-insensitive and must be unique. Type: String Optional 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
1233
Chapter 2
Shift Guarantee
Name that identifies an existing shift guarantee to be assigned to this call-in rule. Type: String Optional Introduced in v5.1 UnscheduledShiftLength
1234
Kronos Incorporated
WSACfgAccrualCode Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSACfgAccrualCode [Abbreviation = String] [Display = Boolean] [HoursPerDay = TimeDuration] [ManualEdit = Boolean] Name = String [TrackingPeriodName = String] [Type = String] > </WSACfgAccrualCode>
Action Descriptions
1235
Chapter 2
RetrieveAllForUpdate This action retrieves all configuration accrual codes to be used for an update action. Return Value Type: Zero or more WSACfgAccrualCode tags Access Control Point Name: View Introduced in v5.2 RetrieveAllNames This action retrieves all configuration accrual code names. Return Value Type: Zero or more NameList tags Access Control Point Name: View 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 Required Properties: Name Access Control Point Name: View Introduced in v5.2 Update This action updates configuration accrual codes. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
Abbreviation
Abbreviation
1236
Kronos Incorporated
WSACfgAccrualCode Tag
Display?
The display switch. Type: Boolean Optional Introduced in v5.2 HoursPerDay
Manual edit?
The manual edit switch. Type: Boolean Optional Introduced in v5.2 Name
Name
The name of the accrual code.
1237
Chapter 2
Type
This is the type of the accrual code. Type: String Optional Introduced in v5.2
1238
Kronos Incorporated
WSACfgContactType Tag
Syntax
Properties <WSACfgContactType [EMailAdress = Integer] [PhoneNumber = Integer] [PostalAddress = Integer] [Deleted = Integer] [LongName = String] Name = String [LabelName = String] [LabelNumber = Integer] > </WSACfgContactType>
Property Descriptions
Deleted
1239
Chapter 2
EMailAdress
1240
Kronos Incorporated
WSACfgContactType Tag
Name
Name
Contact's name Type: String Optional Key Introduced in v5.2 PhoneNumber
1241
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSACfgContactTypeList Name = String > <WSAContactTypeList> <WSACfgContactType>* </WSAContactTypeList> </WSACfgContactTypeList>
Action Descriptions
1242
Kronos Incorporated
WSACfgContactTypeList Tag
RetrieveAllForUpdate This action returns the list which contains all WSACfgContactType objects for update. Return Value Type: Zero or more WSACfgContactTypeList tags Access Control Point Name: View Introduced in v5.2 RetrieveAllNames This action returns the name of the list of WSACfgContactType names. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.2 RetrieveForUpdate This action returns the WSACfgContactTypeList object to update. Return Value Type: Zero or more WSACfgContactTypeList tags Required Properties: Name Access Control Point Name: View Introduced in v5.2 Update This action updates the list of WSACfgContactType objects. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
Name
Name
The name of the list of WSACfgContactType objects to configure.
1243
Chapter 2
1244
Kronos Incorporated
WSACfgCustomData Tag
Syntax
Properties <WSACfgCustomData Deleted = Integer [Description = String] LabelName = String LabelNumber = Integer Name = String > </WSACfgCustomData>
Property Descriptions
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. Type: String
1245
Chapter 2
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
1246
Kronos Incorporated
WSACfgCustomDataList Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSACfgCustomDataList Name = String > <WSACustomDataList> <WSACfgCustomData>* </WSACustomDataList> </WSACfgCustomDataList>
Action Descriptions
1247
Chapter 2
RetrieveAllForUpdate This action retrieves all of the WSACfgCustomData objects in the system for update. Return Value Type: Zero or more WSACfgCustomDataList tags Access Control Point Name: View Introduced in v5.2 RetrieveAllNames This action retrieves the list of names (list of named lists) or the WSACfgCustomData objects in the system. Return Value Type: Zero or more NameList tags Access Control Point Name: View 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 Required Properties: Name Access Control Point Name: View Introduced in v5.2 Update This action updates all of the WSACfgCustomData objects in the system. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
Name
Name
1248
Kronos Incorporated
WSACfgCustomDataList Tag
This is the name of the list of WSACustomData objects. Type: String Required Introduced in v5.2 WSACustomDataList
1249
Chapter 2
Syntax
Request <Request Action = Actions 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>
1250
Kronos Incorporated
WSACFGDistributionAssignment Tag
Action Descriptions
Retrieve This is the action to retrieve a WSA Distribution Assignment for configuration. Return Value Type: WSACFGDistributionAssignment tag Access Control Point Name: Edit Introduced in v5.2 RetrieveForUpdate This is the action to retrieve a WSA Distribution Assignment for configuration. Return Value Type: WSACFGDistributionAssignment tag Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
ExtensionProcessorComponents
1251
Chapter 2
This is the list of pay code Assignments for configuration. Type: Zero or more WSACFGPaycodeAssignment tags Optional Introduced in v5.2 ScheduledDeviation
1252
Kronos Incorporated
WSACFGExtProcessorComponent Tag
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View Introduced in v5.2
1253
Chapter 2
RetrieveForUpdate This is the action to retrieve a Extension Processor for configuration. Return Value Type: WSACFGExtProcessorComponent tag Access Control Point Name: View Introduced in v5.2
Property Descriptions
ExtentionProcessorName
Name
This is the name of the Extension Processor for configuration. Type: String Required Introduced in v5.2
1254
Kronos Incorporated
WSACFGOvertimeComponent Tag
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View Introduced in v5.2
1255
Chapter 2
RetrieveForUpdate This is the action to retrieve a Overtime Component for configuration. Return Value Type: WSACFGOvertimeComponent tag Access Control Point Name: View Introduced in v5.2
Property Descriptions
OvertimeName
Name
This is the name for the Overtime Component for configuration. Type: String Required Introduced in v5.2
1256
Kronos Incorporated
WSACFGPaycodeAssignment Tag
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View Introduced in v5.2
1257
Chapter 2
RetrieveForUpdate This is the action to retrieve a Pay Code Assignment. Return Value Type: WSACFGPaycodeAssignment tag Access Control Point Name: View Introduced in v5.2
Property Descriptions
PaycodeAssignmentName
Name
This is the name of the pay code assignment. Type: String Required Introduced in v5.2
1258
Kronos Incorporated
WSACFGPaycodeDistribution Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Retrieve" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSACFGPaycodeDistribution [CombinationRule = String] Name = String > [<DistributionAssignments> <WSACFGDistributionAssignment>* </DistributionAssignments>] </WSACFGPaycodeDistribution>
Action Descriptions
1259
Chapter 2
Retrieve This is the action to retrieve a Paycode Distribution for configuration. Return Value Type: WSACFGPaycodeDistribution tag Required Properties: Name Access Control Point Name: View Introduced in v5.2 RetrieveAllForUpdate This is the action to retrieve all Paycode Distributions for configuration update. Return Value Type: Zero or more WSACFGPaycodeDistribution tags Access Control Point Name: Edit Introduced in v5.2 RetrieveAllNames This is the action to retrieve a list of all Paycode Distribution names for configuration. Return Value Type: String list Access Control Point Name: View Introduced in v5.2 RetrieveForUpdate This is the action to retrieve a Paycode Distribution for configuration. Return Value Type: WSACFGPaycodeDistribution tag Required Properties: Name Access Control Point Name: View Introduced in v5.2 Update This is the action to update a Paycode Distribution for configuration. Return Value Type: Zero or more WSACFGPaycodeDistribution tags Required Properties: Name Access Control Point Name: Edit
1260
Kronos Incorporated
WSACFGPaycodeDistribution Tag
Introduced in v5.2
Property Descriptions
CombinationRule
Combination rule
This is the Combination Rule name for configuration. Type: String Optional Introduced in v5.2 DistributionAssignments
Name
This is the name of the WSA Paycode Distribution for configuration. Type: String Required Introduced in v5.2
1261
Chapter 2
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View Introduced in v5.2; last changed in v5.2
1262
Kronos Incorporated
WSACFGZoneComponent Tag
RetrieveForUpdate This is the action to retrieve a Zone Component for configuration. Return Value Type: WSACFGZoneComponent tag Access Control Point Name: View Introduced in v5.2
Property Descriptions
ZoneName
Name
The name of the zone. Type: String Required Introduced in v5.2
1263
Chapter 2
Syntax
Properties <WSAColumnDefinition [ExteriorName = String] [ExteriorItemNumber = Integer] [JavaClass = String] Name = String [DisplayName = String] > [<ColumnDefinitionDataType> <WSAColumnDefinitionDataType> </ColumnDefinitionDataType>] </WSAColumnDefinition>
Property Descriptions
ColumnDefinitionDataType
1264
Kronos Incorporated
WSAColumnDefinition Tag
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.
1265
Chapter 2
1266
Kronos Incorporated
WSAColumnDefinitionDataType Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" Parameters None Properties <WSAColumnDefinitionDataType [ExteriorName = String] [ExteriorItemNumber = Integer] ColumnDefinitionDataTypeName = String > </WSAColumnDefinitionDataType>
Action Descriptions
RetrieveAllForUpdate Returns all column definition data types for update. Return Value Type: Zero or more WSAColumnDefinitionDataType tags Access Control Point Name: View
1267
Chapter 2
Introduced in v5.1; last changed in v5.2 RetrieveAllNames Returns a list of the names of all column definition data types. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified column definition data type for update. Return Value Type: WSAColumnDefinitionDataType tag Required Properties: ColumnDefinitionDataTypeName Access Control Point Name: View Introduced in v5.1
Property Descriptions
ColumnDefinitionDataTypeName
Item number
Unique number that identifies the ExteriorName. Type: Integer Optional Introduced in v5.1
1268
Kronos Incorporated
WSAColumnDefinitionDataType Tag
ExteriorName
Item name
Extension name. This is the name of the product. Type: String Optional Introduced in v5.1
1269
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveForUpdate" Parameters None Properties <WSAColumnDetail [AscendingSwitch = Integer] [ColumnWidth = Integer] [ContactType = String] [CustomData = String] [InPunchType = Integer] [DisplayName = String] OverrideDisplayName = String [SortOrderNumber = Integer] [VisualIndexNumber = Long] > [<AccrualCode> <WSAAccrualCode> </AccrualCode>] [<ColumnDefinition> <WSAColumnDefinition> </ColumnDefinition>] [<CustomDateType> <WSACustomDateType>
1270
Kronos Incorporated
WSAColumnDetail Tag
</CustomDateType>] [<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 Access Control Point Name: View Introduced in v5.1
Property Descriptions
AccrualCode
Accrual code
Accrual code assigned to this column detail. Type: WSAAccrualCode tag Optional Introduced in v5.1 AscendingSwitch
Ascending switch
1271
Chapter 2
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
1272
Kronos Incorporated
WSAColumnDetail Tag
Custom data definition name with which this column detail is associated. Type: String Optional Introduced in v5.1 CustomDateType
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.
1273
Chapter 2
Organization type
Identifier of the organization type with which this column detail is associated. Type: WSAOrganizationType tag Optional Introduced in v5.1 OverrideDisplayName
Pay code
Pay code associated with this column detail. Type: WSADPPayCode tag
1274
Kronos Incorporated
WSAColumnDetail Tag
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. Type: Integer Optional Introduced in v5.1 VisualIndexNumber
1275
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveForUpdate" Parameters None Properties <WSACombinationRule [<Item> <WSAOvertimeRule> </Item>] [<Key> <WSAOvertimeRule> </Key>] [<Value> <WSAOvertimeRule> </Value>] </WSACombinationRule>
Action Descriptions
1276
Kronos Incorporated
WSACombinationRule Tag
RetrieveForUpdate Returns the specified combination rule for update. Return Value Type: WSACombinationRule tag Access Control Point Name: View Introduced in v5.1
Property Descriptions
Item
1277
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSACombinedPayCodeRule [EffectiveDate = Date] [MoneyCategory = Boolean] Name = String [SelectedPayCodes = String list] [VisibleInReport = Boolean] [VisibleToUser = Boolean] > </WSACombinedPayCodeRule>
Action Descriptions
RetrieveAllForUpdate Returns all combined pay code rules for updating.
1278
Kronos Incorporated
WSACombinedPayCodeRule Tag
Return Value Type: Zero or more WSACombinedPayCodeRule tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all combined pay code rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified combined pay code rule for updating. Return Value Type: WSACombinedPayCodeRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified combined pay code rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
EffectiveDate
Effective Date
Effective date of the combined pay code, in MM/DD/YYYY format. Type: Date Optional
1279
Chapter 2
Money Category
Boolean value that, when True, indicates that the pay code displays as money in the Timecard totals. If a pay code type of time is specified, hours and total wages appear on reports. If a pay code type of money is specified, hour amounts from hour type of pay codes are converted to a monetary amount. The conversion calculates wage rates with hour amounts, and the result is a total monetary amount. Only monetary amounts appear on reports. Type: Boolean Optional Introduced in v5.1 Name
Name
Name of the combined pay code rule. The name can be up to 32 characters long, is case-insensitive and must be unique. Type: String Optional Key Introduced in v5.1 SelectedPayCodes
Visible In Report
1280
Kronos Incorporated
WSACombinedPayCodeRule Tag
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
1281
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAComment [CodeNumber = Integer] [Active = Boolean] Text = String > [<Types> <WSACommentType>* </Types>] </WSAComment>
Action Descriptions
1282
Kronos Incorporated
WSAComment Tag
RetrieveAllForUpdate Returns all comments for update. Return Value Type: Zero or more WSAComment tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all comments. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified comment for update. Return Value Type: WSAComment tag Required Properties: Text Access Control Point Name: View Introduced in v5.1 Update This method uses the supplied WSAComment Bean info to either update (if a comment with the supplied "Name" attribute exists in the DB already) or add (otherwise) a comment with the information provided in the input stream. Note that if you supply a value for the "Types" attribute, that value must be either one or more WSACommentType bean entries. If you supply this information, the new/ updated comment will be assigned only to the comment categories/types which you specify. 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. Return Value Type: None Required Properties: Text
1283
Chapter 2
Property Descriptions
Active
1284
Kronos Incorporated
WSAComment Tag
Types
1285
Chapter 2
Syntax
Request <Request Action = Actions 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 Required Properties: Name Access Control Point Name: View Introduced in v5.1
1286
Kronos Incorporated
WSACommentType Tag
Property Descriptions
Name
Comment name
Name of the comment type. Type: String Optional Key Introduced in v5.1
1287
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAContributingPayCodeRule Name = String > [<PayCodeNames> <SimpleValue>* </PayCodeNames>] </WSAContributingPayCodeRule>
Action Descriptions
RetrieveAllForUpdate Returns all contributing pay code rules for updating. Return Value Type: Zero or more WSAContributingPayCodeRule tags
1288
Kronos Incorporated
WSAContributingPayCodeRule Tag
Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all contributing pay code rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified contributing pay code rule for updating. Return Value Type: WSAContributingPayCodeRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified contributing pay code rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
Name
Name
Name of the contributing pay code rule. The name is case-insensitive and must be unique. Type: String Optional Key Introduced in v5.1
1289
Chapter 2
PayCodeNames
1290
Kronos Incorporated
WSAContributingShiftRule Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAContributingShiftRule [DaysOfWeekIncludeType = String] [LookBackTime = Integer] [LookBackUnit = String] [MinimumShiftLength = TimeDuration] Name = String [ContributingPayCodeRuleName = String] > [<Days> <SimpleValue>* </Days>] </WSAContributingShiftRule>
Action Descriptions
1291
Chapter 2
RetrieveAllForUpdate Returns all contributing shift rules for updating. Return Value Type: Zero or more WSAContributingShiftRule tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all contributing shift rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified contributing shift rule for updating. Return Value Type: WSAContributingShiftRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified contributing shift rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
ContributingPayCodeRuleName
1292
Kronos Incorporated
WSAContributingShiftRule Tag
Name of the contributing pay code rule for this contributing shift rule. This property is required when adding a new rule; it is optional when updating an existing rule. Type: String Optional Introduced in v5.1 Days
List of days
List of those days of the week (for example, Monday, Tuesday,Wednesday, Thursday, Friday) that count toward contributing shifts when the Specify option is selected in the Days of the Week Include Type property. Type: Zero or more SimpleValue tags Optional Introduced in v5.1 DaysOfWeekIncludeType
1293
Chapter 2
LookBackTime
Name
Name of the contributing shift rule. The name can be up to 32 characters long, is case-insensitive, and must be unique. Type: String
1294
Kronos Incorporated
WSAContributingShiftRule Tag
1295
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSACoreHoursRule [AtLeastSelected = Boolean] [BreaksViolate_SW = Boolean] [Description = String] [EndTime = Time] [Friday = Boolean] [Monday = Boolean] Name = String [Saturday = Boolean] [StartTime = Time] [Sunday = Boolean] [Thursday = Boolean] [Tuesday = Boolean] [Wednesday = Boolean] >
1296
Kronos Incorporated
WSACoreHoursRule Tag
</WSACoreHoursRule>
Action Descriptions
RetrieveAllForUpdate Returns all core hours rules for updating. Return Value Type: Zero or more WSACoreHoursRule tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all core hours rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified core hours rule for updating. Return Value Type: WSACoreHoursRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified core hours rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
1297
Chapter 2
AtLeastSelected
At Least Selected
At Least Selected Type: Boolean Optional Introduced in v5.1 BreaksViolate_SW
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
1298
Kronos Incorporated
WSACoreHoursRule Tag
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 caseinsensitive, and must be unique. Type: String Optional Key Introduced in v5.1 Saturday
Saturday
1299
Chapter 2
Boolean value that, when True, indicates that the core hours rule applies to Saturday. By default, this value is False. Type: Boolean Optional Introduced in v5.1 StartTime
Start Time
Starting time, in HH:mm AM|PM format, of a specific range of time during which employees are expected to work. The default is 12:00 AM. Type: Time Optional Introduced in v5.1 Sunday
Sunday
Boolean value that, when True, indicates that the core hours rule applies to Sunday. By default, this value is False. Type: Boolean Optional Introduced in v5.1 Thursday
Thursday
Boolean value that, when True, indicates that the core hours rule applies to Thursday. By default, this value is False. Type: Boolean Optional Introduced in v5.1
1300
Kronos Incorporated
WSACoreHoursRule Tag
Tuesday
Tuesday
Boolean value that, when True, indicates that the core hours rule applies to Tuesday. By default, this value is False. Type: Boolean Optional Introduced in v5.1 Wednesday
Wednesday
Boolean value that, when True, indicates that the core hours rule applies to Wednesday. By default, this value is False. Type: Boolean Optional Introduced in v5.1
1301
Chapter 2
Syntax
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] [WorkRuleName = String] > [<CreditPayCodeNames> <SimpleValue>* </CreditPayCodeNames>] </WSACreditCalculator>
Property Descriptions
1302
Kronos Incorporated
WSACreditCalculator Tag
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.
1303
Chapter 2
1304
Kronos Incorporated
WSACreditCalculator Tag
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
1305
Chapter 2
Credit Rules Hours Credits configuration determines the grace values for the rounding rule. Type: TimeDuration Optional Introduced in v5.1 HolidayDeduct
Holiday deduction
String value that indicates how to deduct the time from the holiday credit. This property can have the following values: A -- Worked time that satisfies any Holiday Zone rule for the given holiday has no effect on holiday credits. N -- Holiday credits are reduced by the amount of worked time that satisfies a Holiday Zone rule for the particular holiday. W -- All holiday credits are cancelled if any worked time satisfies a Holiday Zone rule on a particular holiday.
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
1306
Kronos Incorporated
WSACreditCalculator Tag
Value, expressed in HH:mm format, that is used when calculating an average shift length. The value is rounded to a multiple of a specific increment. The Holiday Credit Rules Hours Credits configuration determines the round values for the rounding rule. Type: TimeDuration Optional Introduced in v5.1 Type
Type
Method used to calculate the holiday credit. This property can have the following values: 0 -- Fixed hours or wages. A set number of hours or wages issued as holiday credit. This amount does not change from holiday to holiday. 1 -- Average actual wage. The actual wages for a specified period of time immediately preceding the holidays. 2 -- Hours from schedule. The number of holiday credits is based on what the employee would have scheduled for the day of the holiday. 3 -- Average shift length. An averaged value of the total wages paid for qualified shifts during a specified time period immediately preceding the holiday. 4 -- Percent of wages. A fixed percentage of the total wages paid for qualified shifts during a specified time period immediately preceding the holiday. 5 -- Average base wage. The base wage for a specified time period immediately preceding the holiday.
1307
Chapter 2
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.
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.
Wage percentage
Percentage of the total wages paid as a holiday credit. Type: String Optional Introduced in v5.1
1308
Kronos Incorporated
WSACreditCalculator Tag
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
1309
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" Parameters None Properties <WSACriteriaSet Name = String [Description = String] [EvaluationRuleTypeID = Long] > </WSACriteriaSet>
Action Descriptions
RetrieveAllForUpdate Returns all criteria sets for update. Return Value Type: Zero or more WSACriteriaSet tags Access Control Point Name: View Introduced in v5.1
1310
Kronos Incorporated
WSACriteriaSet Tag
RetrieveAllNames Returns a list of the names of all criteria sets. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified criteria set for update. Return Value Type: WSACriteriaSet tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
Property Descriptions
Description
Description
Description of the criteria set. Type: String Optional Introduced in v5.1 EvaluationRuleTypeID
1311
Chapter 2
Name of the criteria set. Type: String Optional Key Introduced in v5.1
1312
Kronos Incorporated
WSACustomDate Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters Update [NewName = String] Properties <WSACustomDate Date = Date [SiteWide = Boolean] Name = String ReferenceCustomDate = String > </WSACustomDate>
Action Descriptions
RetrieveAllForUpdate Retrieves all custom dates.
1313
Chapter 2
Return Value Type: Zero or more CustomDate tags Access Control Point Name: View Introduced in v5.2 RetrieveAllNames Retrieves the names of all the custom dates. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.2 RetrieveForUpdate Retrieves the named custom date. Used by Setup Data Manager. Return Value Type: Zero or more CustomDate tags Required Properties: Name Access Control Point Name: View Introduced in v5.2 Update Updates the specified custom date if it exists; otherwise the custom date is added. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2
Action Parameters Parameter Name NewName Description New name for the custom date. Optional Additional information Introduced in v5.2
Property Descriptions
1314
Kronos Incorporated
WSACustomDate Tag
Date
Date
The calendar date for a site wide date. 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
1315
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" Parameters None Properties <WSACustomDateType ShortName = String > </WSACustomDateType>
Action Descriptions
RetrieveAllForUpdate Returns all custom date types for update. Return Value Type: Zero or more WSACustomDateType tags Access Control Point Name: View Introduced in v5.1
1316
Kronos Incorporated
WSACustomDateType Tag
RetrieveAllNames Returns a list of the names of all custom date types. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Updates the specified custom date type. Return Value Type: WSACustomDateType tag Required Properties: ShortName Access Control Point Name: View Introduced in v5.1
Property Descriptions
ShortName
1317
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSACustomUrl [Popup = Boolean] DisplayName = String [NavBar = Boolean] [OrderNum = Integer] [UrlText = String] > </WSACustomUrl>
Action Descriptions
RetrieveAllForUpdate Returns all custom URLs for update. Return Value Type: Zero or more WSACustomUrl tags
1318
Kronos Incorporated
WSACustomUrl Tag
Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all custom URLs. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified URL for update. Return Value Type: WSACustomUrl tag Required Properties: DisplayName Access Control Point Name: View Introduced in v5.1 Update Updates the specified URL. Return Value Type: None Required Properties: DisplayName Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
DisplayName
1319
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
1320
Kronos Incorporated
WSACustomUrlProfile Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSACustomUrlProfile [Description = String] [DisplayDescription = String] Name = String [DisplayName = String] > [<Urls> <WSACustomUrl>* </Urls>] [<GeniesUrls> <WSACustomUrl>* </GeniesUrls>] </WSACustomUrlProfile>
1321
Chapter 2
Action Descriptions
RetrieveAllForUpdate Returns all custom URL profiles for update. Return Value Type: Zero or more WSACustomUrlProfile tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all custom URL profiles. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1; last changed in v5.2 RetrieveForUpdate Returns the specified URL profile for update. Return Value Type: WSACustomUrlProfile tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified URL profile. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
Description
Description
1322
Kronos Incorporated
WSACustomUrlProfile Tag
Description of this URL profile. Type: String Optional Introduced in v5.1 DisplayDescription
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.
1323
Chapter 2
Available URLs
List of one or more URLs associated with this profile. Type: Zero or more WSACustomUrl tags Optional Introduced in v5.1
1324
Kronos Incorporated
WSADateFinder Tag
Syntax
Request <Request Action = Actions 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
1325
Chapter 2
Access Control Point Name: View Introduced in v5.2; last changed in v5.2 RetrieveForUpdate Returns a WSADateFinder bean Return Value Type: WSADateFinder tag Access Control Point Name: View Introduced in v5.2
Property Descriptions
CustomDateType
Type
The Date Finder Type Type: String Required Introduced in v5.2; last changed in v5.2 DayOfInterval
Day of interval
The Day of interval Type: Integer Required
1326
Kronos Incorporated
WSADateFinder Tag
Month of interval
The Month of Interval Type: Integer Required Introduced in v5.2; last changed in v5.2 StartStrategyType
1327
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Delete" | "Retrieve" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSADatePattern ExpectedHours = TimeDuration [Name = String] OffsetAmount = Integer [OffsetDateName = String] > [<DateFinder> <WSADateFinder> </DateFinder>] <Interval> <WSAInterval> </Interval> </WSADatePattern>
1328
Kronos Incorporated
WSADatePattern Tag
Action Descriptions
Delete Deletes a Date Pattern Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2 Retrieve Retrieves a DatePattern bean Return Value Type: WSADatePattern tag Required Properties: Name Access Control Point Name: View Introduced in v5.2 RetrieveAllForUpdate Retrieve a list of Date Pattern Beans Return Value Type: Zero or more WSADatePattern tags Access Control Point Name: View Introduced in v5.2 RetrieveAllNames Retrieves all DatePattern Names. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.2 RetrieveForUpdate Retrieves a Date Pattern bean. Return Value Type: WSADatePattern tag
1329
Chapter 2
Required Properties: Name Access Control Point Name: View Introduced in v5.2; last changed in v5.2 Update Updates a Date Pattern Bean Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
DateFinder
Date finder
A DateFinder object. Type: WSADateFinder tag Optional Introduced in v5.2; last changed in v6.0 ExpectedHours
Expected hours
The expected hours attribute. Type: TimeDuration Required Introduced in v5.2 Interval
Interval
A WSAInterval bean
1330
Kronos Incorporated
WSADatePattern Tag
Name
The name of the Date Pattern. Type: String Optional Introduced in v5.2; last changed in v5.2 OffsetAmount
Offset amount
The offset amount attribute. Type: Integer Required Introduced in v5.2 OffsetDateName
1331
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Retrieve" | "RetrieveForUpdate" Parameters None Properties <WSADayMonthSpan [EndDay = Integer] [EndMonth = Integer] [StartDay = Integer] [StartMonth = Integer] > </WSADayMonthSpan>
Action Descriptions
1332
Kronos Incorporated
WSADayMonthSpan Tag
Retrieve Returns an instance of WSADayMonthSpan (uninitialized). Return Value Type: WSADayMonthSpan tag Access Control Point Name: View Introduced in v5.2 RetrieveForUpdate Returns an instance of WSADayMonthSpan (uninitialized). Return Value Type: WSADayMonthSpan tag Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
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
1333
Chapter 2
Start Day of the span. Type: Integer Optional 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
1334
Kronos Incorporated
WSADaysOfWeek Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveForUpdate" Parameters None Properties <WSADaysOfWeek [Friday = Boolean] [Monday = Boolean] [Saturday = Boolean] [Sunday = Boolean] [Thursday = Boolean] [Tuesday = Boolean] [Wednesday = Boolean] [AtLeastSelected = Boolean] > </WSADaysOfWeek>
Action Descriptions
RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSADaysOfWeek tag
1335
Chapter 2
Property Descriptions
AtLeastSelected
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
1336
Kronos Incorporated
WSADaysOfWeek Tag
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
1337
Chapter 2
Introduced in v5.1
1338
Kronos Incorporated
WSADetail Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSADetail [Description = String] [DisplayDescription = String] Name = String [DisplayName = String] > [<NavbarCategory> <WSANavbarCategory> </NavbarCategory>] [<ColumnSet> <WSAWfgColumnSet> </ColumnSet>] [<DefaultHyperfindQuery> <WSAHyperfindQuery> </DefaultHyperfindQuery>] [<DefaultTimePeriod>
1339
Chapter 2
Action Descriptions
RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSADetail tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1; last changed in v5.2 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSADetail tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Update the specified instance Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
1340
Kronos Incorporated
WSADetail Tag
Property Descriptions
ColumnSet
Description
The Description Type: String Optional Introduced in v5.1
1341
Chapter 2
DisplayDescription
Name
Name of the specified instance Type: String Optional Key Introduced in v5.1 NavbarCategory
1342
Kronos Incorporated
WSADetailColumnSet Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSADetailColumnSet [Description = String] [DisplayDescription = String] [ExteriorName = String] [ExteriorItemNumber = Long] Name = String [DisplayName = String] > [<ColumnDetail> <WSAColumnDetail>* </ColumnDetail>] </WSADetailColumnSet>
Action Descriptions
1343
Chapter 2
RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSADetailColumnSet tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Retrieve the names of all instances in the system Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1; last changed in v5.2 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSADetailColumnSet tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Update the specified instance Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
ColumnDetail
1344
Kronos Incorporated
WSADetailColumnSet Tag
Description
The Description Type: String Optional Introduced in v5.1 DisplayDescription
Item number
The Exterior Item Number Type: Long
1345
Chapter 2
Item name
The Exterior Name Type: String Optional Introduced in v5.1 Name
Name
The Name of the instance Type: String Optional Key Introduced in v5.1
1346
Kronos Incorporated
WSADisplayOrder Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSADisplayOrder Name = String > [<PaycodesList> <WSADispOrdOptionalRule>* </PaycodesList>] </WSADisplayOrder>
Action Descriptions
1347
Chapter 2
RetrieveAllForUpdate Returns all display orders for updating. Return Value Type: Zero or more WSADisplayOrder tags Access Control Point Name: View Introduced in v5.1; last changed in v5.1 RetrieveAllNames Returns a list of the names of all display orders. Return Value Type: Zero or more NameList tags Access Control Point Name: Edit Introduced in v5.1 RetrieveForUpdate Returns the specified display order for updating. Return Value Type: WSADisplayOrder tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified display order. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
Name
1348
Kronos Incorporated
WSADisplayOrder Tag
1349
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Delete" | "Retrieve" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSADisplayProfile (AccrualDetailGenieForTimeCardDisplayName = String) [AccrualDetailGenieForScheduleEditorName = String] [AccrualDetailGenieForTimeCardName = String] [AccrualTotalsAccrualBalanceOnSelectedDateLabelText = String] [AccrualTotalsAccrualCodeLabelText = String] [AccrualTotalsAccrualUnitsLabelText = String] [EditFutureTimecardsSwitch = Boolean] [UseShorthandLaborAccountNotationSwitch = Boolean] [DayDurationDisplaySwitch = Boolean] [Description = String] [DisplayDescription = String]
1350
Kronos Incorporated
WSADisplayProfile Tag
[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] [WorkloadPlannerProfileName = String] [DisplayName = 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
Delete This action delete display profile by name Return Value Type: None
1351
Chapter 2
Required Properties: Name Access Control Point Name: Edit Introduced in v6.0 Retrieve This action retrieves Display Profile by name Return Value Type: WSADisplayProfile tag Required Properties: Name Access Control Point Name: View Introduced in v6.0 RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSADisplayProfile tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSADisplayProfile tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Update the specified instance
1352
Kronos Incorporated
WSADisplayProfile Tag
On Create, "DisplayName" and "SchedulePeriodName" are required but "Name" is not. On an update, both "Name" and "DisplayName" are required. Return Value Type: None Required Properties: DisplayName, Name, SchedulePeriodName Access Control Point Name: Edit Introduced in v5.1; last changed in v6.0
Property Descriptions
AccrualDetailGenieForScheduleEditorName
1353
Chapter 2
1354
Kronos Incorporated
WSADisplayProfile Tag
Description
The Description
1355
Chapter 2
1356
Kronos Incorporated
WSADisplayProfile Tag
1357
Chapter 2
1358
Kronos Incorporated
WSADisplayProfile Tag
1359
Chapter 2
Name
The Name of the entity. Type: String Optional Key Introduced in v5.1 NavProfileName
1360
Kronos Incorporated
WSADisplayProfile Tag
1361
Chapter 2
Name of profile
The name of WorkforceGenieProfileName Type: String Optional Introduced in v5.1 WorkloadPlannerProfileName
1362
Kronos Incorporated
WSADisplayProfileWorkforceGenieProfile Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveForUpdate" Parameters None Properties <WSADisplayProfileWorkforceGenieProfile Name = String > </WSADisplayProfileWorkforceGenieProfile>
Action Descriptions
RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSADisplayProfileWorkforceGenieProfile tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
1363
Chapter 2
Property Descriptions
Name
1364
Kronos Incorporated
WSADispOrdOptionalRule Tag
Syntax
Request <Request Action = Actions 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 Required Properties: Name Access Control Point Name: View Introduced in v5.1
1365
Chapter 2
Property Descriptions
ListOrder
Name
The Name Type: String Optional Key Introduced in v5.1
1366
Kronos Incorporated
WSADPLaborLevelDefinition Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" Parameters None Properties <WSADPLaborLevelDefinition [CheckedOnRollup = Boolean] Name = String > </WSADPLaborLevelDefinition>
Action Descriptions
RetrieveAllForUpdate Retrieve All the instances defined in the DB Return Value Type: Zero or more WSADPLaborLevelDefinition tags Access Control Point Name: View Introduced in v5.1
1367
Chapter 2
RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSADPLaborLevelDefinition tag Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
CheckedOnRollup
Name
The Name of the instance Type: String Optional Key Introduced in v5.1
1368
Kronos Incorporated
WSADPPayCode Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" Parameters None Properties <WSADPPayCode Name = String > </WSADPPayCode>
Action Descriptions
RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSADPPayCode tags Access Control Point Name: View Introduced in v5.1
1369
Chapter 2
RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSADPPayCode tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
Property Descriptions
Name
Name
The Name of the instance Type: String Optional Key Introduced in v5.1
1370
Kronos Incorporated
WSADPTimePeriod Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" Parameters None Properties <WSADPTimePeriod Name = String > </WSADPTimePeriod>
Action Descriptions
RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSADPTimePeriod tags Access Control Point Name: View Introduced in v5.1
1371
Chapter 2
RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSADPTimePeriod tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
Property Descriptions
Name
Name
The Name of the instance Type: String Optional Key Introduced in v5.1
1372
Kronos Incorporated
WSAEffectivePayRule Tag
Syntax
Request <Request Action = Actions 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]
1373
Chapter 2
[TransferRegularHome = Boolean] [ExtensionProcessorNames = String list] 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 Access Control Point Name: View Introduced in v5.1
Property Descriptions
ApplyOnly
1374
Kronos Incorporated
WSAEffectivePayRule Tag
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
Effective date
Effective date span of this pay rule version. Type: Long Optional Key Introduced in v5.1
1375
Chapter 2
ExtensionProcessorNames
Holidays
List of holidays that give holiday credits to the employees who are assigned to this pay rule. Type: Zero or more WSAPayRuleHoliday tags
1376
Kronos Incorporated
WSAEffectivePayRule Tag
Name
Name of the pay rule. The name is case-insensitive and must be unique. Type: String Optional Key Introduced in v5.1 PayFromSchedule
1377
Chapter 2
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
1378
Kronos Incorporated
WSAEffectivePayRule Tag
1379
Chapter 2
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
1380
Kronos Incorporated
WSAEffectiveWorkRule Tag
Syntax
Request <Request Action = Actions 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>]
1381
Chapter 2
Action Descriptions
Retrieve Returns the effective work rule selected by name and effective date. Return Value Type: WSAEffectiveWorkRule tag Required Properties: Name, EffectiveDate Access Control Point Name: View Introduced in v5.1
Property Descriptions
AutoBreakPlacement
1382
Kronos Incorporated
WSAEffectiveWorkRule Tag
DayDivideOverride
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
1383
Chapter 2
Name
1384
Kronos Incorporated
WSAEffectiveWorkRule Tag
UnapprovedOvertimePayCodeName
1385
Chapter 2
Syntax
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>
Property Descriptions
AfterHolidaySwitch
1386
Kronos Incorporated
WSAEligibilityDeterminer Tag
1387
Chapter 2
One or more work history qualifiers that must be satisfied in order for an employee to receive this credit. Type: Zero or more SimpleValue tags Optional Introduced in v5.1 MinimumTimeActiveUnit
1388
Kronos Incorporated
WSAEligibilityDeterminer Tag
1389
Chapter 2
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
1390
Kronos Incorporated
WSAExceptionRule Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAExceptionRule [InEarly = TimeDuration] [InLate = TimeDuration] [InVeryEarly = TimeDuration] [LongInterval = TimeDuration] Name = String [OutEarly = TimeDuration] [OutLate = TimeDuration] [OutVeryLate = TimeDuration] [ShortShift = TimeDuration] [Unscheduled = Boolean] > </WSAExceptionRule>
1391
Chapter 2
Action Descriptions
RetrieveAllForUpdate Returns all exception rules for updating. Return Value Type: Zero or more WSAExceptionRule tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all exception rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified exception rule for updating. Return Value Type: WSAExceptionRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified exception rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
InEarly
In Early
1392
Kronos Incorporated
WSAExceptionRule Tag
Amount for early in-punches in HH:mm format. Exceptions occur when employees punch in before their scheduled start times and at or before the early in amount. The default is 24:00, which disables these exceptions. Type: TimeDuration Optional Introduced in v5.1 InLate
In Late
Amount for late in-punches in HH:mm format. Exceptions occur when employees punch in after their scheduled start times and at or after the late in amount. Type: TimeDuration Optional Introduced in v5.1 InVeryEarly
In Very Early
Amount for very early in-punches in HH:mm format. Exceptions appear when employees punch in before their scheduled start times and at or before the very early in amount. The default is 24:00, which disables these exceptions. Type: TimeDuration Optional Introduced in v5.1 LongInterval
Long Interval
Long interval in HH:mm format. This property defines an unusually long period of time between an in-punch and an out-punch. The rounded time between the punches is used to compute this exception. If it equals or is greater than the long interval, the long exception appears on the Timecard and on reports. By default, this value is 99:00.
1393
Chapter 2
Name
Name of exception rule. The name can be up to 32 characters long, is caseinsensitive, and must be unique. 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. 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
1394
Kronos Incorporated
WSAExceptionRule Tag
OutVeryLate
Short Shift
The duration of a short shift in HH:mm format. Exceptions appear when rounded shift lengths are less than or equal to the short shift setting. The default value is 0:00. Type: TimeDuration Optional Introduced in v5.1 Unscheduled
Unscheduled
Boolean value that, when True, indicates that an exception should occur when an unscheduled employee punches in. By default this value is False. Type: Boolean Optional Introduced in v5.1
1395
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" Parameters None Properties <WSAExceptionType ShortName = String > </WSAExceptionType>
Action Descriptions
RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSAExceptionType tags Access Control Point Name: View Introduced in v5.1
1396
Kronos Incorporated
WSAExceptionType Tag
RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSAExceptionType tag Required Properties: ShortName Access Control Point Name: View Introduced in v5.1
Property Descriptions
ShortName
Name
The name of the entity (ShortName) Type: String Optional Key Introduced in v5.1
1397
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAFixedRule [ApplyToDate = String] Name = String > [<PayPeriodType> <WSAPayPeriod> </PayPeriodType>] </WSAFixedRule>
Action Descriptions
RetrieveAllForUpdate Returns all fixed rules for updating.
1398
Kronos Incorporated
WSAFixedRule Tag
Return Value Type: Zero or more WSAFixedRule tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all fixed rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified fixed rule for updating. Return Value Type: WSAFixedRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified fixed rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
ApplyToDate
1399
Chapter 2
1400
Kronos Incorporated
WSAFunctionAccessProfile Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAFunctionAccessProfile [Description = String] [AllowsAll = Boolean] Name = String [IsDefault = Boolean] > [<Permissions> <WSAPermission>* </Permissions>] </WSAFunctionAccessProfile>
1401
Chapter 2
Action Descriptions
RetrieveAllForUpdate Returns all function access profiles for updating. Return Value Type: Zero or more WSAFunctionAccessProfile tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all function access profiles. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified function access profile for updating. Return Value Type: WSAFunctionAccessProfile tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified function access profile. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
AllowsAll
1402
Kronos Incorporated
WSAFunctionAccessProfile Tag
Boolean value that, when True, indicates that the function access profile includes all functions in the system. Type: Boolean Optional Introduced in v5.1 Description
Description
Description of the function access profile. Type: String Optional Introduced in v5.1 IsDefault
1403
Chapter 2
Permissions
1404
Kronos Incorporated
WSAGenie Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" Parameters None Properties <WSAGenie [Description = String] [DisplayDescription = String] Name = String [DisplayName = String] [OrderNum = Integer] > [<NavbarCategory> <WSANavbarCategory> </NavbarCategory>] </WSAGenie>
Action Descriptions
RetrieveAllForUpdate Retrieve all instances from the DB
1405
Chapter 2
Return Value Type: Zero or more WSAGenie tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1; last changed in v5.2 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSAGenie tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
Property Descriptions
Description
1406
Kronos Incorporated
WSAGenie Tag
1407
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Delete" | "Retrieve" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAGrant GrantType = String [ExtraHours = Boolean] [DatePattern = String] [CoreSetDate = String] [GrantOnce = Boolean] [IncrementAmount = String] [Increment = Boolean] [Carryover = Boolean] [Name = String] [PayCode = String] [Prorate = Boolean] >
1408
Kronos Incorporated
WSAGrant Tag
Action Descriptions
Delete This is the action which deletes an Accrual Grant object. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2 Retrieve This is the action which returns a Grant object for an Accrual. Return Value Type: WSAGrant tag Required Properties: Name Access Control Point Name: View Introduced in v5.2 RetrieveAllForUpdate 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 Access Control Point Name: View Introduced in v5.2 RetrieveAllNames This is the action which returns all the names of the Accrual Grant objects. Return Value Type: String list
1409
Chapter 2
Access Control Point Name: View 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 Required Properties: Name Access Control Point Name: View 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. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
AccrualQualifiers
1410
Kronos Incorporated
WSAGrant Tag
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
1411
Chapter 2
GrantOnce
Grant once?
This is the property which holds the grantOnce flag for this Grant. Type: Boolean Optional Introduced in v5.2 GrantType
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
1412
Kronos Incorporated
WSAGrant Tag
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 Interval
Interval
This is the property which hold the Grant Interval. Type: WSAInterval tag Required Introduced in v5.2 Name
Name
This is the name of the grant. Type: String Optional Introduced in v5.2 PayCode
1413
Chapter 2
Prorate?
This is the property which holds the prorate flag for this Grant. Type: Boolean Optional Introduced in v5.2
1414
Kronos Incorporated
WSAHoliday Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Delete" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAHoliday [DisplayName = String] [EndDate = Date] [EndTime = Time] [StartDate = Date] [StartTime = Time] Name = String [Code = String] > [<WSAHolidayDates> <WSAHolidayDate>* </WSAHolidayDates>] </WSAHoliday>
1415
Chapter 2
Action Descriptions
Delete Delete Holiday and Holiday Dates. Return Value Type: None Required Properties: Name, WSAHolidayDates Access Control Point Name: Edit Introduced in v6.0 RetrieveAllForUpdate Returns all holidays for updating. Return Value Type: Zero or more WSAHoliday tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all holidays. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified holiday for updating. Return Value Type: WSAHoliday tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified holiday. Return Value Type: None Required Properties: Name Access Control Point Name: Edit
1416
Kronos Incorporated
WSAHoliday Tag
Introduced in v5.1
Property Descriptions
Code
1417
Chapter 2
Time when holiday ends, in HH:mm format. Type: Time 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. Name
1418
Kronos Incorporated
WSAHoliday Tag
WSAHolidayDates
Holiday Dates
List of holiday dates. Type: Zero or more WSAHolidayDate tags Optional Introduced in v6.0
1419
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAHolidayCreditRule [DayOvertimeLimitType = Integer] Name = String [OvertimeLimitType = Integer] [DayOvertimeLimitPayCodeName = String] [OvertimeLimitPayCodeName = String] > [<WSACreditCalculator> <WSACreditCalculator> </WSACreditCalculator>] [<WSAEligibilityDeterminer> <WSAEligibilityDeterminer> </WSAEligibilityDeterminer>] </WSAHolidayCreditRule>
1420
Kronos Incorporated
WSAHolidayCreditRule Tag
Action Descriptions
RetrieveAllForUpdate Returns all holiday credit rules for updating. Return Value Type: Zero or more WSAHolidayCreditRule tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all holiday credit rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified holiday credit rule for updating. Return Value Type: WSAHolidayCreditRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified holiday credit rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
1421
Chapter 2
DayOvertimeLimitPayCodeName
1422
Kronos Incorporated
WSAHolidayCreditRule Tag
The name must be unique. Maximum length: 50 characters Introduced in v5.1 OvertimeLimitPayCodeName
Credit calculator
Name of credit calculator associated with this holiday credit rule. Type: WSACreditCalculator tag Optional
1423
Chapter 2
Eligibility determiners
List of one or more eligibility determiners associated with this holiday credit rule. Type: WSAEligibilityDeterminer tag Optional Introduced in v5.1
1424
Kronos Incorporated
WSAHolidayDate Tag
Syntax
Properties <WSAHolidayDate [EndDate = Date] [EndTime = Time] StartDate = Date [StartTime = Time] > </WSAHolidayDate>
Property Descriptions
EndDate
1425
Chapter 2
1426
Kronos Incorporated
WSAHyperfindQuery Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" Parameters None Properties <WSAHyperfindQuery [LongDescription = String] [HyperfindQueryTypeID = Long] Name = String [QueryVisibleType = Long] > </WSAHyperfindQuery>
Action Descriptions
RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSAHyperfindQuery tags Access Control Point Name: View
1427
Chapter 2
Introduced in v5.1 RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSAHyperfindQuery tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
Property Descriptions
HyperfindQueryTypeID
Description
The Long Description Type: String Optional Introduced in v5.1
1428
Kronos Incorporated
WSAHyperfindQuery Tag
Name
Name
The Name of the instance Type: String Optional Key Introduced in v5.1 QueryVisibleType
1429
Chapter 2
Syntax
Properties <WSAInitialGrant [ExpireToAccrual = String] AccrualRule = String GranRule = String InitialValue = String > [<SubsequentGrants> <WSASubsequentGrant>* </SubsequentGrants>] </WSAInitialGrant>
Property Descriptions
AccrualRule
Accrual rule
The Accrual Policy Rule associated with this initial grant. Type: String Required Introduced in v5.2 ExpireToAccrual
1430
Kronos Incorporated
WSAInitialGrant Tag
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. 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
1431
Chapter 2
Syntax
Request <Request Action = Actions 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
1432
Kronos Incorporated
WSAInterval Tag
Access Control Point Name: View Introduced in v5.2 RetrieveForUpdate Returns an instance of WSAInterval (uninitialized). Return Value Type: WSAInterval tag Access Control Point Name: Edit Introduced in v5.2; last changed in v5.2
Property Descriptions
numIntervals
Number of intervals
an Integer representative of the number of time unit types Type: Integer Required Introduced in v5.2 timeUnitType
1433
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAIntervalRoundRule [Grace = TimeDuration] [IsMissedOutException = Boolean] Name = String [Round = TimeDuration] [UseScheduledOut = Boolean] > </WSAIntervalRoundRule>
Action Descriptions
1434
Kronos Incorporated
WSAIntervalRoundRule Tag
RetrieveAllForUpdate Returns all interval round rules for updating. Return Value Type: Zero or more WSAIntervalRoundRule tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all interval round rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified interval round rule for updating. Return Value Type: WSAIntervalRoundRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified interval round rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
Grace
Grace period
Grace period, in HH:mm format.
1435
Chapter 2
1436
Kronos Incorporated
WSAIntervalRoundRule Tag
UseScheduledOut
1437
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSALaborLevel [CanOverrideMinMaxSwitch = Boolean] EncodedName = String [MaxNameLength = Integer] [MinNameLength = Integer] [Abbreviation = String] [ValidateAllNewEntriesSwitch = Boolean] > </WSALaborLevel>
Action Descriptions
1438
Kronos Incorporated
WSALaborLevel Tag
RetrieveAllForUpdate Returns all labor levels for updating. Return Value Type: Zero or more WSALaborLevel tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all labor levels. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified labor level for updating. Return Value Type: WSALaborLevel tag Required Properties: EncodedName Access Control Point Name: View Introduced in v5.1 Update Updates the specified labor level. Return Value Type: None Required Properties: EncodedName Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
Abbreviation
1439
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
1440
Kronos Incorporated
WSALaborLevel Tag
1441
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSALaborLevelEntry [ReadOnly = Boolean] [Description = String] [Inactive = Boolean] EncodedName = String > </WSALaborLevelEntry>
Action Descriptions
RetrieveAllForUpdate Returns all labor level entries for updating.
1442
Kronos Incorporated
WSALaborLevelEntry Tag
Return Value Type: Zero or more WSALaborLevelEntry tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all labor level entries. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified labor level entry for updating. Return Value Type: WSALaborLevelEntry tag Required Properties: EncodedName Access Control Point Name: View Introduced in v5.1 Update Updates the specified labor level entry. Return Value Type: None Required Properties: EncodedName Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
Description
1443
Chapter 2
1444
Kronos Incorporated
WSALaborLevelEntry Tag
1445
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSALeaveCaseDetail [Description = String] [DisplayDescription = String] [Name = String] [DisplayName = String] > [<ColumnSet> <WSAWfgColumnSet> </ColumnSet>] [<DefaultHyperfindQuery> <WSAHyperfindQuery> </DefaultHyperfindQuery>] [<DefaultTimePeriod> <WSADPTimePeriod> </DefaultTimePeriod>] [<NavbarCategory>
1446
Kronos Incorporated
WSALeaveCaseDetail Tag
Action Descriptions
RetrieveAllForUpdate Retrieve all instances for update Return Value Type: Zero or more WSALeaveCaseDetail tags Access Control Point Name: View Introduced in v5.2 RetrieveAllNames Return all Leave Case Detail instance names Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.2; last changed in v5.2 RetrieveForUpdate Retrieve instance for update Return Value Type: WSALeaveCaseDetail tag Required Properties: Name Access Control Point Name: View Introduced in v5.2 Update Update the instance. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2
1447
Chapter 2
Property Descriptions
ColumnSet
Column set
Column set that is assigned. Type: WSAWfgColumnSet tag Optional Introduced in v5.2 DefaultHyperfindQuery
Description
Description Type: String Optional Introduced in v5.2
1448
Kronos Incorporated
WSALeaveCaseDetail Tag
DisplayDescription
Name
Name Type: String Optional Introduced in v5.2 NavbarCategory
1449
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSALeaveCaseDetailColumnSet [Description = String] [DisplayDescription = String] [ExteriorName = String] [ExteriorItemNumber = Long] [Name = String] [DisplayName = String] > [<ColumnDetail> <WSAColumnDetail>* </ColumnDetail>] </WSALeaveCaseDetailColumnSet>
Action Descriptions
1450
Kronos Incorporated
WSALeaveCaseDetailColumnSet Tag
RetrieveAllForUpdate Retrieve all for Update Return Value Type: Zero or more WSALeaveCaseDetailColumnSet tags Access Control Point Name: View Introduced in v5.2 RetrieveAllNames Returns all names Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.2 RetrieveForUpdate Retrieve for Update Return Value Type: WSALeaveCaseDetailColumnSet tag Required Properties: Name Access Control Point Name: View Introduced in v5.2 Update Updates the entity Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
ColumnDetail
Column detail
Column Details that are assigned
1451
Chapter 2
Description
Description Type: String Optional Introduced in v5.2 DisplayDescription
1452
Kronos Incorporated
WSALeaveCaseDetailColumnSet Tag
Name
Name Type: String Optional Introduced in v5.2
1453
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Delete" | "Retrieve" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters Update [NewName = String] Properties <WSALimit [DatePattern = String] [ForgivenBalance = Boolean] [LimitType = String] [MaxLimit = Boolean] Name = String > [<DayMonthSpan> <WSADayMonthSpan> </DayMonthSpan>] [<Interval>
1454
Kronos Incorporated
WSALimit Tag
Action Descriptions
Delete Delete the specified instance Return Value Type: None Required Properties: Name, LimitType Access Control Point Name: Edit Introduced in v5.2; last changed in v5.2 Retrieve Retrieve the specified instance from the DB Return Value Type: WSALimit tag Required Properties: Name, LimitType Access Control Point Name: View Introduced in v5.2 RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSALimit tags Access Control Point Name: View Introduced in v5.2 RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.2; last changed in v5.2
1455
Chapter 2
RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSALimit tag Required Properties: Name Access Control Point Name: View Introduced in v5.2 Update Update the specified instance Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2
Action Parameters Parameter Name NewName Description This parameter is used to five a new name to the WSALimit object Optional Additional information Introduced in v5.2
Property Descriptions
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
1456
Kronos Incorporated
WSALimit Tag
DayMonthSpan
Day-month span
The Day-month span property is selectable for the Earning Amount Limit limit type. Type: WSADayMonthSpan tag 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. Type: WSAInterval tag 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
1457
Chapter 2
Maximum limit
The Maximum limit property is required for the Carryover Limit limit type. Type: Boolean Optional 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
1458
Kronos Incorporated
WSALogonProfile Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSALogonProfile [Description = String] [AccLockoutDuration = Long] [IsDefault = Boolean] [InactivityTimeOut = Long] Name = String [PwdMinLength = Integer] [AccLockoutAfter = Integer] [PwdExpiredDays = Integer] [PwdMaxHistory = Integer] [AccLockoutSwitch = Boolean] [InactivityTimeOutSwitch = Boolean] [PwdMinLengthSwitch = Boolean]
1459
Chapter 2
Action Descriptions
RetrieveAllForUpdate Returns all logon profiles for updating. Return Value Type: Zero or more WSALogonProfile tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all login profiles. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified login profile for updating. Return Value Type: WSALogonProfile tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified logon profile. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
1460
Kronos Incorporated
WSALogonProfile Tag
Property Descriptions
AccLockoutAfter
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 AccLockoutSwitch
1461
Chapter 2
Description
Description
Description of the logon profile. Type: String Optional Introduced in v5.1 InactivityTimeOut
1462
Kronos Incorporated
WSALogonProfile Tag
IsDefault
1463
Chapter 2
1464
Kronos Incorporated
WSALogonProfile Tag
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
1465
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" Parameters None Properties <WSAMainTab Name = String [ComponentName = String] > </WSAMainTab>
Action Descriptions
RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSAMainTab tags Access Control Point Name: View Introduced in v5.1
1466
Kronos Incorporated
WSAMainTab Tag
RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSAMainTab tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
Property Descriptions
ComponentName
Name
The Name of the instance Type: String Optional Key Introduced in v5.1
1467
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAMajorityRule [IncludeDeducts = Boolean] [IncludePunchedBreaks = Boolean] [IncludeRegular = Boolean] Name = String [EqualIntervalUse = String] > [<SelectedZones> <WSAOptionalRule>* </SelectedZones>] </WSAMajorityRule>
1468
Kronos Incorporated
WSAMajorityRule Tag
Action Descriptions
RetrieveAllForUpdate Returns all majority rules for updating. Return Value Type: Zero or more WSAMajorityRule tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all majority rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified majority rule for updating. Return Value Type: WSAMajorityRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified majority rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1
Property Descriptions
EqualIntervalUse
1469
Chapter 2
Character string that specifies which rule takes precedence in the event that employees work equal amounts of time in more than one zone, or they work equal amounts of time in a zone and in a regular (non-zone) shift. The rules include: "Highest" -- The rule at the bottom of the Selected Zones list applies to the entire shift. "Lowest" -- The rule at the top of the Selected Zones applies to the entire shift. "First" -- The first zone worked applies to the entire shift. "Last" -- The last zone worked applies to the entire shift. "Ignore" -- No rule takes precedence. Each interval is paid according to the rule associated with it.
1470
Kronos Incorporated
WSAMajorityRule Tag
1471
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" Parameters None Properties <WSANavbarCategory [GenieItemIndicator = Integer] Name = String > </WSANavbarCategory>
Action Descriptions
RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSANavbarCategory tags Access Control Point Name: View Introduced in v5.1
1472
Kronos Incorporated
WSANavbarCategory Tag
RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSANavbarCategory tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
Property Descriptions
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
1473
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveForUpdate" Parameters None Properties <WSAOptionalRule [ListOrder = Integer] Name = String MajorityRuleName = String > </WSAOptionalRule>
Action Descriptions
RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSAOptionalRule tag Required Properties: Name, MajorityRuleName Access Control Point Name: View
1474
Kronos Incorporated
WSAOptionalRule Tag
Introduced in v5.1
Property Descriptions
ListOrder
List order
The assigned List Order Type: Integer Optional Introduced in v5.1 MajorityRuleName
Name
Name of the optional rule Type: String Optional Key Introduced in v5.1
1475
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" Parameters None Properties <WSAOrganizationType [Description = String] [IsDefaultSwitch = Integer] [LanguageCD = String] [LeafNodeSwitch = Integer] Name = String [DisplayName = String] [DisplayOrderNumber = Integer] > [<TreeType> <WSATreeType> </TreeType>] </WSAOrganizationType>
Action Descriptions
1476
Kronos Incorporated
WSAOrganizationType Tag
RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSAOrganizationType tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSAOrganizationType tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
Property Descriptions
Description
Description
The Description Type: String Optional Introduced in v5.1 DisplayName
1477
Chapter 2
Language CD
The Language CD Type: String Optional Introduced in v5.1 LeafNodeSwitch
1478
Kronos Incorporated
WSAOrganizationType Tag
Name
The Name of the instance Type: String Optional Key Introduced in v5.1 TreeType
Tree Type
The Tree Type Type: WSATreeType tag Optional Introduced in v5.1
1479
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Retrieve" | "RetrieveForUpdate" Parameters None
Action Descriptions
Retrieve Retrieve Return Value Type: WSAOverridePayCode tag Required Properties: Name Access Control Point Name: View Introduced in v6.0 RetrieveForUpdate Retrieve for update Return Value Type: WSAOverridePayCode tag Required Properties: Name
1480
Kronos Incorporated
WSAOverridePayCode Tag
1481
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAOvertimeCombination Name = String > [<CombinationRules> <WSACombinationRule>* </CombinationRules>] [<SelectedOvertimeRules> <WSAOvertimeRule>* </SelectedOvertimeRules>] </WSAOvertimeCombination>
Action Descriptions
1482
Kronos Incorporated
WSAOvertimeCombination Tag
RetrieveAllForUpdate Returns all overtime combination rules for updating. Return Value Type: Zero or more WSAOvertimeCombination tags Access Control Point Name: View Introduced in v5.1; last changed in v5.1 RetrieveAllNames Returns a list of the names of all overtime combination rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified overtime combination rule for updating. Return Value Type: WSAOvertimeCombination tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified overtime combination rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
CombinationRules
Combination rules
List of one or more combination rules to be applied to this overtime combination rule.
1483
Chapter 2
1484
Kronos Incorporated
WSAOvertimeRule Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAOvertimeRule [Amount = TimeDuration] [Minimum = TimeDuration] [ResetDate = Date] [ResetDay = Integer] [RequiresApproval = Boolean] [ConPreShifts = Boolean] [IsOverridePayCodes = Boolean] [TrackStart = String] Name = String [ResetAtTime = Time] [Type = String] [UseBreakVar = Boolean] [ResetAfter = Long] >
1485
Chapter 2
Action Descriptions
RetrieveAllForUpdate Returns all overtime rules for updating. Return Value Type: Zero or more WSAOvertimeRule tags Access Control Point Name: View Introduced in v5.1; last changed in v5.1 RetrieveAllNames Returns a list of the names of all overtime rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1; last changed in v5.1 RetrieveForUpdate Returns the specified overtime rule for updating. Return Value Type: WSAOvertimeRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified overtime rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
1486
Kronos Incorporated
WSAOvertimeRule Tag
Property Descriptions
Amount
Amount
Amount. Type: TimeDuration Optional Introduced in v5.1; last changed in v5.1 ConPreShifts
1487
Chapter 2
Name
1488
Kronos Incorporated
WSAOvertimeRule Tag
1489
Chapter 2
Method for tracking start time when the 24-hour rule is in effect. Valid values include: TrackingStartActual TrackingStartSchedule TrackingStartEarlier
1490
Kronos Incorporated
WSAOvertimeRule Tag
1491
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAPatternTemplateDAP [Description = String] [AllowAll = Boolean] Name = String > [<ProfileItems> <WSAPatternTemplateProfileItem>* </ProfileItems>] </WSAPatternTemplateDAP>
Action Descriptions
1492
Kronos Incorporated
WSAPatternTemplateDAP Tag
RetrieveAllForUpdate Returns all pattern template data access profiles for updating. Return Value Type: Zero or more WSAPatternTemplateDAP tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all pattern template data access profiles. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified pattern template data access profile for updating. Return Value Type: WSAPatternTemplateDAP tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified pattern template data access profile. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
AllowAll
1493
Chapter 2
Description
Description of the pattern template data access profile. Type: String Optional Introduced in v5.1 Name
1494
Kronos Incorporated
WSAPatternTemplateProfileItem Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveForUpdate" Parameters None Properties <WSAPatternTemplateProfileItem Name = String > </WSAPatternTemplateProfileItem>
Action Descriptions
RetrieveAllForUpdate Returns all pattern template data access profiles for updating. Return Value Type: Zero or more WSAPatternTemplateProfileItem tags Access Control Point Name: View
1495
Chapter 2
Introduced in v5.1 RetrieveForUpdate Returns the specified pattern template for updating. Return Value Type: WSAPatternTemplateProfileItem tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
Property Descriptions
Name
1496
Kronos Incorporated
WSAPayCode Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAPayCode [CheckAvlbltySw = Boolean] [TerminalCdNum = Integer] [IsMoneyCategory = Boolean] [EditAffShfTotal = Boolean] [EditCntToCdotSw = Boolean] [EditCntToOt = Boolean] [EditExcuseAbsn = Boolean] Name = String [PersistPceSw = Boolean] [ScheduleHoursType = String] [AbbreviationChar = String] [VisibleInMainArea = Boolean] [VisibleInReport = Boolean]
1497
Chapter 2
Action Descriptions
RetrieveAllForUpdate Returns all pay codes for updating. Return Value Type: Zero or more WSAPayCode tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all pay codes. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified pay code for updating. Return Value Type: WSAPayCode tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified pay code. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
1498
Kronos Incorporated
WSAPayCode Tag
Property Descriptions
AbbreviationChar
Short Name
Abbreviated name for the pay code. The short name is for device display purposes. Type: String Optional Introduced in v5.1 CheckAvlbltySw
1499
Chapter 2
1500
Kronos Incorporated
WSAPayCode Tag
Name of the pay code. The name can be up to 32 characters long, is caseinsensitive, and must be unique. Type: String Optional Key Introduced in v5.1 PersistPceSw
1501
Chapter 2
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. Type: Boolean Optional Introduced in v5.1 WageAddition
Wage Addition
1502
Kronos Incorporated
WSAPayCode Tag
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
1503
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAPayCodeDAP [Description = String] [AllowAll = Boolean] Name = String > [<ProfileItems> <WSAPayCodeProfileItem>* </ProfileItems>] </WSAPayCodeDAP>
Action Descriptions
1504
Kronos Incorporated
WSAPayCodeDAP Tag
RetrieveAllForUpdate Returns all pay code data access profiles for updating. Return Value Type: Zero or more WSAPayCodeDAP tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all pay code data access profiles. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified pay code data access profile for updating. Return Value Type: WSAPayCodeDAP tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified pay code data access profile. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
AllowAll
1505
Chapter 2
Description
Description of the pay code data access profile. Type: String Optional Introduced in v5.1 Name
1506
Kronos Incorporated
WSAPayCodeDistribution Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAPayCodeDistribution [Deviations = String list] Name = String [OvertimeCombination = String] [ZoneCombination = String] > [<Distribution> <WSAPayDistributionAssociation>* </Distribution>] </WSAPayCodeDistribution>
1507
Chapter 2
Action Descriptions
RetrieveAllForUpdate Returns all pay code distribution rules for updating. Return Value Type: Zero or more WSAPayCodeDistribution tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all pay code distribution rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified pay code distribution rule for updating. Return Value Type: WSAPayCodeDistribution tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified pay code distribution rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
Deviations
Deviations
1508
Kronos Incorporated
WSAPayCodeDistribution Tag
List of one or more schedule deviations. Type: String list Optional Introduced in v5.1 Distribution
Distribution
List of one or more pay codes for employees who are assigned this work rule. The pay code distribution tells the system in which pay codes each of the possible hour types accumulate. Type: Zero or more WSAPayDistributionAssociation tags Optional Introduced in v5.1 Name
Name
Name of the pay code distribution rule. The name can be up to 32 characters long, is case-insensitive, and must be unique. Type: String Optional Key Introduced in v5.1 OvertimeCombination
Overtime Combination
Overtime combination rule. Type: String Optional Introduced in v5.1
1509
Chapter 2
ZoneCombination
Zone Combination
Zone combination rule. Zones indicate that employees may receive a special pay rate for working during a special interval of time (such as a holiday or on a Sunday). Type: String Optional Introduced in v5.1
1510
Kronos Incorporated
WSAPayCodeProfileItem Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveForUpdate" Parameters None Properties <WSAPayCodeProfileItem Name = String > </WSAPayCodeProfileItem>
Action Descriptions
RetrieveAllForUpdate Returns all pay code profile items for updating. Return Value Type: Zero or more WSAPayCodeProfileItem tags Access Control Point Name: View Introduced in v5.1
1511
Chapter 2
RetrieveForUpdate Returns the specified pay code profile item for update. Return Value Type: WSAPayCodeProfileItem tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
Property Descriptions
Name
1512
Kronos Incorporated
WSAPayDistributionAssociation Tag
Syntax
Request <Request Action = Actions 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
1513
Chapter 2
Property Descriptions
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
1514
Kronos Incorporated
WSAPayDistributionAssociation Tag
Zones
Zones Type: String list Optional Key Introduced in v5.1
1515
Chapter 2
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View
1516
Kronos Incorporated
WSAPayPeriod Tag
Introduced in v5.1
Property Descriptions
DayDivide
Time of day
The time of day, in HH:mm format, when a pay period starts. Type: Time Optional Introduced in v5.1 Length
1517
Chapter 2
1518
Kronos Incorporated
WSAPayRule Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAPayRule Name = String > [<EffectivePayRules> <WSAEffectivePayRule>* </EffectivePayRules>] </WSAPayRule>
Action Descriptions
RetrieveAllForUpdate Returns all pay rules for updating. Return Value Type: Zero or more WSAPayRule tags
1519
Chapter 2
Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all pay rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified pay rule for updating. Return Value Type: WSAPayRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified pay rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
EffectivePayRules
1520
Kronos Incorporated
WSAPayRule Tag
Name
1521
Chapter 2
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View Introduced in v5.1
1522
Kronos Incorporated
WSAPayRuleHoliday Tag
Property Descriptions
CreditRuleNames
Holiday name
Name of the associated holiday. Type: String Optional Introduced in v5.1 Selected
1523
Chapter 2
Syntax
Request <Request Action = Actions 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
1524
Kronos Incorporated
WSAPermission Tag
Property Descriptions
ActionName
Action name
Action for which the permission has been granted. Possible actions are: ALLOWED EDIT ADD DELETE VIEW
Scope name
Scope that is associated with the action and permission type. Possible scopes are: ALL
1525
Chapter 2
1526
Kronos Incorporated
WSAProbationPeriod Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Retrieve" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" Parameters None Properties <WSAProbationPeriod [DatePattern = String] [EndAmount = Integer] [Name = String] Type = String > [<ProbationQualifiers> <WSAProbationQualifier>* </ProbationQualifiers>] </WSAProbationPeriod>
Action Descriptions
1527
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 Required Properties: Name Access Control Point Name: View Introduced in v5.2 RetrieveAllForUpdate The RetrieveAllForUpdate action will return a list of all available Probation Period Objects. Return Value Type: Zero or more WSAProbationPeriod tags Access Control Point Name: Edit Introduced in v5.2 RetrieveAllNames The RetrieveAllNames action will return a list of names of all available Probation Periods. Return Value Type: String list Access Control Point Name: View 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 Required Properties: Name Access Control Point Name: Edit Introduced in v5.2
1528
Kronos Incorporated
WSAProbationPeriod Tag
Property Descriptions
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
1529
Chapter 2
Type
Type
This attribute contains the type of the Probation Period. Can be "S" or "R". Type: String Required Introduced in v5.2
1530
Kronos Incorporated
WSAProbationQualifier Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Retrieve" | "RetrieveAllForUpdate" | "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
1531
Chapter 2
Access Control Point Name: View Introduced in v5.2 RetrieveAllForUpdate Returns a list of Probation Qualifiers for update Return Value Type: Zero or more WSAProbationQualifier tags Access Control Point Name: Edit Introduced in v5.2 RetrieveForUpdate Return a WSAProbationQualifier object for update Return Value Type: WSAProbationQualifier tag Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
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
1532
Kronos Incorporated
WSAProbationQualifier Tag
ConsecSwitch
1533
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAProcessingOrderRule Name = String > [<DoFirstList> <WSASequencedItem>* </DoFirstList>] [<DoLastList> <WSASequencedItem>* </DoLastList>] </WSAProcessingOrderRule>
Action Descriptions
1534
Kronos Incorporated
WSAProcessingOrderRule Tag
RetrieveAllForUpdate Returns a list of all of the WSA Processing Order Rules for update. Return Value Type: Zero or more WSAProcessingOrderRule tags Access Control Point Name: View Introduced in v5.2; last changed in v5.2 RetrieveAllNames Returns a list of names for all the Processing Order Rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.2; last changed in v5.2 RetrieveForUpdate Returns the specified WSA Processing Order Rule for update. Return Value Type: WSAProcessingOrderRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.2; last changed in v5.2 Update Does not return anything. Updates the specified Processing Order Rule. Return Value Type: None Required Properties: Name Access Control Point Name: View Introduced in v5.2; last changed in v5.2
Property Descriptions
DoFirstList
Do first List
A list of items to process first
1535
Chapter 2
Do last list
List of items to process last Type: Zero or more WSASequencedItem tags Optional Introduced in v5.2 Name
1536
Kronos Incorporated
WSAPunchRoundRule Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "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
1537
Chapter 2
[OutPunchEarlyChangePoint = TimeDuration] [OutPunchEarlyInsideGrace = TimeDuration] [OutPunchEarlyInsideRound = TimeDuration] [OutPunchEarlyOutsideGrace = TimeDuration] [OutPunchEarlyOutsideRound = TimeDuration] [OutPunchLateChangePoint = TimeDuration] [OutPunchLateInsideGrace = TimeDuration] [OutPunchLateInsideRound = TimeDuration] [OutPunchLateOutsideGrace = TimeDuration] [OutPunchLateOutsideRound = TimeDuration] [TransferGrace = TimeDuration] [TransferRound = TimeDuration] [UnscheduledInGrace = TimeDuration] [UnscheduledInRound = TimeDuration] [UnscheduledOutGrace = TimeDuration] [UnscheduledOutRound = TimeDuration] [UseScheduledOut = Boolean] > </WSAPunchRoundRule>
Action Descriptions
RetrieveAllForUpdate Returns all punch round rules for updating. Return Value Type: Zero or more WSAPunchRoundRule tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all punch round rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified punch round rule for updating. Return Value Type: WSAPunchRoundRule tag Required Properties: Name
1538
Kronos Incorporated
WSAPunchRoundRule Tag
Access Control Point Name: View Introduced in v5.1 Update Updates the specified punch round rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
InPunchEarlyChangePoint
1539
Chapter 2
the next increment. Grace amounts must be less than round amounts. You must specify a change point to use inside graces. Legal values are in the range of 00:00 to 99:59. The default is 00:00. Type: TimeDuration Optional Introduced in v5.1 InPunchEarlyInsideRound
1540
Kronos Incorporated
WSAPunchRoundRule Tag
1541
Chapter 2
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 shift start and end times round to the previous increment and when they round to the next increment. Grace amounts must be less than round amounts. You must specify a change point to use inside graces. Legal values are in the range of 00:00 to 99:59. The default is 00:00. Type: TimeDuration Optional Introduced in v5.1 InPunchLateInsideRound
1542
Kronos Incorporated
WSAPunchRoundRule Tag
when they round to the next increment. Grace amounts must be less than round amounts. Legal values are in the range of 00:00 to 99:59. The default is 00:01. Type: TimeDuration Optional Introduced in v5.1 InPunchLateOutsideRound
Name
1543
Chapter 2
Name of the punch round rule. The name can be up to 32 characters long, is caseinsensitive, and must be unique. Type: String Optional Key Introduced in v5.1 OutPunchEarlyChangePoint
1544
Kronos Incorporated
WSAPunchRoundRule Tag
1545
Chapter 2
(after the change point and before the scheduled start or end time). They establish the increments for punches and inferred amount end times by dividing hours into equal segments by minutes, so that 60 is a multiple of the round (for example, 1, 2, 3, 4, 5, 6, 10, 12, 15. 20, and 30). Legal values are in the range of 00:00 to 99:59. The default is 00:01. Type: TimeDuration Optional Introduced in v5.1 OutPunchLateChangePoint
1546
Kronos Incorporated
WSAPunchRoundRule Tag
1547
Chapter 2
Out Punch Late Outside Round, in HH:mm format. Late outside rounds apply to punches and amount end times that do not occur during the late inside interval (after the scheduled start or end time and before the change point). They establish the increments for punches and inferred amount end times by dividing hours into equal segments by minutes, so that 60 is a multiple of the round (for example, 1, 2, 3, 4, 5, 6, 10, 12, 15. 20, and 30). Legal values are in the range of 00:00 to 99:59. The default is 00:01. Type: TimeDuration Optional Introduced in v5.1 TransferGrace
Transfer Grace
Grace value, in HH:mm format, to be applied to punches by transferring employees. Graces determine when shift start and end times round to the previous increment and when they round to the next increment. Grace amounts must be less than round amounts. Legal values are in the range of 00:00 to 99:59. The default is 00:00. Type: TimeDuration Optional Introduced in v5.1 TransferRound
Transfer Round
Round value, in HH:mm format, to be applied to punches by transferring employees. Rounds establish the increments for punches and inferred amount end times by dividing hours into equal segments by minutes, so that 60 is a multiple of the round (for example, 1, 2, 3, 4, 5, 6, 10, 12, 15. 20, and 30). Legal values are in the range of 00:00 to 99:59. The default is 00:01. Type: TimeDuration Optional Introduced in v5.1
1548
Kronos Incorporated
WSAPunchRoundRule Tag
UnscheduledInGrace
Unscheduled In Grace
Grace value, in HH:mm format, to be applied to in-punches by unscheduled employees. Graces determine when shift start and end times round to the previous increment and when they round to the next increment. Grace amounts must be less than round amounts. Legal values are in the range of 00:00 to 99:59. The default is 00:00. Type: TimeDuration Optional Introduced in v5.1 UnscheduledInRound
Unscheduled In Round
Round value, in HH:mm format, to be applied to in-punches by unscheduled employees. Rounds establish the increments for punches and inferred amount end times by dividing hours into equal segments by minutes, so that 60 is a multiple of the round (for example, 1, 2, 3, 4, 5, 6, 10, 12, 15. 20, and 30). Legal values are in the range of 00:00 to 99:59. The default is 00:01. Type: TimeDuration Optional Introduced in v5.1 UnscheduledOutGrace
1549
Chapter 2
1550
Kronos Incorporated
WSAQuickFind Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAQuickFind [Description = String] [DisplayDescription = String] Name = String [DisplayName = String] > [<ColumnSet> <WSAWfgColumnSet> </ColumnSet>] [<NavbarCategory> <WSANavbarCategory> </NavbarCategory>] [<DefaultTimePeriod> <WSADPTimePeriod> </DefaultTimePeriod>] </WSAQuickFind>
1551
Chapter 2
Action Descriptions
RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSAQuickFind tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1; last changed in v5.2 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSAQuickFind tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Update the specified instance Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
1552
Kronos Incorporated
WSAQuickFind Tag
ColumnSet
Description
The Description Type: String Optional Introduced in v5.1 DisplayDescription
1553
Chapter 2
DisplayName
Name
The Name of the instance Type: String Optional Key Introduced in v5.1 NavbarCategory
1554
Kronos Incorporated
WSAReportDAP Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAReportDAP [Description = String] [AllowAll = Boolean] Name = String > [<ProfileItems> <WSAReportProfileItem>* </ProfileItems>] </WSAReportDAP>
Action Descriptions
1555
Chapter 2
RetrieveAllForUpdate Returns all report data access profiles for updating. Return Value Type: Zero or more WSAReportDAP tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all report data access profiles. Return Value Type: Zero or more NameList tags Access Control Point Name: Edit Introduced in v5.1 RetrieveForUpdate Returns the specified report data access profile for updating. Return Value Type: WSAReportDAP tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified report data access profile. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
AllowAll
1556
Kronos Incorporated
WSAReportDAP Tag
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
1557
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveForUpdate" Parameters None Properties <WSAReportProfileItem Name = String > </WSAReportProfileItem>
Action Descriptions
RetrieveAllForUpdate Returns all report profile items for updating. Return Value Type: Zero or more WSAReportProfileItem tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified report profile item for update.
1558
Kronos Incorporated
WSAReportProfileItem Tag
Return Value Type: WSAReportProfileItem tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
Property Descriptions
Name
1559
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSARollup [Description = String] [DisplayDescription = String] Name = String [DisplayName = String] > [<NavbarCategory> <WSANavbarCategory> </NavbarCategory>] [<ColumnSet> <WSAWfgColumnSet> </ColumnSet>] [<DefaultHyperfindQuery> <WSAHyperfindQuery> </DefaultHyperfindQuery>] [<DefaultTimePeriod>
1560
Kronos Incorporated
WSARollup Tag
Action Descriptions
RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSARollup tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1; last changed in v5.2 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSARollup tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Update the specified instance Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
1561
Chapter 2
Property Descriptions
ColumnSet
Description
The Description Type: String Optional Introduced in v5.1
1562
Kronos Incorporated
WSARollup Tag
DisplayDescription
Name
The Name of the instance Type: String Optional Key Introduced in v5.1 NavbarCategory
1563
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSARollupColumnSet [Description = String] [DisplayDescription = String] [ExteriorName = String] [ExteriorItemNumber = Long] Name = String [DisplayName = String] > [<LaborLevel> <WSADPLaborLevelDefinition>* </LaborLevel>] [<ColumnDetail> <WSAColumnDetail>* </ColumnDetail>] </WSARollupColumnSet>
1564
Kronos Incorporated
WSARollupColumnSet Tag
Action Descriptions
RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSARollupColumnSet tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1; last changed in v5.2 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSARollupColumnSet tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Update the specified instance Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
ColumnDetail
1565
Chapter 2
The collection of Column Details Type: Zero or more WSAColumnDetail tags Optional Introduced in v5.1 Description
Description
The Description Type: String Optional Introduced in v5.1 DisplayDescription
Item number
The Exterior Item Number
1566
Kronos Incorporated
WSARollupColumnSet Tag
Item name
The Exterior Name Type: String Optional Introduced in v5.1 LaborLevel
Name
The Name of the instance Type: String Optional Key Introduced in v5.1
1567
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAScheduleAssistant [ColumnSet = String] [CriteriaSet = String] [DefaultHyperfindQuery = String] [Description = String] [DisplayDescription = String] Name = String [DisplayName = String] > </WSAScheduleAssistant>
Action Descriptions
RetrieveAllForUpdate Retrieve all instances from the DB
1568
Kronos Incorporated
WSAScheduleAssistant Tag
Return Value Type: Zero or more WSAScheduleAssistant tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1; last changed in v5.2 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSAScheduleAssistant tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Update the specified instance Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
ColumnSet
1569
Chapter 2
Description
The Description Type: String Optional Introduced in v5.1 DisplayDescription
1570
Kronos Incorporated
WSAScheduleAssistant Tag
DisplayName
Name
The Name of the instance Type: String Optional Key Introduced in v5.1
1571
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAScheduleAssistantColumnSet [Description = String] [DisplayDescription = String] [ExteriorName = String] [ExteriorItemNumber = Long] Name = String [DisplayName = String] > [<ColumnDetail> <WSAColumnDetail>* </ColumnDetail>] </WSAScheduleAssistantColumnSet>
Action Descriptions
1572
Kronos Incorporated
WSAScheduleAssistantColumnSet Tag
RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSAScheduleAssistantColumnSet tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1; last changed in v5.2 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSAScheduleAssistantColumnSet tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Update the specified instance Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
ColumnDetail
1573
Chapter 2
Description
The Description Type: String Optional Introduced in v5.1 DisplayDescription
Item number
The Exterior Item Number Type: Long
1574
Kronos Incorporated
WSAScheduleAssistantColumnSet Tag
Item name
The Exterior Name Type: String Optional Introduced in v5.1 Name
Name
The Name of the instance Type: String Optional Key Introduced in v5.1
1575
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" Parameters None Properties <WSAScheduleAssistantTab [ComponentName = String] Name = String > </WSAScheduleAssistantTab>
Action Descriptions
RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSAScheduleAssistantTab tags Access Control Point Name: View Introduced in v5.1
1576
Kronos Incorporated
WSAScheduleAssistantTab Tag
RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSAScheduleAssistantTab tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
Property Descriptions
ComponentName
Component name
The Component Name Type: String Optional Introduced in v5.1 Name
Name
The Name of the instance Type: String Optional Key Introduced in v5.1
1577
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAScheduleDeviationRule [AfterShift = Boolean] [BeforeShift = Boolean] Name = String [NotScheduled = Boolean] [RequiresApproval = Boolean] > </WSAScheduleDeviationRule>
Action Descriptions
1578
Kronos Incorporated
WSAScheduleDeviationRule Tag
RetrieveAllForUpdate Returns all schedule deviation rules for updating. Return Value Type: Zero or more WSAScheduleDeviationRule tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all schedule deviation rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified schedule deviation rule for updating. Return Value Type: WSAScheduleDeviationRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified schedule deviation rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
AfterShift
After Shift
Boolean value that, when True, indicates that time worked after the scheduled end of a shift and before the missed-out limit accumulates as schedule deviation time.
1579
Chapter 2
Before Shift
Boolean value that, when True, indicates that time worked within the early schedule margin and before the start of a shift accumulates as schedule deviation time. Type: Boolean Optional Introduced in v5.1 Name
Name
Name of the schedule deviation rule. The name can be up to 32 characters long, is case-insensitive, and must be unique. Type: String Optional 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
1580
Kronos Incorporated
WSAScheduleDeviationRule Tag
Boolean value that, when True, indicates that hours worked outside of the employees scheduled shift requires a manager's approval. Type: Boolean Optional Introduced in v5.1
1581
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAScheduledHoursType Name = String [SchedHrsProdMonSw = Boolean] [SchedHrsInclSw = Boolean] > </WSAScheduledHoursType>
Action Descriptions
RetrieveAllForUpdate Returns all scheduled hours types for update. Return Value Type: Zero or more WSAScheduledHoursType tags
1582
Kronos Incorporated
WSAScheduledHoursType Tag
Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all scheduled hours types. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified scheduled hours type for update. Return Value Type: WSAScheduledHoursType tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified scheduled hours type. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
Name
Name
Name of the scheduled hours type. The name can be up to 32 characters long, is case-insensitive, and must be unique. Type: String Optional Key Introduced in v5.1
1583
Chapter 2
SchedHrsInclSw
1584
Kronos Incorporated
WSAScheduleEditor Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAScheduleEditor [DisplayDescription = String] [DisplayName = String] [Description = String] Name = String > [<ColumnSet> <WSAWfgColumnSet> </ColumnSet>] [<NavbarCategory> <WSANavbarCategory> </NavbarCategory>] [<DefaultHyperfindQuery> <WSAHyperfindQuery> </DefaultHyperfindQuery>] [<DefaultMainTab>
1585
Chapter 2
Action Descriptions
RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSAScheduleEditor tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1; last changed in v5.2 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSAScheduleEditor tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Update the specified instance Return Value Type: None Required Properties: Name Access Control Point Name: Edit
1586
Kronos Incorporated
WSAScheduleEditor Tag
Introduced in v5.1
Property Descriptions
ColumnSet
Query name
Specify the name of the query the Schedule Editor will use to retrieve schedule data. Type: WSAHyperfindQuery tag 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 DefaultTimePeriod
Time period
1587
Chapter 2
Specify a time period that has been defined for scheduling; for example, previous, current, or next. Type: WSADPTimePeriod tag Optional Introduced in v5.1 Description
1588
Kronos Incorporated
WSAScheduleEditor Tag
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
1589
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAScheduleEditorColumnSet [Description = String] [DisplayDescription = String] [ExteriorName = String] [ExteriorItemNumber = Long] Name = String [DisplayName = String] > [<ColumnDetail> <WSAColumnDetail>* </ColumnDetail>] </WSAScheduleEditorColumnSet>
Action Descriptions
1590
Kronos Incorporated
WSAScheduleEditorColumnSet Tag
RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSAScheduleEditorColumnSet tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1; last changed in v5.2 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSAScheduleEditorColumnSet tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Update the specified instance Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
ColumnDetail
1591
Chapter 2
Description
The Description Type: String Optional Introduced in v5.1 DisplayDescription
Item number
The Exterior Item Number Type: Long
1592
Kronos Incorporated
WSAScheduleEditorColumnSet Tag
Item name
The ExteriorName Type: String Optional Introduced in v5.1 Name
Name
The Name of the instance Type: String Optional Key Introduced in v5.1
1593
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Retrieve" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAScheduleGroupDAP [Description = String] [AllowAll = Boolean] Name = String > [<ProfileItems> <WSAScheduleGroupProfileItem>* </ProfileItems>] </WSAScheduleGroupDAP>
Action Descriptions
1594
Kronos Incorporated
WSAScheduleGroupDAP Tag
Retrieve Returns the specified schedule group data access profile. Return Value Type: WSAScheduleGroupDAP tag Required Properties: Name Access Control Point Name: View Introduced in v6.0 RetrieveAllForUpdate Return all schedule group data access profiles for update. Return Value Type: Zero or more WSAScheduleGroupDAP tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all schedule group data access profiles. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified schedule group data access profile for update. Return Value Type: WSAScheduleGroupDAP tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified schedule group data access profile. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
1595
Chapter 2
Property Descriptions
AllowAll
Description of DAP
Description of the schedule group data access profile. Type: String Optional Introduced in v5.1; last changed in v6.0 Name
Name of DAP
Name of the schedule group 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; last changed in v6.0 ProfileItems
1596
Kronos Incorporated
WSAScheduleGroupDAP Tag
1597
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Retrieve" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAScheduleGroupDetail [Description = String] [DisplayDescription = String] Name = String [DisplayName = String] > [<NavbarCategory> <WSANavbarCategory> </NavbarCategory>] [<ColumnSet> <WSAWfgColumnSet> </ColumnSet>] [<DefaultHyperfindQuery> <WSAHyperfindQuery> </DefaultHyperfindQuery>]
1598
Kronos Incorporated
WSAScheduleGroupDetail Tag
Action Descriptions
Retrieve Returns the specified schedule group detail. Return Value Type: WSAScheduleGroupDetail tag Required Properties: Name Access Control Point Name: View Introduced in v6.0 RetrieveAllForUpdate 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 Access Control Point Name: View Introduced in v5.2 RetrieveAllNames Retrieve the names of all instances in the system Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.2; last changed in v5.2 RetrieveForUpdate Retrieve all the updateable information for the specified schedule group detail record Return Value Type: WSAScheduleGroupDetail tag Required Properties: Name Access Control Point Name: View
1599
Chapter 2
Introduced in v5.2 Update Modify the schedule group detail record. If an object with the specified name does not exist, it's automatically created. Return Value Type: None Required Properties: name Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
ColumnSet
1600
Kronos Incorporated
WSAScheduleGroupDetail Tag
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
Name
1601
Chapter 2
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 NavbarCategory
1602
Kronos Incorporated
WSAScheduleGroupDetailColumnSet Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Retrieve" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAScheduleGroupDetailColumnSet [Description = String] [DisplayDescription = String] [ExteriorName = String] [ExteriorItemNumber = Long] Name = String [DisplayName = String] > [<ColumnDetail> <WSAColumnDetail>* </ColumnDetail>] </WSAScheduleGroupDetailColumnSet>
1603
Chapter 2
Action Descriptions
Retrieve Returns the specified schedule group detail coulmn set. Return Value Type: WSAScheduleGroupDetailColumnSet tag Required Properties: Name Access Control Point Name: View Introduced in v6.0 RetrieveAllForUpdate 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 Access Control Point Name: View Introduced in v5.2 RetrieveAllNames Retrieve the names of all the schedule group detail column set definitions in the system Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.2; last changed in v5.2 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 Required Properties: Name Access Control Point Name: View 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.
1604
Kronos Incorporated
WSAScheduleGroupDetailColumnSet Tag
Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
ColumnDetail
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
1605
Chapter 2
DisplayName
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
1606
Kronos Incorporated
WSAScheduleGroupDetailColumnSet Tag
Introduced in v5.2
1607
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Retrieve" | "RetrieveAllForUpdate" | "RetrieveForUpdate" Parameters None Properties <WSAScheduleGroupProfileItem Name = String > </WSAScheduleGroupProfileItem>
Action Descriptions
Retrieve Returns the specified schedule group profile item. Return Value Type: WSAScheduleGroupProfileItem tag Required Properties: Name Access Control Point Name: View
1608
Kronos Incorporated
WSAScheduleGroupProfileItem Tag
Introduced in v6.0 RetrieveAllForUpdate Returns all schedule group profile items for update. Return Value Type: Zero or more WSAScheduleGroupProfileItem tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified schedule group profile item for update. Return Value Type: WSAScheduleGroupProfileItem tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
Property Descriptions
Name
1609
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Retrieve" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAScheduleGroupRollup [Description = String] [DisplayDescription = String] Name = String [DisplayName = String] > [<NavbarCategory> <WSANavbarCategory> </NavbarCategory>] [<ColumnSet> <WSAWfgColumnSet> </ColumnSet>] [<DefaultHyperfindQuery> <WSAHyperfindQuery> </DefaultHyperfindQuery>]
1610
Kronos Incorporated
WSAScheduleGroupRollup Tag
Action Descriptions
Retrieve Returns the specified schedule group rollup. Return Value Type: WSAScheduleGroupRollup tag Required Properties: Name Access Control Point Name: View Introduced in v6.0 RetrieveAllForUpdate 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 Access Control Point Name: View Introduced in v5.2 RetrieveAllNames Retrieve the names of all the Schedule Group Roll-up definitions in the system Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.2; last changed in v5.2 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 Required Properties: Name Access Control Point Name: View
1611
Chapter 2
Introduced in v5.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. Return Value Type: None Required Properties: Name Optional Properties: ColumnSet, DefaultHyperfindQuery, DefaultTimePeriod, Description, DisplayDescription, DisplayName, NavbarCategory Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
ColumnSet
1612
Kronos Incorporated
WSAScheduleGroupRollup Tag
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
Name
1613
Chapter 2
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 NavbarCategory
1614
Kronos Incorporated
WSAScheduleGroupRollupColumnSet Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Retrieve" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAScheduleGroupRollupColumnSet [Description = String] [DisplayDescription = String] [ExteriorName = String] [ExteriorItemNumber = Long] Name = String [DisplayName = String] > [<ColumnDetail> <WSAColumnDetail>* </ColumnDetail>] </WSAScheduleGroupRollupColumnSet>
Action Descriptions
1615
Chapter 2
Retrieve Returns the specified schedule group rollup column set. Return Value Type: WSAScheduleGroupRollupColumnSet tag Required Properties: Name Access Control Point Name: View Introduced in v6.0 RetrieveAllForUpdate 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 Access Control Point Name: View Introduced in v5.2 RetrieveAllNames Retrieve the names of all the schedule group roll-up column set definitions in the system Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.2; last changed in v5.2 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 Required Properties: Name Access Control Point Name: View 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. Return Value Type: None
1616
Kronos Incorporated
WSAScheduleGroupRollupColumnSet Tag
Required Properties: Name Access Control Point Name: Edit Introduced in v5.2
Property Descriptions
ColumnDetail
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
1617
Chapter 2
DisplayName
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
1618
Kronos Incorporated
WSAScheduleGroupRollupColumnSet Tag
Introduced in v5.2
1619
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" Parameters None Properties <WSASchedulePeriod Name = String > </WSASchedulePeriod>
Action Descriptions
RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSASchedulePeriod tags Access Control Point Name: View Introduced in v5.1
1620
Kronos Incorporated
WSASchedulePeriod Tag
RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSASchedulePeriod tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
Property Descriptions
Name
1621
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSASchedulePlanner [DisplayDescription = String] [ColumnSet = String] [DisplayName = String] [NavbarCategory = String] [DefaultHyperfindQuery = String] [Description = String] [ScheduleAssistant = String] Name = String [DefaultMainTab = String] [DefaultScheduleAssistantTab = String] [DefaultTimePeriod = String] > </WSASchedulePlanner>
1622
Kronos Incorporated
WSASchedulePlanner Tag
Action Descriptions
RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSASchedulePlanner tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1; last changed in v5.2 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSASchedulePlanner tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Update the specified instance Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
ColumnSet
1623
Chapter 2
Specify the name of the column set that will return the requested data. Type: String Optional Introduced in v5.1 DefaultHyperfindQuery
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 Optional Introduced in v5.1 DefaultScheduleAssistantTab
1624
Kronos Incorporated
WSASchedulePlanner Tag
Specify a time period that has been defined for scheduling; for example, previous, current, or next. Type: String Optional Introduced in v5.1 Description
1625
Chapter 2
Name
1626
Kronos Incorporated
WSASchedulePlannerColumnSet Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSASchedulePlannerColumnSet [Description = String] [DisplayDescription = String] [ExteriorName = String] [ExteriorItemNumber = Long] Name = String [DisplayName = String] > [<ColumnDetail> <WSAColumnDetail>* </ColumnDetail>] </WSASchedulePlannerColumnSet>
Action Descriptions
1627
Chapter 2
RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSASchedulePlannerColumnSet tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1; last changed in v5.2 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSASchedulePlannerColumnSet tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Update the specified instance Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
ColumnDetail
1628
Kronos Incorporated
WSASchedulePlannerColumnSet Tag
Description
The Description Type: String Optional Introduced in v5.1 DisplayDescription
Item number
The Exterior Item Number Type: Long
1629
Chapter 2
Item name
The Exterior Name Type: String Optional Introduced in v5.1 Name
Name
The Name of the instance Type: String Optional Key Introduced in v5.1
1630
Kronos Incorporated
WSASequencedItem Tag
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View
1631
Chapter 2
Introduced in v5.1
Property Descriptions
Name
1632
Kronos Incorporated
WSASequencerRule Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSASequencerRule Name = String > [<DoFirstList> <WSASequencedItem>* </DoFirstList>] [<DoLastList> <WSASequencedItem>* </DoLastList>] </WSASequencerRule>
Action Descriptions
1633
Chapter 2
RetrieveAllForUpdate Retrieve all sequencer rules for update. Return Value Type: Zero or more WSAProcessingOrderRule tags Access Control Point Name: View Introduced in v5.1; last changed in v5.2 RetrieveAllNames Returns a list of the names of all sequencer rules. Return Value Type: Zero or more NameList tags Access Control Point Name: Edit Introduced in v5.1; last changed in v5.2 RetrieveForUpdate Returns the specified sequencer rule for update. Return Value Type: WSAProcessingOrderRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.1; last changed in v5.2 Update Updates the specified sequencer rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1; last changed in v5.2
Property Descriptions
DoFirstList
Do first list
Ordered list that specifies the hour types to process first. Hour types that help employees reach overtime limits may be in this category. For example, if a
1634
Kronos Incorporated
WSASequencerRule Tag
holiday occurs at the end of the week, place the holiday hour type in this list. Holiday hours process first and help employees reach overtime limits. Type: Zero or more WSASequencedItem tags Optional Introduced in v5.1 DoLastList
Do last list
Ordered list that specifies the hour types to process last. You typically place an hour type in this list to prevent the corresponding hours from counting toward the weekly overtime goal. For example, if you moved daily overtime hours to this list, you can prevent daily overtime hours from counting toward weekly overtime. You can also total or process "non-home" labor level transfers last. That procedure ensures that the system allocates overtime hours to the department to which the person was "loaned" rather than to the person's "home" department. Type: Zero or more WSASequencedItem tags Optional Introduced in v5.1 Name
1635
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "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] >
1636
Kronos Incorporated
WSAShiftGuarantee Tag
</WSAShiftGuarantee>
Action Descriptions
RetrieveAllForUpdate Returns all shift guarantees for update. Return Value Type: Zero or more WSAShiftGuarantee tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all shift guarantees. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified shift guarantee for update. Return Value Type: WSAShiftGuarantee tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified shift guarantee. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
1637
Chapter 2
Friday
Friday
Length of the guaranteed shift for Friday. Type: TimeDuration Optional Introduced in v5.1 Monday
Monday
Length of the guaranteed shift for Monday. Type: TimeDuration Optional Introduced in v5.1 Name
Name
Name of the shift guarantee. The name can be up to 32 characters long, is caseinsensitive, and must be unique. Type: String Optional Key Introduced in v5.1 ReductByAmountTardy
1638
Kronos Incorporated
WSAShiftGuarantee Tag
length of the guarantee, the guaranteed shift no longer applies. By default, this option is not selected. Type: Boolean Optional Introduced in v5.1 Saturday
Saturday
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.
1639
Chapter 2
Wednesday
Length of the guaranteed shift for Wednesday. Type: TimeDuration Optional Introduced in v5.1 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
1640
Kronos Incorporated
WSAShiftLength Tag
Syntax
Request <Request Action = Actions 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 Required Properties: Name
1641
Chapter 2
Property Descriptions
BreakTimes
Break times
List of one or more breaks assigned to this shift. Type: Zero or more WSABreakTime tags Optional Introduced in v5.1 Length
Length of shift
Shift length, in HH:mm format. A shift can be from 0 (zero) to 99 hours long. Type: Long Optional Introduced in v5.1 Name
Shift name
Name of the shift. The name can be up to 32 characters long, is case-insensitive, and must be unique. Type: String Optional Key Introduced in v5.1
1642
Kronos Incorporated
WSAShiftLengthExclusion Tag
Syntax
Properties <WSAShiftLengthExclusion Length = String > </WSAShiftLengthExclusion>
Property Descriptions
Length
Length
Length Type: String Required Introduced in v6.0; last changed in v6.0
1643
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAShiftTemplateDAP Name = String [Description = String] [AllowAll = Boolean] > [<ProfileItems> <WSAShiftTemplateProfileItem>* </ProfileItems>] </WSAShiftTemplateDAP>
Action Descriptions
1644
Kronos Incorporated
WSAShiftTemplateDAP Tag
RetrieveAllForUpdate Returns all shift template data access profiles for update. Return Value Type: Zero or more WSAShiftTemplateDAP tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all shift template data access profiles. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified shift template data access profile for update. Return Value Type: WSAShiftTemplateDAP tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified shift template data access profile. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
AllowAll
1645
Chapter 2
Description
Description of the shift template data access profile. Type: String Optional Introduced in v5.1 Name
1646
Kronos Incorporated
WSAShiftTemplateProfileItem Tag
Syntax
Properties <WSAShiftTemplateProfileItem Name = String > </WSAShiftTemplateProfileItem>
Property Descriptions
Name
1647
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSASignOffRestriction [DisallowIfMissingPunches = Boolean] [DisallowIfUnexcusedAbsences = Boolean] [DisallowIfZeroHours = Boolean] Name = String [PayCodeForZeroHours = String] > </WSASignOffRestriction>
Action Descriptions
RetrieveAllForUpdate Returns all sign-off restrictions for update.
1648
Kronos Incorporated
WSASignOffRestriction Tag
Return Value Type: Zero or more WSASignOffRestriction tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all sign-off restrictions. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified sign-off restriction for update. Return Value Type: WSASignOffRestriction tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified sign-off restriction. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
DisallowIfMissingPunches
1649
Chapter 2
1650
Kronos Incorporated
WSASignOffRestriction Tag
PayCodeForZeroHours
1651
Chapter 2
Syntax
Properties <WSASubsequentGrant [ExpireToAccrual = String] AccrualRule = String Amount = String GrantRule = String MilestoneNumber = Integer > </WSASubsequentGrant>
Property Descriptions
AccrualRule
Accrual rule
The Accrual Policy Rule associated with this subsequent grant. Type: String Required Introduced in v5.2 Amount
Amount accrued
1652
Kronos Incorporated
WSASubsequentGrant Tag
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
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
1653
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Retrieve" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" Parameters None
Action Descriptions
Retrieve Return the Time Period with the given name. Return Value Type: WSATimePeriod tag Required Properties: Name Access Control Point Name: View Introduced in v5.2 RetrieveAllForUpdate Returns a list of WSATimePeriods
1654
Kronos Incorporated
WSATimePeriod Tag
Return Value Type: Collection Access Control Point Name: Edit Introduced in v5.2 RetrieveAllNames Return a list of all the names of all the Time Periods Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.2 RetrieveForUpdate Returns the WSA Time Period with the given name. Return Value Type: WSATimePeriod tag Required Properties: Name Access Control Point Name: View Introduced in v5.2
1655
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Delete" | "Retrieve" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "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]
1656
Kronos Incorporated
WSATkTerminalRule Tag
[LateEndMargin = TimeDuration] [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. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.2 Retrieve Retrieve the specified Terminal Rule. Return Value Type: WSATkTerminalRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.2 RetrieveAllForUpdate Returns all terminal rules for update. Return Value Type: Zero or more WSATkTerminalRule tags Access Control Point Name: View Introduced in v5.1
1657
Chapter 2
RetrieveAllNames Returns a list of the names of all terminal rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified terminal rule for update. Return Value Type: WSATkTerminalRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified terminal rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
AllowOverrides
1658
Kronos Incorporated
WSATkTerminalRule Tag
BeginEarlyEnd
Starts a period of time before the end of a shift when an employee cannot punch out
The Begin Early End restriction, specified in HH:mm format, starts a period of time before the end of a shift when an employee cannot punch out. If you use this restriction, you are required to set Lift Early End Restriction, which ends the outpunch 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
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
1659
Chapter 2
EarlyStartBreakMargin
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
1660
Kronos Incorporated
WSATkTerminalRule Tag
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
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
1661
Chapter 2
Time before the end of a shift that an employee cannot punch out
The Lift Early End, specified in HH:mm format, specifies the period of time before the end of a shift when an employee cannot punch out. If you use this restriction, you are required to set Begin Early End Restriction, which starts the out-punch restriction period. Lift Early End Restriction cannot exceed Begin Early End Restriction. Type: TimeDuration Optional Introduced in v5.1 MaximumOut
1662
Kronos Incorporated
WSATkTerminalRule Tag
MaximumShiftLength
1663
Chapter 2
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 Introduced in v5.1; last changed in v5.2 UnscheduledIn
1664
Kronos Incorporated
WSATkTerminalRule Tag
1665
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" Parameters None Properties <WSATreeType [Description = String] [LeafNodeSupportSwitch = Integer] [IsDefaultSwitch = Integer] [LanguageCD = String] Name = String [TreeTypeCD = String] > </WSATreeType>
Action Descriptions
RetrieveAllForUpdate Retrieve all instances from the DB Return Value Type: Zero or more WSATreeType tags
1666
Kronos Incorporated
WSATreeType Tag
Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Retrieve the names of all instances in the DB Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSATreeType tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
Property Descriptions
Description
Description
The Description Type: String Optional Introduced in v5.1 IsDefaultSwitch
1667
Chapter 2
LanguageCD
Language CD
The Language CD Type: String Optional Introduced in v5.1 LeafNodeSupportSwitch
Name
The Name of the instance Type: String Optional Key Introduced in v5.1 TreeTypeCD
Tree Type CD
The Tree Type CD Type: String Optional Introduced in v5.1
1668
Kronos Incorporated
WSAULLE Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAULLE [Description = String] [Name = String] > </WSAULLE>
Action Descriptions
1669
Chapter 2
RetrieveAllForUpdate Returns the one logical unspecified labor level entry in the system. (Note: This API exists for completeness. Although there is one unspecified labor level entry for each defined labor level, these entries all have the same attributes and are thus one logical entity.) Return Value Type: Zero or more WSAULLE tags Access Control Point Name: View 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.) Return Value Type: Zero or more NameList tags Access Control Point Name: View 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 Required Properties: Name Access Control Point Name: View 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.) Return Value Type: None
1670
Kronos Incorporated
WSAULLE Tag
Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
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 long, is case-insensitive, and must be unique. Type: String Optional Introduced in v5.1
1671
Chapter 2
Syntax
Request <Request Action = Actions 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
1672
Kronos Incorporated
WSAWageAdjustment Tag
Required Properties: WageProfileName, LaborLevelName, LaborLevelEntryName, LaborLevelEntryWildcard Access Control Point Name: View Introduced in v5.1; last changed in v5.2
Property Descriptions
Amount
Amount
Amount to be applied to the adjustment type. Although this property takes a string, this value should be a well-formed float/long. Type: String Optional Introduced in v5.1 LaborLevelEntryName
1673
Chapter 2
1674
Kronos Incorporated
WSAWageProfile Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAWageProfile [OverrideIfHomeSwitch = Boolean] [UseHighestWageSwitch = Boolean] Name = String > [<WgpPayCodes> <WSAWageProfilePayCode>* </WgpPayCodes>] [<WageProfileLLDef> <WSAWageProfileLaborLevelLinkage>* </WageProfileLLDef>] </WSAWageProfile>
1675
Chapter 2
Action Descriptions
RetrieveAllForUpdate Returns all wage profiles for update. Return Value Type: WSAWageProfile tag Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all wage profiles. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified wage profile for update. Return Value Type: WSAWageProfile tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified wage profile. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
Name
1676
Kronos Incorporated
WSAWageProfile Tag
Name of the wage profile. The name can be up to 32 characters long, is caseinsensitive, and must be unique. Type: String Optional Key Introduced in v5.1 OverrideIfHomeSwitch
1677
Chapter 2
WgpPayCodes
1678
Kronos Incorporated
WSAWageProfileLaborLevelLinkage Tag
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View
1679
Chapter 2
Introduced in v5.1
Property Descriptions
Adjustments
1680
Kronos Incorporated
WSAWageProfilePayCode Tag
Syntax
Request <Request Action = Actions 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 Required Properties: Name Access Control Point Name: View Introduced in v5.1
1681
Chapter 2
Property Descriptions
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
1682
Kronos Incorporated
WSAWfgColumnSet Tag
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View
1683
Chapter 2
Introduced in v5.2 RetrieveForUpdate Returns the specified column set for update. Return Value Type: WSAWfgColumnSet tag Required Properties: Name, TypeExteriorName, TypeExteriorNumber Access Control Point Name: View Introduced in v5.1
Property Descriptions
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
1684
Kronos Incorporated
WSAWfgColumnSet Tag
Introduced in v5.2
1685
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAWorkforceGenieProfile [Description = String] [DisplayDescription = String] Name = String [DisplayName = String] > [<Genies> <WSAGenie>* </Genies>] </WSAWorkforceGenieProfile>
1686
Kronos Incorporated
WSAWorkforceGenieProfile Tag
Action Descriptions
RetrieveAllForUpdate Returns all profiles for update. Return Value Type: Zero or more WSAWorkforceGenieProfile tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all profiles. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1; last changed in v5.2 RetrieveForUpdate Returns the specified profile for update. Return Value Type: WSAWorkforceGenieProfile tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified profile. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
Description
Description
1687
Chapter 2
Description of the profile building block. Type: String Optional Introduced in v5.1 DisplayDescription
Name
Name of the profile building block. The name is case-insensitive and must be unique.
1688
Kronos Incorporated
WSAWorkforceGenieProfile Tag
1689
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAWorkHistoryQualifierRule [AmountUnits = String] [ContributingShiftRuleName = String] Name = String [Type = String] > </WSAWorkHistoryQualifierRule>
Action Descriptions
RetrieveAllForUpdate Returns all work history qualifier rules for update. Return Value Type: Zero or more WSAWorkHistoryQualifierRule tags
1690
Kronos Incorporated
WSAWorkHistoryQualifierRule Tag
Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all work history qualifier rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified work history qualifier rule for update. Return Value Type: WSAWorkHistoryQualifierRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified work history qualifier rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
AmountUnits
1691
Chapter 2
Type: String
1692
Kronos Incorporated
WSAWorkHistoryQualifierRule Tag
1693
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" Parameters None Properties <WSAWorkloadPlannerProfile Name = String > </WSAWorkloadPlannerProfile>
Action Descriptions
RetrieveAllForUpdate Returns all workload planner profiles for update. Return Value Type: Zero or more WSAWorkloadPlannerProfile tags Access Control Point Name: View
1694
Kronos Incorporated
WSAWorkloadPlannerProfile Tag
Introduced in v5.1 RetrieveAllNames Returns a list of the names of all workload planner profiles. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns a specific workload planner profile for update. Return Value Type: WSAWorkloadPlannerProfile tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
Property Descriptions
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
1695
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAWorkRule Name = String > [<EffectiveWorkRules> <WSAEffectiveWorkRule>* </EffectiveWorkRules>] </WSAWorkRule>
Action Descriptions
RetrieveAllForUpdate Returns all work rules for update.
1696
Kronos Incorporated
WSAWorkRule Tag
Return Value Type: Zero or more WSAWorkRule tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all work rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified work rule for update. Return Value Type: WSAWorkRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified work rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
EffectiveWorkRules
1697
Chapter 2
1698
Kronos Incorporated
WSAWorkRuleDAP Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAWorkRuleDAP [Description = String] [AllowAll = Boolean] Name = String > [<ProfileItems> <WSAWorkRuleProfileItem>* </ProfileItems>] </WSAWorkRuleDAP>
Action Descriptions
1699
Chapter 2
RetrieveAllForUpdate Returns all work rule data access profiles for update. Return Value Type: Zero or more WSAWorkRuleDAP tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all work rule data access profiles. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified work rule data access profile for update. Return Value Type: WSAWorkRuleDAP tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified work rule data access profile. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
AllowAll
1700
Kronos Incorporated
WSAWorkRuleDAP Tag
Description
Description of the work rule data access profile. Type: String Optional Introduced in v5.1 Name
1701
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Retrieve" Parameters None Properties <WSAWorkRuleGeneral [BonusDeductRuleNames = String list] [BreakRuleNames = String list] [CoreHoursRuleNames = String list] Name = String > </WSAWorkRuleGeneral>
Action Descriptions
Retrieve Returns the specified general work rule. Return Value Type: WSAWorkRuleGeneral tag Required Properties: Name Access Control Point Name: View
1702
Kronos Incorporated
WSAWorkRuleGeneral Tag
Introduced in v5.1
Property Descriptions
BonusDeductRuleNames
1703
Chapter 2
Name of the general work rule. The name can be up to 32 characters long, is caseinsensitive, and must be unique. Type: String Optional Key Introduced in v5.1
1704
Kronos Incorporated
WSAWorkRulePCDistr Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Retrieve" Parameters None Properties <WSAWorkRulePCDistr [ExtensionNames = String list] [MajorityRuleNames = String list] Name = String [OvertimeRuleNames = String list] [ScheduleDeviationRuleNames = String list] [ZoneRuleNames = String list] > </WSAWorkRulePCDistr>
Action Descriptions
Retrieve Returns the specified pay code distribution.
1705
Chapter 2
Return Value Type: WSAWorkRulePCDistr tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
Property Descriptions
ExtensionNames
Majority rules
List of one or more majority rules associated with this pay code distribution. Type: String list Optional Introduced in v5.1 Name
1706
Kronos Incorporated
WSAWorkRulePCDistr Tag
OvertimeRuleNames
Overtime rules
List of one or more overtime rules associated with this pay code distribution. Type: String list Optional Introduced in v5.1 ScheduleDeviationRuleNames
Zone rule
List of one or more zone rules associated with this pay code distribution. Type: String list Optional Introduced in v5.1
1707
Chapter 2
Syntax
Request <Request Action = Actions 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 Access Control Point Name: View Introduced in v5.1
1708
Kronos Incorporated
WSAWorkRuleProfileItem Tag
RetrieveForUpdate Returns the specified work rule profile item for update. Return Value Type: WSAWorkRuleProfileItem tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
Property Descriptions
Name
1709
Chapter 2
Syntax
Request <Request Action = Actions 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]
1710
Kronos Incorporated
WSAZone Tag
[ConsecutiveMinimumTime = TimeDuration] [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 Access Control Point Name: View Introduced in v5.1
Property Descriptions
ConsecutiveDayNumber
1711
Chapter 2
When the zone type is consecutive days worked and consecutive type is C (Days is a row), number of the day of the week on which the number of contributing days is reset to 0 (zero). Type: Integer Optional Introduced in v5.1 ConsecutiveLastDayMinimumTime
1712
Kronos Incorporated
WSAZone Tag
When zone type is consecutive days worked, this property specifies one of the following reset methods: A -- Days in a row: Resets the number of contributing days to 0 on the specified day number. For example, if the value is 7, the count of contributing days will automatically reset on the seventh day. This method allows days contributing toward consecutive days work to cross the day divide. C -- Days in a row: Resets the number of contributing days to 0 on the specified day of week. D -- Days in a week: Resets the number of contributing days to 0 on the specified day of the week.
Type: String Optional Sample values: Days in a row, Days in a week Introduced in v5.1 DaysOfWeek
Days of week
When the zone type is days of week and the ConsecutiveType property is D, list of one or more days that are eligible for a special pay rate. Type: WSADaysOfWeek tag Optional Introduced in v5.1 DaysOfWeekZonesAppliesType
1713
Chapter 2
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.
1714
Kronos Incorporated
WSAZone Tag
Can an employee stop work early and still earn zone time?
When the zone type is daily shift differential or weekend differential, Boolean value that, when True, indicates an employee can earn zone hours if work is ended before the end of the zone. If the value is False, the EndWorkBeforeTime property is ignored. Type: Boolean Optional
1715
Chapter 2
1716
Kronos Incorporated
WSAZone Tag
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.
1717
Chapter 2
9 -- Holiday Zone defined by Times in Holiday Table; Holiday Worked Hours belong to Day With Majority Hours.
1718
Kronos Incorporated
WSAZone Tag
Selected holidays
When the zone type is holiday, list of selected holiday zone rules.
1719
Chapter 2
Selected limits
The list of Selected Limits Type: Zero or more WSAZoneRuleLimit tags Optional Introduced in v5.1 StartNumberOfDay
1720
Kronos Incorporated
WSAZone Tag
StartWorkAfterTime
Can an employee start work late and still earn zone time?
When the zone type is daily shift differential, Boolean value that, when True, indicates that an employee can earn zone hours if work is started after the start of the zone. If the value is False, the StartWorkAfterTime property is ignored. Type: Boolean Optional Introduced in v5.1 StartWorkBeforeTime
1721
Chapter 2
When the zone type is daily shift differential or weekend differential, Boolean value that indicates, when True, that an employee can earn zone hours if work is started before the start of the zone. If the value is False, the StartWorkBeforeTime property is ignored. Type: Boolean Optional Introduced in v5.1 TypeCode
Zone type
Type of zone. Valid zone types include: C -- Consecutive days worked H -- Holiday D -- Days of week S -- Daily shift differential W -- Weekend differential
1722
Kronos Incorporated
WSAZoneCombinationRule Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAZoneCombinationRule Name = String > [<SelectedZoneRules> <WSAZoneCombinationZoneRule>* </SelectedZoneRules>] [<CombinationRules> <WSAZoneCombinationSpecificationRule>* </CombinationRules>] </WSAZoneCombinationRule>
Action Descriptions
1723
Chapter 2
RetrieveAllForUpdate Returns all zone combination rules for update. Return Value Type: Zero or more WSAZoneCombinationRule tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all zone combination rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified zone combination rule for update. Return Value Type: WSAZoneCombinationRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified zone combination rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
CombinationRules
1724
Kronos Incorporated
WSAZoneCombinationRule Tag
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
1725
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveForUpdate" Parameters None Properties <WSAZoneCombinationSpecificationRule KeyName = String ValueName = String ItemName = String > </WSAZoneCombinationSpecificationRule>
Action Descriptions
RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSAZoneCombinationSpecificationRule tag Required Properties: ItemName, KeyName, ValueName Access Control Point Name: View
1726
Kronos Incorporated
WSAZoneCombinationSpecificationRule Tag
Introduced in v5.1
Property Descriptions
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
1727
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveForUpdate" Parameters None Properties <WSAZoneCombinationZoneRule Name = String > </WSAZoneCombinationZoneRule>
Action Descriptions
RetrieveForUpdate Retrieve the specified instance from the DB Return Value Type: WSAZoneCombinationZoneRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.1
1728
Kronos Incorporated
WSAZoneCombinationZoneRule Tag
Property Descriptions
Name
1729
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" Parameters None Properties <WSAZoneRule [RequiresApproval = Boolean] Name = String > [<Zone> <WSAZone> </Zone>] </WSAZoneRule>
Action Descriptions
RetrieveAllForUpdate Returns all zone rules for update.
1730
Kronos Incorporated
WSAZoneRule Tag
Return Value Type: Zero or more WSAZoneRule tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns a list of the names of all zone rules. Return Value Type: Zero or more NameList tags Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns the specified zone rule for update. Return Value Type: WSAZoneRule tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Updates the specified zone rule. Return Value Type: None Required Properties: Name Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
Name
1731
Chapter 2
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
1732
Kronos Incorporated
WSAZoneRuleHoliday Tag
Syntax
Request <Request Action = Actions 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 Required Properties: Name Access Control Point Name: View Introduced in v5.1
1733
Chapter 2
Property Descriptions
Name
1734
Kronos Incorporated
WSAZoneRuleLimit Tag
Syntax
Request <Request Action = Actions 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 Required Properties: Name Access Control Point Name: View Introduced in v5.1
1735
Chapter 2
Property Descriptions
Name
1736
Kronos Incorporated
WTDEmployeeAssignment Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Retrieve" | "RetrieveAll" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" |
1737
Chapter 2
"Update" Parameters None Properties <WTDEmployeeAssignment EmployeeId = Long [HazardousWorker = Boolean] Id = Long Name = String WtdRuleId = Long > [<OptOutStatuses> <OptOutStatusList>* </OptOutStatuses>] </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 Required Properties: EmployeeId Access Control Point Name: View Introduced in v5.1 RetrieveAll Returns all Employee Assignments. Return Value Type: Zero or more WTDEmployeeAssignment tags Access Control Point Name: View Introduced in v5.1 RetrieveAllForUpdate Returns all WTDEmployeeAssignments for SDM update. Return Value Type: Zero or more WTDEmployeeAssignment tags
1738
Kronos Incorporated
WTDEmployeeAssignment Tag
Access Control Point Name: View Introduced in v5.1; last changed in v5.1 RetrieveAllNames Returns the names of all Employee Assignments. This is formatted as <Name |<WTKEmployeeId Return Value Type: String list Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Retrieves a single WTDEmplyoeeAssignement for SDM update. Return Value Type: WTDEmployeeAssignment tag Required Properties: Name Access Control Point Name: View Introduced in v5.1 Update Adds or updates an WTDEmployeeAssignment. Return Value Type: None Required Properties: EmployeeId WtdRuleId Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
EmployeeId
Employee Id
The WTKEmployeeId that this rule is being assigned to. Type: Long
1739
Chapter 2
Hazardous Worker
Flag indicating if the employee's job is hazardous. Type: Boolean Optional Sample values: True Introduced in v5.1 Id
Id
The primary key of a Working Time Directive rule. Type: Long Required Key not null Introduced in v5.1; last changed in v5.1 Name
Name
The name of the employee/rule assignment. Type: String Required Introduced in v5.1
1740
Kronos Incorporated
WTDEmployeeAssignment Tag
OptOutStatuses
OptOutStatusList
The list of effective dated OptOutStatuses Type: Zero or more OptOutStatusList tags Optional Introduced in v5.1; last changed in v6.0 WtdRuleId
WTD Rule Id
The Working Time Directive rule that is being assigned to an employee. Type: Long Required not null Introduced in v5.1; last changed in v5.1
1741
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Add" | "AddOnly" | "Delete" | "DeleteOnly" | "Retrieve" | "RetrieveAll" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" | "UpdateOnly" Parameters None Properties
1742
Kronos Incorporated
WTDGlobal Tag
<WTDGlobal [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. Return Value Type: None Required Properties: IncludedPayCode Optional Properties: Id BreakPayCode ExcludedPayCode Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1 AddOnly Adds a new instance. If an object exist for this Id then a duplicate exception is thrown. Id and IncludedPayCode cannot be null Return Value Type: None Required Properties: Id IncludedPayCode Optional Properties: ExcludedPayCode BreakPayCode
1743
Chapter 2
Access Control Point Name: Edit Introduced in v5.1 Delete Deletes the specified pay code from the Working Time Directive global settings. If the pay code is not listed in the global settings, no error is returned. Return Value Type: None Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1 DeleteOnly Deletes an instance. If the object is not found then OBJECT_NOT_FOUND_KEY is thrown. Return Value Type: None Access Control Point Name: Edit Introduced in v5.1 Retrieve Returns a list of pay codes in the Working Time Directive Global settings. If the object is not found then OBJECT_NOT_FOUND_KEY is thrown. None Return Value Type: WTDGlobal tag Access Control Point Name: View Introduced in v5.1; last changed in v5.1 RetrieveAll Returns all global configurations, which should equal exactly 1 configuration object. Implemented for future enhancements. Return Value Type: Zero or more WTDGlobal tags Access Control Point Name: View Introduced in v5.1 RetrieveAllForUpdate Returns all for SDM update.
1744
Kronos Incorporated
WTDGlobal Tag
Return Value Type: Zero or more WTDGlobal tags Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns all names for the Setup Data Manager (SDM). Return Value Type: String list Access Control Point Name: View Introduced in v5.1 RetrieveForUpdate Returns an instance for the provided name. If the object does not exists and an Object key not found exception is thrown. Return Value Type: WTDGlobal tag Required Properties: Name Access Control Point Name: View Introduced in v5.1; last changed in v5.1 Update Updates a global configuration. If it does not exist then it is created. Id IncludedPayCode cannot be null Return Value Type: None Required Properties: IncludedPayCode IncludedPayCodeName Optional Properties: Id ExcludedPayCode BreakPayCode Access Control Point Name: Edit Introduced in v5.1; last changed in v5.1 UpdateOnly updates only. If the object is not found then OBJECT_NOT_FOUND_KEY is thrown. Id and IncludedPayCode cannot be null. Return Value Type: None
1745
Chapter 2
Required Properties: Id IncludedPayCode Optional Properties: BreakPayCode ExcludedPayCode Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
BreakPayCode
1746
Kronos Incorporated
WTDGlobal Tag
ExcludedPayCodeName
Id
Primary key of the global configuration. Type: Long Required Key cannot be null Introduced in v5.1 IncludedPayCode
1747
Chapter 2
Name
Name of the global configuration. Type: String Required Introduced in v5.1 UpdateDateTime
1748
Kronos Incorporated
WTDRule Tag
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "Add" | "AddOnly" | "Delete" | "DeleteOnly" | "Retrieve" | "RetrieveAll" | "RetrieveAllForUpdate" | "RetrieveAllNames" | "RetrieveForUpdate" | "Update" | "UpdateOnly"
1749
Chapter 2
Parameters 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 [Description = 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. Return Value Type: None Required Properties: Name WorkWeekLength FirstDayOfWeek NumberOfIterations ExceptionsOnly MaxWeeklyHours ExcludedHours
1750
Kronos Incorporated
WTDRule Tag
WorkedAveragePeriod MaxAdultWork MinAdultBreak MinAdultDailyRest MinAdultWeeklyRest OffAveragePeriod MaxYoungWork MinYoungBreak MinYoungDailyRest MinYoungWeeklyRest Optional Properties: StartNightPeriod EndNightPeriod MinPercentNightHours MaxNightHours MaxHazardousNightHours YoungWorkerAge YoungWorkerMaxDailyHours YoungWorkerMaxWeeklyHours Access Control Point Name: Edit Introduced in v5.1 AddOnly Adds a new WTDRule. If the object exists already a duplicate exception is thrown. Return Value Type: None 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 Access Control Point Name: Edit Introduced in v5.1 Delete Deletes the rule if exists. If it does not exist nothing happens. RuleId cannot be null Return Value Type: None Required Properties: RuleId Access Control Point Name: Edit Introduced in v5.1
1751
Chapter 2
DeleteOnly If the rule exists it will be deleted if it does not then an object key not found exception is thrown. RuleId cannot be null Return Value Type: None Required Properties: RuleId Access Control Point Name: Edit Introduced in v5.1 Retrieve Returns the Working Time Directive rule for the specified RuleId. If the rule does not exist and an Object key not found, an exception is thrown. Return Value Type: WTDRule tag Required Properties: RuleId Access Control Point Name: View Introduced in v5.1; last changed in v5.1 RetrieveAll Retrieves all Working Time Directive rules. Return Value Type: Zero or more WTDRule tags Access Control Point Name: View Introduced in v5.1; last changed in v5.1 RetrieveAllForUpdate Returns all rules for SDM update. Return Value Type: String list Access Control Point Name: View Introduced in v5.1 RetrieveAllNames Returns the names of all Working Time Directive rules. Return Value Type: String list
1752
Kronos Incorporated
WTDRule Tag
Access Control Point Name: View Introduced in v5.1; last changed in v5.1 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 Required Properties: Name Access Control Point Name: View Introduced in v5.1; last changed in v5.1 Update Updates a rule with new properties. If the rule does not exist one is created. Not Enough Room Return Value Type: None Required Properties: RuleId Optional Properties: Not Enough Room Access Control Point Name: Edit 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 Return Value Type: Boolean Required Properties: RuleId Optional Properties: Not Enough Room Access Control Point Name: Edit Introduced in v5.1
Property Descriptions
1753
Chapter 2
Description
RuleDescription
Short Description. Type: String Optional Cannot exceed 50 characters in length Sample values: "Description" Introduced in v5.1 EndNightPeriod
Report Content
Specifies if the report should contain data for everyone or just those that are in violation. Type: Integer Required cannot be null.
1754
Kronos Incorporated
WTDRule Tag
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
1755
Chapter 2
The maximum number of hours an employee should work during the night performing hazardous work. Type: Integer Optional Introduced in v5.1 MaxNightHours
1756
Kronos Incorporated
WTDRule Tag
MinAdultBreak
1757
Chapter 2
Rule Name
The name of the rule.
1758
Kronos Incorporated
WTDRule Tag
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 OffAveragePeriod
RuleId
Primary key of a rule. Type: Long Required Key Cannot be null
1759
Chapter 2
1760
Kronos Incorporated
WTDRule Tag
YoungWorkerAge
1761
Chapter 2
Syntax
Request <Request Action = Actions Parameters > Properties </Request> Actions "GetPayPeriodDates" | "Load" Parameters GetPayPeriodDates TimeFrameName = String Properties <WTKEmployee [AccrualProfileName = String] (ManagerSignoffThruDateTime = Date) (PayrollLockoutThruDateTime = Date) [DeviceGroupName = String] [PayRuleName = String] [ScheduleGroupName = String] [TimeZoneName = String] [WageProfileName = String] > <Identity> <CurrentUser> | <PersonIdentity>
1762
Kronos Incorporated
WTKEmployee Tag
</Identity> </WTKEmployee>
Action Descriptions
GetPayPeriodDates Returns the applicable pay period dates for an employee for a given time frame. Return Value Type: TimeFramePeriod tag Required Properties: Identity Access Control Point Name: View Introduced in v4; last changed in v5.0; deprecated in v5.0
Action Parameters Parameter Name TimeFrameName Required This name must be one of the pay period time frame names. Description Additional information Introduced in v4; last changed in v5.0; deprecated in v5.0
Load Returns WTKEmployee information for the specified person. Return Value Type: WTKEmployee tag Required Properties: Identity Access Control Point Name: View Introduced in v4; last changed in v5.0; deprecated in v5.0
Property Descriptions
AccrualProfileName
Accrual profile
1763
Chapter 2
The accrual profile to be used for a person or group. Accrual profiles are based on your company's accrual rules and policies that apply to similar groups of employees. The rules determine how employees accrue their time or money, or both. When an employee uses accrued time or money, specified amounts are deducted from the balance. When an employee receives or earns time or money, specified amounts are credited to the balances. Type: String Optional Maximum length: 50 characters You can find values in the Workforce Timekeeper Setup Application. Sample values: VAC and Sick Only Introduced in v4; last changed in v5.0; deprecated in v5.0. Use the property in the Person tag instead. DeviceGroupName
Device group
The name of the group of devices that the employee is authorized to use. Type: String Optional Maximum length: 50 characters You can find values in the Workforce Timekeeper Setup Application. Introduced in v4; last changed in v5.0; deprecated in v5.0. Use the property in the JobAssignmentDetails tag instead. Identity
Identity
One employee, as specified in a PersonIdentity or CurrentUser tag. Type: Either CurrentUser or PersonIdentity tag
1764
Kronos Incorporated
WTKEmployee Tag
Required Key Must uniquely identify an existing and active employee Introduced in v4; last changed in v5.0 ManagerSignoffThruDateTime
Pay rule
The name of the pay rule that is assigned to the employee. A pay rule defines the set of business standards by which persons are paid and determines how the person's time is processed and categorized. Type: String Optional Maximum length: 50 characters Required: For a new TimeKeeper user Required: When a person is tracked
1765
Chapter 2
You can find values in the Workforce Timekeeper Setup Application. Introduced in v4; last changed in v5.0; deprecated in v5.0. Use the property in the JobAssignmentDetails tag instead. ScheduleGroupName
Time zone
Contains either the ID, a five-digit value that describes how the local time for a region relates to Greenwich mean time (GMT), or the exact name of the time zone in which the person works. A value is required when a value is also specified for DeviceGroupName. If you do not specify a value, the default time zone is used. Type: String Optional Maximum length: 30 characters For a list of values, see "Time Zone Definitions" in Appendix B in the Workforce Timekeeper DTK Reference Guide. Introduced in v4; last changed in v5.0; deprecated in v5.0. Use the property in the JobAssignmentDetails tag instead. WageProfileName
Wage profile
The name of the person's wage profile
1766
Kronos Incorporated
WTKEmployee Tag
Type: String Optional Maximum length: 50 characters Introduced in v4; last changed in v5.0; deprecated in v5.0. Use the property in the JobAssignmentDetails tag instead.
1767
Chapter 2
1768
Kronos Incorporated
Index
A
Abbreviation AccrualCode tag 58 CertificationItem tag 169 WSACfgAccrualCode tag 1236 WSALaborLevel tag 1439 AbbreviationChar WSAPayCode tag 1499 AccessAssignment 33, 34, 35, 36, 37, 38, 39, 40, 41 AccessAssignmentData PersonInformation tag 648 AccessControlPointName 45 MenuItem tag 495 Permission tag 603 AccessProfile 44, 45, 46, 47, 48 AccessProfileName AccessAssignment tag 33 AccessProfile tag 46 RoleProfileKBO tag 802 AccLockoutAfter WSALogonProfile tag 1461 AccLockoutDuration WSALogonProfile tag 1461 AccLockoutSwitch WSALogonProfile tag 1461 AccountNumber CheckAdviceDetailDirectDeposit tag 179 AccrualBalances AccrualData tag 61
AccrualBalanceSummary 50, 51, 52, 53, 54, 55, 56 AccrualCode 57, 58, 59 WSAAccrualPolicy tag 1153 WSAAccrualProfile tag 1170 WSAColumnDetail tag 1271 AccrualCodeId AccrualBalanceSummary tag 50 AccrualCodeName AccrualBalanceSummary tag 50 AccrualCode tag 58 EarnedAccrual tag 248 ResetAccrual tag 795 ScheduleAccrualAmountEdit tag 853 ScheduleAccrualPattern tag 858 AccrualCodeNames BulkAccruals tag 151 AccrualData 60, 61 AccrualDetailGenieForScheduleEditorName WSADisplayProfile tag 1353 AccrualDetailGenieForTimeCardDisplayName WSADisplayProfile tag 1353 AccrualDetailGenieForTimeCardName WSADisplayProfile tag 1353 AccrualMove 64, 65, 66 AccrualOverride 359, 368, 512, 572, 582, 755, 756, 1102 AccrualPatternElement 67 AccrualPatternElements ScheduleAccrualPattern tag 858 AccrualPolicy
Index
WSAAccrualProfilePolicy tag 1172 AccrualPolicyPayCodes WSAAccrualPolicy tag 1154 AccrualProfile 68, 69 AccrualProfileId AccrualProfile tag 69 AccrualProfileName AccrualProfile tag 69 Person tag 606 WTKEmployee tag 1763 AccrualProfilePolicies WSAAccrualProfile tag 1170 AccrualQualifier WSAProbationQualifier tag 1532 AccrualQualifiers WSAGrant tag 1410 AccrualRule WSAInitialGrant tag 1430 WSASubsequentGrant tag 1652 Accruals EmployeeSummary tag 274 AccrualTotalsAccrualBalanceOnSelectedDateLa belText WSADisplayProfile tag 1354 AccrualTotalsAccrualCodeLabelText WSADisplayProfile tag 1354 AccrualTotalsAccrualUnitsLabelText WSADisplayProfile tag 1354 AccrualType AccrualBalanceSummary tag 50 AccrualViolation ScheduleHoursStatus tag 890 Action Request tag 780 ShiftHistory tag 963 ActionListSwitch ProcessTemplate tag 744 ActionName 45 Error tag 280 Permission tag 603
WSAPermission tag 1525 Active CalendarProfile tag 159 GenericEmployeeCalendar tag 330 GenericManagerCalendar tag 338 NavProfile tag 506 WorkWeek tag 1130 WSAComment tag 1284 ActiveFlag PersonAuthenticationType tag 632 PersonLicenseType tag 654 ActiveSwitch ProcessTemplate tag 744 ShiftStartTimeBand tag 973 ActualNumberOfActiveDays TimekeepingException tag 1018 Add CalendarProfile tag 157 CoverageSettings tag 197 GenericEmployeeCalendar tag 328 GenericManagerCalendar tag 336 LocationProfileSettings tag 468 Procedure tag 675 ProcedureSet tag 688 Process tag 696 ProcessorToEmployee tag 704 ProcessTemplate tag 726 SchedGenSettings tag 808 SchedRule tag 816 SchedRuleSet tag 827 Signature tag 984 WTDGlobal tag 1743 WTDRule tag 1750 AddAtTerminalFlag LaborLevelDefinition tag 446 AddBids BidGroupItem tag 133 AddComment HistoricalPayCodeEdit tag 358 HistoricalPayCodeMove tag 367
1770
Kronos Incorporated
Index
NonCancellingPayCodeEdit tag 511 OvertimeApproval tag 557 PayCodeEdit tag 571 PayCodeMove tag 581 Punch tag 753 WorkedDuration tag 1101 AddEmployees ScheduleGroup tag 872 AddEntries LaborAccountEntry tag 432 OrgSetEntry tag 550 AddGDAPItem DataAccessGroup tag 216 AddOnly BidGroup tag 126 BidGroupItem tag 133 BidRequest tag 141 CalendarProfile tag 157 CheckAdvice tag 172 CoverageSettings tag 197 DataAccessGroup tag 216 DelegateProfile tag 238 FailedXMLTransaction tag 287 GDAPAssignment tag 317 GenericEmployeeCalendar tag 328 GenericManagerCalendar tag 336 HistoricalPayCodeEdit tag 358 HistoricalPayCodeMove tag 367 ImportBatchStatus tag 410 LaborAccountSet tag 438 LaborLevelEntry tag 450 LocationProfileSettings tag 468 NonCancellingPayCodeEdit tag 511 OrgSet tag 546 PayCodeEdit tag 571 PayCodeMove tag 581 PayFromSchedule tag 593 PayFromScheduleStopEvent tag 595 Personality tag 619 Procedure tag 675
ProcedureSet tag 688 ProcessorToEmployee tag 704 Punch tag 754 RoleProfileKBO tag 800 SchedGenSettings tag 808 SchedRule tag 816 SchedRuleSet tag 827 ScheduleHours tag 880 ScheduleRuleOverride tag 919 Signature tag 984 WfcJob tag 1096 WorkedDuration tag 1101 WorkerType tag 1109 WTDGlobal tag 1743 WTDRule tag 1751 addOnly ShiftStartTimeBand tag 972 TreeNodeType tag 1058 AddOnlyWithRestrictions Punch tag 755 AddPatternElements SchedulePattern tag 900 Address EmailAddress tag 257 From tag 311 To tag 1028 AddScheduleItems Schedule tag 840 AddShiftRemovingOverlaps Schedule tag 840 AddTriggerToRule FPATrigger tag 307 AddVersionToRule FPARuleVersion tag 302 AddWithWebForm Process tag 697 Adhoc LaborAccountEntryData tag 435 AdHocLaborAccount 71, 72 Adjustments
1771
Index
WSAWageProfileLaborLevelLinkage tag 1680 AdminTemplateId Process tag 699 ProcessTemplate tag 745 AdminTemplateName ProcessTemplate tag 745 AfterHolidaySwitch WSAEligibilityDeterminer tag 1386 AfterImage AuditItem tag 102 AfterShift WSAScheduleDeviationRule tag 1579 Allocations FPATrigger tag 307 allowAdHoc 359, 368, 512, 572, 582, 755, 1102 AllowAll WSAAvailabilityPatternDAP tag 1200 WSAPatternTemplateDAP tag 1493 WSAPayCodeDAP tag 1505 WSAReportDAP tag 1556 WSAScheduleGroupDAP tag 1596 WSAShiftTemplateDAP tag 1645 WSAWorkRuleDAP tag 1700 AllowContract ScheduleGroup tag 873 AllowItemList 218, 219 AllowNewLLEntries GlsegmentDetail tag 348 AllowOverrides WSATkTerminalRule tag 1658 AllowsAll WSAFunctionAccessProfile tag 1402 AllowsInheritance ScheduleGroup tag 874 AlternateHolidayCreditRuleName WSAEligibilityDeterminer tag 1387 Amount CheckAdviceDetailDeductions tag 177 CheckAdviceDetailDirectDeposit tag 179
CheckAdviceDetailGrossPay tag 181 CheckAdviceDetailTaxes tag 184 HoursSummary tag 386 HPPDItem tag 390 HPPDSummary tag 396 PersonalOvertimeLimit tag 628 WSAAccrualPolicyGrant tag 1161 WSAAccrualPolicyLimit tag 1163 WSAAccrualQualifier tag 1174 WSABonusDeductRule tag 1206 WSAOvertimeRule tag 1487 WSAProbationQualifier tag 1532 WSASubsequentGrant tag 1652 WSAWageAdjustment tag 1673 AmountInCurrency AccrualMove tag 64 EarnedAccrual tag 247 PatternElement tag 563 ResetAccrual tag 793 ScheduleAccrualAmountEdit tag 852 ScheduleAccrualPattern tag 857 SchedulePayCodeEdit tag 907 Total tag 1033 AmountInTime AccrualMove tag 64 EarnedAccrual tag 247 OnCall tag 520 OvertimeApproval tag 558 PatternElement tag 563 ResetAccrual tag 793 ScheduleAccrualAmountEdit tag 853 ScheduleAccrualPattern tag 858 ScheduleHours tag 880 SchedulePayCodeEdit tag 907 Total tag 1034 TotaledScheduledWorkedDuration tag 1044 WorkedDuration tag 1103 AmountInTimeOrCurrency EarnedAccrual tag 248 HistoricalPayCodeEdit tag 359
1772
Kronos Incorporated
Index
HistoricalPayCodeMove tag 368 HolidayEditHours tag 378 HolidayEditWages tag 381 NonCancellingPayCodeEdit tag 512 PayCodeEdit tag 573 PayCodeMove tag 583 ResetAccrual tag 794 SchedulePayCodeEdit tag 907 TotaledScheduledPayCodeEdit tag 1037 TotaledScheduledPayCodeEditUneditable tag 1040 AmountUnits WSAWorkHistoryQualifierRule tag 1691 AmountYTD CheckAdviceDetailDeductions tag 177 CheckAdviceDetailGrossPay tag 181 AnchorDate EffectiveWorkload tag 250 ScheduleAccrualPattern tag 858 SchedulePattern tag 902 APIBeanName FailedXMLTransaction tag 288 APICallList 73, 74 APIOutsideDate 75 APIPSEEngine 76, 77 APIPunchRestrictionOverride 79, 80, 81, 82, 83 APISCGEngine 84, 85 APIStableDateSpans 86, 87 APIVolumeDataService 88, 89 AppendDurationAmount AppendShifts tag 90 AppendShift Schedule tag 840 AppendShifts 90, 91 Schedule tag 846 AppendToBeginOrEnd AppendShifts tag 90 ApplicationCalendar 93, 94 ApplicationCalendars CalendarProfile tag 159
ApplicationName ApplicationCalendar tag 93 ApplyBidNotes Bid tag 121 ApplyHour WSACreditCalculator tag 1303 ApplyOnly WSAEffectivePayRule tag 1374 ApplyPremiumToEntireShift RBSRuleVersion tag 772 ApplyToDate WSAFixedRule tag 1399 Approve ApproveSignoff tag 97 VacationBid tag 1079 ApproveAll OvertimeApproval tag 557 ApproveNone OvertimeApproval tag 557 ApproveSignoff 97, 98, 99 ApproveSome OvertimeApproval tag 557 AscendingSwitch WSAColumnDetail tag 1271 AsIfWorkedSwitch WSACreditCalculator tag 1303 AssignBreaks Schedule tag 841 AssignCoverShift RequestToCover tag 785 AssignmentRules WSAEffectivePayRule tag 1375 AssignOpenShift Schedule tag 841 AssignOpenShiftVolunteer OpenShiftVolunteer tag 525 AssociatedId AuditItem tag 103 AssociatedName AuditItem tag 103
1773
Index
AssociatedWithInPunchFlag TimekeepingException tag 1019 AtLeastSelected WSABonusDeductRule tag 1206 WSACoreHoursRule tag 1298 WSADaysOfWeek tag 1336 Attribute 100 AuditAction AuditItem tag 103 AuditBeginDtm AuditItem tag 103 AuditEndDtm AuditItem tag 104 AuditItem 102, 103, 104, 105 AuditItemChildren AuditItem tag 104 AuditItems AuditTrail tag 108 AuditTrail 107, 108, 109 AuditType AuditItem tag 104 AuditTrail tag 109 AuthenticationType 111, 112 AuthenticationTypeName PersonAuthenticationType tag 633 AuthTypeName AuthenticationType tag 112 AutoBreakPlacement WSAEffectiveWorkRule tag 1382 AvailabilityPatternName AccessAssignment tag 33 AvailabilityPatternProfileName ManagerRoleAvailabilityPatternProfile tag 479 AvailableCount LicenseType tag 461 AverageDaysMinimum WSACreditCalculator tag 1303 AverageFixedNumber WSACreditCalculator tag 1303
1304 1304
B
BadgeAssignment 114, 115, 116 BadgeAssignments PersonInformation tag 649 BadgeNumber BadgeAssignment tag 114 CurrentUser tag 207 PersonIdentity tag 641 BalanceDate AccrualData tag 61 BaseWageEffectiveDate JobAssignmentDetails tag 419 BaseWageHourly JobAssignmentDetails tag 420 Person tag 606 BaseWageRate 117, 118, 119 BatchDescription ImportBatchStatus tag 411 BatchName ImportBatchStatus tag 411 BatchProcessStatus ImportBatchStatus tag 411 BatchStatId FailedXMLTransaction tag 288 ImportBatchStatus tag 412 BatchType ImportBatchStatus tag 412 BeanName Error tag 281 BeforeHolidaySwitch WSAEligibilityDeterminer tag 1387 BeforeImage AuditItem tag 105 BeforeShift WSAScheduleDeviationRule tag 1580
1774
Kronos Incorporated
Index
BeginEarlyEnd WSATkTerminalRule tag 1659 BeginTime ScheduleZone tag 940 ShiftCountSpan tag 960 StandardShift tag 992 Bid 121, 122, 123 BidGroup 126, 127, 128, 129, 130 BidGroupId BidGroup tag 128 BidGroupItem tag 135 BidGroupItem 133, 134, 135, 136, 137 BidGroupItemId Bid tag 121 BidGroupItem tag 135 VacationBid tag 1080 BidId Bid tag 122 VacationBid tag 1080 BidList BidGroupItem tag 136 BidNote 138, 139 BidNotes Bid tag 122 VacationBid tag 1081 BidReceived BidGroupItem tag 136 BidRequest 141, 142, 143, 144, 145, 146, 147, 148, 149 BidRequestId BidGroup tag 128 BidRequest tag 144 BidSubmissionStatus BidGroupItem tag 136 BirthDate Person tag 606 BonusDeductRuleNames WSAWorkRuleGeneral tag 1703 BonusQualify WSABonusDeductRule tag 1207
BreakPayCode WTDGlobal tag 1746 BreakPayCodeName WTDGlobal tag 1746 BreakRule WSABonusDeductRule tag 1207 BreakRuleName WSABreakTime tag 1224 BreakRuleNames WSAWorkRuleGeneral tag 1703 BreaksViolate_SW WSACoreHoursRule tag 1298 BreakTimes WSAShiftLength tag 1642 BuildShifts ShiftBuilder tag 953 BulkAccruals 151, 152 BulkTotals 154, 155
C
CalendarProfile 157, 158, 159, 160 CalendarProfileAPIFacade 162, 163 CalendarProfileName WSADisplayProfile tag 1354 CallInRuleName WSAEffectiveWorkRule tag 1382 CancelDeductions 167, 168 CancelDeductRuleName Punch tag 758 CancelPFSOnHolidays WSAEffectivePayRule tag 1375 CancelTimeOff ScheduleHours tag 880 CanOverrideMinMaxSwitch WSALaborLevel tag 1440 Carryover WSAGrant tag 1410 CategoryName 718, 735, 738 LicenseType tag 461 CategoryNames
1775
Index
ProcessTemplate tag 746 CertificationItem 169, 170 CertificationNumber PersonCertificationItem tag 637 ChangeDate OrgLocationsImport tag 542 CheckAdvice 172, 173, 174, 175, 176 CheckAdviceDetailDeductions 177, 178 CheckAdviceDetailDirectDeposit 179, 180 CheckAdviceDetailGrossPay 181, 182 CheckAdviceDetailTaxes 184, 185 CheckAtLeastMin WSAAccrualQualifier tag 1175 CheckAvlbltySw WSAPayCode tag 1499 CheckDate CheckAdvice tag 172 CheckedOnRollup WSADPLaborLevelDefinition tag 1368 checkForRefrences TreeNodeType tag 1058 CheckNumber CheckAdvice tag 172 CheckRules ProcessSchedule tag 713 Schedule tag 847 CheckRuleViolations Schedule tag 841 CheckStatus PunchStatus tag 765 ChosenComponent WSAAPICombination tag 1178 City PostalAddress tag 663 ClientName DataSource tag 226 CloseDate BidGroup tag 128 Code WSAHoliday tag 1417
CodeNumber WSAComment tag 1284 ColumnDefinition WSAColumnDetail tag 1272 ColumnDefinitionDataType WSAColumnDefinition tag 1264 ColumnDefinitionDataTypeName WSAColumnDefinitionDataType tag 1268 ColumnDetail WSAAccrualDetailColumnSet tag 1149 WSADetailColumnSet tag 1344 WSALeaveCaseDetailColumnSet tag 1451 WSARollupColumnSet tag 1565 WSAScheduleAssistantColumnSet tag 1573 WSAScheduleEditorColumnSet tag 1591 WSAScheduleGroupDetailColumnSet tag 1605 WSAScheduleGroupRollupColumnSet tag 1617 WSASchedulePlannerColumnSet tag 1628 ColumnN GenieRow tag 346 ColumnNumber GenieColumn tag 344 ColumnSet WSAAccrualDetail tag 1144 WSADetail tag 1341 WSALeaveCaseDetail tag 1448 WSAQuickFind tag 1553 WSARollup tag 1562 WSAScheduleAssistant tag 1569 WSAScheduleEditor tag 1587 WSAScheduleGroupDetail tag 1600 WSAScheduleGroupRollup tag 1612 WSASchedulePlanner tag 1623 ColumnWidth WSAColumnDetail tag 1272 CombinationComponentType1 WSAAPICombination tag 1178 CombinationComponentType2
1776
Kronos Incorporated
Index
WSAAPICombination tag 1178 CombinationRule WSACFGPaycodeDistribution tag 1261 CombinationRules WSAOvertimeCombination tag 1483 WSAZoneCombinationRule tag 1724 Combinations WSAAPICombinationRule tag 1185 CombinationTowardOT WSAAPICombinationRule tag 1185 Comment 186, 187, 188 ShiftHistory tag 964 CommentCategory Comment tag 187 Comments HistoricalPayCodeEdit tag 360 HistoricalPayCodeMove tag 369 NonCancellingPayCodeEdit tag 513 OvertimeApproval tag 558 PatternElement tag 563 PayCodeEdit tag 574 PayCodeMove tag 583 Punch tag 758 ScheduleOff tag 895 SchedulePayCodeEdit tag 907 ScheduleShift tag 927 ScheduleUnavailable tag 934 TotaledScheduledPayCodeEdit tag 1038 TotaledScheduledPayCodeEditUneditable tag 1041 TransferEmployee tag 1051 WorkedDuration tag 1103 CommentText Comment tag 187 ConnectToScheduleItem tag 191 HistoricalPayCodeEdit tag 360 HistoricalPayCodeMove tag 369 NonCancellingPayCodeEdit tag 513 OvertimeApproval tag 558 PatternElement tag 564
PayCodeEdit tag 574 PayCodeMove tag 584 PayFromSchedule tag 593 PayFromScheduleStopEvent tag 596 ProcessTemplate tag 746 Punch tag 758 ScheduleOff tag 895 SchedulePayCodeEdit tag 908 ScheduleShift tag 927 ScheduleUnavailable tag 935 TotaledScheduledPayCodeEditUneditable tag 1041 WorkedDuration tag 1104 ComponentName WSAMainTab tag 1467 WSAScheduleAssistantTab tag 1577 ComponentName1 WSAAPICombination tag 1179 ComponentName2 WSAAPICombination tag 1179 ConnectToSchedule 189, 190 ConnectToScheduleItem 191, 192, 193, 194 ConnectToScheduleItems ConnectToSchedule tag 190 ConPreShifts WSAOvertimeRule tag 1487 ConsecSwitch WSAProbationQualifier tag 1533 ConsecutiveBadLogons UserAccount tag 1067 ConsecutiveDayNumber WSAZone tag 1711 ConsecutiveLastDayMinimumTime WSAZone tag 1712 ConsecutiveMinimumTime WSAZone tag 1712 ConsecutiveType WSAZone tag 1712 ContactType WSAColumnDetail tag 1272
1777
Index
ContactTypeName EmailAddress tag 257 PostalAddress tag 663 TelephoneNumber tag 1010 ContextName Procedure tag 677 ProcedureSet tag 690 SchedRule tag 818 SchedRuleContext tag 823 SchedRuleSet tag 829 ContinueToCountTO WSAAPICombinationComponent tag 1181 Contribute HPPDItem tag 390 HPPDSummary tag 396 ContributingPayCodeRuleName WSAContributingShiftRule tag 1292 ContributingShiftName WSACreditCalculator tag 1304 ContributingShiftRuleName WSAWorkHistoryQualifierRule tag 1692 ControlPointKey WSAPermission tag 1525 CoreHoursRuleNames WSAWorkRuleGeneral tag 1703 CoreSetDate WSAGrant tag 1411 Country PostalAddress tag 664 CountsTowardMaxDaysPerWeek WorkWeekDay tag 1138 CountsTowardMaxHoursPerWeek WorkWeekDay tag 1138 CountsTowardMinHoursPerWeek WorkWeekDay tag 1138 CountsTowardTargetOT WSAAPICombinationTowardOT tag 1188 CoverageSettings 197, 198, 199, 200, 201 CoverageSettingsValue 202, 203 CoverShift
ProcessSchedule tag 713 CoverShiftStatus 204, 205 CreateAdHoc AdHocLaborAccount tag 71 CreateOpenShift VacationBid tag 1081 CreditFixedAmount WSACreditCalculator tag 1304 CreditPayCodeNames WSACreditCalculator tag 1305 CreditRuleNames WSAPayRuleHoliday tag 1523 CreditWageAmount WSACreditCalculator tag 1305 CriteriaSet WSAScheduleAssistant tag 1570 CurrentDateBalance WSAAccrualPolicy tag 1154 CurrentUser 207, 208 CustomData 210, 211 WSAColumnDetail tag 1272 CustomDataList PersonInformation tag 649 CustomDataTypeName CustomData tag 210 CustomDate 212, 213 CustomDates PersonInformation tag 649 CustomDateType WSAColumnDetail tag 1273 WSADateFinder tag 1326 CustomDateTypeName CustomDate tag 212 CustomOperator 214 CustomOperators SchedRule tag 819 CustomUrlProfileName WSADisplayProfile tag 1355
1778
Kronos Incorporated
Index
DailyStatus ScheduleHoursStatus tag 890 DailyTotals Timesheet tag 1024 DataAccessGroup 216, 217, 218, 219, 220, 221 DataElementAPIFacade 222, 223 DataSetAPIFacade 224, 225 DataSetName ApplicationCalendar tag 93 GenericEmployeeCalendar tag 330 GenericManagerCalendar tag 339 DataSource 226, 227 ApproveSignoff tag 98 AuditItem tag 105 Note tag 518 Request tag 781 DataTypeName HPPDItem tag 391 HPPDSummary tag 397 Date 456, 457 AccrualMove tag 65 CancelDeductions tag 167 CheckAdviceDetailGrossPay tag 182 CoverShiftStatus tag 204 CustomDate tag 213 DateTotals tag 228 EarnedAccrual tag 248 HistoricalPayCodeEdit tag 360 HistoricalPayCodeMove tag 369 HolidayEditHours tag 378 HolidayEditWages tag 381 LockedDataCorrection tag 473 NonCancellingPayCodeEdit tag 514 OnCall tag 520 OvertimeApproval tag 559 PayCodeEdit tag 575 PayCodeMove tag 584 PayFromScheduleStopEvent tag 596 Punch tag 759 ResetAccrual tag 795
ScheduleHoursDailyStatus tag 886 ScheduleHoursStatus tag 890 TotaledScheduledPayCodeEdit tag 1038 TotaledScheduledPayCodeEditUneditable tag 1041 TotaledScheduledWorkedDuration tag 1045 WorkedDuration tag 1104 WorkWeekDay tag 1137 WSACustomDate tag 1315 DATE_TIME_SPAN OpenShiftItem tag 523 DateFinder WSADatePattern tag 1330 DateFinderType WSADateFinder tag 1326 DatePattern WSAAccrualPolicy tag 1154 WSAGrant tag 1411 WSALimit tag 1456 WSAProbationPeriod tag 1529 DateSpan AuditTrail tag 108 DateTime ServerTime tag 944 ShiftHistory tag 964 DateTimeSpan AuditTrail tag 108 Holiday tag 377 RequestToCoverItem tag 790 ShiftHistory tag 964 DateTotals 228 DayDivide WSAPayPeriod tag 1517 DayDivideOverride WSAEffectiveWorkRule tag 1383 DayDurationDisplaySwitch WSADisplayProfile tag 1355 DaylightSavingsFlag Punch tag 759 PunchStatus tag 765
1779
Index
DayMonthSpan WSALimit tag 1457 DayNumber AccrualPatternElement tag 67 PatternElement tag 564 DayOfInterval WSADateFinder tag 1326 DayOfWeek Headcount tag 353 WorkWeekDay tag 1137 DayOvertimeLimitPayCodeName WSAHolidayCreditRule tag 1422 DayOvertimeLimitType WSAHolidayCreditRule tag 1422 Days WSAContributingShiftRule tag 1293 DaysOfWeek WSAZone tag 1713 DaysOfWeekIncludeType WSAContributingShiftRule tag 1293 DaysOfWeekZonesAppliesType WSAZone tag 1713 Deductions CheckAdvice tag 173 DeductionsList CheckAdvice tag 173 DeductRule 230, 231 DeductRuleName DeductRule tag 231 DefaultAttendanceTab WSADisplayProfile tag 1355 DefaultHyperfindQuery WSAAccrualDetail tag 1144 WSADetail tag 1341 WSALeaveCaseDetail tag 1448 WSARollup tag 1562 WSAScheduleAssistant tag 1570 WSAScheduleEditor tag 1587 WSAScheduleGroupDetail tag 1600 WSAScheduleGroupRollup tag 1612
WSASchedulePlanner tag 1624 DefaultMainTab WSAScheduleEditor tag 1587 WSASchedulePlanner tag 1624 DefaultScheduleAssistantTab WSASchedulePlanner tag 1624 DefaultSwitch GDAPAssignment tag 320 DefaultTimePeriod WSAAccrualDetail tag 1145 WSADetail tag 1341 WSALeaveCaseDetail tag 1448 WSAQuickFind tag 1553 WSARollup tag 1562 WSAScheduleEditor tag 1587 WSAScheduleGroupDetail tag 1600 WSAScheduleGroupRollup tag 1612 WSASchedulePlanner tag 1624 DefinedHolidayZone WSACreditCalculator tag 1305 DelegateAuthorityTask 233, 234, 235, 236 DelegateProfile 238, 239, 240, 241 DelegateProfileName AccessAssignment tag 34 Delegates DelegateProfile tag 241 delegatorFullName SwitchRoleEngine tag 1005 delegatorPersonNum SwitchRoleEngine tag 1005 Delete BidGroup tag 126 BidGroupItem tag 133 BidRequest tag 141 CalendarProfile tag 157 CoverageSettings tag 197 DataAccessGroup tag 216 DelegateProfile tag 238 EmployeeMessage tag 268 EmployeePreferredZone tag 271
1780
Kronos Incorporated
Index
FailedXMLTransaction tag 287 FPARule tag 298 GDAPAssignment tag 317 GenericEmployeeCalendar tag 328 GenericManagerCalendar tag 336 HistoricalPayCodeEdit tag 359 HistoricalPayCodeMove tag 368 LocationProfileSettings tag 468 NavProfile tag 505 NonCancellingPayCodeEdit tag 512 PayCodeEdit tag 572 PayCodeMove tag 582 PayFromSchedule tag 593 PayFromScheduleStopEvent tag 596 Personality tag 619 Procedure tag 675 ProcedureSet tag 688 ProcessorToEmployee tag 704 Punch tag 756 RBSRule tag 768 RoleProfileKBO tag 800 SchedGenSettings tag 808 SchedRule tag 816 SchedRuleSet tag 827 Schedule tag 842 ScheduleAccrualPattern tag 857 ScheduleGroup tag 872 SchedulePattern tag 900 SchedulePeriod tag 915 ScheduleRuleOverride tag 919 ShiftCode tag 957 Signature tag 984 WfcJob tag 1096 WorkedDuration tag 1102 WorkerType tag 1109 WorkWeek tag 1128 WorkWeekAssignments tag 1133 WSAAccrualDetail tag 1143 WSAAccrualDetailColumnSet tag 1148 WSAAccrualPolicy tag 1152
WSAAccrualProfile tag 1169 WSAAPICombinationRule tag 1184 WSADatePattern tag 1329 WSADisplayProfile tag 1351 WSAGrant tag 1409 WSAHoliday tag 1416 WSALimit tag 1455 WSATkTerminalRule tag 1657 WTDGlobal tag 1744 WTDRule tag 1751 delete TreeNodeType tag 1058 DeleteAllGDAPItem DataAccessGroup tag 217 DeleteBidNotes Bid tag 121 Deleted WSACfgContactType tag 1239 WSACfgCustomData tag 1245 DeleteGDAPItem DataAccessGroup tag 217 DeleteOnly CoverageSettings tag 198 LocationProfileSettings tag 469 Personality tag 619 Procedure tag 675 ProcedureSet tag 688 Process tag 698 ProcessTemplate tag 727 SchedGenSettings tag 809 SchedRule tag 817 SchedRuleSet tag 828 Signature tag 984 WTDGlobal tag 1744 WTDRule tag 1752 deleteOnly ShiftStartTimeBand tag 972 DeletePatterns Schedule tag 842 Depth
1781
Index
MenuItem tag 495 Description AccessProfile tag 47 BidGroup tag 129 BidRequest tag 144 CalendarProfile tag 160 CheckAdviceDetailDeductions tag 178 CheckAdviceDetailDirectDeposit tag 180 CheckAdviceDetailGrossPay tag 182 CheckAdviceDetailTaxes tag 184 CoverageSettings tag 199 DataAccessGroup tag 220 DelegateProfile tag 241 FPARuleVersion tag 303 GenericEmployeeCalendar tag 331 GenericManagerCalendar tag 339 HyperFindQuery tag 402 LaborAccount tag 430 LaborAccountSet tag 439 LaborLevelEntry tag 452 LocationProfileSettings tag 470 ManagerRoleAvailabilityPatternProfile tag 479 ManagerRoleScheduleGroupProfile tag 482 ManagerRoleSchedulePatternProfile tag 485 ManagerRoleShiftCodeProfile tag 488 NavProfile tag 507 OrgLocation tag 536 OrgSet tag 547 Procedure tag 677 ProcedureSet tag 691 RBSRuleVersion tag 773 RoleProfileKBO tag 803 SchedGenSettings tag 810 SchedRule tag 819 SchedRuleSet tag 830 SchedulePattern tag 902 SchedulePeriod tag 916 SettingsType tag 951 ShiftCode tag 958
TreeNodeType tag 1059 WeekDay tag 1090 WorkflowTemplateCategory tag 1119 WorkWeek tag 1131 WSAAccrualDetail tag 1145 WSAAccrualDetailColumnSet tag 1149 WSAAPICombinationComponent tag 1181 WSAAvailabilityPatternDAP tag 1201 WSACfgCustomData tag 1245 WSACoreHoursRule tag 1298 WSACriteriaSet tag 1311 WSACustomUrlProfile tag 1322 WSADetail tag 1341 WSADetailColumnSet tag 1345 WSADisplayProfile tag 1355 WSAFunctionAccessProfile tag 1403 WSAGenie tag 1406 WSALaborLevelEntry tag 1443 WSALeaveCaseDetail tag 1448 WSALeaveCaseDetailColumnSet tag 1452 WSALogonProfile tag 1462 WSAOrganizationType tag 1477 WSAPatternTemplateDAP tag 1494 WSAPayCodeDAP tag 1506 WSAQuickFind tag 1553 WSAReportDAP tag 1557 WSARollup tag 1562 WSARollupColumnSet tag 1566 WSAScheduleAssistant tag 1570 WSAScheduleAssistantColumnSet tag 1574 WSAScheduleEditor tag 1588 WSAScheduleEditorColumnSet tag 1592 WSAScheduleGroupDAP tag 1596 WSAScheduleGroupDetail tag 1601 WSAScheduleGroupDetailColumnSet tag 1605 WSAScheduleGroupRollup tag 1613 WSAScheduleGroupRollupColumnSet tag 1617 WSASchedulePlanner tag 1625
1782
Kronos Incorporated
Index
WSASchedulePlannerColumnSet tag 1629 WSAShiftTemplateDAP tag 1646 WSATreeType tag 1667 WSAULLE tag 1671 WSAWorkforceGenieProfile tag 1687 WSAWorkRuleDAP tag 1701 WTDRule tag 1754 Descriptions LaborAccountEntryData tag 435 DetailErrors Error tag 281 DetailsSummary ScheduleRuleOverride tag 920 Deviation WSAPayDistributionAssociation tag 1514 Deviations WSAPayCodeDistribution tag 1508 DeviceGroup 243, 244 DeviceGroupId DeviceGroup tag 244 DeviceGroupName DeviceGroup tag 244 JobAssignmentDetails tag 420 WTKEmployee tag 1764 DifferenceToLimit TimekeepingException tag 1019 DirectDepositList CheckAdvice tag 173 DisallowAmount WSAAccrualPolicyTakingLimit tag 1166 DisallowIfMissingPunches WSASignOffRestriction tag 1649 DisallowIfUnexcusedAbsences WSASignOffRestriction tag 1650 DisallowIfZeroHours WSASignOffRestriction tag 1650 Display WSAAccrualProfilePolicy tag 1172 WSACfgAccrualCode tag 1237
DisplayAccrualsInScheduleEditorLegacyDisplay Switch WSADisplayProfile tag 1356 DisplayAccrualsOnScheduleSwitch WSADisplayProfile tag 1356 DisplayAccrualsOnTimeCardLegacySwitch WSADisplayProfile tag 1356 DisplayAccrualsOnTimeCardReportingPeriodS witch WSADisplayProfile tag 1356 DisplayAccrualsOnTimeCardSwitch WSADisplayProfile tag 1357 DisplayAccrualsTotalsBalancesInMainTimeCard ViewSwitch WSADisplayProfile tag 1357 DisplayDescription WSAAccrualDetail tag 1145 WSAAccrualDetailColumnSet tag 1149 WSACustomUrlProfile tag 1323 WSADetail tag 1342 WSADetailColumnSet tag 1345 WSADisplayProfile tag 1357 WSAGenie tag 1406 WSALeaveCaseDetail tag 1449 WSALeaveCaseDetailColumnSet tag 1452 WSAQuickFind tag 1553 WSARollup tag 1563 WSARollupColumnSet tag 1566 WSAScheduleAssistant tag 1570 WSAScheduleAssistantColumnSet tag 1574 WSAScheduleEditor tag 1588 WSAScheduleEditorColumnSet tag 1592 WSAScheduleGroupDetail tag 1601 WSAScheduleGroupDetailColumnSet tag 1605 WSAScheduleGroupRollup tag 1613 WSAScheduleGroupRollupColumnSet tag 1617 WSASchedulePlanner tag 1625 WSASchedulePlannerColumnSet tag 1629
1783
Index
WSAWorkforceGenieProfile tag 1688 DisplayFormatSwitch WSADisplayProfile tag 1357 DisplayName GenericEmployeeCalendar tag 331 GenericManagerCalendar tag 339 ProcessTemplate tag 746 ShiftStartTimeBand tag 974 WSAAccrualDetail tag 1145 WSAAccrualDetailColumnSet tag 1150 WSAColumnDefinition tag 1264 WSAColumnDetail tag 1273 WSACustomUrl tag 1319 WSACustomUrlProfile tag 1323 WSADetail tag 1342 WSADetailColumnSet tag 1345 WSADisplayProfile tag 1358 WSAGenie tag 1407 WSAHoliday tag 1417 WSALeaveCaseDetail tag 1449 WSALeaveCaseDetailColumnSet tag 1452 WSAOrganizationType tag 1477 WSAQuickFind tag 1554 WSARollup tag 1563 WSARollupColumnSet tag 1566 WSAScheduleAssistant tag 1571 WSAScheduleAssistantColumnSet tag 1574 WSAScheduleEditor tag 1588 WSAScheduleEditorColumnSet tag 1592 WSAScheduleGroupDetail tag 1601 WSAScheduleGroupDetailColumnSet tag 1606 WSAScheduleGroupRollup tag 1613 WSAScheduleGroupRollupColumnSet tag 1618 WSASchedulePlanner tag 1625 WSASchedulePlannerColumnSet tag 1629 WSAWorkforceGenieProfile tag 1688 DisplayOrder PayCode tag 567
DisplayOrderNumber WSAOrganizationType tag 1478 DisplayTime PatternElement tag 564 ScheduleHours tag 881 SchedulePayCodeEdit tag 908 DisplayTimecardEditorTotalsSwitch WSADisplayProfile tag 1358 DisplayType AccrualCode tag 58 Distribution WSAPayCodeDistribution tag 1509 DistributionAssignments WSACFGPaycodeDistribution tag 1261 DoFirstList WSAProcessingOrderRule tag 1535 WSASequencerRule tag 1634 DoLastList WSAProcessingOrderRule tag 1536 WSASequencerRule tag 1635 Duplicate DataAccessGroup tag 217 DelegateProfile tag 238 RoleProfileKBO tag 800 Duration ConnectToScheduleItem tag 192 DurationDisplaySwitch WSADisplayProfile tag 1358 DurationOfException TimekeepingException tag 1019
E
EarlyInOverrideFlag APIPunchRestrictionOverride tag EarlyOutRestrictionFlag APIPunchRestrictionOverride tag EarlyScheduleMargin WSACallInRule tag 1230 WSATkTerminalRule tag 1659 EarlyStart 79 80
1784
Kronos Incorporated
Index
WSATkTerminalRule tag 1659 EarlyStartBreakMargin WSATkTerminalRule tag 1660 EarnedAccrual 247, 248, 249 EchoData 359, 368, 512, 572, 582, 755, 756, 757, 1102 EditAffShfTotal WSAPayCode tag 1499 EditCntToCdotSw WSAPayCode tag 1499 EditCntToOt WSAPayCode tag 1500 EditExcuseAbsn WSAPayCode tag 1500 EditFutureTimecardsSwitch WSADisplayProfile tag 1358 EditScheduleItems Schedule tag 842 EffectiveDate AppendShifts tag 91 BadgeAssignment tag 115 BaseWageRate tag 118 EffectiveWorkload tag 251 EmployeeGroupItem tag 263 EmploymentStatus tag 277 GDAPAssignment tag 320 HomeAccount tag 384 HPPDItem tag 391 OptOutStatus tag 530 OrgSetEntry tag 550 PersonAccessAssignment tag 615 PersonalOvertimeAssignment tag 624 PersonCertificationItem tag 638 PersonSkillItem tag 661 PrimaryLaborAccount tag 670 ProcessorToEmployee tag 707 ProcessTemplate tag 746 ScheduleRuleOverride tag 920 TransferEmployee tag 1051 TransferJobSeniorityDate tag 1055
UserAccountStatus tag 1075 WSACombinedPayCodeRule tag 1279 WSAEffectivePayRule tag 1375 WSAEffectiveWorkRule tag 1383 EffectiveDateSpan GroupMembership tag 351 SchedulePattern tag 902 EffectiveDateTime PasswordHistory tag 561 UserAccountLockout tag 1072 EffectivePayRules WSAPayRule tag 1520 EffectiveWorkload 250, 251, 252, 253 EffectiveWorkRules WSAWorkRule tag 1697 EitherBeforeOrAfterHolidaySwitch WSAEligibilityDeterminer tag 1387 EligibilityWorkHistoryQualifierNames WSAEligibilityDeterminer tag 1387 EligibleJobs 254, 255, 256 EmailAddress 257 EMailAddresses PersonInformation tag 649 EMailAdress WSACfgContactType tag 1240 Employee AccrualData tag 61 ApproveSignoff tag 99 CancelDeductions tag 167 CheckAdvice tag 174 EarnedAccrual tag 249 EligibleJobs tag 255 EmployeeSummary tag 275 GroupMembership tag 351 HistoricalPayCodeEdit tag 361 HistoricalPayCodeMove tag 370 LockedDataCorrection tag 474 MarkForTotalization tag 491 NonCancellingPayCodeEdit tag 514 OnCall tag 521
1785
Index
OpenShiftVolunteer tag 525 OvertimeApproval tag 559 PayCodeEdit tag 575 PayCodeMove tag 584 PayFromSchedule tag 594 PayFromScheduleStopEvent tag 597 PersonShiftTemplateAssignment tag 657 Punch tag 759 PunchStatus tag 765 RequestToCover tag 786 ResetAccrual tag 795 ScheduleAccrualAmountEdit tag 853 ScheduleHours tag 881 ScheduleOff tag 896 SchedulePattern tag 903 SchedulePayCodeEdit tag 908 ScheduleShift tag 928 ScheduleShiftSwap tag 932 ScheduleUnavailable tag 935 ShiftHistory tag 963 ShiftTemplateItem tag 978 ShiftValidation tag 981 SwapShiftEmployees tag 999 SwapShiftJobs tag 1002 Timesheet tag 1024 TotaledScheduledWorkedDuration tag 1045 WorkedDuration tag 1104 EmployeeGroupAssign 260, 261 EmployeeGroupItem 262, 263 EmployeeGroupItems EmployeeGroupAssign tag 260 EmployeeGroupProfile 265, 266 EmployeeGroupProfileId EmployeeGroupProfile tag 265 EmployeeGroupProfileName EmployeeGroupProfile tag 266 EmployeeId ConnectToScheduleItem tag 192 ScheduleRuleOverride tag 920 WTDEmployeeAssignment tag 1739
EmployeeKey CurrentUser tag 207 PersonIdentity tag 642 EmployeeMessage 268, 269, 270 EmployeePaid CheckAdviceDetailDeductions tag 178 EmployeePaidYTD CheckAdviceDetailDeductions tag 178 EmployeePreferredZone 271, 272, 273 EmployeeRuleSetItems RuleSetEmployeeAssign tag 805 EmployeeRuleSets WorkWeekAssignments tag 1135 Employees BulkAccruals tag 151 BulkTotals tag 154 EmployeeGroupAssign tag 260 PersonCertificationAssign tag 635 PersonSkillAssign tag 659 ProcessSchedule tag 714 RequestToCover tag 786 RuleSetEmployeeAssign tag 805 Schedule tag 847 ScheduleAccrualPattern tag 859 EmployeeStandardHours Person tag 607 EmployeeSummary 274, 275 BulkAccruals tag 152 BulkTotals tag 154 EmployeeWorkflowProfileName WorkflowAccessAssignment tag 1115 EmploymentStatus 277, 278, 279 EmploymentStatusList PersonInformation tag 650 EmploymentStatusName EmploymentStatus tag 277 EncodedName WSALaborLevel tag 1440 WSALaborLevelEntry tag 1444 EncumberedBalanceInCurrency
1786
Kronos Incorporated
Index
AccrualBalanceSummary tag 50 EncumberedBalanceInTime AccrualBalanceSummary tag 51 EndAmount WSAProbationPeriod tag 1529 EndDate 74, 77, 85, 1129 CheckAdvice tag 174 DelegateAuthorityTask tag 233 EligibleJobs tag 255 EmployeeGroupItem tag 262 PayFromSchedule tag 594 ProcessTask tag 719 ScheduleShiftSwap tag 933 ScheduleUnavailable tag 935 VacationBid tag 1082 WSAHoliday tag 1417 WSAHolidayDate tag 1425 EndDay WSADayMonthSpan tag 1333 EndDayNumber ShiftSegment tag 966 EndEffectiveDate FPARuleVersion tag 303 OrgLocation tag 537 EndMonth WSADayMonthSpan tag 1333 EndNightPeriod WTDRule tag 1754 EndNumberOfDay WSAZone tag 1714 endSeparatorCharacter GlsegmentDetail tag 348 EndTime ScheduleShiftSwap tag 933 ScheduleUnavailable tag 936 ScheduleZone tag 940 ShiftCountSpan tag 960 ShiftSegment tag 967 ShiftValidation tag 981 StandardShift tag 992
SwapShiftEmployees tag 999 SwapShiftJobs tag 1002 WSABreakRule tag 1218 WSACoreHoursRule tag 1298 WSAHoliday tag 1417 WSAHolidayDate tag 1425 WSAZone tag 1714 EndWorkAfterTime WSAZone tag 1714 EndWorkAfterTimeSwitch WSAZone tag 1715 EndWorkBeforeTime WSAZone tag 1715 EndWorkBeforeTimeSwitch WSAZone tag 1715 EnforceBreaks WSATkTerminalRule tag 1660 EnteredOnDate HistoricalPayCodeEdit tag 361 HistoricalPayCodeMove tag 370 NonCancellingPayCodeEdit tag 514 OvertimeApproval tag 559 PayCodeEdit tag 575 PayCodeMove tag 585 Punch tag 760 TotaledScheduledPayCodeEdit tag 1038 TotaledScheduledPayCodeEditUneditable tag 1042 WorkedDuration tag 1105 EnteredOnDtm AuditItem tag 105 EnteredOnTime HistoricalPayCodeEdit tag 361 HistoricalPayCodeMove tag 370 NonCancellingPayCodeEdit tag 515 OvertimeApproval tag 559 PayCodeEdit tag 576 PayCodeMove tag 585 Punch tag 760 TotaledScheduledPayCodeEdit tag 1038
1787
Index
TotaledScheduledPayCodeEditUneditable tag 1042 WorkedDuration tag 1105 Entries LaborAccountEntryData tag 436 EntryList LaborAccountSet tag 439 OrgSet tag 547 EqualIntervalUse WSAMajorityRule tag 1469 Error 280, 281, 282, 283 ErrorCode Error tag 281 FailedXMLTransaction tag 288 ErrorData Error tag 281 ErrorRecordNumber FailedXMLTransaction tag 289 ErrorText FailedXMLTransaction tag 289 ImportBatchStatus tag 412 EvaluationRuleTypeID WSACriteriaSet tag 1311 Exception ScheduleHoursStatus tag 890 ExceptionRuleName WSAEffectiveWorkRule tag 1383 Exceptions TotaledScheduledWorkedDuration tag 1045 TotaledSpan tag 1047 WorkedDuration tag 1105 ExceptionsOnly WTDRule tag 1754 ExceptionType WSAColumnDetail tag 1273 ExceptionTypeName TimekeepingException tag 1020 ExcludedHours WTDRule tag 1755 ExcludedPayCode
WTDGlobal tag 1746 ExcludedPayCodeName WTDGlobal tag 1747 ExcuseAbsenceFlag PayCode tag 567 ExitNum GenieColumn tag 344 ExpansionMarginsEarlyTime WSAZone tag 1716 ExpansionMarginsLateTime WSAZone tag 1716 ExpectedHours 284 WSADatePattern tag 1330 ExpectedHoursList PersonInformation tag 650 ExpirationDate BadgeAssignment tag 115 BaseWageRate tag 118 EffectiveWorkload tag 251 EmployeeGroupItem tag 262 EmploymentStatus tag 278 GDAPAssignment tag 320 HomeAccount tag 384 OptOutStatus tag 531 PersonAccessAssignment tag 615 PersonalOvertimeAssignment tag 624 PersonCertificationItem tag 638 PersonSkillItem tag 661 PrimaryLaborAccount tag 670 ProcessorToEmployee tag 707 ProcessTemplate tag 747 ScheduleRuleOverride tag 920 UserAccountStatus tag 1075 ExpirationDateTime APIPunchRestrictionOverride tag 80 ExpireNow GDAPAssignment tag 317 ExpireToAccrual WSAAccrualPolicyGrant tag 1161 WSAInitialGrant tag 1430
1788
Kronos Incorporated
Index
WSASubsequentGrant tag 1653 ExtensionNames WSAWorkRulePCDistr tag 1706 ExtensionProcessorComponents WSACFGDistributionAssignment tag 1251 ExtensionProcessorNames WSAEffectivePayRule tag 1376 WSAEffectiveWorkRule tag 1383 ExtentionProcessorName WSACFGExtProcessorComponent tag 1254 ExteriorItemNumber WSAAccrualDetailColumnSet tag 1150 WSAColumnDefinition tag 1265 WSAColumnDefinitionDataType tag 1268 WSADetailColumnSet tag 1345 WSALeaveCaseDetailColumnSet tag 1452 WSARollupColumnSet tag 1566 WSAScheduleAssistantColumnSet tag 1574 WSAScheduleEditorColumnSet tag 1592 WSAScheduleGroupDetailColumnSet tag 1606 WSAScheduleGroupRollupColumnSet tag 1618 WSASchedulePlannerColumnSet tag 1629 ExteriorName WSAAccrualDetailColumnSet tag 1150 WSAColumnDefinition tag 1265 WSAColumnDefinitionDataType tag 1269 WSADetailColumnSet tag 1346 WSALeaveCaseDetailColumnSet tag 1453 WSARollupColumnSet tag 1567 WSAScheduleAssistantColumnSet tag 1575 WSAScheduleEditorColumnSet tag 1593 WSAScheduleGroupDetailColumnSet tag 1606 WSAScheduleGroupRollupColumnSet tag 1618 WSASchedulePlannerColumnSet tag 1630 ExternalFlag MenuItem tag 496
1411
F
FailedRecordCount ImportBatchStatus tag 413 FailedXMLTransaction 287, 288, 289, 290, 291, 292 FailureURL Request tag 781 FieldDefinitionName AdHocLaborAccount tag 72 FillCharacter GlsegmentDetail tag 349 FillPosition GlsegmentDetail tag 349 FilterQueryName PersonIdentity tag 643 FingerRequiredFlag Person tag 607 FirstDayOfWeek WTDRule tag 1755 FirstName Person tag 608 FixedRuleName WSAEffectivePayRule tag 1376 ForgivenBalance WSALimit tag 1457 FPAAllocation 294, 295 FPARule 298, 299, 301 FPARuleVersion 302, 303, 304 FPARuleVersions FPARule tag 299 FPATrigger 307, 308, 309 Friday WSAAssignmentRule tag 1191 WSABonusDeductRule tag 1207 WSACoreHoursRule tag 1299 WSADaysOfWeek tag 1336 WSAShiftGuarantee tag 1638
1789
Index
From 311, 312 FromLaborAccountName HistoricalPayCodeMove tag 370 PayCodeMove tag 585 FromPayCodeName HistoricalPayCodeMove tag 371 PayCodeMove tag 586 FullName HyperFindResult tag 406 Person tag 608 FullPath OrgJob tag 535 FullTimePercentage Person tag 608 FullTimeStandardHours Person tag 609 FunctionAccessProfile 314, 315 FunctionAccessProfileId FunctionAccessProfile tag 314 FunctionAccessProfileName FunctionAccessProfile tag 315 FunctionalAreaCode DataSource tag 226 FutureOverdraftError WSAAccrualPolicy tag 1155 FutureOverdraftWarning WSAAccrualPolicy tag 1155
G
GDAPAssignment 317, 318, 319, 320, 321, 322 GDAPAssignmentDefaultSwitch 323, 324 GDAPAssignments Personality tag 620 GDAPItem 325 GDAPItemList DataAccessGroup tag 221 GDAPItemType 218, 219 GDAPName GDAPAssignment tag 320 GDAPAssignmentDefaultSwitch tag 324
GenerateAudit ProcedureSetItem tag 693 GenericEmployeeCalendar 328, 329, 330, 331, 332 GenericEmployeeCalendarAPIFacade 333, 334 GenericEmployeeCalendarNames CalendarProfile tag 160 GenericManagerCalendar 336, 337, 338, 339, 340, 341 GenericManagerCalendarAPIFacade 342, 343 GenericManagerCalendarNames CalendarProfile tag 160 GenieColumn 344, 345 GenieColumns WFCGenie tag 1092 GenieItemIndicator WSANavbarCategory tag 1473 GenieName WFCGenie tag 1093 GenieRow 346 GenieRows WFCGenie tag 1093 Genies WSAWorkforceGenieProfile tag 1688 GeniesUrls WSACustomUrlProfile tag 1323 GenieType WFCGenie tag 1093 GetCountByLaborLevelWithFilter LaborLevelEntry tag 450 GetCountsByLaborLevel LaborLevelEntry tag 450 GetGDAPItemTypeList DataAccessGroup tag 217 GetHiddenActions 731, 735, 738 GetNumberOfLaborLevels LaborLevelDefinition tag 446 GetOpenShiftsForJob OpenShiftVolunteer tag 525 GetOutsideDates
1790
Kronos Incorporated
Index
WorkWeek tag 1128 GetPayPeriodDates WTKEmployee tag 1763 GetQueryCount HyperFindQuery tag 402 GetServerTime ServerTime tag 943 GivingEmployee AccrualMove tag 65 GivingEmployeeAccrualCodeName AccrualMove tag 65 GlsegmentDetail 348, 349, 350 TreeNodeType tag 1060 Grace WSACreditCalculator tag 1305 WSAIntervalRoundRule tag 1435 GranRule WSAInitialGrant tag 1431 GrantOnce WSAGrant tag 1412 GrantRule WSAAccrualPolicyGrant tag 1162 WSAAccrualPolicyLimit tag 1164 WSASubsequentGrant tag 1653 Grants WSAAccrualPolicy tag 1155 GrantType WSAGrant tag 1412 Granularity WSAAccrualPolicy tag 1155 GrossPay CheckAdvice tag 174 GrossPayList CheckAdvice tag 174 GroupEditOverride WSAAccrualPolicy tag 1156 Grouping ScheduleCostSummary tag 866 GroupMembership 351 GroupMemberships
ScheduleGroup tag 874 GroupScheduleName AccessAssignment tag 34 GroupScheduleProfileName BidRequest tag 144
H
HasPersonalOvertimeFlag JobAssignment tag 416 HasTransferToCallback WSACallInRule tag 1230 HasTransferToRegular WSACallInRule tag 1230 HazardousWorker WTDEmployeeAssignment tag 1740 Headcount 353, 354 HeadcountPattern 355, 356 HeadcountPatterns EffectiveWorkload tag 251 Headcounts HeadcountPattern tag 355 HireDate Person tag 610 HistoricalDate HistoricalPayCodeEdit tag 361 HistoricalPayCodeMove tag 371 HistoricalPayCodeEdit 358, 359, 360, 361, 362, 363, 364 HistoricalPayCodeMove 367, 368, 369, 370, 371, 372, 373 Holiday 376, 377 HolidayCreditRuleName WSAEffectivePayRule tag 1376 HolidayDeduct WSACreditCalculator tag 1306 HolidayDeductTypeId WSAZone tag 1716 HolidayEditHours 378, 379 HolidayEditWages 381, 382 HolidayName
1791
Index
HolidayEditHours tag 379 HolidayEditWages tag 382 WSAPayRuleHoliday tag 1523 HolidayPolicyTypeId WSAZone tag 1717 Holidays WSAEffectivePayRule tag 1376 HomeAccount 384, 385 HomeAccounts PersonInformation tag 650 HomePagePath NavProfile tag 507 HourlyRate BaseWageRate tag 119 Hours CheckAdviceDetailGrossPay tag 182 ScheduleCostPaycode tag 862 HoursPerDay AccrualBalanceSummary tag 51 AccrualCode tag 59 VacationBid tag 1082 WSACfgAccrualCode tag 1237 HoursSummary 386, 387 HoursSummaryService 388, 389 HPPDItem 390, 391 HPPDService 393, 394, 395 HPPDSummary 396, 397, 398 HPPDSummaryService 399, 400 HyperFindQuery 402, 403, 404 HyperFindQueryId GenericManagerCalendar tag 339 HyperFindQueryName HyperFindQuery tag 403 WFCGenie tag 1094 HyperfindQueryTypeID WSAHyperfindQuery tag 1428 HyperFindResult 406, 407
I
Id
WorkflowTemplateCategory tag 1119 WTDEmployeeAssignment tag 1740 WTDGlobal tag 1747 Identity BadgeAssignment tag 115 BaseWageRate tag 119 EmploymentStatus tag 278 GDAPAssignment tag 321 JobAssignment tag 416 PersonAccessAssignment tag 616 Personality tag 621 PersonalOvertimeAssignment tag 625 PersonInformation tag 651 PrimaryLaborAccount tag 671 User tag 1065 UserAccountStatus tag 1076 WFCGenie tag 1094 WorkflowAccessAssignment tag 1116 WTKEmployee tag 1764 ImpactsAccrualsFlag HistoricalPayCodeEdit tag 362 HistoricalPayCodeMove tag 371 ImportBatchStatus 410, 411, 412, 413 ImportOverride WSAAccrualPolicy tag 1156 In OptOutStatus tag 531 Inactive WSALaborLevelEntry tag 1444 InactiveFlag LaborLevelEntry tag 452 InActiveSw WfcJob tag 1097 InactivityTimeOut WSALogonProfile tag 1462 InactivityTimeOutSwitch WSALogonProfile tag 1462 IncludeDeducts WSAMajorityRule tag 1470 IncludedPayCode
1792
Kronos Incorporated
Index
WTDGlobal tag 1747 IncludedPayCodeName WTDGlobal tag 1747 IncludePunchedBreaks WSAMajorityRule tag 1470 IncludeRegular WSAMajorityRule tag 1471 IncludeTemplateData 729, 732, 736, 739, 741, 742, 744 Increment WSAGrant tag 1412 IncrementAmount WSAGrant tag 1413 IndependentProductSw SuiteProduct tag 995 InEarly WSAExceptionRule tag 1392 Info ShiftHistory tag 964 InitialValue WSAInitialGrant tag 1431 InLate WSAExceptionRule tag 1393 InPunch TotaledSpan tag 1048 InPunchEarlyChangePoint WSAPunchRoundRule tag 1539 InPunchEarlyInsideGrace WSAPunchRoundRule tag 1539 InPunchEarlyInsideRound WSAPunchRoundRule tag 1540 InPunchEarlyOutsideGrace WSAPunchRoundRule tag 1540 InPunchEarlyOutsideRound WSAPunchRoundRule tag 1541 InPunchLateChangePoint WSAPunchRoundRule tag 1541 InPunchLateInsideGrace WSAPunchRoundRule tag 1541 InPunchLateInsideRound
WSAPunchRoundRule tag 1542 InPunchLateOutsideGrace WSAPunchRoundRule tag 1542 InPunchLateOutsideRound WSAPunchRoundRule tag 1543 InPunchOption RBSRuleVersion tag 773 InPunchType WSAColumnDetail tag 1273 InstalledSw SuiteProduct tag 995 Interval WSAAccrualQualifier tag 1175 WSADatePattern tag 1330 WSAGrant tag 1413 WSALimit tag 1457 InUseCount LicenseType tag 462 InVeryEarly WSAExceptionRule tag 1393 InWinEtime WSABonusDeductRule tag 1207 InWinStime WSABonusDeductRule tag 1208 IsActive CertificationItem tag 169 PersonSkillItem tag 662 WorkerTypeElement tag 1112 IsAllDays ScheduleHours tag 881 IsAllowAll ManagerRoleAvailabilityPatternProfile tag 479 ManagerRoleScheduleGroupProfile tag 482 ManagerRoleSchedulePatternProfile tag 485 ManagerRoleShiftCodeProfile tag 488 IsBeyondMinimunHours MinimunHoursNoModification tag 499 IsCallbackDeducted WSACallInRule tag 1231
1793
Index
IsCanceledInTimecard WSABonusDeductRule tag 1208 IsCheckRules OpenShiftVolunteer tag 526 RequestToCover tag 786 ScheduleHours tag 882 IsCombinedFlag PayCode tag 567 IsCreateOpenShift ScheduleHours tag 882 IsCurrencyFlag HolidayEditHours tag 379 HolidayEditWages tag 382 NonCancellingPayCodeEdit tag 515 PayCode tag 568 PayCodeEdit tag 576 Total tag 1034 TotaledScheduledPayCodeEdit tag 1039 TotaledScheduledPayCodeEditUneditable tag 1042 IsDefault WSAFunctionAccessProfile tag 1403 WSALogonProfile tag 1463 IsDefaultSwitch WSADisplayProfile tag 1359 WSAOrganizationType tag 1478 WSATreeType tag 1667 IsDeleted ScheduleAccrualAmountEdit tag 854 ScheduleOff tag 896 SchedulePayCodeEdit tag 909 ScheduleShift tag 928 ScheduleUnavailable tag 936 isDeleted ScheduleZone tag 941 IsForeverPattern Schedule tag 847 ScheduleAccrualPattern tag 859 IsGuaranteedAsSumOfShifts WSACallInRule tag 1231
IsLockedFlag ScheduleUnavailable tag 936 IsMissedOutException WSAIntervalRoundRule tag 1436 WSAPunchRoundRule tag 1543 IsMoneyCategory WSAPayCode tag 1500 IsOnlyActualAmountDeducted WSACallInRule tag 1231 IsOpenShift Schedule tag 847 ScheduleOff tag 896 ScheduleShift tag 928 IsOverride ScheduleHours tag 882 SchedulePayCodeEdit tag 909 IsOverrideAccrual SchedulePayCodeEdit tag 909 IsOverrideConflict ScheduleGroup tag 874 IsOverridePayCodes WSAOvertimeRule tag 1487 IsPaidBothRegularAndCallback WSACallInRule tag 1232 IsPartialOverride SchedulePayCodeEdit tag 910 IsPayCodeEditCreated ScheduleHoursDailyStatus tag 886 IsPermitted AccessProfile tag 44 IsRestIntervalContinuous RBSRuleVersion tag 773 IsSaveData OpenShiftVolunteer tag 526 RequestToCover tag 787 ScheduleHours tag 883 IsSeparateShift WSACallInRule tag 1232 IsShiftCovered CoverShiftStatus tag 204
1794
Kronos Incorporated
Index
IsShiftExists CoverShiftStatus tag 205 RequestToCover tag 787 ShiftValidation tag 981 IsShiftRestriction WSABonusDeductRule tag 1208 IsTemplateFlag SchedulePattern tag 903 IsVisibleFlag PayCode tag 568 Item WSACombinationRule tag 1277 ItemName WSAZoneCombinationSpecificationRule tag 1727 Items HPPDService tag 394
KeyName WSAZoneCombinationSpecificationRule tag 1727 KeyNames 1008 KProcessUniqueKey Process tag 700 ProcessTemplate tag 747 Kronos_WFC 424, 425 KronosTimeZone Punch tag 760 PunchStatus tag 765 ServerTime tag 944 KTimeZone 426, 427, 428 KTimeZoneId KTimeZone tag 427 KTimeZoneName KTimeZone tag 428
J
JavaClass WSAColumnDefinition tag 1265 JobAssignment 416, 417, 418 JobAssignmentData Personality tag 621 JobAssignmentDetails 419, 420, 421, 422, 423 JobAssignmentDetailsData JobAssignment tag 417 JobCode FPATrigger tag 308 WfcJob tag 1097 JobCodeEffectiveDate FPATrigger tag 308 JobTitle WfcJob tag 1097
L
Label GenieColumn tag 345 MenuItem tag 496 ScheduleCostPaycode tag 862 ScheduleCostResult tag 864 ShiftCode tag 958 LabelName WSACfgContactType tag 1240 WSACfgCustomData tag 1246 LabelNumber WSACfgContactType tag 1240 WSACfgCustomData tag 1246 LaborAccount 429, 430, 431 LaborAccountAndJobTransfers WSAEffectivePayRule tag 1377 LaborAccountDescription Total tag 1034 LaborAccountEntry 432, 433 LaborAccountEntryData 435, 436 LaborAccountId Total tag 1034
K
Key SimplePair tag 988 SystemSettings tag 1008 WSACombinationRule tag
1277
1795
Index
LaborAccountName AdHocLaborAccount tag 72 AppendShifts tag 91 ConnectToScheduleItem tag 192 FPAAllocation tag 294 HistoricalPayCodeEdit tag 362 HistoricalPayCodeMove tag 372 HomeAccount tag 385 LaborAccount tag 431 NonCancellingPayCodeEdit tag 515 OnCall tag 521 PayCodeEdit tag 576 PayCodeMove tag 586 PrimaryLaborAccount tag 671 Punch tag 761 PunchStatus tag 766 SchedulePayCodeEdit tag 910 ShiftSegment tag 967 Total tag 1035 TotaledScheduledPayCodeEdit tag 1039 TotaledScheduledPayCodeEditUneditable tag 1042 TotaledScheduledWorkedDuration tag 1046 TotaledSpan tag 1048 TransferEmployee tag 1052 WorkedDuration tag 1105 LaborAccountPattern FPATrigger tag 309 LaborAccountSet 438, 439, 440, 441 LaborAccountSetKey LaborAccountSet tag 440 LaborAccountSetName LaborAccountSet tag 440 LaborAccountSetProfile 442, 443 LaborAccountSetProfileId LaborAccountSetProfile tag 443 LaborAccountSetProfileName LaborAccountSetProfile tag 443 LaborAccountSetTypeName LaborAccountSet tag 440
LaborLevel WSARollupColumnSet tag 1567 LaborLevelDefinition 446, 447, 448 WSAColumnDetail tag 1274 LaborLevelDefinitionName 450, 451 LaborAccountEntry tag 433 LaborAccountEntryData tag 436 LaborLevelDefinition tag 446 LaborLevelEntry tag 453 LaborLevelEntries LaborAccount tag 431 LaborLevelEntry 450, 451, 452, 453, 454 LaborLevelEntryName LaborLevelEntry tag 453 WSAWageAdjustment tag 1673 LaborLevelEntryWildcard WSAWageAdjustment tag 1673 LaborLevelName GlsegmentDetail tag 349 WSAWageAdjustment tag 1674 WSAWageProfileLaborLevelLinkage tag 1680 LaborLevelNames WSADisplayProfile tag 1359 LaborLevelSwitches WSADisplayProfile tag 1359 LanguageCD WSAOrganizationType tag 1478 WSATreeType tag 1668 LastDeployed ProcessTemplate tag 748 LastName Person tag 610 LastSubmitted BidGroupItem tag 137 LastTotalizationDateTime Timesheet tag 1025 LateEnd WSATkTerminalRule tag 1660 LateEndBreakMargin
1796
Kronos Incorporated
Index
WSATkTerminalRule tag 1660 LateEndMargin WSATkTerminalRule tag 1661 LateInRestrictionFlag APIPunchRestrictionOverride tag 80 LateOutRestrictionFlag APIPunchRestrictionOverride tag 81 LateScheduleMargin WSATkTerminalRule tag 1661 LateStart WSATkTerminalRule tag 1661 LateStartBreakMargin WSATkTerminalRule tag 1662 LaunchHistory 456, 457, 458, 459 LeafNodeSupportSwitch WSATreeType tag 1668 LeafNodeSwitch WSAOrganizationType tag 1478 LegacyAccrualsTabLabelOnTimeCard WSADisplayProfile tag 1359 LegacyHomePage NavProfile tag 507 Length WSAPayPeriod tag 1517 WSAShiftLength tag 1642 WSAShiftLengthExclusion tag 1643 LengthOfService WSAAccrualPolicyGrant tag 1162 WSAAccrualPolicyLimit tag 1164 LicensedSw SuiteProduct tag 996 LicenseType 461, 462, 463 LicenseTypeName LicenseType tag 462 PersonLicenseType tag 654 LiftEarlyEnd WSATkTerminalRule tag 1662 LightWeightPerson 464 LimitCount LicenseType tag 463
Limits WSAAccrualPolicy tag 1156 LimitType WSALimit tag 1457 ListOrder WSADispOrdOptionalRule tag 1366 WSAOptionalRule tag 1475 LLEDesc WfcJob tag 1098 LLEName WfcJob tag 1098 LLEntryName OrgLocation tag 537 Load AccessProfile tag 45 AccrualData tag 60 AccrualProfile tag 68 BidGroup tag 126 BidGroupItem tag 134 BidRequest tag 142 DeviceGroup tag 243 EmployeeGroupAssign tag 260 EmployeeGroupProfile tag 265 EmployeeMessage tag 268 EmployeePreferredZone tag 272 FailedXMLTransaction tag 287 FunctionAccessProfile tag 314 GDAPAssignment tag 318 Holiday tag 376 JobAssignment tag 416 KTimeZone tag 426 LaborAccount tag 429 LaborAccountSet tag 438 LaborAccountSetProfile tag 442 LaborLevelEntry tag 451 LicenseType tag 461 LogonProfile tag 475 ManagerRoleAvailabilityPatternProfile tag 478 ManagerRoleScheduleGroupProfile tag
481
1797
Index
ManagerRoleSchedulePatternProfile tag 484 ManagerRoleShiftCodeProfile tag 487 Menu tag 493 MinimunHoursNoModification tag 499 OrgSet tag 546 PayCodeProfile tag 590 PayRuleProfile tag 599 Personality tag 620 PersonalOvertimeAssignment tag 624 PersonInformation tag 647 PersonShiftTemplateAssignment tag 656 PreferenceProfile tag 666 ProcessProfile tag 710 ProjectingOvertime tag 750 ReportProfile tag 777 RuleSetEmployeeAssign tag 804 Schedule tag 842 ScheduleGroup tag 872 ScheduleGroupProfile tag 876, 877 SchedulePattern tag 900 SchedulePeriod tag 915 ShiftCode tag 957 ShiftTemplateAssignment tag 976 ShiftValidation tag 980 SystemSettings tag 1008 TimeEntry tag 1012 Timesheet tag 1023 TransferJobSeniorityDate tag 1054 TypeOverride tag 1062 User tag 1065 VacationBid tag 1079 WageProfile tag 1086 WeekDay tag 1089 WFCGenie tag 1092 WorkerType tag 1109 WorkflowAccessAssignment tag 1115 WorkRuleProfile tag 1125 WTKEmployee tag 1763 load OrgDirect_IndirectPct tag 534
LoadAccruals BulkAccruals tag 151 LoadActiveComments Comment tag 186 LoadAll EligibleJobs tag 254 ManagerRoleAvailabilityPatternProfile tag 479 ManagerRoleScheduleGroupProfile tag 482 ManagerRoleSchedulePatternProfile tag 485 ManagerRoleShiftCodeProfile tag 488 PersonCertificationAssign tag 635 PersonSkillAssign tag 659 ShiftTemplateAssignment tag 977 SuiteProduct tag 994 WeekDay tag 1090 WorkerType tag 1109 LoadAllAccessControlPointNames AccessProfile tag 46 LoadAllAccrualCodes AccrualCode tag 57 LoadAllAccrualProfiles AccrualProfile tag 69 LoadAllActionNames AccessProfile tag 46 LoadAllBadgeAssignments PersonInformation tag 647 LoadAllBatchNames ImportBatchStatus tag 410 LoadAllDeductRules DeductRule tag 230 LoadAllDefinitions LaborLevelDefinition tag 446 LoadAllDeviceGroups DeviceGroup tag 244 LoadAllEmployeeGroupProfiles EmployeeGroupProfile tag 265 LoadAllEmploymentStatus PersonInformation tag 648 LoadAllFunctionAccessProfiles
1798
Kronos Incorporated
Index
FunctionAccessProfile tag 314 LoadAllGenies WFCGenie tag 1092 LoadAllGroups ScheduleGroup tag 872 LoadAllHolidaysInSpan Holiday tag 377 LoadAllHomeAccounts PersonInformation tag 648 LoadAllJobSeniorityDates TransferJobSeniorityDate tag 1055 LoadAllKTimeZones KTimeZone tag 427 LoadAllLaborAccountSetProfiles LaborAccountSetProfile tag 443 LoadAllLogonProfiles LogonProfile tag 476 LoadAllMessages EmployeeMessage tag 268 LoadAllowedPermissions AccessProfile tag 46 LoadAllPatterns SchedulePattern tag 901 LoadAllPayCodeProfiles PayCodeProfile tag 590 LoadAllPayCodes PayCode tag 567 LoadAllPayRuleProfiles PayRuleProfile tag 599 LoadAllPeriods SchedulePeriod tag 915 LoadAllPreferenceProfiles PreferenceProfile tag 667 LoadAllProcessProfiles ProcessProfile tag 710 LoadAllQueries HyperFindQuery tag 402 LoadAllReportProfiles ReportProfile tag 778 LoadAllScheduleGroupProfiles
ScheduleGroupProfile tag 877 LoadAllShiftCodes ShiftCode tag 957 LoadAllSuiteProductNames AccessProfile tag 46 LoadAllTimeEntries TimeEntry tag 1013 LoadAllTimeFrames TimeFramePeriod tag 1015 LoadAllUserAccountStatus PersonInformation tag 648 LoadAllWageProfiles WageProfile tag 1087 LoadAllWorkRuleProfiles WorkRuleProfile tag 1125 LoadAllWorkRules WorkRule tag 1122 LoadAssignable LicenseType tag 461 LoadBadgeAssignments BadgeAssignment tag 114 LoadBaseWageRateHistory BaseWageRate tag 117 LoadByBidGroupAndPerson BidGroupItem tag 134 LoadByBidGroupItem VacationBid tag 1079 LoadByBidRequest BidGroup tag 127 LoadById AccrualProfile tag 69 DeviceGroup tag 244 EmployeeGroupProfile tag 265 FunctionAccessProfile tag 314 KTimeZone tag 427 LaborAccountSetProfile tag 443 LogonProfile tag 476 PayCodeProfile tag 590 PayRuleProfile tag 599 PreferenceProfile tag 667
1799
Index
ProcessProfile tag 710 ReportProfile tag 778 ScheduleGroupProfile tag 877 TimeEntry tag 1013 WageProfile tag 1087 WorkRuleProfile tag 1125 LoadByManager BidRequest tag 142 LoadByName SuiteProduct tag 995 WfcJob tag 1096 LoadByWildcard LaborLevelEntry tag 451 LoadCertificationAssignments PersonCertificationAssign tag 635 LoadCommentCategories Comment tag 187 LoadDailyTotals Timesheet tag 1023 LoadDateRange TimeFramePeriod tag 1016 LoadEligibleEmployees RequestToCover tag 785 SwapShiftEmployees tag 999 LoadEmploymentStatuses EmploymentStatus tag 277 LoadIdentities CurrentUser tag 207 PersonIdentity tag 641 LoadJobLocations OrgMapIntegration tag 543 LoadJobs SwapShiftJobs tag 1002 LoadLaborAccountData LaborAccountSet tag 438 LoadLaborAccountUpdatedData LaborAccountSet tag 438 LoadMetadata WFCGenie tag 1092 LoadPayCodesForProfileName
PayCodeProfile tag 590 LoadPayCodeTotals BulkTotals tag 154 LoadPeriodTotals Timesheet tag 1024 LoadPersonAccessAssignments PersonAccessAssignment tag 615 LoadPopulatedThroughDate ShiftBuilder tag 954 LoadPrimaryLaborAccounts PrimaryLaborAccount tag 670 LoadShifts RequestToCover tag 785 LoadSkillAssignments PersonSkillAssign tag 659 LoadTemplatePatterns SchedulePattern tag 901 LoadUserAccount User tag 1065 LoadUserAccountStatuses UserAccountStatus tag 1075 LocationId 466 LocationItems EligibleJobs tag 255 LocationName OrgLocation tag 538 LocationNum OrgLocation tag 538 LocationOrgNodePath TransferJobSeniorityDate tag 1056 LocationProfileSettings 468, 469, 470, 471, 472 Locations APIStableDateSpans tag 87 APIVolumeDataService tag 89 HoursSummaryService tag 389 HPPDSummaryService tag 400 ProcessTask tag 719 ProjectingOvertime tag 751 Schedule tag 848 ScheduleCoverage tag 870
1800
Kronos Incorporated
Index
LocationType OrgLocation tag 538 Locator WSABonusDeductRule tag 1209 LocatorAtOrAfter WSABonusDeductRule tag 1209 LocatorBefore WSABonusDeductRule tag 1210 LockDays Schedule tag 843 LockedDataCorrection 473, 474 LockoutReasonName UserAccountLockout tag 1072 LockoutResetDateTime UserAccount tag 1068 LockShifts Schedule tag 843 LogonProfile 475, 476, 477 LogonProfileId LogonProfile tag 476 LogonProfileName LogonProfile tag 477 UserAccount tag 1068 LongChgPoint WSABreakRule tag 1218 LongDescription WSAHyperfindQuery tag 1428 LongException WSABreakRule tag 1218 LongGrace WSABreakRule tag 1219 LongInterval WSAExceptionRule tag 1393 LongName WSACfgContactType tag 1240 LongRound WSABreakRule tag 1219 LookbackDuration RBSRuleVersion tag 774 LookBackTime
1294 1294
M
MajorityRuleName WSAOptionalRule tag 1475 MajorityRuleNames WSAWorkRulePCDistr tag 1706 Manager BidRequest tag 145 ManagerAccessFlag PayCode tag 568 ManagerAccessOrganizationSetName PersonAccessAssignment tag 616 ManagerAccessSetName AccessAssignment tag 35 ManagerHasAccessFlag WorkRule tag 1122 ManagerName CancelDeductions tag 167 NonCancellingPayCodeEdit tag 516 PayCodeEdit tag 577 PayCodeMove tag 587 Punch tag 761 ManagerPayCodeName AccessAssignment tag 35 ManagerRoleAvailabilityPatternProfile 478, 479 ManagerRoleScheduleGroupProfile 481, 482 ManagerRoleSchedulePatternProfile 484, 485 ManagerRoleShiftCodeProfile 487, 488 ManagerSignoffDateTime Timesheet tag 1025 ManagerSignoffThruDateTime Person tag 611 WTKEmployee tag 1765 ManagerTransferOrganizationSetName PersonAccessAssignment tag 616 ManagerTransferSetName
1801
Index
AccessAssignment tag 36 ManagerViewPayCodeName AccessAssignment tag 36 ManagerWorkflowProfileName WorkflowAccessAssignment tag 1116 ManagerWorkRuleName AccessAssignment tag 37 ManualEdit WSACfgAccrualCode tag 1237 MarkForTotalization 490, 491 MaxAdultWork WTDRule tag 1755 MaxAmount WSACreditCalculator tag 1306 MaxBids BidRequest tag 145 MaxHazardousNightHours WTDRule tag 1755 MaximumOnCall WSACallInRule tag 1232 MaximumOut WSATkTerminalRule tag 1662 MaximumShiftLength WSATkTerminalRule tag 1663 MaxLength WSABreakRule tag 1219 MaxLimit WSALimit tag 1458 MaxNameLength LaborLevelDefinition tag 447 WSALaborLevel tag 1440 MaxNightHours WTDRule tag 1756 MaxPoolSize ProcessTemplate tag 748 MaxRestPremiumDuration RBSRuleVersion tag 774 MaxStart WSABreakTime tag 1224 MaxStartTimeForBreak
WSAAutoBreakPlacement tag 1197 MaxTakings WSAAccrualPolicy tag 1157 MaxWeeklyHours WTDRule tag 1756 MaxYoungWork WTDRule tag 1756 MediumGrace WSABreakRule tag 1219 MediumRound WSABreakRule tag 1220 Menu 493, 494 MenuItem 495, 496, 497 MenuItemName MenuItem tag 496 MenuItems Menu tag 494 Message Error tag 282 Response tag 797 MessageSubject EmployeeMessage tag 269 MgrId DelegateAuthorityTask tag 234 MgrName DelegateAuthorityTask tag 234 MiddleInitial Person tag 611 MilestoneNumber WSASubsequentGrant tag 1653 MinAdultBreak WTDRule tag 1757 MinAdultDailyRest WTDRule tag 1757 MinAdultWeeklyRest WTDRule tag 1757 Minimum WSAOvertimeRule tag 1487 MinimumAmount PersonalOvertimeLimit tag 628
1802
Kronos Incorporated
Index
MinimumBreakRestrictionFlag APIPunchRestrictionOverride tag 81 MinimumHoursWithinShift WSAZone tag 1718 MinimumHoursWithinZone WSAZone tag 1718 MinimumMeal WSATkTerminalRule tag 1663 MinimumNumberOfActiveDays TimekeepingException tag 1020 MinimumShiftLength WSAContributingShiftRule tag 1294 MinimumTimeActiveUnit WSAEligibilityDeterminer tag 1388 MinimumTimeActiveValue WSAEligibilityDeterminer tag 1388 MinimumTimeEmployedUnit WSAEligibilityDeterminer tag 1388 MinimumTimeEmployedValue WSAEligibilityDeterminer tag 1389 MinimumToQualify WSACallInRule tag 1233 MinimunHoursNoModification 499, 500 MinimunHoursRequired MinimunHoursNoModification tag 499 MinNameLength LaborLevelDefinition tag 447 WSALaborLevel tag 1441 MinPercentNightHours WTDRule tag 1757 MinRestPremiumDuration RBSRuleVersion tag 774 MinShiftLengthDuration RBSRuleVersion tag 774 MinStart WSABreakTime tag 1224 MinStartTimeForBreak WSAAutoBreakPlacement tag 1197 MinTakings WSAAccrualPolicy tag 1157
MinTimeBetweenBreaks WSAAutoBreakPlacement tag 1197 MinYoungBreak WTDRule tag 1758 MinYoungDailyRest WTDRule tag 1758 MinYoungWeeklyRest WTDRule tag 1758 MissedOutDateTime TimekeepingException tag 1020 Monday WSAAssignmentRule tag 1191 WSABonusDeductRule tag 1210 WSACoreHoursRule tag 1299 WSADaysOfWeek tag 1336 WSAShiftGuarantee tag 1638 MoneyCategory WSACombinedPayCodeRule tag 1280 MonthOfInterval WSADateFinder tag 1327 MonthWidth ApplicationCalendar tag 94 GenericEmployeeCalendar tag 331 GenericManagerCalendar tag 340 MustSatisfyAllSwitch WSAEligibilityDeterminer tag 1389
N
Name 239 Attribute tag 100 BidGroup tag 129 BidRequest tag 146 CalendarProfile tag 160 CalendarProfileAPIFacade tag 163 CertificationItem tag 170 DataAccessGroup tag 221 DataElementAPIFacade tag 223 DataSetAPIFacade tag 225 DelegateProfile tag 241 EmployeeGroupItem tag 263
1803
Index
FPARule tag 301 GDAPItem tag 325 GenericEmployeeCalendar tag 331 GenericEmployeeCalendarAPIFacade tag 334 GenericManagerCalendar tag 340 GenericManagerCalendarAPIFacade tag 343 Holiday tag 377 LightWeightPerson tag 464 NavProfile tag 508 OrgSet tag 548 OrgSetEntry tag 551 PersonCertificationItem tag 638 PersonSkillItem tag 662 RBSRule tag 770 RoleProfileKBO tag 803 ScheduleRuleOverride tag 921 SettingsParamValue tag 948 ShiftStartTimeBand tag 974 TreeNodeType tag 1060 WeekDay tag 1090 WorkerType tag 1110 WorkflowTemplateCategory tag 1119 WorkWeek tag 1131 WSAAccrualCode tag 1141 WSAAccrualDetail tag 1146 WSAAccrualDetailColumnSet tag 1150 WSAAccrualPolicy tag 1157 WSAAccrualPolicyTakingLimit tag 1167 WSAAccrualProfile tag 1171 WSAAPICombinationComponent tag 1181 WSAAPICombinationRule tag 1185 WSAAutoBreakPlacement tag 1198 WSAAvailabilityPatternDAP tag 1201 WSAAvailabilityPatternProfileItem tag 1203 WSABonusDeductRule tag 1210 WSABreakRule tag 1220 WSABreakTime tag 1224 WSACalendarProfile tag 1227
WSACallInRule tag 1233 WSACfgAccrualCode tag 1237 WSACfgContactType tag 1241 WSACfgContactTypeList tag 1243 WSACfgCustomData tag 1246 WSACfgCustomDataList tag 1248 WSACFGPaycodeDistribution tag 1261 WSAColumnDefinition tag 1265 WSACombinedPayCodeRule tag 1280 WSACommentType tag 1287 WSAContributingPayCodeRule tag 1289 WSAContributingShiftRule tag 1294 WSACoreHoursRule tag 1299 WSACriteriaSet tag 1311 WSACustomDate tag 1315 WSACustomUrlProfile tag 1323 WSADatePattern tag 1331 WSADetail tag 1342 WSADetailColumnSet tag 1346 WSADisplayOrder tag 1348 WSADisplayProfile tag 1360 WSADisplayProfileWorkforceGenieProfile tag 1364 WSADispOrdOptionalRule tag 1366 WSADPLaborLevelDefinition tag 1368 WSADPPayCode tag 1370 WSADPTimePeriod tag 1372 WSAEffectivePayRule tag 1377 WSAEffectiveWorkRule tag 1384 WSAExceptionRule tag 1394 WSAFixedRule tag 1400 WSAFunctionAccessProfile tag 1403 WSAGenie tag 1407 WSAGrant tag 1413 WSAHoliday tag 1418 WSAHolidayCreditRule tag 1422 WSAHyperfindQuery tag 1429 WSAIntervalRoundRule tag 1436 WSALeaveCaseDetail tag 1449 WSALeaveCaseDetailColumnSet tag 1453
1804
Kronos Incorporated
Index
WSALimit tag 1458 WSALogonProfile tag 1463 WSAMainTab tag 1467 WSAMajorityRule tag 1471 WSANavbarCategory tag 1473 WSAOptionalRule tag 1475 WSAOrganizationType tag 1479 WSAOvertimeCombination tag 1484 WSAOvertimeRule tag 1488 WSAPatternTemplateDAP tag 1494 WSAPatternTemplateProfileItem tag 1496 WSAPayCode tag 1500 WSAPayCodeDAP tag 1506 WSAPayCodeDistribution tag 1509 WSAPayCodeProfileItem tag 1512 WSAPayDistributionAssociation tag 1514 WSAPayRule tag 1521 WSAProbationPeriod tag 1529 WSAProcessingOrderRule tag 1536 WSAPunchRoundRule tag 1543 WSAQuickFind tag 1554 WSAReportDAP tag 1557 WSAReportProfileItem tag 1559 WSARollup tag 1563 WSARollupColumnSet tag 1567 WSAScheduleAssistant tag 1571 WSAScheduleAssistantColumnSet tag 1575 WSAScheduleAssistantTab tag 1577 WSAScheduleDeviationRule tag 1580 WSAScheduledHoursType tag 1583 WSAScheduleEditor tag 1588 WSAScheduleEditorColumnSet tag 1593 WSAScheduleGroupDAP tag 1596 WSAScheduleGroupDetail tag 1601 WSAScheduleGroupDetailColumnSet tag 1606 WSAScheduleGroupProfileItem tag 1609 WSAScheduleGroupRollup tag 1613 WSAScheduleGroupRollupColumnSet tag 1618
WSASchedulePeriod tag 1621 WSASchedulePlanner tag 1626 WSASchedulePlannerColumnSet tag 1630 WSASequencedItem tag 1632 WSASequencerRule tag 1635 WSAShiftGuarantee tag 1638 WSAShiftLength tag 1642 WSAShiftTemplateDAP tag 1646 WSAShiftTemplateProfileItem tag 1647 WSASignOffRestriction tag 1650 WSATkTerminalRule tag 1663 WSATreeType tag 1668 WSAULLE tag 1671 WSAWageProfile tag 1676 WSAWageProfilePayCode tag 1682 WSAWfgColumnSet tag 1684 WSAWorkforceGenieProfile tag 1688 WSAWorkHistoryQualifierRule tag 1692 WSAWorkloadPlannerProfile tag 1695 WSAWorkRule tag 1698 WSAWorkRuleDAP tag 1701 WSAWorkRuleGeneral tag 1703 WSAWorkRulePCDistr tag 1706 WSAWorkRuleProfileItem tag 1709 WSAZoneCombinationRule tag 1725 WSAZoneCombinationZoneRule tag 1729 WSAZoneRule tag 1731 WSAZoneRuleHoliday tag 1734 WSAZoneRuleLimit tag 1736 WTDEmployeeAssignment tag 1740 WTDGlobal tag 1748 WTDRule tag 1758 NameList 501 Names 503 NameList tag 501 NavBar WSACustomUrl tag 1320 NavbarCategory WSAAccrualDetail tag 1146 WSADetail tag 1342
1805
Index
WSAGenie tag 1407 WSALeaveCaseDetail tag 1449 WSAQuickFind tag 1554 WSARollup tag 1563 WSAScheduleEditor tag 1589 WSAScheduleGroupDetail tag 1602 WSAScheduleGroupRollup tag 1614 WSASchedulePlanner tag 1626 NavBarCategoryId GenericManagerCalendar tag 340 NavProfile 505, 506, 507, 508 NavProfileName WSADisplayProfile tag 1360 NetPay CheckAdvice tag 175 NewName 220, 240, 241, 802, 1130, 1314, 1456 LaborAccountSet tag 441 LaborLevelEntry tag 454 ScheduleZone tag 941 ShiftStartTimeBand tag 974 TreeNodeType tag 1060 WorkerTypeElement tag 1112 NewShift ShiftHistory tag 965 NewShiftOverrideFlag WorkedDuration tag 1106 NodeId LocationId tag 466 OrgJob tag 535 NonCancellingPayCodeEdit 511, 512, 513, 514, 515, 516, 517 Note 518, 519 Notes Comment tag 188 ConnectToScheduleItem tag 192 HistoricalPayCodeEdit tag 363 HistoricalPayCodeMove tag 373 NonCancellingPayCodeEdit tag 516 PayCodeEdit tag 577
PayCodeMove tag 587 Punch tag 762 ScheduleOff tag 897 SchedulePayCodeEdit tag 911 ScheduleShift tag 929 ScheduleUnavailable tag 937 WorkedDuration tag 1106 NotificationDate BidRequest tag 146 NotificationText BidGroup tag 129 NotScheduled WSAScheduleDeviationRule tag 1580 NumberOfDay WSAZone tag 1718 NumberOfFutureDays WSADisplayProfile tag 1360 NumberOfIterations WTDRule tag 1759 NumberOfStaffs Headcount tag 354 NumberOfWorkedDays TimekeepingException tag 1020 numIntervals WSAInterval tag 1433 NumToCheck WSAAccrualQualifier tag 1175
O
Object Request tag 781 OffAveragePeriod WTDRule tag 1759 OffsetAmount WSADatePattern tag 1331 OffsetDateName WSADatePattern tag 1331 OldCertificationNumber PersonCertificationItem tag 638 OldEffectiveDate
1806
Kronos Incorporated
Index
PersonCertificationItem tag 639 OldExpirationDate PersonCertificationItem tag 639 OnCall 520, 521 OnCallLocator WSACallInRule tag 1233 OnCallWorkRule WSACallInRule tag 1233 OnError Request tag 781 OnHolidaySwitch WSAEligibilityDeterminer tag 1389 OpenDate BidGroup tag 130 OpenShiftItem 523 OpenShiftItems OpenShiftVolunteer tag 526 Schedule tag 848 OpenShiftVolunteer 525, 526, 527, 528 OperatorName CustomOperator tag 214 SchedRuleOperator tag 825 OptionSetName 85 OptOutStatus 530, 531 OptOutStatuses OptOutStatusList tag 532 WTDEmployeeAssignment tag 1741 OptOutStatusList 532 OrderNum WSAAssignmentRule tag 1191 WSABreakTime tag 1225 WSACustomUrl tag 1320 WSAGenie tag 1407 OrganizationPath PrimaryLaborAccount tag 672 OrganizationType WSAColumnDetail tag 1274 OrgDirect_IndirectPct 534 OrgId OrgSetEntry tag 551
OrgJob 535 OrgJobDescription Total tag 1035 OrgJobId NonCancellingPayCodeEdit tag 513 OrgSetJob tag 552 PayCodeEdit tag 573 PayCodeMove tag 582 Punch tag 757 Total tag 1035 WorkedDuration tag 1103 OrgJobLocation ScheduleMarkPosted tag 893 OrgJobName NonCancellingPayCodeEdit tag 513 OrgSetJob tag 552 PayCodeEdit tag 573 PayCodeMove tag 583 Punch tag 757 Total tag 1035 WorkedDuration tag 1102 OrgJobPath AppendShifts tag 91 ConnectToScheduleItem tag 193 EffectiveWorkload tag 251 OpenShiftVolunteer tag 527 Schedule tag 848 SchedulePayCodeEdit tag 911 ScheduleShift tag 929 ShiftHistory tag 963 ShiftSegment tag 967 TransferEmployee tag 1052 OrgJobPaths RequestToCoverItem tag 790 Schedule tag 849 OrgJobs SwapShiftJobs tag 1002 OrgLocation 536, 537, 538, 539, 540 OrgLocations OrgLocationsImport tag 542
1807
Index
OrgLocationsImport 541, 542 OrgMapIntegration 543, 544 OrgPath HoursSummary tag 386 HPPDItem tag 391 HPPDService tag 394 HPPDSummary tag 397 orgPath 203 OrgPaths CoverageSettings tag 200 LocationProfileSettings tag 471 SchedGenSettings tag 811 SchedGenSettingsValue tag 814 OrgSet 546, 547, 548, 549 OrgSetEntry 550, 551 OrgSetId OrgSet tag 548 OrgSetJob 552 OrgSetJobList OrgSet tag 548 OrgSetName OrgSet tag 548 OrgSetTypeName OrgSet tag 549 OrgWorkAllocationEntry 554 OrgWorkAllocationEntryList OrgLocation tag 539 OrgWorkPct OrgWorkAllocationEntry tag 554 OrgWorkTypeName OrgWorkAllocationEntry tag 554 OriginalEffectiveDate GDAPAssignment tag 321 OriginalExpirationDate GDAPAssignment tag 321 Originator WorkflowTemplateCategory tag 1119 OutEarly WSAExceptionRule tag 1394 OutLate
WSAExceptionRule tag 1394 OutPunch TotaledSpan tag 1048 OutPunchEarlyChangePoint WSAPunchRoundRule tag 1544 OutPunchEarlyInsideGrace WSAPunchRoundRule tag 1544 OutPunchEarlyInsideRound WSAPunchRoundRule tag 1545 OutPunchEarlyOutsideGrace WSAPunchRoundRule tag 1545 OutPunchEarlyOutsideRound WSAPunchRoundRule tag 1545 OutPunchLateChangePoint WSAPunchRoundRule tag 1546 OutPunchLateInsideGrace WSAPunchRoundRule tag 1546 OutPunchLateInsideRound WSAPunchRoundRule tag 1547 OutPunchLateOutsideGrace WSAPunchRoundRule tag 1547 OutPunchLateOutsideRound WSAPunchRoundRule tag 1547 OutPunchOption RBSRuleVersion tag 775 OutsideDate APIOutsideDate tag 75 OutVeryLate WSAExceptionRule tag 1395 OverdraftError WSAAccrualPolicy tag 1157 OverdraftWarning WSAAccrualPolicy tag 1158 OverflowAccrualCode WSAAccrualPolicy tag 1158 OverrideAccrualDays NonCancellingPayCodeEdit tag 516 PayCodeEdit tag 577 OverrideDisplayName WSAColumnDetail tag 1274
1808
Kronos Incorporated
Index
OverrideFlag LaborLevelDefinition tag 447 OverrideIfHomeSwitch WSAWageProfile tag 1677 OverridePayCodes WSAOvertimeRule tag 1488 OverrideRuleName TypeOverride tag 1063 OverrideTypeName Punch tag 762 OvertimeApproval 557, 558, 559 OvertimeCombination WSAPayCodeDistribution tag 1509 OvertimeComponents WSACFGDistributionAssignment tag 1251 OvertimeLevel PersonalOvertimeAssignment tag 625 OvertimeLimitPayCodeName WSAHolidayCreditRule tag 1423 OvertimeLimitType WSAHolidayCreditRule tag 1423 OvertimeName WSACFGOvertimeComponent tag 1256 OvertimeRuleNames WSAWorkRulePCDistr tag 1707 Overtimes WSAPayDistributionAssociation tag 1514 OvertimeTypeName PersonalOvertimeAssignment tag 625
P
PaidAmount WSABreakRule tag 1220 PaidFlag HistoricalPayCodeEdit tag 363 paramDefinitionName 203 ParameterName Error tag 282 ParameterType Error tag 282
ParameterValue Error tag 282 ProcedureParameter tag 683 ParamQty ScheduleRuleOverrideDetails tag ParamTypeId ScheduleRuleOverrideDetails tag ParamTypeMMId ScheduleRuleOverrideDetails tag ParamValTypeId ScheduleRuleOverrideDetails tag ParamValue ScheduleRuleOverrideDetails tag ParentLocationNum OrgLocation tag 539 PartialEndDate OpenShiftVolunteer tag 527 RequestToCover tag 787 PartialEndTime OpenShiftVolunteer tag 527 RequestToCover tag 787 PartialShiftItems Schedule tag 849 PartialStartDate OpenShiftVolunteer tag 527 RequestToCover tag 788 PartialStartTime OpenShiftVolunteer tag 528 RequestToCover tag 788 Password PasswordHistory tag 561 Request tag 782 PasswordHistories User tag 1065 PasswordHistory 561 PasswordUpdatedDateTime UserAccount tag 1069 PasswordUpdateFlag UserAccount tag 1069 PatternDurationType
1809
Index
EffectiveWorkload tag 252 PatternElement 562, 563, 564 PatternElements SchedulePattern tag 903 PayCode 567, 568, 569 WSAAccrualPolicyPayCode tag 1165 WSAAccrualQualifier tag 1175 WSABonusDeductRule tag 1211 WSAColumnDetail tag 1274 WSAGrant tag 1413 PaycodeAssignmentName WSACFGPaycodeAssignment tag 1258 PaycodeAssignments WSACFGDistributionAssignment tag 1251 PayCodeDistributionName WSAEffectiveWorkRule tag 1384 PayCodeEdit 571, 572, 573, 574, 575, 576, 577, 578 PayCodeForZeroHours WSASignOffRestriction tag 1651 PayCodeId Total tag 1036 PaycodeMax WSABonusDeductRule tag 1211 PaycodeMin WSABonusDeductRule tag 1211 PayCodeMove 581, 582, 583, 584, 585, 586, 587 PayCodeName HistoricalPayCodeEdit tag 364 HistoricalPayCodeMove tag 373 HolidayEditHours tag 379 HolidayEditWages tag 382 NonCancellingPayCodeEdit tag 517 PatternElement tag 562 PayCode tag 569 PayCodeEdit tag 578 PayCodeMove tag 587 SchedulePayCodeEdit tag 912 Total tag 1036
TotaledScheduledPayCodeEdit tag 1039 TotaledScheduledPayCodeEditUneditable tag 1043 PaycodeName ScheduleHours tag 883 PayCodeNames BulkTotals tag 154 WSAContributingPayCodeRule tag 1290 PayCodeProfile 590, 591 PayCodeProfileId PayCodeProfile tag 591 PayCodeProfileName PayCodeProfile tag 591 PayCodes FPATrigger tag 309 WSAPayDistributionAssociation tag 1514 Paycodes ScheduleCostResult tag 865 PaycodesList WSADisplayOrder tag 1349 PayFromSchedule 593, 594 WSAEffectivePayRule tag 1377 PayFromScheduleStopEvent 595, 596, 597 PaymentType CheckAdvice tag 175 PayPeriodType WSAFixedRule tag 1400 PayrollLockoutThruDateTime Person tag 611 WTKEmployee tag 1765 PayRuleName JobAssignmentDetails tag 420 WTKEmployee tag 1765 PayRuleProfile 599, 600 PayRuleProfileId PayRuleProfile tag 599 PayRuleProfileName PayRuleProfile tag 600 Percentage FPAAllocation tag 294
1810
Kronos Incorporated
Index
Period ApproveSignoff tag 99 BadgeAssignment tag 116 BaseWageRate tag 119 BulkAccruals tag 152 BulkTotals tag 155 EmploymentStatus tag 279 JobAssignment tag 417 PersonAccessAssignment tag 617 Personality tag 621 PersonalOvertimeAssignment tag 626 PersonCertificationAssign tag 636 PersonSkillAssign tag 660 PrimaryLaborAccount tag 672 Timesheet tag 1025 UserAccountStatus tag 1076 WFCGenie tag 1094 PeriodCodeName ScheduleAccrualPattern tag 859 SchedulePattern tag 903 SchedulePeriod tag 916 PeriodDateSpan PeriodTotals tag 601 TimeFramePeriod tag 1016 PeriodEndDate BidRequest tag 146 PeriodIsApproved ApproveSignoff tag 97 PeriodIsSignedOff ApproveSignoff tag 97 PeriodLength ScheduleAccrualPattern tag 860 SchedulePattern tag 904 SchedulePeriod tag 917 PeriodLengthInDays ScheduleAccrualPattern tag 860 SchedulePattern tag 904 PeriodStartDate BidRequest tag 147 PeriodTotalData
Timesheet tag 1025 PeriodTotals 601, 602 Permission 603, 604 AccessProfile tag 48 Permissions WSAFunctionAccessProfile tag 1404 PersistPceSw WSAPayCode tag 1501 Person 457, 606, 607, 608, 609, 610, 611, 612 ProcessorToEmployee tag 707 PersonAccessAssignment 615, 616, 617 PersonAccessAssignments PersonInformation tag 651 Personality 619, 620, 621, 622 PersonalOvertimeAmountTypeName PersonalOvertimeLimit tag 629 PersonalOvertimeAssignment 624, 625, 626 PersonalOvertimeAssignments JobAssignment tag 417 PersonalOvertimeLimit 628, 629 PersonalOvertimeLimits PersonalOvertimeRule tag 630 PersonalOvertimeRule 630, 631 PersonalOvertimeRuleData PersonalOvertimeAssignment tag 626 PersonalOvertimeRuleDisplayName PersonalOvertimeRule tag 631 PersonAuthenticationType 632, 633 PersonAuthenticationTypes PersonInformation tag 651 PersonCertificationAssign 635, 636 PersonCertificationItem 637, 638, 639 PersonCertificationItems PersonCertificationAssign tag 636 PersonData HyperFindResult tag 407 PersonInformation tag 651 PersonId BidGroupItem tag 137 PersonIdentity 641, 642, 643
1811
Index
PersonIdentityList PersonIdentity tag 642 PersonInformation 647, 648, 649, 650, 651, 652, 653 PersonInformationData Personality tag 621 PersonKey CurrentUser tag 208 From tag 311 PersonIdentity tag 642 To tag 1028 PersonLicenseType 654 PersonLicenseTypes PersonInformation tag 652 PersonNumber 45, 233, 1129 APIPunchRestrictionOverride tag 82 AuditItem tag 105 AuditTrail tag 109 CurrentUser tag 208 EmployeeGroupAssign tag 261 EmployeePreferredZone tag 272 From tag 312 HyperFindResult tag 407 LightWeightPerson tag 464 Person tag 611 PersonCertificationAssign tag 636 PersonIdentity tag 643 PersonSkillAssign tag 660 RuleSetEmployeeAssign tag 805 ScheduleRuleOverride tag 921 To tag 1029 TransferJobSeniorityDate tag 1056 PersonShiftTemplateAssignment 656, 657 PersonSkillAssign 659, 660 PersonSkillItem 661, 662 PersonSkillItems PersonSkillAssign tag 660 PhoneNumber TelephoneNumber tag 1011 WSACfgContactType tag 1241
PhoneticFullName Person tag 612 PopulatedThroughDate ShiftBuilder tag 954 Popup WSACustomUrl tag 1320 PostalAddress 663, 664, 665 WSACfgContactType tag 1241 PostalAddresses PersonInformation tag 652 PostalCode PostalAddress tag 664 PostToSchedule BidRequest tag 142 PreferenceProfile 666, 667 PreferenceProfileId PreferenceProfile tag 667 PreferenceProfileName AccessAssignment tag 37 PreferenceProfile tag 667 RoleProfileKBO tag 803 PreferredZone EmployeePreferredZone tag 272 PreferredZoneSet EmployeePreferredZone tag 273 PrepopulateProject WSAEffectivePayRule tag 1377 PrevLocations ProcessTask tag 719 PrimaryLaborAccount 670, 671, 672 PrimaryLaborAccounts JobAssignment tag 418 Priority Bid tag 123 VacationBid tag 1083 ProbationAmountInCurrency ResetAccrual tag 794 ProbationAmountInTime ResetAccrual tag 794 ProbationaryBalanceInCurrency
1812
Kronos Incorporated
Index
AccrualBalanceSummary tag 51 ProbationaryBalanceInTime AccrualBalanceSummary tag 52 ProbationPeriod WSAAccrualPolicy tag 1158 ProbationQualifiers WSAProbationPeriod tag 1529 Procedure 675, 676, 677, 678 ProcedureAction 679, 680 ProcedureActionName ProcedureAction tag 680 ProcedureContext 681, 682 ProcedureContextName ProcedureContext tag 682 ProcedureName Procedure tag 678 ProcedureSetItem tag 693 ProcedureParameter 683, 684 ProcedureParameterDefinition 685, 686 ProcedureParameterDefinitionName ProcedureParameter tag 683 SignatureItem tag 987 ProcedureParameterName ProcedureParameter tag 684 ProcedureParameterDefinition tag 686 SignatureItem tag 987 ProcedureParameters ProcedureSetItem tag 694 ProcedureSet 458, 688, 689, 690, 691, 692 ProcedureSetItem 693, 694 ProcedureSetItems ProcedureSet tag 691 ProcedureSetName 74, 77 ProcedureSet tag 692 Process 696, 697, 698, 699, 700, 701, 702 ProcessAsManager Request tag 782 ProcessAttributes Process tag 700 ProcessId
Process tag 701 ProcessTask tag 720 ProcessName Process tag 701 ProcessTask tag 720 Processor ProcessorToEmployee tag 708 ProcessorToEmployee 704, 705, 706, 707, 708 ProcessProfile 710, 711 ProcessProfileId ProcessProfile tag 710 ProcessProfileName ProcessProfile tag 711 ProcessSchedule 713, 714, 715 ProcessState Process tag 701 ProcessStateCode Process tag 702 ProcessTask 717, 718, 719, 720, 721, 722, 723 ProcessTemplate 726, 727, 728, 729, 731, 732, 733, 735, 736, 738, 739, 741, 742, 744, 745, 746, 747, 748, 749 Product GenieColumn tag 345 ProfessionalAccessFlag PayCode tag 569 ProfessionalHasAccessFlag WorkRule tag 1122 ProfessionalPayCodeName AccessAssignment tag 38 ProfessionalTransferOrganizationSetName PersonAccessAssignment tag 617 ProfessionalTransferSetName AccessAssignment tag 38 ProfessionalWorkRuleName AccessAssignment tag 39 ProfileItems WSAAvailabilityPatternDAP tag 1201 WSAPatternTemplateDAP tag 1494 WSAPayCodeDAP tag 1506
1813
Index
WSAReportDAP tag 1557 WSAScheduleGroupDAP tag 1596 WSAShiftTemplateDAP tag 1646 WSAWorkRuleDAP tag 1701 ProjectedBalanceInCurrency AccrualBalanceSummary tag 52 ProjectedBalanceInTime AccrualBalanceSummary tag 52 ProjectedDate AccrualBalanceSummary tag 53 ProjectedGrantAmountInCurrency AccrualBalanceSummary tag 53 ProjectedGrantAmountInTime AccrualBalanceSummary tag 53 ProjectedProbationaryBalanceInCurrency AccrualBalanceSummary tag 53 ProjectedProbationaryBalanceInTime AccrualBalanceSummary tag 54 ProjectedTakingAmountInCurrency AccrualBalanceSummary tag 54 ProjectedTakingAmountInTime AccrualBalanceSummary tag 54 ProjectedVestedBalanceInCurrency AccrualBalanceSummary tag 55 ProjectedVestedBalanceInTime AccrualBalanceSummary tag 55 ProjectingOvertime 750, 751 ProjectViewStartDay WSADisplayProfile tag 1360 PropertyName Error tag 283 FailedXMLTransaction tag 289 NameList tag 501 PropertyType Error tag 283 PropertyValue Error tag 283 FailedXMLTransaction tag 289 Prorate WSAGrant tag 1414
ProxyMgrId DelegateAuthorityTask tag 234 ProxyMgrName DelegateAuthorityTask tag 234 ProxyMgrNumber DelegateAuthorityTask tag 235 Punch 753, 754, 755, 756, 757, 758, 759, 760, 761, 762, 763 PunchRestrictions WSATkTerminalRule tag 1663 PunchStatus 765, 766 PurgeShiftBuilderErrorDetails ShiftBuilder tag 954 PwdExpiredDays WSALogonProfile tag 1463 PwdExpiredDaysSwitch WSALogonProfile tag 1463 PwdMaxHistory WSALogonProfile tag 1464 PwdMaxHistorySwitch WSALogonProfile tag 1464 PwdMinLength WSALogonProfile tag 1464 PwdMinLengthSwitch WSALogonProfile tag 1464
Q
QualifiedSignOffRuleName WSAEffectivePayRule tag 1378 QualifiersBasedOnType WSAZone tag 1719 QualifiersUnscheduled WSAZone tag 1719 QualifyPerShift WSABonusDeductRule tag 1212 Quantity ExpectedHours tag 284 QueryDate MinimunHoursNoModification tag OpenShiftVolunteer tag 528
499
1814
Kronos Incorporated
Index
RequestToCover tag 788 ShiftValidation tag 982 SwapShiftEmployees tag 999 SwapShiftJobs tag 1003 QueryDateSpan APIStableDateSpans tag 87 APIVolumeDataService tag 89 HoursSummaryService tag 389 HPPDService tag 395 HPPDSummaryService tag 400 HyperFindQuery tag 403 ProcessSchedule tag 714 ProjectingOvertime tag 751 Schedule tag 849 ScheduleAccrualPattern tag 860 ScheduleCoverage tag 870 ScheduleGroup tag 874 ScheduleHours tag 883 ScheduleMarkPosted tag 893 QueryDateTimeSpan OpenShiftVolunteer tag 528 RequestToCover tag 788 QueryIncludePersonFlag HyperFindQuery tag 403 QueryIncludeUserFlag HyperFindQuery tag 404 QueryIncludeWTKEmployeeFlag HyperFindQuery tag 404 QueryPersonOrEmployee HyperFindQuery tag 404 QueryVisibleType WSAHyperfindQuery tag 1429
R
Rate CheckAdviceDetailGrossPay tag 182 RBSRule 768, 769, 770 RBSRuleVersion 772, 773, 774, 775 RBSRuleVersions RBSRule tag 770
ReadOnly WSALaborLevelEntry tag 1444 Reason ShiftHistory tag 965 Recipients EmployeeMessage tag 269 RecordManagerLockoutFlag UserAccount tag 1069 ReductByAmountTardy WSAShiftGuarantee tag 1638 ReferenceCustomDate WSACustomDate tag 1315 ReferenceDate WSAPayPeriod tag 1517 ReferenceDay WSAPayPeriod tag 1517 Reject VacationBid tag 1080 RelativeTo WSABreakRule tag 1221 RemoveApproval ApproveSignoff tag 97 RemoveBids BidGroupItem tag 134 RemoveEmployees ScheduleGroup tag 873 RemoveEmployeesByDateSpan ScheduleGroup tag 873 RemoveEntries LaborAccountEntry tag 433 RemoveOthersApproval ApproveSignoff tag 98 RemoveScheduleItems Schedule tag 844 RemoveSignOff ApproveSignoff tag 98 RemoveSpecifiedScheduleItems Schedule tag 844 RemoveWorkRule Punch tag 756
1815
Index
ReplaceEntries LaborAccountEntry tag 433 OrgSetEntry tag 551 ReplaceShift Schedule tag 844 ReportingPeriodAccrualsTabLabelOnTimeCard WSADisplayProfile tag 1361 ReportName AccessAssignment tag 39 ReportProfile 777, 778 ReportProfileId ReportProfile tag 778 ReportProfileName ReportProfile tag 778 Request 780, 781, 782, 783 RequestCode ConnectToScheduleItem tag 193 RequestToCover 785, 786, 787, 788, 789 RequestToCoverItem 790 RequestToCoverItems CoverShiftStatus tag 205 RequestToCover tag 789 RequestToCoverStatus RequestToCover tag 789 RequiredRestDuration RBSRuleVersion tag 775 RequiresApproval WSAOvertimeRule tag 1488 WSAScheduleDeviationRule tag 1580 WSAZoneRule tag 1732 ResetAccrual 793, 794, 795 ResetAfter WSAOvertimeRule tag 1488 ResetAtTime WSAOvertimeRule tag 1489 ResetDate WSAOvertimeRule tag 1489 ResetDay WSAOvertimeRule tag 1489 ResourceId 697, 698, 733, 739
ProcessTask tag 720 ResourceName ProcessTask tag 721 Response 797, 798 RestoreTaking WSAAccrualPolicy tag 1158 RestoreTakingAmount WSAAccrualPolicy tag 1159 RestoreTakingAmountUnitOfMeasure WSAAccrualPolicy tag 1159 ResubmitFailedShiftBuilderTasks ShiftBuilder tag 954 Results ScheduleCostSummary tag 866 RetreiveAllForUpdate WSAWorkRuleProfileItem tag 1708 Retrieve APIStableDateSpans tag 86 APIVolumeDataService tag 88 CoverageSettings tag 198 DataAccessGroup tag 218 DelegateProfile tag 239 FPARule tag 298 HoursSummaryService tag 388 HPPDService tag 393 HPPDSummaryService tag 399 LocationProfileSettings tag 469 NavProfile tag 505 Procedure tag 676 ProcedureAction tag 679 ProcedureContext tag 681 ProcedureParameterDefinition tag 685 ProcedureSet tag 689 Process tag 698 ProcessorToEmployee tag 705 ProcessTask tag 717 ProcessTemplate tag 727 RBSRule tag 769 RoleProfileKBO tag 800 SchedGenSettings tag 809
1816
Kronos Incorporated
Index
SchedRule tag 817 SchedRuleContext tag 822 SchedRuleOperator tag 824 SchedRuleSet tag 828 SchedRuleSortOrder tag 832 SchedRuleTopic tag 834 SchedRuleValueType tag 836 ScheduleRuleOverride tag 919 SettingsParamDefinition tag 945 SettingsType tag 950 ShiftHistory tag 963 Signature tag 985 TopicParameterDefinition tag 1030 WorkWeek tag 1129 WorkWeekAssignments tag 1134 WSAAccrualDetail tag 1143 WSAAccrualDetailColumnSet tag 1148 WSAAccrualPolicy tag 1152 WSAAccrualProfile tag 1169 WSAAPICombination tag 1177 WSAAPICombinationComponent tag 1180 WSAAPICombinationRule tag 1184 WSAAPICombinationTowardOT tag 1187 WSAAssignmentRule tag 1191 WSAAutoBreakPlacement tag 1197 WSABreakTime tag 1223 WSACFGDistributionAssignment tag 1251 WSACFGExtProcessorComponent tag 1253 WSACFGOvertimeComponent tag 1255 WSACFGPaycodeAssignment tag 1257 WSACFGPaycodeDistribution tag 1260 WSACFGZoneComponent tag 1262 WSADateFinder tag 1325 WSADatePattern tag 1329 WSADayMonthSpan tag 1333 WSADisplayProfile tag 1352 WSAEffectivePayRule tag 1374 WSAEffectiveWorkRule tag 1382 WSAGrant tag 1409 WSAInterval tag 1432
WSALimit tag 1455 WSAOverridePayCode tag 1480 WSAPayRuleHoliday tag 1522 WSAProbationPeriod tag 1528 WSAProbationQualifier tag 1531 WSAScheduleGroupDAP tag 1595 WSAScheduleGroupDetail tag 1599 WSAScheduleGroupDetailColumnSet tag 1604 WSAScheduleGroupProfileItem tag 1608 WSAScheduleGroupRollup tag 1611 WSAScheduleGroupRollupColumnSet tag 1616 WSAShiftLength tag 1641 WSATimePeriod tag 1654 WSATkTerminalRule tag 1657 WSAWfgColumnSet tag 1683 WSAWorkRuleGeneral tag 1702 WSAWorkRulePCDistr tag 1705 WTDEmployeeAssignment tag 1738 WTDGlobal tag 1744 WTDRule tag 1752 retrieve ShiftStartTimeBand tag 972 RetrieveAll AuthenticationType tag 111 CalendarProfile tag 158 CoverageSettings tag 198 DataAccessGroup tag 218 DelegateProfile tag 239 FPARule tag 298 GenericEmployeeCalendar tag 329 GenericManagerCalendar tag 337 LaunchHistory tag 456 LocationProfileSettings tag 469 NavProfile tag 505 OrgMapIntegration tag 543 Procedure tag 676 ProcedureAction tag 680 ProcedureContext tag 682
1817
Index
ProcedureParameterDefinition tag 686 ProcedureSet tag 689 ProcessorToEmployee tag 705 ProcessTemplate tag 727 RBSRule tag 769 RoleProfileKBO tag 801 SchedGenSettings tag 809 SchedRule tag 817 SchedRuleContext tag 823 SchedRuleOperator tag 825 SchedRuleSet tag 828 SchedRuleSortOrder tag 833 SchedRuleTopic tag 835 SchedRuleValueType tag 837 ScheduleCoverage tag 868 ScheduleRuleOverride tag 919 SettingsParamDefinition tag 946 SettingsType tag 951 Signature tag 985 TopicParameterDefinition tag 1031 WTDEmployeeAssignment tag 1738 WTDGlobal tag 1744 WTDRule tag 1752 retrieveAll ShiftStartTimeBand tag 972 RetrieveAllByCategory ProcessTemplate tag 728 RetrieveAllByName CalendarProfile tag 158 GenericEmployeeCalendar tag 329 GenericManagerCalendar tag 337 RetrieveAllByNameAndActive CalendarProfile tag 158 GenericEmployeeCalendar tag 329 GenericManagerCalendar tag 337 RetrieveAllByProcessId ProcessTask tag 717 RetrieveAllByResourceId ProcessTask tag 717 ProcessTemplate tag 729
RetrieveAllCategories WorkflowTemplateCategory tag 1118 RetrieveAllForEmployee ProcessTemplate tag 733 RetrieveAllForManager ProcessTemplate tag 736 RetrieveAllForUpdate CoverageSettings tag 198 DataAccessGroup tag 219 LocationProfileSettings tag 469 Procedure tag 676 ProcedureSet tag 689 SchedGenSettings tag 809 SchedulePattern tag 901 SchedulePeriod tag 915 ShiftCode tag 957 Signature tag 985 WSAAccrualCode tag 1140 WSAAccrualDetail tag 1143 WSAAccrualDetailColumnSet tag 1148 WSAAccrualPolicy tag 1153 WSAAccrualProfile tag 1169 WSAAPICombinationRule tag 1184 WSAAvailabilityPatternDAP tag 1200 WSAAvailabilityPatternProfileItem tag 1202 WSABonusDeductRule tag 1205 WSABreakRule tag 1217 WSACalendarProfile tag 1226 WSACallInRule tag 1229 WSACfgAccrualCode tag 1236 WSACfgContactTypeList tag 1243 WSACfgCustomDataList tag 1248 WSACFGPaycodeDistribution tag 1260 WSAColumnDefinitionDataType tag 1267 WSACombinedPayCodeRule tag 1278 WSAComment tag 1283 WSAContributingPayCodeRule tag 1288 WSAContributingShiftRule tag 1292 WSACoreHoursRule tag 1297
1818
Kronos Incorporated
Index
WSACriteriaSet tag 1310 WSACustomDate tag 1313 WSACustomDateType tag 1316 WSACustomUrl tag 1318 WSACustomUrlProfile tag 1322 WSADatePattern tag 1329 WSADetail tag 1340 WSADetailColumnSet tag 1344 WSADisplayOrder tag 1348 WSADisplayProfile tag 1352 WSADPLaborLevelDefinition tag 1367 WSADPPayCode tag 1369 WSADPTimePeriod tag 1371 WSAExceptionRule tag 1392 WSAExceptionType tag 1396 WSAFixedRule tag 1398 WSAFunctionAccessProfile tag 1402 WSAGenie tag 1405 WSAGrant tag 1409 WSAHoliday tag 1416 WSAHolidayCreditRule tag 1421 WSAHyperfindQuery tag 1427 WSAIntervalRoundRule tag 1435 WSALaborLevel tag 1439 WSALaborLevelEntry tag 1442 WSALeaveCaseDetail tag 1447 WSALeaveCaseDetailColumnSet tag 1451 WSALimit tag 1455 WSALogonProfile tag 1460 WSAMainTab tag 1466 WSAMajorityRule tag 1469 WSANavbarCategory tag 1472 WSAOrganizationType tag 1477 WSAOvertimeCombination tag 1483 WSAOvertimeRule tag 1486 WSAPatternTemplateDAP tag 1493 WSAPatternTemplateProfileItem tag 1495 WSAPayCode tag 1498 WSAPayCodeDAP tag 1505 WSAPayCodeDistribution tag 1508
WSAPayCodeProfileItem tag 1511 WSAPayRule tag 1519 WSAProbationPeriod tag 1528 WSAProbationQualifier tag 1532 WSAProcessingOrderRule tag 1535 WSAPunchRoundRule tag 1538 WSAQuickFind tag 1552 WSAReportDAP tag 1556 WSAReportProfileItem tag 1558 WSARollup tag 1561 WSARollupColumnSet tag 1565 WSAScheduleAssistant tag 1568 WSAScheduleAssistantColumnSet tag 1573 WSAScheduleAssistantTab tag 1576 WSAScheduleDeviationRule tag 1579 WSAScheduledHoursType tag 1582 WSAScheduleEditor tag 1586 WSAScheduleEditorColumnSet tag 1591 WSAScheduleGroupDAP tag 1595 WSAScheduleGroupDetail tag 1599 WSAScheduleGroupDetailColumnSet tag 1604 WSAScheduleGroupProfileItem tag 1609 WSAScheduleGroupRollup tag 1611 WSAScheduleGroupRollupColumnSet tag 1616 WSASchedulePeriod tag 1620 WSASchedulePlanner tag 1623 WSASchedulePlannerColumnSet tag 1628 WSASequencerRule tag 1634 WSAShiftGuarantee tag 1637 WSAShiftTemplateDAP tag 1645 WSASignOffRestriction tag 1648 WSATimePeriod tag 1654 WSATkTerminalRule tag 1657 WSATreeType tag 1666 WSAULLE tag 1670 WSAWageProfile tag 1676 WSAWorkforceGenieProfile tag 1687 WSAWorkHistoryQualifierRule tag 1690
1819
Index
WSAWorkloadPlannerProfile tag 1694 WSAWorkRule tag 1696 WSAWorkRuleDAP tag 1700 WSAZoneCombinationRule tag 1724 WSAZoneRule tag 1730 WTDEmployeeAssignment tag 1738 WTDGlobal tag 1744 WTDRule tag 1752 retrieveAllForUpdate TreeNodeType tag 1058 RetrieveAllNames CalendarProfileAPIFacade tag 162 CoverageSettings tag 198 DataAccessGroup tag 219 DataElementAPIFacade tag 222 DataSetAPIFacade tag 224 FPARule tag 298 GenericEmployeeCalendarAPIFacade tag 333 GenericManagerCalendarAPIFacade tag 342 LocationProfileSettings tag 469 NavProfile tag 505 Procedure tag 676 ProcedureContext tag 682 ProcedureParameterDefinition tag 686 ProcedureSet tag 689 RBSRule tag 769 RoleProfileKBO tag 801 SchedGenSettings tag 809 SchedRule tag 817 SchedRuleContext tag 823 SchedRuleOperator tag 825 SchedRuleSet tag 828 SchedRuleSortOrder tag 833 SchedRuleTopic tag 835 SchedRuleValueType tag 837 SchedulePattern tag 901 SchedulePeriod tag 915 SettingsParamDefinition tag 946 SettingsType tag 951
ShiftCode tag 957 Signature tag 985 TopicParameterDefinition tag 1031 WorkerType tag 1109 WorkWeek tag 1129 WorkWeekAssignments tag 1134 WSAAccrualCode tag 1141 WSAAccrualDetail tag 1143 WSAAccrualDetailColumnSet tag 1148 WSAAccrualPolicy tag 1153 WSAAccrualProfile tag 1169 WSAAPICombinationRule tag 1184 WSAAvailabilityPatternDAP tag 1200 WSABonusDeductRule tag 1205 WSABreakRule tag 1217 WSACalendarProfile tag 1227 WSACallInRule tag 1229 WSACfgAccrualCode tag 1236 WSACfgContactTypeList tag 1243 WSACfgCustomDataList tag 1248 WSACFGPaycodeDistribution tag 1260 WSAColumnDefinitionDataType tag 1268 WSACombinedPayCodeRule tag 1279 WSAComment tag 1283 WSAContributingPayCodeRule tag 1289 WSAContributingShiftRule tag 1292 WSACoreHoursRule tag 1297 WSACriteriaSet tag 1311 WSACustomDate tag 1314 WSACustomDateType tag 1317 WSACustomUrl tag 1319 WSACustomUrlProfile tag 1322 WSADatePattern tag 1329 WSADetail tag 1340 WSADetailColumnSet tag 1344 WSADisplayOrder tag 1348 WSADisplayProfile tag 1352 WSADPLaborLevelDefinition tag 1368 WSADPPayCode tag 1370 WSADPTimePeriod tag 1372
1820
Kronos Incorporated
Index
WSAExceptionRule tag 1392 WSAExceptionType tag 1397 WSAFixedRule tag 1399 WSAFunctionAccessProfile tag 1402 WSAGenie tag 1406 WSAGrant tag 1409 WSAHoliday tag 1416 WSAHolidayCreditRule tag 1421 WSAHyperfindQuery tag 1428 WSAIntervalRoundRule tag 1435 WSALaborLevel tag 1439 WSALaborLevelEntry tag 1443 WSALeaveCaseDetail tag 1447 WSALeaveCaseDetailColumnSet tag 1451 WSALimit tag 1455 WSALogonProfile tag 1460 WSAMainTab tag 1467 WSAMajorityRule tag 1469 WSANavbarCategory tag 1473 WSAOrganizationType tag 1477 WSAOvertimeCombination tag 1483 WSAOvertimeRule tag 1486 WSAPatternTemplateDAP tag 1493 WSAPayCode tag 1498 WSAPayCodeDAP tag 1505 WSAPayCodeDistribution tag 1508 WSAPayRule tag 1520 WSAProbationPeriod tag 1528 WSAProcessingOrderRule tag 1535 WSAPunchRoundRule tag 1538 WSAQuickFind tag 1552 WSAReportDAP tag 1556 WSARollup tag 1561 WSARollupColumnSet tag 1565 WSAScheduleAssistant tag 1569 WSAScheduleAssistantColumnSet tag 1573 WSAScheduleAssistantTab tag 1577 WSAScheduleDeviationRule tag 1579 WSAScheduledHoursType tag 1583 WSAScheduleEditor tag 1586
WSAScheduleEditorColumnSet tag 1591 WSAScheduleGroupDAP tag 1595 WSAScheduleGroupDetail tag 1599 WSAScheduleGroupDetailColumnSet tag 1604 WSAScheduleGroupRollup tag 1611 WSAScheduleGroupRollupColumnSet tag 1616 WSASchedulePeriod tag 1621 WSASchedulePlanner tag 1623 WSASchedulePlannerColumnSet tag 1628 WSASequencerRule tag 1634 WSAShiftGuarantee tag 1637 WSAShiftTemplateDAP tag 1645 WSASignOffRestriction tag 1649 WSATimePeriod tag 1655 WSATkTerminalRule tag 1658 WSATreeType tag 1667 WSAULLE tag 1670 WSAWageProfile tag 1676 WSAWorkforceGenieProfile tag 1687 WSAWorkHistoryQualifierRule tag 1691 WSAWorkloadPlannerProfile tag 1695 WSAWorkRule tag 1697 WSAWorkRuleDAP tag 1700 WSAZoneCombinationRule tag 1724 WSAZoneRule tag 1731 WTDEmployeeAssignment tag 1739 WTDGlobal tag 1745 WTDRule tag 1752 retrieveAllNames TreeNodeType tag 1059 RetrieveAuditTrail AuditTrail tag 107 RetrieveByDate LaunchHistory tag 456 RetrieveByDatePerson LaunchHistory tag 456 RetrieveByDisplayName ProcessTemplate tag 739
1821
Index
RetrieveByGDAPName GDAPAssignment tag 318 RetrieveById CalendarProfile tag 158 GenericEmployeeCalendar tag 329 GenericManagerCalendar tag 337 RetrieveByName CalendarProfile tag 158 FPARule tag 298 GenericEmployeeCalendar tag 329 GenericManagerCalendar tag 338 RBSRule tag 769 RetrieveByPerson LaunchHistory tag 457 ProcessorToEmployee tag 705 RetrieveByPersonAndEffectiveDate ProcessorToEmployee tag 705 RetrieveByPersonId GDAPAssignment tag 318 RetrieveByPersonIdAndRole GDAPAssignment tag 318 RetrieveByProcedureSet LaunchHistory tag 457 RetrieveByProcedureSetUserAccountName LaunchHistory tag 458 RetrieveByProcessor ProcessorToEmployee tag 706 RetrieveByProxyMgrPersonNumber DelegateAuthorityTask tag 233 RetrieveByUniqueKey ProcessTemplate tag 741 RetrieveByUser LaunchHistory tag 458 RetrieveCallList APICallList tag 73 RetrieveDetails ScheduleCoverage tag 869 RetrieveForUpdate APIPunchRestrictionOverride tag 79 CalendarProfileAPIFacade tag 163
CoverageSettings tag 199 DataAccessGroup tag 219 DataElementAPIFacade tag 223 DataSetAPIFacade tag 225 FPARule tag 299 GenericEmployeeCalendarAPIFacade tag 334 GenericManagerCalendarAPIFacade tag 343 HPPDService tag 394 LocationProfileSettings tag 470 NavProfile tag 506 Procedure tag 676 ProcedureSet tag 690 ProcessorToEmployee tag 706 RBSRule tag 770 RoleProfileKBO tag 801 SchedGenSettings tag 810 SchedRule tag 817 SchedRuleSet tag 828 SchedulePattern tag 901 SchedulePeriod tag 916 ShiftCode tag 958 Signature tag 985 WorkerType tag 1110 WorkWeek tag 1130 WorkWeekAssignments tag 1134 WSAAccrualCode tag 1141 WSAAccrualDetail tag 1144 WSAAccrualDetailColumnSet tag 1148 WSAAccrualPolicy tag 1153 WSAAccrualProfile tag 1169 WSAAPICombination tag 1178 WSAAPICombinationComponent tag 1181 WSAAPICombinationRule tag 1184 WSAAPICombinationTowardOT tag 1188 WSAAvailabilityPatternDAP tag 1200 WSAAvailabilityPatternProfileItem tag 1202 WSABonusDeductRule tag 1205 WSABreakRule tag 1217
1822
Kronos Incorporated
Index
WSACalendarProfile tag 1227 WSACallInRule tag 1229 WSACfgAccrualCode tag 1236 WSACfgContactTypeList tag 1243 WSACfgCustomDataList tag 1248 WSACFGDistributionAssignment tag 1251 WSACFGExtProcessorComponent tag 1254 WSACFGOvertimeComponent tag 1256 WSACFGPaycodeAssignment tag 1258 WSACFGPaycodeDistribution tag 1260 WSACFGZoneComponent tag 1263 WSAColumnDefinitionDataType tag 1268 WSAColumnDetail tag 1271 WSACombinationRule tag 1277 WSACombinedPayCodeRule tag 1279 WSAComment tag 1283 WSACommentType tag 1286 WSAContributingPayCodeRule tag 1289 WSAContributingShiftRule tag 1292 WSACoreHoursRule tag 1297 WSACriteriaSet tag 1311 WSACustomDate tag 1314 WSACustomDateType tag 1317 WSACustomUrl tag 1319 WSACustomUrlProfile tag 1322 WSADateFinder tag 1326 WSADatePattern tag 1329 WSADayMonthSpan tag 1333 WSADaysOfWeek tag 1335 WSADetail tag 1340 WSADetailColumnSet tag 1344 WSADisplayOrder tag 1348 WSADisplayProfile tag 1352 WSADisplayProfileWorkforceGenieProfile tag 1363 WSADispOrdOptionalRule tag 1365 WSADPLaborLevelDefinition tag 1368 WSADPPayCode tag 1370 WSADPTimePeriod tag 1372 WSAExceptionRule tag 1392
WSAExceptionType tag 1397 WSAFixedRule tag 1399 WSAFunctionAccessProfile tag 1402 WSAGenie tag 1406 WSAGrant tag 1410 WSAHoliday tag 1416 WSAHolidayCreditRule tag 1421 WSAHyperfindQuery tag 1428 WSAInterval tag 1433 WSAIntervalRoundRule tag 1435 WSALaborLevel tag 1439 WSALaborLevelEntry tag 1443 WSALeaveCaseDetail tag 1447 WSALeaveCaseDetailColumnSet tag 1451 WSALimit tag 1456 WSALogonProfile tag 1460 WSAMainTab tag 1467 WSAMajorityRule tag 1469 WSANavbarCategory tag 1473 WSAOptionalRule tag 1474 WSAOrganizationType tag 1477 WSAOverridePayCode tag 1480 WSAOvertimeCombination tag 1483 WSAOvertimeRule tag 1486 WSAPatternTemplateDAP tag 1493 WSAPatternTemplateProfileItem tag 1496 WSAPayCode tag 1498 WSAPayCodeDAP tag 1505 WSAPayCodeDistribution tag 1508 WSAPayCodeProfileItem tag 1512 WSAPayDistributionAssociation tag 1513 WSAPayPeriod tag 1516 WSAPayRule tag 1520 WSAPermission tag 1524 WSAProbationPeriod tag 1528 WSAProbationQualifier tag 1532 WSAProcessingOrderRule tag 1535 WSAPunchRoundRule tag 1538 WSAQuickFind tag 1552 WSAReportDAP tag 1556
1823
Index
WSAReportProfileItem tag 1558 WSARollup tag 1561 WSARollupColumnSet tag 1565 WSAScheduleAssistant tag 1569 WSAScheduleAssistantColumnSet tag 1573 WSAScheduleAssistantTab tag 1577 WSAScheduleDeviationRule tag 1579 WSAScheduledHoursType tag 1583 WSAScheduleEditor tag 1586 WSAScheduleEditorColumnSet tag 1591 WSAScheduleGroupDAP tag 1595 WSAScheduleGroupDetail tag 1599 WSAScheduleGroupDetailColumnSet tag 1604 WSAScheduleGroupProfileItem tag 1609 WSAScheduleGroupRollup tag 1611 WSAScheduleGroupRollupColumnSet tag 1616 WSASchedulePeriod tag 1621 WSASchedulePlanner tag 1623 WSASchedulePlannerColumnSet tag 1628 WSASequencedItem tag 1631 WSASequencerRule tag 1634 WSAShiftGuarantee tag 1637 WSAShiftTemplateDAP tag 1645 WSASignOffRestriction tag 1649 WSATimePeriod tag 1655 WSATkTerminalRule tag 1658 WSATreeType tag 1667 WSAULLE tag 1670 WSAWageAdjustment tag 1672 WSAWageProfile tag 1676 WSAWageProfileLaborLevelLinkage tag 1679 WSAWageProfilePayCode tag 1681 WSAWfgColumnSet tag 1684 WSAWorkforceGenieProfile tag 1687 WSAWorkHistoryQualifierRule tag 1691 WSAWorkloadPlannerProfile tag 1695 WSAWorkRule tag 1697
WSAWorkRuleDAP tag 1700 WSAWorkRuleProfileItem tag 1709 WSAZone tag 1711 WSAZoneCombinationRule tag 1724 WSAZoneCombinationSpecificationRule tag 1726 WSAZoneCombinationZoneRule tag 1728 WSAZoneRule tag 1731 WSAZoneRuleHoliday tag 1733 WSAZoneRuleLimit tag 1735 WTDEmployeeAssignment tag 1739 WTDGlobal tag 1745 WTDRule tag 1753 retrieveForUpdate TreeNodeType tag 1059 RetrieveForUpdateFactory NavProfile tag 506 RetrieveOpenShifts ScheduleCoverage tag 869 RetrievePartial OrgMapIntegration tag 544 RetrieveRoleProfiles RoleProfileKBO tag 801 RetrievesAllForUpdate SchedRule tag 818 SchedRuleSet tag 829 RetrieveSettings SchedGenSettingsValue tag 813 RetrieveSummary ScheduleCoverage tag 869 RetrieveValue CoverageSettingsValue tag 202 Role GDAPAssignment tag 322 GDAPAssignmentDefaultSwitch tag 324 RoleName DelegateAuthorityTask tag 235 RoleProfileId DelegateAuthorityTask tag 235 RoleProfileKBO 800, 801, 802, 803
1824
Kronos Incorporated
Index
roleProfileName SwitchRoleEngine tag 1005 RomanizedFullName Person tag 612 RootNodePath NavProfile tag 508 Round WSACreditCalculator tag 1306 WSAIntervalRoundRule tag 1436 RoundRuleName WSAEffectiveWorkRule tag 1384 RoutingNumber CheckAdviceDetailDirectDeposit tag RowKey GenieRow tag 346 RuleChangedFlag MarkForTotalization tag 491 RuleId WTDRule tag 1759 RuleName RBSRuleVersion tag 775 SchedRule tag 820 ruleName 303, 307 RuleNumber WSATkTerminalRule tag 1664 RuleSetEmployeeAssign 804, 805 RuleSetName SchedRuleSet tag 830 RuleViolations OpenShiftVolunteer tag 528 RequestToCover tag 789 ScheduleHoursStatus tag 891 Run APIPSEEngine tag 76 run APISCGEngine tag 84 RunQuery HyperFindQuery tag 402
180
Saturday WSAAssignmentRule tag 1192 WSABonusDeductRule tag 1212 WSACoreHoursRule tag 1299 WSADaysOfWeek tag 1336 WSAShiftGuarantee tag 1639 SaveData ProcessSchedule tag 714 Schedule tag 849 SchedGenSettings 808, 809, 810, 811, 812 SchedGenSettingsValue 813, 814 SchedHrsInclSw WSAScheduledHoursType tag 1584 SchedHrsProdMonSw WSAScheduledHoursType tag 1584 SchedRule 816, 817, 818, 819, 820, 821 SchedRuleContext 822, 823 SchedRuleId ScheduleRuleOverride tag 921 SchedRuleOperator 824, 825 SchedRules SchedRuleSet tag 830 SchedRuleSet 827, 828, 829, 830 SchedRuleSortOrder 832, 833 SchedRuleTopic 834, 835 SchedRuleValueType 836, 837 Schedule 840, 841, 842, 843, 844, 845, 846, 847, 848, 849, 850, 851 ScheduleAccrualAmountEdit 852, 853, 854 ScheduleAccrualPattern 857, 858, 859, 860 ScheduleAmountType NonCancellingPayCodeEdit tag 513 PayCodeEdit tag 572 ScheduleAssistant WSASchedulePlanner tag 1626 ScheduleChangedFlag MarkForTotalization tag 491 ScheduleCostPaycode 862, 863 ScheduleCostResult 864, 865 ScheduleCostSummaries
1825
Index
Schedule tag 850 ScheduleCostSummary 866, 867 ScheduleCoverage 868, 869, 870 Scheduled WSAAssignmentRule tag 1192 ScheduledDeviation WSACFGDistributionAssignment tag 1252 ScheduleDeviationRuleNames WSAWorkRulePCDistr tag 1707 ScheduledLaborAccountName TotaledScheduledWorkedDuration tag 1046 WorkedDuration tag 1107 ScheduledShiftDisplaySwitch WSADisplayProfile tag 1361 ScheduledShiftExist ScheduleHoursDailyStatus tag 887 ScheduledShiftTypeSwitch WSAEligibilityDeterminer tag 1389 ScheduleEndTime WSAAssignmentRule tag 1192 ScheduleGroup 872, 873, 874, 875 ScheduleGroupId ScheduleGroupProfile tag 877 ScheduleGroupName JobAssignment tag 418 ScheduleAccrualAmountEdit tag 854 ScheduleGroup tag 875 ScheduleGroupProfile tag 878 SchedulePattern tag 904 ScheduleShift tag 929 ScheduleUnavailable tag 937 WTKEmployee tag 1766 ScheduleGroupProfile 876, 877, 878 ScheduleGroupProfileName ManagerRoleScheduleGroupProfile tag 482 ScheduleGroups Schedule tag 850 ScheduleAccrualPattern tag 860 ScheduleHours 880, 881, 882, 883, 884 ScheduleHoursAccrualViolation 885
ScheduleHoursDailyStatus 886, 887 ScheduleHoursException 888 ScheduleHoursStatus 890, 891 ScheduleHoursType WSAPayCode tag 1501 ScheduleItems ProcessSchedule tag 715 Schedule tag 850 ScheduleMarkPosted 892, 893 ScheduleOff 895, 896, 897 SchedulePattern 900, 901, 902, 903, 904, 905 SchedulePatternName AccessAssignment tag 40 SchedulePattern tag 905 SchedulePatternProfileName BidRequest tag 147 ManagerRoleSchedulePatternProfile tag 485 SchedulePatterns Schedule tag 851 SchedulePayCodeEdit 907, 908, 909, 910, 911, 912, 913 SchedulePeriod 915, 916, 917 SchedulePeriodName SchedulePeriod tag 917 WSADisplayProfile tag 1361 ScheduleRuleOverride 919, 920, 921 ScheduleRuleOverrideDetails 923, 924 ScheduleRuleOverrideDetailsList ScheduleRuleOverride tag 921 ScheduleShift 927, 928, 929, 930 ScheduleShiftSwap 932, 933 ScheduleStartTime WSAAssignmentRule tag 1193 ScheduleTotal WSAEffectivePayRule tag 1378 ScheduleUnavailable 934, 935, 936, 937, 938 ScheduleZone 940, 941 ScopeName Permission tag 604 WSAPermission tag 1525
1826
Kronos Incorporated
Index
Seasonal OrgLocation tag 539 SegmentLength GlsegmentDetail tag 350 SegmentNumber GlsegmentDetail tag 350 SegmentTypeName ShiftSegment tag 968 Selected WSAPayRuleHoliday tag 1523 SelectedComponents WSAAPICombinationRule tag 1186 SelectedHolidays WSAZone tag 1719 SelectedLimits WSAZone tag 1720 SelectedOvertimeRules WSAOvertimeCombination tag 1484 SelectedPayCodes WSACombinedPayCodeRule tag 1280 SelectedZoneRules WSAZoneCombinationRule tag 1725 SelectedZones WSAMajorityRule tag 1471 Send EmployeeMessage tag 268 Sender EmployeeMessage tag 269 SendToParticipants BidRequest tag 142 SeniorityDate TransferJobSeniorityDate tag 1056 SeniorityRankDate JobAssignmentDetails tag 421 Sequence BidNote tag 138 Request tag 782 Response tag 797 SequenceNumber FPATrigger tag 309
SequenceRuleName WSAEffectivePayRule tag 1378 ServerName DataSource tag 227 ServerTime 943, 944 Settings SchedGenSettingsValue tag 814 SettingsName CoverageSettings tag 200 LocationProfileSettings tag 471 SchedGenSettings tag 811 SettingsParamDefinition 945, 946 SettingsParameterDefinitionName SettingsParamDefinition tag 946 SettingsParamValue 948 SettingsParamValues CoverageSettings tag 201 LocationProfileSettings tag 472 SchedGenSettings tag 812 SettingsType 950, 951 SettingsTypeName 951 SettingsType tag 951 ShfitCodeProfileName BidRequest tag 147 ShfLenMax WSABonusDeductRule tag 1212 ShfLenMin WSABonusDeductRule tag 1212 ShiftBuilder 953, 954, 955 ShiftCode 957, 958, 959 ShiftCodeName AccessAssignment tag 40 PatternElement tag 563 ScheduleOff tag 895 ScheduleShift tag 927 ShiftCode tag 959 ShiftCodeProfileName ManagerRoleShiftCodeProfile tag 488 ShiftCountSpan 960 ShiftDescription
1827
Index
StandardShift tag 993 ShiftGuarantee WSACallInRule tag 1234 ShiftGuaranteeName WSAEffectiveWorkRule tag 1384 ShiftHistory 963, 964, 965 ShiftLengthExclusions WSAAutoBreakPlacement tag 1198 ShiftLengths WSAAutoBreakPlacement tag 1198 ShiftMax WSAAssignmentRule tag 1193 ShiftMin WSAAssignmentRule tag 1193 ShiftName StandardShift tag 993 ShiftOverride BidGroup tag 130 ShiftReq WSABonusDeductRule tag 1213 ShiftSegment 966, 967, 968, 969 ShiftSegments ScheduleOff tag 895 ScheduleShift tag 927 ShiftCode tag 959 ShiftStartTimeBand 972, 973, 974 ShiftTemplateAssignment 976, 977 ShiftTemplateItem 978 ShiftTemplateItems ShiftTemplateAssignment tag 977 ShiftTemplateProfileName PersonShiftTemplateAssignment tag 657 ShiftTemplateItem tag 978 ShiftTypeName ScheduleOff tag 897 ScheduleShift tag 930 ShiftValidation 980, 981, 982 ShortChgPoint WSABreakRule tag 1221 ShortException
WSABreakRule tag 1221 ShortGrace WSABreakRule tag 1222 ShortName LaborLevelDefinition tag 447 Person tag 612 WSACustomDateType tag 1317 WSAExceptionType tag 1397 ShortRound WSABreakRule tag 1222 ShortShift WSAExceptionRule tag 1395 ShowJobLocationDescriptionSwitch WSADisplayProfile tag 1361 ShowLaborLevelEntryDescriptionSwitch WSADisplayProfile tag 1362 Signature 984, 985, 986 SignatureItem 987 SignatureName Signature tag 986 SignOff ApproveSignoff tag 98 SimplePair 988 SimpleValue 990 AccessProfile tag 48 SimpleValues Names tag 503 SiteWide WSACustomDate tag 1315 SortOrder LaborLevelDefinition tag 448 WfcJob tag 1098 SortOrderName SchedRule tag 820 SchedRuleSortOrder tag 833 SortOrderNumber WSAColumnDetail tag 1275 SourceDetails FailedXMLTransaction tag 290 SourceName
1828
Kronos Incorporated
Index
FailedXMLTransaction tag 290 SourceRuleComponentType WSAAPICombinationTowardOT tag 1188 SourceRuleName WSAAPICombinationTowardOT tag 1188 StandardShift 992, 993 StartBreakRestrictionFlag APIPunchRestrictionOverride tag 82 StartDate 74, 77, 85, 1129 CheckAdvice tag 175 ConnectToScheduleItem tag 193 DelegateAuthorityTask tag 235 EligibleJobs tag 256 PayFromSchedule tag 594 ProcessTask tag 721 ScheduleOff tag 897 SchedulePayCodeEdit tag 912 SchedulePeriod tag 917 ScheduleShift tag 930 ScheduleShiftSwap tag 933 ScheduleUnavailable tag 937 VacationBid tag 1083 WSAHoliday tag 1418 WSAHolidayDate tag 1426 Startdate ScheduleAccrualAmountEdit tag 854 StartDateTime WSAZoneRuleHoliday tag 1734 StartDay WSADayMonthSpan tag 1333 StartDayNumber ShiftSegment tag 968 StartEffectiveDate FPARuleVersion tag 304 OrgLocation tag 540 StartMonth WSADayMonthSpan tag 1334 StartNightPeriod WTDRule tag 1760 StartNumberOfDay
WSAZone tag 1720 StartStrategyType WSADateFinder tag 1327 StartTime ConnectToScheduleItem tag 194 MinimunHoursNoModification tag 500 NonCancellingPayCodeEdit tag 517 PayCodeEdit tag 578 ScheduleShiftSwap tag 933 ScheduleUnavailable tag 938 ShiftSegment tag 968 ShiftStartTimeBand tag 974 ShiftValidation tag 982 SwapShiftEmployees tag 1000 SwapShiftJobs tag 1003 WSABreakRule tag 1222 WSACoreHoursRule tag 1300 WSAHoliday tag 1418 WSAHolidayDate tag 1426 WSAZone tag 1720 StartWorkAfterTime WSAZone tag 1721 StartWorkAfterTimeSwitch WSAZone tag 1721 StartWorkBeforeTime WSAZone tag 1721 StartWorkBeforeTimeSwitch WSAZone tag 1721 State PostalAddress tag 664 Status Bid tag 123 BidRequest tag 148 Response tag 798 VacationBid tag 1084 StopOvertimeFlag PersonalOvertimeAssignment tag 626 Street PostalAddress tag 665 SubsequentGrants
1829
Index
WSAInitialGrant tag 1431 SuccessRecordCount ImportBatchStatus tag 413 SuccessURL Request tag 783 SuiteProduct 994, 995, 996 SuiteProductName 45 Permission tag 604 SuiteProduct tag 996 SummaryType HoursSummary tag 387 ScheduleCostSummary tag 867 Sunday WSAAssignmentRule tag 1193 WSABonusDeductRule tag 1213 WSACoreHoursRule tag 1300 WSADaysOfWeek tag 1337 WSAShiftGuarantee tag 1639 SupervisorData PersonInformation tag 652 SupervisorName JobAssignmentDetails tag 421 SupervisorPersonNumber JobAssignmentDetails tag 422 SwapShiftEmployees 999, 1000 SwapShiftJobs 1002, 1003 SwapShifts ProcessSchedule tag 713 SwitchBackToMyself SwitchRoleEngine tag 1004 SwitchRole SwitchRoleEngine tag 1005 SwitchRoleEngine 1004, 1005 SystemSettings 1008
T
TakingEmployee AccrualMove tag 65 TakingEmployeeAccrualCodeName AccrualMove tag 66
TakingLimits WSAAccrualPolicy tag 1159 TargetOTRuleComponentType WSAAPICombinationTowardOT tag TargetOTRuleName WSAAPICombinationTowardOT tag TaskAttributes ProcessTask tag 721 TaskId DelegateAuthorityTask tag 236 ProcessTask tag 722 TaskName ProcessTask tag 722 TaskState ProcessTask tag 723 TaskStateCode ProcessTask tag 723 TaskString DelegateAuthorityTask tag 236 TaskURL ProcessTask tag 723 TaxableWages CheckAdviceDetailTaxes tag 185 Taxes CheckAdvice tag 175 TaxesList CheckAdvice tag 176 TaxesYTD CheckAdviceDetailTaxes tag 185 TelephoneNumber 1010, 1011 TelephoneNumbers PersonInformation tag 652 TemplateData ProcessTemplate tag 748 TemplateId ProcessTemplate tag 748 TerminalCdNum WSAPayCode tag 1501 TerminalRuleName WSAEffectivePayRule tag 1379
1189 1189
1830
Kronos Incorporated
Index
Text BidNote tag 139 CustomData tag 211 Note tag 518 WSAComment tag 1284 Thursday WSAAssignmentRule tag 1194 WSABonusDeductRule tag 1213 WSACoreHoursRule tag 1300 WSADaysOfWeek tag 1337 WSAShiftGuarantee tag 1639 Time CancelDeductions tag 168 Punch tag 762 PunchStatus tag 766 TimeEntry 1012, 1013 TimeEntryId TimeEntry tag 1013 TimeEntryName TimeEntry tag 1013 TimeEntryTypeName AccessAssignment tag 41 TimeFrameDate TimeFramePeriod tag 1016 TimeFrameName 1763 TimeFramePeriod tag 1017 TimeFramePeriod 1015, 1016, 1017 TimekeepingException 1018, 1019, 1020 TimeOfDay WSABonusDeductRule tag 1214 TimePeriodId GenericEmployeeCalendar tag 332 GenericManagerCalendar tag 340 TimePeriodTypeName ExpectedHours tag 284 Timesheet 1023, 1024, 1025, 1026, 1027 TimeStamp Kronos_WFC tag 424 Timestamp Note tag 519
TimeUnitType WSADateFinder tag 1327 timeUnitType WSAInterval tag 1433 TimeZoneName JobAssignmentDetails tag 422 WTKEmployee tag 1766 To 1028, 1029 TopicName SchedRule tag 820 SchedRuleTopic tag 835 TopicParameterDefinition 1030, 1031 TopicParameterName TopicParameterDefinition tag 1031 TopicParameterValue tag 1032 TopicParameterValue 1032 TopicParameterValues SchedRule tag 821 Total 1033, 1034, 1035, 1036 TotaledPayCodeEdits Timesheet tag 1026 TotaledScheduledPayCodeEdit 1037, 1038, 1039 TotaledScheduledPayCodeEditUneditable 104 0, 1041, 1042, 1043 TotaledScheduledWorkedDuration 1044, 1045, 1046 TotaledSpan 1047, 1048 TotaledSpans Timesheet tag 1026 TotaledWorkedDurations Timesheet tag 1026 TotalHours CheckAdvice tag 176 TotalRecordCount ImportBatchStatus tag 413 Totals DateTotals tag 228 EmployeeSummary tag 275 LockedDataCorrection tag 474
1831
Index
PeriodTotals tag 602 TotalSummary tag 1049 TotalSummary 1049 TotalsUpToDateFlag Timesheet tag 1027 TrackingPeriodName WSACfgAccrualCode tag 1238 TrackStart WSAOvertimeRule tag 1489 Transaction 1050 TransactionSequence Response tag 798 Transaction tag 1050 TransactionType FailedXMLTransaction tag 290 ImportBatchStatus tag 413 TransferEmployee 1051, 1052 TransferEmployeeFlag AccessAssignment tag 41 TransferEmployees Schedule tag 845, 851 TransferGrace WSAPunchRoundRule tag 1548 TransferJobSeniorityDate 1054, 1055, 1056 TransferRegularHome WSAEffectivePayRule tag 1379 TransferRound WSAPunchRoundRule tag 1548 TransferStartTime TransferEmployee tag 1052 TreeNodeType 1058, 1059, 1060, 1061 TreeType WSAOrganizationType tag 1479 TreeTypeCD WSATreeType tag 1668 TreeTypeName TreeNodeType tag 1061 Triggers FPARuleVersion tag 304 TrigpaycodeName
WSABonusDeductRule tag 1214 Tuesday WSAAssignmentRule tag 1194 WSABonusDeductRule tag 1214 WSACoreHoursRule tag 1301 WSADaysOfWeek tag 1337 WSAShiftGuarantee tag 1639 Type BidRequest tag 148 GDAPItem tag 325 NavProfile tag 508 WSAAccrualQualifier tag 1176 WSAAPICombinationComponent tag 1182 WSABonusDeductRule tag 1215 WSACfgAccrualCode tag 1238 WSACreditCalculator tag 1307 WSAOvertimeRule tag 1490 WSAProbationPeriod tag 1530 WSAWageAdjustment tag 1674 WSAWorkHistoryQualifierRule tag 1692 TypeCode WSAPayPeriod tag 1518 WSASequencedItem tag 1632 WSAZone tag 1722 TypeExteriorName WSAWfgColumnSet tag 1684 TypeExteriorNumber WSAWfgColumnSet tag 1684 TypeId EmployeeMessage tag 270 TypeOverride 1062, 1063 Types WSAComment tag 1285
U
UnapprovedOvertimePayCodeName WSAEffectiveWorkRule tag 1385 UnavailableDuration ScheduleHours tag 884 SchedulePayCodeEdit tag 913
1832
Kronos Incorporated
Index
UnavailableStartTime ScheduleHours tag 884 SchedulePayCodeEdit tag 913 UnLockDays Schedule tag 845 UnlockShifts Schedule tag 845 Unscheduled WSAAssignmentRule tag 1194 WSAExceptionRule tag 1395 UnscheduledIn WSATkTerminalRule tag 1664 UnscheduledInGrace WSAPunchRoundRule tag 1549 UnscheduledInRound WSAPunchRoundRule tag 1549 UnscheduledOutGrace WSAPunchRoundRule tag 1549 UnscheduledOutRound WSAPunchRoundRule tag 1550 UnscheduledPunchRestrictionFlag APIPunchRestrictionOverride tag 83 UnscheduledShiftIsRest RBSRuleVersion tag 775 UnscheduledShiftLength WSACallInRule tag 1234 WSATkTerminalRule tag 1664 UntotaledPunches Timesheet tag 1027 UntotaledWorkedDurations Timesheet tag 1027 Update AccrualMove tag 64 APIPunchRestrictionOverride tag 79 BidGroup tag 127 BidRequest tag 143 CalendarProfile tag 159 CalendarProfileAPIFacade tag 163 CancelDeductions tag 167 ConnectToSchedule tag 189
CoverageSettings tag 199 DataAccessGroup tag 220 DataElementAPIFacade tag 223 DataSetAPIFacade tag 225 EarnedAccrual tag 247 EmployeeGroupAssign tag 260 EmployeePreferredZone tag 272 FPARule tag 299 GDAPAssignment tag 319 GDAPAssignmentDefaultSwitch tag 323 GenericEmployeeCalendar tag 330 GenericEmployeeCalendarAPIFacade tag 334 GenericManagerCalendar tag 338 HPPDService tag 394 ImportBatchStatus tag 410 LaborAccount tag 430 LaborAccountSet tag 439 LaborLevelEntry tag 451 LocationProfileSettings tag 470 MarkForTotalization tag 490 NavProfile tag 506 OrgLocationsImport tag 541 OrgSet tag 546 Personality tag 620 PersonCertificationAssign tag 635 PersonShiftTemplateAssignment tag 657 PersonSkillAssign tag 659 Procedure tag 677 ProcedureSet tag 690 ProcessorToEmployee tag 706 RBSRule tag 770 ResetAccrual tag 793 RoleProfileKBO tag 801 RuleSetEmployeeAssign tag 805 SchedGenSettings tag 810 SchedRule tag 818 SchedRuleSet tag 829 Schedule tag 846 ScheduleAccrualPattern tag 857
1833
Index
ScheduleGroup tag 873 ScheduleMarkPosted tag 892 SchedulePattern tag 902 SchedulePeriod tag 916 ScheduleRuleOverride tag 919 ShiftCode tag 958 ShiftTemplateAssignment tag 977 Signature tag 986 TransferJobSeniorityDate tag 1055 WorkerType tag 1110 WorkWeek tag 1130 WorkWeekAssignments tag 1134 WorkWeekDay tag 1136 WSAAccrualDetail tag 1144 WSAAccrualDetailColumnSet tag 1149 WSAAccrualPolicy tag 1153 WSAAccrualProfile tag 1170 WSAAPICombinationRule tag 1185 WSAAvailabilityPatternDAP tag 1200 WSABonusDeductRule tag 1206 WSABreakRule tag 1217 WSACallInRule tag 1229 WSACfgAccrualCode tag 1236 WSACfgContactTypeList tag 1243 WSACfgCustomDataList tag 1248 WSACFGPaycodeDistribution tag 1260 WSACombinedPayCodeRule tag 1279 WSAComment tag 1283 WSAContributingPayCodeRule tag 1289 WSAContributingShiftRule tag 1292 WSACoreHoursRule tag 1297 WSACustomDate tag 1314 WSACustomUrl tag 1319 WSACustomUrlProfile tag 1322 WSADatePattern tag 1330 WSADetail tag 1340 WSADetailColumnSet tag 1344 WSADisplayOrder tag 1348 WSADisplayProfile tag 1352 WSAExceptionRule tag 1392
WSAFixedRule tag 1399 WSAFunctionAccessProfile tag 1402 WSAGrant tag 1410 WSAHoliday tag 1416 WSAHolidayCreditRule tag 1421 WSAIntervalRoundRule tag 1435 WSALaborLevel tag 1439 WSALaborLevelEntry tag 1443 WSALeaveCaseDetail tag 1447 WSALeaveCaseDetailColumnSet tag 1451 WSALimit tag 1456 WSALogonProfile tag 1460 WSAMajorityRule tag 1469 WSAOvertimeCombination tag 1483 WSAOvertimeRule tag 1486 WSAPatternTemplateDAP tag 1493 WSAPayCode tag 1498 WSAPayCodeDAP tag 1505 WSAPayCodeDistribution tag 1508 WSAPayRule tag 1520 WSAProcessingOrderRule tag 1535 WSAPunchRoundRule tag 1539 WSAQuickFind tag 1552 WSAReportDAP tag 1556 WSARollup tag 1561 WSARollupColumnSet tag 1565 WSAScheduleAssistant tag 1569 WSAScheduleAssistantColumnSet tag 1573 WSAScheduleDeviationRule tag 1579 WSAScheduledHoursType tag 1583 WSAScheduleEditor tag 1586 WSAScheduleEditorColumnSet tag 1591 WSAScheduleGroupDAP tag 1595 WSAScheduleGroupDetail tag 1600 WSAScheduleGroupDetailColumnSet tag 1604 WSAScheduleGroupRollup tag 1612 WSAScheduleGroupRollupColumnSet tag 1616 WSASchedulePlanner tag 1623
1834
Kronos Incorporated
Index
WSASchedulePlannerColumnSet tag 1628 WSASequencerRule tag 1634 WSAShiftGuarantee tag 1637 WSAShiftTemplateDAP tag 1645 WSASignOffRestriction tag 1649 WSATkTerminalRule tag 1658 WSAULLE tag 1670 WSAWageProfile tag 1676 WSAWorkforceGenieProfile tag 1687 WSAWorkHistoryQualifierRule tag 1691 WSAWorkRule tag 1697 WSAWorkRuleDAP tag 1700 WSAZoneCombinationRule tag 1724 WSAZoneRule tag 1731 WTDEmployeeAssignment tag 1739 WTDGlobal tag 1745 WTDRule tag 1753 update ShiftStartTimeBand tag 973 TreeNodeType tag 1059 UpdateAndLoad LaborAccount tag 430 Updated ScheduleCostSummary tag 867 UpdateDateTime WTDGlobal tag 1748 UpdatedDate LaborAccountSet tag 441 UpdateEntryList DelegateProfile tag 239 OrgSet tag 547 UpdateOnly BidGroup tag 127 BidRequest tag 143 CoverageSettings tag 199 DataAccessGroup tag 220 DelegateProfile tag 240 GDAPAssignment tag 319 LaborAccountSet tag 439 LaborLevelEntry tag 452
LocationProfileSettings tag 470 OrgSet tag 547 Personality tag 620 Procedure tag 677 ProcedureSet tag 690 Process tag 699 ProcessorToEmployee tag 706 ProcessTask tag 718 ProcessTemplate tag 742 RoleProfileKBO tag 802 SchedGenSettings tag 810 SchedRule tag 818 SchedRuleSet tag 829 Signature tag 986 WfcJob tag 1096 WorkerType tag 1110 WorkflowAccessAssignment tag 1115 WTDGlobal tag 1745 WTDRule tag 1753 updateOnly ShiftStartTimeBand tag 973 URL MenuItem tag 497 Urls WSACustomUrlProfile tag 1324 UrlText WSACustomUrl tag 1320 UseAllShiftsSwitch WSACreditCalculator tag 1307 UseBreakVar WSAOvertimeRule tag 1491 UsedBy ProcessTemplate tag 749 UseHighestWageSwitch WSAWageProfile tag 1677 User 1065, 1066 Menu tag 494 UserAccount 1067, 1068, 1069, 1070 UserAccountData HyperFindResult tag 407
1835
Index
User tag 1066 UserAccountLockout 1072 UserAccountLockouts User tag 1066 UserAccountStatus 1075, 1076 UserAccountStatusList PersonInformation tag 653 UserAccountStatusName UserAccountStatus tag 1076 UserData Personality tag 622 UserKey CurrentUser tag 208 PersonIdentity tag 643 UserName 458, 459 ApproveSignoff tag 99 AuditTrail tag 109 DataSource tag 227 Request tag 783 ShiftBuilder tag 955 ShiftHistory tag 965 UserAccount tag 1070 UserPassword UserAccount tag 1070 UseScheduleAmount WSAAccrualPolicy tag 1160 UseScheduledOut WSAIntervalRoundRule tag 1437 WSAPunchRoundRule tag 1550 UseScheduleFlag PersonalOvertimeRule tag 631 UseShorthandLaborAccountNotationSwitch WSADisplayProfile tag 1362
V
VacationBid 1079, 1080, 1081, 1082, 1083, 1084 VacationPayCodeName BidRequest tag 149 ValidateAllNewEntriesSwitch
WSALaborLevel tag 1441 Value Attribute tag 100 CoverageSettingsValue tag 203 CustomOperator tag 214 SettingsParamValue tag 948 SimplePair tag 988 SimpleValue tag 990 SystemSettings tag 1008 TopicParameterValue tag 1032 WSACombinationRule tag 1277 ValueName WSAZoneCombinationSpecificationRule tag 1727 ValueType HoursSummary tag 387 HPPDSummary tag 398 ValueTypeName HPPDItem tag 391 SchedRuleValueType tag 837 SettingsParamDefinition tag 946 Version Kronos_WFC tag 425 ProcessTemplate tag 749 SuiteProduct tag 996 versionStartDate 307 VestedBalanceInCurrency AccrualBalanceSummary tag 55 VestedBalanceInTime AccrualBalanceSummary tag 56 ViewType ApplicationCalendar tag 94 GenericEmployeeCalendar tag 332 GenericManagerCalendar tag 341 ViolationMessage ScheduleHoursAccrualViolation tag 885 ScheduleHoursException tag 888 VisibilityCode HyperFindQuery tag 404 VisibleInMainArea
1836
Kronos Incorporated
Index
WSAPayCode tag 1502 VisibleInReport WSACombinedPayCodeRule tag WSAPayCode tag 1502 VisibleToUser WSACombinedPayCodeRule tag WSAPayCode tag 1502 VisualIndexNumber WSAColumnDetail tag 1275
1280
1281
W
WageAddition WSAPayCode tag 1502 WageAdjustmentAmount FPAAllocation tag 295 WageAdjustmentType FPAAllocation tag 295 WageCalculation WSACreditCalculator tag 1308 WageMultiply WSAPayCode tag 1503 WagePercent WSACreditCalculator tag 1308 WageProfile 1086, 1087, 1088 WageProfileId WageProfile tag 1087 WageProfileLLDef WSAWageProfile tag 1677 WageProfileName JobAssignmentDetails tag 422 WageProfile tag 1088 WSAWageAdjustment tag 1674 WSAWageProfileLaborLevelLinkage tag 1680 WTKEmployee tag 1766 Wages ScheduleCostPaycode tag 863 WarningAmount WSAAccrualPolicyTakingLimit tag 1167 Wednesday
WSAAssignmentRule tag 1195 WSABonusDeductRule tag 1215 WSACoreHoursRule tag 1301 WSADaysOfWeek tag 1337 WSAShiftGuarantee tag 1640 WeekDay 1089, 1090 WeekDayId ScheduleRuleOverrideDetails tag 924 WeekStart WSABonusDeductRule tag 1215 WFCGenie 1092, 1093, 1094 WfcJob 1096, 1097, 1098, 1099 WfcJobDesc WfcJob tag 1098 WfcJobName WfcJob tag 1099 WfcJobNewName WfcJob tag 1099 WFCVersion Kronos_WFC tag 425 WgpPayCodes WSAWageProfile tag 1678 Width GenieColumn tag 345 WildCard 451 Wildcard 450 WorkedAveragePeriod WTDRule tag 1760 WorkedDuration 1101, 1102, 1103, 1104, 1105, 1106, 1107 WorkerType 1109, 1110, 1111 WorkerTypeElement 1112, 1113 WorkerTypeElements WorkerType tag 1111 WorkerTypeName JobAssignmentDetails tag 423 WorkerTypeElement tag 1113 WorkflowAccessAssignment 1115, 1116 WorkflowTemplateCategory 1118, 1119 WorkforceGenieProfileName
1837
Index
WSADisplayProfile tag 1362 WorkloadPatternType EffectiveWorkload tag 252 WorkloadPlannerProfileName WSADisplayProfile tag 1362 WorkloadPlanType EffectiveWorkload tag 253 WorkloadSpanName HeadcountPattern tag 356 WorkloadType EffectiveWorkload tag 253 WorkRule 1122 WSAShiftGuarantee tag 1640 WorkRuleGeneral WSAEffectiveWorkRule tag 1385 WorkRuleName AppendShifts tag 91 ConnectToScheduleItem tag 194 HistoricalPayCodeEdit tag 364 HistoricalPayCodeMove tag 373 Punch tag 763 ShiftSegment tag 969 TotaledScheduledWorkedDuration tag 1046 TransferEmployee tag 1052 WorkedDuration tag 1107 WorkRule tag 1122 WSAAssignmentRule tag 1195 WSACreditCalculator tag 1309 WSAEffectivePayRule tag 1379 WorkRulePCDistr WSAEffectiveWorkRule tag 1385 WorkRuleProfile 1125, 1126 WorkRuleProfileId WorkRuleProfile tag 1125 WorkRuleProfileName WorkRuleProfile tag 1126 WorkRuleTransfers WSAEffectivePayRule tag 1379 WorkWeek 1128, 1129, 1130, 1131, 1132 WorkWeekAssignments 1133, 1134, 1135
WorkWeekDay 1136, 1137, 1138 WorkWeekDays WorkWeek tag 1132 WorkWeekLength WTDRule tag 1760 WorkWeekName WorkWeekAssignments tag 1135 WSAAccrualCode 1140, 1141 WSAAccrualDetail 1143, 1144, 1145, 1146 WSAAccrualDetailColumnSet 1148, 1149, 1150 WSAAccrualPolicy 1152, 1153, 1154, 1155, 1156, 1157, 1158, 1159, 1160 WSAAccrualPolicyGrant 1161, 1162 WSAAccrualPolicyLimit 1163, 1164 WSAAccrualPolicyPayCode 1165 WSAAccrualPolicyTakingLimit 1166, 1167 WSAAccrualProfile 1169, 1170, 1171 WSAAccrualProfilePolicy 1172 WSAAccrualQualifier 1174, 1175, 1176 WSAAPICombination 1177, 1178, 1179 WSAAPICombinationComponent 1180, 1181, 1182 WSAAPICombinationRule 1184, 1185, 1186 WSAAPICombinationTowardOT 1187, 1188, 1189 WSAAssignmentRule 1191, 1192, 1193, 1194, 1195 WSAAutoBreakPlacement 1197, 1198 WSAAvailabilityPatternDAP 1200, 1201 WSAAvailabilityPatternProfileItem 1202, 1203 WSABonusDeductRule 1205, 1206, 1207, 1208, 1209, 1210, 1211, 1212, 1213, 1214, 1215 WSABreakRule 1217, 1218, 1219, 1220, 1221, 1222 WSABreakTime 1223, 1224, 1225 WSACalendarProfile 1226, 1227
1838
Kronos Incorporated
Index
WSACallInRule 1229, 1230, 1231, 1232, 1233, 1234 WSACfgAccrualCode 1236, 1237, 1238 WSACfgContactType 1239, 1240, 1241 WSACfgContactTypeList 1243, 1244 WSACfgCustomData 1245, 1246 WSACfgCustomDataList 1248, 1249 WSACFGDistributionAssignment 1251, 1252 WSACFGExtProcessorComponent 1253, 1254 WSACFGOvertimeComponent 1255, 1256 WSACFGPaycodeAssignment 1257, 1258 WSACFGPaycodeDistribution 1260, 1261 WSACFGZoneComponent 1262, 1263 WSAColumnDefinition 1264, 1265 WSAColumnDefinitionDataType 1267, 1268, 1269 WSAColumnDetail 1271, 1272, 1273, 1274, 1275 WSACombinationRule 1277 WSACombinedPayCodeRule 1278, 1279, 1280, 1281 WSAComment 1283, 1284, 1285 WSACommentType 1286, 1287 WSAContactTypeList WSACfgContactTypeList tag 1244 WSAContributingPayCodeRule 1288, 1289, 1290 WSAContributingShiftRule 1292, 1293, 1294 WSACoreHoursRule 1297, 1298, 1299, 1300, 1301 WSACreditCalculator 1303, 1304, 1305, 1306, 1307, 1308, 1309 WSAHolidayCreditRule tag 1423 WSACriteriaSet 1310, 1311 WSACustomDataList WSACfgCustomDataList tag 1249 WSACustomDate 1313, 1314, 1315 WSACustomDateType 1316, 1317 WSACustomUrl 1318, 1319, 1320 WSACustomUrlProfile 1322, 1323, 1324
WSADateFinder 1325, 1326, 1327 WSADatePattern 1329, 1330, 1331 WSADayMonthSpan 1333, 1334 WSADaysOfWeek 1335, 1336, 1337 WSADetail 1340, 1341, 1342 WSADetailColumnSet 1344, 1345, 1346 WSADisplayOrder 1348, 1349 WSADisplayProfile 1351, 1352, 1353, 1354, 1355, 1356, 1357, 1358, 1359, 1360, 1361, 1362 WSADisplayProfileWorkforceGenieProfile 13 63, 1364 WSADispOrdOptionalRule 1365, 1366 WSADPLaborLevelDefinition 1367, 1368 WSADPPayCode 1369, 1370 WSADPTimePeriod 1371, 1372 WSAEffectivePayRule 1374, 1375, 1376, 1377, 1378, 1379 WSAEffectiveWorkRule 1382, 1383, 1384, 1385 WSAEligibilityDeterminer 1386, 1387, 1388, 1389 WSAHolidayCreditRule tag 1424 WSAExceptionRule 1392, 1393, 1394, 1395 WSAExceptionType 1396, 1397 WSAFixedRule 1398, 1399, 1400 WSAFunctionAccessProfile 1402, 1403, 1404 WSAGenie 1405, 1406, 1407 WSAGrant 1409, 1410, 1411, 1412, 1413, 1414 WSAHoliday 1416, 1417, 1418, 1419 WSAHolidayCreditRule 1421, 1422, 1423, 1424 WSAHolidayDate 1425, 1426 WSAHolidayDates WSAHoliday tag 1419 WSAHyperfindQuery 1427, 1428, 1429 WSAInitialGrant 1430, 1431 WSAInterval 1432, 1433 WSAIntervalRoundRule 1435, 1436, 1437 WSALaborLevel 1439, 1440, 1441
1839
Index
WSALaborLevelEntry 1442, 1443, 1444 WSALeaveCaseDetail 1447, 1448, 1449 WSALeaveCaseDetailColumnSet 1451, 1452, 1453 WSALimit 1455, 1456, 1457, 1458 WSALogonProfile 1460, 1461, 1462, 1463, 1464 WSAMainTab 1466, 1467 WSAMajorityRule 1469, 1470, 1471 WSANavbarCategory 1472, 1473 WSAOptionalRule 1474, 1475 WSAOrganizationType 1477, 1478, 1479 WSAOverridePayCode 1480 WSAOvertimeCombination 1483, 1484 WSAOvertimeRule 1486, 1487, 1488, 1489, 1490, 1491 WSAPatternTemplateDAP 1493, 1494 WSAPatternTemplateProfileItem 1495, 1496 WSAPayCode 1498, 1499, 1500, 1501, 1502, 1503 WSAPayCodeDAP 1505, 1506 WSAPayCodeDistribution 1508, 1509, 1510 WSAPayCodeProfileItem 1511, 1512 WSAPayDistributionAssociation 1513, 1514, 1515 WSAPayPeriod 1516, 1517, 1518 WSAPayRule 1519, 1520, 1521 WSAPayRuleHoliday 1522, 1523 WSAPermission 1524, 1525 WSAProbationPeriod 1528, 1529, 1530 WSAProbationQualifier 1531, 1532, 1533 WSAProcessingOrderRule 1535, 1536 WSAPunchRoundRule 1538, 1539, 1540, 1541, 1542, 1543, 1544, 1545, 1546, 1547, 1548, 1549, 1550 WSAQuickFind 1552, 1553, 1554 WSAReportDAP 1556, 1557 WSAReportProfileItem 1558, 1559 WSARollup 1561, 1562, 1563 WSARollupColumnSet 1565, 1566, 1567
WSAScheduleAssistant 1568, 1569, 1570, 1571 WSAScheduleAssistantColumnSet 1573, 1574, 1575 WSAScheduleAssistantTab 1576, 1577 WSAScheduleDeviationRule 1579, 1580 WSAScheduledHoursType 1582, 1583, 1584 WSAScheduleEditor 1586, 1587, 1588, 1589 WSAScheduleEditorColumnSet 1591, 1592, 1593 WSAScheduleGroupDAP 1595, 1596 WSAScheduleGroupDetail 1599, 1600, 1601, 1602 WSAScheduleGroupDetailColumnSet 1604, 1605, 1606 WSAScheduleGroupProfileItem 1608, 1609 WSAScheduleGroupRollup 1611, 1612, 1613, 1614 WSAScheduleGroupRollupColumnSet 1616, 1617, 1618 WSASchedulePeriod 1620, 1621 WSASchedulePlanner 1623, 1624, 1625, 1626 WSASchedulePlannerColumnSet 1628, 1629, 1630 WSASequencedItem 1631, 1632 WSASequencerRule 1634, 1635 WSAShiftGuarantee 1637, 1638, 1639, 1640 WSAShiftLength 1641, 1642 WSAShiftLengthExclusion 1643 WSAShiftTemplateDAP 1645, 1646 WSAShiftTemplateProfileItem 1647 WSASignOffRestriction 1648, 1649, 1650, 1651 WSASubsequentGrant 1652, 1653 WSATimePeriod 1654, 1655 WSATkTerminalRule 1657, 1658, 1659, 1660, 1661, 1662, 1663, 1664 WSATreeType 1666, 1667, 1668 WSAULLE 1670, 1671 WSAWageAdjustment 1672, 1673, 1674
1840
Kronos Incorporated
Index
WSAWageProfile 1676, 1677, 1678 WSAWageProfileLaborLevelLinkage 1679, 1680 WSAWageProfilePayCode 1681, 1682 WSAWfgColumnSet 1683, 1684 WSAWorkforceGenieProfile 1687, 1688 WSAWorkHistoryQualifierRule 1690, 1691, 1692 WSAWorkloadPlannerProfile 1694, 1695 WSAWorkRule 1696, 1697, 1698 WSAWorkRuleDAP 1700, 1701 WSAWorkRuleGeneral 1702, 1703 WSAWorkRulePCDistr 1705, 1706, 1707 WSAWorkRuleProfileItem 1708, 1709 WSAZone 1711, 1712, 1713, 1714, 1715, 1716, 1717, 1718, 1719, 1720, 1721, 1722 WSAZoneCombinationRule 1724, 1725 WSAZoneCombinationSpecificationRule 1726 , 1727 WSAZoneCombinationZoneRule 1728, 1729 WSAZoneRule 1730, 1731, 1732 WSAZoneRuleHoliday 1733, 1734 WSAZoneRuleLimit 1735, 1736 WtdAssignmentId OptOutStatusList tag 532 WtdEmployeeAssgnmntId OptOutStatus tag 531 WTDEmployeeAssignment 1738, 1739, 1740, 1741 WTDGlobal 1743, 1744, 1745, 1746, 1747, 1748 WTDRule 1750, 1751, 1752, 1753, 1754, 1755, 1756, 1757, 1758, 1759, 1760, 1761 WtdRuleId WTDEmployeeAssignment tag 1741 WTKEmployee 1763, 1764, 1765, 1766 WTKEmployeeData HyperFindResult tag 407 Personality tag 622
X
XMLRequestBeginDate FailedXMLTransaction tag XMLRequestBeginTime FailedXMLTransaction tag XMLRequestBodyText FailedXMLTransaction tag XMLRequestEndDate FailedXMLTransaction tag XMLRequestEndTime FailedXMLTransaction tag XMLRequestHeaderText FailedXMLTransaction tag 291 291 291 292 292 292
Y
YoungWorkerAge WTDRule tag 1761 YoungWorkerMaxDailyHours WTDRule tag 1761 YoungWorkerMaxWeeklyHours WTDRule tag 1761
Z
Zone WSAZoneRule tag 1732 ZoneCombination WSAPayCodeDistribution tag 1510 ZoneComponents WSACFGDistributionAssignment tag 1252 ZoneDescription ScheduleZone tag 941 ZoneName ScheduleZone tag 941 WSACFGZoneComponent tag 1263 ZoneRuleNames WSAWorkRulePCDistr tag 1707 Zones WSAPayDistributionAssociation tag 1515
1841
Index
1842
Kronos Incorporated