Skip to main content

System Settings

The System Settings section in OSPROV allows administrators to configure various aspects of the system, including appearance, security, workflow behavior, notifications, and more. This manual provides detailed information about each settings tab and how to configure them.

Accessing System Settings​

  1. Log in to OSPROV with an administrator account
  2. Navigate to Settings in the sidebar menu
  3. Select System Settings

Settings Tabs​

The System Settings are organized into six tabs:

  1. Appearance
  2. Security
  3. Workflow
  4. Notification
  5. Extras
  6. Help

Appearance Tab​

The Appearance tab allows you to customize the visual aspects of OSPROV, including branding, table settings, and sidebar configuration.

Organizational Branding​

  • Company Name: Enter your organization's name
  • Company Logo: Upload your organization's logo (will be resized to 100px width)
  • App Title: Set the title that appears in the browser tab and application header
  • Front Page Background Image: Upload an image to be displayed on the login page
  • Remove Custom Branding: Click this button to remove the logo and reset the company name
  • Show available systems at login page: When enabled, shows a list of available systems on the login page

Table Settings​

  • Disable column filter: When enabled, removes the column filtering functionality from tables throughout the application
  • Sidebar Configuration: A JSON editor for configuring the sidebar menu structure
    • This allows for customizing the navigation menu items, their order, and grouping

Security Tab​

The Security tab contains settings related to user access, permissions, and system security.

Security Policy​

  • Default Authorization Channel: Set the default authorization channel(s) for new users
  • Allow own submission approval: When enabled, users can approve their own submissions
  • Allow own submission review: When enabled, users can review their own submissions
  • Allow own submission processing: When enabled, users can process their own submissions
  • Restrict comment's attachment file type to images and pdf: When enabled, limits the file types that can be attached to comments
  • Session Timeout (in Minutes): Set how long user sessions remain active without activity (between 5 and 90 minutes)

Lockdown​

  • Maintenance mode: When enabled, only administrators can log in, and other users see a maintenance page

SSO Restriction​

  • Restrict by email domain(s): When enabled, only users with email addresses from specified domains can log in
  • Allowed Domain(s): Comma-separated list of allowed email domains

Workflow Tab​

The Workflow tab contains settings that control how workflows function in the system.

Workflow Settings​

  • Default Workflow Submission Name: Set the default naming pattern for new workflow submissions
  • After Completed Submission, go: Choose where users are redirected after completing a submission:
    • Back to Available Workflow: Returns to the workflow listing
    • To Submission View and Status: Shows the completed submission details
  • Masterdata evaluated to: Control how masterdata is evaluated in hooks and transforms:
    • Value: Use the stored value
    • Label: Use the display label
  • Allow multiple drafts for same workflow submission: When enabled, users can have multiple draft submissions for the same workflow
  • Enable enhanced pending status in listing: When enabled, shows more detailed pending status information in listings
  • Disable version control: When enabled, turns off version control for workflows and forms (use with caution)

Notification Tab​

The Notification tab contains settings for email notifications and system alerts.

Sendmail Settings​

  • Sendmail Type: Choose between OSPROV Default Sendmail or Custom Sendmail
  • Custom Sendmail Settings (visible when Custom Sendmail is selected):
    • Sendmail Host: SMTP server hostname
    • Sendmail Port: SMTP server port
    • Sendmail Username: SMTP username (also used as the "from" address)
    • Sendmail Password: SMTP password
    • Encryption Type: Choose between none, TLS, or SSL
    • Mail From Name: Name to display as the sender

Notification Settings​

For each of the following notification types, you can enable/disable notifications and select an email template:

  • Rejected Submission: Notifications when submissions are rejected
  • Reverted Submission: Notifications when submissions are reverted to a previous step
  • Delegated Submission: Notifications when tasks are delegated to other users
  • Comments Received: Notifications when comments are added to submissions
  • Submission Open for Editing: Notifications when submissions are opened for editing
  • Submission Updated: Notifications when submissions are updated after editing

Extras Tab​

The Extras tab contains additional settings for extended functionality.

OpenAI Integration​

  • OpenAI API Token: Enter your OpenAI API token to enable AI features in OSPROV

Help Tab​

The Help tab allows you to configure support resources for users.

Help Settings​

  • Support Label: Text to display for the support link
  • Support Link: URL to your organization's support system or helpdesk
  • User Manual: Upload a PDF document that will serve as the user manual
  • View Current User Manual: Link to view the currently uploaded user manual

Saving Settings​

After making changes to any settings tab:

  1. Click the Save button at the bottom of the page
  2. You will see a confirmation message if the settings were saved successfully
  3. Some settings may require a page refresh or system restart to take effect

Best Practices​

  1. Document Changes: Keep a record of significant settings changes
  2. Test After Changes: Verify that the system works as expected after changing settings
  3. Backup Before Major Changes: Consider backing up the database before making major configuration changes
  4. Review Regularly: Periodically review settings to ensure they still meet your organization's needs
  5. Limit Access: Only give system settings access to trusted administrators

By properly configuring the System Settings, you can customize OSPROV to match your organization's branding, security requirements, and workflow processes.