General Modules: Admin & System Maintenance
General Modules is an internal administrative toolkit designed for high-level system maintenance and data management. Restricted to specific admin user IDs, this module provides a suite of backend utilities for regenerating organization configuration files, processing bulk PDF and Excel exports for user plans, and performing deep-clean deletions of customer records. It acts as a centralized "command center" for developers and system managers to force global updates, troubleshoot document generation, and inspect sensitive payment data through a secure, multi-column interface.
How to Load the General Modules
To access the General Modules admin toolkit, follow these three simple steps:
-
Open Settings: Click on your Profile Icon in the top-right corner and select the Settings (gear) icon.
-
Navigate to Special Modules: In the left-hand sidebar, locate and click on the Special Modules dropdown menu.
-
Launch General Modules: Click on General Modules from the list. The maintenance modal will open at Step 1/1, displaying your administrative tools.
|
 |
General Modules: Key Administrative Tools
These features within the General Modules are high-level administrative functions used to maintain system accuracy and ensure all data remains synchronized across the platform.
 |
1. Generate File For Single User
-
What it is: A targeted synchronization tool for a specific account.
-
How it works: Enter a unique User ID and click Submit to regenerate all configuration and organization-specific files for that single user scope.
-
Use Case: Use this when a specific user reports an issue with their settings or if their account data isn't loading correctly.
2. Generate File For All Users
-
What it is: A global system-wide update tool.
-
How it works: Clicking this button triggers a backend process that loops through every user in the database and regenerates their configuration files.
-
Use Case: Typically used after a major platform update or code change to ensure all users are running the latest version of their generated system files.
|
3. Generate Document PDF
-
What it is: A specific recovery tool for document files.
-
How it works: Enter a Document ID to manually re-trigger the PDF creation process. It pulls the data from the database and rebuilds the physical PDF file.
-
Use Case: Useful if a customer reports a "missing" PDF or if a previous document was generated with incorrect formatting and needs to be refreshed.
4. Refresh User
-
What it is: A remote "page reloader" for the frontend.
-
How it works: Enter a specific Owner User ID or type "all" to send a socket signal that forces the web browser to refresh for those users instantly.
-
Use Case: Use this after making a critical update to ensure users see the changes immediately without needing to manually refresh their own browsers.
5. Delete All Documents for Single Customer
-
What it is: A deep-clean data removal tool.
-
How it works: Enter a Customer ID and click Submit to permanently wipe all linked records, including documents, payments, and product history for that specific client.
-
Use Case: Essential for privacy requests (GDPR) or clearing out accidental duplicate entries and testing data to keep the database clean.
|
 |
6. Generate Supplier PDF
-
What it is: A dedicated document generator for vendors.
-
How it works: Input the specific supplier details or IDs to trigger the creation of a formatted PDF document tailored for supply-chain records.
-
Use Case: Used when a supplier needs a formal record of transactions or account details that isn't covered by standard customer invoices.
 |
7. Download User Plan Zip
-
What it is: A bulk document downloader for paid invoices.
-
How it works: Enter the User ID and a specific Date Range (From/To). The system gathers all matching invoice PDFs and packages them into a single .zip file for instant download.
-
Use Case: Perfect for users who need all their payment receipts for annual tax filing or accounting audits.
8. Download User Plan Excel
-
What it is: A structured data reporting tool.
-
How it works: Similar to the Zip tool, enter the User ID and Date Range. Instead of PDFs, the system generates an .xls spreadsheet containing detailed payment methods and transaction records.
-
Use Case: Used for high-level financial analysis or importing transaction history into third-party accounting software like QuickBooks or Excel.
|
9. Get Card Details
-
What it is: A sensitive data inspection tool for internal debugging.
-
How it works: Input a User ID to decrypt and display the stored card information (such as card type or last four digits) associated with that account.
-
Use Case: Strictly for internal support when a user reports a payment failure or needs to verify which card is currently active on their subscription.