Kronos WFC Developers Toolkit Reference Timekeeping v6

Workforce Central Developers Toolkit Reference Guide Timekeeping

An alphabetical listing of the XML application programming interface (API) tag definitions that are used by the Workforce Central platform and Workforce Timekeeper.

Kronos Workforce Central Suite Version 6

Document Part Number: 4703971-001 Document Revision: A

The information in this document is subject to change without notice and should not be construed as a commitment by Kronos Incorporated. Kronos Incorporated assumes no responsibility for any errors that may appear in this manual. This document or any part thereof may not be reproduced in any form without the written permission of Kronos Incorporated. All rights reserved. Copyright 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

4

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

Workforce Central Developers Toolkit Reference GuideTimekeeping

5

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

6

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


7

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

8

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


9

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

About This Guide

This reference guide defines and describes the Kronos XML API for Workforce Timekeeper. This preface contains the following sections: Organization of this guide on page 20 Abbreviations and terms on page 21

About This Guide

Organization of this guideThis reference guide contains the following information: Chapter 1, Introduction, on page 23 provides an overview on how to use the reference information. Chapter 2, Workforce Timekeeper XML API Tag Definitions, on page 31 contains detailed information about each XML tag.

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

20

Kronos Incorporated

Abbreviations and terms

Abbreviations and termsThe following abbreviations and terms are used in this reference guide:Abbreviation API DTK HTML HTTP HTTPS RDBMS TCP/IP URL XML Term Application Program Interface Developers Toolkit Hypertext Markup Language Hypertext Transfer Protocol Hypertext Transfer Protocol Secure Relational Database Management System Transmission Control Protocol/Internet Protocol Universal Resource Locator Extensible Markup Language


21

About This Guide

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

Using the tag descriptionsThe XML tags are described using standard formats and conventions, described in this section. XML tag name The XML tag name includes the technical name, or how the tag is referenced in code, and the non-technical name, or how the tag is referenced in the XML Import and Export Programmer Guides and the user interface. Example technical name: CheckAdvice Example non-technical name: Earnings History XML tag description The XML tag description gives an overview of what the XML tag is used for, and specifies whether it is used by another XML tag. The description also includes tag level validations, if they are not standard validations. For example, standard date validation is not mentioned, but if the date must fall during the last week of a month, the information is included. Function access control point The function access control point identifies the functional area that a user must have access to in order to use the XML tags within that functional area. For example, for the Punch tag, the function access control point is API.Timecard. This means that a user must have access to Timecard in order to use this tag. To validate whether a user has the appropriate access rights, complete these steps in Workforce Central Setup. Contact your system administrator if you do not have access to Workforce Central Setup: 1. Click Access Profiles. 2. Click Function Access Profiles from the list on the left. 3. Click the function access profile associated with the user whose access rights you are checking; for example, IS. The Edit Function Access Profile window opens.

24

Kronos Incorporated

Using the tag descriptions

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

after one year, whichever date is later.Syntax This section describes the abstract syntax for the XML tag. XML tag names, action names, action parameters, and property names are case sensitive. Example: Request --> Properties Actions --> "AddComment" | "AddOnly" | "Delete" Parameters --> [ AccrualOverride = Boolean ]


25

Chapter 1

Introduction

[ allowAdHoc = Boolean ] [ EchoData = Boolean ] Properties --> ( * ) | 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 italicBrackets [ ]

Parenthesis ()

26

Kronos Incorporated


Syntax

Description Mutually exclusive options

Example

vertical pipe | asterisk * plus sign +

"AddComment" | "AddOnly" | "Delete"Choose one of these actions.

Array of zero or more occurrences * 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

after one year, whichever date is later.Property descriptions The property description describes all of the properties specified for an XML tag. The property name includes the technical name, or how the property is referenced in code; and the non-technical name, or how the property is referenced in the XML Import and Export Programmer Guides and the user interface. The description describes each property, including validation rules. Allowed Values identifies a predefined set of allowable values for the property. The Default Value item identifies a default value, where appropriate. The Contributes to Uniqueness item identifies properties that are required as part of the unique identification of an instance of a tag.

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,

or after one year, whichever date is later.


29

Chapter 1

Introduction

30

Kronos Incorporated

Chapter 2

Workforce Timekeeper XML API Tag Definitions

This chapter lists, in alphabetic order, the XML API Tag descriptions

Chapter 2


AccessAssignment Tag Access RightsThe AccessAssignment tag enables you to specify access rights for a person. Access rights can also be displayed and edited online in the People Editor. The user of this tag must have access rights to view or edit the specified data. Used by: PersonInformation Dependency: Access to this information is controlled through the Role View access control point. The user must have view or add access rights to retrieve or modify the information in this tag. Function Access Control Point: API.Person Introduced in v4; last changed in v5.2

