Digital.ai APIs and client tools

License

Configuration section for managing the License Key.

License

Enter the provided license key for this installation.

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.

From Name

The name any messages will appear 'From'

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.

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.

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.

Server

Agility Connect Server URL to which Poller/Task Engine will communicate.

Security

Security Policy and settings for the application.

Verbose Page View Logging

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

Password Minimum Length

Minumum allowed length for a valid password.

• Data Type: integer

New User Welcome Email

The body of an email sent to new user accounts.

Password Maximum Age

Maximum age a password will be allowed. Changing this setting will force a user to change their password immediately if their current password is older than the new Max age.

• Data Type: integer

Login Message

A message to display on the Login page.

Password Age Warning Days

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

• Data Type: integer

Password Maximum Length

Maximum allowed length for a password.

• 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

Maximum number of failed login attempts allowed before locking the account.

• Data Type: integer

SSO

Settings for the 'SSO' module.

Inbound Webhooks Debug

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

• Data Type: integer

System

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

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

Core Service Debug

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

• Data Type: integer
• Config File Setting: core_debug

MessageHub Bind Address

Bind the Agility Connect MessageHub to a local address, overrides 0.0.0.0

• Config File Setting: msghub_bind_address

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

MessageHub Port

Run on the specified TCP port.

• Config File Setting: msghub_port

Message History

Number of days of email message queue history to keep.

• Data Type: integer
• Config File Setting: message_history

Share Usage Statistics

Share usage statistics with Digital.ai?

• Config File Setting: usage_sharing

Core Service Loop

Loop timer for the Core service.

• Data Type: integer
• Config File Setting: core_loop

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

Agility Connect DataSync Debug

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

• Data Type: integer
• Config File Setting: echo_datasync_debug

Rest API Allowed Origins

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

• Config File Setting: rest_api_allowed_origins

Enable External Downloads

Allow browsers to request external resources to improve performance?

• Config File Setting: enable_external_downloads

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

UI SSL

Run the UI in secure (https) mode?

• Config File Setting: ui_use_ssl

Service Logs History

Number of days of services logs to keep.

• Data Type: integer
• Config File Setting: service_logs_history

Single Server Database Logging

Centralized logging to the database is disabled when 'Single Server Mode' is true. Setting this 'true' explicitly ENABLES database logging in a single-server configuration. While there are benefits in log management, there is a small performance impact.

• Config File Setting: single_server_mode_db_logging

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

UI Bind Address

Bind the Agility Connect UI to a local address, overrides 0.0.0.0

• Config File Setting: ui_bind_address

Canvas Allowed Origins

Comma-separated list of origins allowed to access Canvas resources.

• Config File Setting: dash_api_allowed_origins

LDAP/AD SSL?

Use SSL for the LDAP/AD connection?

• Config File Setting: ldap_ssl

Single Server Mode

All work will execute on the main server instead of one or more configured 'worker' servers.

• Config File Setting: single_server_mode

Core Service Enabled

• Config File Setting: core_enabled

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

Rest API Basic Authentication

Allow 'basic' authentication to the Rest API.

• Config File Setting: rest_api_enable_basicauth

UI Token Authentication

Allow user token authentication to the UI.

• Config File Setting: ui_enable_tokenauth

UI SSL Certificate

SSL Certificate to use for the UI.

• Config File Setting: ui_ssl_cert