Getting Started > Installing Umbria

Installing Umbria

Two file types are used for installing Umbria. The MSI file installs Umbria only, while the EXE file installs Umbria and any needed prerequisites. When installing for the first time, use the EXE file; subsequent upgrades can use the MSI file. The instructions below are applicable to either installation file, as the process is the same.

Preinstallation Checklist

Before installing Umbria for the first time, have the following information handy:

Running the Umbria Installer

These instructions apply only when installing a fresh copy of Umbria. See Upgrading Umbria for instructions on upgrading from a previous version. During most implementations, the Web server is installed separately, which makes the installation process overall shorter. It is acceptable to install the Web server and Agent at the same time if installing on a local machine for testing purposes with only a sample database of data.

To install the Umbria Web server, Umbria Agent, :

  1. Navigate to the download location and double-click the program to start the Prosperoware Umbria Installer.
  1. Note: With the installer, Open JDK is now included as part of 2020.1.1.

  2. In the Prosperoware Umbria Installer Setup dialog, check I agree to the license terms and conditions and click Install. After installing any missing prerequisites, the installer will close and the Setup Wizard will appear.
  3. On the Welcome to the Prosperoware Umbria Setup Wizard screen, click Next to proceed to the End-User License Agreement.
  4. After reading through the license agreement, check I accept the terms in the License Agreement and click Next to advance to the Destination Folder screen.

    Tip: You cannot continue past this step if you do not accept the License Agreement.

  5. If you would like to install Umbria somewhere other than the default location of C:\Program Files\Prosperoware.Umbria\, click Change... and navigate to your desired installation folder; otherwise, leave the path unchanged. Click Next to continue to Custom Setup.
  6. By default, the Setup Wizard will install all Umbria components to the current machine. To install only one component, click the other components and select Entire feature will be unavailable. Click Next to continue to the User Information screen.

    Note: The Windows Features screen may appear if there are Windows components that will be enabled during installation. To skip installing the features, check Don't enable Windows features. Click Next to continue to the User Information screen.

  7. On the User Information screen, uncheck Skip IIS configuration... and then click Next.
  8. Tip: The Skip IIS configuration will be checked if there is no web server installed.

  9. Under License Key, click Browse and use the Open dialog to locate and select your license file (license.xml) and click Next. The User Information for Windows Services screen appears.

    Warning: You cannot continue with the installation past the User Information screen unless you specify a path to a valid license file.

    Tip: Prosperoware recommends keeping the license key file, License.xml, saved in the default application folder of C:\Program Files\Prosperoware.Umbria\.

  10. Click the System User radio button and click Next. The Ready to install Prosperoware Umbria screen appears.
  11. Click the Install button. The installer proceeds to download needed components.
  12. Once the installer has finished, a Completed the Prosperoware Umbria [build #] Setup Wizard dialog appears; click Finish. The Setup Wizard closes.
  13. Click Close on the Prosperoware Umbria Installer pop-up box once it notes Setup Successful.
  14. Proceed to the instructions for installing the optional Umbria Client or skip forward to granting access to the configuration file.

Granting Access to the Umbria Configuration File

  1. Open Windows File Explorer and navigate to the C:\Program Files\Prosperoware.Umbria folder.
  2. Right-click the Prosperoware.Umbria folder and select Properties. A pop-up box appears.
  3. At the top of the pop-up, click the Security tab.
  4. Scroll through the Group or user names field and select Users.
  5. Click the Edit button. The Permissions pop-up box appears.
  6. Scroll down the Group or user names field and select Users. Set the service account that is granted for Umbria.
  7. Make sure all check boxes are selected in the Allow column and click OK. The Permissions pop-up closes.
  8. On the Properties pop-up box, click OK.
  9. Proceed to the instructions for creating a new SQL database.

Creating a New Database

  1. Open Microsoft SQL Server Management Studio. The application and Connect to Server pop-up appear.
  2. Select and connect to the needed server from the provided drop-down list.
  3. On the left side of the application window, expand the server and Databases folders.
  4. Right-click on the Databases folder and select New Database…. The New Database dialog box appears.
  5. In the Database name field, type the name for your database to hold Umbria. Prosperoware recommends using Umbria or something similar. Click OK. The New Database pop-up closes.
  6. Proceed to the instructions for installing the Umbria Agent.

Installing Umbria Agent

Note: On Umbria fresh installation, to enable Agent, and Data Sync setting, allow the user complete Admin access. Admin: Roles>Select desired role to grant full Admin Access> Select “Administrator” as Permission group> Check all permissions on right side

During most implementations, the Agent is installed separately, which makes the installation process overall shorter. It is acceptable to install the Web server and Agent at the same time if installing on a local machine for testing purposes with only a sample database of data.

Option 1 - Umbria UI

Open the Service Agents window from the Admin Panel. If you change one of the service agents in the processors window, or check an agent job on an agent, it queues up the agent selected.

Note: Sometimes the Agent may need IIS to be restarted. Use either a restart in the IIS UI or the IISReset command on an elevated Windows command prompt to start/stop/reset.

Note:The service agent is not uninstalled on upgrade any longer. The service is stopped, then files replaced then started.

Option 2 - UmbriaAgent.exe

  1. Edit the CalibanAgent.exe config file with Notepad or a similar program. Change the two connection strings appropriately and click Save.

Option 3 - Windows Services

  1. Umbria, when installed, automatically saves the Agent as a service in Windows Services.
  2. Open Services, find the Umbria Agent service, and click Start. A refresh of the Service Agents panel in the Umbria UI occurs and shows the newly opened Agent.

Note: If you need to restart a service, Prosperoware recommends stopping then starting the service instead (with a small pause in between). On some hardware, if a pause is not observed, the service starts before an active connection to SQL opens up, causing a failure.

Web-Based Setup

Now that Umbria has been installed, the SQL database has been created, and access granted to the configuration file, Umbria must be configured through a local web browser.

To start the web-based setup:

  1. Open a web browser and enter http://<Server Name>/Umbria in the address bar.
  2. On the Umbria welcome screen, click Next. The Database Setup page appears.
  3. Enter the following fields in the table and click Next.
    FieldDescription
    Server NameThe name of the SQL server hosting the Umbria database.
    Database NameThe name of the database that you created on the SQL server to be used by Umbria.
    Authentication

    The authentication method used by Umbria to connect to the SQL server.

    If Integrated is selected, Umbria attempts to connect to the database using the credentials of the service account used by the Umbria application pool.

    When SQL Server is selected, you must specify the user name and password of an account on the SQL server with access to the Umbria database in the Database UserName and Database Password fields that are displayed below the Authentication drop-down menu.

    Umbria Admin UsernameA name for the default administrator account in Umbria.
    Umbria Admin PasswordThe password for the default administrator account in Umbria.
  4. Umbria attempts to connect to the SQL Server and creates the required tables within the database. The Active Directory setup page appears.
  5. Fill in the following fields in the table (if using) and click Next.
    FieldDescription
    Active Directory Domain NameThe domain controller (DC) or container name (CN) that contains the users to be synced to Umbria.
    Admin User IDA domain user account with read access to the DC/CN specified above.
    Admin PasswordThe password for the user specified above.
    Ldap PathThe path to your LDAP server, which must start with LDAP://.
    Full Domain NameOptional.

    Tip: If you are unsure as to which values to enter in the above fields, download the Active Directory Explorer tool from Microsoft here, which allows you to confirm your Active Directory configuration.

  6. On the Accounting System Setup page, either click Skip or fill out the fields if applicable, then click Next. .
  7. Select the user groups or people imported from Active Directory (AD), if any, that you want to have certain access then click Next. You can select users by expanding the dropdown list and clicking each user/group's name. Options include:

    • System Admins
    • Partners
    • Pricing Team
    • Associates
  8. On the Client Offices Setup page, click Skip.
  9. On the Seed Data page, you can select out-of-the-box additions, such as Planning Templates, Budget Templates, Dashboards, Export Templates, Fee Classes, and Phase and Task Codes etc. Click Next when done.

    Note
    1. For exports to work on migrated matters/budgets, you should always select the Widget Base Templates to be installed on the Seed Data page.
  10. The Analysis Services Setup page appears. Complete the page based on the table below if using cubes. Skip if not using cubes.

    SectionInstructions
    Relational Data Source Information for Analysis ServerConnect to the Umbria database you setup on the Database Setup page, and the appropriate information is filled in by default.
    Analysis Server InformationCreate a connection to the Umbria analytics database. Enter the desired server name and analytics database name. It is okay to call these the same name as the relational database, as they are on different parts of the SQL server.

  11. Click Next. In the Server Setting(s) page, select the sign-in authentication type you want to set for Umbria login. Click Next
  12. The Planning Setting(s) page displays. Check box to create a default firm arrangement and a default rate card. Click Next.
  13. In the Import Settings(s) page, check box to set up import jobs. To initiate an import, the Accounting System must be set up. Read here for detailed instructions to set up an import job.
  14. The analytics database is created, and you are directed to the Umbria main dashboard. The installation and initialization are complete.
  15. The final step is to go to Admin-> Dashboard and import the out of the box dashboards.

Tip: To maintain your installation of Umbria, see the page on Database Maintenance Plan Requirements for recommended daily and weekly maintenance.