.png)
The Clock In/Out screen is used by shift workers to clock in to and clock out from a workplace. This allows you to pay staff accurately for the number of hours worked.
The Clock In/Out screen has two buttons as follows:
The text on the buttons can be changed by specifying the "in" and "out" options in the screen details. For example:
in=Start Shift, out=End Shift
The buttons can be further configured to allow you to collect data during your clock in and clock out events, using the following syntax:
in/out = <button>:<type>:<label>:<details>
where <button> is the button text, <type> is the type of data you want to capture , <label> is the name of the data field, and <details> are the type specific details.
While all data types can be used at either Clock In or Clock Out, the following data types are typically used at Clock In:
And the following data types are typically used at Clock Out:
Each of these data types is explained in more detail below.
A data type of "dual" is used to capture values from two different lists, such as a project name and a work type. The "in" option should be configured with the following colon separated components:
For example:
in=Start Shift:dual:Project:Work Type:Airport;Tower One;Naval Base:Design;Construction;Maintenance:Airport
If you are synchronising your users with a system that supports global lists, you can specify your list values by providing the appropriate list numbers. For example:
in=Start:dual:Project:Work Type:$1:$2
You can optionally filter the first list to only include items that contain the current site name by specifying the "sitelist" option. For example:
in=Start Work:dual:Position:Time Entry Code:$1:$2,
sitelist=true
A data type of "nest" is used to capture values from two different lists, such as a project name and a work type, when the list of work types varies for each project. The "in" option should be configured with the following colon separated components:
Then, for each value in the first list, you separtely define the values in the second list with the following colon separated components:
Each of the second lists is defined by the option "list1", "list2", etc, in the order of the options in the first list. For example:
in=Start Shift:nest:Project:Airport;Tower One;Naval Base,
list1=Work Type:Design;Construction;Maintenance,
list2=Work Type:Maintenance:Maintenance,
out=End Shift
Notice in this example that the Naval Base project does not have a corresponding list of Work Types, so it won't be necessary to select a Work Type for that project.
If you are synchronising your users with a system that supports global lists, and your list is hierarchical, you can specify your list values by providing the appropriate list number. For example:
in=Start Shift:nest:Work Type:$4
A data type of "tree" is used to capture values from a hierarchical list, such as a list of cost centers. Each level of the hierarchy is selected independently (one after the other), and searching is supported when a level has a large number of options. The "in" option should be configured with the following colon separated components:
For example:
in=Start Work:tree:Project;Work Type:$1
For example:
in=Clock In:type:Department;Position:$1:false
A data type of "site" is intended to be used when a hierarchical selection list is maintained in a workforce management platform, and the top level of the hierarchy is the site. NoahFace filters the selection list so that only the options that correspond to the current site are displayed, simplifying the user experience. If there is only one option available to a user at the site, it will be automatically selected.
The "in" option should be configured with the following colon separated components:
For example:
in=Clock In:site:Department;Position:$1:false
A data type of "api" is used to capture a value from an external system, such as a blood alcohol reading from a breathalyser. The "in" option should be configured with the following colon separated components:
Your URL will be passed query parameters containing information on the user (eg: firstname, lastname, etc) and the environment (eg: org, site, etc), and is expected to return an HTTP status of either:
Your response body is expected to contain your value (eg: the blood alcohol reading). If you return an error, you can optionally return additional details by setting the field X-NOAHFACE-MESSAGE in your response header.
For example:
in=Start Work:api:Breathalyser:To start work please conduct a breath test using the adjacent breathalyser.:deny:120:http://192.254.1.100/breathtest, out=Stop Work
A data type of "scan" is used to capture a value from a barcode or QR code. The "in" option should be configured with the following colon separated components:
Barcodes must be large and clear to be read by the limited resolution of the front facing iPad camera. The following types of barcode are supported:
Only alpha and numeric values are supported, up to 40 characters in length.
For example:
in=Start Job:scan:Job Number:Please scan your job sheet., out=Complete
A data type of "select" is used to capture two-option attestations at the end of a shift. The "out" option should be configured with the following colon separated components:
For example:
out=End Shift:select:Shift Confirmation:Please confirm that you worked your standard hours and you took your required rest breaks. Otherwise please provide a justification.:negative:Justification:Standard Hours:Extra Time Worked:Rest Breaks Taken:Breaks Not Taken:none
A data type of "break" is used to capture the times of paid rest breaks at the end of a shift. The "out" option should be configured with the following colon separated components:
For example:
out=End Shift:break:true:10:4:2:8:6
A data type of "sentiment" is used to capture employee sentiment at the end of a shift. The "out" option should be configured with the following colon separated components:
For example:
out=Clock Out:sentiment:Clock Out:negative
A data type of "multi" is used to capture multiple selections from a list, such as shift conditions which drive additional payments. The "in" or "out" option should be configured with the following colon separated components:
For example:
out=Finish:multi:Conditions:Hot;Cold;Rain; Snow;Windy:1
A data type of "range" is used to capture a numeric value, such as the number of boxes packed during a shift, to drive piecework payments. The "out" option should be configured with the following colon separated components:
For example:
out=Done:range:Boxes:1:100:1:20
A data type of "number" is used to capture a numeric amount, such as the number of miles travelled during a shift, to drive allowances. The "in" or "out" option should be configured with the following colon separated components:
For example, to capture the number of miles travelled during a shift, use:
out=End Shift:number:Miles:0:10
And to capture 4 to 6 character job numbers using a barcode gun, validated against a global list of job numbers, use:
in=Start Job:number:Job Number:4:6:$1
A data type of "dollar" is used to capture a dollar amount, such as tips, at the end of a shift. The "out" option should be configured with the following colon separated components:
For example:
out=Clock Out:dollar:Tips:0:10:true
User Type
You can restrict which user types are required to enter data by specifying either the "intype" or "outtype" option in the screen details as appropriate. For example, to require that users with a user type of "Supervisor" must select a project during clock in, you would specify:
in=Start:list:Project:Airport;Tower One;Naval Base:Tower One, intype=Supervisor
All other users can clock in just by pressing the "Clock In" button.
Similarly, to require that users with a user type of "Driver" or "Packer" must enter the number of boxes processed during clock out, you would specify:
out=Done:range:Boxes:0:100:1, outtype=Driver;Packer
All other users can clock out just by pressing the "Clock Out" button.
Each user type can be expressed either as an exact value or as a regular expression. For example, to require that users with a user type of "Bus Driver" or "Train Driver" entered data, you could could specify:
intype=.*Driver
Day of Week
You can restrict which days of the week data entry is required by specifying either the "intime" or "outtime" option in the screen details as appropriate. For example, to collect employee sentiment only on Friday, specify:
outtime=friday, out=Clock Out:sentiment:Clock Out:negative:How was your work week?
The day of the week can be specified either in full (eg: "Friday"), as its first three letters (eg: "fri"), or as a number (1=Sun, 2=Mon, etc). You can also specify a list of days on which data entry is required (eg: "Mon;Wed;Fri").
Task
You can restrict which tasks (positions, work types, etc) require data entry at clock out by specifying the "outtask" option in the screen details. For example, to require only workers that selected a position of "Server" or "Waiter" to enter tips, specify:
outtask=Server;Waiter, out=Clock Out:dollar:Tips
You can format your event data by specifying the "format" option in your screen details. A number of examples are shown below:
Fixed Text
If you want to capture the words "Compliance Training" in the event data with each event, specify:
format=Compliance Training
Device Name
If you want to capture the device (access point) name in the event data with each event, specify:
format=#DEVICE
Site Name
If you want to capture the site name in the event data for each event, specify:
format=#SITE
Combination
If you want to combine together the site name, the device name, and the current event data, separating these by slashes, specify:
format=#SITE / #DEVICE / #DATA
Swapping Data
If you want to swap the order of two data items, specify:
format=#DATA2;#DATA1
