Getting Started (User Guide)
TODO: Basic end-user onboarding steps.
User Manual – System Configurations
Introduction
This manual provides step-by-step guidance on managing system configurations. It is designed for administrators and users to configure global settings, manage modules, apply themes, update the system, handle backups, and manage storage efficiently.
Global Configurations
The Global Configuration section allows administrators to set system-wide parameters such as phone country codes, time zone, OTP settings, file upload limits, and storage options. These settings ensure consistent behavior across the application.
Phone Country Code
This setting defines the country code used for all phone numbers in the system.
For example, selecting +94 (Sri Lanka) ensures that all registered phone numbers are prefixed with the Sri Lankan country code.
Make sure the correct country code is selected so phone number validation and communication features work properly.
Time Zone
This option sets the system’s time zone, which affects all scheduled activities, notifications, and system logs.
For instance, selecting Asia/Colombo will align the system clock with Sri Lanka’s local time.
It is important to choose the correct time zone for your region to ensure accurate scheduling and reporting.
Phone Number Length
This field determines the total length of phone numbers (excluding the country code).
For example, in Sri Lanka the phone number length is typically 9 digits, so the value should be set to 9.
Entering the correct length ensures consistent validation of user phone numbers.
Max File Upload Size (MB)
This setting specifies the maximum file size allowed for uploads in the system.
For instance, if set to 10 MB, users cannot upload files larger than 10 MB.
Adjust this value according to your system’s storage capacity and expected file usage.
OTP Attempt Limit
This option controls the maximum number of failed OTP (One-Time Password) attempts allowed for a user.
For example, if the limit is set to 4, a user can only enter an incorrect OTP four times before restrictions apply.
This helps secure the system against brute-force attempts.
OTP Reset Interval (Seconds)
This setting defines the time period after which the OTP attempt counter resets.
For example, if configured to 180 seconds (3 minutes), users will regain a fresh set of attempts after three minutes.
This provides balance between security and user convenience.
OTP Attempt Block Time (Minutes)
This field determines how long a user will be blocked from making further OTP attempts after exceeding the allowed limit.
For instance, setting this value to 120 minutes (2 hours) means the user must wait two hours before trying again.
Adjust this carefully to prevent misuse without overly inconveniencing genuine users.
File Storage Type
This option defines where uploaded files will be stored.
If set to Local, files are stored directly on the application’s server.
Alternatively, you can configure Amazon S3 as the storage option, which stores files securely in the cloud and allows for scalable storage management.
Select the option that best fits your organization’s infrastructure and long-term data storage needs.
After Completing the Saving
Once you have updated the required fields in Global Configurations, follow these steps to save your changes:
- Review all the configuration fields you have modified (Phone Country Code, Time Zone, OTP Settings, File Storage Type, etc.).
- Scroll to the bottom of the Global Configurations page.
- Click on the Save Configuration button.