WFC81 IntegrationMgrDTKRef

Integration Manager -
Developer’s Toolkit
Reference Guide
API Reference information
Kronos Workforce Central Suite

® ®
Version 8.1.
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 2017.
Altitude, Altitude Dream, Altitude Pairing, Altitude PBS, CardSaver, Gatekeeper, Gatekeeper Central, Keep.Trac,
Kronos, Kronos InTouch, Kronos Touch ID, the Kronos logo, Kronos Workforce Ready, My Genies, OptiLink,
ShiftLogic, ShopTrac, Timekeeper Central, TimeLink, Unicru, Visionware, Workforce Accruals, Workforce Central,
Workforce Genie, and Workforce TeleTime are registered trademarks of Kronos Incorporated or a related company.
ACA Manager, Altitude BLISS, Altitude Insight, Altitude MPP, Altitude MPPXpress, Altitude Rostering, Altitude VBS,
CMS, Comm.Mgr, CommLink, DKC/Datalink, eDiagnostics, FasTrack, Hireport, HR and Payroll Answerforce,
HyperFind, iBid, Kronos 4500, Kronos 4500 Touch ID, Kronos 4510, Kronos Acquisition, Kronos ByDemand,
Kronos e-Central, Kronos Efficient, Kronos Enterprise Archive, Kronos Essentials, Kronos for Dining Accelerated,
Kronos for Retail Accelerated, Kronos KnowledgePass, Kronos Paragon, Kronos TechKnowledgy, KronosWorks,
KVC ByDemand, KVC OnDemand, Labor Plus, MedSched, MPPXpress, Overall Labor Effectiveness, Schedule
Assistant, Smart Scheduler, Smart View, StaffEasy, Start Quality, Start WIP, Starter Series, StartLabor, Stromberg,
Timekeeper Decisions, Timekeeper Web, VisionPlus, WebStaff, webTA, webTA Mobile, Winstar Elite, WIP Plus,
Workforce Absence Manager, Workforce Acquisition, Workforce Activities, Workforce Analytics, Workforce
Attendance, Workforce Auditor, Workforce Budgeting, Workforce Central Portal, Workforce Connect, Workforce
Device Manager, Workforce Dimensions, Workforce Employee, Workforce ESP, Workforce Forecast Manager,
Workforce HR, Workforce Innovation That Works, Workforce Institute, Workforce Integration Manager, Workforce
IntegrityScreen, Workforce Leave, Workforce Manager, Workforce Mobile, Workforce MobileTime, Workforce
Operations Planner, Workforce Payroll, Workforce Record Manager, Workforce Recruiter, Workforce Scheduler,
Workforce Scheduler with Optimization, Workforce Selection, Workforce Smart Scheduler, Workforce Sourcing
Analytics, Workforce Tablet, Workforce Tablet Analytics, Workforce Talent Acquisition, Workforce Task
Management, Workforce Tax Filing, Workforce TeleStaff, Workforce TeleTime IP, Workforce Timekeeper,
Workforce View, and Workforce Worksheet are trademarks of Kronos Incorporated or a related company.
For a complete list of Kronos trademarks, please visit the "trademarks" page at www.kronos.com. The source code
for Equinox is available for free download at www.eclipse.org. All other trademarks or registered trademarks used
herein are the property of their respective owners and are used for identification purposes only. All specifications
are subject to change.
When using and applying the information generated by Kronos products, customers should ensure that they comply
with the applicable requirements of all applicable law, including 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

900 Chelmsford Street, Lowell, MA 01851 USA
Phone: 978-250-9800, Fax: 978-367-5900
Kronos Incorporated Global Support: 1-800-394-HELP (1-800-394-4357)
For links to information about international subsidiaries of Kronos Incorporated, go to

http://www.kronos.com
Document Revision History
Document Revision Product Version Release Date
A 8.1 December 2017

Contents
Contents
Chapter 1: About This Guide

Users of this guide ......................................................................................... 8
Abbreviations and terms ................................................................................ 9
Chapter 2: XML Tags

Using the tag descriptions ........................................................................... 12
DateFormatValidation Tag .......................................................................... 19
DownloadContext Tag ................................................................................. 22
KnxEngineKBO Tag ................................................................................... 24
LookupTableValidation Tag ....................................................................... 27
NoValidation Tag ........................................................................................ 29
Prompt Tag .................................................................................................. 31
PromptValidation Tag ................................................................................. 34
RunHistory Tag ........................................................................................... 35
RunStatusType Tag ..................................................................................... 39
SpecialLookupTableValidation Tag ............................................................ 41
TableRow Tag ............................................................................................. 44
TransferContext Tag .................................................................................... 46
ValidPromptString Tag ............................................................................... 48
WimADPFileOption Tag ............................................................................. 49
WimAPIIntegration Tag .............................................................................. 51
WimAPIIntegrationRunStatus Tag ............................................................. 54
WimConnectionInfo Tag ............................................................................. 57
WimConnectionOption Tag ........................................................................ 67
WimEmployeeInfoConnOption Tag ........................................................... 68
WimExecOption Tag ................................................................................... 72
WimFile Tag ................................................................................................ 76
WimFileOption Tag ..................................................................................... 79
WimFileService Tag .................................................................................... 81
3
Contents
WimFileTransfer Tag ...................................................................................84

WimFolderMap Tag .....................................................................................87
WimInputPrompt Tag ..................................................................................91
WimInterface Tag ........................................................................................95
WimInterfaceRunStatus Tag ......................................................................103
WimLink Tag .............................................................................................107
WimLookupTable Tag ...............................................................................110
WimLookupTableOption Tag ....................................................................113
WimSourceOption Tag ..............................................................................114
WimStepOverride Tag ...............................................................................115
WimVariable Tag .......................................................................................119
WimVariableSet Tag ..................................................................................122
WimXmlApiConnectionOption Tag ..........................................................124
WimXmlLog Tag .......................................................................................126
Chapter 3: Import XML Transactions

Transactions ...............................................................................................131
Integration Manager Engine ................................................................131
Data Integration Interface Status .........................................................131
Mapped Folders ...................................................................................132
Connections for Data Integration ........................................................132
Data Integration Interface ....................................................................133
Date Format Validation .......................................................................138
Lookup Table Validation .....................................................................138
No Validation ......................................................................................139
Special Lookup Table Validation ........................................................139
Data Integration Link Information ......................................................139
File Service ..........................................................................................140
XML Log .............................................................................................141
Data Integration Lookup Table Information .......................................141
Data Integration Route ........................................................................141
Chapter 4: Export XML Transactions

Transactions ...............................................................................................145
Integration Manager Engine ................................................................145
4
Contents
Data Integration Interface Status ........................................................ 145

Mapped Folders .................................................................................. 145
Connections for Data Integration ........................................................ 146
Data Integration Interface ................................................................... 147
Date Format Validation ....................................................................... 152
Lookup Table Validation .................................................................... 153
No Validation ...................................................................................... 153
Special Lookup Table Validation ....................................................... 153
Data Integration Link Information ...................................................... 154
File Service ......................................................................................... 154
XML Log ............................................................................................ 155
Data Integration Lookup Table Information ....................................... 156
Data Integration Route ........................................................................ 156
5
Contents
6
Chapter 1
About This Guide
This reference guide defines and describes the XML API interface. XML API
reference information is available for the following products:
• Timekeeping
• Scheduling (including Task Management)
• Activities
• Attendance
• Data Integration
• Device Manager
• Leave
• Budgeting
Chapter 1 About This Guide
Users of this guide

This reference guide is for programmers, system integrators, and Web developers
who need to understand the 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 product’s user interface.
54 Kronos Incorporated
Abbreviations and terms
Abbreviations and terms

The following abbreviations and terms are used in this reference guide:
Abbreviation Term
API Application Program Interface
DTK Developer’s Toolkit
HTML Hypertext Markup Language
HTTP Hypertext Transfer Protocol
HTTPS Hypertext Transfer Protocol Secure
RDBMS Relational Database Management System
TCP/IP Transmission Control Protocol/Internet Protocol
URL Universal Resource Locator
XML Extensible Markup Language
55
Chapter 1 About This Guide
Chapter 2
XML Tags
Chapter 2 XML Tags
Using the tag descriptions

The XML tags are described using standard formats and conventions, described in
this section.
XML tag name
The XML tag name includes the technical name, or how the tag is referenced in
code, and the non-technical name, or how the tag is referenced in the XML Import
and Export Programmer sections 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 Setup. Contact your system administrator if you do not have access to Setup:
1. Click Access Profiles.
2. Click Function Access Profiles from the list on the left.
3. Click the function access profile associated with the user whose access rights
you are checking; for example, IS.
The Edit Function Access Profile window opens.
4. Expand the API and API Beans entries to see the function access control
points.
5. Find the function access control point you are interested in (for example,
Timecard) and verify that it is set to Allowed for the type of operation the user
needs to perform.
If it is set to Allowed, the user has access rights to all the tags in the reference
chapter of this document whose Function Access Control Point is specified as
API.Timecard; for example, the Punch tag.
Note: In the GUI, the function access control point name may reflect the
control point’s association with Java beans. Thus, the GUI may refer to
API.Timecard as Timecard Beans.
Versions
The “introduced” version specifies the version number when the tag was
introduced. If the tag was modified since it was introduced, the version when it
was last changed is specified. If it has been modified in this release and you are
already using this tag, check your XML code to make sure it is up-to-date.
If the tag has been marked for deprecation, this information is specified. A
deprecated item will be removed from the API in the next major release, or
after one year, whichever date is later.
Syntax
This section describes the abstract syntax for the XML tag. XML tag names,
action names, action parameters, and property names are case sensitive.
Example:
Request -->
<Request Action = Actions
Parameters >
Properties
</Request>
Actions --> "AddComment" | "AddOnly" | "Delete"
Parameters -->
[ AccrualOverride = Boolean ]
[ allowAdHoc = Boolean ]
[ EchoData = Boolean ]
59
Chapter 2 XML Tags
Properties -->
<PayCodeMove
AmountInTimeOrCurrency = String
[ CommentText = String ]
Date = Date
( EnteredOnDate = Date )
( EnteredOnTime = Time )
[ FromLaborAccountName = String ]
FromPayCodeName = String
[ LaborAccountName = String ]
[ ManagerName = String ]
OrgJobId = String
[ OrgJobName = String ]
PayCodeName = String >
( <Comments>
<Comment>*
</Comments> )
<Employee>
<CurrentUser> | <PersonIdentity>
</Employee>
</PayCodeMove>
Conventions
The syntax conventions are described in the following table.
Syntax Description Example

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

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

