Skip to main content
System StatusContact Support
VersionOne Community

Configuration Reference

Overview 

List of configuration reference resources.

References

License

Configuration section for managing the License Key.

License

Enter the provided license key for this installation.

Flow

Settings for the 'Flow' module.

Instance Canvas

Override the default 'dashboard' on the Pipeline Instance page.

Project Canvas

Override the default 'dashboard' on the Project Summary page.

Home Canvas

Canvas to display on the Flow UI - /home URL

First Page

The name of a specific 'first page' to show when entering the Flow UI. 'Projects', 'Approvals', 'Pipelines' or 'Home'. (default: Home) Projects and Pipelines can also have a tab specified by using a colon. Ex. 'Projects:Status'

System

Global system configuration items and other settings not specific to any other category.

Default Time Zone

Default time zone for all users (users can override this time zone in My Account)

Config File Setting: default_time_zone

MessageHub Debug

Set the debug level of the process. (10=DEBUG, 20=INFO, 30=WARNING, 40=ERROR, 50=CRITICAL)

Data Type: integer

Config File Setting: msghub_debug

MessageHub URL (External)

Force all generated URLs to use the specified value.

Config File Setting: msghub_external_url

LDAP/AD Port

LDAP/AD service port

Data Type: integer

Config File Setting: ldap_port

Repo Poller Debug

Set the debug level of the process. (10=DEBUG, 20=INFO, 30=WARNING, 40=ERROR, 50=CRITICAL)

Data Type: integer

Config File Setting: repopoller_debug

UI SSL Key

SSL Certificate to use for the UI.

Config File Setting: ui_ssl_key

LDAP/AD Server

LDAP/AD Server for User Authentication

Config File Setting: ldap_server

UI URL (External)

Force all generated URLs to use the specified value.

Config File Setting: ui_external_url

Canvas Temp Directory

Canvas temporary directory for file uploads.

Config File Setting: dash_api_tmpdir

Canvas Repository Directory

Canvas filesystem repository directory.

Config File Setting: report_store

Metrics Engine Debug

Set the debug level of the process. (10=DEBUG, 20=INFO, 30=WARNING, 40=ERROR, 50=CRITICAL)

Data Type: integer

Config File Setting: metrics_debug

MessageHub Port

Run on the specified TCP port.

Config File Setting: msghub_port

UI Home Canvas

Canvas to display on the main UI - /home URL.

Config File Setting: ui_home_canvas

UI SSL

Run the UI in secure (https) mode?

Config File Setting: ui_use_ssl

Canvas Index (POST)

Default page for Canvas when no page is specified.

Config File Setting: dash_api_post_index

Canvas Index (GET)

Default page for Canvas when no page is specified.

Config File Setting: dash_api_get_index

UI Port

Run on the specified TCP port.

Config File Setting: ui_port

UI Debug

Set the debug level of the process. (10=DEBUG, 20=INFO, 30=WARNING, 40=ERROR, 50=CRITICAL)

Data Type: integer

Config File Setting: ui_debug

Rest API Basic Authentication

Allow 'basic' authentication to the Rest API.

Config File Setting: rest_api_enable_basicauth

Rest API Allowed Origins

Comma-separated list of origins allowed to access the API.

Config File Setting: rest_api_allowed_origins

Deploy UI Refresh?

The Deploy UI uses page refresh to keep content current. (Disable for troubleshooting.)

Config File Setting: deploy_ui_enable_refresh

UI Token Authentication

Allow user token authentication to the UI.

Config File Setting: ui_enable_tokenauth

MessageHub Enabled

Config File Setting: msghub_enabled

UI Menu Canvas

One or more name:path; entries to Canvas resources. Appear as a 'Custom Pages' link in the Main UI right-side menu.

Config File Setting: ui_menu_canvas

JobHandler Debug

Set the debug level of the process. (10=DEBUG, 20=INFO, 30=WARNING, 40=ERROR, 50=CRITICAL)

