Employee Field Definitions

Modified on Mon, Nov 16, 2020 at 5:07 PM

The following tables describe the data sources under Employee. They list the fields available and provide a brief description of contents. They include:




Availability Override

You can report on data regarding employees who alter or override their normal availability schedule. Reports gather information from the following sources.

  • Employee information is specified in the Add or Edit Employee window. 

  • Location information is specified in the Add or Edit Location window.

  • Employees specify availability information on the Single Day Override window in the Employee Portal.

Field

Description of contents

Active

A flag that indicates whether employee is available for use in scheduling shifts. Displays on reports as True if active and False if inactive. Status is active unless an inactive date is set on Employee Status window.

Available

Specific times employee is available or unavailable for assignment (depends on value of Enabled Yes/No). (Employee selects Available Times on Single Day Override window.)

Date

Date of the override.

Yes/No (Enabled)

 Indicates whether the availability is "Off" or "On".

On/OffIndicates which days the employee can (on) or can't (off) be scheduled.

Hours

Number of hours in the Available Range.

Name

Name or type of the Availability Override. Report displays either Global Day Override or Local Day Override.

Preferred

Specific times employee prefers to be scheduled. (Overrides default preferred times for a date.)

Scope

Name of override's scope or availability. Report displays either Global or Local with the location's name.

Count

A count of the Availability Overrides, grouped by the other fields selected.

Total Hours

A sum of the Availability Overrides Hours, grouped by the other fields selected.


Availability Template

You can report on data regarding employee availability on templates. Depending on your company's administration, data for each employee is entered in either the Location portal or the Employee portal. See the following:

  • Employee contact and scheduling information is specified in the Add or Edit Employee window. In many organizations, employees maintain their personal and contact information in the Employee portal.

  • Location information is specified in the Add or Edit Location window.

  • Schedulers enter availability in the Location portal in either a Global or Local template or, if Location Admin settings permit, employees enter their availability themselves on templates in the Employee portal.

Field

Description of contents

Active

A flag that indicates whether employee is available for use in scheduling shifts. Displays on reports as True if active and False if inactive. Status is active unless an inactive date is set on Employee Status window.

Available

Specific times employee is available.(Employee enters Available Times in the Availability Template window.)

Effective End

Date the availability template ends, if Date-Based

Effective Start

Date the availability template starts, if Date-Based

On/Off

Indicates which days the employee can (on) or can't (off) be scheduled.

Hours

Number of hours an employee is available based on Enabled and Available values.

Preferred

Specific times employee prefers to be scheduled. (Overrides default preferred times for a date.)

Priority

Rank indicating which days employee wishes to be schedule at first with 1 being last and 9 being first.

Scope

Name of template. Reports displays either Global, Local, or Date Based

Name

Name or type of the Availability Override. Report displays either Global Day Override or Local Day Override.



Employee

You can report on data regarding employees at a location using the Location portal. Included is personal data, contact information, and scheduling, as well as leave requests and credentials. Some fields are unique to the Location portal, and the Employee (Local) data source provides access to this data. See the following:

  • Employee contact and scheduling information is specified in the Add or Edit Employee window. In many organizations, employees maintain their personal and contact information in the Employee portal.

  • Location information is specified in the Add or Edit Location window.

Field

Description of contents

Active

A flag that indicates whether employee is available for use in scheduling shifts. Displays on reports as True if active and False if inactive. Status is active unless an inactive date is set on Employee Status window.

ActivityThe default activity this employee is assigned to. (Entered in Employee Time window.)

Address

Employee's street address. (Entered in the Employee Contact window.)

Address 2

Additional information for employee address. (Entered in the Employee Contact window.)

