Configuration Key Editior

Owned by Enterprise IT
May 29, 2024
7 min read

An Administrator can add/update SummitAI Proxy and Summit Server config. Key(s) in the SummitAI config files (web.config, server monitor.config, and proxy.config). These key(s) will further synchronize with the respective Data Collector/Proxy.

Advantages:

  • Self-support: Any person with an Administrator access can add/update keys in SummitAI config files. This will eliminate the dependency of dedicated resource to update the key.
  • Forepart Access: All the keys can be added/updated in the SummitAI config files using application UI screen.
  • Increased Productivity: The Administrator can add keys without even accessing the customer’s environment. Due to this, the customer’s productive time will not be halted.
  • No Server Access Dependency: The Administrators can add the keys without even login to the server.
  • Performance Optimization: Due to the defined configuration process it enhances the system efficiency. It makes the application more agile which ultimately enhances quality of service for your customers.
  • Consistency: It helps in avoiding duplicate keys across all the available server. Also, it detects and corrects all the improper configurations that could negatively impact performance.

To configure key editor:

Prerequisites: The SummitAI and DC servers must be installed and configured. Post configuration of the DC Server and SummitAI, all the servers will be populated in the newly added Web Console i.e., KEY CONFIGURATION EDITOR page.

Note:

Upon installing SummitAI, DC, and/or Proxy servers, all the keys are stored in the master table.

  1. Select Admin > Basic> Infrastructure > Key Configuration Editor.
  2. On the ACTIONS panel of the CONFIGURATION KEY EDITOR page, click Filters.

  3. On the FILTERS pop-up, select the Domain for which you want to add Key, and then click SUBMIT. For more information about the fields on the FILTERS pop-up, see FILTERS.

    Figure: FILTERS pop-up

    Note:

    Post installation and configuration of SummitAI Web Server, Data Collector, and/or Proxy servers, respective server details will populate in the Server drop-down list.

  4. The list of Keys based filter criteria is displayed. Select the radio button of the required Key and click ADD KEY on the ACTIONS Panel.
  5. On the ADD KEY page, fill in the required fields and click SUBMIT. The key will be added to the selected Server. For more information about the fields, see Field Description.

    Figure: ADD KEY page

Field Description

The following table describes the fields of the ADD KEY page:

Field

Description

DETAILS
Server Name

Select the Server name.

  • Summit Server: It refers to the machine, where SUMMIT Suite is installed. It is also referred as SUMMIT Centralized Server. Select this option to add the key to the SUMMIT Server.
  • Data Collector: The Data Collection Server (DC Server) is a real-time data transportation solution that improves decision support by connecting data producers and consumers together. Select this option to add the Key to the DC Server.
  • Proxy Server: This is an alternative server. Select this option to add the Key to the Proxy Server.

Group Name

Type in the group name for the easy identification of the key group This identification is necessary while performing any update to the add keys in future.

Key Name 

Type in the Key name that you want to add to the selected Server.

Data Type

Select the data type for the Key from the drop-down list. The available data types are:

  • Int: Select the data type as Int to store a whole number (not a fraction) for the Key value
  • Boolean: Select the data type as Boolean to store True and False for the Key value.
  • String: Select the data type as String to store characters in double quotes for the Key value

Key Value

Type in the value for the above specified key.

Primary Config Value

Select the server name from the list. The selected Server will be considered as the primary server for adding the key configuration.

The available options are:

  • Web.config
  • ServerMonitor.exe.config
  • Summit_Proxyserver.exe.config

Secondary Config Value

Select the server name from the list. The selected Server will be considered as the secondary server for adding the key configuration.

Description

Type in the description about the Key.

Active

This check box is used to set the status of the added Key.

If the check box is enabled, then the above added key becomes active. If the check box is not enabled, then the above added key becomes inactive.


ACTIONS

This section explains all the action items that are displayed on the ACTIONS panel of the CONFIGURATION KEY EDITOR page.

SHOW LIST

Click SHOW LIST to view the list of configuration Key Editor.

For more information about the fields on the LIST page, see Field Description.


Figure: CONFIGURATION KEY EDITOR page - LIST page

Field Description

The following table describes the fields on the LIST page:

Field

Description

Action

Select the radio button of the required Key for which you want to perform the action.

If the Keys are already added to the Server, then the radio button becomes disable and you cannot perform any of the activities available on the ACTIONS panel, however you can only update the Key Value of the respective Key and click SUBMIT.

Key Name

Displays the Key name.

Key Value

Displays the Key value that was specified while adding the key.

Data Type

Displays the data type of the Key value that was specified while adding the key.

Is Added?

