[Index]
For users that have access to the data/Settings model or view/DataSettings, the global levels of logging can be managed.
This level will affect the Log block of messages at the bottom of a selected transaction on the Transaction interface and does not for example affect the transaction or sub transaction Action and Detail information.
Log levels are cumulative, in other words, more detailed levels include all details from less detailed levels. The levels includes messages and have severity values as follows:
| Level | Description | Severity |
|---|---|---|
| Disabled | disables all transaction log messages | 999 |
| Error | only displays error messages | 40 |
| Warning | also adds warning messages to above | 30 |
| Info | also adds informational messages to above | 20 |
| Verbose | also adds messages used for diagnostic purposes to above | 15 |
| Debug | also adds advanced diagnostic messages - for future use | 10 |
The Severity values are referenced (from value - to value) in transaction details when the log level is changed on this setting or changed by lower level administrators from the System Settings menu. See: Manage System Settings.
If a transaction fails, the Log block will include all entries with severity values larger than that of the default or selected level of logging.
The log levels of data syncs can be set to override these global levels.
The transaction log level used for data sync and its immediate sub-transactions is by default set to Warning when it is not set.
For details, refer to the Create a Custom Data Sync topic in the Core Feature Guide.
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.
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.
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.
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.
Important
Since the result of the status action is in real time, the current status of the list requires that the action carried out in order to see the latest values.
There is no caching of data resulting from this action. If any values show in the columns before carrying out this action, these would not be current, but are the cached values from the RIS data collector if it is enabled.
When carrying out the status action, the data in the Registration Status and IP Address columns can only be viewed.:
Note
When clearing or enabling the check box on data/Settings, log in on the platform command line interface (CLI) and restart the service:
$ cluster run application app start voss-risapi_collector
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
}
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.
When the Additional Role Access Profile Validation check box is enabled:
An administrator 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 administrator'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 administrators manage multi-role admin users - where the role is associated with an Authorized Admin Hierarchy.
When the Additional Role Access Profile Validation check box is disabled:
An administrator can assign any role to a user, regardless of the administrator's 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.
By default, the Additional Role Access Profile Validation is disabled.
Refer to the macro topic Filter Role Functions for details on the use of the fn.filter_roles_by_user_access_profile function.
By default, the following file limitations apply:
Note
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.
Files are uploaded to the system database during such activities as:
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.
For users with system administrator privileges to the data/Settings model, the time-to-live for uploaded files can be managed.
Note
Files that are uploaded from file management menus on the user interface and listed as instances of data/File are not affected.
Uploaded Bulk Load files and imported JSON files are affected, however:
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:
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.
Refer to the allow lists below.
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."
Note
After release 20.1.1 or applying patch EKB-4362-19.2.1_patch, the previously denylisted LDAP attributes are no longer imported during LDAP synchronization:
For device/ldap/user:
Refer to the deny lists below.
From release 21.4-PB2, the following allowlist model attributes have been added:
Allowlist ``device/msteamsonline/CsOnlineUser``
Allowlist ``device/msgraph/MsolUser``
A number of denylist attributes have been added by default:
Denylist ``device/ldap/user``
Denylist ``device/cucm/User``
Denylist ``device/cucm/Phone``
Denylist ``device/ldap/userProxy``
Related Topics
Allowlists and Denylists in the Core Feature Guide.
Microsoft Sync Overview in the Best Practices Guide.
| Title | Description | Details | |||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Name |
|
||||||||||||||||||||||||||||||||||||||||||||||||
| Transaction Log Level |
|
||||||||||||||||||||||||||||||||||||||||||||||||
| Supported File Extensions | List of supported file extensions for upload |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Disable Device Logging | Turn off detailed logging of device APIs |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Activate Phone Status Service | Activate service to periodically fetch Call Manager phone status |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Additional Role Access Profile Validation | Enable additional role access profile validation |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Maximum Upload File Size | Maximum file size (in bytes) of an upload file. Default size is 209715200 bytes (200 megabytes). 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 |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Data Sync Workflow Execution Control | Controls the execution of data sync workflows with allow and deny lists. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Model Type | Model type to control data sync workflow execution for. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| 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. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| 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. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Device Overwrite Check Exemptions | These attributes will never be checked by the device overwrite feature. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Model Type | Exempt certain attributes of this model type from device overwrite checking. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
| Attributes | Exempt these attributes from device overwrite checking. |
|
|||||||||||||||||||||||||||||||||||||||||||||||