Installing ActiveEfficiency

To install ActiveEfficiency:

  1. Run the ActiveEfficiencyServer.msi. If you are running the installer on a server where UAC is enabled, start it from a command-prompt with elevated permissions – you may need to reboot the server.

  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:
     

    All prerequisites must pass in order to continue, except for MSMQ which is recommended if you are using Nomad.

    If the Windows MSMQ feature is not enabled then the 1E ActiveEfficiency service component is not installed, then some Nomad features of ActiveEfficiency will not work. This service is required by:

    • Nomad Sync (dashboard and pre-cache features) even though it does not use MSMQ
    • Nomad integration with WakeUp feature, which does use MSMQ and requires MSMQ to also be enabled on the NightWatchman server
  5. 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.
     
  6. 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.

    • If you have an existing ActiveEfficiency database you can optionally delete the existing data by checking the Drop any existing ActiveEfficiency database checkbox - if you select this option the existing data will be lost. ActiveEfficiency does not support database mirroring.
    • You can use a named instance with: <ServerName>\<InstanceName>. For example, if there is an SQL Server named instance called Admin on the server SMS01, set the SQL Server Name: field to SMS01\Admin.

      If you want to install ActiveEfficiency database on a SQL Server cluster or SQL Always-On:

      • Option 1 - SQL Server cluster - Specify the name of the SQL Server cluster in Step 6
      • Option 2 - SQL Always-On - Complete the setup from Step 1 to 9 and move the database to an Always-On availability listener group

      Edit the following config files, search for the <connectionStrings> tag, and replace each Server=name of the Always-On availability listener group:

      • <AE Install Directory>\Service\ServiceHost.exe.config
      • <AE Install Directory>\Web\WebService\Web.config

      The following is an example:

      Old Connection String
        <connectionStrings>
          <add name="ActiveEfficiencyDataContext" providerName="System.Data.SqlClient" connectionString="Server=DBServer;Database=ActiveEfficiency;Integrated Security=True;" />
          <add name="MassTransit" connectionString="Server=DBServer;Database=ActiveEfficiency;Integrated Security=True;" providerName="System.Data.SqlClient" />
        </connectionStrings>
      New Connection String
       <connectionStrings>
          <add name="ActiveEfficiencyDataContext" providerName="System.Data.SqlClient" connectionString="Server=SQLHADBServer;Database=ActiveEfficiency;Integrated Security=True;" />
          <add name="MassTransit" connectionString="Server=SQLHADBServer;Database=ActiveEfficiency;Integrated Security=True;" providerName="System.Data.SqlClient" />
        </connectionStrings>
    • If your SQL server is remote and TLS 1.0 is disabled in your environment you must install the SQL Server Native Client 11.0 (also known as SQL Server 2012 Native Client) on the Web server hosting the ActiveEfficiency application. If your SQL server is local you will likely already have the SQL Server Native Client installed, but you should check that this is the case.

      Check the TLS 1.0 disabled - install using TLS 1.1/1.2 checkbox. Further information can be found in the prerequisites for Web servers.

  7. 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.
    Using custom IIS settings in the ActiveEfficiency installer
    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, select the Use Custom IIS Settings option and update:

    • 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.
  8. On the Nomad Sync screen: 

    1. Tick the Enable Nomad Sync checkbox.

      Nomad Sync is required for the Nomad Pre-cache and Nomad Dashboard features of ActiveEfficiency.

    2. In Configuration Manager 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.

      Option 1- If you are installing a new setup for ActiveEfficiency and CM database on SQL Server cluster or Always-On please provide the name of the SQL Server cluster or Always-On availability listener group.

      Option 2- If you already have a ActiveEfficiency installed with CM database on standalone instance, which was moved to a SQL Server cluster or an Always-On availability group, you will have to uninstall and re-install ActiveEfficiency using the name of the SQL Server cluster or Always-On availability listener group.

      Add ActiveEfficiency server name in ConfigMgr_DViewAccess group on all nodes.

    3. In Configuration Manager database name, enter the name of your Configuration Manager database.
    4. Set the synchronization interval in minutes. The default is 30 minutes.
    5. Click Next.
       
  9. 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 customizations to site bindings, the ActiveEfficiency service account or the servicehost.exe.config file, you must note these and reapply them after the upgrade.