Setup Guide

Choose the connection path that matches your current systems.

Use live APIs when your ERP, SMS, SIS, LMS, or database can sync directly. Use strict Excel templates when your team prefers manual review. Use SSO when users should open the LMS from your portal without another login. Use payment providers when course fees, invoices, or online checkout should be collected through Odoo.

Before you begin Prepare your base URL, environment name, sample teacher/student/course records, API details or Excel exports, SSO provider information, and payment provider credentials if online payment is required.

Use this guide if you have

  • Student Management System, SMS, or SIS.
  • ERP or university portal.
  • Existing LMS or internal database.
  • Excel exports for academic data.
  • Identity provider for SSO.
  • Payment gateway account for online course or invoice payments.

Prepare before setup

  • Base URL and environment name.
  • API endpoint list or Excel exports.
  • API keys, tokens, or app credentials.
  • Sample teacher, student, course, and enrollment records.
  • SSO protocol and redirect URI, if required.
  • Payment provider account, supported currency, and sandbox credentials.
02

Live API setup

Integrations Hub

Use this when your system can provide connection details without code changes. Administrators should prepare the LMS URL, API keys, security tokens, and endpoint paths.

Purpose Keep connection details in one secure administrative place so integrations can be standardized across institutions instead of hardcoded per project.

What you enter

  • LMS URL or external system base URL.
  • Environment name, institution name, and connection owner.
  • API credentials, keys, username, or password.
  • Bearer token, refresh token, or webhook secret.
  • Teacher, student, course, enrollment, and college endpoints.

Example endpoints

  • Teachers: /api/teachers
  • Students: /api/students
  • Courses: /api/courses
  • Enrollments: /api/enrollments
  • Colleges: /api/colleges

Step by step

  1. Open System Configuration.
  2. Open Integrations Hub.
  3. Enter the LMS URL or external system URL.
  4. Enter the required credentials or token.
  5. Add endpoint paths for teachers, students, courses, and enrollments.
  6. Save and run a connection test.
  7. Run a small test sync and review records in NexusLMS.
  8. Approve the integration for production sync.

Success criteria

  • NexusLMS can reach your system URL.
  • Authentication succeeds with the configured credentials.
  • Sample records sync without manual code changes.
  • Credentials are stored securely and fetched dynamically by integration modules.
  • Sync failures can be reviewed without exposing secrets.
Recommended test Start with a small dataset: one college, two courses, two teachers, and five students. Confirm records are created correctly before enabling a production-sized sync.
03

Manual upload setup

Bulk Imports / Templates

Use this when live API syncing is not ready or when academic data must be reviewed before entering the LMS.

Purpose Give your team strict Excel structures for batch creation and enrollment, while still allowing validation before records are imported.

Students

Student role accounts that can sign in to the tenant LMS and access enrolled courses.

Company, Login, Name, Roles Download CSV

Teachers

Teacher role accounts that can be assigned to courses and manage course activity.

Company, Login, Name, Roles Download CSV

Colleges

College records used to group users and courses under the correct tenant company.

code, name, name_ar Download CSV

Courses

Course records created under a college. ID is the external course identifier.

id, name, college_code Download CSV

Teacher Assignments

Links teachers to courses so they can appear as assigned instructors in the LMS.

username, external_course_id, college_code Download CSV

Student Enrollments

Links existing student users to courses. Username is the user's Login, and External Course ID is the course's business ID—not Odoo's exported External ID.

username, external_course_id, college_code Download CSV

Upload flow

  1. Download the official Excel template.
  2. Fill the file without renaming columns or merging cells.
  3. Open Settings → UST LMS Sync → Bulk CSV Imports.
  4. Choose Student Enrollments or Teacher Assignments, then click Import.
  5. Upload the completed file and review the mapped columns.
  6. Review the row-by-row results after importing.
  7. Fix rejected rows and upload again if needed.
  8. Export the result list if a report is needed.

Avoid these mistakes

  • Uploading raw ERP exports without mapping them to the template.
  • Using a course number without the matching college code.
  • Using different usernames for the same person.
  • Leaving required fields empty.
  • Renaming columns, changing order, or merging cells.
Expected result The file is validated row by row, mapped to NexusLMS fields, rejected rows are reported clearly, and approved rows can be imported immediately for batch enrollment.

Validation should check

  • Required columns exist exactly as expected.
  • Required values are not empty.
  • Email formats are valid where email is required.
  • College codes and course numbers match existing records.
  • Enrollment status uses accepted values only.

Recommended first import

Start with one college, one or two courses, a small teacher list, and a limited student group. Review the result report before uploading a full academic batch.

04

Single sign-on setup

Authentication (SSO)

Use this when users should open NexusLMS from your portal or identity provider without entering a second password.

Purpose Map identity provider settings, certificates, and handshake endpoints in one place, then provide a clear Open LMS action for authenticated portal users.