• Request—An XML statement can be actionable or non-actionable. If it is
actionable, the statement is contained within a Request tag. If it is not
actionable, it must be used within an actionable tag.
• Actions—If the syntax statement contains actions, an Actions part identifies
all the actions supported by the XML tag.
• Parameters—If any actions use parameters, a Parameters part identifies them.
• Properties—The properties part of the syntax statement identifies all
properties that are available for a tag, including required and optional
properties.
• Contained API tags—If the syntax of the primary XML tag requires another
XML tag, which is not assigned to any property within the primary tag, a
container API tag is used to specify a placeholder for the other tag.
Action descriptions
The action description includes the following information:

• The action name includes the technical name, or how the action is referenced
in code; and the non-technical name, or how the action is referenced in the
XML Import and Export Programmer Guides and the user interface.
61
Chapter 2 XML Tags
• 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 version number when the action was
introduced. If the action was modified since it was introduced, the version
when it was last changed is specified. If it has been modified in this release
and you are already using this action, check your XML code to make sure it is
up-to-date.
If the action has been marked for deprecation, this information is specified. A
deprecated item will be removed from the API in the next major release, or
after one year, whichever date is later.
Property descriptions
The property description describes all of the properties specified for an XML tag.
• The property name includes the technical name, or how the property is
referenced in code; and the non-technical name, or how the property is
referenced in the XML Import and Export Programmer Guides and the user
interface.
• The description describes each property, including validation rules.
• Allowed Values identifies a predefined set of allowable values for the
property.
• The Default Value item identifies a default value, where appropriate.
• The Contributes to Uniqueness item identifies properties that are required as
part of the unique identification of an instance of a tag.
• Groups of Mutually Exclusive Properties specifies if any of the properties in a
tag are mutually exclusive. For example, in the EarnedAccruals tag, you can
specify the AmountInTime or the AmountInCurrency property, but not both.
• The “introduced” version specifies the 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.
63
Chapter 2 XML Tags
DateFormatValidation Tag
Date Format Validation

Forces the user to enter the date in a certain format.
Function Access Control Point: KNX
Introduced in v6.1; last changed in v6.3
Syntax
Request
Parameters >
Properties
</Request>
Actions
"GetListOfValidEntries" 
"Validate"
Parameters
None
Properties
<DateFormatValidation
DateFormat = Integer
DateSeparator = Integer
[ValidationString = String] >
</DateFormatValidation>
Action Descriptions
GetListOfValidEntries
Gets the format this date must be in
Return Value Type: Zero or more ValidPromptString tags
Required Properties: DateFormat, DateSeparator

Access Control Point Name: View
Introduced in v6.1
Validate
Determine if the validation string is valid given the date format and date separator
Return Value Type: Boolean
Required Properties: DateFormat DateSeparator ValidationString
Introduced in v6.1
Property Descriptions
DateFormat
Date Format
A date format enum
0: MMDDYY
1: MMDDYYYY
2: DDMMYY
3: DDMMYYYY
4: YYDDMM
5: YYYYDDMM
6: YYMMDD
7: YYYYMMDD
Type: Integer
Required
A number 0 to 7
DateSeparator
Date Separator
0: No separator
1: Slash Separator (/)
2: Hyphen Separator (-)
3: Period Separator (.)
Type: Integer
Required
A number from 0 to 3.
ValidationString
Validation String
The string to validate, based on both the date format and date separator character
values. Those two values are specified in the "Validate input using desired date
format" area of the Validate User Input dialog box in Interface Designer.
Type: String
Optional

DownloadContext Tag
Download Context
Requests that a file be downloaded
Syntax
Request
Parameters >
Properties
</Request>
<DownloadContext
Type = String >
<File>
<WimFile>
</File>
</DownloadContext>
File
File
The file to be downloaded.
Type: WimFile tag
Required
Must be a valid file of the type specified by the DownloadContext type.

Sample values:
<WimFile Name="C:KRONOSINTERFACEDESIGNERKNXWFC_SQL.TBL" />
Default value: none
Introduced in v6.1
Type
File Type
Specifies the type of download being requested.
Type: String
Required
Must be one of: "DownloadLookTable"
Sample values:
DownloadLookTable
Default value: none
Introduced in v6.1
KnxEngineKBO Tag
Integration Manager Engine

Kronos Business Object wrapper for the Integration Manager Engine. This allows
the Integration Manager Engine to be invoked by the XML API.
A valid Integration Manager interface must be provided.
Syntax
Request
Parameters >
Properties
</Request>
Actions
"Cancel" 
"Execute" 
"Progress" 
"Prompts"
None
<KnxEngineKBO
[JobId = Long]
[InterfaceName = String] >
</KnxEngineKBO>
Action Descriptions
Cancel
Cancels a running Workforce Connect job
Return Value Type: None
Required Properties: JobId
Optional Properties: None
Access Control Point Name: Edit
Introduced in v6.1
Execute
This action executes the Workforce Connect Engine
Verifies the Workforce Connect Interface Name exists in database
Return Value Type: KnxEngineKBO tag
Required Properties: InterfaceName
Progress
Looks up the current progress of an interface job, based on the id in the
knxrunhistory table
The job id must be non-negative
Return Value Type: KnxEngineKBO tag
Required Properties: JobId
Prompts
Gets a list of prompts for an interface
the interface name is valid

Return Value Type: Zero or more Prompt tags
Required Properties: InterfaceName
Introduced in v6.1
InterfaceName
Name of Integration Manager Interface
The name of the Integration Manager interface to be processed by the Integration
Manager Engine.
Type: String
Optional
Verifies the interface name is not null or empty.
JobId
Integration Manager Run History ID
The Integration Manager run ID to be processed by the Integration Manager
Engine.
Type: Long
Optional
Verifies that the ID is non-negative.

LookupTableValidation Tag
Lookup Table Validation

Validates input against a lookup table in KNXLOOKUPTBALES.
Syntax
Request
Parameters >
Properties
</Request>
Actions
"Validate"
None
<LookupTableValidation
[LookupTableName = String]
</LookupTableValidation>
Action Descriptions
Validate
validates that ValidationString exists in the 1st column of LookupTableName
Required Properties: LookupTableName ValidationString

LookupTableName
Lookup Table Name
Name of the lookup table to validate against
Type: String
Optional
Introduced in v6.1
ValidationString
Validation String
String to validate against the lookup table
Type: String
Optional
Introduced in v6.1
NoValidation Tag
No Validation
Validates any non-empty string.
Syntax
Request
Parameters >
Properties
</Request>
Actions
"Validate"
None
<NoValidation
</NoValidation>
Action Descriptions
always returns null
Return Value Type: ValidPromptString tag
Introduced in v6.1
Validate
validates that ValidationString is not null or zero length
Required Properties: ValidationString
Introduced in v6.1
ValidationString
Validation String
The string to validate against NoValidation.
Type: String
Optional

Prompt Tag
Data Integration Prompt

A preopen prompt that is displayed to a user to get input at runtime for an
interface run.
Syntax
Request
Parameters >
Properties
</Request>
<Prompt
(InterfaceName = String)
(LinkName = String)
(LinkNumber = Integer)
(PromptName = String)
(ProvideCalendar = Boolean)
(VariableName = String) >
(<Validation>
</Validation>)
</Prompt>
InterfaceName
Interface Name
The interface name this prompt is from
Type: String
Output only
Introduced in v6.1
LinkName
Link Name
The name of the link this prompt is in
Type: String
Output only
None
Default value: None
Introduced in v6.1
LinkNumber
Link Number
The number of the link within this interface this prompt belongs to
Type: Integer
Output only
Introduced in v6.1
PromptName
Prompt Name
The text to display to ask user input
Type: String
Output only
None
Introduced in v6.1
ProvideCalendar
Provide Calendar
Whether to display a caledar for the user to select a date from
Type: Boolean
Output only
Introduced in v6.1
Validation
Validation
The validation to do on this prompt
Type: Either tag
Output only
Introduced in v6.1
VariableName
Variable Name
Variable name defined in the designer
Type: String
Output only
Introduced in v6.1
PromptValidation Tag
Prompt Validation
The type of validation that should be applied to a prompt.
Syntax
Request
Parameters >
Properties
</Request>
<PromptValidation
</PromptValidation>
ValidationString
Validation String
The string to validate against this validator
Type: String
Optional
Introduced in v6.1
RunHistory Tag
Data Integration Interface Status

