Skip to main content

Moving Ouvvi with a New Database

Ouvvi has an export/import feature that enables you to export your full Ouvvi configuration including your connection library, user settings and triggers alongside your groups and projects and import these into another tenant.

If you are upgrading from a version of Ouvvi released before V6 please take a look at our upgrade docs which will lay out the considerations you need to have and the steps you should take.

Create the New Ouvvi Tenant

Start by opening the Deployment Manager, this can be accessed by opening Data Sync, expanding the Tools menu and selecting Ouvvi Deployment Manager.

We can either take the default install that is offered when you first open the deployment manager and make a few changes or we can create one from scratch. These both follow the same principle but creating a new tenant has a couple more steps to get started.

To create a new Ouvvi Tenant within the Deployment Manager you can then either click onto the New Tenant button in the toolbar or you can open the file menu and select New Tenant.

New Tenant Button New Tenant

Install IIS components

Before installing the Ouvvi tenant you will first need to ensure that the default IIS configuration is installed. To do this open the Tools menu and select Install IIS Components.

This will run a PowerShell Script to install the required IIS Components. Click return/enter to continue once the script has run.

Install IIS

Install SQL Server

Ouvvi requires a SQL Server to run and store all of the necessary project files. It can be run on all editions of Microsoft SQL Server, from SQL Express through to Enterprise Edition.

SQL Express is typically used to deploy Ouvvi unless you have an existing SQL Server.

To download SQL Server Express edition open the Tools menu and select Download SQL Express which will begin the download of the SQL installer. Please note that this will open a command window whilst it downloads.

Install SQL Express

Once this has downloaded the SQL Server setup window will open. Run through this changing any of the settings if you need to, otherwise you can keep clicking next until the installation is complete.

Configuration

You now need to configure the tenant settings before installing, to do this double click onto the tenant to open the configuration window where you can set the configuration settings for your tenant; such as the Tenant Name, Tenant Path and the Site Port you wish to use to browse to your Ouvvi site.

note

Please note that a random IIS Port will be assigned by default when you add a new Tenant so you may wish to change this to be a different port. If you plan to make Ouvvi available externally from this server be sure to configure SSL/TLS in IIS after you install this instance to keep your instance secure.

If your SQL Server is on another machine you should configure a Windows Service Account that will be the IISAppPool Identity used to authenticate with your SQL Database.

info

The default NT AUTHORITY\NETWORK SERVICE is a machine account and can be used when you have a single server set-up. i.e. Ouvvi Website, Service and Database are all on the same server.

Configuration Tab

Database Setup

You now need to point the configuration to the SQL Server that will host your Ouvvi Database under the Database tab.

Enter the path to the SQL Server instance and then select the Ouvvi database from the drop down options.

info

SQL Authentication is only required when you cannot use Integrated Security and is not recommended unless this is your only option. Therefore, SQL Authentication is usually left blank.

The install will add the IISAppPool identity as DBO to the Ouvvi Database only when creating the Database. If you attach to an existing database ensure that the IISAppPool identity has permission to access the SQL Database.

If your SQL Server supports connection encryption make sure to set the Encrypt and Trust Server Certificate settings appropriately for your SQL Server connection.

Database Configuration

Service Setup

The Ouvvi Windows Service should be configured to run under a network domain account as this account will be used as the security context to run the steps within Ouvvi.

info

The default account NT AUTHORITY\NETWORK SERVICE is a machine account and can be used to access local machine resources and internet based services with a username and password.

For Local Domain services SQL Servers, SharePoint Servers, FileShares etc a Domain User account must be used.

If you decide to change this from the default you will need to ensure that the service account has Admin+Agent permission set in Ouvvi. For more information on how to set admin and agent permissions please visit the Agents page.

Service Configuration

Install Ouvvi

The next step is to install the tenant you've just been defining. To do this right click onto your tenant and select Install.

Install Tenant

This will then install the Ouvvi site. If you are getting errors please check that you have installed IIS and that the account has permissions to create the database.

Browse to Site and Install License Key

You now need to browse to your Ouvvi site to finish setting up the database. You can so this by right clicking onto the tenant and selecting Browse from the list.

Browse to Site

Check that the settings are correct and then click "Setup" to create the tables.

info

If you are getting permission errors then please check that the service account has read/write permissions within the Ouvvi database.

![Setup Database]("Setup Database")

Finally make sure to input your license key, by either clicking onto teh activate hyperlink in the top banner or by opening the Settings menu and selecting Register License. Without a license key your projects and steps will not run once they have been imported.

Start Services

Now go back to the deployment manager and start your services. You can do this either by clicking the green play button in the menu or by right clicking on your instance and selecting Start Service from the list.

Start Services

This will open the browser to the Agent Service configuration page to allow you to setup the services. Click onto Setup Services to setup and start the service. Once this has been done the page will redirect to the services table where you can see green flags which means the services are running.

Solution Export/Import

The solution export creates a zip folder containing all of the details you selected to be included about your Ouvvi tenant configuration. By default everything is selected however you can exclude any projects you do not want to include.

Export

To Export your Ouvvi site go to the projects overview (all) page and select the Export button in the toolbar. Export Project Button

This will open the export view where you can check the checkbox against any items you want to export. If you wish to include your connection files and user settings, please check the checkboxes for each of these. You can mark all of the projects to be exported by selecting the checkbox next to the header Groups, this will select everything in the list.

When you have selected all of the items to export click Export. This will download a solution file into your local downloads.

Choose Export Items

Import

Once you have a solution file exported you can upload this into another Ouvvi instance.

To do this open the All Project view page in the Ouvvi instance you are uploading into, and click Import in the sub menu.

Import Project Button

This will open the import view where you can select a file to import. Click onto the Choose File button to browse for your solution file in your the file explorer. Once you are done click Next to load the file.

Import Solution

This will load the various sections within the solution file into a tabular view. Click through the tabs to check everything is included and correct. You can exclude items from the import by unchecking the checkbox. When you are ready click Import to load the selected items.

Import Groups

Your files will have now been loaded and will be visible on their corresponding pages. I.E. Projects on the Projects page, Groups listed under projects and visible in the Groups Table etc.#

You should now be able to view and run all of your projects.

caution

You must make sure to stop the services on your old Ouvvi site to prevent the projects running in two locations. If you run the same project in two locations can lead to data loss and data being overwritten. Making sure that you only run the projects in one location saved you from lots of future issues.

Encryption

If you have encryption applied to your environment remember to install the encryption key in Data Sync and Ouvvi. You also need to ensure that the permissions for the private key of the certificate are for the local machine and that the Ouvvi app pool user and any users running Data Sync and Ouvvi have permissions on that certificate.

You can read more on reinstalling the encryption key on the migration overview page

If you do not install the encryption key then your projects will not run and will need to be re-made.