GUI Settings

  • General Information
  • GUI Configuration File
  • XML Attributes
  • XML File Example

    • General Information

    The GUI settings are stored in a xml formatted file. This configuration file can be a serverside config file, that is stored on the server or it can be a lcoal file, that is located on the user side. During the start, the boom GUI checks if a server side config file does exist for the current user role.

    Please note: GUI settings are defined on a user role level!

    Local profiles are stored for each user/boom server combination.


    GUI Configuration File

    Server side Config File:
    The server side config file is always the master! If this file exist, the local config file will be ignored. In case there is no severside config file, the local config file will be used. If there is no server and no local config file, a new local config file will be created.

    UI settings can only be defined by users that belong to the administrator role. The serverside config file is read only for all other users. Changes to the UI (done by the user) will not be saved to the server config file! The ability of the user to reorganize the boom GUI depends on the settings inside the server config file.

    Local Config File:
    The local UI config file is only used, if the server side UI config file does not exist. The local config file is created after the first start of the boom GUI. In this case, the user is allowed to reorganize the GUI without any restrictions. All changes that he makes to the boom workbench (i.e. moving views, opening new Indication Browsers, ...) will be saved to this local config file.

    File Name
    To make sure that the user roles are using the correct config file, the name of the xml file must be equal to the user role id. You can get the user role id from your database.

    user role id:   1ded5a54-7f8c-4301-9821-9fb98ed81079
    file name:   1ded5a54-7f8c-4301-9821-9fb98ed81079.xml

    File Path
    Put your server side config file in the following directory: \srv\profiles\
    The local config file is called profile.xml and can be found in the local user directory.


    XML Attributes

    The following table contains all available attributes that can be defined in the UI Config file. All attributes that are set '0' are NOT allowed. All values other than '0' will be enabled for the specific action.

    attribute_value = 0  Action is NOT allowed
    attribute_value >= 1  Action is allowed

    Global Attributes

    Global Attributes apply to all Indication Tabs.
     
    CAN_MOVE Possible values: 0|>=1
    This attribute defines if the user is allowed to move Indication Tabs within the Indication View or the Indication View2.
    CAN_SORT Possible values: 0|>=1
    Here you can define, if the user is allowed to sort all Indication tables or not.
    CAN_SWITCH Possible values: 0|>=1
    This attribute describes if the user is allowed to switch the perspective of Indication tables between active and closed Indications.
    CAN_MODIFY_FILTERS Possible values: 0|>=1
    You can decide if the user is allowed or not allowed to change the filtering of Indication tables.
    Attributes on View level

    The following attributes apply to Indication View1 and Indication View2.
     
    VIEW_ID Every Workbench View can be identified on the basis of its unique View ID. Here is the list of available View IDs:

        Indication View1:  "com.blixx.boom.gui.views.msgview"
        Indication View2:  "com.blixx.boom.gui.views.msgview:MsgView2"
     
    CLOSABLE Possible values: 0|>=1
    Describes if the user is allowed to close the View with the given View ID.
    MOVEABLE Possible values: 0|>=1
    Describes the if the user is allowed to move this View within the boom Workbench.
    ADD_NEW_TABS Possible values: 0|>=1
    This attribute defines if the user is allowed to open/close new Indication Tabs inside the Indication View with the given View ID.
    Attributes on Tab level

    The following attributes apply to all Indication Tabs.
     
    INDICATION_VIEW_ID     Possible values: 1|2
    It defines, if the Tab will be opened in the Indication Browser1 or the Indication Browser2.
    TAB_NAME Name of the Tab.
    SHOW_ACTIVE Possible values: true|false
    Set attribute to true if you want the user to see all active Indications in this tab.
    DEFAULT_SORTING Possible values: column|sortdirection
    You can define the default sorting of the Indication table.
    Example: "SrvTime|down" -> The table will be sorted downwards by the column ServerTime.
    Filter Attributes

    The Filter Attributes apply to all Indication Tables. For more information about filters see chapter Indication Filtering.
     

    XML File Example

    How to create a GUI config file?
    Login with a user who does not belong to the administrator role. Make sure that this user or rather the his user role must not have a server side GUI config file! If you are logged in you can organize your workbench: open new Indication browser and add possible filters to them. When you are done check the profile.xml file in the user directory. The user side GUI config file has been created automatically and keeps all necessary user settings. You can now adapt this xml file for your needs and move it to the server.

    GUI XML Configuration File