The Run History API provides the execution status of all the interface runs,
whether they are scheduled, running, completed, or completed with errors.
Syntax
Request
Parameters >
Properties
</Request>
Actions
"RetrieveAll" 
"RetrieveById"
None
<RunHistory
(ActualStart = String)
Id = Long
(UserName = String) >
(<RunStatusType>
<RunStatusType>
</RunStatusType>)
</RunHistory>
Action Descriptions
RetrieveAll
Retrieve all run history information associated with Workforce Integration
Manager
Return Value Type: Collection
Introduced in v6.1
RetrieveById
Retrieves the run history information for the data integration job associated with
the Id property
Return Value Type: RunHistory tag
Introduced in v6.2
ActualStart
Actual start time of the interface run
The time the interface run actually started
Type: String
Output only
Sample values:
ActualStart="12/26/2007 2:22PM"
Introduced in v6.1
Id
Id
Job Id for data integration interface in KNXRUNHISTORY table
Type: Long
Required
Id must exist in KNXRUNHISTORY table
Introduced in v6.2
InterfaceName
Interface name
The name of the interface which was run
Type: String
Output only
Sample values:
InterfaceName="SimpleInterface"
Introduced in v6.1
RunStatusType
Run status
The status of the run; possible values are SCHEDULED, RUNNING,
COMPLETED, COMPLETED_WITH_ERRORS, and CANCELED.
Type: RunStatusType tag
Output only
Sample values:
<RunStatusType>
<RunStatusType Key="COMPLETED"/>
</RunStatusType>
UserName
User name
Name of the user who ran the interface
Type: String
Output only
Sample values:
UserName="SuperUser"
Introduced in v6.1
RunStatusType Tag

The Run Status Type provides the status of a data integration interface that is
running on the Integration Manager server.
None
Syntax
Request
Parameters >
Properties
</Request>
<RunStatusType
(Key = String) >
</RunStatusType>
Key
Status of interface process
Current status of a Status of data integration interface process.
Type: String
Output only
Sample values:
RUNNING

SpecialLookupTableValidation Tag
Special Lookup Table Validation

Validates and provides valid values for prompts against a Special Lookup Table.
Introduced in v6.1; last changed in v6.3; deprecated in v6.3
Syntax
Request
Parameters >
Properties
</Request>
Actions
"Validate"
None
<SpecialLookupTableValidation
[LinkName = String]
[TableName = String]
</SpecialLookupTableValidation>
Action Descriptions
gets a list of strings from the special lookup table defined in the link
Return Value Type: Zero or more ValidPromptString tags
Required Properties: LinkName TableName

Validate
validates that ValidationString is in the first column of TableName defined as a
special lookup table in LinkName
Required Properties: LinkName TableName ValidationString
LinkName
Link Name
The link name to find the special lookup table in
Type: String
Optional
Introduced in v6.1
TableName
Table Name
The special lookup table to look in for strings and validation defined in the
LinkName
Type: String
Optional
Introduced in v6.1
ValidationString
Validation String
the string to validate against the 1st column of special lookup table defined in the
link
Type: String
Optional
Introduced in v6.1
TableRow Tag
Table Row
Represents the value of a row in a table. Each column value is a SimpleValue
bean
in the Columns property. The TableRow bean does not have any information
about the
rows position in the table. Column values do not have an explicit column
position specified
either. Column position is determined by the order of values in the Columns

property.
None.
Syntax
Request
Parameters >
Properties
</Request>
<TableRow
[<Columns>
<SimpleValue>*
</Columns>]
</TableRow>
Columns
Column Values
Contains the column values for the row. Column position is determined by the
order of SimpleValue beans in the list.
Type: Zero or more SimpleValue tags
Optional
Must be a list of SimpleValue beans.
Sample values:
<SimpleValue Value="a data" />
Default value: null
Introduced in v6.1
TransferContext Tag
Transfer Context
Specifies the type of File Transfer.
The Type property must have an accepted value.
Syntax
Request
Parameters >
Properties
</Request>
<TransferContext
Type = String >
</TransferContext>
Type
Transfer Type
Specifies the type of file transfer.
Type: String
Required
Must be an accepted Type. Accepted types are: UploadLookTable .
Sample values:
UploadLookTable
Default value: none
Introduced in v6.1
ValidPromptString Tag
Valid Prompt String

Wrapper around String so a list can be returned to the user.
Syntax
Request
Parameters >
Properties
</Request>
<ValidPromptString
(ValidString = String) >
</ValidPromptString>
ValidString
Valid String
The valid string to wrap as a business object
Type: String
Output only
Introduced in v6.1
WimADPFileOption Tag
ADP File Options

Options for step overrides in an Integration Manager interface where the source or
output targets are ADP files.
Syntax
Request
Parameters >
Properties
</Request>
<WimADPFileOption
[BatchNumber = String]
[CompanyCode = String] >
</WimADPFileOption>
BatchNumber
Batch Number
Batch Number for ADP Output type.
Type: String
Optional
Introduced in v6.1
CompanyCode
Company Code
ADP company code
Type: String
Optional
Introduced in v6.1
WimAPIIntegration Tag
Data Integration Route

Data integration route defined by Camel plugin configuration file.
Syntax
Request
Parameters >
Properties
</Request>
Actions
"Execute" 
"RetrieveRunStatus"
None
<WimAPIIntegration
Name = String
Input = String >
<RunStatus>
<WimAPIIntegrationRunStatus>
</RunStatus>
</WimAPIIntegration>
Action Descriptions
Execute
Request route be submitted for execution.
Return Value Type: WimAPIIntegrationRunStatus tag

Required Properties: Name, Input
RetrieveRunStatus
Request run execution information of a route execution.
Return Value Type: WimAPIIntegrationRunStatus tag
Required Properties: Name, RunStatus
Input
Execution input parameters
Input parameters passed to the route execution.
Type: String
Required
Introduced in v8.0
Name
Defined route name
Name (ID) of the route to be executed.
Type: String
Required Key
Introduced in v8.0
RunStatus
Run status
Status of route execution.
Type: WimAPIIntegrationRunStatus tag
Required

WimAPIIntegrationRunStatus Tag
Integration Route Execution Status

Describes the current status of a data integration route execution.
Syntax
Request
Parameters >
Properties
</Request>
<WimAPIIntegrationRunStatus
(EndTime = DateTime)
(ErrorMessage = String)
(StartTime = DateTime)
(Status = String)
ExecutionId = Long
(RouteName = String) >
</WimAPIIntegrationRunStatus>
EndTime
Execution end time
Time stamp of when the route execution stopped.
Type: DateTime
Output only
Introduced in v8.0
ErrorMessage
Execution error message
Error messge in case of execution error.
Type: String
Output only
Introduced in v8.0
ExecutionId
Numeric identifier of the route execution.
Numeric identifier of the route execution.
Type: Long
Required Key
Introduced in v8.0
RouteName
Route name
Name (ID) of the route that status applies.
Type: String
Output only
Introduced in v8.0
StartTime
Execution start time
Time stamp of when the route execution started.
Type: DateTime
Output only
Introduced in v8.0
Status
Execution status
Status of Camel route execution.
Type: String
Output only
Introduced in v8.0
WimConnectionInfo Tag
Connections for Data Integration

Connections used by the data integration application (Integration Manager).
Syntax
Request
Parameters >
Properties
</Request>
Actions
"Delete" 
"Retrieve" 
"RetrieveAll" 
"RetrieveAllForUpdate" 
"RetrieveAllNames" 
"RetrieveByType" 
"RetrieveForUpdate" 
"Test" 
"Update"
None
<WimConnectionInfo
Password = String
EncryptedPassword = String
Name = String
[Type = String]
[DataSourceName = String]
[ServerName = String]
[UserName = String]
[Description = String]
[ParameterString = String]
[InstanceName = String]
[JdbcUrl = String]
[JdbcDriverClass = String]
[LocalizedName = String]
[TimeOut = Integer]
[PortNumber = Integer]
[UrlPrefix = String] >
</WimConnectionInfo>
Action Descriptions
Delete
Deletes a Connecton from the WFC database.
Required Properties: Name
Introduced in v6.1
Retrieve
Name of the connection to be retrieved
Return Value Type: WimConnectionInfo tag
RetrieveAll
Retrieve all connections in WFC database.
Return Value Type: Zero or more WimConnectionInfo tags

Introduced in v6.1
RetrieveAllForUpdate
For SDM compliance, this action retrieves all connections in the WFC database
and exposes all attributes that are writeable via XML requests.
Introduced in v6.1
RetrieveAllNames
Retrieve a list of names of all connections in WFC data base.
Return Value Type: String list
RetrieveByType
Returns all the ConnectionInfo objects of the type specified in the WFC System
that are available to the logged on user via default GDAP.
Required Properties: Type
Introduced in v6.3
RetrieveForUpdate
Retrieves a Connection object and displays all the writeable attributes in the XML
response.
Return Value Type: WimConnectionInfo tag

Introduced in v6.1
Test
Tests the connection without storing it in the DB and throws an exception if any of
the required fields are null.
Throws an exception if required fields are null.
Optional Properties: Type, Description,TimeOut, UserName, Password,

ServerName, InstanceName, UrlPrefix, PortNumber, ParameterString, JdbcUrl,
JdbcDriverClass
Introduced in v6.1
Update
Supports adding or updating the connection identified by the required Name
attribute.
Optional Properties: LocalizedName, Type, Description,TimeOut, UserName,

