System Settings

About

Through this system settings page, authorized administrator can manage SafeQ configuration.

YSoft SafeQ 5 has no user-configurable hard text or xml configuration files on the file system. All configuration settings is saved in database. There may be some configuration files in SafeQ installation directory, however these are considered as a part of application, required for its start up and shall not be modified any time.

There are following rules in updating configuration in cluster:

  • all nodes have to be up and running when changing settings

  • it is highly recommended to update configuration on the master node

General overview

images/s/-3eliqb/8502/404359a7d2ab19c9c7c58d12013124a386b28257/_/images/icons/emoticons/lightbulb_on.svg System settings can be found on web interface: System > System settings

Please note that settings of LDAP replicator are in separate page in user management, see Tools - LDAP Integration.

images/download/attachments/21955624/system_settings_overview.png

Working with System settings

Search filter

In System settings page you can search for properties:

  • by entering text phase into text filed. This phase must be part of property name, description or internal name.

  • by marking/unmarking SafeQ components which are using this property

To apply current search filter click Search button. To cancel current serach filter click Clear buton.

images/download/attachments/21955624/search_filter.png

Tablet panels

Tablet panel on the left side of the page are representing different categories of system settings. Number of displayed categories depends on the currently selected view and search filter.

To change category just click its name. Currently selected category is always highlighted with white color. 

images/download/attachments/21955624/left_tablet_menu.png

Property details

Each property listed in System settings contains some attributes which are described below. All attributes marked with asterisk are always display for each property.

images/download/attachments/21955624/property_notes.png

  1. Property name* - you can search properties based on name

  2. Property description* - short description how property affects SafeQ system; possible to search properties based on description 

  3. Configuration level - green = basic, yellow = advanced, red = expert

  4. Internal name and "Revert to default value" button* - internal name of property; possible to search properties based on internal name; by clicking

  5. List of components where is this property applied* - possible values: CML (central managing layer), ORS (offline remote spooler), TS (terminal server), MPS (mobile print server)

  6. List of components which requires restart to apply changes - possible values: CML (central managing layer), ORS (offline remote spooler), TS (terminal server server), MPS (mobile print server)

  7. List of embedded terminals which requires reinstallation to apply changes - only installed vendors are listed

  8. Currently saved value* - possible ways of selecting value are: selecting from drop-down list, editing text field, adding/removing line with value

Saving new settings

After changing settings values you have to save changes to apply new settings. It is possible to change more values on different pages and then save settings

After clicking images/download/attachments/21955624/save_changes.png  button, there is displayed a window with summary of changes, list of components to be restarted and list of terminals to be reinstalled. To confirm these changes click Yes.

images/download/attachments/21955624/save_popup.png

Functions

In the top right corner there is few functions available for this page. For general page functions see: Web interface - Basics

Add new item

This function is available only in Expert options view and allows you to add custom properties into System settings. After clicking images/download/attachments/21955624/add_new_item.png  pop-up window will be displayed. Fill in all necessary field and click Add property.

 images/download/attachments/21955624/add_new_item0.png

Actions

Name

Description

Import settings from file

Imports previously exported file with differential settings with following conditions:

  • Differential system settings in the import file has to exist in existing YSoft SafeQ settings and only value is updated. If system setting does not exist in YSoft SafeQ, an error is reported.

  • Setting has to be contain valid values which can be imported.

  • Setting in YSoft SafeQ which should be overwritten by value from the import file cannot be read-only otherwise an error is reported.

  • Setting which exists as user settings in YSoft SafeQ cannot be overwritten by any setting from the import file. Such setting has to be modified only from web interface.

  • Imported user defined setting cannot overwrite existing system setting in the YSoft SafeQ.

If your import fails, remove invalid setting from the import file according these conditions and try to load it again.

Export settings to file

Exports settings difference between default value and set value. Only key and a current value is exported. All user defined settings are exported as full record which means with information about used subsystems, all flags, default value and its assignment in category to be able to restore it again in the import. Settings which are not changes are not exported.

Views

SafeQ system settings are divided into three levels, based on impact to SafeQ system.  After clicking images/download/attachments/21955624/views.PNG  you can select:

images/download/attachments/21955624/dot_green.png  Basic options - small impact to SafeQ system
images/download/attachments/21955624/dot_yellow.png  Advanced options - medium impact to SafeQ system
images/download/attachments/21955624/dot_red.png  Expert options - high impact to SafeQ system. Do not change Expert options without prior permission from Y Soft.

Save settings

To save new settings you have to click images/download/attachments/21955624/save_changes.png  button before leaving system settings page. For more info see Saving new settings.

Settings in Dashboard widget

Some basic settings can be also edited from Welcome to YSoft SafeQ widget on Dashboard. For changes of the setting using the widget same rules as for System Settings apply.

images/download/attachments/21955624/widget_welcome.png

Delivering configuration to the customer

As a CSS technician or Y Soft partner, I want to deliver changes in configuration to the customer so that customer environment can be set properly even without skilled person on site.

To prepare changes in configuration, create XML file for import with following structure:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<configuration>
<property>
<key>property name</key>
<value>value</value>
</property>
<property>
<key>property name 2</key>
<value>value 2</value>
</property>
...
</configuration>

Any user with right to change system settings can than import the XML file.

Please note that you have to follow rules for importing setting. Also SafeQ services must be restarted for applying settings where required.