Allow SwapEntered Yes or No to indicate whether or not this employee is able to swap shifts with others. (Entered in Employee Schedule window.)
AttributeA skill or experience the employee has. (Entered in Attributes Schedule window.)
Attribute EndWhen the attribute ends. (Entered in Employee Attributes window.)
Attribute NotesAny notes attached to an attribute. (Entered in Attributes Schedule window.)
Attribute StartWhen the attribute started (Entered in Employee Attributes window.)
Attribute ValueHow valuable that attribute is. (Entered in Employee Attributes window.)
Badge Id

Employee's Badge Id (Entered in the Employee Personal window.)

Bio Id

Employee's Bio Id. (Entered in the Employee Personal window.)

Birth Date

Employee's birthdate. (Entered in the Employee Personal window.)

City

City of the employee address. (Entered in Employee Contact window.)

Consecutive DaysThe number of days in a row an employee can work. (Entered in Employee Schedule window.)

Country

Country of the employee address. (Entered in Employee Contact window.)

CrewWhich work crew the employee is assigned to. (Entered in Employee Schedulewindow.)

Email

Email of the employee. (Entered in Employee Contact window.)

External Id

Employee number for use with an external system, such as HR or Payroll. (Entered in Employee Personal window.)

FaxThe fax number for the employee. (Entered in Employee Personal window.)

First Name

Employee's first name. (Entered in Employee Personal window.)

GeoLocation

The latitude and longitude of the location. (Entered in Employee Personal window.)

Last Name

Employee's last name. (Entered in Employee Personal window.)

Max Days Per Week

Maximum number of working days per week this employee can be assigned to work. The Automatic scheduling system honors this setting and does not assign an employee to a shift that exceeds Max Days. (Entered in Employee Schedule window.)

Max Hours Per Week

Maximum number of hours per week this employee can be assigned to work. The Automatic scheduling system honors this setting and does not assign an employee to a shift that exceeds Max Hours. (Entered in Employee Schedule window.)

Max Hours Per Day

Maximum number of hours per day this employee can be assigned to work. The Automatic scheduling system honors this setting and does not assign an employee to a shift that exceeds Max Hours Per Day. (Entered in Employee Schedule window.)

Max Shifts Per Day

Maximum number of shifts per day this employee can be assigned to work. The Automatic scheduling system honors this setting and does not assign an employee to a shift that exceeds Max  Shifts Per Day. (Entered in Employee Schedule window.)

Min Hours Per Week

Minimum number of hours per week for this employee. Used only for reports and analysis. (Entered in Employee Schedule window.)

MobileEmployee's mobile phone number. (Entered in Employee Personal window.)
Nick Name

Employee's nick name. (Entered in Employee Personal window.)

Notes

Textual notes related to the Employee. (Entered on Employee Personal window.)

PasswordA place to create a new password for an employee (Entered in Employee Personal window.)
Pay RateEmployee's hourly rate of pay. (Entered in Employee Schedule window.)

Phone

Employee's phone number. (Entered in Employee Contact window.)

Phone 2

Additional employee phone number. (Entered in Employee Contact window.)

Phone 3

Additional employee phone number (Entered in Employee Contact window.)

PhotoWhere employee pictures can be taken and uploaded. (Entered in Employee Contact window.)
PIN

Employee's Pin number issued for clocking via a telephone. (Entered in Employee Photo window.)

Postal Code

Employee's zip code or postal code. (Entered in Employee Contact window.)

Project/TackTh default project/task this employee is assigned on a schedule. (Entered in Employee Time window.)

Rank

Rank of the employee versus other employees. Used in seniority considerations. (Entered in Employee Schedule window.)

RotationWhich schedule rotation the employee is assigned to. (Entered in Employee Schedule window.)
Seniority DateUsed to determine which employees have seniority and can be different than their start date. (Entered in Employee Personal window.)
Start Date

Employee Start Date. (Entered in Employee Personal window.)

State

Employee’s state (Entered in Employee Contact window.)

StyleThe color, font, and style used when this employee is inserted into schedules and other places. (Entered in Employee Personal window.)

End Date

Termination or Inactive date of employee. (Entered in Employee Personal window.)

Time Zone Offset