Password, ServerName, InstanceName, UrlPrefix, PortNumber, ParameterString,
JdbcUrl, JdbcDriverClass
Password
Password
Password to DB
Type: String
Introduced in v6.3
EncryptedPassword
Password to database
The password associated with the UserName property that will be used to log onto
the database server.
Type: String
DataSourceName
Database Name or Oracle SID
The unique indetifier for the data source on the database server. For Oracle
connections, this would be the SID. For MS SQL Server, this is the database
name.
Type: String
Optional
Introduced in v6.1
Description
Description of connection
User entered description of connection.
Type: String
Optional
Sample values:
Connection to HR database.
Introduced in v6.1
InstanceName
Instance Name on the Server
WFC Instance Name on the Server
Type: String
Optional
JdbcDriverClass
Java class name of JDBC Driver
For custom connections, this is fully qaulified Java class name of the JDBC
Driver.
Type: String
Optional
Sample values:
com.mysql.jdbc.Driver
Introduced in v6.1
JdbcUrl
JDBC Connection URL
For custom type connections, the JDBC Connection URL must be entered
directly.
Type: String
Optional
Introduced in v6.1
LocalizedName
LocalizedName
The Localized name for the connections used internally by the system. This
property is not persisted in the DB.
Type: String
Optional
Introduced in v6.1
Name
Connection Name
Name of connection. All names are unique for connections in WFC.
Type: String
Required Key
Sample values:
TestConnection
Introduced in v6.1
ParameterString
Driver connection properties
For standard connection types, this should be a SEMI COLON separated list of
connection properties for the JDBC Driver.
Type: String
Optional
Sample values:
oracle.jdbc.ReadTimeout=5000;txnAutoCommit=true;
Introduced in v6.1
PortNumber
Network port number
Network port number that database server is listening on.
Type: Integer
Optional
Sample values:
1521
Introduced in v6.1
ServerName
Database server name or IP address
Network name or IP address of database server.
Type: String
Optional
Introduced in v6.1
TimeOut
Login time out in seconds.
The time duration in seconds that the application will wait when attempting to
login to the system described by the connection.
Type: Integer
Optional
Introduced in v6.1
Type
Connection Type
Describes the the data source the connection will provide access to.
Type: String
Optional
Sample values:
Oracle
Enumerated value: Oracle;SQL Server; Custom
Introduced in v6.1
UrlPrefix
Url Prefix to be used(http or https)
Url Prefix(http or https) to be used to construct a valid URL to access a WFC
server
Type: String
Optional
UserName
Database user name
The user name of the account on the data base server.
Type: String
Optional
Introduced in v6.1
Groups of Mutually Exclusive Properties

Password or Encrypted Password
To enter value for Password or Encrypted password.
Required
Group includes: Password, EncryptedPassword

WimConnectionOption Tag
Connection Options
Describes the data integration options that can be overridden for source and output
targets that are associated with a connection.
Syntax
Request
Parameters >
Properties
</Request>
<WimConnectionOption
ConnectionName = String >
</WimConnectionOption>
ConnectionName
Name of the connection
Property to specify the connection name
Type: String
Required
Introduced in v6.1
WimEmployeeInfoConnOption Tag
Employee Connection Information

Step override options for source or output targets where they are connections to a
employee-based applications such as Workforce Timekeeper.
Syntax
Request
Parameters >
Properties
</Request>
<WimEmployeeInfoConnOption
[DailyRecords = Boolean]
[IgnoreSignOff = Boolean]
PayPeriod = String
[EndDate = Date]
[StartDate = Date]
[ActiveEmployeesOnly = Boolean] >
<ConnectionOption>
<WimConnectionOption>
</ConnectionOption>
<XmlApiConnectionOption>
<WimXmlApiConnectionOption>
</XmlApiConnectionOption>
</WimEmployeeInfoConnOption>
ActiveEmployeesOnly
Process Active Employees Only
Set to true if you need to process active employees only.
Type: Boolean
Optional
Introduced in v6.1
ConnectionOption
Connect Information
Specifies the connection information.
Type: WimConnectionOption tag
Required
Introduced in v6.1
DailyRecords
Create Daily Records
Ste to true if you need to create daily records.
Type: Boolean
Optional
Introduced in v6.1
EndDate
Pay Period End Date
Specifies the pay period end date.
Type: Date
Optional
Introduced in v6.1
IgnoreSignOff
Ignore SignOff
Set to true if you need to ignore signoff.
Type: Boolean
Optional
Introduced in v6.1
PayPeriod
Pay Period
Specifies the Pay Period
Type: String
Required
Introduced in v6.1
StartDate
Pay Period Start Date
Specifies the Pay Period Start Date
Type: Date
Optional
Introduced in v6.1
XmlApiConnectionOption
Xml Api connection Information
Specifies the XML API connection information for Workforce Timekeeper
source.
Type: WimXmlApiConnectionOption tag
Required
Introduced in v6.1
WimExecOption Tag
Execution Option
Allows the user to enter options for the execution of an Integration Manager
interface (WimInterface). These options are only in effect for the duration of the
WimInterface execution.
Syntax
Request
Parameters >
Properties
</Request>
<WimExecOption
[BatchNumber = String]
[CompanyCode = String]
[CreateDailyRecords = String]
[IgnoreSignOff = String]
[IncludeActiveEmployees = String]
[PayPeriod = String]
[PayPeriodEnd = String]
[PayPeriodStart = String]
[PromptOnRenamePrevOutFile = String] >
[<Variables>
<WimVariable>*
</Variables>]
</WimExecOption>
BatchNumber
Batch number
Batch number for ADP output Type
Type: String
Optional
Introduced in v6.1
CompanyCode
Company Code
Company Code for ADP output type
Type: String
Optional
Introduced in v6.1
CreateDailyRecords
Create Daily Records
Switch to indicate whether to create Daily Records
Type: String
Optional
Introduced in v6.1
IgnoreSignOff
Ignore Signoff
Flag to indicate Ignore Signoff.
Type: String
Optional
Default value: false
IncludeActiveEmployees
Include Active Employees
Flag to process only active employees.
Type: String
Optional
PayPeriod
Pay Period
Specifies the pay period to override.
Type: String
Optional
Should be Current, Previous or Range.
Introduced in v6.1
PayPeriodEnd
Pay Period End Date
Property to specify pay period end date. Used when the Pay period is Range.
Type: String
Optional
Introduced in v6.1
PayPeriodStart
Pay Period Start Date
Property to specify Pay Period Start date.
Type: String
Optional
Introduced in v6.1
PromptOnRenamePrevOutFile
PromptOnRenamePrevOutFile
Set to true if you wish to allow prompting for the file name to rename any
previous output file. If set to false, the runtime engine should overwrite the
previous output file.
Type: String
Optional
Introduced in v6.1
Variables
Variables
Variables to use when running an interface
Type: Zero or more WimVariable tags
Optional
Introduced in v6.3
WimFile Tag
File
A file being transferred by the Integration Manager.
Must have a valid type.
Function Access Control Point: KNK
Syntax
Request
Parameters >
Properties
</Request>
<WimFile
[ContentName = String]
Name = String
[Type = String] >
[<FileContents>
<TableRow>*
</FileContents>]
</WimFile>
ContentName
File Content
Identifies source of file content
Type: String
Optional
none
Sample values:
C:KRONOSINTERFACEDESIGNERKNXWFC_SQL.TBL"
Default value: none
Introduced in v6.1
FileContents
Table Contents
Contains the value of a table when the WimFile bean has a type of "LookTable"
Type: Zero or more TableRow tags
Optional
Must be a list of TableRow beans.
Sample values:
<TableRow>
<Columns>
<SimpleValue Value="Column 1 Value" />
<SimpleValue Value="Column 2 value" />
</Columns>
</TableRow>
Default value: none
Introduced in v6.1
Name
File Name
The name that uniquely identifies the file.
Type: String
Required Key
Must be specified.
Default value: none
Introduced in v6.1
Type
File Type
Identifies the type of the file
Type: String
Optional
Must be a valid type. Valid types are: "LookTable". Must be specified for Upload
actions.
Sample values:
LookTable
Default value: none
Enumerated value: LookTable
Introduced in v6.1
WimFileOption Tag
Data Integration File Options

Options associated with Source and Output targets for a data integration interface.
Syntax
Request
Parameters >
Properties
</Request>
<WimFileOption
[AppendRecords = Boolean]
FileName = String
MappedFolderName = String
[RenamePreviousOutputFile = Boolean] >
</WimFileOption>
AppendRecords
Append Records
Set to true if you neeed to append records if the file already exists.
Type: Boolean
Optional
Default value: False

FileName
File Name
Specifies the output/input file name.
Type: String
Required
Introduced in v6.1
MappedFolderName
Name of the Mapped Folder
Name of the Mapped Folder
Type: String
Required
Introduced in v6.1
RenamePreviousOutputFile
Rename Previous Output File
Set to true if you need to rename the output file of the previous run.
Type: Boolean
Optional

