General Settings
Configure your environment in Settings → General Settings. The settings page is organized into six tabs:
General tab:
- Session Timeout — auto-logout after a period of inactivity (default: 24 hours)
- Error Log — configure which log categories are written to the database (HTTP errors, client errors, slow requests, server events)
- Boolean Display — custom True/False labels for data grid columns
- Announcement Banner — display a message banner at the top of the application for all users. More details
Retention tab:
- Audit Log Retention — how long change history is kept (default: 90 days). Table:
AuditLog - Approval Data Retention — how long resolved approval requests are kept (default: 1 year). Table:
ApprovalRequests - Error Log Retention — how long database error entries are kept (default: 30 days). Table:
ErrorLog - Staging Data Retention — how long processed staging import records are kept (default: 7 days). Table:
StagingImport. Only processed records are deleted — pending imports are never removed automatically - Scheduler Log Retention — how long scheduler dispatch events are kept (default: 30 days). Table:
SchedulerLog
Each retention card shows the database table name, a description of what data it controls, a number input with quick-select presets, and an orange cutoff banner showing the exact date before which records will be removed.
All retention settings are stored in the AppSettings database table. A SQL Server Agent job runs usp_Maintenance_Cleanup periodically, reads the configured retention values, and deletes expired records. See Data Retention for technical details.
Connection tab:
- Set the SQL Server hostname, instance name, database name, username, and password
- Click Test Connection to verify — shows live status (connecting, success, error) with server version on success
Email tab:
- Configure SMTP settings for outbound email (host, port, TLS, credentials, from address)
- Send a test email to verify your configuration
- Enable license expiry notifications with configurable thresholds and recipients
License tab:
- Enter and validate your license key
- Without a valid license, the application runs in read-only mode
API tab:
- API toggle — Global kill switch to enable or disable all external REST API access. When disabled, every API request returns
503 Service Unavailable - See API Keys for full details on managing API users and endpoints
Announcement Banner
Display a message banner at the top of the application for all users — useful for maintenance notices, company announcements, or important updates.
Access: Settings → General Settings → General tab → Announcement Banner
Configuration fields:
| Field | Description |
|---|---|
| Message | The text shown in the banner. Maximum 200 characters |
| Expire date | Optional. The banner automatically disappears after this date (end of day). Leave empty for no expiry |
| Color | Choose a preset (Red, Orange, Green) or enter a custom hex color. Each preset uses a matching icon: warning triangle for red/orange, checkmark for green, info circle for custom colors |
| Link URL | Optional. A URL to link to from the banner. Must start with http:// or https:// |
| Link text | Optional. The clickable link text shown next to the message (e.g. "Learn more") |
Color presets:
- Red — red background, warning triangle icon. Use for urgent alerts or outages
- Orange — orange background, warning triangle icon. Use for scheduled maintenance or important notices
- Green — green background, checkmark icon. Use for positive announcements or resolved incidents
A live preview is shown below the fields as you type, so you can see exactly how the banner will look before saving.
How it works:
- The banner appears as a 40px bar at the very top of the application, above the navigation
- All users see the banner when they open the application
- Users can dismiss the banner by clicking the × button. The dismissal is stored in the browser's local storage, so it stays dismissed for that user on that device
- If the message text changes, previously dismissed banners reset — all users see the new message
- When the expire date passes, the banner disappears automatically for everyone, regardless of dismissal state
- To remove the banner immediately, click Clear banner in the settings and save
Clearing the banner:
Click the Clear banner button in the Announcement Banner card to remove the message, expiry date, link, and color in one action. Save the settings to apply the change.