The hour difference between UTC time and the time zone setting for the employee. (Entered in Employee Time window.)

Time Zone 

The time zone for the employee shifts (Entered in Employee Time window.)

UserDefined1 - UserDefined6

Custom field(s) identified in Admin > Custom Fields > Employee.

User Name

Employee's username. (Entered in Employee Personal window.)



Employee Deployments

You can report on data regarding employees at a location using the Location portal. Included is personal data, contact information, and scheduling as well as leave requests and credentials. Some fields are unique to the Location portal, and the Employee (Local) data source provides access to this data. See the following:

  • Employee contact and scheduling information is specified in the Add or Edit Employee window. In many organizations, employees maintain their personal and contact information in the Employee portal.

  • Location information is specified in the Add or Edit Location window.

You can keep track of employee credentials, qualifications, certifications, and training classes as they relate to stations and shift assignments. Designate locations that require enforcement of credentials and identify non-compliant shifts. Run reports on a periodic basis that list expired credentials, credentials that will expire in the near future, and shifts that highlight employees who are non-compliant. See the following:

  • Credentials are established in the Enterprise portal. Go to the Credentials section of TeamWork to add and edit credentials. While you assign credentials to employees in the Enterprise portal, a scheduler with role permissions can view credentials in the Location portal and Employees can view their credentials in the Employee portal.

  • Location information is specified in the Add or Edit Location window.

  • Employee contact and scheduling information is specified in the Add or Edit Employee window. In many organizations, employees maintain their personal and contact information in the Employee portal.

    Note: Credentials such as qualifications and certifications are assigned to specific employees. When you run reports to view Employee Credentials, only the employees who have those qualifications and certifications assigned to them are listed.



Field

Description of contents

Agreement End Date

End date of current employee agreement. When an agreement is added to an employee, any previous agreement is terminated on the day before the new agreement begins. An employee can only be under one agreement at one time.

Agreement Policy

Name of effective Employee Policy. (Entered in Organization > Policies and assigned to an employee when you assign an employee agreement.)


Agreement Position

Name of effective position. (Entered into Admin > Lists > Employee Positions and assigned to an employee when you assign an employee agreement.)

Agreement Start Date

Start date of current employee agreement. Agreements are entered in the Enterprise portal under Admin > Lists > Employee Agreements. When you assign an agreement to an employee using Employees > Mass-Assign or add a new employee agreement in Employees > Agreements, you designate an Effective Date, which is the Agreement Start Date.

Agreement Type

Indicates the name of the agreement. Add an Employee Agreement Type in the Employee Agreements window under Admin > Lists in the Enterprise portal

Credentials Completed

Date the qualification was completed. (Entered in Name in the Qualification or Certification window.)
Credentials DueDate the qualification must be completed by. (Entered in Name in the Qualification or Certification window.)
Credentials End

Last date qualification is effective for an employee. (Entered in Name in the Qualification or Certification window.)

Credentials Name

Name associated with this qualification or certification. (Entered in Name in the Qualification or Certification window.)

Credentials Notes

Notes associated with this qualification or certification. (Entered in Notes in the Qualification or Certification window.)

Credentials Start

Date qualification begins being effective for an employee. (Entered in Name in the Qualification or Certification window.)

Credentials Status

Indicates qualification status: Complete = valid and Pending = pending (Entered in Notes in the Qualification or Certification window.)

FolderThe organization folder the employee is assigned to. (Entered in Employee Folder window.)
LocationName of the location the employee can be assigned to. (Entered in Employee Locations window.)
Location Allow SwapMarked Yes or No to indicate whether or not employees can swap shifts at this location. (Entered in Employee Locations window.)
Location CodeThe code employees and managers use when logging on to TeamWork 5. (Entered in Employee Locations window.)

Location Default

Indicates the location chosen as an employee's the primary work location in the Enterprise portal. To edit the Default Location, go to Employees > Location and click on a Location in the list of locations for that employee. On the Locations Settings window that displays, select Yes or No for Default. (Entered in Employee Locations window.)

