Skip to main content

Accelero Edu Integration

The Accelero Edu integration connects ACCELERO to the Accelero Edu application, aimed at the school environment. The app allows the teacher to take attendance (attendance list) of a class directly from their phone, authenticating with their ACCELERO credentials. The recorded attendance is available in ACCELERO through the Attendance Report.

Availability

This integration is provided as a plugin (acceleroedu) and must be installed and enabled by IONGRADE's technical team. Contact support to check compatibility with your version of ACCELERO.

Compatibility

Current plugin version: 1.0.0 — compatible with ACCELERO 2.17.0 or higher.


What the integration does

With the plugin active, ACCELERO provides the Accelero Edu application with class and student data, authenticates teachers, and stores the attendance taken by the app.

FeatureWhat happens in ACCELERO
Marking a classA person category can be marked as a class, which then appears in the application
Class QR CodeEach class gets a QR Code that points to the app's address, identifying the school and the class
Password for Accelero EduA person (teacher) can have their own password to authenticate in the application
Teacher authenticationThe app authenticates the teacher using the document (CPF) and password registered in ACCELERO
Query of classes and studentsThe app lists the enabled classes and the students of each class, with photo
Attendance recordingThe attendance list sent by the app is recorded in ACCELERO (attendance + presence of each student)
Attendance ReportReport, within ACCELERO, of the recorded attendance, with filters by period, class, student, and teacher
Main benefit

Allows the teacher to take class attendance from the application, reusing the person and category records already existing in ACCELERO, without parallel spreadsheets.


Configuration

Navigation path: Settings > Integrations - AcceleroEdu

The configuration screen has the General tab.

TODO: Add Screenshot

Screen Settings > Integrations - AcceleroEdu, General tab, showing the Operator, Authentication token, acceleroEdu URL, and School slug fields.

General tab — Integration data

FieldDescription
OperatorACCELERO operator used by the integration. When not defined, the background process user is used
Authentication token (APP > Accelero)Token used in the communication between the application and ACCELERO
acceleroEdu URLAddress (URL) of the Accelero Edu application. It composes the link recorded in the class QR Code
School slugSchool identifier used in composing the class QR Code
Required fields

All fields in the General tab are required. The Token, the URL, and the School slug are provided/defined during deployment by IONGRADE.

Screen buttons

ButtonFunction
BackReturns to the settings list
SavePersists the configuration

Fields added to entities

The plugin extends ACCELERO forms with sections specific to Accelero Edu.

Person

In the person record, the collapsible Accelero Edu section is added:

TODO: Add Screenshot

Person record with the Accelero Edu section expanded, showing the Password for Accelero Edu field.

FieldDescription
Password for Accelero EduPassword used by the person (teacher) to authenticate in the application. It is stored encrypted
Teacher authentication

The teacher authenticates in the app by entering the document (CPF) registered in their person record and the Password for Accelero Edu. People without this password defined cannot log into the application.

Category (Class)

In the person category editing, the collapsible Accelero Edu section is added:

TODO: Add Screenshot

Person category editing with the Accelero Edu section expanded, showing the Is it a class? selector and the QR Code area with the Print QRCode button.

FieldDescription
Is it a class?When enabled, marks the category as an Accelero Edu class. Only categories marked as a class appear in the application
QR CodeClass QR Code image, automatically generated from the app URL, the school slug, and the class
Print QRCodeButton that allows printing the class QR Code
Enabled classes

Only enabled categories marked as a class are listed for the application. Disable the category or uncheck "Is it a class?" to remove it from the app.


Attendance Report

The plugin adds the Attendance Report, which gathers the attendance recorded by the application.

Navigation path: Reports > Attendance Report

TODO: Add Screenshot

Initial screen of the Attendance Report, showing the filters (From, To, Classes, Student name, Student ID, Teacher name) and the generation, template creation, and history buttons.

Available filters

FilterDescription
FromAttendance start date
ToAttendance end date
ClassesSelection of one or more classes
Student nameFilters by student name
Student IDFilters by student code (RA)
Teacher nameFilters by the name of the teacher responsible for the attendance

