NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Page info
title
title

Tip
titleYou can print and export wiki pages

Include Page
CommonProjects:Included Page To Print the Guide
CommonProjects:Included Page To Print the Guide

Panel
titleContents of this Page
Table of Contents
minLevel2

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.

An AIM template group is a container that holds more than one template. Templates and template groups are part of AIM template files, which are in XML format. The following XML file section shows how template groups and their component template files are described in an AIM template file.
objects described in XML file are TemplateContainer and Template

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

Return to top of page

Why Use the AIM Model?

Include Page
Why Use the AIM Model 1.0
Why Use the AIM Model 1.0

Return to top of page

What is in an AIM Template?

Include Page
What is in an AIM Template 1.0
What is in an AIM Template 1.0

Return to top of page

Requesting an NCI Account

Include Page
Requesting an NCI Account for Accessing the AIM Template Service
Requesting an NCI Account for Accessing the AIM Template Service

Return to top of page

Publishing a Template

You can publish a template file to ATS if you have a caGrid account, the template file is in XML format, and the template complies with AIM schema versions v1.rv23 and v2rv13.

  1. Select Publish.
    The Publish page appears.
    Publish page of ATS. Options described in procedure.
  2. Click Browse and navigate to the template file on your file system.
  3. Click Submit.
    A confirmation message appears.

    Info
    titleNote

    Click Reset to clear any value in the text field box.

Return to top of page

Searching for a Template Group to Download

You can download a template group from ATS so that you can import it to any AIM-enabled application such as AIM Template Builder.

When you create a template group using an AIM-enabled application, you specify its metadata. You can use this metadata as search criteria when you search for the template group later.

  1. Select Search Template Groups.
    The Template Group Search page appears.
    Template group search page of ATS. Options described in procedure.
  2. Narrow your search by entering information into the fields. If you do not enter any information into the fields, all template groups available in ATS appear, and it may take longer to see the results of your search. The following fields are available.

    Field

    Description

    Container Name

    Template group name

    Container Description

    Template group description

    Container Author

    Person who created the template group in the AIM-enabled application

    Disease

    Disease that is the topic of the templates in the template group

    Body Part

    Body part that is the topic of the templates in the template group

  3. Click Search.
    All template groups matching the search criteria you entered appear.
  4. Find a template group and then click the download link.
    Your browser prompts you to save or open the AIM template file.

Return to top of page

Searching for a Template to Download

Download a template from ATS so that you can use it in an AIM-enabled application such as AIM Template Builder.

When you create a template using an AIM-enabled application, you specify its metadata. You can use this metadata as search criteria when you search for the template later.

  1. Select Search Template.
    The Template Search page appears.
    Template search page of ATS. Options described in procedure.
  2. Narrow your search by entering information into the fields. If you do not enter any information into the fields, all template groups available in the AIM Template Service appear, and it may take longer to see the results of your search. The following fields are available.

    Field

    Description

    Template Name

    Template name

    Template Code Desc

    Template code description

    Template Description

    Template description

    Template Author

    Person who created the template in the AIM-enabled application

    Disease

    Disease that is the topic of the templates in the template group

    Body Part

    Body part that is the topic of the templates in the template group

    Modality

    Any of the various types of equipment or probes used to acquire images of the body, such as CR or DR (radiography), US (ultrasound) and MR (magnetic resonance imaging)

  3. Click Search.
    All templates matching the search criteria you entered appear.
  4. Find a template and then click the download link.
    Your browser prompts you to save or open the AIM template file.

Return to top of page

Changing the Permissions for a Template Group

You can make the template groups you publish to ATS public or private.

  1. Select Administration.
    The Edit Permissions page appears.
    Edit Permissions page lists template groups and their metadata and offers options to change or view permissions.
  2. For a selected template group, click Change.
    The Change Template Group page appears.
  3. From the Permission list, select Public or Private. For the Private option, enter names of users allowed to access that template group in the Allowed Users field. Separate each name by a comma. For example, UserA, UserB.
  4. Click Change.

Return to top of page

Deleting a Template Group

Deleting a template group permanently removes it from ATS.

  1. Select Administration.
    The Edit Permissions page appears.
    Edit Permissions page lists template groups and their metadata and offers options to change or view permissions.
  2. For a selected template group, click Change.
    The Change Template Group page appears.
  3. Select the Delete checkbox.
  4. Click Delete.

Return to top of page

Viewing an AIM Template in XML

You can view the contents of an AIM template in XML format.

  1. Select Administration.
    The Edit Permissions page appears.
    Edit Permissions page lists template groups and their metadata and offers options to change or view permissions.
  2. For a selected template group, click View.
    The template file contents appear in a new browser window.
    Raw XML content of a template file.

Return to top of page