User Guide

Ouvvi Online

This setup guide is for a new Ouvvi Online Instance hosted by Simego. Requires Data Sync Version 3.0.1260 and above.

Set Up Ouvvi Instance

Browse to your Ouvvi site via the link we have given you, and you will find it brings you to a setup page.

Setup Page

Setup Credentials

Choose between Simego Identity and Internal Identity (default).

The Simego Identity option means you can use the username and password you use to log into the Simego website. If you choose to use these make sure to enter in the same password you normally would use on the website. This will mean that if you change the password on the website it will change your password to log in to Ouvvi too.

The default option will enable you to use any username and password that you wish to use. The username does not need to be an email address. However you will need to make sure you remember these credentials as we will not be able to remind you of them if you forget them.

Credential Type

Set Regional Settings

Now choose your locale and set the time zone. You can choose to have this set in UTC or in your local time.

Completed Setup

Register License

If you have not supplied a license key when creating the instance, please go to Settings > Register License to ensure that you have a valid license entered.

Your projects will not run unless there is a valid in-date license key entered into the system.

To use Ouvvi Online you need to either have an in-date subscription license or in-date support and maintenance on your perpetual license.

If your support and maintenance has expired, this will need to be renewed before you can use this license key as Ouvvi Online will not retain your perpetual status.

Register License

Install an Agent

We now need to install an agent on a Windows Desktop PC or Windows Server, this needs to be somewhere that can run the Ouvvi processes, has access to the internet and has access to any systems that you want to connect to. Ouvvi requires at least one agent to run any jobs or processes.

Go to Services > System Services and click onto the Add Agent button.

Install Agent

Type in a name for your agent i.e. your machine/computer name and then click Next Step.

Adding a dependency name ensures that this agent only runs steps with the same dependency name assigned. Therefore you require at least one agent in your environment with no dependency. Dependencies are typically only for use in advanced scenarios.

For more information on dependency agents please see our documentation page here.

Name Agent

Now copy the text that appears in the blue box. You will need this to install your agent.

Copy Text

Now open Data Sync and go to Tools > Ouvvi > Online Agent Manager.

Online Agent Manager

Click the New Agent button to open the configuration window.

Add Agent

Now paste the text that you copied earlier from Ouvvi into the window and click OK.

Paste text

Type in a name for your agent and then click OK to install and create it.

Name Agent

You can now run your agent as a windows application or a windows service. To install as a service right click on your agent and choose Install Windows Service. You can also run as an interactive desktop application, to do this right click on your agent and choose Create Desktop Shortcut.

Typically we would install as a Windows Service, however it will depend on your setup and how you would prefer Ouvvi to run as to which option is best for you.

Install or Run

Edit the Windows Service

Before starting the service you may wish to go into Services Control Manager (services.msc) and change the windows account used to run the service. By default this is set as NETWORK SERVICE.

Locate your Agent in Services and edit the Ouvvi Service to set the Windows Account to run this Service.

Ouvvi Service Setup Ouvvi Service Setup

Start the Service

If you have chosen to install the agent as a Windows Service, you can start the service by selecting your agent and clicking the green play button or right clicking and choosing Start Service.

Start Service

Go back to your Ouvvi site and look at the System Services page, you will see that the agent has been created and the service is running. Ouvvi is now ready to use, and you can use the normal Ouvvi documentation to guide you on how to get started.

Services Running

Add Users

It is also recommended to add any additional users to your Ouvvi Instance and set their permission levels accordingly, by going to Settings > User Profiles > Add User. You can add additional admin users or just those that can start projects but cannot edit them.

For more information on users please see our documentation page here.

Add User