Kiosk Data Entry

Overview

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.

Data Entry at Clock In

While all data types can be used at either Clock In or Clock Out, the following data types are typically used at Clock In:


Each of these data types is explained in more detail below.

List

A data type of "list" is used to capture a selection from a list, such as a list of active projects. The "in" or "out" option should be configured with the following colon separated components:

  • The button label. eg: "Start Work"
  • The data type. ie: "list"
  • The label for the list attribute. eg: "Project".
  • The list of options available (semi-colon separated).
  • Optionally, a default value.

For example:

        in=Start:list:Project:Airport;Tower One;Naval Base:Tower One

If you are synchronising your users with a system that supports global lists, you can specify your list values by providing the appropriate list number. For example:

        in=Start:list:Project:$1

If you are synchronising your users with a system that supports per user lists, you can specify your list values by providing the appropriate list name. For example:

        in=Start:list:Project:#projects
 

Type

A data type of "type" is used to capture a selection from a list, such as a list of work types, where the list of available options varies by user type. The "in" option should be configured with the following colon separated components:

  • The button label. eg: "Start Work"
  • The data type. ie: "type"
Then, for each user type, you can specify:

  • The label for the attribute (eg: Work Type).
  • The list of options available (semi-colon separated).
  • Optionally, the default value.

You can optionally specify a label and the list of options for all other user types at the end of your "in" option.

For example:

        in=Start Work:type:Work Type:General,
        Maintenance=Work Type:Fencing;Buildings;Machinery,
        Farm Hand=Work Type:Ploughing;Planting;Picking;Other
 
In this example, users with a user type of Maintenance will get to select from: Fencing, Buildings, or Machinery; users with a user type of Farm Hand will get to select from: Ploughing, Planting, Picking, or Other, and users with any other user type will only have one option to select from: General.

Dual

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:

  • The button label. eg: "Start Shift"
  • The data type. ie: "dual"
  • The label for the first list attribute. eg: "Project".
  • The label for the second list attribute. eg: "Work Type".
  • The semi-colon separated list values for the first list.
  • The semi-colon separated list values for the second list.
  • Optionally, a default for the first list.
  • Optionally, a default for the second list.


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

If you are synchronising your users with a system that supports per user lists, you can specify your list values by providing the appropriate list names. For example:

        in=Start:dual:Project:Work Type:#projects:#worktypes

Tree

A data type of "tree" 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:

  • The button label. eg: "Start Shift"
  • The data type. ie: "tree"
  • The label for the first list attribute. eg: "Project".
  • The semi-colon separated list values for the first list.
  • Optionally, a default for the first list.


Then, for each value in the first list, you separtely define the values in the second list with the following colon separated components:

  • The label for the attribute. eg: "Work Type"
  • The semi-colon separated list values.
  • Optionally, a default.


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:tree: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:tree:Work Type:$4

API

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:

  • The button label. eg: "Start Work"
  • The data type. ie: "api"
  • The title. eg: "Breathalyser".
  • The message.
  • The mode, which can be either:
    • auto. Automatically record events.
    • man. Manually record events.
    • deny. Manually record successful events only.
  • The timeout in seconds.
  • The URL to call.


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:

  • 200. Success.
  • 403. Permission Denied.
  • 500. Internal Error.


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

Scan

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:

  • The button label. eg: "Start Job"
  • The data type. ie: "scan"
  • The title. eg: "Job Number".
  • The message. eg: "Please scan your job sheet.".


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:

  • Code 39
  • Interleaved 2 of 5
  • QR Codes


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

Data Entry at Clock Out

While all data types can be used at either Clock In or Clock Out, the following data types are typically used at Clock Out:


Each of these data types is explained in more detail below.

Text

A data type of "text" is used to capture an alphanumeric string, such as a comment on clock out. The "out" option should be configured with the following colon separated components:

  • The button label. eg: "End Work"
  • The data type. ie: "text"
  • The label for the text attribute. eg: "Comment".
  • Optionally, the minimum length, which defaults to 1.
  • Optionally, the maximum length.
  • Optionally, a default value.

For example:

        out=End Work:text:Comment:0

Range

A data type of "range" is used to capture a numeric value, such as the number of boxes packed during a shift. The "out" option should be configured with the following colon separated components:

  • The button label. eg: "Done"
  • The data type. ie: "range"
  • The label for the attribute. eg: "Boxes".
  • The minimum value.
  • The maximum value.
  • Optionally, the increment between values.
  • Optionally, the default value.


For example:

        out=Done:range:Boxes:1:100:1:20

Multi

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:

  • The button label. eg: "End Shift"
  • The data type. ie: "multi"
  • The label for the list attribute. eg: "Conditions".
  • The semi-colon separated list values.
  • Optionally, the minimum number of selections, which defaults to 0.


For example:

        out=Finish:multi:Conditions:Hot;Cold;Rain; Snow;Windy:1

Break

A data type of "break" is used to capture paid rest breaks at the end of a shift. The "out" option should be configured with the following colon separated components:

  • The button label. eg: "End Shift"
  • The data type. ie: "break"
  • Whether to default breaks as taken ie: true/false.
  • The break duration in minutes (eg: 10 = 10 mins).
  • The time after a 1st break is due in hours (eg: 4 = 4 hours).
  • The default time after the 1st break is taken (eg: 2 = 2 hours).
  • The time after a 2nd break is due in hours (eg: 8 = 8 hours).
  • The default time after the 2nd break is taken (eg: 6 = 6 hours).


For example:

        out=End Shift:break:true:10:4:2:8:6

Dollar

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:

  • The button label. eg: "End Shift"
  • The data type. ie: "dollar"
  • The label for the dollar attribute. eg: "Tips".
  • Optionally, the minimum number of characters (default 0).
  • Optionally, the maximum number of characters (default 5).
  • Optionally, whether cents should be allowed ie: true or false.


For example:

        out=End Shift:dollar:Tips:0:10:true

Conditional Data Entry


You can restrict which users 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.

Privacy
Legal
Terms of Use
Contact Us
© NoahFace 2018
.