Schoex Documentation

### Welcome

#### Schoex - The ultimate school management application ( Exclusive on codecanyon )

Thank you for choosing our products, we would be happy to receive your feedbacks on e-mail address : info@cr-house.com
Customer support available in our support gate : http://support.cr-house.com

### Schoex modules

Schoex include multiple of modules that orchestrate together to define schoex services, here is the list of modules :

- User groups : Administrators, teachers, students and parents
- Registeration : Administrator must approve registerations of teachers, students or parents
- Private messages : simple way to communicate with other users by messages
- Mail / SMS : Administrators can send e-mail or SMS to teachers, students or parents
- NewsBoard : Publish school news on board
- Events : Publish scheduled events
- Calender : List events, news, exams and online exams on calender
- Attendance : Track attendance of students
- Exams : Add exams scheduled for school students and grade levels
- Assignments : Upload assignments related to each class
- Online exams : Create online exams ( Multiple choice ) for students with auto marking
- Dormitories : Add your school dormitories
- Classes : Add your school classes
- Class schedule : Create class schedule for each one
- Subjects : Add subjects and their relation to teachers
- Books library : Create online library by either download or book availability on library

You can simply enable/disable activated modules. go to Administrative tasks -> General Settings. you'll find Activated Modules option to select which modules running

### Schoex installation

Installation of Schoex is pretty easy just do the following items :

- Set folders permissions
- Set Database connection details in config file
- Start installation

#### Folders permissions

The following folders must have write permissions ( Permission : 755 ) :

- uploads/assignments
- uploads/books
- uploads/profile
- app/storage/cache
- app/storage/logs
- app/storage/meta
- app/storage/sessions
- app/storage/views

You can use FTP application like filezilla to set permissions to the required foldres

#### Database connection

Prepare your database connection details and add it to file : app/config/database.php

#### Start Installation

Point the URL to : http://example.com/path_to_script/install
Welcome script shows, press start installation :
Checking the database connection and folders permissions, if it pass press next step, if failed please check your configurations again then recheck
Type in Administrator details and site settings, press next
Now you finished installation, go to : http://example.com/path_to_script

### Schoex upgrade

When new version available to download, update notice button appear in the top menu of your website.
Simply click on it and follow the instructions to update your version.

### User roles

##### Schoex has 4 user roles

1. Administrators
   - Control all areas of script
   - Create new accounts and approve registeration requests
   - Send Mail / SMS to users
   - Control site settings, dormitories, classes, subjects, news, events and grade levels
   - Set class schedule for each class
   - Can use private messages with other site users
   - View library, download and check book status
   - Demo Test : click here Username : admin, Password : admin123
2. Teachers
   - Can see classes schedule
   - Add / Control attendance for students
   - Add / Control grades for students
   - Create online exams for classes and review marks
   - Can use private messages with other site users
   - View library, download and check book status
   - Can view news, events and calender
   - Demo Test : click here Username : teacher, Password : teacher123
3. Students
   - Can view exams and assignments
   - Can view online exams and take them
   - Can see classes schedule
   - Can view news, events and calender
   - Can use private messages with other site users
   - View library, download and check book status
   - Demo Test : click here Username : student, Password : student123
4. Parents
   - Can see his student's marksheet and attendance
   - Can view exams and assignments
   - Can see classes schedule
   - Can view news, events and calender
   - Can use private messages with other site users
   - View library, download and check book status
   - Demo Test : click here Username : parent, Password : parent123

### registerations

Schoex offer registerations systems for teachers, students and parents to register themselves in the system and administrator approve their accounts instead of adding them manually.
And now administrator can approve or remove newly registered accounts go to (teachers, students or parents) and click Waiting approvals button to view list of users pending.

### Languages

Schoex delivered to you equiped with 9 diffrent languages : English, Arabic (RTL), French, Dutch, German, Hindi, Italian, Turkish,Russian & Spanish with RTL Support
User can select his own language, and you can disable this feature
Even if your language isn't exixt, you can add new language by clicking Add button

### Dashboard

Beautifull dashboard provides you with quick statistics, upcoming news & events, leaderboard (students & teachers), calender and Quick links customized based on your user group
Schoex comes with 2 themes : Black & Blue

### School terms

Static pages enable you set your static content pages, You can select activated pages to be shown on the left menu bar.
Only activated pages appear on the left menu bar

### Users

List administrators on website : from left panel press Admins
To add new administrator press Add administrator button
List teachers on website : from left panel press Teachers
To add new teacher press Add teacher button
the same procedures for students and parents
To view any user's profile, pess on user's name
Users can be imported / Exported via Excel And CSV, But you must follow the file Schema to avoid any problems.

### Leader board

Leader boards are available for students & teachers, leaderboard show up in the main dashboard
You can set student leaderboard from the following : Go to students and locate the student you want define leaderboard and click the following icon :
popup message appear to define description of leaderboard, type it and click ok.
The same procedure for teachers

### Student promotion

You can use promotion feature to promote student from one class to another
Select student class, students and the class to be promoted to.

### Mail / SMS