Location DistanceDistance to the location. (Entered in Employee Locations window.)
Location EditableYes or no as to whether or not this location can be edited for this employee. (Entered in Employee Locations window.)
Location End DateWhen the location ends and is no longer being worked at. (Entered in Employee Locations window.)
Location Hire DateWhen the employee was hired to work at that location. (Entered in Employee Locations window.)
Location Pay RateThe employee's hourly rate per location. (Entered in Employee Locations window.)
Location PreferenceA ranking used to show which location(s) the employee should be assigned to first when using autofill schedules. (Entered in Employee Locations window.)
Station NameThe name of the station the employee can be assigned to. (Entered in Employee Station window.)
Station PriorityA ranking of which stations the employee should be assigned to first with 1 being lowest priority and 9 being highest. (Entered in Employee Stations window.)




Employee Leave

You can report on employee leave. When employees request leave, they select a leave type. The leave is granted or denied in the Location portal or the Enterprise portal. See the following:

  • Employee contact and scheduling information is specified in the Add or Edit Employee window. In many organizations, employees maintain their personal and contact information in the Employee portal.

  • Location information is specified in the Add or Edit Location window.

  • Leave Types information is specified in Admin in the Enterprise portal.

Field

Description of contents

Comment

Comment employee enters when leave is requested.

Days

Count of days in the effective leave date range.

Employee Request Time

Timestamp of the entry in employee’s Time Zone, if different from location.

End Time

Ending time of partial day off entry.

Enterprise Request Time

Timestamp of the entry in enterprise Time Zone.

Last Updated Date

Timestamp of last update to leave entry.

Leave Hours

Total hours of leave entry.

Leave Type Code

Code associated with this leave type for the entry.

Leave Type Id

Unique ID for the leave type, set by ScheduleSource.

Leave Type Name

Name of the leave type for the entry.

Location Request Time

Timestamp of the entry in location’s Time Zone.

Notes

Notes related to the Employee. (Entered on Employee Information window.

Off Type

UNUSED

Request Status

Numerical indication of leave request status: 1 = request initiated, 0 = request granted, 2 = request denied

Request Status Text

Text indication of leave request status: REQUEST (request initiated), GRANTED (request granted), DENIED (request denied), CANCELLED (granted leave was cancelled by request)

Request Time

Timestamp of entry creation.

Start Month

Month formatted (MM) DateStart.

Start Time

Start time of partial day off.

Start Year

Year formatted (YYYY) DateStart.

Time Off

Text representation of start/end times for partial day off.

UserName

Employee's username. (Entered in Username/ID in Employee Information window.)

Cancel Requested Count

A count of the Leave Entries that have been requested cancelled (but not yet cancelled), grouped by the other fields selected.

Count

A count of the Leave Entries, grouped by the other fields selected.

Denied Count

A count of the Leave Entries with DENIED status, grouped by the other fields selected.

Granted Count

A count of the Leave Entries with GRANTED status, grouped by the other fields selected.

Leave Hours Total

A sum of the Leave Entry Hours, grouped by the other fields selected.

Request Count

A count of the Leave Entries with REQUEST status, grouped by the other fields selected.

Total Days

A sum of the Leave Entry Days, grouped by the other fields selected.



Employee Skills

You can keep track of employee skills as they relate to stations and shift assignments. Station ranks are defined when stations are added and configured in locations in the Enterprise portal. While in many organizations, schedulers assign employee skills in the Location portal, you can also assign skills in the Enterprise portal.
 

Field

Description of contents

AddAdd a new skill.
DeleteDelete a station.

Location

Name of the location the employee can be assigned to. (Entered in Employee Locations window.)

Priority

Rank indicating which days employee wishes to be schedule at first with 1 being last and 9 being first.

Station

The station the employee is assigned to. (Entered in Employee Station window.)

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article