Device Tagging Feature

The following components are involved in getting Device Tagging information into AppClarity 5.2.

  • The Web API is used by the Scout and scripts to store information in the ActiveEfficiency database and enables the information to be retrieved for use in AppClarity 5.2.
  • The Scout or ActiveEfficiency Agent must be run first in any mode to create the basic data for the Device Tagging script to add onto. This is required so that the information for a device to be tagged will get sent on to AppClarity 5.2.
  • The Device Tagging script uses the Web API to add data into the ActiveEfficiency database. The data is then matched with information retrieved by the Scout from the ConfigMgr database to ensure that each device is tagged with the right information.
  • AppClarity 5.2 is a consumer of the data set by the Device Tagging Script.

On this page:

Running the Device Tagging Feature

This page describes how Device Tagging information is retrieved from the network and passed to AppClarity 5.2.

To connect the Device Tagging information with the devices stored in AppClarity 5.2 the Scout or ActiveEfficiency Agent must be run first in any mode that retrieves information on devices. The Device Tagging feature uses a script to retrieve device information and store it in ActiveEfficiency. The information is then retrieved by AppClarity 5.2 by synchronizing its ActiveEfficiency Connector.

Configuring AppClarity 5.2 Integration

We recommend that the Scout, Device Tagging script and ActiveEfficiency Connector components are configured to run on a schedule using Windows Task Scheduler.

The following table shows the recommended schedules that should be used for the components:

ScoutOnce a day
Device Tagging ScriptOnce a day - though this can be varied according to how often the information being retrieved is likely to change.
ActiveEfficiency ConnectorSynchronized using the AppClarity Connector Synchronizer once a day

We recommend that the components are also run in the order they appear in the table so that the latest information is always passed on as soon as possible.

Running the Scout

For the Device Tagging feature you will need to run the scout in ConfigMgr mode. In a default installation, the scout is located in the following directory:

C:\Program Files (x86)\1E\ActiveEfficiency\Scout\

There is only one command-line parameter applicable to the ConfigMgr scout, called Modes, which is described in Scout Command-line. To run the ConfigMgr scout on its own without the Server scout you run the following command-line:

C:\Program Files (x86)\1E\ActiveEfficiency\Scout\Scout.exe Modes=ConfigMgr

Device Tagging Scripts

A Device Tagging Script should aim to retrieve information for devices from the network and then use the ActiveEfficiency Web Service through the ActiveEfficiency Web API to post information back to the ActiveEfficiency.

An example script that retrieves device information from Active Directory is described here.

Getting the data to AppClarity 5.2

Please follow the AppClarity 5.2 documentation to synchronize the ActiveEfficiency Connector. Please refer to AppClarity 5.2 - Connecting to ActiveEfficiency.