Advanced Configuration

Understanding the installation folder

During the installation process, the Squore Installation Wizard creates several folders and files in the Squore installation directory <SQUORE_HOME>:

  • <SQUORE_HOME>/addons contains the Data Providers and Repository Connectors available in Squore

  • <SQUORE_HOME>/bin contains scripts to start, stop and manage Squore.

  • <SQUORE_HOME>/configuration contains folders and files that provide the default analysis and decision models, as well as the default dashboards for these models. For more details on how to understand and use these configuration files, refer to the Squore Configuration Guide.

  • <SQUORE_HOME>/database contains scripts used to create and reset the database.

  • <SQUORE_HOME>/deploy contains a copy of the web applications deployed during the installation.

  • <SQUORE_HOME>/docs contains licenses for third party libraries included in Squore and a copy of the Squore documentation.

  • <SQUORE_HOME>/lib contains runtime libraries used by Squore Server.

  • <SQUORE_HOME>/samples contains some sample source code in various programming languages that can be used as examples when getting to know Squore. This folder can safely be deleted if you do not need it.

  • <SQUORE_HOME>/server contains the Squore application server. See Application Server for more information.

  • <SQUORE_HOME>/share contains some custom perl modules and other files needed to run the web applications.

  • <SQUORE_HOME>/tools contains the local instances of perl, tclsh, PostgreSQL and PhantomJS.

  • <SQUORE_HOME>/util (Windows-only) contains scripts used during the installation.

  • <SQUORE_HOME>/config.xml is used to specify the location of some configuration folders. See Understanding the config.xml file for more information.

Understanding the config.xml file

This section deals with editing the configuration of the installed instance of Squore. For more information about how to edit analysis models and wizards, refer to the Squore Configuration Guide.

The default content of the <SQUORE_HOME>/config.xml file is as follows:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<squore type="server" version="1.4">
	<paths>
		<path name="perl.dir" path="C:\Vector\Squore\squore-server\tools\perl\perl"/>
		<path name="tclsh.dir" path="C:\Vector\Squore\squore-server\tools\tclsh"/>
	</paths>
	<database>
		<postgresql directory="C:\Vector\Squore\squore-server\tools\pgsql"/>
		<cluster directory="C:\Vector\Squore\squore-data\cluster"/>
		<backup directory="C:\Vector\Squore\squore-data\backup"/>
		<security>
			<user-name>postgres</user-name>
		</security>
	</database>
	<phantomjs>
		<socket-binding port="3003"/>
	</phantomjs>
	<configuration>
		<path directory="C:\Vector\Squore\squore-server\configuration"/>
	</configuration>
	<addons>
		<path directory="C:\Vector\Squore\squore-server\addons"/>
	</addons>
	<tmp directory="C:\Vector\Squore\squore-data\temp"/>
	<projects directory="C:\Vector\Squore\squore-data\projects"/>
	<workspace directory="C:\Vector\Squore\squore-data\workspace"/>
	<archive directory="C:\Vector\Squore\squore-data\archive"/>
</squore>

You can find the XML schema for <SQUORE_HOME>/config.xml in config-1.4.xsd section.

Here is a description of each element:

  • paths/path name="perl.dir" (mandatory) is the path to the perl installation used by Squore. It is detected automatically on Linux and set to <SQUORE_HOME>/tools/perl/perl on Windows.

  • paths/path name="tclsh.dir" (mandatory) is the path to the tcl installation used by Squore. It is detected automatically on Linux and set to <SQUORE_HOME>/tools/tclsh on Windows.

  • database/postgresql directory="…​" (for installations using PostgreSQL only) is the path to the PostgreSQL installation used by Squore It is detected automatically on Linux (or passed as a parameter to ./install) and set to <SQUORE_HOME>/tools/pgsql on Windows.

  • database/cluster directory="…​" (for installations using a local PostgreSQL cluster only) is the path to the PostgreSQL cluster defined at installation to hold the Squore Database.

  • database/backup directory="…​" (mandatory) is the path to the folder used by Squore by default to store backups. It can be overridden by passing a path to the backup script.

  • phantomjs (optional) allows you to specify the port used by Squore Server to communicate with the local instance of PhantomJS.

  • configurations/path directory="…​" (mandatory): Paths to one or more configuration folders. The first path listed in the list takes precedence over the next one.

  • addons/path directory="…​" (mandatory): Paths to one or more addons folders. The first path listed in the list takes precedence over the next one.

  • tmp directory="…​" (mandatory) is the path to the temporary folder used to hold temporary analysis and user session data created while the server is running (this folder is emptied at startup).

  • projects directory="…​" (mandatory) is the path to the project folder that holds analysis results. Files in this folder are included in a backup, along with the contents of the database.

  • workspace directory="…​" (mandatory) is the path to the folder where any configuration changes carried out in the user interface are saved (for example charts and dashboards modified in the Dashboard Editor).

  • archive directory="…​" (mandatory) is the path to the folder where projects archives are stored.

Elements order must be identical to the one defined in XML schema, otherwise Squore Server will not be able to start.