Version: 1
restore

Contents

To install ActiveEfficiency:

  1. Run ActiveEfficiencyServer.msiIf you are running the installer on a server where UAC is enabled, start it from a command-prompt with elevated permissions.

  2. On the Welcome screen, click Next.
  3. On the License Agreement screen, accept the license agreement and click Next.
  4. On the Prerequisite Checks screen, the installer runs checks to see if the following are installed before it continues:
    ActiveEfficiency installer prerequisite checks
    • MSMQ is a prerequisite for the Nomad dashboard, so if that fails the 1E ActiveEfficiency service component will not be installed
  5. On the Enable 1E ActiveEfficiency Cloud Connection screen: 
    Opting to connect to the ActiveEfficiency Cloud service
    • Select the Yes I want to register with 1E ActiveEfficiency option and click Next to complete the registration if you want to take advantage of the cloud service
    • If you do not want to take advantage of the cloud service, do not select the Yes I want to register with 1E ActiveEfficiency cloud option and click Next to skip this process

    1. In the Register with 1E ActiveEfficiency Cloud screen, click Create 1E ActiveEfficiency account and enter your credentials.
      Creating an ActiveEfficiency Cloud account
      If you have previously created an account, use your existing credentials. If this is the first time, the process is described here.
  6. On the Destination Folder screen, choose the folder where you want ActiveEfficiency installed. By default, it installs to C:\Program Files (x86)\1E\ActiveEfficiency\. You can choose a different location by clicking Change... Click Next to continue.

  7. On the Database Server screen, enter the name of the server where you want the ActiveEfficiency database installed and click Next. Checks are made to see if the specified machine is an SQL server.

    Installing the ActiveEfficiency on your database server

    You can opt to drop an existing ActiveEfficiency database if one exists – do this is you want a clean installation. Do not use this option if you are upgrading. By default, this option is disabled to preserve your existing data. You can also rename of the ActiveEfficiency database that gets created and when you upgrade, it will leave the existing database intact and create a one with the new name. ActiveEfficiency does not support database mirroring.

    You can use a named instance with: <ServerName>\<InstanceName>. For example, if there is an SQL named instance called Admin on the server SMS01, set the SQL Server Name: field to SMS01\Admin.

  8. On the ActiveEfficiency Website Settings screen, accept the defaults and Click Next or modify the default settings for the ActiveEfficiency Website by ticking the Use Custom IIS Setting checkbox. Exercise caution when doing this and ensure that any changes you make are reflected in the DNS, router and firewall. If you want to customize the settings, check Use Custom IIS settings and update:
    Using custom IIS settings in the ActiveEfficiency installer

    • IIS Port – port used by the ActiveEfficiency Web API
    • IP Address – IP Address for the ActiveEfficiency Web API
    • Host Header – host reader for the ActiveEfficiency Web API. This is the server name used to locate the ActiveEfficiency Web API.

    Any customizations to the ActiveEfficiency Web API will need to be used in all the consumers of data from the ActiveEfficiency Server when configuring the connection to ActiveEfficiency server.

    In order to use a customized host header name, ensure the changes are reflected in your DNS settings.
  9. On the Nomad Sync screen:
    Synchronizing Nomad with Configuration Manager
    1. Tick the Enable Nomad Sync checkbox.
    2. In CM Database Server, enter the name of the server hosting your Configuration Manager database.

      If you are installing ActiveEfficiency on the same server as the Configuration Manager database, do not use its Fully Qualified Domain Name. Use local or the name of the server instead.

    3. In CM Database Name, enter the name of your Configuration Manager database.
    4. Set the synchronization interval. The default is 30 minutes.
    5. Click Next.
  10. On the Ready to Install the Program screen, click Install.
Post-installation, you may want to consider securing the ActiveEfficiency Website.

Upgrading ActiveEfficiency

You should upgrade both the ActiveEfficiency Server and the ActiveEfficiency Scout at the same time.

If you made customisations to site bindings, the ActiveEfficiency service account, the servicehost.exe.config file or recreating the ActiveEfficiency cloud certificate you must back these up and restore them after the upgrade.