Professional Documents
Culture Documents
User Guide
Version 4.2
Table of Contents
Contact ShmoopySoft
Website http://www.ShmoopySoft.co.za
Email Address info@ShmoopySoft.co.za
Support Email Address support@ShmoopySoft.co.za
Twitter Handle @ShmoopySoft
Before SAM can help you manage attendance, you first need to follow a few simple steps to prepare
SAM for attendance management. If you plan to add your Students and Classes manually, you need
to follow the steps represented in the flow diagram below:
Generate
Add Set Scan Scan
Add Classes Student
Students Preferences Attendance
Cards
Add Classes
Adding the names of the Classes that your Students will be attending is the first step in the SAM app
process.
Add Students
After adding your Classes, you can then add your Students. When adding a Student, the SAM app
will ask you to pick the Class to which the Student is linked.
Scan Attendance
When a student arrives for a class, scan their student card using the SAM app. An attendance record
will be added to the SAM app's database, which will then be used for attendance reporting
purposes.
If you plan to add your Students and Classes by importing a comma-delimited (CSV) file, you need to
follow the steps represented in the flow diagram below:
Scan Attendance
When a student arrives for a class, scan their student card using the SAM app. An attendance record
will be added to the SAM app's database, which will then be used for attendance reporting
purposes.
The following sections provide step-by-step "How To" instructions on all the SAM app's features,
grouped into the following general themes:
Manage Classes
Manage Students
Manage Notes
Scan Attendance
Attendance Reports
Attendance Record Management
Attendance Statistics
Attendance Charts
Manage Preferences
Manage Database
Manage Dropbox
There are two main ways to easily get around the SAM app user interface:
You need to add Classes before adding Students. There is no limit to the number of Classes that can
be added to the SAM app database, provided your mobile device has sufficient storage capacity.
Please Note: When a new Class is added, SAM will check to ensure that the Class Name provided
does not already exist in the database. If it does, SAM will not allow the new Class to be added and a
different Class Name will need to be provided.
Deleting a Class is permanent and cannot be undone, so please ensure you backup the SAM
database before deleting a Class.
Please Note: SAM will check if the Class has any Student records linked to it and, if one or more
Student records are found to be linked to the Class, SAM will not allow the Class to be deleted.
The Class List contains a list of all Classes with a count of the number of Students in each Class. The
Class List is emailed as a comma-delimited (CSV) file, which can then be imported and used in
popular office applications.
The Class List contains a list of all Classes with a count of the number of Students in each Class. The
Class List is saved as a comma-delimited (CSV) file, which can then be imported and used in popular
office applications.
The Class List contains a list of all Classes with a count of the number of Students in each Class.
You need to add Students and link them to Classes before scanning attendance. There is no limit to
the number of Students that can be added to the SAM app database, provided your mobile device
has sufficient storage capacity
Please Note: When a new Student is added, SAM will check to ensure that the Student number
provided does not already exist in the database. If it does, SAM will not allow the new Student to be
added and a different Student number will need to be provided.
Mandatory Fields
When adding a new Student, please take note of the following mandatory fields:
Use any of SAM's scan methods and modes to scan a Student card. If SAM cannot locate the Student
number extracted from the Student card barcode, and the Enable Add Student From Scan
preference is checked, you will be prompted to add the Student.
A. Only the Student number is provided in the QR Code (the SAM app default).
B. A pipe-delimited string containing all required Student data fields is provided in the QR Code
(using your own QR Code generator).
Use the edit feature to update a Student's contact information, link a Student to a different Class, or
change a Student's status.
Student Statuses
1. Active
2. Cancelled
3. Deceased
4. Dormant
5. Expelled
6. Graduated
7. Inactive
8. Injured
9. Suspended
10. Terminated
Tip: When Student cards are generated, SAM encodes the QR Code with the Student number.
Deleting a Student is permanent and cannot be undone, so please ensure you backup the SAM
database before deleting a Student.
Please Note: SAM will check if the Student has any Attendance history and, if one or more
Attendance records are found, SAM will not allow the Student to be deleted.
Student cards are generated with barcodes to assist attending scanning. The Student card is saved as
a Portable Network Graphics (PNG) file for distribution to the Student.
Student cards can be generated in bulk for all Students and saved for distribution or scanning
purposes. Student cards are saved as a Portable Network Graphics (PNG) file for distribution to
Students.
If a Student mobile phone number has been provided, you can call a Student directly from SAM.
If a Student email address has been provided, an Attendance report can be emailed directly to a
Student.
The Student Roster contains a list of all Students with their information, Class allocation and Status.
The Student Roster is saved as a comma-delimited (CSV) file, which can then be imported and used
in popular office applications.
The Student Roster contains a list of all Students with their information, Class allocation and Status.
The Student Roster is saved as a comma-delimited (CSV) file, which can then be imported and used
in popular office applications.
The Student Roster contains a list of all Students with their information, Class allocation and Status.
Use the import feature to import a list of Students and Classes from a comma-delimited (CSV) file.
The following table defines each column that needs to be provided in the CSV import file.
Please Note:
The following table provides an example of a CSV import file with 5 Student records, each with
contact information, all linked to the "Genetics and Genetic Engineering" Class.
Notes can be added to Students to keep track of important remarks. There is no limit to the number
of Notes that can be added to a Student, provided your mobile device has sufficient storage capacity
Notes can be deleted when no longer required. Deleting a Note is permanent and cannot be undone.
Make sure you backup the SAM database before deleting any Notes.
The Notes List contains a list of all Notes added to a Student. The Notes List is saved as a comma-
delimited (CSV) file, which can then be imported and used in popular office applications.
The Notes List contains a list of all Notes added to a Student. The Notes List is saved as a comma-
delimited (CSV) file, which can then be imported and used in popular office applications.
Two different scan modes are provided: Continuous Scan and Manual Scan.
Continuous Scan
Tip: Depending on your mobile device performance, increase or decrease the Scan Delay preference
to ensure scanning the same Student card repeatedly and adding duplicate attendance records is
avoided.
Manual Scan
Attendance Reports are provided for a tabular data representation of key attendance metrics.
Attendance Reports are provided for a tabular data representation of key attendance metrics. Date
period shortcuts are provided to quickly drill-down on common reporting periods.
Today
The Report Start Date and Report End Date wheels will be automatically populated with today's
date.
This Week
The Report Start Date and Report End Date wheels will be automatically populated with the current
week's Sunday (start) and Saturday (end) dates.
This Month
The Report Start Date and Report End Date wheels will be automatically populated with the first and
last date of the current month.
Copyright © 2017 - 2018 by ShmoopySoft. Page 20 of 33
All Rights Reserved.
This Year
The Report Start Date and Report End Date wheels will be automatically populated with the first and
last date of the current year, i.e. 1st of January to 31st of December.
All Records
The Report Start Date and Report End Date wheels will be automatically populated with the first
(minimum) and last (maximum) dates that appear in the database for all attendance records.
Attendance Reports are provided for a tabular data representation of key attendance metrics.
Attendance Reports are saved as a comma-delimited (CSV) files, which can then be imported and
used in popular office applications.
Attendance Reports are provided for a tabular data representation of key attendance metrics.
Attendance Reports are saved as a comma-delimited (CSV) files, which can then be imported and
used in popular office applications.
Attendance Reports are provided for a tabular data representation of key attendance metrics.
Attendance records may be updated to change the Class Name, Attendance Type or Attendance
Date attributes.
Please Note: When changing the Attendance Date, SAM will prevent a date in the future from being
selected.
Deleting an Attendance record is permanent and cannot be undone, so please ensure you backup
the SAM database before deleting an Attendance record.
You can quickly navigate to the Student record associated with an Attendance Record.
You can view the location of an attendance scan if your mobile device supports a GPS map
application.
Please Note: If the attendance record selected was not tagged with GPS coordinate, this feature will
not be available.
Students Scanned %
This metric is calculated by counting the number of Students that have at least 1 scan attendance
record and dividing it by the total number of Students.
Average Attendance %
This metric is calculated by first counting the number of days where at least 1 Student was scanned,
then multiplying the result by the total number of Students to determine the projected attendance,
then dividing the total number of attendance records by the projected attendance.
Active Students %
This metric is calculated by taking the number of Students that have an Active status and dividing it
by the total number of Students.
Total Students
This metric is calculated by counting the total number of Students.
Students Scanned
This metric is calculated by counting the number of Students that have at least 1 scan attendance
record.
Total Attendance
This metric is calculated by counting the total number of attendance records.
Scan Days
This metric is calculated by counting the number of days where at least 1 Student was scanned.
Total Classes
This metric is calculated by counting the total number of Classes.
Classes Scanned
This metric is calculated by counting the number of Classes that have Students with at least 1 scan
attendance record linked to them.
The statistics feature provides a quick summary of important attendance figures. Attendance
Statistics are saved as a Portable Network Graphics (PNG) image file, which can then be imported
and used in popular image editing and office applications.
Attendance Charts are provided for a visual representation of key attendance metrics.
Attendance Charts are provided for a visual representation of key attendance metrics. Attendance
Charts are saved as Portable Network Graphics (PNG) image files, which can then be imported and
used in popular image editing and office applications.
The preferences features allows you to configure the way you would like SAM to manage scanning
and reporting features.
Scan Camera
This dropdown list becomes available for selection if the mobile device has 1 or more cameras and is
used to select the default camera to use during attendance scanning.
Scan Mode
Manual Scan Mode: SAM will wait for you to press START to start scanning. When a barcode is
found and an attendance record is inserted, the app will stop scanning until you press START again.
Continuous Scan Mode: SAM will automatically start scanning. When a barcode is found and an
attendance record is inserted, the app will pause scanning for a specified delay period and
automatically resume scanning again.
Scan Delay
This dropdown list becomes available for selection if the Scan Mode is set to Continuous and is used
to select how long, in seconds, SAM should pause scanning before automatically resuming scanning
again.
Report Filter
This dropdown list is used to select the default filter to be applied when generating Attendance
Reports. Available options are:
The clean up feature will move files saved in the SAM app's root file folder into the correct sub-
folders.
Application Images
\Android\data\com.shmoopy.sam\files\App Images
This folder contains all images used by SAM, such as the logo used during share operations.
\Android\data\com.shmoopy.sam\files\Backups V2
\Android\data\com.shmoopy.sam\files\Backups V3
This folder contains all database backup files for SAM version 3.x and cannot be used by SAM version
4.1.
\Android\data\com.shmoopy.sam\files\Backups V4
This folder contains all database backup files for SAM version 4.x.
Attendance Charts
\Android\data\com.shmoopy.sam\files\Charts
This folder contains attendance charts in Portable Network Graphics (PNG) format.
\Android\data\com.shmoopy.sam\files\Reports
This folder contains attendance reports in comma-delimited (CSV) format.
Attendance Statistics
\Android\data\com.shmoopy.sam\files\Statistics
This folder contains attendance statistics in Portable Network Graphics (PNG) format.
Student Cards
\Android\data\com.shmoopy.sam\files\Student Cards
This folder contains Student cards in Portable Network Graphics (PNG) format.
The backup feature saves a copy of the current SAM app database on your mobile device.
This fields shows the date and time on which the SAM app database last had a backup, including a
backup performed on Dropbox.
The restore feature will restore the SAM app database from a previous backup saved on your mobile
device.
Warning: Restoring the database from a previous backup will completely overwrite the current SAM
app database and all of its content.
The factory reset feature will delete all records from the SAM app database and restore the
database to default conditions.
Warning: All records will be deleted from the current SAM app database, including Classes,
Students, Student Attendance and Student Notes.
Please Note: Performing a factory reset does not delete any files or folders from the SAM app folder
structure, including any database backup files, reports, lists, charts, statistics or Student cards that
may have been generated.
The integrity check feature will check to ensure that the SAM app database is optimised and does
not contain any corrupt or orphaned records.
Please Note: If the database integrity check is not successful, please contact our support team at
support@shmoopysoft.co.za.
To make use of Dropbox integration features, you first need to authorize and link SAM to your
Dropbox account.
Please Note: Your mobile device needs an active internet connection to make use of Dropbox
features and data charges may apply.
Backing up the SAM database to Dropbox provides an additional level of data security in case your
mobile device is lost, stolen or damaged and the SAM app needs to be restored.
Please Note: Unlike database backups saved on your mobile device, only one database backup file is
saved in your Dropbox account at any time.
Tip: By installing the SAM app on multiple devices and linking each SAM app instance to the same
Dropbox account, the same SAM app database can be distributed across many devices.
How To: Restore the SAM app database from a Dropbox Account
The restore feature will restore the SAM app database from a backup saved in your Dropbox
account.
Warning: Restoring the database from a previous backup will completely overwrite the current SAM
app database and all of its content.
If you no longer want to allow SAM access to your Dropbox account, you can easily unlink the SAM
app.
Please Note: Unlinking SAM from your Dropbox account does not delete any database backup file
that may exist in your Dropbox folder.