SyntaxProperties

32

Kronos Incorporated

AccessAssignment Tag

Property DescriptionsAccessProfileName

Function access profileThe name of the person's function access profile. The function access profile contains a set of permissions and restrictions that determine which components users can access and the types of functions they can perform. For information about function access profiles and related concepts, see the online help. The following predefined data values are available: &DEFAULT &OTHER_MANAGER &PAYROLL_MANAGER &IS &TIMESTAMP_EMPLOYEE &WORKFORCE_EMPLOYEE

Type: String Optional Maximum length: 50 characters Default value: Specified in the Access Profile Editor in Timekeeping Setup Introduced in v4; last changed in v5.1 AvailabilityPatternName

Availability template profileThe name of the availability template profile that an individual can use when in a manager's role. An availability template is a series of availability settings for a recurring time period that a manager can assign to multiple employees and reuse as needed. An availability template profile is a group of availability templates. Type: String Optional Maximum length: 30 characters


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

Delegate profile nameDelegate Profile contains the list of people to whom the user with that profile may delegate his/her authority. Type: String Optional Sample values: Empty Profile Default value: &EMPTY Introduced in v5.2 GroupScheduleName

Schedule group profileContains the name of a manager's schedule group profile. A schedule group is a set of employees who work the same shifts, and the schedule group profile is a set of schedule groups. The following predefined data values are available: &ALL_SCHEDULE_PATTERNS and &EMPTY_PROFILE for all schedules &ALL_GROUP_SCHEDULES and &EMPTY for all group schedules

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


Introduced in v5.0; last changed in v5.1 ManagerAccessSetName

Employee group profileThe name of the labor level set that is the manager's employee group when an individual is in a manager role. This gives the manager access to the records of those individuals whose primary accounts are in that labor level set. The following predefined data values are available: &ALL_LABOR_ACCOUNTS &EMPTY

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

Pay codes Edit profile - managerThe name of the pay code profile that applies to an individual when in a manager role. A pay code profile identifies those pay codes that the manager can select for editing. The following predefined data values are available: &ALL_PAY_CODES &EMPTY

Type: String Optional Maximum length: 50 characters Dependency: Only specify for a person who has a manager's license. Introduced in v4; last changed in v5.2


35

Chapter 2


ManagerTransferSetName

Labor level transfer set - managerThe name of the labor level transfer set that applies to an individual when in a manager role. A labor level transfer set is a group of labor level entries that a manager or employee can use to transfer time or money. The following predefined data values are available: Type: String Optional Maximum length: 30 characters Must be identified as a labor account set and have a Type of Employee Groups (Manager) or All Sets (Both Manager and Transfer) Dependency: Only specify for a person who has a manager's license. Introduced in v4; last changed in v5.1 ManagerViewPayCodeName &ALL_LABOR_ACCOUNTS &EMPTY

Pay codes View profile - managerThe name of the pay code profile that applies to an individual when in a manager role. A pay code profile identifies those pay codes that the manager can select for viewing. The following predefined data values are available: &ALL_PAY_CODES &EMPTY

Type: String Optional Maximum length: 50 characters Dependency: Only specify for a person who has a manager's license.

36

Kronos Incorporated


Introduced in v5.2 ManagerWorkRuleName

Work rule profile - managerThe name of the work rule profile that applies to an individual in a manager role. A work rule profile is a set of rules that determines how employee hours accrue (for example, details about how punches round, what types of overtime can be earned, which pay codes hold what type of hours, and policies for meals and breaks). The following predefined data values are available: &ALL_WORK_RULES &EMPTY

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 profileThe 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


Introduced in v4; last changed in v5.0 ProfessionalPayCodeName

Pay codes profile - employeeThe name of the pay code profile that applies to an individual when in an employee role. A pay code profile identifies those pay codes that the employee can select. The following predefined data values are available: &ALL_PAY_CODES &EMPTY

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

Labor level transfer set - employeeThe name of the labor level transfer set that applies to an individual when in an he name of the labor level transfer set that applies to an individual when in an employee role. A labor level transfer set is a group of labor level entries that a manager or employee can use to transfer time or money. The following predefined data values are available: &ALL_LABOR_ACCOUNTS &EMPTY

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


Dependency: Only specify for an employee who has a user account. Introduced in v4; last changed in v5.1 ProfessionalWorkRuleName

Work rule profile - employeeThe name of the work rule profile that applies to an individual in an employee role. A work rule profile is a set of rules that determines how employee hours accrue (for example, details about how punches round, what types of overtime can be earned, which pay codes hold what type of hours, and policies for meals and breaks). The following predefined data values are available: &ALL_WORK_RULES &EMPTY

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 profileContains 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

