NIH | National Cancer Institute | NCI Wiki  

You can print and export wiki pages

Unable to render {include} The included page could not be found.

Contents of this Page

Introduction to the AIM Template Service

The AIM Template Service (ATS) is a web service application that makes it possible for you to upload (publish) and download AIM templates created using a caBIG® Annotation and Image Markup (AIM) tool such as AIM Template Builder. You can import AIM template files to AIM Template Builder and modify them there. You can then use AIM Template Builder to export the template(s) to an AIM template file. If you want to share that file, you can upload it to ATS.

AIM templates contain a set of well-defined questions and answer choices to facilitate collecting information for a particular purpose, such as The Cancer Genome Atlas Glioblastoma (TCGA GBM) study. AIM templates ensure that users can annotate medical images using a controlled vocabulary and standard template. This results in simple and constrained annotations that are reproducible and consistent.

A valid AIM template is validated by AIM schemas (version 1, revision 18/19/23).

Refer to the AIM Template Service documentation for more information about ATS features.

Return to top of page

Installing the AIM Template Service

  1. Download the Berkley DB XML version suitable for your platform from

    The version used for this installation guide is Berkley DB XML 2.5.16.
  2. Install the software.
    1. Select the Java integration option. On Unix, you may need to run this command from the installation folder: sh --enable-java.
    2. On Windows, modify the PATH environment variable to include the DB XML executables. The database executables must be included in the PATH for the software to work properly.
    3. Optionally, download a pre-built Windows x64 version of Berkley DB XML from the ATS download location. Follow the instructions that are included with the downloaded file to configure your Windows 64-bit environment.
  3. Install Java 6 JDK with the latest updates from:
  4. Download the ATS software package, ATS-1.1.rar, and store it in a folder.
  5. Uncompress the ATS package, ATS-1.1.rar. The archive file contains the folder ATS-1.1 that includes AIM Template Service executables.
    1. Windows – click the compressed file to open; drag its content out to a folder, e.g. C:\ATS-1.1
    2. Unix – unrar ATS-1.1.rar. This creates a new folder called ATS-1.1.
  6. Create the certificate.
    1. [optional] Create your certificate(s) to run ATS over HTTPS.
  7. Edit serverConfig.txt as follows.
    1. Navigate to the ATS-1.1 folder.
    2. Edit serverConfig.txt as follows.
      1. port = 4433 (AIM template service server port)
      2. dbpath = C:\ATS-1.1\xmldb (Path to a location where you want to store ATS data)
      3. CaGridSecurityUrl = (URL for STS authentication service)
      4. keystorepath = (path to the keystore) (Optional. Required if running over https)
      5. keystorename = (name of the keystore file) (Optional. Required if running over https)
  8. Create the database as follows.
    1. Create a writable database folder, e.g. C:\ATS-1.1\xmldb – must correspond to the value of dbpath specified in serverConfig.txt.
    2. [optional] Open the command line and open the database folder.
    3. [optional] In the database folder, run dbxml. This opens the XML DB shell.
    4. [optional] In the XML DB shell, run createContainer ats_prod.dbxml. This creates an empty AIM Template Service database.
  9. Run the ATS application as follows.
    1. Windows
      1. Open the Administrator command line prompt.
      2. Navigate to the ATS-1.1 folder.
      3. Type %JAVA_HOME%\bin\java” -jar AimTemplateService.jar

        Set the JAVA_HOME environment variable to point to your JDK location.
    2. Unix

      1. Open a terminal window.

      2. Navigate to the ATS-1.1 folder.

      3. Type java -Djava.library.path=/home/john /dbxml-2.5.16/install/lib/ -jar AimTemplateService.jar

        The java.library.path value depends on where you have installed Oracle DB XML.
    3. Watch console output for errors and warnings.

  10. Validate the installation as follows.
    1. Open a web browser on another computer.
    2. Navigate to http[s]://<your server name>:<your port>/
    3. Log in using your caGRID login credentials or as a guest.

Return to top of page


  • No labels