TrainEasy

Welcome To TrainEasy

Thank you for purchasing this application. If you have questions that are beyond the scope of this help file, contact us.

Installation

Installing TrainEasy

SERVER REQUIREMENTS

Before you begin installation, make sure you have a webserver that meets the following requirements:


  • PHP 8.1.2 or higher
  • MySQL >= MySQL 5.7
Ensure the following PHP extensions are installed
  • ext-bcmath
  • ext-ctype
  • ext-curl
  • ext-dom
  • ext-gd
  • ext-hash
  • ext-iconv
  • ext-intl
  • ext-mbstring
  • ext-openssl
  • ext-pdo_mysql
  • ext-simplexml
  • ext-soap
  • ext-xsl
  • ext-zip
  • lib-libxml


It is also strongly recommended that you install FFmpeg on your server. This will enable automatic generation of Video thumbnails

If you are unable to install FFmpeg on your sever, you can specify the path to the FFmpeg and FFprobe binaries in your .env file (in the application root). Simply fill in the following values


    
                FF_MPEG=""
                FF_PROBE=""    
                  


You can still use TrainEasy without FFmpeg installed. However, you would need to manually upload thumbnails for uploaded videos.


  • The TrainEasy installation file consists of a zip file that has the following contents when unzipped



  • Upload the app.zip file into the root of your web server or wherever you would like the application to reside.
  • Extract the contents of the app.zip folder. You will see the following directory structure:



  • We recommend that you point your domain name to the public directory. Your should be able to do this from your Hosting's control panel. Otherwise, you can use the .htaccess file located the the 'Resources' directory. Simply upload this file to the same directory as the public folder and then change the [YOUR_DOMAIN_NAME] placeholder to your actual domain name

  • Open your web browser and enter the domain name for the application. You should see the setup wizard open like below:


  • Click on the 'Check Requirements' button. The installer will check to ensure that you have all the required PHP extensions.



  • If all extensions are available, click on the 'Check Permissions' button. If any extensions are missing, ensure you enable them on your server before proceeding.


  • Next, click on the 'Configure Environment' button (if any of the listed folders are not writable, make sure you correct this before proceeding).


  • Click on the 'Form Wizard Setup' button.


    Enter your 'App Name' (Usually your website/company name). Set 'App Debug' to 'False'. Change the 'App Url' to your website u. Leave other defaults and click 'Setup Database'.


  • Enter in your Database credentials. Click 'Setup Application'


    Leave all the defaults in the next screen and click 'Install'



  • Once the installation is complete, you will see a page like below:


Click on the 'Click here to exit' button and you should then be directed to your homepage


Setting up cron jobs

TrainEasy sends different notification messages automatically. To enable this, you need to setup the laravel task scheduler.
Create a cron job similar to this:
* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1


YOUR FIRST ADMIN ACCOUNT

When you install the application for the first time, a default Admin account is created for you. The credentials for this account are as follows:
Email:admin@email.com
Password:password

Click on the 'Login/Register' link at the top in order to login to your admin area. Make sure you change your email and password immediately you login.


Settings

TrainEasy comes with a lot of configuration options that enable you setup the application to suit your needs. To access the configuration page, login to the backend and go to 'Settings'-'Site Settings'


The configuration page is as shown below:



