Visit our new and improved Knowledge Base at support.seeq.com!


Seeq Configuration and User Data Files

Configuration System 

Seeq uses a centralized configuration system for administration and tuning.  For a full list of options and their descriptions, see the Configuration tab in the Administration page.

Updating Configuration Options

There are two ways to update configuration options: via the Configuration tab in the Administration page, or by using the Seeq Command Prompt.

Administration Page

When you navigate to the Configuration tab on the Administration page, you will be presented with a table of options that you can use to configure Seeq Server.  You can use the controls at the top to search for options by name, or filter by any field.  To see a description of what each option does, hover over a row in the table.  Notes can be added when overriding values to explain why decisions were made.  

Any changes made to configuration options on the Administration page are not saved permanently until the orange Save button is clicked.   When the Save button is clicked, you will be shown a confirmation dialog that summarizes the changes you have made; note that the values of many options depend on others and these will be updated accordingly.

The Advanced field signifies whether or not an option is intended for advanced tuning; please strongly consider working with Seeq Support if you think you need to adjust one of these!  By default, these options will be hidden.

Some options are not editable from the Administration page, but must be updated via the Seeq Command Prompt.  Others are presented for informational purposes only.

Seeq Command Prompt

You can also set and unset options using the seeq config command in the Seeq Command Prompt.  For example, to update the hostname of your Seeq server, you could run the following command:

1 seeq config set Network/Hostname my.company.hostname

Option names (e.g. Network/Hostname in the example above) are case-sensitive.

Boolean values are set using 'true' or 'false' from the CLI even though they display as 'True' or 'False'

 

For details and information on subcommands, run the following:

1 seeq config --help

 

Data Locations 

Seeq configuration, data, licenses, plugins and all other customer-specific files are stored centrally in the file system. This approach facilitates backup activities, upgrade testing and other administrative functions.

The default location for such files is within a common application data folder for the operating system. On Windows, that is C:\ProgramData\Seeq and on Linux/OSX that is ~/.seeq. This folder is referred to in Seeq technical documentation as the global folder.

Within the global folder are the following major files and folders:

global.properties (before R22.0.46.00)

This text file defines machine-specific properties like IP addresses and port numbers. As you will see below, this file can be used to specify the location of the data folder.

This file is always in the same location and cannot be moved.

global_config.json (R22.0.46.00 and later)

This JSON file defines machine-specific properties like IP address and port numbers.  This file is always in the same location and cannot be moved.  It is strongly recommended that this file is not modified by hand; see the Configuration System section of this article for instructions on how to configure Seeq.

licenses

This folder contains the active license file for this server. An "old" subfolder contains inactive licenses.

This folder is always in the same location and cannot be moved.

data

This folder contains all user data associated with an instance of a Seeq Server, including workbooks, worksheets, comments, indexes, profile/value searches, conditions, calculated data, cached data, formulas, Seeq users/passwords, and all configuration data (other than global properties and licenses).

The location of the data folder can be changed using the procedure described in Changing the Data Folder Location below.

Since the only configuration items not included in the data folder are the machine-specific global properties and license files, it is easy to copy the user data to another machine without taking the machine-specific files with it.

backups

This folder contains backups of the data folder that result from using the built-in backup facilities or selecting the backup checkbox during upgrades. You can change the location of the backups folder if desired.

Customizing Seeq Login Images

Customization of Seeq Login images is supported in Seeq Server version R21 and later.

To customize the Seeq login images follow the steps below.

Adding multiple images will result in a random image being selected for the background each time a user visits the login screen.

  1. Navigate to data/configuration/login-images 

  2. Copy custom images into the directory (.png, .jpg, .jpeg, .gif files only). 

  3. To see the new images, refresh the login page. No need to restart Seeq server.

  4. If you delete all the photos (or use invalid file types), the default Seeq background images will be used.

Adding a Custom Banner Message

The following methods are available for displaying a message in Seeq that can message all Seeq users. 

System Admin Message

Create a System Admin message by using the instructions in https://seeq.atlassian.net/wiki/spaces/KB/pages/599425196/Seeq+Administrative+Announcements. The custom message will display as a yellow banner across the screen after logging into Seeq. Note, however, that once the user dismisses the message they will not see it again. 

Login Page Image

Using the method described above a custom login image can be created that has the message as part of the image. However, users will only see it when they log in which may not be very frequent.

Customization of the Sidebar

The sidebar on the Workbench home screen can be customized by following these instructions.

Logo Change 

If it is a requirement that the message be visible in all parts of Seeq and not be able to be dismissed, the logo image (shown in the top left corner of Seeq) can be overwritten with a custom image.

This should only be considered if the other options are not sufficient since it will need to be done each time Seeq is upgraded.

Create a PNG image with dimensions of 160px x 56px and name it Seeq_logo_white@2x.png. Overwrite the following file on the Seeq server with the new image: C:\Program Files\Seeq Server\webserver\image\dist\img\Seeq_logo_white@2x.png. To see the new image users must clear their browser cache by holding down the Shift key and reloading the Seeq page.

Changing the Data Folder Location

Often, due to limited disk space or other concerns, you may want to use another location for the data folder.

Do not put the data folder on a network drive, as a network drive may have unreliable file access, insufficient atomicity guarantees, and/or poor performance.

Do not put the data folder in a folder path that contains spaces, as some Seeq components do not support this.

Take the steps defined in the following sections to change the location.

This below command will shut down Seeq Server (if necessary), copy the folder to the new location (being sure to preserve access control / permissions), update the global configuration, then delete the folder in the old location.

<new_data_folder_location> should be the path to where you want Seeq's "data" folder to be. (Example: D:\ProgramData\Seeq\data is a recommended path you could use for <new_data_folder_location>.)

Note: You will have to have already created the folder path except for "data" in this example.  So you should first ensure there is a "D:\ProgramData\Seeq" folder path, but don't manually make the "data" folder.  Let the Seeq CLI command do that.  This new "data" folder location should not already exist or the move will fail with an error as the process expects it will have to create the new folder for you.  When running the following command via the Seeq Command Line Interface specify the complete <new_data_folder_location> including the data folder.  (Example: D:\ProgramData\Seeq\data)

Using the Seeq Command Line Interface, execute the following commands:

1 2 > cd.. > seeq install --data <new_data_folder_location>
  1. You will need to have enough disk space on the storage device that houses the new location, otherwise the copy operation will fail.

  2. Running the CD (change directory) command moves you out of the data directory, the default path the Seeq Command Line Interface starts in, so the removal of the old data directory is successful.

If you wish to start Seeq Server once the data folder has been moved, just execute seeq start.

If you're running Seeq Server version R22.0.46.00 or later, the data folder is already in the desired location, and you just need to configure Seeq Server to use the new location, execute this command instead:

1 seeq config set Folders/Data <new_data_folder_location>