Kronos WFC 4500 Developers Toolkit Reference

Workforce Central Developers Toolkit Reference Guide

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

Kronos Workforce Central Suite Version 6

Document Part Number: 4704277-001 Document Revision: A

The information in this document is subject to change without notice and should not be construed as a commitment by Kronos Incorporated. Kronos Incorporated assumes no responsibility for any errors that may appear in this manual. This document or any part thereof may not be reproduced in any form without the written permission of Kronos Incorporated. All rights reserved. Copyright 2009. Altitude, Altitude Dream, Cambridge Clock, CardSaver, Datakeeper, Datakeeper Central, eForce, Gatekeeper, Gatekeeper Central, Imagekeeper, Jobkeeper Central, Keep.Trac, Kronos, Kronos Touch ID, the Kronos logo, My Genies, PeoplePlanner, PeoplePlanner & Design, Schedule Manager & Design, ShiftLogic, ShopTrac, ShopTrac Pro, StarComm, StarPort, StarSaver, StarTimer, TeleTime, Timekeeper, Timekeeper Central, TimeMaker, Unicru, Visionware, Workforce Accruals, Workforce Central, Workforce Decisions, Workforce Express, Workforce Genie, and Workforce TeleTime are registered trademarks of Kronos Incorporated or a related company. Altitude MPP, Altitude MPPXpress, Altitude Pairing, Altitude PBS, Comm.Mgr, CommLink, DKC/Datalink, eDiagnostics, Experts at Improving the Performance of People and Business, FasTrack, Hireport, HR and Payroll Answerforce, HyperFind, Kronos 4500 Touch ID, Kronos 4500, Kronos 4510, Kronos Acquisition, Kronos e-Central, Kronos KnowledgePass, Kronos TechKnowledgy, KronosWorks, KVC OnDemand, Labor Plus, Momentum Essentials, Momentum Online, Momentum, MPPXpress, Overall Labor Effectiveness, Schedule Assistant, Smart Scheduler, Smart View, Start Quality, Start WIP, Starter Series, StartLabor, Timekeeper Decisions, Timekeeper Web, VisionPlus, Winstar Elite, WIP Plus, Workforce Acquisition, Workforce Activities, Workforce Analytics, Workforce Attendance, Workforce Central Portal, Workforce Connect, Workforce Employee, Workforce Forecast Manager, Workforce HR, Workforce Leave, Workforce Manager, Workforce MobileTime, Workforce Operations Planner, Workforce Payroll, Workforce Record Manager, Workforce Recruiter, Workforce Scheduler, Workforce Smart Scheduler, Workforce Tax Filing, Workforce Timekeeper, Workforce View, and Workforce Worksheet are trademarks of Kronos Incorporated or a related company. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http:// www.openssl.org). This product includes software written by Eric Young ([email protected]). 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.1 Release Date January 2009

Contents

About This Guide Organization of this guide ........................................................................... 24 Abbreviations and terms .............................................................................. 25 Workforce Timekeeper documentation ........ .............................................. 26 Chapter 1: Introduction Using the tag descriptions ........................................................................... 28 Chapter 2: Workforce Timekeeper XML API Tag Definitions AccessAssignment Tag ............................................................................... 36 AccessProfile Tag ........................................................................................ 46 AccrualAmountAuditItem Tag .................................................................... 52 AccrualBalanceSummary Tag ..................................................................... 55 AccrualCode Tag ......................................................................................... 62 AccrualData Tag .......................................................................................... 65 AccrualMove Tag ........................................................................................ 67 AccrualPatternElement Tag ......................................................................... 71 AccrualProfile Tag ...................................................................................... 72 AdHocLaborAccount Tag ........................................................................... 75 AdjustmentAllocation Tag .......................................................................... 77 AdjustmentRule Tag .................................................................................... 85 AdjustmentRuleVersion Tag ....................................................................... 90 AdjustmentTrigger Tag ............................................................................... 94 AdjustmentTriggerForRule Tag ................................................................ 103 Allocation Tag ........................................................................................... 107 APICallList Tag ......................................................................................... 109 APIHolidayProfile Tag .............................................................................. 111 APIHolidayProfileData Tag ...................................................................... 115 APIHolidayProfileDataEntry Tag ............................................................. 118

Contents

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

4

Kronos Incorporated

Contents

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

Developers Toolkit Reference Guide

5

Contents

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

6

Kronos Incorporated

Contents

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


7

Contents

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

8

Kronos Incorporated

Contents

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


9

Contents

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

10

Kronos Incorporated

Contents

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


11

Contents

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

12

Kronos Incorporated

Contents

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


13

Contents

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

14