The following section explains the various configuration options

  • General Tab
    • Country/Currency: This controls the currency that is used for your website. Session fees will be formated based on this setting and payment gateways will also be configured based on this
    • Site Name: The site name should be the name of your organization. When the systems sends out email,it will use this as the sender name
    • Homepage Title: This is the text that will appear at the top of the browser for the homepage. It is very important for search engine optimization
    • Homepage Meta Description: This text is used by search engines and othe robots to get a description about your website. It is important you set this for search engine optimization purposes
    • Admin Email: This is the email address that the system will use as the 'from' email when sending out notifications and alerts to students and administrators
    • Use SSL: Set this to Yes if you have SSL installed on your server. This enables the app to use https:// for all pages
    • Header Scripts (advanced): This can be used to add code (css or javascript) to the HEAD section of all pages of your site (Frontend only).
    • Footer Scripts (advanced): This can be used to add code before the closing BODY tag of all pages of the Frontend
    • Disqus Shortname: This is used to enable commenting on the Frontend. Visit disqus.com and get your shortname. Once you save it here, commenting will be enabled on the blog and revision notes sections of the Frontend
    • Discussion Instructions: This controls the instructions students see when they try to post a question using the discussion feature.
    • Show Session Fees: This can be used to hide or show the Fee column on the session enrollment page of the Frontend
    • Site IP Address: Here you can specify the IP address of your server. If this is done, it will add extra secuirity to your cron jobs i.e. the automatic reminder emails sent to students and instructors. It ensures that the cron job can only be triggered by your server
    • Send Class Reminders: This controls if the system should send reminders to students and instructors about upcoming classes. Please note however that you still need to setup the cron job for this to work. See the 'Setting Up Reminders' section for more information
    • Reminder Day: This specifies how many days to a class should reminders be sent. The system will send out reminders once a day every day before the day the class is scheduled to hold.
    • Site Timezone: This sets the timezone used by the entire site and the reminder system.
    • Reminder Hour: This specifies the hour of the day when class reminders will be sent out.
    • Live Chat Code: In this box, you can paste a live chat embed code from your favorite live chat service. This chat box will only be visible when students are taking online courses for which live chat has been enabled.
    • Contact Address: The contact address that will be displayed on your 'Contact Us' page
    • Contact Telephone No: The telephone number displayed on the 'Contact Us' page
    • Contact Email: The email address displayed on the 'Contact Us' page
    • Video Max Size: The maximum size of videos (in megabytes) that can be uploaded. Please note that you PHP max_post_size value must be equal to or greater than this value for this to have any effect.
  • Logo and Icon Tab: Upload your website's logo and Favicon here.
  • Menu Tab: Use this to hide or show various elements of the menu and header on the student's dashboard
  • Labels Tab: This section allows you to change the default text that is used in the general layout of the student's dashboard.
  • Registration Tab:
    • Enable registration?: Enables or disables the student registration form on the frontend
    • Registration Instructions: Sets the text displayedat the top of the student registration form on the Frontend
    • Successful Registration Email: Controls the text that is sent to a student after they register successfully.
    • Send alert for enrollments: This setting enables the adminstrators to get a notification email when a studetn successfully enrolls for a session. For paid sessions, the alert will only be sent after successfull payment.
    • Send alert for registrations: This setting enables the administrators to get notified whenever a student fills the registration form successfully.
    • Confirm Student Emails: This controls if students will need to confirm their emails after registration.
    • Captcha Type: Select the type of Captcha that will be used for the registration and contact forms. We recommend Google reCaptcha v3.
    • Recaptcha Site Key: Set this if you selected 'Google reCaptcha' above.
    • Recaptcha Secret Key: Set this if you selected 'Google reCaptcha' above
    • Successful enrollment email: Email message sent to the student after enrolling into a course/session.
  • Mail Tab: This setting allows you to use an smtp server if you have one. Otherwise, you can use the default which is PHP's native mail function.
  • Social Login Tab: Set details for social login.
  • Zoom Settings Tab: Set your Zoom API credentials here

Setting up a theme

TrainEasy comes with different Themes you can choose from. A Theme is a design that gives the public area of your TrainEasy application a special look. Each Theme comes with different options that enable you customize the general appearance and content of various aspects of the Theme.

To customize your current theme or choose a new one, go to 'Settings'-'Site Theme'



The Themes page is split into two sections: Active Theme and All Themes.




The Active Theme section shows the currently installed Theme and also displays buttons for modifying the Theme. The 'All Themes' section displays all the available Themes you can choose from. Click on the 'Install' button if you would like to switch to a new Theme. To modify your existing Theme, click on the 'Customize' button.

Clicking the 'Customize' button presents two options: Settings and Colors



The 'Settings' button is the main option for modifying the Theme. It leads to a page that contains various forms for customizing the Theme. The 'Color' option leads to a page that enables you change the different major colors used by the Theme.

Clicking on the 'Settings' option leads to a page like below:


Please note that each Theme's settings page will give different options other than that shown in this image.

Clicking on any of the options opens the panel to reveal the controls available for modifying that option.


Each option always has an 'Enabled' dropdown control at the top left. This can be used to completely enable or disable that option. Once you modify any of the content of an option, click on the 'Save Changes' button. Your changes will reflect on your portal immediately.

Customizing the Registration Form

TrainEasy enables you to create additional fields for the student registration form. This is very useful if you need to collect extra data during registration.

To add new fields or edit existing fields, click on the Custom Student Fields menu option.



Note: The following fields are already included in the form: First Name, Last Name, Email, Telephone Number, Password and Confirm Password. Hence you do not need to create them.

To add a new field, click on the Add Field button



The following fields are available:

  1. Label: This is the descriptive name of the field
  2. Input Type: This is the type of the field.Options include text, textarea, select etc.
  3. Mandatory: This specifies if the Student has to fill this field.
  4. Sort order: The position of the field relative to other fields in ascending order.
  5. Enabled: If the field is visible on the form or not.
  6. Student Editable: This determines if a student can modify the contents of this field.


Managing Roles

TrainEasy comes with a powerful role management system that enables you to set permissions for every aspect of the backend.

A role is simply a collection of permissions that specifies what administrators can or cannot do on the backend. By default, two roles are provided after installation

  1. Super Administrator
  2. Administrator