Identity provider settings

  • Provider name and protocol type.
  • Issuer URL and authorization endpoint.
  • Token, user info, or introspection endpoint.
  • Application ID, application secret, redirect URI, and scope.
  • Security certificate, signing key, or metadata URL.

Open LMS flow

  1. User signs in to your portal or identity provider.
  2. User clicks Open LMS.
  3. Nexus validates the SSO request and maps the user account.
  4. Nexus creates a secure LMS session.
  5. User enters the LMS without another password prompt.

Logout flow

  • Confirm whether logout starts from the portal, LMS, or identity provider.
  • Configure the logout URL or single logout endpoint.
  • Make sure the session is cleared according to the selected protocol.
  • Test that a logged-out user cannot reopen the LMS from an old session.

Success criteria

  • Authenticated users can jump to the LMS securely.
  • User identity maps to the correct NexusLMS account.
  • Certificates and endpoints are configured in the admin interface.
  • Logout behavior matches the agreed protocol specification.
Recommended test Test at least one administrator, one teacher, and one student. Confirm each user lands in the correct account and loses LMS access after logout.
05

Online payment setup

Payment Integrations

Use this when a tenant needs to accept online payments through NexusLMS for course fees, invoices, portal payments, or checkout orders.

Purpose New tenant databases include the supported community payment provider modules by default. Administrators only need to open the provider screen, activate the gateway they want to use, enter the credentials requested by that provider, and test the payment flow before going live.

Preinstalled provider options

  • Stripe, PayPal, Adyen, Alipay, Amazon Payment Services, AsiaPay, Authorize.Net, Buckaroo, Flutterwave, Mercado Pago, Mollie, Ogone, PayU Latam, PayUmoney, Razorpay, SIPS, and Xendit.
  • Wire Transfer / Custom Payment Modes for offline or manual payment collection.
  • Demo provider for sandbox testing and internal validation only.

Provider details to prepare

  • Merchant account, provider app, or gateway dashboard access.
  • API keys, publishable keys, secret keys, merchant IDs, webhook secrets, certificates, or account identifiers requested by the selected provider.
  • Accepted currencies, countries, payment methods, and settlement account.
  • Return URL, webhook URL, checkout domain, and test credentials if the provider requires them.

Setup flow in the tenant database

  1. Log in to the tenant database as an administrator.
  2. Open Settings, then select Payment Providers.
  3. Choose the provider the institution wants to use and click Activate.
  4. Enter the credentials and configuration fields requested by that provider.
  5. Keep the provider in Test mode first and complete a sandbox transaction.
  6. Confirm the payment returns users to the correct confirmation page and creates the expected transaction record.
  7. Move the provider to Enabled only after the finance and operations teams approve the test flow.

Success criteria

  • The selected provider is visible and configurable from Settings > Payment Providers.
  • Sandbox payments complete successfully and return users to the correct confirmation page.
  • NexusLMS records the transaction with the correct customer, invoice or order, and currency.
  • Failed, canceled, refunded, and pending payments are clearly visible to administrators.
  • Live credentials are not used before finance and operations approve the flow.
Recommended test Start with one low-value test payment. Confirm successful payment, failed payment, refund or cancellation behavior, customer email, and administrator visibility before enabling live checkout.
06

Decision guide

Which setup should you choose?

Your institution can use one setup path or combine multiple paths. Many teams start with imports, move to live API syncing, enable SSO when identity provider details are ready, and add online payments when course fees or portal invoices need checkout support.

Choose Integrations Hub Your system has stable APIs, your technical team can provide credentials, and you want ongoing automated sync.
Choose Bulk Imports Your API is not ready, data needs review, or you want to begin with a controlled first import.
Choose Authentication (SSO) Your users already sign in through a portal or identity provider and should open the LMS without another password.
Choose Payment Integrations Your users need to pay course fees, invoices, or online orders through a supported Odoo payment provider.
Practical approach Start with the lowest-friction setup that gets clean data into NexusLMS, then standardize the live connection, authentication flow, and payment provider when your technical details are ready.
07

Go-live checklist

Confirm these items before production launch.

System and data readiness

  • System owner and technical contact are confirmed.
  • Base URL and environment are documented.
  • API credentials or Excel templates are ready.
  • Sample teacher, student, course, and enrollment records are prepared.
  • Connection test or upload validation has passed.

Access and launch readiness

  • Rejected rows or sync errors have been reviewed.
  • SSO redirect URI and certificates are confirmed, if applicable.
  • Open LMS action has been tested by role.
  • Logout behavior has been tested.
  • Payment provider sandbox checkout and refund flow have passed, if applicable.
  • Production sync/import approval is documented.
Final reminder Use Integrations Hub for live API connections, Bulk Imports for controlled Excel uploads, Authentication (SSO) for secure one-click LMS access, and Payment Integrations for verified online checkout.