System Configuration API

The System Configuration APIs support the management of company and setup information in Attendance on Demand. Configuration elements supported in the API include Clocks, Company, Status, Payroll, and Workgroup information. Setup information can be added, updated, deleted, or retrieved using the various methods below.

Table of Contents

1. Methods
2. Data Structures
3. Enumerated Data Types

Methods

Clocks - Retrieve

Type	Name	Description
READ	getClockGroupsSimple	Returns a simple list of clock groups available within the system
READ	getClockGroupStationsSimple	Returns a list of stations for a selected clock group available within the system
READ	getClustersSimple	Returns a list of clusters available within the system
READ	getClusterStationsSimple	Returns a list of stations assigned to a selected cluster available within the system

Company - Retrieve

Type	Name	Description
READ	ClientServerDateTime	Returns the client’s date and time local to the client
READ	extractNewDBElements	Extracts new database elements by element state
READ	getBaseClientData	Returns information about the client
READ	getBrowserProfilesSimple	Returns a list of browser profile names available within the system
READ	getCompanyName	Returns the client’s company name as configured by the channel partner
READ	getCurrentBrowserProfileMenuItems	Returns a list of menu items available for the browser profile currently in use
READ	getManuallySelectedSetupData	Returns configured setup data in a customized set of lists
READ	getSiteEnvironment	Returns basic information about the hosted site
READ	ServerUTCDateTime	Returns the server’s date and time

Company - Update

Type	Name	Description
WRITE	setBaseClientData	Sets (updates) information about the current client
WRITE	updateNewDBElement	Updates an existing database element

Employee Status - Retrieve

Type	Name	Description
READ	getActiveStatusConditions	Returns a list of active status conditions available within the system
READ	getHourlyStatusTypesSimple	Returns a list of hourly status types available within the system
READ	getInactiveStatusConditions	Returns a list of inactive status conditions available within the system

Other

Type	Name	Description
READ	getHyperQueriesSimple	Returns a list of hyper queries (filtered employee list) available within the system

Payroll - Delete

Type	Name	Description
DELETE	removeGlobalPayDesMappingSet	Removes a global pay mapping designation

Payroll - Retrieve

Type	Name	Description
READ	getGlobalPayDesMappingSet	Returns the properties of a global pay designation mapping set
READ	getGlobalPayDesMappingSetMappings	Returns the history of properties of a global pay designation mapping set
READ	getGlobalPayDesMappingsSimple	Returns a list of global pay designation mapping definitions
READ	getPayClassesSimple	Returns a list of pay classes available within the system
READ	getPayDesignationsSimple	Returns a list of pay designations available within the system
READ	getPayPeriodClassData	Returns details about a selected pay period class
READ	getPayPeriodClasses	Returns a list of pay period classes established in the client’s system
READ	getPayTypes	Returns a list of pay types available within the system
READ	getReasonCodesSimple	Returns a list of reason codes available within the system

Payroll - Update

Type	Name	Description
WRITE	appendGlobalPayDesMappingSetMapping	Adds a mapping definition to a global pay designation mapping set

Workgroups - Delete

Type	Name	Description
DELETE	delWorkgroup	Delete a workgroup not in use
DELETE	removeDeptXlateItem	Removes a department translate item
DELETE	removeWGXlate	Removes a workgroup mapping translation

Workgroups - Retrieve

Type	Name	Description
READ	extractDeptXlateItems	Retrieve a list of mapped department translations which were used during autobuild
READ	extractWGXlates	Extracts the system’s list of workgroup translations
READ	getWorkgroup	Returns details about a specific workgroup based on level and number
READ	getWorkgroupLevelDetails	Returns details about a selected workgroup level
READ	getWorkgroups	Returns a sorted list of sub workgroups for a selected workgroup level
READ	getWorkgroupStruct	Returns an empty TAeWorkgroup structure
READ	getWorkgroupViaCode	Retrieve details for a workgroup by code
READ	getWorkgroupViaName	Retrieve details for a workgroup by name
READ	nextWGNumForWGLevel	Returns the next sequential workgroup number for the workgroup level specified

Workgroups - Update

Type	Name	Description
WRITE	addDeptXlateItem	Used to translate a mapped department during an autobuild
WRITE	addWorkgroup	Add a new workgroup to an existing workgroup level
WRITE	maintainWGXlate	Upload a workgroup mapping translation structure
WRITE	setWorkgroup	Updates a workgroup
WRITE	setWorkgroupLevelLabels	Sets details about a selected workgroup level
WRITE	updateDeptXlateItem	updates a translated mapped department

Data Structures

Name	Description
TAeBasicDataItem	Code tables
TAeBrowserMenuItem	Menu items based on user account
TAeClientData	Client information
TAeDeptXlateItem	Identifies late item
TAeNewDBElement	New DB element information
TAePayDesMapping	Description coming
TAePayDesMappingSet	Description coming
TAePayPeriodInfo	Pay information by pay class
TAeSiteEnvironment	Shows site environment
TAeWorkgroup	Individual workgroup information
TAeWorkgroupLevel	Workgroup information by level
TAeWorkgroupXLate	Workgroup information by an external identifier

Enumerated Data Types

Name	Description
TWGSortingOption	Workgroup sorting options

Back to Top