These default roles can not be deleted. Also, the Super Administrator role can not be edited. The super administrator role has access to every aspect of the application. The administrator role by default has access to most features except the settings features.

Understanding Resources

A resource in TrainEasy refers to items created by administrators which are privately owned. Such items include the following:

  1. Sessions & Courses
  2. Classes
  3. Homework
  4. Revision Notes
  5. Downloads
  6. Tests
  7. Discussions
  8. Certificates
  9. Files

The systems tracks who creates what, and by default, Instructors are only able to see and modify items that they create. There is a special permission that controls this feature. It is called 'Global Resource Access'. You can see this permission under the 'Miscellaneous' section when creating or editing roles.



Creating Roles

To create a new role, click on the Roles menu option


This will open up the page containing all roles. Next click on the 'Add New' button



Enter in the role name and select all the permissions you would like that role to have

Managing Administrators & Instructors

You can create as many administrators and instructors as you wish. Each administrator/instructor is assigned a role that limits what they can do on the backend. To add a new administrator/instructor, click on the Administrators/Instructors menu option under 'Settings'



Next, click on the Add New button.


On the Add Administrator page, fill in all the details for the administrator

Managing Classes

In TrainEasy, classes are created independent of any courses or sessions. This way, you have the opportunity to reuse classes across multiple sessions or courses.


There are two types of classes in TrainEasy


  1. Online Class: These are classes that are to hold online. They can be added to Online courses or Training Sessions with online Classes. Online classes also have 'Lectures' associated with them. Lectures break down a class into multiple topics. A lecture must belong to a single class.
  2. Physical Location Class: These are classes that are intended to be held at physical locations. They can be added to Training Sessions or Training Sessions with online Classes.


Creating a class


To create a class, go to 'Classes'-'Add Class'





The add class form has the following fields:


  1. Class Name: The descriptive name of the class.
  2. Class Type: Use this to indicate if the class is an online or physical location class.
  3. Test Required: This option will appear if 'Online Class' is selected as the class type. If selected, it will force students to take a test before they can complete the class.
  4. Test: Sets the test required. It will only have an effect if 'Test Required' above is selected.
  5. Brief Description: A descriptive text describing the class.
  6. Enforce Lecture Order: This setting ensures that students can only view lectures in the order that you set.
  7. Introduction: This field applies only to online classes. Enter the introductory content for the student here.
  8. Class Groups: Class groups offer a convenient way to organize classes internally. This makes for easier sorting of classes during editing. Class groups are not visible to students.
  9. Sort Order: This sets the default sort order for the class. The sort order determines the position of a class relative to other classes in the assigned Session or Course. You can still set the sort order of a class on the session/course level. However, it is advisable to set them properly here as well.
  10. Cover Image: You can set a descriptive image of the class here.


Managing Lectures

Lectures are the heartbeat of online classes. Each lecture consists of pages of content which can contain Text. Video or Html code. Each lecture can also only be associated with one class.


Creating a lecture


To create a lecture, first navigate to the class you will be adding the lecture to. Go to 'Classes'-'All Classes'.





On the the class list page, click 'Actions'-'Manage Lectures' for the class you are adding the lecture to.



On the next page, click on the 'Add Lecture Button'



A popup will appear. Enter in the lecture name and optional sort order. Then click 'save changes'. the sort order determines the position of the Lecture relative to other lectures in that class.



Once you have successfully created the lecture, you will be automatically redirected to the 'Lecture Content' page. This is where you get the add the content of that lecture. You can add Text, Video or HTML code. Clicking the 'Add Lecture Content' button gives you the following options:



  1. Text: Adding text is just as simple as entering the title and content of the text page.


  2. Video: There are two methods of adding Video to a lecture. The first is using a URL and the second is using video embed code. To add video, you need to first upload the video file to your chosen video hosting service. We strongly recommend Vimeo for this due to the advanced privacy and security features they offer.
    The URL method for adding video is the easiest method of adding a video. You simply copy and paste the url of the video from your video hosting service.


    The video embed feature requires you to get the embed code from your hosting service. This feature is useful if you want greater control over how the video displays.
  3. Html Code: This is useful for trainers in the IT sector. It enables you to display raw html code.


Managing Class & Lecture Downloads

TrainEasy gives you the ability to attach files to lectures and classes for enrolled students to download. You can attach multiple files to a class or to individual lectures.

Class Downloads

To attach files to a class, navigate to the class list page by going to 'Classes'-'All Classes'


On the 'All Classes' page, for the class you are adding the file to, click 'Actions'-'Manage Downloads'


On the class downloads page, click the 'Add File' button


This will bring up the file manager box.

On the file manager, click the 'Upload' button to add a file from your hard disk. Once uploaded, double click the file to add it to the class.


Lecture Downloads

Adding files to a lecture is a similar process to adding to classes. Simply navigate to the list of lectures for a class (from the class list page). For a particular lecture, click on 'Actions'-'Manage Downloads'



