This topic describes the system level settings configurable via the Settings page, where a sysadmin user with access to the data/Settings model can view and modify the following global system level settings for Automate:

System transaction log levels refer to the configured verbosity level of the transaction logs in Automate. Available transaction log levels for Automate are as follows:

The following Automate admin users can view and modify transaction log levels in Automate:

Users with system administrator privileges to the data/Settings model, typically, sysadmin, can manage valid file extensions in Automate.

By default, the following file extensions are specified as supported in the Global instance of data/Settings, which means that files with these extensions can be uploaded to Automate.

The sysadmin user can add or remove file extensions. Unsupported files can't be uploaded or imported, and will trigger a system error.

Users with system administrator privileges to the data/Settings model, typically, sysadmin, can enable or disable device logging.

When setting Disable Device Logging to enabled (on the Settings page). then CUCM AXL (and other external calls) requests and responses aren't written to the transaction log, and neither are generic driver requests, responses, template evaluations, and macro evaluations. These details won't display for the relevant transactions under Administration Tools > Transaction Log.

High level admins (sysadmin) with access to the data/Settings model (default menus, Administration Menu > Settings) can view and update the Activate Phone Status Service checkbox, which is enabled by default.

When enabled, this setting indicates that the real-time information (RIS) data collector service is enabled and is polling the CUCM to obtain the latest phone registration status information for phone instances stored in the Automate database. The polling default interval is 43200 seconds (12 hours).

For details, see the System Monitoring Configuration (Metrics Collection) topic in the Advanced Configuration Guide.

However, When viewing a list of phones, the status action can be carried out by an administrator who has been assigned a role that has an access profile to enable this action. By default, an administrator above provider level can carry out this task from the Role Management > Access Profiles menu - in this case, for relation/SubscriberPhone.

Carrying out this operation fetches the Unified CM phone IP address and status directly from the Unified CM and displays the data on the Phones list view Registration Status and IP Address columns, updating any existing data shown.

When clearing or enabling the check box on data/Settings, log in on the platform command line interface (CLI) and restart the service:

Phone Status Service in the Logs

When clearing this setting and then restarting the (RIS) data collector service, an app.log entry will show: "message":"RIS API service disabled".

Refer to the Platform Guide for commands to inspect log files.

Example log entry below (line breaks added):

2020-03-26T20:06:00.346577+00:00 VOSS-UN-2 deviceapi.background.risapi INFO
 {"process_id":24,
  "hostname":"VOSS-UN-2-voss-risapi-collector",
  "name":"deviceapi.background.risapi",
  "level":"INFO",
  "utc_iso_timestamp":"2020-03-26T22:06:00.346268",
  "request_uuid":null,
  "user_hierarchy":null,
  "user":null,
  "message":"RIS API service disabled",
  "line":330,
  "parent_process_id":1
 }

Additional Role Access Profile Validation

High level admins (sysadmin) with access to the data/Settings model (default menus, Administration Menu > Settings) can view and update the Additional Role Access Profile Validation setting to manage the available roles when an administrator creates access profiles.

The table describes how the system works when the Additional Role Access Profile Validation setting is enabled or disabled:

Enabled

An admin can only assign a role to a user if it is linked to an access profile with permissions that are in the subset of the admin's own access profile. Role drop-down lists will therefore be restricted.

If the macro function fn.filter_roles_by_user_access_profile is used, the setting needs to be enabled for roles to be filtered.

This validation check also applies when admins manage multi-role admin users - where the role is associated with an Authorized Admin Hierarchy.

Disabled

(Default) An admin can assign any role to a user, regardless of the admins own access profile. Role drop-down lists will therefore not be restricted.

If the macro function fn.filter_roles_by_user_access_profile is used, the roles will not be filtered.

This validation check also applies when administrators manage multi-role admin users - where the role is associated with an Authorized Admin Hierarchy.

Note

See the macro topic Filter Role Functions for details on the use of the fn.filter_roles_by_user_access_profile function.

File Upload Limitations

High level admins (sysadmin) with access to the data/Settings model (default menus, Administration Menu > Settings) can view and update file upload size limitations and file time to live on the database.

By default, the following file limitations apply:

Maximum Upload File Size: 209715200 bytes (200MB)
Time-To-Live for Uploaded Files: 24 (clean up every 24 hours)

Note

Extending the Maximum Upload File Size to greater than the default can impact the platform system operation.
The minimum setting for time-to-live hours is 1 hour

Files are uploaded to the system database during activities such as:

Bulk Load
JSON import
Theme upload
Any other file upload activity, excluding:
- Themes
- SSO certificates
- SSO service provider metadata
- Audio files (MoH)

