Installing Emcien with a VM

This article walks you through the process of installing Emcien.

Generally, installation is only performed by IT team members and Emcien support.

Not an IT person? Emcien can help you get things set up for free. Contact us at [email protected].

This process includes the following steps:

Minimum System Requirements

Currently, you can only install Emcien using a virtual machine (VM). To get started, you'll need a server that meets the following requirements:

RAM 16GB or more
Disk Space 500GB or more
Processor Intel or AMD x86 with at least 4 cores, each with a speed of 2GHz or more
VM Software VMware vCenter 5.1 or later

Installing the Emcien VM

After ensuring your server meets the minimum requirements, follow the steps below to install the Emcien VM.

  1. Download the Emcien Open Virtualization Archive (OVA) file.
  2. Deploy the Emcien OVA file as an Open Virtualization Format (OVF) template in VMWare vCenter.

    Refer to VCenter's documentation for more information about deploying OVF templates.

  3. During the Customize template step of the OVF deployment, configure your installation using the options below.

    Hostname The URL Emcien uses in links. Although you can also access Emcien using an IP address, the hostname is used in API links and other areas.
    Initial Admin Email

    Email address of the system administrator. The system administrator will provision the Emcien administrator and possibly additional users.

    Warning: Make a note of this email address. This email address must be used to sign into the Emcien VM for the first time and cannot be retrieved after the VM is deployed.

    Initial Admin Password

    Password for the system administrator.

    Warning: Make a note of this password This password must be used to sign into the Emcien VM for the first time and cannot be retrieved after the VM is deployed. The password can be changed in Emcien after the system administrator is signed in.

    Network 1 IP Address IP address for the Emcien VM. Leave all network settings blank for DHCP.
    Network 1 Netmask Netmask for the static IP settings.
    Default Gateway IP address for the Emcien VM’s default gateway.
    DNS One or more DNS server IP addresses, separated by spaces or commas.

    If you check Power on After Deployment during configuration, any changes made to the Emicen VM hardware settings in the Configure VM Disk Space section will not be applied until the Emcien VM is restarted.

    The OVF deployment initialization process should take a few seconds. The deployment step begins immediately after initialization. The progress bar under Recent Tasks will indicate deployment progress.

Configuring Hardware Settings

By default, Emcien is set up to use two hard disks: the application disk and the data disk.

The application disk contains the Emcien software and operating system.

The data disk contains data, including user files and database data. By default, the data disk has an initial size of 10GB.

We strongly recommend you increase the size of the data disk above the initial 10GB size. The disk size can be increased during initial VM configuration or when the Emcien VM is powered off.

Once allocated, the size of the data disk cannot be reduced.

You can change the following hardware settings for your Emcien VM:

CPU Defaults to 2. Supports 1 – 64. Increasing this will improve engine clustering speed.
Memory Defaults to 4GB. Increasing this will improve file parsing and performance.
Data Disk Ships with 10GB. Will need to be increased based on your data file sizes.

Launching the Emcien VM

After configuring your hardware settings, you are ready to launch the Emcien VM.

When launching the Emcien VM, the following screen is displayed.

If you checked Power On after deployment while configuring your hardware settings, this screen is not displayed. Instead, skip ahead to the Licensing Emcien.

Licensing Emcien

After launching the Emcien VM, you can license your installation of Emcien. You must license your installation before you can begin using Emcien.

  1. Inside the Emcien VM, open you preferred web browser.
  2. In the web browser, type the hostname set during the Installing the Emcien VM step.

    The Emcien license page is displayed.

  3. Copy the Instance UUID on the Emcien License page and email it to [email protected].

    We will respond with your license file.

  4. Save your license file to a location that can be accessed from the Emcien VM.
  5. On the Emcien license page, click Choose File and select your license file.
  6. Click Upload License.

    Emcien will process the license in approximately two minutes.

  7. When the license is processed, click Go to Emcien.

    The Emcien Sign In page is displayed.

  8. Sign into the Emcien Sign In page using the system administrator email and password set during the Installing the Emcien VM step.

    After you sign in, the Emcien System Admin page is displayed.

  9. On the Emcien System Admin page, click System in the upper right.

    The System page is displayed.

  10. Verify the Disk Path: the information in the right Disk Usage and Processor sections of the System page matches your settings from Configuring Hardware Settings.

Validating the Emcien VM

The final part of the Emcien installation is performing a test analysis. This test analysis will use one of the sample data sets included in the installation.

  1. On the Emcien home page, click Analyze Data. The New Analysis page is displayed.
  2. On the New Analysis page, select a data file from the list and click Start Analysis. The analysis progress bar is displayed.
  3. When analysis is complete, click View Analysis to view the report for the data set.

VM Space

The Disk Usage section of the System Administrator page shows the available physical disk space. If Working Area portion of the Disk Usage section reaches 5%, you should discontinue uploads until more disk space is available. Reducing the Working Area portion to 0% will crash Emcien.