WimFileService Tag
File Service
Performs actions on WIM files.
Syntax
Request
Parameters >
Properties
</Request>
Actions
"Download" 
"Upload"
None
<WimFileService
[<Context>
<DownloadContext>
</Context>]
[<ServiceType>
<WimFileTransfer>
</ServiceType>]
</WimFileService>
Action Descriptions
Download
Downloads files or run logs
A valid DownloadContext must be specified
Return Value Type: WimFileTransfer tag
Required Properties: Context
Upload
Uploads files to the WIM service
ServiceType must specify a valid WimFileTransfer for an Upload operation.
Return Value Type: TransferContext tag
Required Properties: ServiceType
Introduced in v6.1
Context
Context
Specifies the context for a download action
Type: DownloadContext tag
Optional
Sample values:
<DownloadContext Type="DownloadLookTable">
<File> <WimFile Name="C:KRONOSINTERFACEDESIGNERKNXWFC_SQL.TBL" </
File>
</DownloadContext>
Default value: none
Introduced in v6.1
ServiceType
Service Type
Specifies the files being uploaded.
Type: WimFileTransfer tag
Optional
Default value: none
Introduced in v6.1
WimFileTransfer Tag
File Transfer
Specifies the files transfer by an upload or download action.
FileList property must be specified.
Syntax
Request
Parameters >
Properties
</Request>
<WimFileTransfer
[<Context>
<TransferContext>
</Context>]
<FileList>
<WimFile>*
</FileList>
</WimFileTransfer>
Context
Context
Specifies the type of file transfer.
Type: TransferContext tag

Optional
Must be valid <TransferContext/
bean.
Sample values:
<TransferContext Type="UploadLookTable" />
Default value: none
Introduced in v6.1
FileList
File List
The files being uploaded or downloaded
Type: Zero or more WimFile tags
Required
Sample values:
<WimFile Name="C:KRONOSINTERFACEDESIGNERKNXWFC_SQL.TBL"
Type="LookTable"
ContentName="C:KRONOSINTERFACEDESIGNERKNXWFC_SQL.TBL">
<FileContents>
<TableRow>
<Columns>
<SimpleValue Value="a=b=c<=d," />
<SimpleValue Value="b,x'yv" />
</Columns>
</TableRow>
<TableRow>
<Columns>
<SimpleValue Value=""ab" ,"c&d',"
/>
<SimpleValue Value=""ef"" />
</Columns>
</TableRow>
</FileContents>
</WimFile>
Default value: none
Introduced in v6.1
WimFolderMap Tag
Mapped Folders
Business object to access mapped folders.
Function Access Control Point: WIM
Syntax
Request
Parameters >
Properties
</Request>
Actions
"AddOnly" 
"Delete" 
"Retrieve" 
"RetrieveAll" 
"RetrieveAllNames" 
"RetrieveForUpdate" 
"Test" 
"Update"
None
<WimFolderMap
FolderAlias = String
[FolderPath = String] >
</WimFolderMap>
Action Descriptions
AddOnly
Adds an entry to the KNXFOLDERMAP table, linking an alias to a path
FolderAlias and FolderPath must be non-null
Required Properties: FolderAlias, FolderPath
Delete
Deletes an entry from the KNXFOLDERMAP table
Required Properties: FolderAlias
Retrieve
Returns the specified folder map object
Return Value Type: WimFolderMap tag
RetrieveAll
Returns a list of all folder map objects
Return Value Type: Zero or more WimFolderMap tags

Introduced in v6.1
RetrieveAllNames
Returns a list of existing folder map names
Return Value Type: String list
Introduced in v6.1
RetrieveForUpdate
Returns the specified folder map object
Return Value Type: WimFolderMap tag
Test
Test FolderAlias to the mapped FolderPath
FolderAlias must be non-null
Optional Properties: FolderPath
Introduced in v7.0
Update
Updates the path of an existing folder map entry, or adds a new entry if the
supplied folder alias does not exist
Required Properties: FolderAlias, FolderPath
FolderAlias
Folder Alias
The alias to a folder map
Type: String
Required Key
FolderPath
Folder Path
Path on filesystem
Type: String
Optional

WimInputPrompt Tag
Data Integration Prompt

Prompt that provides requests and responses for information when a data
integration interface is run.
Syntax
Request
Parameters >
Properties
</Request>
<WimInputPrompt
<PromptDateFormatValidation>
<DateFormatValidation>
</PromptDateFormatValidation>
<PromptLookupTableValidation>
<LookupTableValidation>
</PromptLookupTableValidation>
<PromptSpecialLookupTableValidation>
<SpecialLookupTableValidation>
</PromptSpecialLookupTableValidation>
<PromptNoValidation>
<NoValidation>
</PromptNoValidation>
AssocLinkName = String
AssocStepNumber = Integer
Response = String
Request = String
VariableName = String >
</WimInputPrompt>
PromptDateFormatValidation
Prompt with Date Format Validation
Prompt with Date Format Validation
Type: DateFormatValidation tag
PromptLookupTableValidation
Prompt with Lookup Table Validation
Prompt with Lookup Table Validation
Type: LookupTableValidation tag
PromptSpecialLookupTableValidation
Prompt with Special Lookup Table Validation
Prompt with Special Lookup Table Validation
Type: SpecialLookupTableValidation tag
PromptNoValidation
Prompt with no validation
Validation is not required
Type: NoValidation tag

AssocLinkName
Associated Link Name
The name of the Link the prompt is associated with
Type: String
Required
AssocStepNumber
Associated Step Number
The priority number of the step the prompt is associated with.
Type: Integer
Required
Introduced in v6.1
Request
Requested information
The name or title of the prompt. This prompt can be specified in the Prompt field
of the Validate User Input dialog box in Interface Designer when you configure a
variable user prompt in a link.
Type: String
Required
Response
Information submitted
Information submitted to the prompt's request.
Type: String
Required
VariableName
Variable for prompt
This variable is used in a configuration where one interface calls another interface
that has links with prompts. In that configuration, the value for VariableName is
the name of the prompt variable that is used by the link that is being called.
Type: String
Required
Groups of Mutually Exclusive Properties

PromptValidation
Mutually exclusive group for prompt validation types
Required
Group includes: PromptDateFormatValidation, PromptLookupTableValidation,

PromptSpecialLookupTableValidation, PromptNoValidation
WimInterface Tag
Data Integration Interface

Data integration interface deployed by Interface Designer, which is the Integration
Manager configuration tool.
Syntax
Request
Parameters >
Properties
</Request>
Actions
"CancelRun" 
"Delete" 
"Execute" 
"Retrieve" 
"RetrieveAll" 
"RetrievePrompts" 
"RetrieveRunStatus" 
"Update"
Retrieve
[LoadAssocLinks = Boolean]
[LoadAssocLookupTables = Boolean]
[LoadLightLinks = Boolean]
[LoadRunOptions = Boolean]
<WimInterface
(Description = String)
Name = String >
[<AssocLinks>
<WimLink>*
</AssocLinks>]
[<AssocLookupTables>
<WimLookupTable>*
</AssocLookupTables>]
[<StepOverrides>
<WimStepOverride>*
</StepOverrides>]
(<UnansweredPrompts>
<WimInputPrompt>*
</UnansweredPrompts>)
[<AnsweredPrompts>
<WimInputPrompt>*
</AnsweredPrompts>]
<RunStatus>
<WimInterfaceRunStatus>
</RunStatus>
[<ExecuteOption>
<WimExecOption>
</ExecuteOption>]
</WimInterface>
Action Descriptions
CancelRun
Request that a Interface run execution be terminated before normal completion.
Introduced in v6.1
Delete
Delete the Interface specified by the Name attribute from the available list of
Interfaces in the XML user's Generic Data Access Profile

Introduced in v6.1
Execute
Request that the named interface be submitted for execution.
Return Value Type: WimInterfaceRunStatus tag
Optional Properties: ExecuteOption
Introduced in v6.1
Retrieve
Retrieve the Interface specified by the Name attribute
Return Value Type: WimInterface tag

Action Parameters
Parameter Name Description Additional information

LoadAssocLinks Load all associated WimLink to the Introduced in v6.1
WimInterface
Optional
LoadAssocLookupTable Load all associated Lookup Tables Introduced in v6.1
s associated with the WimInterface
Optional
LoadLightLinks When set to true, only the light Introduced in v6.1
version of the WimLinks(with only id
and name) associated with this
Interface are loaded.
Optional
LoadRunOptions Load all run options that can be Introduced in v6.1
modified for the WimInterface
Optional
RetrieveAll
List of all available Interface in the XML user's Generic Data Access Profile
Return Value Type: Zero or more WimInterface tags
Introduced in v6.1
RetrievePrompts
Retrieve prompt that must be answered in order to execute the WimInterface
Return Value Type: WimInterface tag
Optional Properties: AnsweredPrompts

Introduced in v6.1
RetrieveRunStatus
Request run execution information on a interface execution.
Return Value Type: WimInterfaceRunStatus tag
Introduced in v6.1
Update
Request that the named interface be updated with the provided Step Overrides.
Optional Properties: StepOverrides
Introduced in v6.1
AnsweredPrompts
Prompts providing answers
List of prompts that have responses to their requests.
Type: Zero or more WimInputPrompt tags
Optional
Introduced in v6.1
AssocLinks
Associated links with an interface
This property represents the links associated with the given wim interface.
Type: Zero or more WimLink tags
Optional
Introduced in v6.3
AssocLookupTables
Associated lookup tables with an interface
Indicator for defining if the associated lookup tables to be retrieved.
Type: Zero or more WimLookupTable tags
Optional
Introduced in v6.3
Description
Description
Additional information that helps identifies Interface
Type: String
Output only
Introduced in v6.1
ExecuteOption
Runtime options for an Interface
This tag provides a means to override interface options at runtime without
updating the interface.
Type: WimExecOption tag
Optional
Introduced in v6.1
Name
Unique name of Interface
The unique name for the Interface deployed to the WIM application by the
Interface Designer
Type: String
Required Key
Introduced in v6.1
RunStatus
Run Status
Status of an interface run
Type: WimInterfaceRunStatus tag
Required
Introduced in v8.0
StepOverrides
Overrides for steps in an interface
A list of overrides for the steps in an interface.
Type: Zero or more WimStepOverride tags
Optional