Administrators can send Mail / SMS newsletters to Teachers, Students (All students or specify class's students) and parents also you can track sent messages .
With administrator account you'll see Mail/SMS button on the left bar.

- Select Type of users : Teacher, Student or Parents
- Select Send as Regular mail or SMS
- Type Message title & content

Schoex support diffrent 8 SMS APIs and 4 methods of mail delivery

- SMS
  - Nexmo
  - Twilio
  - hoiio
  - ClickAtell
  - intellisms
  - Bulksms
  - Concepto (liveair.in)
  - MSG91
- Mail
  - Simple PHP Mail function
  - PHP Mailer class
  - SMTP
  - Amazon SES

You can edit the messages sent for Exam details and Student's absense notification from : Administrative tasks -> Mail / SMS Templates
Select the template you want to edit :
Edit the template

### Payments

Schoex support payments with paypal integration and tax calculation.
Add / Edit payment
When selecting more than one student it'll generate seperate invoice for each one
View the generated invoice
When Payment is PAID via paypal, you can click on PAID text to see the payment's information
Set Paypal mail address and payment TAX from Administrative tasks -> Genetal Settings

### Site settings

Administrators control site settings through site settings. Site title & URL, Address, Phone No., E-mail address, Footer text and twilio credintals.
With administrator account you'll see Site settings button on the bottom of left bar, you can edit:

- Website title & url
- School address & phone number
- System E-mail : used when send mail to users
- Change footer text of script
- For enabling SMS you must have active account on Twilio and type here Twilio account SID, Twilio auth token & Twilio from number

### Account settings

Change your account profile data, E-mail address and password, from the top menu the Account Settings button.
Change your profile data : Fullname, Gender, birthday, Address, Phone number, Mobile number & profile photo
Change your E-mail address and password

### Private messagess

PM is simple way for users to communicate each others. Schoex implement synchronous chat box between 2 users with chat archiving .
Sending new message is simple by clicking button : Compose and write your message

### Newsboard, Events

Newsboard and events offer easy way to publish your school's news and events, items are classified to be shown to teachers, students, parents or all members

### Calender

All time-based items combined in the calender includes :

- News board
- Events
- Exams
- Online exams
- Assignments

### Attendance

Student's attendance support 2 types:

- Subject based : Attendance entry require Subject and class
- Class-only based : Attendance entry require class only

You can switch between both of them from : Administrative tasks -> General Settings -> Attendance model
Teachers can add / control student attendance for classes and subjects, Select Class, Subject and day to control the attendance then proceed
Check one of student status from : Present, Absent, Late, Late with excuse Or Early Dismissal is absent or prsent, ( Data can be edited anytime after that )
You can see student attendance history from the left meny click students and you'll find this icon beside student to view student attendance history
View student attendance history
Use attendance statistics for get deep info about attendance. Graphs or search attendance.
You can activate sending student absent's status to parent's mail or SMS from : Administrative tasks -> General Settings -> Send student's absense via And select sending method you need .

### Dormitories, classes & subjects

- Dormitories, classes & subjects are 3 categories to organize structure
- Dormitories used to define places inside your school
- Subjects are related to teachers
- Classes are related to students

Dormitories
Subjects
Add subject
Classes
Add class

### Book library

Archive your library books in this section ( Traditional ) and make other books downloadable ( Electronic ) .
Books available to download can be downloaded via this icon .
Add book :

- Specify boot title, Description & author
- If it traditional book specify it's price & availabilty status
- If it electronic book upload the book file to be available to download

### Polls

From Administrative tasks -> Polls.
To add poll you'll need to set the poll title, Options and target
From Dashboard see it in action

### Transportation

Manage the transportation list
Add / Edit transport by adding transport title, description, Driver contact and fare
You can list transport Subscribers by pressing this button
To add student / Teacher under one of transportation, Edit user to select the enrolled transportation

### Media Center

Schoex provide media center with unlimited sub-albums features

### Exams

You can add exams list of your school and teachers will add exam grades for each school.
Teachers, Admins can add marks for the students for the exam by clicking this button :
The following form appear, select Class & Subject to add the marks to and press Add marks :
The following form appear to add the marks of attendance, exams & comments of exam
You can send exam marks to student's & parents by clicking this button in exams list
Change sending exam notifications settings go to Administrative tasks -> General Settings

### Grade levels

Grade levels define exam grades and their values to generate Marksheet marks.
Add/Edit grade level

### Assignments

Assignments differ from exams that you can upload assignment file & select target classes then students download file and solve it.
Add/Edit assignments. you can select multiple classes, choose assignment deadline and upload assignment file.

### Online exams

Administrators & teachers can create online exams for student with ability to specify class students able to take this exam and option to show the grade after finish exam or not. specify start and deadline of exam with unlimited questions.
To add/edit exam by Add exam button or edit button :

- Enter Exam title & Description
- Select Class (You can select multiple) & Subject
- Select Exam start date & Deadline
- In Extras you can select to show grade to student after finish & submit the answers
- Add Exam questions and answers, select the true answer the press add question

You can show marks of students who took the exam by pressing the following button

### Class schedule

You can control class schedule for each class and print them, simply press add, select subject day and time and press add
To add schedule press + button and enter details : Subject, Day, Start time & End time

### School Terms

Modify School terms from : Administrative tasks -> School Terms. Type terms and save