Report content

The report lists the recorded presences, with the columns:

ColumnContent
Student nameStudent name
RAStudent code (RA)
ClassClass description
Attendance Date and TimeMoment the attendance was recorded
TeacherName of the teacher who took the attendance
PresentIndicates whether the student was marked as present (Yes/No)

The screen also provides the Templates (saved filter templates) and History (previously generated reports) tabs, in addition to the button to generate the report asynchronously.

Access permission

Access to the Attendance Report is controlled by the Attendance report permission, created upon plugin installation. Make sure the operator's profile has this permission.


How the application communicates with ACCELERO

The app usage flow follows these steps:

  1. Authentication — the teacher enters the document (CPF) and the Password for Accelero Edu; ACCELERO validates the credentials and returns the teacher's data.
  2. Class listing — the app obtains the classes (categories enabled and marked as a class).
  3. Student listing — when opening a class, the app receives the students linked to the category, with name, RA, and photo.
  4. Attendance recording — when finishing, the app sends the list with the presence of each student; ACCELERO records the attendance and the individual presence.
Class identification by QR Code

Each class's QR Code points to the application's address, already identifying the school (slug) and the class. It facilitates access to the correct class from the app.

TODO: Add Diagram

Diagram of the flow between the Accelero Edu application and ACCELERO: teacher authentication, class listing, student listing, and attendance submission.


Use cases

Enabling a class in the application

  1. Request IONGRADE to install the acceleroedu plugin.
  2. In Settings > Integrations - AcceleroEdu, fill in Operator, Token, acceleroEdu URL, and School slug.
  3. Edit the category that represents the class and enable Is it a class? in the Accelero Edu section.
  4. Make sure the students are linked to this category.
  5. Use the class QR Code (the Print QRCode button) for quick access from the app.

Enabling a teacher in the application

  1. Edit the record of the person who will be the teacher.
  2. Confirm that the document (CPF) is registered.
  3. In the Accelero Edu section, set the Password for Accelero Edu.
  4. Provide the teacher with the credentials (CPF and password) to log into the application.

Checking the recorded attendance

  1. Go to Reports > Attendance Report.
  2. Enter the period in From and To and, if necessary, filter by Classes, student, or teacher.
  3. Generate the report and track the result in the History tab.

Best practices

  • Categories dedicated to classes: use specific categories to represent classes, avoiding marking generic categories as "Is it a class?".
  • Teacher's CPF registered: authentication in the app uses the document (CPF); teachers without a registered CPF cannot log in.
  • Individual passwords: set a Password for Accelero Edu per teacher, instead of sharing credentials.
  • Report permission: grant the Attendance report permission only to the profiles that need to check attendance.

Troubleshooting

The class does not appear in the application

Possible causes:

  • The category is not marked with Is it a class?.
  • The category is disabled.

Solution:

  1. Edit the category and confirm that Is it a class? is active.
  2. Check whether the category is enabled.

The teacher cannot authenticate

Possible causes:

  • The person does not have a document (CPF) registered.
  • The Password for Accelero Edu was not defined or is incorrect.

Solution:

  1. Confirm the CPF in the person record.
  2. Reset the Password for Accelero Edu in the Accelero Edu section of the record.

The QR Code does not redirect correctly

Possible causes:

  • The acceleroEdu URL or School slug fields are not filled in correctly in the configuration.

Solution:

  1. In Settings > Integrations - AcceleroEdu, review the acceleroEdu URL and School slug fields.
  2. Save and regenerate/reprint the class QR Code.

Integration with other modules

Categories

Accelero Edu classes are person Categories marked as a class. Enabling and linking students is done in the category record.

People

Students and teachers are ACCELERO People. The teacher uses the document (CPF) and the Accelero Edu password to authenticate; the students are the people linked to the class category.

Reports

The Attendance Report follows ACCELERO's Reports mechanism, with filters, templates, and generation history.


Next Steps

  • Categories — Mark the category as a class and link the students
  • People — Register the teacher's CPF and password
  • Reports — Understand how reports work
  • Plugins — Learn more about ACCELERO's plugin system