Administrator's Operations Guide

System configuration, user management, reporting period locking, KPI configuration, and export job management.

Warning: Many operations in this guide are irreversible. Always verify before acting.

1. Your Admin Capabilities

CapabilityDescription
manage_publicationsLock/unlock publications
manage_grantsLock grants, override any action
manage_policiesArchive policies
manage_ip_disclosuresOverride IP workflow
manage_revenue_linesLock revenue data
manage_capacity_buildingOverride activities
manage_funding_programmesCreate/edit funding programmes
manage_kpi_definitionsConfigure KPIs
manage_export_jobsFull export access
view_system_healthSystem monitoring
manage_usersUser lifecycle

2. Reporting Period Management

Reporting periods define when submissions are collected for HEC reporting.

2.1 Creating a Reporting Period

  1. Go to Settings → Reporting Periods
  2. Click Add Period
  3. Fill in: Code (e.g., FY2024-25), Label, Start Date, End Date
  4. Click Save

2.2 Locking a Reporting Period

Critical: Locking a period freezes all data. This cannot be undone without administrator intervention.

To lock:

  1. Go to Settings → Reporting Periods
  2. Find the period you want to lock
  3. Click Lock Period
  4. Confirm the action

When a period is locked:

2.3 What Gets Locked

ModuleAffected Records
PublicationsAll approved publications in period
GrantsAll grants in period
PoliciesAll published policies
IP DisclosuresAll IP records
RevenueAll revenue lines
Capacity BuildingAll activities

3. User Management

3.1 Creating Users

  1. Go to Admin → Users
  2. Click Add User
  3. Enter username, email, select role
  4. Set initial password (must be changed on first login)

3.2 Role Assignment

RoleUse For
adminSystem administrators
oric_staffORIC processing staff
employeeResearchers, faculty
leadershipVC, Deans, management
supervisorDepartment heads

3.3 Supervisory Hierarchy

Set reports_to for each user to enable:

4. Export Jobs

Export jobs generate reports for HEC submission.

4.1 Available Exports

Export TypeDescription
ScorecardComplete HEC scorecard (all sections)
Annex-A BundleInstitutional profile, ORIC staff, committees
Annex-B BundleGrants, funding, overhead
Annex-C BundlePolicies, IP, patents
Annex-D BundleRevenue, capacity building
PublicationsICT-2 publication list
KPI ReportCalculated KPIs for period

4.2 Running an Export

  1. Go to Export → Create Job
  2. Select export type
  3. Select reporting period
  4. Choose format (CSV/JSON)
  5. Click Queue Export

Exports run in the background. You'll receive a notification when complete.

5. KPI Configuration

Configure KPIs for institutional tracking:

  1. Go to Admin → KPI Definitions
  2. Add or edit KPI definitions
  3. Set formula, threshold, category
  4. Mark active/inactive
Note: KPI definitions are system-wide. Changes affect all users.

6. Notification Rules

Configure who receives which notifications:

  1. Go to Admin → Notification Rules
  2. Configure event → role mapping
  3. Set channel preferences (email, push, in-app)

7. System Health

Monitor:

8. Database Migrations

Warning: Schema migrations modify the database structure. Only run migrations in development first.

To apply pending migrations:

  1. Go to Admin → Migrations
  2. Review pending migrations
  3. Click Apply

9. Backup & Recovery

Regular backups should include:

See BACKUP_AND_RECOVERY.md for detailed procedures.


Related Documentation: Backup & Recovery | Operations Runbook | Role Permissions