UnansweredPrompts
Prompts needing responses
During a RetrievePrompts action request, this tag provides information on
prompts that must be answered by the user in order to execute the Interface.
Type: Zero or more WimInputPrompt tags
Output only

WimInterfaceRunStatus Tag
Interface Run Status

Describes the current status of an interface run by the Integration Manager server.
Syntax
Request
Parameters >
Properties
</Request>
<WimInterfaceRunStatus
(CurrentStepNumber = Integer)
(CurrentStepName = String)
JobId = Integer
(StartTime = DateTime)
(EndTime = DateTime)
(TotalRecords = Integer)
(RecordsProcessed = Integer) >
(<Status>
<RunStatusType>
</Status>)
</WimInterfaceRunStatus>
CurrentStepName
Name of Link or Command
The name of the Link or Command in the list of Steps being processed.
Type: String
Output only
Introduced in v6.1
CurrentStepNumber
Indicates priority order of step
Numeric value that indicates the priority order that the step currently being
processed was set at by the user.
Type: Integer
Output only
Introduced in v6.1
EndTime
Time stamp of when execution stopped.
The date and time the execution of the interface stopped.
Type: DateTime
Output only
Introduced in v6.1
InterfaceName
Name of Interface that status applies.
The name of the WIM Interface that the status information applies to.
Type: String
Output only

JobId
Numeric identifier of the run execution.
Numeric identifier provided by the WIM Server to denote a running process for
the execution run of an Interface.
Type: Integer
Required Key
Introduced in v6.1
RecordsProcessed
Total records currently processed by interface
Indicates the total number of records processed by the interface that is currently
running on the data integration server.
Type: Integer
Output only
StartTime
Time stamp of when execution started.
The start date and time the execution of the Interface begain.
Type: DateTime
Output only
Introduced in v6.1
Status
Indicates running state
Indicates the running state of execution.
Type: RunStatusType tag
Output only
Introduced in v6.1
TotalRecords
Total number of records that will be processed
Total number of records that will be processed when the Interface excution
completes.
Type: Integer
Output only
Introduced in v6.1
WimLink Tag
Data Integration Link Information

Provides all information associated with a link that is used by a data integration
interface.
Syntax
Request
Parameters >
Properties
</Request>
Actions
"Retrieve" 
"RetrieveAll"
[LoadAssocInterfaces = Boolean]
[LoadAssocLookupTables = Boolean]
<WimLink
Name = String >
</WimLink>
Action Descriptions
Retrieve
Retrieve a Integration Manager link with the name provided.
Return Value Type: WimLink tag

Introduced in v6.1
Action Parameters

LoadAssocInterfaces Loads all Interfaces currently using Introduced in v6.1
the named WimLink
Optional
LoadAssocLookupTable Determines whether to load all of the Introduced in v6.1
s lookup tables used by the link
Optional
Either true or false
LoadLightLinks Indicates whether Light Link Introduced in v6.3
information to be retrieved with
interface information.
Optional
RetrieveAll
Retrieve a list of all Links in the system.
Return Value Type: Zero or more WimLink tags
Introduced in v6.1
Name
Unique Name of Link
Unique name for a WimLink.
Type: String
Required Key

WimLookupTable Tag
Data Integration Lookup Table Information

Provides all information associated with a lookup table that is used by a data
integration interface.
Syntax
Request
Parameters >
Properties
</Request>
Actions
"Retrieve" 
"RetrieveAll"
[LoadAssocInterfaces = Boolean]
[LoadAssocLinks = Boolean]
<WimLookupTable
Name = String >
</WimLookupTable>
Action Descriptions
Retrieve
Retrieves the lookup table information for the given name
Return Value Type: WimLookupTable tag

Introduced in v6.3
Action Parameters

LoadAssocInterfaces Indicates whether Associated Introduced in v6.3
interfaces should be loaded or not.
Optional
LoadAssocLinks Indicates whether Associated links to Introduced in v6.3
be retieved.
Optional
LoadLightLinks This indicator is used for retrieving Introduced in v6.3
list of only Light WimLink objects.
Optional
RetrieveAll
Retrieves all the lookup tables.
Return Value Type: Zero or more WimLookupTable tags
Introduced in v6.3
Name
Lookup Table Name
Name of the lookup table to be lookedup.
Type: String
Required Key
Introduced in v6.3
WimLookupTableOption Tag
Data Integration Lookup Table Options

Describes the values that can be changed when the source or output target for a
data integration interface is a lookup table.
Syntax
None
WimSourceOption Tag
Data Integration Step Override Option

A generic option to override the source or output targets for a data integration
interface.
Syntax
None
WimStepOverride Tag
Integration Override Values

Describes the values that can be overridden when manipulating runtime options
for a data integration interface.
Syntax
Request
Parameters >
Properties
</Request>
<WimStepOverride
[EnabledState = Boolean]
StepName = String
[OverridesLink = Boolean]
StepNumber = Integer
StepType = String >
[<Output>
<WimADPFileOption> | <WimConnectionOption> |
<WimEmployeeInfoConnOption> | <WimFileOption> |
<WimLookupTableOption> | <WimSourceOption> |
</Output>]
[<Source>
<WimADPFileOption> | <WimConnectionOption> |
<WimEmployeeInfoConnOption> | <WimFileOption> |
<WimLookupTableOption> | <WimSourceOption> |
</Source>]
</WimStepOverride>
EnabledState
Execute Link or Command?
Indicates whether or not Link or Command should be executed.
Type: Boolean
Optional
Introduced in v6.1
Output
Output type options
Overrides the Output type options for the Step Override.
Type: Either WimADPFileOption, WimConnectionOption,

WimEmployeeInfoConnOption, WimFileOption, WimLookupTableOption,
WimSourceOption or WimXmlApiConnectionOption tag
Optional
Introduced in v6.1
OverridesLink
Overrides link
Set to true to enable override link options with step overrides in a data integration
interface.
Type: Boolean
Optional

Source
Source Override Options
Overrides the Source type options for the Step Override.
Type: Either WimADPFileOption, WimConnectionOption,

WimEmployeeInfoConnOption, WimFileOption, WimLookupTableOption,
WimSourceOption or WimXmlApiConnectionOption tag
Optional
Introduced in v6.1
StepName
Name of the Step
Name of the Step
Type: String
Required
Introduced in v6.1
StepNumber
Step Number
The number for the step in an interface.
Type: Integer
Required
Introduced in v6.1
StepType
Type of the Step
Property to specify whether the Step is a Link or Command.
Type: String
Required
Introduced in v6.1
WimVariable Tag
Variable Assignment
The name and value of a variable used by Integration Manager.
Syntax
Request
Parameters >
Properties
</Request>
<WimVariable
[ActionType = String]
[Comment = String]
[EnabledState = Boolean]
Name = String
[Value = String] >
</WimVariable>
ActionType
Action Type
String that describes the action that should be used to obtain the variable's value.
Type: String
Optional
Introduced in v6.1
Comment
Comments for Variable
Comments for Variable
Type: String
Optional
Introduced in v6.1
EnabledState
Enabled State
Property that specifies whether to use this variable or not.
Type: Boolean
Optional
Introduced in v6.1
Name
Variable Name
Name of the Variable
Type: String
Required
Introduced in v6.1
Value
Variable Value
Value of the variable.
Type: String
Optional
Introduced in v6.1
WimVariableSet Tag
Link Variables
Link variables for Integration Manager.
Syntax
Request
Parameters >
Properties
</Request>
<WimVariableSet
<Values>
<NameValuePair>*
</Values>
</WimVariableSet>
Values
Values
validate
Type: Zero or more NameValuePair tags
Required
validate
Default value: empty

Introduced in v6.1
WimXmlApiConnectionOption Tag
XML API Connection Options

Describes the options for a step override in an interface where the source or target
is a connection exclusively associated with an XML Service.
Syntax
Request
Parameters >
Properties
</Request>
<WimXmlApiConnectionOption
[XmlTABatchName = String]
ConnectionName = String
[UseXMLTa = Boolean] >
</WimXmlApiConnectionOption>
ConnectionName
Connection Name
The name of the XML API connection.
Type: String
Required

UseXMLTa
Use Transaction Assistant
Set to true to send errors to Transaction Assistant whenever a data integration
interface is run.
Type: Boolean
Optional
XmlTABatchName
Batch Name for Transaction Assistant
The batch name for Transaction Assistant.
Type: String
Optional

WimXmlLog Tag
XML Log
XML Log for one Data Integration Interface Job
Syntax
Request
Parameters >
Properties
</Request>
Actions
"RetrieveXmlLog"
None
<WimXmlLog
Id = Long
(XmlLog = String) >
</WimXmlLog>
Action Descriptions
RetrieveXmlLog
Retrieves the xml log from the KNXRUNHISTORY table for the data integration
job associated with the Id property
Return Value Type: WimXmlLog tag

