Managing System Configurations
Learn how to configure system attributes like: Device Custom Attribute Label, Mails, SetClock, System, etc.
The system configuration feature provides a user interface to manage various configurations that compose the system and its boundary. This feature provides a graphical interface for managing the system related configurations.
To configure the system:
- Go to Administration > Estate Administration > System Configuration.
- Select a configurable value in Category drop-down.
The below table lists the category attribute with description:
|
Category |
Description |
|
Device Custom Attribute Label |
Indicates the attribute labels created by users manually. The user can create maximum five custom attributes. |
|
Mails |
Indicates the e-mail configuration settings. |
|
Scheduler |
Indicates the schedule settings for actions, downloads etc. |
|
Schedules and Timers |
Indicates the schedule and time settings for different windows services. |
|
Security |
Indicates the security settings for the VHQ application. |
|
Set Clock |
Indicates the timestamp value, which the server instructs the device to set in the device. This value is generated by the server for the agent to set. |
|
Setup |
Indicates the location settings for different types of logs. |
|
System |
Indicates the system and application level settings. |
Device Custom Attribute Label Configuration
The custom fields allow you to add your own values. You can configure each of the custom field by changing the values. Editing the custom field allows you to change its Name (label).
To configure DeviceCustomAttributeLabel:
1. Go to Administration > Estate Administration > System Configuration.
2. Select Device Custom Attribute Label from the Category drop-down.
3. Click
to edit the custom field value.
4. Enter the field name and click Save.
Mails Configuration
You can configure mail values in the system.
To configure mails:
1. Go to Administration > Estate Administration > System Configuration.
2. Select Mails from the Category drop-down.
- Select the config name and click to edit.
- Enter the config value and click
. - Click
to restore the default value.
| Config Name | Description |
| SMTP Host Name | Indicates the mail server host name used by the modules of VHQ. |
| Sender Mail Address | Indicates e-mail address of the sender. |
| Mail Server Name | Indicates configured mail server name. |
| GUI URL | Indicates the URL of the application displayed in the mail. |
| Support Mail Address | Indicates the VHQ support teams e-mail ID displayed in the mail. |
| Password Redirect URL | Indicates the password reset URL displayed in the mail. |
NOTE:
The following are the configurations specific to AWS Server users:
- SMTP Enable Authentication
- SMTP Username
- SMTP Password
- SMTP Enable SSL
- SMTP Port
Scheduler Configuration
You can configure the scheduler in the system.
To configure scheduler:
1. Go to Administration > Estate Administration > System Configuration.
2. Select Scheduler from the Category dropdown.
- Select the config name and click to edit.
- Enter the config value and click .
- Click to restore the default value.
| Config Name | Description |
| Slot Scheduling Poll Timer | Indicates the poll timer configured to invoke the Slot Scheduling Service. The value is in minutes and must be in the range 1-5. |
| Average HeartBeat Frequency | Indicates the average heart beat frequency. The value is in minutes and must be in the range 15-1440. |
| Free Time slot Search Timeout | Indicates the number of days to search for available free time slots, if no end date is selected during manual software schedule. |
Schedules and Timers Configuration
You can configure schedules and timers in the system.
To configure schedules and timers:
1. Go to Administration > Estate Administration > System Configuration.
2. Select Schedules and Timers from the Category drop-down.
- Select the config name and click to edit.
- Enter the config value and click .
- Click to restore the default value.
| Config Name | Description |
| Alert Generation Poll Timer | Indicates the poll time configuration for generating alerts. The value is in minutes and must be in the range 5-1440. |
| Mail Notification Poll Timer | Indicates the poll time configuration for mail notification. The value is in minutes and must be in the range 5-1440. |
| Server Event Generation Poll Timer | Indicates the poll time configuration for generating server events. The value is in minutes and must be in the range 5-1440. |
| Common Mail Generation Poll Timer | Indicates the poll time configuration for common mail processing. The value is in minutes and must be in the range 5-1440. |
| Low Alerts Mail Generation Time | Indicates the scheduled time for generating low alerts mail. |
| Maximum Daily Recurrence for Scheduling | Indicates the maximum number of occurrences allowed daily. The value must be in the range 30-365. |
| Maximum Weekly Recurrence for Scheduling | Indicates the maximum number of occurrences allowed weekly. The value must be in the range 4-52. |
| Maximum Monthly Recurrence for Scheduling | Indicates maximum number of occurrences allowed monthly. The value must be in the range 1-12. |
| Maximum Hourly Recurrence for Scheduling | Indicates the maximum number of occurrences allowed hourly. The value must be in the range 1-24. |
Security Configuration
You can configure the security in the system.
To configure security:
- Go to Administration > Estate Administration > System Configuration.
- Select Security from the Category drop-down.
- Select the config name and click to edit.
- Enter the config value and click .
- Click to restore the default value.
| Config Name | Description |
| Password Policy Note | Indicates the rules to set a password on the VHQ system. |
| Password Pattern | Indicates the VHQ password policy for user passwords. |
| Failed Login Delay | Indicates the time limit to log in after account locked. The invalid login limit has crossed. The value is in minutes and must be in the range 5-1440. |
| Failed Login Count | Indicates number of attempts allowed to try login before temporary lock out. The value must be in the range 3-20. |
| Maximum number of User Passwords Retained | Indicates the maximum number of passwords to be retained by every user to validate during password change. |
| Temporary Password Expiry Period | Indicates the number of days beyond which the temporary password expires. |
| Minimum Password Age to change | Indicates the number of days when the user can use the password before changing the password. |
| Maximum Password Age for Expiry | Indicates the maximum number of days beyond which the user password expires. |
| Notify User of Password Expiry | Indicates the number of days before which the user must be notified of the password expiration. |
NOTE: All policies will work based on the configurations. The customer has to get in touch with the VHQ Support to enable the password policies.
Set Clock Configuration
You can synchronize device clocks with the server. Device setting the clock gives more accurate time.
To configure SetClock:
1. Go to Administration > Estate Administration > System Configuration.
2. Select Set Clock from the Category drop-down.
3. Click Yes or No to synchronize device clocks.
- Click Save to confirm the changes.
Setup Configuration
You can configure the setup in the system.
To configure setup:
1. Go to Administration > Estate Administration > System Configuration.
2. Select Setup from the Category drop-down.
- Select the config name and click to edit.
- Enter the config value and click .
- Click to restore the default value.
| Config Name | Description |
| Import Logs Folder | Indicates the server folder location for import logs. |
| Import Logs URL | Indicates the import logs URL. |
| Device Uploaded Files Folder | Indicates the location to store the files uploaded from the device. |
| Device Uploaded Files URL | Indicates the device uploaded file URL. |
| VRK Certificate Files Folder | Indicates the location that stores the VRK Certificate uploaded from the device. |
System Configuration
You can configure the system.
To configure system:
1. Go to Administration > Estate Administration > System Configuration.
2. Select System from the Category drop-down.
- Select the config name and click to edit.
- Enter the config value and click .
- Click to restore the default value.
| Config Name | Description |
| Allow VHQ system to Send Out Mails | Indicates configuration of the VHQ system for sending mails. |
| Allow Device Registration | Indicates the automatic configuration of the device, if the device configuration is not found during registration. |
| GUI Idle Timeout | Indicates, if there is no user activity, the GUI automatically logs out the user after <Configurable> value. The value is in minutes and must be in the range 30-180. |
| Move Device on Location Mismatch | Indicates enabling of the device to move on location mismatch. |
| Generate Device Moved Alert | Indicates the device mismatch with IP Address or Location identifier on which an alert is generated. |
| Track Device Movement by Location Identifier | Indicates the tracking of the device by location identifier. |
| Destination Hierarchy For Orphan Devices | Indicates the device that does not match IP Address or Location identifier of any of the configured hierarchies is moved to the Hierarchy (Root hierarchy or Current hierarchy). |
| Accept Re-registration From Active Devices | Indicates the re- registration of active devices or devices in Pending Hierarchy Assignment. |
| Maximum Registration Retry Counter | Indicates the warnings or errors to the user, if KEM received in a row is not marked as ‘’exchange confirmed" for more than allowed retry count. The value must be in the range 5-15. |
| Maximum Packages Per Reference Set | Indicates the maximum number of packages allowed per Reference Set. The value must be in the range 1-10. |
| Maximum Reference Sets Per Hierarchy | Indicates the maximum number of Reference set allowed per Hierarchy. The value must be in the range 1-50. |
| Download Automation Threshold For Application Sync Verification | Indicates the wait time to compare the applications received from a device with applications configured on server to trigger an automatic download. |
| Number of Records To Process Per SQL Batch | Indicates the number of database records that must be processed per batch. The value must be in the range 100-1000. |
| Direct Parameter Activation | Indicates activation of parameters automatically when they are saved. |
| Maximum Templates Allowed Per Device | Indicates assigning of maximum template to a device. The value must be in the range 1-10. |
| Swap Approval Required | Indicates the approval for swapping the device. |
| Notification Threshold for Licensed Devices Count | Indicates the notification generated by VHQ when the current count of devices in the system exceeds the configured value. The value is in percentage and can range from 60 to 95. |
| License Expiry Email Notification | Indicates the notification generated by VHQ specifying license expiry when the configured value exceeds. The value is in number of days and can range from 1 to 1800. |
| Multiple Device Reboots Counter | Indicates the number of times the device reboots. This value is in numbers and can range from 1 to 200. The default value for the configuration is 6. |
| Multiple Device Reboots Threshold | Indicates the duration. The value is in hours and can range from 1 to 750. The default value for the configuration is 24. |
| Missing Devices To Inactive Status Threshold | Indicates the threshold during which the device fails to communicate and is marked with the Inactive status, if no heartbeat frequency is available. The value is in hours and can range from 0-750. NOTE: On Device Missing alert generation, the devices are not marked Inactive unless the configured value of Missing Device To Inactive Status Threshold exceeds. This configuration indicates the threshold value or the duration set for the devices to remain in the Active state. The value is in hours and can range from 0 to 750. The default value is 24 hours. Once the configured value or the duration exceeds the devices are moved to an Inactive status and a Device Missing alert is generated. The Device Missing alert can be either enabled or disabled by the administrator and will continue to apply on user preference. |
| Include Inactive Devices for Scheduling | Indicates scheduling of inactive devices. |
| Heartbeat Frequency Multiple | Indicates the number of times the Heartbeat frequency can be multiplied. The value must be in the range 1-60. NOTE: The device establishes a connection with a VHQ Server and sends a Heartbeat to the server at the specified interval. If the heartbeat is not received by the VHQ Server, it treats the device as missing. In order to increase the time-out limit in VHQ Server, the heartbeat frequency multiple configuration is introduced. The heartbeat frequency sent by the device to the VHQ server is multiplied with the user configured value to calculate the threshold value for qualifying the device missing alert. |
| Device Ready to Wait for MP | Indicates, if the device is ready to wait for the MP. |
| Callback Duration | Indicates callback duration. The value is in seconds and can range from 300-900. |
| Time Out for MP Preparation | Indicates time-out threshold for preparing the MP. The value is in seconds and can range from 60-240. |
| VRK Key Payloads Deletion Threshold | Indicates the threshold to delete the VRK Key Payloads from VHQ Server upon successful download. The value is in number of days and can range from 1-365. |
| Maximum Number of VRK Files Allowed per Upload | Indicates the maximum number of VRK files, allowed per upload into the VHQ. The value can range from 1 to 500 files. |
| Failed VRK Keyblob Rescheduling Timeout | Indicates the number of days after which Rescheduling will be disabled for VRK key blob. |
| Download without Staggering | Indicates to perform the download immediately on the first Heartbeat from Device in Maintenance window after Device Registers (or re-registers) with VHQ. NOTE: Staggering is the mechanism where the device decides to download the scheduled jobs based on the system calculation. Whenever the device contacts for the first time after KEM (Key Exchange Message), the MP (Management Plan) is sent to the device to perform the download immediately without staggering. To manage this function, a new configuration Download Without Staggering is introduced in VHQ system. The configuration can be set to True or False based on user preference. If the attribute is set to True, the download takes place immediately on the first heartbeat from Device, as soon as the Device Registers (or re-registers) with VHQ irrespective of the type of jobs scheduled. If the attribute is set to False, the staggering behavior of the device is based on the types of jobs scheduled in the given interval. |
| Maximum Hierarchies Per User | Indicates maximum number of hierarchies allowed per user. The value must be in the range 1-25. |
| Root Hierarchy Name | Indicates name in the root hierarchy. |
| Downloads Postpone Duration | Indicates configuration to specify downloads Postpone duration. The value is in minutes and can range from 30 to 10080. |
Non-GUI Configuration
The following VHQ configurations are NOT done from VHQ GUI, rather done directly in the VHQ database or in some VHQ configuration files during setting up VHQ for a customer.
| Config Name | Config Value | Description |
| Max Retry Counter | 5 | Maximum number of attempts for sending an email. The value can range from 3 to 10. |
| User Mail Generation Poll Timer | 6 | Poll time configuration to generate user subscribed alerts in user mail queue. The value is in minutes and it can range from 5 to 1440. |
| High Alerts Mail Generation Poll Timer | 5 | Poll time configuration for high severity alerts mail notification. The value is in minutes and it can range from 5 to 1440. |
| Medium Alerts Mail Generation Poll Timer | 60 | Poll time configuration for medium severity alerts mail notification. The value is in minutes and it can range from 5 to 1440. |
| Max Devices Per Job | 10000 | Maximum number of devices can be scheduled in a single operation from UI. The value can range from 2000 to 10000. |
| VxSubPackagesExceptionForManifestFile | config.zip | Comma separated list of sub packages in a zip bundle with exception for not containing manifest file. |
| Application Name | Verifone HQ | Full name of the application to be shown in mail. |
| Short Application Name | VHQ | Short name of the application to be shown in mail. |
| Sender Name | Verifone HQ Admin | VHQ Sender name details to be sent in a mail. |
| UploadFile Endpoint Address | https://vhq.verifone.com/MessagingServer/messagehandler.asmx | Service End Point for uploading files from Device. |
| GUI Session Timeout | 60 | User is allowed to use the GUI for a maximum of <Configurable> value. After this user will be automatically logged out of the GUI. The value is in minutes and it can range from 20 to 1440. |
| Software Package File Types | *.tgz,*.tar,*.bintbl,*.zip | Software Package types supported by VHQ. |
| Content Package File Types | *.avi,*.mpg,*.wav,*.jpg,*.png,*.tiff,*.eet,*.mp3,*.frm,*.tgz | File types that are supported for uploading Content files/packages in VHQ. |
| ThumbnailCommandArgs | -ss 00:00:03 -vframes 1 -f image2 -vcodec mjpeg -s 320*240 | Thumbnail generation command for ffmpeg.exe. |
| PreviewCommandArgs | -t 30 -y -ar 44100 | Preview generation command for ffmpeg.exe. |
| Supported Video File Types | .mpg,.avi | File types supported for the generation of preview/thumbnails. |
| Supported Image File Types | .png,.jpg,.tiff | File types supported for Images, This setting is used to replace the thumbnail URL the same as Preview URL. |
| Supported Audio File Types | .wav,.mp3 | File types supported for generating preview of audio files. |
| Location Identifier XPATH | /Identifier/CustomParam[@Name='StoreID']/@Value> | XML Path for finding the location identifier. |
| Max Schedules Per Job | 10 | Maximum number of Schedules allowed per job. The value can range from 5 to 20. |
| IncomingIpHeader | X-Forwarded-For | Header that stores the source IP address returned from LBR |
| VxFilesToIncludeInBundle | vxossign.crt,pkg_inst.sdm,pkg_inst.man,pkg_inst.mandoes,vfi.p7s,vfi.ped,*.mft | Comma separated list of files to be included in the new bundle prepared during Download Automation. |
| Max Retry Counter For Plan Generation | 5 | Maximum Retry Counter For Plan Generation |
| External Package File Types | *.tgz,*.tar,*.bintbl,*.zip | External Package types supported by VHQ. |