Downloading the latest version of Sonia

Introduction 

The Sonia Deployment Builder is an online tool provided by Lumivero to enable clients to quickly and easily access the very latest version of Sonia and its support tools. 

This assumes the institution has a dedicated Sonia server (known as Sonia Full).

This article outlines the fields present within the Sonia Deployment Builder tool and their expected contents.  

Sonia Deployment Builder 

The Sonia Deployment Builder is located at https://deploy.sonia.com.au 

 

Version: The version field is a dropdown list of all the currently available versions of Sonia. The list will display the latest public release of Sonia by default. Earlier versions can be selected. 

Package Date: Within each version of Sonia there are multiple releases. The package date reflects the date the release was created. The latest release will display by default. Earlier releases can be selected. Note that the date is in DD/MM/YYYY format.

Components: The specific build numbers for each of the core Sonia components are displayed based on the version and package date selected. 

License Key: A valid license key must be supplied in order to download Sonia. The .zip file created by the Sonia Deployment Builder will be password protected with the key as the password. 

There are two options for installing the Sonia Client, and both are included in the package unless you select specific options: 

• MSI Installer: Installed on a terminal server which is accessed by all client machines or applied as part of a SOE deployment script. 
• Click Once (most common): Installs on the client machine by way of a URL; automatically updates if the server version changes. 

Additional options:

1. Azure deployment: Creates a zip that includes zips for each component rather than setup executables.  It also does not include the MSI installer. 

2. Include ClinConnect and Importer tools: An optional set of tools for integration with placement providers can be included in the deployment.  (These are mainly only used in Australia.) 

3. Exclude Click Once Sonia Client component: If your installation of Sonia will be utilising the MSI installer of the Sonia Client

4. Including the Click Once Sonia Client 

MSI Installer option

1. Tick the Exclude the Click Once Sonia Client component option. Note: This will hide the configuration fields as these only apply to the Click Once deployment.

2. Click the Create Deployment Package button at the bottom right to begin the deployment. 

3. Once the Progress metre reaches 100% the download will automatically begin. 

4. A link also appears in the status area below the Progress metre that can be used if the download doesn’t begin automatically. 

 

Click Once Sonia Client option 

Note: The Click Once Sonia Client is included in the complete package if you do not tick both the Exclude and Include options. 

This option allows you to specify that you only want the Click Once Sonia Client component rather than a complete package of the various components. This is handy if you misconfigure the deployment credentials, etc. then you can regenerate only the click once component instead of a complete package; the result being smaller and saving time downloading. 

 

Click Once Client settings: 

 

1. Type the Client application Name as you would like it to appear on the desktop of the client users. The default is Sonia, but for each of your deployments you might want a different name; for example, a test server may have Sonia Test entered in this field. 

2. The Client deployment URL is the URL from which your client users will install the Sonia Client. This should be secure, i.e. https. 

3. The Sonia Entities URL is the URL that the Sonia Entities will be installed, and this should be secure, i.e. https. 

4. The Client/Server Binding is a dropdown list selection. However, Internet should always be selected as the other options are now obsolete. 

5. The Service Host URL is the URL that the Sonia Service Host will be installed, and this should be secure, i.e. https. 

6. The Message Credential Type is a dropdown list selection: 

1. 1. Windows: Your client users will be authenticated using Windows authentication. 

   2. UserName: Your client users will be authenticated using Sonia or SAML authentication.  This option is the most popular and the one that is used on cloud environments such as Microsoft Azure.

7. The Default Domain is optional. This appears as the default domain if client users are using Windows authentication and are prompted to enter login credentials. If a client user is logged into their machine with the account they have been given access to Sonia with, they will not be prompted to enter login credentials unless they are enforced to do so via one of the configurations. For cloud environments such as Microsoft Azure, leave this blank. 

8. For each of your installations you must select a different Type of setup option. You must also select the same option for every subsequent upgrade of the same installation, otherwise the automatic Click Once upgrade will not work. The selection allows for up to one production environment and three test environments. 

9. Create deployment package 

• • Click the Create Deployment Package button to begin the deployment. 

  • Once the Progress metre reaches 100% the download will automatically begin. 

  • A link also appears in the status area below the Progress metre that can be used if the download doesn’t begin automatically.