Introduced in v6.2
Id
Id
Job Id for data integratin interface in KNXRUNHISTORY table
Type: Long
Required
Id must exist in KNXRUNHISTORY table
Introduced in v6.2
XmlLog
XML Log
The xml log generated from a data integration run of an xml api import or export
Type: String
Output only
None
Introduced in v6.2
Chapter 3
Import XML Transactions
This section describes the XML APIs that are used for import operations. Some
components might not include any import XML transactions.
It does not include non-import types of actions, such as Load, or non-import data
types for properties, such as OutputOnly. Import transactions are grouped
together, according to the type of import; for example, all Accrual transactions are
grouped together.
When importing data, review the following considerations:
• The username and password that are used in the Logon request to import data
is the user whose access rights are checked during the import. A unique user
name, Import, is available for the specific purpose of importing data. When
the Import user name is associated with the import, the correct access rights
are set. In addition, using the Import user name will likely improve
performance because security privilege checks that are associated with other
users are bypassed. See the import section for more information.
• When you import data, be sure to take the sequence of imports into
consideration. Some data must be imported before other data is imported. For
example, if you import punch data for a person who has not been added to the
database yet, the punch import will fail. See the import user’s guide for more
information.
• There are two ways to refer to an XML tag or property: a non-technical name,
or its descriptive name; and a technical name, or its name as it is used in XML
syntax. In this document, the non-technical name is shown first. However,
examples use technical names.
3435
Chapter 3 Import XML Transactions

Transactions

The following actions are available for the Integration Manager Engine
transactions:
• Execute
• Progress
• Cancel
• Prompts
Non-Technical Language XML Name Format Required

Integration Manager Engine KnxEngineKBO tag
Integration Manager Run History ID JobId Long Optional
Name of Integration Manager InterfaceName String Optional
Interface

The following actions are available for the Data Integration Interface Status
transactions:

Data Integration Interface Status RunHistory tag
Id Id Long Required
Mapped Folders
The following actions are available for the Mapped Folders transactions:
• AddOnly
• Delete
• Update
• Test

Mapped Folders WimFolderMap tag
Folder Alias FolderAlias String Required Key
Folder Path FolderPath String Optional

The following actions are available for the Connections for Data Integration
transactions:
• Update
• Delete
• Test

Connections for Data Integration WimConnectionInfo tag
Connection Name Name String Required Key
Connection Type Type String Optional
Database Name or Oracle SID DataSourceName String Optional
Database server name or IP address ServerName String Optional
Database user name UserName String Optional
2
Transactions

Description of connection Description String Optional
Driver connection properties ParameterString String Optional
Instance Name on the Server InstanceName String Optional
JDBC Connection URL JdbcUrl String Optional
Java class name of JDBC Driver JdbcDriverClass String Optional
LocalizedName LocalizedName String Optional
Login time out in seconds. TimeOut Integer Optional
Network port number PortNumber Integer Optional
Password or Encrypted Password Password or Encrypted Required
choice Password One of
Password Password String

Password to database EncryptedPassword String
Url Prefix to be used(http or https) UrlPrefix String Optional

The following actions are available for the Data Integration Interface transactions:
• Delete
• Execute
• CancelRun
• Update

Data Integration Interface WimInterface tag
Associated links with an interface AssocLinks Optional
Data Integration Link Information WimLink tag Zero or more of
Unique Name of Link Name String Required Key
Associated lookup tables with an AssocLookupTables Optional
interface WimLookupTable tag Zero or more of
Data Integration Lookup Table
Information
Lookup Table Name Name String Required Key
Overrides for steps in an interface StepOverrides Optional
Integration Override Values WimStepOverride tag Zero or more of
Execute Link or Command? EnabledState Boolean Optional
Name of the Step StepName String Required
Output type options Output Optional
choice See Below One of
WimFileOption
WimConnectionOption
WimLookupTableOption
WimXmlApiConnectionOptio
n
WimADPFileOption
WimEmployeeInfoConnOptio
n
WimSourceOption
Data Integration File Options WimFileOption tag
Append Records AppendRecords Boolean Optional
File Name FileName String Required
Name of the Mapped MappedFolderName String Required
Folder
Rename Previous Output RenamePreviousOutputFile Boolean Optional
File
Connection Options WimConnectionOption tag
Name of the connection ConnectionName String Required
Data Integration Lookup Table WimLookupTableOption tag
Options
XML API Connection Options WimXmlApiConnectionOptio
n tag
4
Transactions

Batch Name for XmlTABatchName String Optional
Transaction Assistant
Connection Name ConnectionName String Required
Use Transaction Assistant UseXMLTa Boolean Optional
ADP File Options WimADPFileOption tag
Batch Number BatchNumber String Optional
Company Code CompanyCode String Optional
Employee Connection WimEmployeeInfoConnOptio
Information n tag
Create Daily Records DailyRecords Boolean Optional
Ignore SignOff IgnoreSignOff Boolean Optional
Pay Period PayPeriod String Required
Pay Period End Date EndDate Date Optional
Pay Period Start Date StartDate Date Optional
Process Active Employees ActiveEmployeesOnly Boolean Optional
Only
Data Integration Step Override WimSourceOption tag
Option
Overrides link OverridesLink Boolean Optional
Source Override Options Source Optional
WimFileOption
WimConnectionOption
n
WimADPFileOption
n
WimSourceOption
Options
n tag
Information n tag
Option
Step Number StepNumber Integer Required
Type of the Step StepType String Required
Prompts providing answers AnsweredPrompts Optional
Data Integration Prompt WimInputPrompt tag Zero or more of
Associated Link Name AssocLinkName String Required
Associated Step Number AssocStepNumber Integer Required
Information submitted Response String Required
PromptValidation PromptValidation Required
choice One of
Prompt with Date Format PromptDateFormatValidation
Validation DateFormatValidation tag
Date Format DateFormat Integer Required
Date Separator DateSeparator Integer Required
Validation String ValidationString String Optional
Prompt with Lookup Table PromptLookupTableValidatio
Validation n
Lookup Table Validation LookupTableValidation tag
Lookup Table Name LookupTableName String Optional
6
Transactions

Prompt with Special Lookup PromptSpecialLookupTableVa
Table Validation lidation
Special Lookup Table SpecialLookupTableValidatio
Validation n tag
Link Name LinkName String Optional
Table Name TableName String Optional
Prompt with no validation PromptNoValidation
No Validation NoValidation tag
Requested information Request String Required
Variable for prompt VariableName String Required
Run Status RunStatus Required
Interface Run Status WimInterfaceRunStatus tag
Numeric identifier of the run JobId Integer Required Key
execution.
Runtime options for an Interface ExecuteOption Optional
Execution Option WimExecOption tag
Batch number BatchNumber String Optional
Create Daily Records CreateDailyRecords String Optional
Ignore Signoff IgnoreSignOff String Optional
Include Active Employees IncludeActiveEmployees String Optional
Pay Period PayPeriod String Optional
Pay Period End Date PayPeriodEnd String Optional
Pay Period Start Date PayPeriodStart String Optional
PromptOnRenamePrevOutFile PromptOnRenamePrevOutFil String Optional
e
Variables Variables Optional
Variable Assignment WimVariable tag Zero or more of
Action Type ActionType String Optional
Comments for Variable Comment String Optional
Enabled State EnabledState Boolean Optional
Variable Name Name String Required
Variable Value Value String Optional
Unique name of Interface Name String Required Key

The following actions are available for the Date Format Validation transactions:
• Validate

Date Format Validation DateFormatValidation tag

The following action is available for the Lookup Table Validation transactions:
• Validate

8
Transactions
No Validation
The following actions are available for the No Validation transactions:
• Validate


The following actions are available for the Special Lookup Table Validation
transactions:
• Validate

Special Lookup Table Validation SpecialLookupTableValidatio
n tag

The following actions are available for the Data Integration Link Information
transactions:
Data Integration Link Information WimLink tag
File Service
The following actions are available for the File Service transactions:

File Service WimFileService tag
Context Context Optional
Download Context DownloadContext tag
File File Required
File WimFile tag
File Content ContentName String Optional
File Name Name String Required Key
File Type Type String Optional
Table Contents FileContents Optional
Table Row TableRow tag Zero or more of
Column Values Columns Optional
Simple Value SimpleValue tag Zero or more of
Value Value String Required
File Type Type String Required
Service Type ServiceType Optional
File Transfer WimFileTransfer tag
Transfer Context TransferContext tag
Transfer Type Type String Required
10
Transactions
XML Log
The following action is available for the XML Log transactions:

XML Log WimXmlLog tag
Id Id Long Required

The following actions are available for the Data Integration Lookup Table
Information transactions:

Data Integration Lookup Table WimLookupTable tag
Information

The following actions are available for the Data Integration Route transactions:
• Execute

Data Integration Route WimAPIIntegration tag
Defined route name Name String Required Key
Execution input parameters Input String Required
Run status RunStatus Required
Integration Route Execution Status WimAPIIntegrationRunStatus
tag
Numeric identifier of the route ExecutionId Long Required Key
execution.
12
Chapter 4
Export XML Transactions
This section describes the XML APIs that are used for export operations. Some
components might not include any export XML transactions.
It does not include non-export types of actions, such as Update, or non-export data
types for properties. Export transactions are grouped together, according to the
type of export; for example, all Accrual transactions are grouped together.
When exporting data, review the following considerations:
• The username and password that are used in the Logon request to export data
is the user whose access rights are checked during the export. A unique user
name, Import, is available for the specific purpose of importing and
exporting data. When the Import user name is associated with the export,
the correct access rights are set. In addition, using the Import user name will
likely improve performance because security privilege checks that are
associated with other users are bypassed. See the import section for more
information.
• There are two ways to refer to an XML tag or property: a non-technical name,
or its descriptive name; and a technical name, or its name as it is used in XML
syntax. In this document, the non-technical name is shown first. However,
examples use technical names.
3927
Chapter 4 Export XML Transactions

Transactions

The following actions are available for the Integration Manager Engine
transactions:

