Time clock systems by TimeIPS
Call Now! 316-264-1600
Information
Sales
Support
Knowledge Base Search:  
Main Menu
· Home

· Table of Contents
· Article Index

· Downloads
· New Features
· FAQ
· News
· Web Links

   
TimeIPS Knowledge Base

Table of Contents: Article IndexPrintable Version

Applies to versions: 4.0



Expression Variables for Employees, Jobs, Work Orders, Time Events, etc.



The following tables show variables that are used throughout the system. Such places include Advanced Modifications and Accruals using Expressions, Schedule Groups Break Rules Expression Variables, Monthly Employee Counts, the Time Edit tab on the Divisions page, and Remote Clocking Whitelist Expressions. This table shows [user] as the starting point. Other places might use a different name like [editor] or nothing at all. Please see the respective page for whichever entity you are trying to write an expression for.

User Variables

Variable OutlineFull Variable NameDescription 
user
 [user] This variable itself has no value to expressions. It serves as the starting point for multi-dimensional variables that contain more information about this employee. 
        usersID
 [user][usersID] This is the unique database ID assigned to this employee by TimeIPS. This will always be unique among all employees in the system. 
        nameFirst
 [user][nameFirst] The employee's first name. 
        nameLast
 [user][nameLast] The employee's last name. 
        nameMid
 [user][nameMid] The employee's middle name if provided.  
        namePref
 [user][namePref] The employee's preferred name if provided. 
        HID
 [user][HID] The employee's badge number. 
        type
 [user][type] Starting point for information about the employee's payroll type.  
                typeID
 [user][type][typeID] A unique database ID assigned to this payroll type. 
                name
 [user][type][name] The name of the employee's payroll type. 
                timing_frame
 [user][type][timing_frame] An indicator about the payroll frequency of this payroll type. Possible values are 'week', 'biweek', 'month', 'bimonth', and '4-4-5'. 
                code
 [user][type][code] An arbitrary payroll code associated with this payroll type. 
        orgUnit
 [user][orgUnit] Starting point for the employee's organizational unit. 
                organizationalUnitID
 [user][orgUnit][organizationalUnitID] A unique database ID for this unit. 
                name
 [user][orgUnit][name] The name of this unit. 
                code
 [user][orgUnit][code] An arbitrary code associated with this unit. 
        scheduleGroup
 [user][scheduleGroup] Starting point for this employee's schedule group. 
                schedGroupID
 [user][scheduleGroup][schedGroupID] Unique database ID. 
                name
 [user][scheduleGroup][name] The name of this schedule group. 
        defaultDepartment
 [user][defaultDepartment] Starting point for information about this employee's default department. 
                departmentID
 [user][defaultDepartment][departmentID] A unique database ID. 
                name
 [user][defaultDepartment][name] The name of this employee's default department. 
                shortName
 [user][defaultDepartment][shortName] The abbreviated name of this department. 
                ctrlNum
 [user][defaultDepartment][ctrlNum] An arbirtrary control number for this department. 
                code
 [user][defaultDepartment][code] The code for this department. This is the code employees might type at the clock. 
                subCode
 [user][defaultDepartment][subCode] An optional subcode for this department. 
                glNum
 [user][defaultDepartment][glNum] An optional G.L. Number for this department. 
                altNum
 [user][defaultDepartment][altNum] An optional alternate number used by this department. 
                trackTime
 [user][defaultDepartment][trackTime] Either a 1 or 0 if this department is tracked against worked time. 
                trackBenefits
 [user][defaultDepartment][trackBenefits] Either a 1 or 0 if this department is tracked against benefits. 
                trackHolidays
 [user][defaultDepartment][trackHolidays] Either a 1 or 0 if this department is tracked against holidays. 
                trackPiecework
 [user][defaultDepartment][trackPiecework] Either a 1 or 0 if this department is tracked against piecework. 
        defaultWorkOrder
 [user][defaultWorkOrder] Starting point for information about the employee's default work order. 
                workOrderID
 [user][defaultWorkOrder][workOrderID] A unique database ID about this work order. 
                name
 [user][defaultWorkOrder][name] The name of this work order. 
                lcdName
 [user][defaultWorkOrder][lcdName] The abbreviated name of this work order. 
                code
 [user][defaultWorkOrder][code] The code to identify the work order. 
                poNum
 [user][defaultWorkOrder][poNum] A P.O. number associated with the work order. 
                dateStart
 [user][defaultWorkOrder][dateStart] The date work on this work order is intended to begin 
                dateDue
 [user][defaultWorkOrder][dateDue] The due date of this work order. 
                note
 [user][defaultWorkOrder][note] A note associated with this work order. 
                customer
 [user][defaultWorkOrder][customer] A starting point for information about the customer on this work order. 
                        custID
 [user][defaultWorkOrder][customer][custID]  This customer's unique database ID. 
                        name
 [user][defaultWorkOrder][customer][name] The name of this customer. 
                        addr1
 [user][defaultWorkOrder][customer][addr1] The first line in this customer's address. 
                        addr2
 [user][defaultWorkOrder][customer][addr2] The second line in this customer's address. 
                        city
 [user][defaultWorkOrder][customer][city] The city for this customer's address. 
                        state
 [user][defaultWorkOrder][customer][state] The state for this customer's address. 
                        zip
 [user][defaultWorkOrder][customer][zip] The zip code for this customer's address. 
                        phone
 [user][defaultWorkOrder][customer][phone] The phone number on this customer. 
                        fax
 [user][defaultWorkOrder][customer][fax] The fax number on this customer. 
        defaultJob
 [user][defaultJob] Starting point for information about this customer's default job. 
                jobID
 [user][defaultJob][jobID] The unique database ID associated with this job. 
                lcdName
 [user][defaultJob][lcdName] The shortened name of this job. 
                code
 [user][defaultJob][code] The job code used to clock in to this job. 
                name
 [user][defaultJob][name] The name of the job. 
                ctrlNum
 [user][defaultJob][ctrlNum] A control number associated with the job. 
                billingRate
 [user][defaultJob][billingRate] A billing rate associated with the job. 
                glNum
 [user][defaultJob][glNum] A G.L. number for the job. 
                description
 [user][defaultJob][description] Any description provided about the job. 
                subCode
 [user][defaultJob][subCode] An arbitrary sub code identifier for the job. 
                altNum
 [user][defaultJob][altNum] The job's alternate number. 
                customer
 [user][defaultJob][customer] A starting point for information about the customer on this job. 
                        custID
 [user][defaultJob][customer][custID] This customer's unique database ID. 
                        name
 [user][defaultJob][customer][name] The name of this customer. 
                        addr1
 [user][defaultJob][customer][addr1] The first line in this customer's address. 
                        addr2
 [user][defaultJob][customer][addr2] The second line in this customer's address. 
                        city
 [user][defaultJob][customer][city] The city for this customer's address. 
                        state
 [user][defaultJob][customer][state] The state for this customer's address. 
                        zip
 [user][defaultJob][customer][zip] The zip code for this customer's address. 
                        phone
 [user][defaultJob][customer][phone] The phone number on this customer. 
                        fax
 [user][defaultJob][customer][fax] The fax number on this customer. 
                category
 [user][defaultJob][category] Starting point for information about this job's category. 
                        catID
 [user][defaultJob][category][catID] A unique database ID for this category. 
                        name
 [user][defaultJob][category][name] The name of the category. 
                        descr
 [user][defaultJob][category][descr] A description about this job category. 
                        code
 [user][defaultJob][category][code] A code associated with this job category. 
        manager
 [user][manager] *? This is the employee's manager. There is another complete set of variables for the manager starting where this list startes with 'user'. For example to get this employee's manager's name you could use [user][manager][nameFirst] If the manager has a manager above them then they will also have a manager entry at [user][manager][manager] and so on.

