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:
- License.xml file that you received from Prosperoware
- Domain username and password of the Umbria service account
- Umbria database server and credentials:
- SQL server where the Umbria database resides
- Login for database access. This can be pass-through authentication using the Windows service account or an explicit SQL account with full rights to the Umbria database.
- Database name
- LDAP configuration:
- Domain
- Login of account that has read access to ADS
- LDAP path
- Users path
- Time & Billing connection information:
- SQL server
- Database name
- User credentials. Both Windows authentication and SQL server credentials are supported.
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, Umbria PQS or Elastic Search:
- Download the EXE version of the Umbria 3.1 installer from Prosperoware Support (login required) to a temporary location.
- Navigate to the download location and double-click the program to start the Prosperoware Umbria Installer. To continue without installing Elastic Search skip steps 3 and 4.
To install Elastic Search:
-
In the Prosperoware Umbria Installer Setup dialog, check I agree to the license terms and conditions. Select Options and check, Install Elasticsearch 5.5.1 and click OK. After installing any missing prerequisites, the installer will close and the Setup Wizard will appear.
-
In the Elastic Search configuration window, follow these steps:
- On the Locations tab, set the directory of installation. Keep the default or set a different directory.
- On the Service tab, change user account that runs the service.
- On the Configuration tab, only change the amount of memory for elastic to use. We recommend between 30-50% of the RAM to be set for elastic.
- On the Plugins tab, do not change anything and click Finish.
- Click Exit to complete the Elastic install. To complete the Umbria setup, refer steps given below.
- 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.
- On the Welcome to the Prosperoware Umbria Setup Wizard screen, click Next to proceed to the End-User License Agreement.
- 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.
- 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.
- 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.
- On the User Information screen, uncheck Skip IIS configuration... and then click Next.
- 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\.
- Click the System User radio button and click Next. The Ready to install Prosperoware Umbria screen appears.
- Click the Install button. The installer proceeds to download needed components.
- Once the installer has finished, a Completed the Prosperoware Umbria [build #] Setup Wizard dialog appears; click Finish. The Setup Wizard closes.
- Click Close on the Prosperoware Umbria Installer pop-up box once it notes Setup Successful.
- Proceed to the instructions for installing the optional Umbria Client or skip forward to granting access to the configuration file.
To install the Umbria Client:
See the Excel Add-On page under the End User Guide for instructions about installing this optional add-in (also known as the Umbria Client). When finished, proceed to the instructions for granting user access to the Umbria configuration file.
Granting Access to the Umbria Configuration File
- Open Windows File Explorer and navigate to the C:\Program Files\Prosperoware.Umbria folder.
- Right-click the Prosperoware.Umbria folder and select Properties. A pop-up box appears.
- At the top of the pop-up, click the Security tab.
- Scroll through the Group or user names field and select Users.
- Click the Edit button. The Permissions pop-up box appears.
- Scroll down the Group or user names field and select Users.
- Make sure all check boxes are selected in the Allow column and click OK. The Permissions pop-up closes.
- On the Properties pop-up box, click OK.
- Proceed to the instructions for creating a new SQL database.
Creating a New Database
- Open Microsoft SQL Server Management Studio. The application and Connect to Server pop-up appear.
- Select and connect to the needed server from the provided drop-down list.
- On the left side of the application window, expand the server and Databases folders.
- Right-click on the Databases folder and select New Database…. The New Database dialog box appears.
- 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.
- 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.
Option 2 - UmbriaAgent.exe
- 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
- Umbria, when installed, automatically saves the Agent as a service in Windows Services.
- 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:
- Open a web browser and enter http://<Server Name>/Umbria in the address bar.
- On the Umbria welcome screen, click Next. The Database Setup page appears.
- Enter the following fields in the table and click Next.
Server Name | The name of the SQL server hosting the Umbria database. |
Database Name | The 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 Username | A name for the default administrator account in Umbria. |
Umbria Admin Password | The password for the default administrator account in Umbria. |
- Umbria attempts to connect to the SQL Server and creates the required tables within the database. The Active Directory setup page appears.
- Fill in the following fields in the table (if using) and click Next.
Active Directory Domain Name | The domain controller (DC) or container name (CN) that contains the users to be synced to Umbria. |
Admin User ID | A domain user account with read access to the DC/CN specified above. |
Admin Password | The password for the user specified above. |
Ldap Path | The path to your LDAP server, which must start with LDAP://. |
Full Domain Name | Optional. |
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.
- On the Accounting System Setup page, either click Skip or fill out the fields if applicable, then click Next. .
- The Assign Groups And Users Setup page appears.
-
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
- On the Client Offices Setup page, click Skip.
-
On the Seed Data page, you can select out-of-the-box additions, such as Budget Templates, Export Templates, Fee Classes, and Phase and Task Codes etc. Click Next when done.
Note
- For Umbria to work properly, at minimum, check all the Monthly Exchange Rates checkboxes.
- For Umbria 2.1.1 and newer versions, do not import monthly exchange rates as these are either imported or created using a background stored procedure.
- For any data set, except Budget Templates you can import data set randomly
- For successful import of Budget Templates from Seed Data, please ensure you have imported other prerequisite data set : Matter Types, Areas of Law, Matter Sub-types, Fee Classes, Phase and Task Codes, Monthly Exchange Rates and UTBMS Code.
-
The Analysis Services Setup page appears. Complete the page based on the table below.
Relational Data Source Information for Analysis Server | Connect to the Umbria database you setup on the Database Setup page, and the appropriate information is filled in by default. |
Analysis Server Information | Create 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. |
- Click Next. In the Server Setting(s) page, select the sign-in authentication type you want to set for Umbria login. Click Next
- In the Import Settings(s) page, check box to set up import jobs. To initiate an import, the Accounting System must be set up.
- The analytics database is created, and you are directed to the Umbria main dashboard. The installation and initialization are complete.
Note: The user may not have permission to access the Umbria home page. Refer to the Admin>Security for user access and setup.
Tip: To maintain your installation of Umbria, see the page on Database Maintenance Plan Requirements for recommended daily and weekly maintenance.