Kronos Incorporated

Contents

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


15

Contents

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

16

Kronos Incorporated

Contents

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


17

Contents

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

18

Kronos Incorporated

Contents

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


19

Contents

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

20

Kronos Incorporated

Contents


21dex

Contents

22

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 24 Abbreviations and terms on page 25 Workforce Timekeeper documentation on page 26

About This Guide

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

Users of this 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.

24

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


25

About This Guide

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

26

Kronos Incorporated

Chapter 1

Introduction

This introduction explains the XML tag and syntax formats that are used in the Kronos XML API reference documentation.

Chapter 1

Introduction

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.

28

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 ]


29

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 ()

30

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. The description tells what the action does, including validation rules.


31

Chapter 1

Introduction

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.

32

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.


33

Chapter 1

Introduction

34

Kronos Incorporated

Chapter 2

Workforce Timekeeper XML API Tag Definitions

This chapter lists the Timekeeping XML API tag descriptions in alphabetical order.

Chapter 2

AccessAssignment TagAccess Rights

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

SyntaxRequest Properties Properties

Property DescriptionsAccessProfileNameFunction access profile

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

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

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

Developers Toolkit Programmers Guide

37

Chapter 2

Optional Maximum length: 30 characters 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 DelegateProfileNameDelegate profile name

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

Contains the name of a manager's schedule group profile. A schedule group is a set of employees who work the same shifts, and the schedule group profile is a set of schedule groups. 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

38

Kronos Incorporated

AccessAssignment Tag

Introduced in v5.0; last changed in v5.1 ManagerAccessSetNameEmployee group profile

The name of the labor level set that is the manager's employee group when an individual is in a manager role. This gives the manager access to the records of those individuals whose primary accounts are in that labor level set. 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 ManagerPayCodeNamePay codes Edit profile - manager

The name of the pay code profile that applies to an individual when in a manager role. A pay code profile identifies those pay codes that the manager can select for editing. 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


39

Chapter 2

ManagerTransferSetNameLabor level transfer set - manager

The name of the labor level transfer set that applies to an individual when in a manager role. A labor level transfer set is a group of labor level entries that a manager or employee can use to transfer time or money. 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 ManagerViewPayCodeNamePay codes View profile - manager

&ALL_LABOR_ACCOUNTS &EMPTY

The name of the pay code profile that applies to an individual when in a manager role. A pay code profile identifies those pay codes that the manager can select for viewing. 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 v5.2

40

Kronos Incorporated


ManagerWorkRuleNameWork rule profile - manager

The name of the work rule profile that applies to an individual in a manager role. A work rule profile is a set of rules that determines how employee hours accrue (for example, details about how punches round, what types of overtime can be earned, which pay codes hold what type of hours, and policies for meals and breaks). 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 PreferenceProfileNameDisplay 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 Introduced in v4; last changed in v5.0


41

Chapter 2

ProfessionalPayCodeNamePay codes profile - employee

The name of the pay code profile that applies to an individual when in an employee role. A pay code profile identifies those pay codes that the employee can select. 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 ProfessionalTransferSetNameLabor level transfer set - employee

The name of the labor level transfer set that applies to an individual when in an he name of the labor level transfer set that applies to an individual when in an employee role. A labor level transfer set is a group of labor level entries that a manager or employee can use to transfer time or money. 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) Dependency: Only specify for an employee who has a user account. Introduced in v4; last changed in v5.1

42

Kronos Incorporated


ProfessionalWorkRuleNameWork rule profile - employee

The name of the work rule profile that applies to an individual in an employee role. A work rule profile is a set of rules that determines how employee hours accrue (for example, details about how punches round, what types of overtime can be earned, which pay codes hold what type of hours, and policies for meals and breaks). 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 ReportNameReports 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

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


43

Chapter 2

SchedulePatternNamePattern template profile

Contains the name of a manager's pattern template profile. Pattern templates contain a series of shifts that managers can assign to multiple employees. This pattern template profile identifies those pattern templates that the individual can select when in a manager's role. 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 ShiftCodeNameShift template profile

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

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

44

Kronos Incorporated


Default value: The Empty Data Access Profile. Introduced in v5.0; last changed in v5.1 TimeEntryTypeNameTime entry method

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

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

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

Type: Boolean Optional Enumerated value: True, False Introduced in v4


45

Chapter 2

AccessProfile TagAccess Profile

The AccessProfile tag provides information about access controls. Use it to check a specific access control prior to attempting to perform an action, such as edit. Access profiles ar

Kronos WFC 4500 Developers Toolkit Reference

Documents

Transcript of Kronos WFC 4500 Developers Toolkit Reference