Revision as of 12:48, 29 July 2016 by Grace (talk | contribs) ({{{saveSiteButton}}})
Jump to: navigation, search

[[{{{loginScreen}}}|thumb|upright|border|The {{{appName}}} app Login Screen]]

Logging In

The first screen which appears after the {{{appName}}} app is opened is the login screen.

To use this ginstr app a ginstr subscription is required.

There are two ways to get such a subscription:
a) buy a subscription in the ginstr app store
b) sign a contract with ginstr (mainly used by organisations that have a greater number of users)

If the user already has login credentials for this app, they should enter them in the e-mail and password fields to login.

If they do not, there is a “sign up!” link located directly above the e-mail field. This will direct the user to a website giving instructions on how to sign up and get login credentials.

There is a checkbox labelled show password next to the login button.

When checked, it allows the user to see the password they enter in the password field as plain text.

The settings button settings grey.png in the top right corner of the login screen opens the ginstr launcher settings menu (see here for more information).

The user can exit the settings menu at any time by pressing the device's back button until they reach the ginstr app screen.

If valid login credentials are entered on the login screen, the app navigates to the first screen of the {{{appName}}} app.

Main Menu

There are several buttons on this screen which allow a user to record information about {{{worksite}}} and employee attendance.


This button navigates to the arriving/leaving page, which contains a form. This form is automatically filled out when an employee scans their employee card/NFC tag by placing it near the back of the device the app is being used on.


Any {{{worksite}}} that has been added to the app’s database can be selected from this dropdown list.

The following fields cannot be filled manually, and are compulsory. Therefore, they must be filled by scanning an employee card.

employee card*

first name*

last name*

employee number*



scan employee card

This is simply an instruction to scan the employee card. When the card is scanned, the app automatically records the employee’s arrival or departure.

assign employee card

This button navigates to the assign employee card screen, which is used to assign a new NFC card or tag to an employee, or to update the information stored about an employee with a certain NFC card.

employee card*

The employee card must be scanned with the device running the app. This will fill in the ID of that employee NFC card. The employee card form field cannot be filled out manually.

If the card’s ID can already be found in the database, a message will appear, “this employee NFC card already exists.” The employee’s current data will appear in the form fields, and can be edited. When the form is submitted, a message will appear to tell the user that the employee data has been updated.

If the NFC card has not been used as an employee ID already, a message will appear to inform the user of this.

These fields are compulsory and must be filled in manually.

first name*

last name*

employee number*


Any miscellaneous information or comments are to be left in this text field, and will be saved as part of the employee card details. These comments will appear on the arriving/leaving screen when the employee uses their employee card to clock in and out.


This field is compulsory, and is likely to contain a placeholder or default address. This long text field can be edited manually, and contains enough space to edit and view long addresses.

save employee card assignment

This is the button that must be pressed to save the employee’s details along with their card ID. If the card has not been scanned, or if any of the compulsory form fields have not been filled, a message will appear to alert the user, and tell them what is missing.


The attendance button navigates to the attendance screen, where employee attendance can be viewed easily for each {{{worksite}}}.

select {{{worksiteTitle2}}}

This is a dropdown list, containing the {{{worksite}}}s which are available in the app’s database. When one of these is selected, the attendance records for employees at that site are displayed on the attendance screen.

Attendance records

The attendance records shown on this page are listed as the first and last names of employees at a {{{worksite}}}. The list of names only shows who is at one {{{worksite}}} at the present time. As soon as an employee clocks in using the “arriving/leaving” function of this app, their name appears on the list for whichever {{{worksite}}} they have selected. When an employee clocks out of the same {{{worksite}}}, their name will no longer appear on the list.

add new site

The add new site button navigates to a page where a new {{{worksite}}} can be added.


This is a mandatory text field which must be filled manually. It allows the user to name a new {{{worksite}}}.

cost centre*

This is a mandatory text field, which must be filled out by the user to record the cost centre for this {{{worksite}}}.


Comments are optional for the new {{{worksite}}}, but can be entered in this multiline text box.


This button saves the information entered in the form. Once this is pressed, there will be a new option in the {{{worksite}}} dropdown lists throughout the app, with the name of the new {{{worksite}}}.
A message will appear confirming that the site details have been saved, and the app will return to its main menu screen.

NFC Reader

Using NFC Readers with ginstr web

NFC card readers can be used to create records for this app on ginstr web.

The NFC reader can be plugged into the user's PC and will initially take a few minutes to set up.

The GoToTags Windows App needs to be installed for the reader to work with the ginstr web backend.

The NFC reader will read the ID of any NFC device that is placed on top of it.

NFC devices

NFC tags, cards, keyrings and other devices can be used to create records with ginstr web.

Each NFC device has a unique ID, which will be shown in the records as a sequence of numbers and letters.

This ID will correspond with the information entered by the user, making the NFC tag an ideal form of ID for {{{NFC_item}}}s.

Creating {{{NFC_item}}} Records

When the NFC reader has been set up and GoToTags has been installed, the NFC tag of the {{{NFC_item}}} can be scanned.

The NFC tag UID, text, or data can be automatically pasted from the tag to the {{{NFC_item_ID}}} data field of the record being created by selecting the "auto paste" option from the "Integrations" tab at the top of the window.

After this, the window containing ginstr web must be selected.

{{{NFC_item}}} records can be created using the

add record

button near the top of the portlet on ginstr web, double clicking the {{{NFC_item_ID}}} field, and scanning the {{{NFC_item}}}'s NFC tag.

The information from the scanned tag will appear in the {{{NFC_item_ID}}} field, but other data about the {{{NFC_item}}} must be entered in the table manually.