Type: String Optional Maximum length: 30 characters


39

Chapter 2


Dependency: Only specify for a person who has a manager license. Introduced in v4; last changed in v5.1 SchedulePatternName

Pattern template profileContains the name of a manager's pattern template profile. Pattern templates contain a series of shifts that managers can assign to multiple employees. This pattern template profile identifies those pattern templates that the individual can select when in a manager's role. The following predefined data values are available: &ALL_SCHEDULE_PATTERNS &EMPTY

Type: String Optional Maximum length: 50 characters Dependency: Only specify for a person who has a manager license. You can find values in Setup Application. Default value: The Empty Data Access Profile Introduced in v5.0; last changed in v5.1 ShiftCodeName

Shift template profileThe name of the shift template profile that an individual can use when in a manager's role. A shift template is a shift with all its segments that a manager can assign to multiple employees and reuse as needed, and a shift template profile is a group of shift templates. The following predefined data values are available: &ALL_SHIFT_CODES &EMPTY_PROFILE

Type: String

40

Kronos Incorporated


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

Time entry methodIndicates the method that the person uses for entering time. Specify one of the following numbers to represent the data value: 1 for Timestamp 2 for Timestamp and Hourly View 3 for Hourly View 4 for Project View

Type: String Optional Maximum length: 1 character Enumerated value: 1, 2, 3, 4 Introduced in v4; last changed in v5.1 TransferEmployeeFlag

Can see transferred employeesIndicates whether the user can view data for employees who have transferred into work labor accounts that match the primary accounts to which the user has access. TransferEmployeeFlag can have the following values: False, if the user cannot see employees who have transferred in True, if the user can see employees who have transferred in

Type: Boolean


41

Chapter 2


Optional Enumerated value: True, False Introduced in v4

42

Kronos Incorporated

AccessProfile Tag

AccessProfile Tag Access ProfileThe AccessProfile tag provides information about access controls. Use it to check a specific access control prior to attempting to perform an action, such as edit. Access profiles are created in Setup and are assigned to people in the online People Editor. The tag provides the following types of information: Access Control Points identify the types of access that can be made available; for example, whether access can be made available for HomeLaborAccount. Actions identify what a user can do with data; for example, edit. Suite Products identify components of the system that can be made available; for example, DCM.

Function Access Control Point: API.AccessProfile Introduced in v4; last changed in v5.2

SyntaxRequest Properties Actions "IsPermitted" | "Load" | "LoadAllAccessControlPointNames" | "LoadAllActionNames" | "LoadAllowedPermissions" | "LoadAllSuiteProductNames" Parameters IsPermitted AccessControlPointName = String ActionName = String [PersonNumber = String]


43

Chapter 2


SuiteProductName = String Properties ( * ) ( * )

Action DescriptionsIsPermitted 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

Action Parameters Parameter Name Description Additional information

AccessControlPointNam The name of the access control point. Introduced in v4 e Required This name must be listed in the Access Control Point table. Otherwise, the system returns False. ActionName The name of the action. 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 DescriptionsAccessProfileName

Access profile name

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

DescriptionDescribes the access profile. Type: String Output Only Maximum length: 250 characters Introduced in v4


47

Chapter 2


Permission

PermissionThe 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 valueInformation 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

AccrualBalanceSummary Tag Accrual Balance for a PersonThe AccrualBalanceSummary tag returns data about an accrual balance for one person. Used by: AccrualData, EmployeeSummary Function Access Control Point: API.Accruals Introduced in v4; last changed in v5.1

SyntaxProperties

Property Descriptions


49

Chapter 2


AccrualCodeId

Accrual code IdA unique identifier for the accrual code. Type: Long Output Only Introduced in v4 AccrualCodeName

Accrual code nameA named account containing the category in which time or money accrues, such as sick, personal, or vacation. Type: String Output Only Sample values: Vacation, Sick Introduced in v4; last changed in v5.1 AccrualType

Type of accrualThe type identifier displayed for an accrual: 1 for hours, 2 for days, 3 for currency. Type: Long Output Only Enumerated value: 1, 2, 3 Introduced in v4 EncumberedBalanceInCurrency

Vested balance, in currencyAmount of money vested, minus any future scheduled takings.

50

Kronos Incorporated


Type: Currency Output Only Contains a value if the accrual is a monetary type Introduced in v4 EncumberedBalanceInTime

Vested balance, in timeAmount of time vested, minus any future scheduled takings. Type: TimeDuration Output Only Contains a value if the accrual is a time type Introduced in v4 HoursPerDay