Creating Sessions & Courses

Once you have successfully created your classes, you can then create sessions and courses. In TrainEasy there are three types:


  1. Training Session: A training session is an event that is holding at a physical location on set dates. You can only add 'Physical Location' classes to Training Sessions.
  2. Online Course: An online course is a virtual training event. You can only add 'Online classes' to online courses.
  3. Training Session with Online Classes: This is a training session holding at a physical location with optional online classes. You can add both 'Physical Location' and 'Online Classes' to these type of session.

Creating an online course

To create an online course, go to 'Courses & Sessions'-'Add New'-'Online Course'



The course creation page appears as below:


The following fields are available for each session


  • Course Name: A short descriptive name of the course
  • Course Start Date: The date the course is scheduled to begin. If left blank, the course will not be available immediately.
  • Enrollment Closes: The closing date for students to be able to enroll for the course. The course can still be visible on the frontend after this date but the Enroll button will be unavailable. If left blank, enrollment will not close.
  • Course End Date: The date the course closes. After this date, the course will no longer be available on the frontend. If left blank, the course will not end.
  • Payment Required: This specifies if a course is free or requires payment.
  • Course Fee: The fee charged for the course. This field only takes effect if the Payment Required field is set to Yes.
  • Effort: A short text indicating how much effort a student is expected to put in to complete the course.
  • Length: A short text indicating how long the course is expected to run for.
  • Short Description: A short summary of the course. This is displayed on the course catalog page on the frontend.
  • Course Description: A detailed description about the course.
  • Introduction: A brief introduction to the course. This is only displayed to enrolled students.
  • Course Categories: Sets what category or categories the course should belong to. This controls where the course will be listed in the frontend. Note that you will need to have already created the categories on the page for managing categories.
  • Course Instructors: Sets the instructors for this course. It is important that you set this as it controls who students are able to open discussions with.
  • Status: This controls if the course is visible on the frontend or not regardless of other settings (start date, closing date etc). You will usually want to set this to 'Disabled' while editing the course and creating its content.
  • Enable Discussions: Controls if students will be able to open discussions with the instructors assigned to this course.
  • Enable Live Chat: Controls if live chat should be made available to students while taking this course. Note that you will need to have already saved your live chat embed code on the Site Settings page for this to work properly.
  • Enforce Class Order: If this is set to 'Yes' then students will be forced to take classes in the order that you set them.
  • Cover Image: Set a descriptive image for this course.
  • Select Classes: Select all the classes for the course You can also specify the opening date and position of the class.



Creating a Training Session

To create a training session, go to 'Courses & Sessions'-'Add New'-'Training Session' or 'Courses & Sessions'-'Add New'-'Training Session with Online Classes' depending on the type of session you wish to create

.


The session creation page will open as shown below:



The following fields are available for each session


  • Session Name: A short descriptive name of the session
  • Session Start Date: The date the first class in the session is scheduled to begin.
  • Registration Closes: The closing date for students to be able to enroll for the session. The session can still be visible on the frontend after this date but the Enroll button will be unavailable.
  • Session End Date: The date the last class in the session is scheduled to hold. The session will no longer be visible on the frontend after this date.
  • Payment Required: This specifies if a session is free or requires payment.
  • Session Fee: The fee charged for the session. This field only takes effect if the Payment Required field is set to Yes.
  • Short Description: A short summary of the session. This is displayed on the session catalog page.
  • Session Description: A detailed description about the session and its classes.
  • Status: This controls if the session is visible on the frontend or not regardless of other settings (start date, closing date etc).
  • Venue: The location for the classes in the session. If classes will hold in multiple locations, you can specify the venue for each individual class.
  • Select Classes: Select all the classes for the session. You can also specify the date and venue for the class if (different from the session venue).


Managing Sessions & Courses

To manage existing sessions, click on the All Sessions & Courses menu option



This will lead to the page displaying all the created sessions and courses.




On this page there are various tools available for managing the session/course and the Students enrolled for it.
The Total Enrolled links displays the total number of students that have enrolled into the session/course. You can quickly view these students by clicking on the link as shown below:


This will bring up a modal box as shown below:



You will also notice an Export button in the Total Enrolled column. Clicking this button reveals the following options:

The options are described below


  • Export Students: This will generate a csv file containing all the students that have enrolled for the session/course.
  • Export Students (Attendance Import): This will generate a csv file that will enable you to set the attendance records for students offline and then import back later. This will be discussed later.
  • Attendance Sheet: This will open a web page that you can print. It contains the students mandatory details and a start and end column for each class. The attendance sheet is intended for Students to sign when they arrive at a class. This option is not available for courses
  • Telephone Numbers: This will generate a csv file containing just the telephone numbers of students enrolled in the session/course. You can use this to easily send bulk sms to students.