The time-to-live value applies to uploaded files that have not been used, in other words, imported or processed. By default, a check is done every 24 hours for such files, after which time they are removed.

Time-To-Live for Uploaded Files

High level admins (sysadmin) with access to the data/Settings model (default menus, Administration Menu > Settings) can view and update the time-to-live for uploaded files.

Note

Files uploaded from file management menus on the Automate GUI and listed as instances of data/File are not affected.

Uploaded bulk load files and imported JSON files are affected; however:

For bulk load files, the file is kept for as long as there is an instance of data/BulkLoad attached to it. So a schedule that is more than 24 hours in the future is not impacted, because when we schedule a bulk load for the future, we create a data/BulkLoad instance. The instance is cleared when the bulk load is executed.
Monthly license reports that are uploaded to the database by the internal schedule are not removed. For more details, refer to the License Guide.

Data Sync Workflow Execution Control

High level admins (sysadmin) with access to the data/Settings model (default menus, Administration Menu > Settings) can view and update lists of device attributes affected by data sync in the Data Sync Workflow Execution Control settings (allowlist and denylist attributes):

List	Description
Allowlist Attributes	When this list contains a field, then only a change in that field and not any other field will trigger data sync workflows, regardless of the list of the Denylist Attributes. In other words, this list takes precedence over the existing list of Denylist Attributes.
Denylist Attributes	Items in this list will not trigger any update workflows that may have been defined to execute during the data sync. These attributes are therefore excluded from data sync considerations. The reason for this list of attributes is that while data sync operations can have a performance impact, some data sync attribute changes do not require data sync workflows to be carried out. Note however that the local device cache will still be updated with the updated attribute data. No update workflows will be run, though. The transaction logs will indicate the updated device cache, but the transactions for these attributes instances will show as: Device changes on denylisted attributes only. Updating cache, skipping workflows.

List

Description

Allowlist Attributes

When this list contains a field, then only a change in that field and not any other field will trigger data sync workflows, regardless of the list of the Denylist Attributes. In other words, this list takes precedence over the existing list of Denylist Attributes.

Denylist Attributes

Items in this list will not trigger any update workflows that may have been defined to execute during the data sync. These attributes are therefore excluded from data sync considerations.

The reason for this list of attributes is that while data sync operations can have a performance impact, some data sync attribute changes do not require data sync workflows to be carried out.

Note however that the local device cache will still be updated with the updated attribute data. No update workflows will be run, though. The transaction logs will indicate the updated device cache, but the transactions for these attributes instances will show as:

Device changes on denylisted attributes only. Updating cache, skipping workflows.

Related Topics

Allowlists and Denylists in the Core Feature Guide.

Microsoft Sync Overview in the Best Practices Guide.

Device Overwrite Check Exemptions

High level admin users (sysadmin) with permissions to access the Global instance of the settings in the data/Settings model can create a list of fields to be excluded from device overwrite checking.

This means that if the field changes on the device, it will not be overwritten by data in VOSS Automate. The most common situation where this might be necessary is where a device field changes, but does not affect the data on VOSS Automate, because the data is treated as read only in VOSS Automate.

Enable Wingman Chat

By default, Enable Wingman Chat is enabled, and the Wingman icon displays on the Admin Portal toolbar, if the user role is associated with an access profile that has Wingman Chat enabled under the Miscellaneous Permissions.

Refer to the VOSS Wingman topic in the Core Feature Guide.

Wingman Web Proxy

High level admin users (sysadmin) with permissions to access the Global instance of the settings in the data/Settings model (default menus, Administration Menu > Settings) can select a Web Proxy name that has been added as an instance on the Web Proxy menu and which will be used by VOSS Wingman on environments that require web proxy access to the internet.

Refer to:

"Set up a Web Proxy" in the Core Feature Guide.

VOSS Wingman in the Core Feature Guide.

File Extensions

For users with system administrator privileges to the data/Settings model, the valid file extensions can be managed.

By default, the following file extensions are in the Global instance of this model and are valid. This means that files with this extension can be uploaded to VOSS Automate:

File extensions can be added or removed by this administrator. Files that do not have an extension that corresponds with an instance in this model, cannot be loaded or imported. An error message will display on the user interface to indicate that the file does not have a valid file extension.

Disable Device Logging

For users that have access to the data/Settings model, device logging can be managed.

If the Disable Device Logging check box is enabled, Unified CM AXL (and other external calls) requests and responses are not written to the transaction log. Generic driver requests, responses, template evaluations and macro evaluations are also not written to the transaction log.