This column displays information if the respective key is added into the server. The available values are as follows:

  • Yes: This value is displayed if the Key is added to Server.
  • No: This value is displayed if the Key is not added to Server.

Description

Display the description about the Key value that was specified while adding the key.

Updated By

Display the username who has updated the key parameters.

Updated On

Display the date and time when the key parameters were updated

Server Config Sync Time

This column displays the date and time when the configuration changes were updated in the server config file.

Is Synced with Server Config?

This column displays information whether the configuration changes made on the KEY CONFIGURATION EDITOR page is updated in the Server or not. The available values are as follows:

  • True: It shows that the configuration changes made on the KEY CONFIGURATION EDITOR are successfully updated in the server config file.
  • False: It shows that the configuration changes made on the KEY CONFIGURATION EDITOR are not yet updated in the server config file.

FILTERS 

This icon is used to specify the filter criteria to display a list of Keys. On clicking the Filters icon, the FILTERS pop-up page is displayed. Specify the filter criteria and click SUBMIT. For more details on the filter fields, see Field Description.


Figure: FILTERS pop-up page 

Field Description

The following table describes the fields on the FILTERS pop-up page:

Field

Description

Domain

Select a Domain from the drop-down list for which you want to view the Key details.

Server

Select the Server from the drop-down list for which you want to view the Key details.

Based on the configuration, the following options are displayed in the drop-down:

  • SummitAI Web Server: It refers to the machine, where SUMMIT Suite is installed. It is also referred as SUMMIT Centralized Server. Select this option to view the key that were added or not added into the SUMMIT Server.
  • Data Collector: The Data Collection Server (DC Server) is a real-time data transportation solution that improves decision support by connecting data producers and consumers together. Select this option to view the key that were added or not added into the DC Server.

Note: By default, the Data Collector servers are not populated. Based on the backend configuration, the Data Collector servers’ options are displayed in the drop-down:

  • Proxy Server: This is an alternative server. Select this option to view the key that were added or not added into the Proxy Server.

Actions

Select an Action from the drop-down list. Based on the selection, the Keys associated with the selected Server and Domain are displayed. The following are the available options:

  • Show Added Keys: If selected, the Keys that are added the selected Server are displayed.
  • Show Not Added Keys: If selected, the Keys that are available in the master table but not yet added to the selected Server are displayed.

    Note: The UPDATE and UPDATE ALL icon are not available on the ACTION panel, if the Actions is selected as Show Not Added Keys and Show All.

  • Show All: If selected, then all the Keys i.e., the keys that are already added and the keys that yet to be added are displayed.

Sync to system config

Select the check box to filter the list of keys those key values are successfully updated in the Server Config file.

EXPAND ALL

Click EXPAND ALL to expand all the collapse group Keys. After all the groups are expanded, the COLLAPSE ALL icon is displayed on the ACTIONS panel in lieu of the EXPAND ALL icon. Click COLLAPSE ALL to collapse the Key list.

UPDATE

Click UPDATE to edit the parameters associated with the selected Key. 

After updating the required details, click the SUMMIT. The updated key details will be displayed on the list page.

Note:

This option is displayed on the ACTION panel if Actions is selected as Show Added Keys on the FILTERS pop-up page


Figure: UPDATE KEY page

Note:

  • While updating the key using the UPDATE action item, the Server Name and Key Name fields are non-editable.
  • The UPDATE action item is not available on the ACTION panel for the keys that are not added to the selected Server

CHANGE HISTORY

Click CHANGE HISTORY to view the changes done in the selected Key. You can view the changes that are made to a particular key value, the user who made the changes, the date and time when the change was made, and the previous and new values of a key. This information is useful to track the various changes made on the key.


Figure: CHANGE HISTORY page

UPDATE ALL

Click UPDATE ALL to update the Key Value of the selected Key across the required Servers to which the key was added.

To update the key value in multiple servers, select the radio button of the Key and edit the Key Value. Click UPDATE ALL on the ACTIONS panel.

Figure: UPDATE ALL KEY page

Select the check box of the required Server for which you want to update the key value and click SUBMIT.

Note:

  • The UPDATE ALL icon is not available on the ACTION panel for the keys that are not added to the any Server.
  • User can also add the key to server by selecting the required key, editing the key value and submitting the form.

ADD TO CONFIG

This option is displayed on the ACTION panel only when the Actions is selected as Show Not Added Keys on the FILTERS pop-up page. Click ADD TO CONFIG to add a particular key to the Server that was selected on the FILTERS pop-up page.

EXPORT TO EXCEL

Click EXPORT TO EXCEL to export the records displayed on this page to a Microsoft Excel sheet.