[Index]

Model: data/Settings

Settings

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

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:

• 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.

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:

• .cer
• .crt
• .der
• .gzip
• .json
• .key
• .pem
• .xlsx
• .xml
• .zip
• .png
• .jpg
• .jpeg
• .wav
• .csv
• .ico

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.

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:

$ 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
 }

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.

• 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.

File Upload Limitations

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)

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:

• Bulk Load
• JSON import
• Theme upload
• any other file upload activity

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

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

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 Feature Guide.

Data Sync Blacklist

Administrators with permissions to access the Global instance of the settings in the data/Settings model, can create a list of device attributes that will not trigger any update workflows that may have been defined to execute during the data sync. These attributes are here called Data Sync Blacklist attributes and are 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 blacklisted attributes only. Updating cache, skipping workflows."

A number of blacklisted attributes have been added by default:

Blacklisted ``device/ldap/user``

• For device/ldap/user:
  • logonCount
  • adminCount
  • lastLogonTimestamp
  • whenCreated
  • uSNCreated
  • badPasswordTime
  • pwdLastSet
  • lastLogon
  • whenChanged
  • badPwdCount
  • accountExpires
  • uSNChanged
  • lastLogoff
  • userPassword

Blacklisted ``device/cucm/User``

• For device/cucm/User:
  • status
  • primaryDevice
  • attendeesAccessCode
  • displayName
  • enableUserToHostConferenceNow
  • pinCredentials
  • passwordCredentials
  • associatedRemoteDestinationProfiles

Blacklisted ``device/cucm/Phone``

• For device/cucm/Phone:
  • keyOrder
  • elinGroup
  • ecKeySize

Blacklisted ``device/ldap/userProxy``

• For device/ldap/userProxy:
  • accountExpires
  • adminCount
  • badPasswordTime
  • badPwdCount
  • bind_dn
  • dSCorePropagationData
  • distinguishedName
  • employeeID
  • homeMDB
  • instanceType
  • lastLogon
  • lastLogoff
  • lastLogonTimestamp
  • legacyExchangeDN
  • logonCount
  • mDBUseDefaults
  • mailNickname
  • manager
  • msExchArchiveQuota
  • msExchArchiveWarnQuota
  • msExchBlockedSendersHash
  • msExchCalendarLoggingQuota
  • msExchDumpsterQuota
  • msExchDumpsterWarningQuota
  • msExchELCMailboxFlags
  • msExchHomeServerName
  • msExchMailboxGuid
  • msExchMailboxSecurityDescriptor
  • msExchMobileAllowedDeviceIDs
  • msExchMobileBlockedDeviceIDs
  • msExchMobileMailboxFlags
  • msExchPoliciesIncluded
  • msExchRBACPolicyLink
  • msExchRecipientDisplayType
  • msExchRecipientTypeDetails
  • msExchSafeSendersHash
  • msExchTextMessagingState
  • msExchUMDtmfMap
  • msExchUserAccountControl
  • msExchVersion
  • msExchWhenMailboxCreated
  • objectCategory
  • objectClass
  • objectGUID
  • objectSid
  • physicalDeliveryOfficeName
  • primaryGroupID
  • protocolSettings
  • proxyAddresses
  • pwdLastSet
  • sAMAccountType
  • showInAddressBook
  • textEncodedORAddress
  • uSNChanged
  • uSNCreated
  • userAccountControl
  • whenChanged
  • whenCreated
  • userPassword

Model Details: data/Settings