The Actions buttons display various options. The pencil and trash icons are used to edit or delete a session/course respectively.



  1. Edit: enables you edit a session/course
  2. View Enrolled Students: Opens a page for viewing all students in the session/course. This page also displays the progress each student has made.

    On this page, you can click various buttons such as the 'Student Progress' button (which displays detailed class attendance and test results), 'Un-enroll' which enables you remove the student from the session/course, view and edit buttons for viewing/editing the student's profile.

  3. Manage Instructors: This options opens a page that lets you set the instructors for each class in a training session. It is not applicable to online courses.
  4. Send Email to enrolled students; This lets you easily send an email to all students in the session
  5. Duplicate: creates an exact copy of a session/course.
  6. Change session type: This enables you change the type of a training session i.e with out without online classes. It is not applicable to online courses.
  7. Delete: Deletes a session/course.


Managing Invoices

TrainEasy comes with a powerful invoicing feature that enables you manage and create invoices for your students. To access the invoicing page, please visit 'Courses & Sessions'-'Invoices'


You will see a list of available invoices



The 'Items' column contains buttons that, when clicked, reveal the courses associated with that invoice. The 'Actions' buttons give you and option to approve an invoice or delete it. When you approve an invoice, the student is automatically enrolled into the associated courses for that invoice.

Clicking on the 'Add New' button presents a modal dialog that enables you create an invoice for a user.


The 'User' field enables you search for a student. You need to type the student name or email address to bring up the student. The 'Courses' dropdown enables you select multiple courses to be included in the invoice. The amount field enables you specify the amount you wish to charge the student for the invoice. If omitted, the price of the courses will be automatically calculated and used for the invoice. You can also select the currency. This only works if you specify a manual amount. You can set the status as paid or unpaid. If set to paid, the student will be automatically enrolled once you create the invoice.

Also note that, if you set an amount that is different from the calculated prices of the courses you select, it will only be useful if you approve the invoice from the backend. If a student attempts to pay for the invoice from the frontend, the price will revert to the calculated price of the courses. This is a security measure.


Adding/Editing Students

To add a new Student to TrainEasy, go to 'Students'-'Add Student'


This opens the student creation page as shown below:


To edit a student, go to 'Students'-'View Students' and click on the 'Edit' button for your selected student.


Bulk Enrolling Students

TrainEasy enables you to enroll multiple students to a session/course by uploading a csv file. To do is, go to 'Students'-'Bulk Enroll'


A sample csv file is available for download. Simply download this file and fill in the details for each student. Each student is uniquely identified by their email address. If a student does not exist, a new record will be created for them using the details specified, thereafter they are enrolled for the session. If a student already exists, they are simply enrolled for the session/course.



Importing/Exporting Students

You can easily import a large number of students into TrainEasy. You can also export all students into a single csv file.

Navigate to 'Students'-'Import Export'


If you wish to import students, it is important that your uploaded csv file is in the right format. A sample csv file is provided for this purpose.



Creating tests

TrainEasy comes with a powerful computer based testing (cbt) feature. With this feature, you can create tests/exams/quizzes for your students to take on the frontend. You can then generate a list of students that passed the test based on a passmark you set.

To create a new test, click on the Tests menu option. Next, click on Add Test


On the Add Test page, you will see the following fields/options

  1. Test Name: A short descriptive name of the test
  2. Instructions: Type in any instructions you would like students to read before taking the test.
  3. Status: This controls if the test becomes visible on the frontend or not.
  4. Pass Mark: Set this as a percentage i.e. 0-100. It sets the minimum score a student must make in order to pass the test.
  5. Time Allowed: This enables you to set a time limit for a test.
  6. Allow Multiple Attempts: This controls if a student can take the test multiple times.
  7. Private Test: Tests can be marked as private or public. Private tests are tests that are only available to students that are enrolled in sessions that specify the test as a requirement.
  8. Show result to student: This specifies if a student should be informed if they passed the test after taking it.


After you add a test, you will be automatically redirected to a page where you can add new questions and options to your test


Clicking on the Add Question button will bring up a pop up that will enable you to easily add a question


There is also a feature for importing questions from a CSV file. Clicking on 'Import Questions' brings up the following modal



There is a link to a sample csv file that you can use to generate a compatible csv file.



Managing Tests

To modify or manage your existing tests, simply click on the All Tests menu option


On the All Tests page, take note of the following options




1. The Attempts button: Click on this button to view all the results of tests that students have taken.


Clicking this button will open a new page displaying all the results.



2. Managing Questions: On the Tests page, you can manage the questions for a test by clicking on the Manage Questions icon.




On the page that opens, you will be able to add new questions or modify existing questions.


3. Duplicate a Test: Sometimes you would like to create a new test based on a previous test. The duplicate option gives you the ability to create an exact copy of an existing test without having to type questions and options all over again