Integration Manager Engine KnxEngineKBO tag
Integration Manager Run History ID JobId Long Optional
Name of Integration Manager InterfaceName String Optional
Interface

The following actions are available for the Data Integration Interface Status
transactions:
• RetrieveAll
• RetrieveById

Data Integration Interface Status RunHistory tag
Id Id Long Required
Mapped Folders
The following actions are available for the Mapped Folders transactions:
• RetrieveAllNames
• Retrieve
• RetrieveForUpdate
• RetrieveAll

Mapped Folders WimFolderMap tag
Folder Alias FolderAlias String Required Key
Folder Path FolderPath String Optional

The following actions are available for the Connections for Data Integration
transactions:
• RetrieveAll
• RetrieveAllNames
• RetrieveForUpdate
• RetrieveAllForUpdate
• Retrieve
• RetrieveByType

Connections for Data Integration WimConnectionInfo tag
Connection Name Name String Required Key
Connection Type Type String Optional
Database Name or Oracle SID DataSourceName String Optional
Database server name or IP address ServerName String Optional
Database user name UserName String Optional
2
Transactions

Description of connection Description String Optional
Driver connection properties ParameterString String Optional
Instance Name on the Server InstanceName String Optional
JDBC Connection URL JdbcUrl String Optional
Java class name of JDBC Driver JdbcDriverClass String Optional
LocalizedName LocalizedName String Optional
Login time out in seconds. TimeOut Integer Optional
Network port number PortNumber Integer Optional
Password or Encrypted Password Password or Encrypted Required
choice Password One of
Password Password String

Password to database EncryptedPassword String
Url Prefix to be used(http or https) UrlPrefix String Optional

The following actions are available for the Data Integration Interface transactions:
• Retrieve
Action Parameter: LoadAssocLinks
Action Parameter: LoadAssocLookupTables
Action Parameter: LoadRunOptions
Action Parameter: LoadLightLinks
• RetrieveAll
• RetrieveRunStatus
• RetrievePrompts
Data Integration Interface WimInterface tag
Associated links with an interface AssocLinks Optional
Data Integration Link Information WimLink tag Zero or more of
Associated lookup tables with an AssocLookupTables Optional
interface WimLookupTable tag Zero or more of
Data Integration Lookup Table
Information
Overrides for steps in an interface StepOverrides Optional
Integration Override Values WimStepOverride tag Zero or more of
Execute Link or Command? EnabledState Boolean Optional
Name of the Step StepName String Required
Output type options Output Optional
WimFileOption
WimConnectionOption
n
WimADPFileOption
n
WimSourceOption
Append Records AppendRecords Boolean Optional
File Name FileName String Required
Name of the Mapped MappedFolderName String Required
Folder
Rename Previous Output RenamePreviousOutputFile Boolean Optional
File
4
Transactions

Name of the connection ConnectionName String Required
Options
n tag
Batch Name for XmlTABatchName String Optional
Transaction Assistant
Connection Name ConnectionName String Required
Use Transaction Assistant UseXMLTa Boolean Optional
Batch Number BatchNumber String Optional
Information n tag
Create Daily Records DailyRecords Boolean Optional
Ignore SignOff IgnoreSignOff Boolean Optional
Pay Period PayPeriod String Required
Pay Period End Date EndDate Date Optional
Pay Period Start Date StartDate Date Optional
Process Active Employees ActiveEmployeesOnly Boolean Optional
Only
Option
Overrides link OverridesLink Boolean Optional
Source Override Options Source Optional
WimFileOption
WimConnectionOption
n
WimADPFileOption
n
WimSourceOption
Options
n tag
Information n tag
Option
Step Number StepNumber Integer Required
Type of the Step StepType String Required
Prompts providing answers AnsweredPrompts Optional
Data Integration Prompt WimInputPrompt tag Zero or more of
Associated Link Name AssocLinkName String Required
Associated Step Number AssocStepNumber Integer Required
Information submitted Response String Required
PromptValidation PromptValidation Required
choice One of
6
Transactions

Prompt with Date Format PromptDateFormatValidation
Validation DateFormatValidation tag
Prompt with Lookup Table PromptLookupTableValidatio
Validation n
Prompt with Special Lookup PromptSpecialLookupTableVa
Table Validation lidation
Special Lookup Table SpecialLookupTableValidatio
Validation n tag
Prompt with no validation PromptNoValidation
Requested information Request String Required
Variable for prompt VariableName String Required
Run Status RunStatus Required
Interface Run Status WimInterfaceRunStatus tag
Numeric identifier of the run JobId Integer Required Key
execution.
Runtime options for an Interface ExecuteOption Optional
Execution Option WimExecOption tag
Batch number BatchNumber String Optional
Create Daily Records CreateDailyRecords String Optional
Ignore Signoff IgnoreSignOff String Optional
Include Active Employees IncludeActiveEmployees String Optional
Pay Period PayPeriod String Optional
Pay Period End Date PayPeriodEnd String Optional
Pay Period Start Date PayPeriodStart String Optional
PromptOnRenamePrevOutFile PromptOnRenamePrevOutFil String Optional
e
Variables Variables Optional
Variable Assignment WimVariable tag Zero or more of
Action Type ActionType String Optional
Comments for Variable Comment String Optional
Enabled State EnabledState Boolean Optional
Variable Name Name String Required
Variable Value Value String Optional
Unique name of Interface Name String Required Key

The following actions are available for the Date Format Validation transactions:
• GetListOfValidEntries

Date Format Validation DateFormatValidation tag
8
Transactions

The following action is available for the Lookup Table Validation transactions:

No Validation
The following actions are available for the No Validation transactions:


The following actions are available for the Special Lookup Table Validation
transactions:

Special Lookup Table Validation SpecialLookupTableValidatio
n tag

The following actions are available for the Data Integration Link Information
transactions:
• RetrieveAll
• Retrieve
Action Parameter: LoadAssocInterfaces
Action Parameter: LoadAssocLookupTables

Data Integration Link Information WimLink tag
File Service
The following actions are available for the File Service transactions:
• Download
• Upload

File Service WimFileService tag
Download Context DownloadContext tag
10
Transactions

File File Required
File WimFile tag
File Content ContentName String Optional
File Name Name String Required Key
File Type Type String Optional
Table Contents FileContents Optional
Table Row TableRow tag Zero or more of
Column Values Columns Optional
Simple Value SimpleValue tag Zero or more of
Value Value String Required
File Type Type String Required
Service Type ServiceType Optional
File Transfer WimFileTransfer tag
Transfer Context TransferContext tag
Transfer Type Type String Required
XML Log
The following action is available for the XML Log transactions:
• RetrieveXmlLog

XML Log WimXmlLog tag
Id Id Long Required
The following actions are available for the Data Integration Lookup Table
Information transactions:
• Retrieve
Action Parameter: LoadAssocInterfaces
Action Parameter: LoadAssocLinks
• RetrieveAll

Data Integration Lookup Table WimLookupTable tag
Information

The following actions are available for the Data Integration Route transactions:
• RetrieveRunStatus

Data Integration Route WimAPIIntegration tag
Defined route name Name String Required Key
Execution input parameters Input String Required
Run status RunStatus Required
Integration Route Execution Status WimAPIIntegrationRunStatus
tag
Numeric identifier of the route ExecutionId Long Required Key
execution.
12

WFC81 IntegrationMgrDTKRef

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

WFC81 IntegrationMgrDTKRef

Uploaded by

Copyright:

Available Formats

Integration Manager -

API Reference information

Kronos Workforce Central Suite

Published by Kronos Incorporated

For links to information about international subsidiaries of Kronos Incorporated, go to

Document Revision History

Document Revision Product Version Release Date

A 8.1 December 2017

Chapter 1: About This Guide

Chapter 2: XML Tags

WimFileTransfer Tag ...................................................................................84

Chapter 3: Import XML Transactions

Chapter 4: Export XML Transactions

Data Integration Interface Status ........................................................ 145

Users of this guide

Abbreviations and terms

Using the tag descriptions

The syntax conventions are described in the following table.

Syntax Description Example

Syntax Description Example

Parts of a syntax statement

The five optional parts of a syntax statement are:

The action description includes the following information:

Date Format Validation

Function Access Control Point: KNX

Introduced in v6.1; last changed in v6.3

Return Value Type: Zero or more ValidPromptString tags

Required Properties: DateFormat, DateSeparator

Return Value Type: Boolean

Required Properties: DateFormat DateSeparator ValidationString

Access Control Point Name: View

Introduced in v6.1; last changed in v6.3

1: Slash Separator (/)

2: Hyphen Separator (-)

3: Period Separator (.)

Introduced in v6.1; last changed in v6.3

Introduced in v6.1; last changed in v6.2

Function Access Control Point: KNX

Introduced in v6.1; last changed in v6.1

Type: WimFile tag

Must be a valid file of the type specified by the DownloadContext type.

Default value: none

Must be one of: "DownloadLookTable"

Default value: none

Integration Manager Engine

A valid Integration Manager interface must be provided.

Function Access Control Point: KNX

Introduced in v6.1; last changed in v6.1

Required Properties: JobId

Optional Properties: None

Access Control Point Name: Edit

Verifies the Workforce Connect Interface Name exists in database

Return Value Type: KnxEngineKBO tag

Required Properties: InterfaceName

Access Control Point Name: Edit

Introduced in v6.1; last changed in v6.1

The job id must be non-negative

Return Value Type: KnxEngineKBO tag

Required Properties: JobId

Access Control Point Name: View

Introduced in v6.1; last changed in v6.1

the interface name is valid

Required Properties: InterfaceName