Skip to end of metadata
Go to start of metadata

The Synergetic server design and installation documentation provides a detailed step by step guide to design the infrastructure, provision servers and install the applications. The outcome will be a consistent environment to effectively host Synergetic.



Server design

Synergetic requires three distinct server roles to provide the platform to run the applications. These server roles can be serviced individually by separate servers (Database, Application & Web) or combined (Database + Application, Database + Web, Application + Web, Database + Application + Web). The server roles provide for security, scalability, high availability and disaster recovery.

Database role

  • SQL Server
  • Can be scaled to utilise SQL Server Availability Groups for high availability.

 Application role

  • Synergetic Windows application network share
  • Synergetic service suite – Crystal Reports Scheduler, DocMan, Notifications, VSN and SIF services
  • Windows SMTP service
  • Can be scaled to incorporate terminal services such as RemoteApp and Citrix XenApp for remote delivery.

 Web role

  • Synergetic web applications – SynWeb & Community Portal, Form Builder, Application Dashboard, Events Booking
  • CoreAPI web service – backend API service for Synergetic web applications
  • SynAPI web service
  • Synergetic web service
  • Can be scaled with load balancing and multiple web servers for high availability and performance.

Create your own design using the roles and determine which servers will be servicing which roles. Small installations can use a single server for all roles and larger installations typically use a separate server for each role. If you would like to explore high availability, this does not need to be implemented immediately and we recommend completing the Synergetic server installation first.

Server installation

Installation prerequisites

All that is needed is a fresh installation of Windows server with dotNET 3.5 and access to the SQL Server installation media either as an ISO image or a mounted disc for use with the Database role. The other roles will just need Windows Server with dotNET 3.5. You will need to provision enough servers to meet your design.

Step-by-step guide

The installer is a powershell script that will configure the server for each of the roles, validate the information and preferences provided and then perform the installation for you. You will need to repeat these steps for each separate server in your design.

  1. Log in to the new Windows Server which is going to host the Synergetic server role(s). Make sure to use a domain account that is also a local administrator.
  2. Unzip the Synergetic server installation toolkit to a temporary folder (ie: 'C:\Temp').
  3. If required, unzip the optional installer into the 'Installers' folder inside the temporary folder above. The optional installer includes the latest SQL Server Management Studio.
  4. Right-click ‘install - run as admin.bat’ and select ‘Run as administrator’.

 The installer will start and display a basic menu to guide you through the process.

Press '1' and 'Enter' for the Configuration options. 'Validate' will not be available until the configuration is complete and 'Start installation' will not be available until validation is complete and successful.

The General Configuration menu will be presented allowing you to configure the general server options. These options are not related to the more specific server roles. The installer will lookup the server name and IP address automatically. Please enter the outbound email server settings:

  • Email Server Name: This is name of the email server. This could be your internal Exchange server or even an external server such as Gmail or Office 365.
  • Email Port: This is the port number the email server accepts incoming email. By default this is set to port '25'. If you use authentication or encryption, this may be another port such as '587'.
  • Email TLS: Set this to 'True' if the email server requires encryption turned on, otherwise leave as 'False'.
  • Email Username & Password: If your email server requires authentication to connect, enter the username and password. This should not be a regular email account.
  • Email Alert Address: This is the email address of the person who will receive alerts from SQL Server if issues arise. This would typically be your IT helpdesk email address.

Once the general configuration options are set, select the server role you would like to configure next. Please note that all three server roles are enabled by default and roles not required will need to be disabled.

The Database Role Configuration menu will be presented allowing you to configure options for SQL Server. The installer will perform some investigations to provide meaningful default values for you.

  • Install Database Server role: Select 'Yes' or 'No'. If 'No', the rest of the options will be disabled. and you can safely select another role to configure.
  • Application Server Name: This is the name of the server servicing the Application role. Enter another server name if this is hosted on a different server.
  • SQL Server Version: This is the version of SQL Server that will be installed. The version number will be populated automatically if the SQL Server installation media is mounted and ready to install.
  • SQL Media Location: This is where the SQL Server installation media is located. This would typically be a drive letter of the media when it's mounted.
  • SQL Data Drive: This is the drive where the SQL user databases will be stored.
  • SQL Log Drive: This is the drive where SQL user transaction logs will be stored.
  • SQL TempDB Drive: This is the drive where the TempDB database is stored.
  • SQL Backup Drive: This is the drive where the backups will be written to.


The Application Role Configuration menu will be presented allowing you to configure options for the Synergetic applications. The installer will perform some investigations to provide meaningful default values for you.

  • Install Application Server role - select 'Yes' or 'No'. If 'No', the rest of the options will be disabled. and you can safely select another role to configure.
  • Database Server Name: This is the name of the server servicing the Database role. Enter another server name if this is hosted on a different server.
  • Synergetic Application Drive: This is the drive where the Synergetic folder and network share and will be stored.
  • Service Suite Drive: This is the drive where the Synergetic Service Suite will be stored.