4. Edit and Delete: Pencil and Trash icons are used to edit or delete a test.

Assigning Tests to Sessions & Courses

TrainEasy enables you assign Tests to courses and sessions. If you assign a Test to an online course, students will be required to complete the Tests before they can complete the course. You also have the ability to specify opening and closing dates for Tests.

There are two ways to assign Tests to a session/course, from the session/course management section or from the Test management section. Assigning Tests from the session/course management section is useful if you would like to assign multiple Tests to a single course. Assigning from the Test management section is useful if you wish to assign a single Test to multiple sessions/courses. This section if especially important for Instuctors how may not have permission to modify a session/course (if they did not create & lack global resource access for example) but are assigned as instructors to it. Such instructors can assign tests they create to a session(s) from the Test management section.

Assigning Tests from the Sessions/Courses section

To assign tests to a course from the sessions/courses section, navigate to the session/courses management page

Click on the 'Actions' button for the session/course you wish to modify. Select 'Manage tests'


On the test management page, click on 'Add Test'



On the Test assignment page, select the Test you wish to add from the dropdown. You can optionally select Opening and Closing dates.


Please note that for the Opening and Closing dates to work, the test must be a private test. Setting dates for public tests will have no effect.


Assigning Tests from the Test Management section
To assign tests to Sessions/Courses from the test management section, go to the test management page (Tests->All Tests)


For the test you wish to assign, click the 'Options' button and select 'Manage Sessions & Courses'



On the next page, click on 'Add to Session/Course'



This will bring up a page like below:



On this page, simply select the Session/Course you wish to add. The rules for the opening and closing dates are similar to that mentioned earlier.

Configuring Payment Methods

TrainEasy ships with multiple payment methods for receiving payment for session/course enrollment.

Each payment method will automatically use the currency you configured for your site. So make sure the method supports your currency before enabling it.

To configure a method, click on the Payment Methods menu option

The list of available methods will be displayed:


Click on the Edit button for a method to configure it.



Fill in the relevant credentials/details and save.

Note that you will need to get the credentials from the respective gateway website.


Payment Method Currencies

Each payment method can be assigned to either all currencies or a specific list of currencies. If you wish for your payment method to be available for all currencies, make sure you check to 'All Currencies' checkbox. If however, you wish for a payment method to be available only for a specific currency, uncheck the 'All Currencies' check box. When you do this, you will notice that a 'Currencies' tab will become visible.


Once you click this tab, you can add your currencies



Creating a Download

The Downloads feature on TrainEasy enables admins and instructors easily share files with students.

This feature also enables you to restrict certain files to students that are enrolled in sessions you sepecify. If no sessions are specified for a download, it will be available for any registered student to download.
The following file types are allowed: pdf, zip, mp4, mp3, doc, docx, ppt, pptx, xls, xlsx, png, jpeg, gif, txt, csv. Please note that security is not provided for image files i.e. png, jpeg or gif files. Users might be able to access these files via a direct link. If you want to securely share these type of files, we recommend you put them in a zip archive.

To create a new download, login to the backend and click on the 'Downloads' menu option. Then click 'Create Download'



On the download creation page, fill in the name of the download as well as its description. Also set 'Enabled' to 'Yes' or 'No'. Disabled downloads will not be available to students.


Next, click on the 'Save' button. After the download as been saved, you will be redirected to the download edit page. On this page, you can add files to the download you just created as well as assign the downloads to sessions/courses.

Creating Homework

TrainEasy allows you to easily create homework for your students. Each Homework is assigned to a session or course. Students can easily respond to homework from their account area by submitting text or file upload.

To add a new homework, go to 'Homework'-'Add Homework'


This opens the add homework page:


The following fields are provided on this page:

  1. Title: The short name of the homework.
  2. Session/Course: The associated Session/Course. Only students enrolled into this session/course will be able to view the homework.
  3. Due Date: The due date for the homework. Students may not be able to submit the homework after this date, depending on the 'Allow late submission' setting you set below.
  4. Homework Instructions: The instructions students must follow while answering the homework.
  5. Passmark: The minimum pass-mark required for the student to pass the homework.
  6. Receive submission notifications: This determines if the instructor/admin who created the homework should receive a notification every time a homework is submitted.
  7. Allow Late Submissions: This determines if students can still submit this homework after the due date.
  8. Notify Session/Course Students: Determines if student enrolled into the selected session/course should be notified immediately the homework is create.


Managing Certificates