Job Variables

Variable OutlineFull Variable NameDescription 
job
 [job] Starting point for information about this job. 
        jobID
 [job][jobID] The unique database ID associated with this job. 
        lcdName
 [job][lcdName] The shortened name of this job. 
        code
 [job][code] The job code used to clock in to this job. 
        name
 [job][name] The name of the job. 
        ctrlNum
 [job][ctrlNum] A control number associated with the job. 
        billingRate
 [job][billingRate] A billing rate associated with the job. 
        glNum
 [job][glNum] A G.L. number for the job. 
        description
 [job][description] Any description provided about the job. 
        subCode
 [job][subCode] An arbitrary sub code identifier for the job. 
        altNum
 [job][altNum] The job's alternate number. 
        customer
 [job][customer] A starting point for information about the customer on this job. 
                custID
 [job][customer][custID] This customer's unique database ID. 
                name
 [job][customer][name] The name of this customer. 
                addr1
 [job][customer][addr1] The first line in this customer's address. 
                addr2
 [job][customer][addr2] The second line in this customer's address. 
                city
 [job][customer][city] The city for this customer's address. 
                state
 [job][customer][state] The state for this customer's address. 
                zip
 [job][customer][zip] The zip code for this customer's address. 
                phone
 [job][customer][phone] The phone number on this customer. 
                fax
 [job][customer][fax] The fax number on this customer. 
        category
 [job][category] Starting point for information about this job's category. 
                catID
 [job][category][catID] A unique database ID for this category. 
                name
 [job][category][name] The name of the category. 
                descr
 [job][category][descr] A description about this job category. 
                code
 [job][category][code] A code associated with this job category.