The Web Role Configuration menu will be presented allowing you to configure options for the Synergetic web applications.

  • Install Web Server role - select 'Yes' or 'No'. If 'No', the rest of the options will be disabled. and you can safely select another role to configure.
  • Database Server Name: This is the name of the server servicing the Database role. Enter another server name if this is hosted on a different server.
  • Web Applications Drive: This is the drive where the web site folders will be stored.
  • Web Certificate Location: This is the location where the certificate is temporarily stored and ready to import.
  • Single or Multi Website: Select whether to group all of the Synergetic web applications into a single URL or use a separate URL for each.
  • Single URL: This is the single URL to use for all of the web applications.

Single Website layout example:


  • Single or Multi Website: Select whether to group all of the Synergetic web applications into a single URL or use a separate URL for each.
  • Synweb URL: This is the separate URL to use for SynWeb.
  • Portal URL: This is the separate URL to use for Community Portal.
  • SynCore URL: This is the separate URL to use for Synergetic Core.

Multi Website layout example:


Once all of the roles have been configured, select 'Q' to quit and save the configuration. This will return to the main menu.

The 'Validate configuration' option will now be available. Select '2' to start the validation process.

The process will validate the configuration of each of the roles that have been enabled. If a role has not been enabled, the validation for this role will be skipped.

  • Notes in green are informational only and no action is required.
  • Notes in yellow indicate warnings and display additional information or actions that need to be taken.
  • Notes in red indicate errors and the validation will fail. This will require correcting the configuration before re-validating.

Once the validation is completed, press any key. This will return to the main menu.

If the validation is successful, The 'Start installation' option will now be available. Select '3' to start the installation process.


The installation process will take a while to complete. Information messages will be displayed as well as several windows will open temporarily as the installation takes place.

The installation process will perform the following:

  • Changes Windows power plan to 'High Performance'
  • Database role:
    • Install SQL Server default instance with Reporting Services and SQL Server Management Studio if available.
    • Enable firewall rules for TCP 1433 & UDP 1434
    • Install SQL Server configuration scripts for Synergetic
    • Configures SQL Server DBmail.
    • Creates SQL Server Agent jobs for SQL Server backup and maintenance, Load Synergetic Database and Refresh Test from Production.
  • Application role:
    • Install Windows Server roles and features for SMTP service
    • Creates Synergetic application folder, configures network share and folder permissions.
  • Web role:
    • Installs prerequisite runtimes for Crystal Reports, Adobe Reader, SQL Server CLR and Microsoft Report Viewer.
    • Install Windows Server roles and features for IIS
    • Creates web sites, application pools and web applications for Synergetic web applications
    • Updates website folder permissions for Synergetic web applications

The Synergetic Server installation is now complete.  Validation and installation information is written to a log file located in the installation files folder and is a good place to start if any errors were displayed during installation.

Post installation Tasks

After the installation is complete there are a number of additional tasks that will need to be completed manually.

  • Install SQL Server Management Studio manually if required. The installer can be downloaded direct from Microsoft from here: http://go.microsoft.com/fwlink/?LinkID=822301
  • Alter the SQL server service account using a domain account such as 'domain\sql_srv' 
  • Using SQL Server Configuration Manager, Add -T272 startup parameter to the SQL Server instance.
  • Run SQL Server Management Studio and log in as 'sa' administrator. The default password is 'SynergeticSQL#5'
    • Under 'Server Properties' > 'Memory', set 'Maximum server memory' to (Memory-4GB: ie: 16GB-4GB = 12GB)
    • Manually configure test database 'Syn Refresh From Production' SQL Agent job with correct database names and path
    • Copy Synergetic database to use with this server to SQL backup drive SynBackup folder (ie: E:\SynBackup) and run 'Load Synergetic Database' SQL Agent job.
    • Important - Change the 'sa' password from the default and record this.
  • Configure SMTP service (if required) - further instructions can be found here: Email Service Configuration


Final Tasks

These tasks require employing the services of the Synergetic Systems team and cannot be performed by clients at this point. 

  • Provision SQL user service accounts
  • Install Octopus Deploy
  • Install and provision Synergetic applications and services through Octopus Deploy
  • Copy and update configuration files (if required)

The typical time required would be 2 hours at the usual rate. Please note there is typically a lead time before the work can be booked in and suggest booking a confirming early to avoid disappointment.

To log a ticket to request this, please click here: https://jira.synergetic.net.au/servicedesk/customer/portal/7



  • No labels