Overview
An Attivio project is defined by various XML configuration files, such as the configuration.xml file, the topology-layout.xml file, and the topology-nodes.xml file, among many others.
Starting an Attivio project involves starting all the Agents running on the individual servers and opening the CLI. From that point, the steps required to start a project depend on whether it is a simple, one-node installation, a multi-node project being deployed to an external Hadoop cluster or a multi-node project being deployed as an Attivio cluster.
AIE-CLI vs AIE Designer
This page describes starting and stopping an Attivio project using the AIE Command Line Interface (AIE-CLI).
AIE on Hadoop
To configure Attivio to run on Hadoop, see Create an Attivio Project on Hadoop.
For an overview of project architecture and deployment see Developing in AIE - Concepts and Tools.
If you want to run a simple, one-node installation on your local machine for demo/training purposes, you may find the Quick Start Tutorial more helpful than this page.
View incoming links.
Start the AIE Agent
The Agent may already be running.
The AIE Agent is installed as a Windows service or Linux daemon by default during Attivio Installation. It that case it is probably already running and there will be no need to start it.
The AIE Agent provides communications between the project control tools (AIE-CLI) and the processes that make up the Attivio project. The Agent must be running on all host machines in your deployment before you can start any other processes. The Agent can be started manually if desired.
See AIE Agent.
Start the AIE Command Line Interface (AIE-CLI)
The AIE-CLI provides simple commands to start, stop, and update a clustered Attivio project.
See AIE-CLI.
One-node Installation (Unclustered)
Start the Project's Nodes
To run the project from AIE-CLI, do the following:
- Use the start all command to initiate services and nodes of the project.
Stop the Project's Nodes
To stop Attivio, do the following:
- Issue the stop all command in the AIE CLI.
Clustered - External Hadoop
Start the Project's Nodes
To run the project from AIE-CLI, do the following:
- Use the start all command to initiate services and nodes of the project.
Stop the Project's Nodes
To stop Attivio, do the following:
- Issue the stop all command in the AIE CLI.
Attivio Cluster
Start the Hadoop Services and Project's Nodes
To run the project from AIE-CLI, do the following:
- Use the start all command to initiate Hadoop services and nodes of the project.
Stop the Hadoop Services and Project's Nodes
To stop Attivio, do the following:
Issue the stop all command in the AIE CLI.
Stop the AIE-CLI
- To stop the AIE-CLI, issue the quit command in the AIE-CLI.
- Note that you can stop/restart the AIE-CLI at any time while Attivio is running.
Stop the AIE Agent
There is no need to stop the Agent.
As a rule of thumb, there is no need to stop the Agent unless you need to update it with a new version or you need to delete the files in the \data-agent directory for some reason.
There are multiple ways to stop the AIE Agent, some of which simultaneously kill all related Attivio processes and some of which do not. The Best Practice is to stop all Attivio-related processes before stopping the AIE Agent. Otherwise, after starting a new Agent, the orphaned processes may interfere with restarting the Attivio node.
When running the AIE Agent from a command window or shell, you can end it cleanly by using control-C. This technique stops the Agent and simultaneously kills the dependent Attivio processes.