Falck Safety Services - Documentation

Falck Safety Services - Documentation


Dashboard

Employees with expiring certifications
This section appears on the top left corner of the dashboard page, and displays expiring employee certifications. It includes the option to filter employees certifications expiring within the next 7 days, 14 days, 30 days and 90 days.
Employees with expired certifications
This section appears on the top right corner of the dashboard page, and displays expired employee certifications, sorted alphabetically and by expiry date. A staff or superuser account is able dismiss expired certs by selecting them and clicking the "Dismiss Selected Certs" button.
Master employee table
The final section on the dashboard page is a table containing every employee in the employee database at every location. This table is sortable on all columns, searchable on all fields, and viewable by 5, 10, 25, or all employees.Finally, the table includes shortcuts to all employee detail pages.

Locations

Locations list
This page contains a searchable list of all available Falck Safety Services locations. Only staff or superuser accounts have permission to view this list.
Location page
Every location page contains an employee table with all employees working at that location. This table is sortable on all columns, searchable on all fields, and viewable by 5, 10, 25, or all employees. Finally, the table includes shortcuts to all employee detail pages.
Location reports
Every location page contains a "Generate Location Report" button that will generate a PDF including the number of employees at that location and all employee details. This PDF is sorted in alphabetical order.

Employees

Employee directory
This page contains a searchable list of all available Falck Safety Services employees. Only staff or superuser accounts have permission to view this list. A user may also add a new employee to the employee directory.
Add an employee
This page contains a form to create a new entry in the employee database. All fields are required except a description.
Employee info
Every employee details page contains an "employee info" button allowing a user to modify the specified employee's details.
Employee history
Every employee details page contains an "employee history" button allowing a user to view employee certifications that have been renewed. These certifications are sorted in chronological order of renewal dates.
Employee reports
Every employee details page contains a "Generate Employee Report" button that will generate a PDF including all the employee's info and certification detaisl. This PDF is sorted in alphabetical order.
Export employee certifications
Every employee page contains a "Export Employee Certs" button that will create a downloadable zip file in the following format. "firstName-lastName-certs.zip" i.e. "gary-yeung-certs.zip". A user can unzip the file and the following unzipped folder will include all the employee certs for the relevant courses that they have taken.
Notify someone
A user can send an email to notifiy someone of an expiring certification. A notify action is available for every employee certification on the employee details page. A modal dialog box provides a template for every email.
Add employee cert
A user may add employee certifications on this page. It includes a form where all fields are required, except for an expiry date and file upload.
Delete employee cert
A user can delete an employee certification from the cert table on the employee details page. A warning message will appear asking the user to confirm the operation, as this action cannot be undone.

Courses

Course directory
This page contains a searchable list of all available Falck Safety Services courses. Only staff or superuser accounts have permission to view this list. A user may also add a new course to the ecourse directory.
Add a course
This page contains a form to create a new entry in the employee database. Only the name field is required on the "New Course" form.
Course info
Every course details page contains an "course info" button allowing a user to modify the specified course's details.
Generate course report
Every course details page contains a "Generate Course Report" button that will generate a PDF including all the course's info and employees that have taken. This PDF is sorted in alphabetical order.
Actions
The actions available include shortcuts to edit an employee's certification details page and to view other certs that employee has taken.

Reports

Filter data
This page includes filter options and two tables. The first, contains all the course certifications at all locations and the second includes all employees that have course certifications. Employees without any certifications will not be shown on this page. These tables are sortable on all columns, searchable on all fields, and viewable by 10, 25, 50, or 100. Finally, these tables include shortcuts to all employee detail pages and course detail pages.
Generate reports
This page includes filter options to generate different PDF reports. The two types of options are report options and date options. The "Generate Report" button will create different reports depending on the filters selected. NOTE: This operation may sometimes be slow.

Account

User profile
The user profile page contains 3 links, if the user is authorized staff or superuser (My info, email, access admin). Otherwise, a regular user and regular staff will only see 2 links (My info, email).
Account email
The email addresses page will display the primary email that the user signed up to the application with. It will also display any secondary email addresses added to the account.
The user's primary email will be used for any password reset emails. A user may verify as many email addresses as they wish. Additional verified email addresses can also be used to reset user passwords.

Admin

Accounts
This administration panel keeps track of all the email addresses belonging to every account(user) using the application.
It also keeps track of all the email confirmations. This is necessary for when a user is resetting their account password. The email confirmations includes a "key" column that is used specifically for password reset purposes.
It is advised that this panel is never edited. Deleting entries is also not prohibited, but it is in the best interest of the superuser to leave this alone.
Authentication & authorization
This administration panel keeps track of all the groups created by a superuser. These groups may contain custom permissions, allowing a superuser to control what actions their staff and regular users are able to perform.
A group is created through this panel. A superuser can then add a regular or staff user to one of these groups through the Users administration panel.
Courses
This administration panel keeps track of all courses created in the database, as well as all the course certifications and renewal histories.
Course details - These are employee course certifications
Course histories - These are old employee course certifications that have already been renewed (i.e. course certifications that expired and no longer relavent).
Courses - These are all the courses in the database regardless of whether or not there are employees taking them.
Employees
This administration panel keeps track of all employees created in the database. The employee list is sorted in alphabetical order.
Locations
This administration panel keeps track of all Falck Safety Services locations created in the database. Locations management is only available through the admin panel, and therefore superusers.
Users
This administration panel keeps track of all the Falck Safety Services web application users created in the database. A superuser can manage all the users permissions, group permissions, and whether the user is a regular user, staff user, or superuser.
Also, note that every user page maintains important dates, such as last login date and date joined. These values can be changed, but it is not suggested to do so. These values are updated automatically and will no longer reflect an accurate description of the user account if modified manually.