Work Order Variables

Variable OutlineFull Variable NameDescription 
workOrder
 [workOrder] Starting point for information about the work order. 
        workOrderID
 [workOrder][workOrderID] A unique database ID about this work order. 
        name
 [workOrder][name] The name of this work order. 
        lcdName
 [workOrder][lcdName] The abbreviated name of this work order. 
        code
 [workOrder][code] The code to identify the work order. 
        poNum
 [workOrder][poNum] A P.O. number associated with the work order. 
        dateStart
 [workOrder][dateStart] The date work on this work order is intended to begin 
        dateDue
 [workOrder][dateDue] The due date of this work order. 
        note
 [workOrder][note] A note associated with this work order. 
        customer
 [workOrder][customer] A starting point for information about the customer on this work order. 
                custID
 [workOrder][customer][custID]  This customer's unique database ID. 
                name
 [workOrder][customer][name] The name of this customer. 
                addr1
 [workOrder][customer][addr1] The first line in this customer's address. 
                addr2
 [workOrder][customer][addr2] The second line in this customer's address. 
                city
 [workOrder][customer][city] The city for this customer's address. 
                state
 [workOrder][customer][state] The state for this customer's address. 
                zip
 [workOrder][customer][zip] The zip code for this customer's address. 
                phone
 [workOrder][customer][phone] The phone number on this customer. 
                fax
 [workOrder][customer][fax] The fax number on this customer.

Time Event Variables

Variable OutlineFull Variable NameDescription 
eventLogID
 [eventLogID] The ID of this time event. 
usersID
 [usersID] The ID of the employee who is associated with this time event. 
timeIn
 [timeIn] A Unix timestamp for the clock-in date and time of this time event. 
timeOut
 [timeOut] A Unix timestamp for the clock-out date and time of this time event. 
flagIn
 [flagIn] Either 1 or 0. 1 means that the clock-in part of this time event is flagged. 0 means that the clock-in part of this time event is not flagged. 
flagOut
 [flagOut] Either 1 or 0. 1 means that the clock-in part of this time event is flagged. 0 means that the clock-in part of this time event is not flagged. 
adminID
 [adminID] The ID of the administrator who is making the change to this time event. 
auditDate
 [auditDate] A Unix timestamp for the date and time of the audit. 
auditNote
 [auditNote] The audit note. 
jobID
 [jobID] The ID of the job that is associated with this time event. 
clockNote
 [clockNote] The clock-in note. For the clock-out note, see [clockNoteOut]. 
adjTimeIn
 [adjTimeIn] A Unix timestamp for the adjusted clock-in date and time of this time event. 