TrainEasy comes with a powerful certificate generation feature that enables you totally eliminate the need for creating paper certificates for each Student at the conclusion of your training programs. This feature can also be used to generate other documents such as admission letters.
The Certificate feature enables you to design documents with a drag and drop interface. You simply upload a blank copy of your existing or new certificates and then specify where the various text should go (e.g Student Name, Session Name, Completion Date etc.)
Each certificate must be associated with a session. Also, certain conditions can be assigned to a certificate which the student must fulfill in order to be granted access to the document.
The following conditions are available:

  • Classes: You can specify which classes the Student must have attended before they can download the certificate.
  • Tests: You can specify which tests a student must have completed successful before they can download the certificate

To create a new certificate follow these steps

  • Login to the backend and click on the 'Certificates'->'Create Certificate' option
  • Fill in the available options. Please note that the 'Certificate Image' should be a blank copy of your certificate (preferably in A4 size). Here is a sample:
  • Once you click the 'Save' button, you will be redirected to the certificate edit page. On this page, you can drag and drop the various 'placeholders' that are available. These placeholders let you specify where text like the student's name, session/course name etc will be placed on the downloaded certificate.
  • You can specify the mandatory classes and tests by clicking the relevant tabs.
  • Do note that, on the 'Mandatory Classes' tab, there is an option a the bottom called 'Search all sessions for attendance' if you select this option, the system will search all existing sessions/courses for attendance of the classes you select in this tab. This is useful if a student attends some classes in one session/course but attends the remaining in another session/course.


Managing Attendance

Setting Attendance

The attendance module enables you to set the attendance for each student per session and class. There are three attendance setting options available:

1. Attendance Lets you set the attendance by selecting students individually.

2. Attendance (bulk) Lets you set attendance of all enrolled students by ticking checkboxes

3. Attendance (import) Lets you set attendance by importing a csv file.

Lets go over each method


Attendance

This option enables you set attendance by typing in a students name.



Once you type in a name, click on it to move it to the box on the right.
Add as many students as you want this way. Next select the session and the class. Finally click submit to save the attendance.


Attendance (Bulk)

This feature enables you to set the attendance by selecting the relevant students from a list. Once you select a Session from the dropdown, the list of enrolled students will appear



In the Mark column, simply select the students that you want to set attendance for and then click Save.


Attendance (Import)

This feature enables you to set the attendance offline and import later.


The instructions on how to use this feature are available on the page.



Certificate Lists

This feature enables you to download a list of students that attended a certain number of classes in a session. You can generate two types of lists:


  • Specific classes: This lets you select the mandatory classes for a session
  • Minimum number of classes: This enables you specify a minimum number of classes each student must have attended.


The search option enables you check for attendance records from either the selected session or any other session. For example, a student might have completed the classes you specify by attending two different sessions. This option enables you add or exclude them from the list.


A csv file will be generated showing the classes students attended as well as the attendance dates.



Attendance Dates

This feature enables you to easily set the attendance date for all the students in a session/course. By default, the date is set based on the class date you specified during the session creation (for training sessions) or the date the student completed the class (for online courses). This feature enables you to override that.

To use this feature, simply select a session/course from a dropdown and then pick a date




Revision Notes

Creating a revision note

Revision notes are intended to be pre or post class summaries. Each revision note is associated with a session and a class. Only students that are enrolled in a session can view the revision notes associated with it.

To create a new revision note, click on the Add Note option under Revision Notes.



The add note page has the following fields:

1. Title: The note title

2. Session: The note session

3. Class: The note class

4. Description: An optional description. The Description will be part of the notification email a student will receive when the note is saved.

5. Content: The content of the revision note.

6. Notify session students: If this is selected, each student enrolled in the session will receive an email informing them about the availability of the revision note.



Managing revision notes

To manage existing revision notes, simply go to 'Revision notes'-'View Archive'


Click the 'Edit' or 'Delete' button for the revision note you want to modify or delete.


Content

Content

Managing Articles

TrainEasy articles are static pages of content that you would like to create to add information to your portal. Typically, you would use them to create pages like 'About Us', 'Vision', 'Mission' etc. Articles can be placed on the navigation menu for easy location by your visitors.

To manage your articles, click on the 'Articles'-'Manage Articles' menu option

The list of existing articles will be displayed. To create a new article, click on the 'Add Article' menu option

This opens the article creation page

The fields on this page are described below:

  1. Title: This is the main heading of the article as it would appear on your site.

    This will also be used as the browser title if the 'Meta Title' field is left blank
  2. Content: This will hold the text content of the article
  3. Slug: This is the Url identifier for the article e.g. htttps://yourportal.com/who-we-are. You can safely leave this blank and it will be generated automatically from the article title you specify.
  4. Meta Title: This contains the browser title for the article. If left blank, the article title will be used instead. This field is especially useful for Search Engine Optimization (SEO).
  5. Meta Description: This Contains the page description visible to search engines. The content of this field will not be visible while viewing the article in the browser but is very useful when optimizing the page for search engines.
  6. Enabled: Specify if the article can be viewed or not.
  7. Mobile: Specify if the article can be viewed on the mobile app (if you have configured that). Selecting this makes the article available on the API

