Page tree
Skip to end of metadata
Go to start of metadata




Quick Start

The following Quick Start tutorial is the best place to start if you are new to Attivio. This tutorial walks you through downloading and installing Attivio and creating your first Attivio project called "Factbook" where you will:

  • Use the Attivio CLI (Command Line Interface) to create and run a new project
  • Ingest sample structured and unstructured data
  • Execute simple and advanced queries using Attivio's built in Search UI

Watch This Tutorial


1. Download Attivio

For the purposes of this tutorial, we will assume you are installing version 5.5.1 (which includes Search UI) using a 64-bit Windows operating system with a minimum of 8GB of RAM. For a full understanding of the resources needed for development and production environments, see our System Requirements page.

  1. Download the Attivio Platform Windows 64-bit Server installer.

2. Run the Installer

  1. Unzip and run the Attivio Platform installer following the steps below.

      Click Next.

      Review the Patent Notice and click Next.


      Click Next.

      If you do not have an Attivio license, contact your Attivio Sales Representative or email If you have a license, click Browse, navigate to your attivio.license file and click Next.

      Choose an installation location and click Next.

      Decide whether you want to create a Start Menu folder and click Next.

      We recommend you keep these default values and click Next.

      The installer will then extract files and install Attivio.

      Click Finish to complete the installation.

    3. Download and install the latest patch

    Patches are released on a regular basis to fix bugs and add new functionality. It is a best practice to install the latest patch available for your version of Attivio. 

    Download the latest patch from Version 5.5.1 Service Packs and follow the instructions there to apply it to the installation you just completed.

    4. Install the updated ALM license

    Download the rlp-license.xml file for the Advanced Linguistics Module (alm) and copy it into your Attivio Platform 5.5.1 installation directory's <INSTALL_DIR>/lib/basisTech/licenses directory, overwriting the existing rlp-license.xml file in that directory.

    5. Create a new project named Factbook

    An Attivio project is a collection of configuration files in an Attivio application. Projects include the feature, schema, component definition, and workflow definition files that define how to ingest content, process queries, and handle results within an Attivio application. Multiple projects can be created within the same installation, and those projects can be managed and developed independently.

    To create a new project named "Factbook", open a command window and execute the following command:

     <install-dir>\bin\createproject.exe --name Factbook -m factbook -g demo -o C:\attivio\projects

    6. Start the project using the Attivio CLI

    The CLI (Command Line Interface) is a small-footprint utility that runs in an interactive command window. It lets us start, stop and monitor multiple servers, and also provides tools for creating and deploying the project. To start the project, execute the following steps:

      Open a command window and execute the following:

      <install-dir>\bin\aie-cli.exe -p C:\attivio\projects\Factbook 

      Depending on you Windows security settings, you  may need to run the command window as Administrator in order to start Attivio properly using the CLI.

      The CLI should look something like the following:

      Type the start all command and hit Enter

      If prompted by a firewall dialog, allow access.

      Execute the status command until the perfmon, store and node all show a status of RUNNING.


      7. Run the connectors

        Go to http://localhost:17000/admin/connectors to open the Attivio Admin UI.

        Select each of the 4 connectors and click the  button in the top toolbar.

        Click Start in the confirmation dialog window.

        Once the connectors finish, you will see the number of documents each has ingested. We now have a populated index which we can query.

        8. Open Search UI and execute simple queries

        1. Go to http://localhost:17000/searchui/ to open Attivio's Search UI. Login with username aieadmin and password attivio.

        2. Search for civil war

        3. Try some other simple queries:

          Example QueryDescription
          democracyMatch documents which contain the term "democracy".
          -democracyMatch documents which do not contain the term "democracy".
          "civil war"Match documents which contain the phrase "civil war". This is unlike the initial query above that did not include quotes which will match documents which contain both "civil" and "war" but not necessarily adjacent to one another.
          civil OR warMatch all documents that contain either "civil" or "war", or both. OR must be in UPPERCASE.
          title:PasadenaMatch documents that contain the term "Pasadena" in the "title" field.
          title:"San Francisco"Match documents that contain the term "San Francisco" in the "title" field.

        9. Execute advanced queries

        1. Switch from Simple Search syntax to Advanced Search

        2. Try some advanced queries:

          Example QueryDescription
          AND(civil, war)The advanced syntax which will match documents which contain both "civil" and "war". 
          AND(civil, war, NOT(independence))Match all documents that contain both "civil" and "war",but not the word "independence".
          REGEX("19[0-9]{2}|20[0-9]{2}")Match all documents that contain years in them.
          title:STARTSWITH(San)Match documents where the title field starts with the value "San".
          NEAR(signed, treaty, distance=3)Match documents which contain the word "signed" within 3 words of "treaty" regardless of which word comes first.
          ONEAR(signed, treaty, distance=3)Match documents which contain the word "signed" within 3 words of "treaty" but only if "signed" appears before "treaty".
          JOIN(table:country, INNER(table:city, on=country), INNER(table:medal, on=country), INNER(table:news, on=country))Match all countries that have at least one city, have won at least one Olympic medal, and that are currently in the news. The primary results are countries, with expandable Child Document displays under each country.
          JOIN(table:country, INNER(AND(table:medal, gold_i:>10), on=country), OUTER(table:news, on=country))Match countries that won at least ten gold medals, and includes available news articles about each country.

        10. Shutting down

          In the CLI, execute the stop all command.

          Execute the status command until perfmon, store and node all show a status of STOPPED.

          • No labels