adjTimeOut
 [adjTimeOut] A Unix timestamp for the adjusted clock-in date and time of this time event. 
clientIn
 [clientIn] The ID of the client for the clock-in part of this time event. 
clientOut
 [clientOut] The ID of the client for the clock-out part of this time event. 
clientAdjIn
 [clientAdjIn] The adjusted client ID for the clock-in part of this time event. 
clientAdjOut
 [clientAdjOut] The adjusted client ID for the clock-out part of this time event. 
changelogID
 [changelogID] The changelog ID. 
remoteIpIn
 [remoteIpIn] The clock-in remote IP address. 
remoteIpOut
 [remoteIpOut] The clock-out remote IP address. 
cidInNumber
 [cidInNumber] The number of the caller ID for the clock-in part of this time event. 
cidInName
 [cidInName] The name of the caller ID for the clock-in part of this time event. 
cidOutNumber
 [cidOutNumber] The number of the caller ID for the clock-out part of this time event. 
cidOutName
 [cidOutName] The name of the caller ID for the clock-out part of this time event. 
voiceIn
 [voiceIn] The clock-in voiceprint. 
voiceOut
 [voiceOut] The clock-out voiceprint. 
clockNoteOut
 [clockNoteOut] The clock-out note. For the clock-in note, see [clockNote]. 
remoteIpInOrig
 [remoteIpInOrig] The original clock-in remote IP. 
cidInNameOrig
 [cidInNameOrig] The original name of the caller ID for the clock-in part of this time event. 
cidInNumberOrig
 [cidInNumberOrig] The original number of the caller ID for the clock-in part of this time event. 
clientInOrig
 [clientInOrig] The original client ID for the clock-in part of this time event. 
remoteIpOutOrig
 [remoteIpOutOrig] The original clock-in remote IP. 
cidOutNameOrig
 [cidOutNameOrig] The original name of the caller ID for the clock-out part of this time event. 
cidOutNumberOrig
 [cidOutNumberOrig] The original number of the caller ID for the clock-out part of this time event. 
clientOutOrig
 [clientOutOrig] The original client ID for the clock-out part of this time event. 
realTimeIn
 [realTimeIn] The real time of the clock itself, as perceived at the clock before snapping/rounding/rules/etc. 
realTimeOut
 [realTimeOut] The real time of the clock itself, as perceived at the clock before snapping/rounding/rules/etc. 
departmentID
 [departmentID] The ID of the department that is associated with this time event. 
isJobChange
 [isJobChange] Either 1 or 0. 1 means that this time event is a job change. 0 means that this time event is not a job change. 
latIn
 [latIn] The clock-in geo location latitude. 
lngIn
 [lngIn] The clock-in geo location longitude. 
latOut
 [latOut] The clock-out geo location latitude. 
lngOut
 [lngOut] The clock-out geo location longitude. 
geoZoneIn
 [geoZoneIn] The name of the clock-in geo zone. 
geoZoneOut
 [geoZoneOut] The name of the clock-out geo zone. 
geoZoneLocationIn
 [geoZoneLocationIn] The name of the clock-in geo zone location. 
geoZoneLocationOut
 [geoZoneLocationOut] The name of the clock-out geo zone location. 
uniqueIDIn
 [uniqueIDIn] Clock-in unique ID to allow an update to the event after creation. 
uniqueIDOut
 [uniqueIDOut] Clock-out unique ID to allow an update to the event after creation. 
department
 [department] Starting point for information about this time event's department. See the variables for the default department in the user variables table, above. It has the exact same stuff here. 
job
 [job] Starting point for information about this time event's job. See the job variables table, above. It has the exact same stuff here. 
workOrder
 [workOrder] Starting point for information about this time event's work order. See the work order variables table, above. It has the exact same stuff here.


©2004-2025 TimeIPS, Inc. All Rights Reserved - TimeIPS and the TimeIPS logo are registered trademarks of TimeIPS, Inc.
"Intelligent Personnel System" "Run your Business. We'll watch the clock." are trademarks of TimeIPS, Inc.
TimeIPS is protected by one or more patents. Patent No. US 7,114.648 B2.