Click on the 'Create' button when done.



Managing Blog Posts

TrainEasy comes with a blogging feature that enables you maintain an easy to use blog on your portal. The blog comes with categories and  scheduling posts.

Managing Blog Categories

Blog posts can be organized into categories. It is recommended that you create your blog categories first before you start creating posts. To manage your categories, go to 'Blog'-'Manage Categories'

This brings up the list of existing categories

To add a new category, click on the 'Add New' button

Fill in the name and sort order of the category. The sort order is a number that determines the position of the category on the blog listing page in ascending order.


Managing Posts

Blog posts are news-like entries that you add continuously to your site. To manage your blog posts, click on the 'Blog'-'Manage Posts' option

This brings up the list of all blog posts.

This list shows the title of the post and its publish date. It also shows if the post is enabled or not. Disabled posts are not visible on the frontend.

Click on the 'Add New' button to create a new post

Each field presented on this form is described below:

  1. Title: This is the main title of the blog post
  2. Content: This is the main content of the blog post
  3. Published on: This is the date you want the post to go live. Please note that if you set a future date as the publish date, then the post will not be visible on the frontend until that date.
  4. Categories: Select the categories that this post should belong to. You need to have already created the category as described above. You can assign a post to multiple categories.
  5. Enabled: Specify if the post should be visible or not.You would usually make a post disabled if you are still working on its content.
  6. Cover Image: Select an image from your computer that will serve as the main image displayed for this post on the blog listing page.
  7. Meta Title: This is the browser page title for this post. If left blank, the post's title will be used. This field is especially useful for search engine optimization purposes.
  8. Meta Description: This is the internal description for this post visible to search engines. This field is useful for search engine optimization. 

Click on the 'Create' button to add your new post.

Zoom Setup

TrainEasy ships with powerful zoom integration that enables your students attend zoom classes from right inside their lectures!
Students do not need to enter meeting ids, names or any other data as that is supplied from their profile on the portal.
Follow these steps to enable Zoom

  • Visit https://marketplace.zoom.us/ and register an account.
  • At the top-right, click 'Develop'-'Build App'
  • Select JWT
  • Obtain your API key and API secret
  • Login to your TrainEasy admin area. Go to 'Settings'-'Site Settings'
  • Click on the 'Zoom Settings' tab and save your credentials there
  • Click the 'Save Changes' button

You can now add a Zoom meeting to any lecture simply by specifying it's Meeting ID and Password.

Upgrade Guide

Upgrading TrainEasy is straightforward. First create a full backup of your installation. Also, if you have created any custom templates or gateways, ensure you copy these to a safe location outside the application and restore them once the upgrade is completed.

Follow these steps to upgrade your installation:

  • Extract the contents of the TrainEasy zip archive downloaded from CodeCanyon
  • You will see a file called app.zip. Upload this file to the update directory in the root directory of the application. (If you do not see this directory, create it and make it writable)
  • Login to your admin backend and go to 'Settings'-'Upgrade'
  • Click on the 'Update' button and you are done!


Note to version 2 users

If you are using the older version of TrainEasy i.e. the version that runs on Zend Framework, please note that you will not be able to upgrade from that version to this new version. This is because the new version runs on the Laravel framework and is hence not backwards compatible. You will need to install the application afresh and setup your new installation


Zoom Setup

TrainEasy ships with powerful zoom integration that enables your students attend zoom classes from right inside their lectures!
Students do not need to enter meeting ids, names or any other data as that is supplied from their profile on the portal.
Follow these steps to enable Zoom

  • Visit https://marketplace.zoom.us/ and register an account.
  • At the top-right, click 'Develop'-'Build App'
  • Select JWT
  • Obtain your API key and API secret
  • Login to your TrainEasy admin area. Go to 'Settings'-'Site Settings'
  • Click on the 'Zoom Settings' tab and save your credentials there
  • Click the 'Save Changes' button

You can now add a Zoom meeting to any lecture simply by specifying it's Meeting ID and Password.

Disable Frontend

TrainEasy provides a feature that enables you to completely disable the frontend features of your site. This means pages like the Homepage, Blog, Articles and Contact pages will not be accessible to users. With the frontend disabled, the default landing page will be the login page. Users can also register if registration is enabled. Only logged in users will be able to view your course/session catalog.

To disable the frontend, login to your admin section and go to 'Settings'-'Disable Frontend'


On the 'Disable Frontend' page, select 'Disabled' and save your changes.

Dashboard Theme

If you would like to change the default blue theme of both the Admin and Student dashboards, you can do so easily by logging into your admin section and going to 'Settings'-'Dashboard Theme'

On this page you will see a color picker. Click on the color picker icon or on the text box and you will be presented with a color selection dialog. Choose your preferred color and save. Save your changes and you are done!