These details will then not be shown for the relevant transactions under Administration Tools > Transaction Log.

Activate Phone Status Service

System administrators with access to data/Settings can see the Activate Phone Status Service check box that is enabled by default. This indicates that the real-time information (RIS) data collector service is enabled and is polling the Unified CM to obtain the latest phone registration status information for phone instances stored in the VOSS Automate database. The polling default interval is: 43200 seconds (12 hours).

For details, refer to the Metrics Collection topic in the Advanced Configuration Guide.

When clearing or enabling the check box on data/Settings, log in on the platform command line interface (CLI) and restart the service:

When clearing this setting and then restarting the (RIS) data collector service, an app.log entry will show: "message":"RIS API service disabled".

Additional Role Access Profile Validation

For users with system administrator privileges to the data/Settings model, a setting called Additional Role Access Profile Validation is available as a check box to manage the available roles when an administrator creates Access Profiles.

Refer to the macro topic Filter Role Functions for details on the use of the fn.filter_roles_by_user_access_profile function.

File Upload Limitations

For users with permissions to the Global instance of the data/Settings datamodel, the upload file size and its time-to-live on the database can be configured.

Time-To-Live for Uploaded Files

For users with system administrator privileges to the data/Settings model, the time-to-live for uploaded files can be managed.

Data Sync Allowlist and Denylist

Administrators with permissions to access the Global instance of the settings in the data/Settings model (sysadmin), can create lists of device attributes affected by data sync under the Data Sync Workflow Execution Control section:

From release 24.1, the following allowlist model attributes have been added and the previous denylist has been removed:

From release 21.4-PB2, the following allowlist model attributes have been added:

Model Details: data/Settings

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title				Description	Details
Name					Field Name: name Type: String
Transaction Log Level					Field Name: transaction_log_level Type: Integer Choices: ["Debug", "Verbose", "Info", "Warning", "Error", "Disabled"]
	Supported File Extensions			List of supported file extensions for upload	Field Name: supported_file_extensions.[n] Type: Array
Disable Device Logging				Turn off detailed logging of device APIs	Field Name: disable_device_logging Type: Boolean
Activate Phone Status Service				Activate service to periodically fetch Call Manager phone status	Field Name: activate_phone_status_service Type: Boolean
Additional Role Access Profile Validation				Enable additional role access profile validation	Field Name: additional_role_access_profile_validation Type: Boolean
Maximum Upload File Size				Maximum file size (in bytes) of an upload file. Default size is 209715200 bytes (200 megabytes). Default: 209715200	Field Name: maximum_upload_file_size Type: Integer Default: 209715200
Time-To-Live for Uploaded Files				Limits the lifespan (in hours) of an uploaded file in the database. Default value is 24 hours. Default: 24	Field Name: upload_files_ttl Type: Integer Minimum: 1 Default: 24
	Data Sync Workflow Execution Control			Controls the execution of data sync workflows with allow and deny lists.	Field Name: data_sync_blacklist.[n] Type: Array
		Model Type		Model type to control data sync workflow execution for.	Field Name: data_sync_blacklist.[n].model_type Type: String Format: uri
			Denylist Attributes	These are attributes that will not trigger workflow execution if their values change. This list will be ignored if allowlist attributes are set.	Field Name: blacklist_attributes.[n] Type: Array
			Allowlist Attributes	These attributes will trigger workflow execution if their values change. Attributes not in this list will not trigger workflow execution even if their values change. Takes precedence over denylist attributes.	Field Name: allowlist_attributes.[n] Type: Array
	Device Overwrite Check Exemptions			These attributes will never be checked by the device overwrite feature.	Field Name: device_overwrite_check_exemptions.[n] Type: Array
		Model Type		Exempt certain attributes of this model type from device overwrite checking.	Field Name: device_overwrite_check_exemptions.[n].model_type Type: String Format: uri
			Attributes	Exempt these attributes from device overwrite checking.	Field Name: exempt_attributes.[n] Type: Array
Enable Wingman Chat				Enable the Wingman Chat Feature Default: True	Field Name: enable_copilot_chat Type: Boolean Default: True
Wingman Web Proxy				Name of the Web Proxy to be used for Wingman requests.	Field Name: wingman_web_proxy Type: String Target: data/WebProxy Format: uri

Model: data/Settings

Settings

Phone Status Service in the Logs

File Extensions

Disable Device Logging

Activate Phone Status Service

Additional Role Access Profile Validation

File Upload Limitations

Time-To-Live for Uploaded Files

Data Sync Allowlist and Denylist

Model Details: data/Settings