Install Symphony - Windows
Adding Logi Symphony to your environment involves installing, configuring, and licensing the components you'll use as a stand alone or embedded resource. You may need to install multiple components that work together to provide your desired analytics experience, depending on your licensing arrangements. v25.1 We've added support for the cast
function in OData API filters. You can now cast numeric fields (integers, longs, doubles, decimals) to strings in filter queries, enabling string-based operations such as eq
, startswith
, and contains
.
Windows support for Symphony includes one Symphony instance per Windows instance, and includes the Getting Started tutorial.
Important: Download the latest installation package here: https://s3.us-west-1.amazonaws.com/installer.logisymphony.com/windows/Latest/Logi.Symphony.Setup.exe.
Prerequisites
-
Windows 10, 11, and Windows Server 2016, 2019, or 2022 (64-bit).
Note: Disable Internet Explorer Enhanced Security in Windows Server 2016 to avoid multiple Internet Explorer security notifications. -
Know the selection of modules you wish to install:
Symphony with Visual Data Discovery, Managed Dashboards, Managed Reports.
-
Symphony with Managed Dashboards and Managed Reports only.
Note: Logi AI is not supported on Windows.
An email address to assign to the Admin user and an appropriate password.
Appropriate names, passwords, descriptions, and port information for creating new databases or connecting to existing databases.
If you are performing a silent installation, you must install PostgreSQL first if required by your environment before you install Symphony.
Download the installer: https://s3.us-west-1.amazonaws.com/installer.logisymphony.com/windows/Latest/Logi.Symphony.Setup.exe.
Windows Requirements
4 Cores
16 Gi Memory minimum. Add more to support multiple data connectors.
40+ Gi of storage
Other Requirements
Visual Data Discovery Module: PostgreSQL. Install before you begin Symphony installation (required for silent install), or as part of the installation process.
Managed Dashboards and Reports Modules: You can use PostgreSQL, or an existing Microsoft SQL server.
.NET 8.0 Desktop Runtime or later - Install before you begin Symphony installation. You will be prompted to install during Symphony deployment if it is not present.
16 Gi Memory minimum. Add more to support multiple data connectors.
40+ Gi of storage.
Important: These specifications are intended as an initial installation guide. Your environment's specific workloads may demand a higher number of cores and more memory available for computing.
Configuration Specific Requirements
RabbitMQ - Allows for the integration of data connectors among installed modules. Install before you begin, or as part of the installation process.
Symphony application and management databases - Connect existing MS SQL or PostgreSQL databases, or prompt Symphony to install PostgreSQL as needed.
Python - Provides Python transforms and a Python Machine learning provider in the Managed Dashboards and Reports module.
Note: The Deployment Console lets you launch the Deployment Console Wizard and check your version, get the silent install, install export configs, or call with a deployment config file to do a silent install.
Installation Steps - All Modules
Download and install .NET 8.0 Desktop Runtime or later if it is not already present.
Download the Symphony setup package.
Launch the application as a Windows administrator. A Logi Symphony Setup work area opens.
Enter an installation path, or accept the default path provided.
-
Select Install Setup Files to install the files you need to install the deployment console wizard.
Important: If Symphony installs a PostgreSQL database for you as part of this process, the user name ispostgres
. -
Once complete, select Launch Application to launch the Logi Symphony Deployment Wizard.
Note: You can access the deployment wizard later from the Windows Start Menu.
Select the option to Add Instance from the wizard by typing in the appropriate option number, then select Enter.
-
By default, the Managed and Discovery modules are selected for installation. Enter a number for a module to toggle installation on and off for your modules as desired, then type
y
to continue installation.Important: If you only install the Managed Dashboards and Reports module as a way to migrate your Dundas BI instance, you can alternatively use your existing SQL server instead of installing PostgreSQL. If you install Visual Data Discovery, PostgreSQL is required. The wizard checks your environment for needed prerequisites. If all items are all present, review the list and type
y
to continue.-
If any prerequisites are missing:
Type in
fixall
to fix all missing items, then select Enter.Type in
fixmandatory
to only fix the mandatory items required for your instance, then select Enter.Type in a number to fix a specific prerequisite, then select Enter to fix that item. Repeat as needed.
Once all items are all present, review the list and type
y
to continue.
Define information about your instance by answering the appropriate prompts. To correct an earlier entry, type in b
and select Enter to return to a previous prompt.
-
Instance Name work area: Provide an instance name for your Symphony installation and select Enter. Use only letters, numbers, and the underscore character.
Important: Windows support for Symphony includes one Symphony instance per Windows instance. -
Instance Description work area: Provide an optional description for this instance and select Enter.
Important: Windows support for Symphony includes one Symphony instance per Windows instance. Instance Path work area: Provide a value for the
InstancePath
, or select Enter to accept the default instance path.Use Empty Hostname work area: Type in
Y
and Enter to use an empty hostname, orn
to provide your own hostname information to use multiple sites on the same port.-
Enter Binding Details work area: Select a binding type.
- Select
https
if you have appropriate certificates available. You'll be prompted to select an available certificate. - Alternatively, select
http
as needed to work without encrypted communication, or to come back and set up ashttps
later.
- Select
- Website Port work area: Type in a port value, then select Enter. Alternatively, select Enter to accept the default port.
- Web Application Name work area: Type in a new name and select Enter. Alternatively, accept the default defined by your earlier selections, and select Enter to continue.
-
Application Pool work area: Select, by number, the
NetworkService
options and select Enter to continue. Other options may include, depending on your environment:SpecificUser
, orApplicationPoolIdentity
. -
Rabbit MQ Configuration work area: Select, by number, either of these options, and complete the associated tasks to complete this step.
- I have an existing RabbitMQ server and will provide its details. You will need to provided the appropriate details to connect Symphony to your instance. Provide values for the Rabbit MQ Host (or accept the default), Rabbit MQ Port (or accept the default), Rabbit MQ Username, Rabbit MQ Password, and Rabbit MQ Virtual Host.
- I need to install a RabbitMQ server. Symphony walks you through installing Rabbit MQ and its Erland OTP dependency. You will need to provide values for the Rabbit MQ Username, Rabbit MQ Password, and Rabbit MQ Virtual Host. Keep note of that user name and the password you assign for future updates, upgrades, or changes.
Important: If you do not install or connect Rabbit MQ at this time, you will encounter integration errors when you attempt to use both Managed and Discovery modules in Symphony.
After Rabbit MQ Configuration is complete (or skipped), you are prompted to provide details to configure databases by linking existing databases or installing new databases.
-
Managed Overview work area: If you have selected to install and license Managed Dashboards and Reports, enter
Y
to continue installation. -
Database State work area: Define a database server for your instance. Have Symphony install PostgreSQL for you, or select an existing MSSQL instance, PostgreSQL instance, or . Select, by number, either of these options:
New: Install a new database server. Provide a password and confirmation to define a PostgreSQL database.
Existing: Link an existing database. Provide the details of your MSSQL or PostgreSQL database. This may include the Host Name, User Name, Password, and Database Name. SSL information may be required as well.
If you need to install a new database server, Symphony installs a PostgreSQL server for you. Provide a password and verify the password. The user name provided by Symphony is
postgres
. Keep note of that user name and the password you assign for future updates, upgrades, or changes.-
If you select Existing to link an existing database, enter
Y
to provide database information for this instance.-
Application Storage Engine work area: Select SqlServer or Postgres.
For SQLServer, provide values for the Data Source, User Id, Password, and Database Name (or use default provided).
For PostgreSQL, provide values for Host, Port (or use the default provided), Username, Password, SSL Mode option (Prefer is useful for most environments), and Database Name (or use the default provided).
-
Warehouse Database Connection work area, use the same database connection details you just defined by entering
y
, then select Enter. Accept or change the default Database Name value.Alternatively, enter
n
, select Enter, then provide details to connect to another database.
-
After this is complete, you are prompted to provide details to configure the Discovery module.
After Managed Configuration is complete, you are prompted to provide details to configure the Discovery module.
Note: These options are not provided if you are not installing the Visual Data Discovery module.
Discovery Overview work area: If you have selected to install and license Visual Data Discovery, enter
Y
to continue installation.-
Discovery Metadata State work area: Define a database server for your instance. Have Symphony install PostgreSQL for you, or select an existing MSSQL instance, PostgreSQL instance, or select, by number, either of these options:
-
New: Install a new database server. Provide a value for the Discovery Postgres Server or accept the default
localhost
. Type in a value for the Port, or use the default provided. Enter a value for Discovery Postgres Username and Discovery Postgres Password. Select an SSL Mode option (Prefer is useful for most environments), and all of the Data Discovery database names.Important: For a clean, uncomplicated instance of Symphony, we suggest you accept the default names provided by the installer. Existing: Link an existing database. Provide the details of your PostgreSQL database. This may include the Host Name, User Name, Password, and Database Name. SSL information may be required as well.
-
Select Additional Features work area: Enter numbers for available features to toggle them on or off for installation, then enter
Y
to continue installation.Select Discovery Connectors work area: The PostgreSQL connector is selected by default. Enter a number for available connectors to toggle them on or off for installation, then enter
Y
to continue installation.
After Discovery Configuration is complete, you are prompted to provide Admin details for Symphony.
Provide a value for the Admin password, then enter it again to verify the password.
Provide a value for the Admin email address. Symphony provides a summary of the installation selections you have made.
If you are satisfied with your selections, type in
y
and select Enter to proceed with the installation process.-
Once the installation is complete, you can review the completed tasks and navigate to the installation log provided to review this information in more detail if needed.
Note: Keep note of that user name and the password you assign for future updates, upgrades, or changes.
Silent Installation
Download and install .NET 8.0 Desktop Runtime or later if it is not already present.
Install PostgreSQL if not already present.
Download the Symphony setup package.
Launch the application as a Windows administrator. A Logi Symphony Setup work area opens.
Enter an installation path, or accept the default path provided.
-
Select Install Setup Files to install the files you need to install the deployment console wizard.
Important: Symphony will not installs PostgreSQL database for you as part of the silent install process. Install before you begin. -
Once complete, you can close the Logi Symphony Setup work area and launch the Logi Symphony Deployment Console in one of two ways.
Open it from the Windows Start Menu by selecting Logi Symphony Deployment Console.
Launch it from the command line from its location, for example:
C:\Program Files (x86)\InsightSoftware\Logi Symphony\Setup\<version number>
.
Launch the Logi Symphony Deployment Console.
-
Type in the command
Logi.Symphony.Deployment.Console.exe
and select Enter. Several options for installing and managing your instance appear.{Deployment Config File Path}
- Provide the path to your customized deployment config file to silently install Symphony.-- ExportDeploymentConfig {Optional Path}
- Exports examples of all possible configs to a directory. Use to create a config file you can customize to create your silent installation.-- wizard
- Launch the Logi Symphony Deployment Wizard - Main Menu.-- Version
- Find out the current version of your software installer.
-
Generate a the sample config file, and supporting files. These include:
-
AddLogiSymphonyInstanceDeploymentConfig.xml
- Customize with your environment specifics to install in your instance. See Installation Steps - All Modules for more details on each item included.Important: You must ensure all prerequisites for installation are met, or the installation will fail. Fix your prerequisites by editing and running a customizedFixPrerequisiteDeploymentConfig.xml
in your environment. FixPrerequisiteDeploymentConfig.xml
- Use to customize and install all prerequisite items in your environment.RemoveLogiSymphonyInstanceDeploymentConfig.xml
- Customize and use to remove Symphony from your environment.UpgradeLogiSymphonyInstanceDeployentConfig.xml
- Customize and upgrade your instance to upgrade to the version you've downloaded the files for.
-
After you've edited the appropriate files, call
Logi.Symphony.Deployment.Console.exe
and the path to the file you want to pass. Repeat for all needed files until installation is complete.Once installation is complete, you can change the default settings for all services, as well as configure Visual Data Discovery services and Managed Dashboards and Reports services as needed.
Perform any post install options, as needed.
Post Installation Options
After you've completed installation, you can perform many of the tasks available in the Deployment Wizard, such as:
-
Logi Symphony - View: Select to open your instance and begin adding users, data sources, and more.
Note: If you need to set or reset your admin password, see How to Reset the Admin Password. -
Managed - Add Federated Authentication To Instance: Select to add a federated authentication option for your instance.
Select an instance from available options
Enter a value for the Federated Authentication Application Pool name, or accept the default name
Select an Identity Option (NetworkService is useful for most environments)
Confirm and add the service
-
Managed - Add GatewayHub to Instance: Select to add the GatewayHub to your instance.
Select an instance from available options
Confirm and add the service
-
Discovery - Update Connectors and Additional Components: Select to add or remove data connectors or other Discovery components.
Select an instance from available options
Enter a number for a feature to toggle for deployment or removal, then
Y
to continueEnter a number for a data connector to toggle for deployment or removal, then
Y
to continueConfirm and deploy the changes
For information about accessing Symphony after it is installed, see Access Symphony.