Data Type: integer

Config File Setting: jobhandler_debug

UI SSL Certificate

SSL Certificate to use for the UI.

Config File Setting: ui_ssl_cert

LDAP/AD SSL?

Use SSL for the LDAP/AD connection?

Config File Setting: ldap_ssl

MessageHub SSL

Run the MessageHub in secure (wss) mode?

Config File Setting: msghub_use_ssl

Access Control

If unchecked, access control via 'Tags' is disabled, and all users will have read access to all objects.(Applies to the UI and API.)

Config File Setting: ui_permissions

Marshaller

The 'Deploy Marshaller' is the service that handles running of Deployment Sequences.

Debug

Set the debug level of the process. (10=DEBUG, 20=INFO, 30=WARNING, 40=ERROR, 50=CRITICAL)

Loop Delay

How often does the Marshaller check for work?

Data Type: integer

Enabled

Enable or Disable the Marshaller

Messenger

The Messenger service is responsible for sending email notifications.

SMTP Connection Timeout

Timeout (in seconds) to wait before giving up trying to connect.

Data Type: integer

SMTP User Account

User account for the SMTP server if authentication is required.

Poll Loop

How often (in seconds) to poll for new emails queued for sending.

Data Type: integer

Enabled

Enable or Disable the Service.

Retry Delay

Delay (in seconds) to wait before retrying a failed send.

Data Type: integer

Retry Max Attempts

Number of times to retry sending when errors are encountered before giving up.

Data Type: integer

Administrative Emails

A list of users who will receive system status and warning information.

From Email

The email address any messages will appear 'From'

SMTP User Password

User password for the SMTP server if authentication is required.

From Name

The name any messages will appear 'From'

SMTP Server Port

Port number of the SMTP server.

Data Type: integer

Use Legacy SSL

Use legacy SSL connections. (uncommon)

SMTP Server Address

Address of the SMTP server.

Scheduler

The 'Automate Scheduler' takes care of scheduling and queing Automate Tasks.

Clean App Registry

Interval for removing defunct processes from the System Status table.

Data Type: integer

Schedule Minimum Depth

How deep to build the future schedule queue.

Data Type: integer

Enabled

Enable or Disable the Service.

Loop Delay

Number of seconds to sleep between queue checks.

Data Type: integer

Schedule Max Days

Maximum number of days into the future to build the schedule queue.

Data Type: integer

Debug

Set the debug level of the process. (10=DEBUG, 20=INFO, 30=WARNING, 40=ERROR, 50=CRITICAL)

Security

Security Policy and settings for the application.

Allow Users to Log In?

Uncheck to temporarily disallow logging in, for system maintenance, etc.

Verbose Page View Logging

Enable for debug/audit purposes. Writes a Security Log entry for every page access by every user.

Password Minimum Length

__

Data Type: integer

New User Welcome Email

The body of an email sent to new user accounts.

Password Maximum Age

__

Data Type: integer

Password Age Warning Days

Number of days before expiration to begin warning the user about password expiration.

Data Type: integer

Login Message

__

Password Maximum Length

__

Data Type: integer

Authentication Error Message

A customized message that appears when there are failed login attempts.

Password History

The number of historical passwords to cache and prevent reuse.

Data Type: integer

Auto Lock Reset

The number of minutes before failed password lockout expires.

Data Type: integer

Complex Password?

Require 'complex' passwords? (numbers and special character)

Password Maximum Attempts

__

Data Type: integer

Poller

The 'Automate Poller' is responsible for monitoring the queue and starting Automate Tasks.

Loop Delay

Number of seconds to sleep between queue checks.

Data Type: integer

Debug

Set the debug level of the process. (10=DEBUG, 20=INFO, 30=WARNING, 40=ERROR, 50=CRITICAL)

Enabled

Enable or Disable the Service.

Concurrent Instances

Maximum number of simultaneously running Task Engine processes.

Data Type: integer

  • Was this article helpful?