Hours per dayNumber of hours in an accrual day. Type: TimeDuration Output Only Introduced in v4; last changed in v5.1 ProbationaryBalanceInCurrency

Probationary balance, in currencyAmount of money earned, but not taken because the employee is within the probation period. A probationary amount is one that cannot be taken or paid out. A balance that is given to a person for a probationary period can be transferred as a vested amount once the person has worked through the probationary period. Type: Currency Output Only Contains a value if the accrual is a monetary type Introduced in v4; last changed in v5.1


51

Chapter 2


ProbationaryBalanceInTime

Probationary balance, in timeAmount of time earned, but not taken because the employee is within the probation period. A probationary amount is one that cannot be taken or paid out. A balance that is given to a person for a probationary period can be transferred as a vested amount once the person has worked through the probationary period. Type: TimeDuration Output Only Contains a value if the accrual is a time type Introduced in v4; last changed in v5.1 ProjectedBalanceInCurrency

Projected balance, in currencyThe current balance minus all projected takings and plus all projected credits up through the furthest projected taking date. This balance includes any scheduled resets. Type: Currency Output Only Contains a value if the accrual type is currency Introduced in v4; last changed in v5.1; deprecated in v5.0 ProjectedBalanceInTime

Projected balance, in timeThe current balance minus all projected takings and plus all projected credits up through the furthest projected taking date. This balance includes any scheduled resets. Type: TimeDuration Output Only Contains a value if the accrual type represents a time Introduced in v4; last changed in v5.1; deprecated in v5.0

52

Kronos Incorporated


ProjectedDate

Projected dateThe date used in determining the projected balance. Type: Date Output Only Introduced in v4; last changed in v5.1 ProjectedGrantAmountInCurrency

Projected grant amount, in currencyThe amount of money scheduled for future grants between the selected date and the furthest projected grant date. Type: Currency Output Only Contains a value if the accrual is a monetary type Introduced in v4; last changed in v5.1 ProjectedGrantAmountInTime

Projected grant amount, in timeThe amount of time scheduled for future grants between the selected date and the furthest projected grant date. Type: TimeDuration Output Only Contains a value if the accrual is a time type Introduced in v4; last changed in v5.1 ProjectedProbationaryBalanceInCurrency

Projected probationary balance, in currencyThe projected probationary balance expressed as an amount of money. A probationary amount is one that cannot be taken or paid out. A balance that is


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

Projected probationary balance, in timeThe projected probationary balance expressed as an amount of time. A probationary amount is one that cannot be taken or paid out. A balance that is given to a person for a probationary period can be transferred as a vested amount once the person has worked through the probationary period. Type: TimeDuration Output only Introduced in v5.0; last changed in v5.1 ProjectedTakingAmountInCurrency

Projected taking amount, in currencyThe amount of money that the employee is scheduled to take between the selected date and the furthest projected taking date. Type: Currency Output Only Contains a value if the accrual is a monetary type Introduced in v4; last changed in v5.1 ProjectedTakingAmountInTime

Projected taking amount, in timeThe amount of time that the employee is scheduled to take between the selected date and the furthest projected taking date. Type: TimeDuration

54

Kronos Incorporated


Output Only Contains a value if the accrual is a time type Introduced in v4; last changed in v5.1 ProjectedVestedBalanceInCurrency

Projected vested balance, in currencyThe current vested balance of money minus all projected takings and plus all projected vested credits up through the furthest projected taking date. This balance includes any scheduled resets. Type: Currency Output only Introduced in v5.0; last changed in v5.1 ProjectedVestedBalanceInTime

Projected vested balance, in timeThe current vested balance of time minus all projected takings and plus all projected vested credits up through the furthest projected taking date. This balance includes any scheduled resets. Type: TimeDuration Output only Introduced in v5.0; last changed in v5.1 VestedBalanceInCurrency

Vested balance, in currencyThe amount of money that is vested in the employee's account. A vested amount is one that can be taken or paid out. Type: Currency Output Only Contains a value if the accrual is a monetary type Introduced in v4; last changed in v5.1


55

Chapter 2


VestedBalanceInTime

Vested balance, in timeThe amount of time that is vested in the employee's account. A vested amount is one that can be taken or paid out. Type: TimeDuration Output Only Contains a value if the accrual is a time type Introduced in v4; last changed in v5.1

56

Kronos Incorporated

AccrualCode Tag

AccrualCode Tag Accrual CodeThe AccrualCode tag defines details about an accrual code. Accrual codes identify categories of time or money that employees earn, such as v

Kronos WFC Developers Toolkit Reference Timekeeping v6

Documents

Transcript of Kronos WFC Developers Toolkit Reference Timekeeping v6