Analytics Manager > Configuring Analysis Agents > Configure the Microsoft Excel Agent
Configure the Microsoft Excel Agent
Excel Compatibility
The following chart shows compatibility between versions of Analytics Manager and Microsoft Excel.
Manager Version
Operating System
Excel Version
Windows 7
2013, 2016 (32 bit)
English (US)
Windows 7
2013, 2016 (32 bit)
English (US)
Windows 7
2013, 2016 (32 bit)
English (US)
Windows 7
2013, 2016 (32 bit)
English (US)
Ensure that you have the following set before you install and configure the Microsoft Excel agent:
Install Visual C++ Redistributable for Visual Studio 2012 Update 4
To do this, go to, and click Download. Select the VSU_4\vcredist_x64.exe package, and click Next. After the package downloads, install the package.
Ensure that you have created an analysis provider for Excel by using the TW.AnalysisServices.Excel.ExcelConnector analysis connector that is provided with the extension. For more information about creating an analysis provider, see Create an Analysis Provider.
Install the Excel Agent
The Excel agent is available in the analytics-manager-tools folder in the Analytics Manager extension zip file. In the analytics-manager-tools folder, double-click TWX_AS-ExcelAgent.msi to install the agent.
Configure the Excel Agent
To configure the Excel agent after you install it, open the file in the installation directory of the agent. This XML file contains the configuration settings for the Excel agent. Add or edit the following values in the appSettings section using the correct XML syntax:
Specifies the key used to communicate with ThingWorx without requiring any other authentication. You can use the default or create your own key in ThingWorx and specify it here.
Specifies the URI of the ThingWorx server where the Analytics Manager framework is running. For example, ws://localhost:8080/Thingworx/WS.
Specifies the name of the connector to which this agent must communicate. The default value TW.AnalysisServices.Excel.ExcelConnector is installed by the Analytics Manager extension on the ThingWorx server.
Specifies the fully qualified name of the class that implements the application interface. This class contains the bridging code between the agent and the analysis provider. This class must be in the classpath provided to the JVM when running the agent. This property is required.
Specifies the configuration file that controls the logging information of the agent. By default, the agent uses the log4net.config file deployed by the installer.
Specifies the number of client instances that start when the agent is started. The default value is 1.
Specifies the maximum number of client instances that this agent can start. Specify a value greater than 0 to provide a fixed maximum value for the number of clients.
Set the value to true to monitor the health of the client. By default, this is set to false.
Specifies the time interval in milliseconds after which the agent polls the system and its clients for health information. The default value is 60000.
Used to monitor the agent for crashes. If the value is set to true, a process is launched at startup of the agent that monitors the agent. If the agent crashes, it is restarted automatically. If the monitoring process fails, the agent restarts it. By default, this is set to false.
Specifies a unique string that is used for identification of an agent to the ThingWorx server. If the value is not specified, a unique ID is generated automatically and is reused until a different one is provided using this property.
Specifies the directory used by the agent to store model files, temporary files, result files, and data files. The default AgentFiles folder is created in the installation directory of the agent. The following subdirectories are created under this directory:
Set to true to deploy new docker-based or jar-based analysis agents.
Specifies the number of jobs that can be queued for execution by the Excel Agent. The default value is 1000.
This property is applicable to simulation jobs only.
Specifies the interval in milliseconds at which the agent checks for simulation property updates and triggers analysis jobs. Jobs are triggered only if property values have changed since the last scan time. By default, this is set to is 1000.
Set to true so that the Excel agent saves the result files after completing a job. This can be used for debugging purposes.
Launch the Excel Agent
After modifying the configuration settings, run TWX_AS_ExcelAgent.exe from the bin directory under the agent installation. You can create an analysis model once it reports that the connection has been established.
To disconnect the agent and exit, type the letter q in the command-line interface.
Was this helpful?