Project Tree window

This window is broken down into two areas. The top row is a group of icons that enable you to filter or collapse the hierarchy.

The rest of the window has an interactive project hierarchy that contains all classes and other related items used to configure your project.

You can add, delete, modify, and reorder these items as required. A shortcut menu that includes several settings from the various ribbon tabs. In addition to this, there is a shortcut menu that changes depending on what item in the Project Tree is selected. See the Project Class shortcut menus for more information.

The settings at the top of the Project Tree are as follows.

Setting

Name and Description

Enter text to search

Search:

All Project Tree items that match the entered search term are displayed, even those items are hidden inside a class.

Project Tree - Project icon

Show Inherited Items / Hide Inherited Items:

Excludes inherited items in the search. Select again to include inherited items.

Project Tree - Project icon

Hide All Details:

Hides any displayed class details, but leaves the expanded or collapsed state of the Project Tree unaffected.

Project Tree - Project icon

Default Layout:

Hides any class details and collapses the Project Tree so only the classes are displayed.

The Project Tree does not always display the contents of a class. If the Show Class Contents icon Show Class Details icon is displayed, the class contents are hidden. You can select this icon to make the class contents visible. Similarly, you can hide the class contents by selecting Hide Class Contents icon Hide Class Details.

Each item in the Project Tree has an icon to indicate its type. When an item is selected, its properties are displayed in the Details window. These properties can be modified to update the project. You can also select multiple items. Any common properties between the selected items can be modified as needed. The following items may be displayed in the class hierarchy, depending on project configuration:

Setting

Name and Description

Project Tree - Project icon

Project:

The root item for the entire project. Some read-only information about the project and a limited number of settings are available at this level in the project.

Project Tree - Project Class icon

Project Class:

The parent class of the project. Any items added to this class are inherited by all other classes in the project.

The shortcut menu for the Project Class contains the following setting that is not available on one of the ribbon tabs:

Show Script:

Show Script icon Opens the Script Code window.

Project Tree - Class icon

Default Class:

The default class in the project. Depending on how your project is configured, any unknown documents are automatically classified as this class.

As long as a child item within a class is selected, the class selection is implied. If you select a locator for a class and then open your Classification Training document set, any classification training documents for the class of the locator are displayed.

Project Tree - Classes icon

A collection of Classes:

If at least one class is present, this collection can be expanded. This grouping enables you to collapse the collection when focusing on other areas of your project.

Project Tree - Class icon

Class:

A class represents how a specific type of document is processed. As a result, each class tends to have one or more fields and locators. You can expand a class to see its child classes or view its contents.

Class contents such as locators, fields, classification instructions, structure rules, and child classes are hidden by default.

As long as a child item within a class is selected, the class selection is implied. If you select a locator for a class and then open your Classification Training document set, any classification training documents for the class of the locator are displayed.

The shortcut menu for a Class contains the following settings that are not available on one of the ribbon tabs:

Show Script:

Show Script icon Opens the Script Code window.

Default Classification Result:

Select the desired default classification result that is used if no other classification result can be determined. (Default: unclassified

TotalAgility Studio – Classification Base:

Select a class so it is the parent class for TotalAgility Studio Classification. This means that all classes added in TotalAgility Studio Classification are listed as child classes to the selected class.

When selected, a checkmark is displayed, indicating the selection. Only one class can be the editor root for TotalAgility Studio Classification.

This setting is not available for the project class.

Project Tree - Fields icon

A collection of Fields:

If there is at least one field group, this collection can be expanded. This grouping enables you to collapse the collection when focusing on other areas of your project.

Project Tree - Field Group icon

Field Group:

Field groups are a useful way of organizing fields into smaller groups based on function or data type. These groups can contain both simple fields and table fields.

Field groups created in the Transformation Designer are automatically created in the Advanced Studio when the project is saved. This eliminates the need to create field groups and fields in Advanced Studio if you want a specific structure.

Project Tree - Field icon

Simple Field:

Simple fields are the most common type of field. These fields typically contain a single piece of information extracted from a document during processing.

For restrictions on field name characters, see to Name conventions.

Project Tree - Table Field icon

Table Field:

Table fields contain many pieces of extracted data from a document. Each cell in the table contains extracted data, but instead of configuring each cell separately using simple fields, a table field in partnership with a table model and a locator, does this automatically.

For restrictions on field name characters, see to name conventions.

Project Tree - Locators icon

A collection of Locators:

If at least one locator is present in a class, this collection can be expanded. This grouping enables you to collapse the collection when focusing on other areas of your project.

Project Tree - Locator icon

Locator:

When a locator is first added to the Project Tree, it is identified using the general Project Tree - Locator icon Locator icon . Once a locator is assigned a locator method, an evaluator method, or a trainable locator method, the icon is updated to show the icon for the specific locator type. By selecting any locator in the Project Tree, you can view its properties and configure your extraction settings.

Inherited locators do not show their specific locator icon. Instead, they show the Project Tree - Inherited Locator icon inherited locator icon .

For restrictions on locator name characters, see to name conventions.

Project Tree - Instructions icon

Instructions:

Any Instructions added to your project are visible in the Details window when this item is selected.

You can use drag-and-drop to move a class in the Project Tree. You can also select multiple classes on the same level and drag them to a new position in the Project Tree. For example, if you want to remove a class level you can move all child classes of a parent class to an upper level.

You cannot use drag-and-drop for other items in the Project Tree.

Instead to change the order of items such as locators, you can use the Move Up and Move Down buttons.

If you select multiple fields or the Fields Project Tree - Fields icon collection topic, the details in the grid are the same settings that are displayed in the Field Details. Similarly, selecting multiple classes or the Classes Project Tree - Classes icon collection topic, the settings displayed are the same settings that are displayed in the Class Details.

For multiple selected classes, some of the settings contain abbreviations in the column header labels. These abbreviations are used to ensure the label association is clear because the group headings displayed in the Class Details to group related settings are not displayed in the grid. The following abbreviations are used:

TDS:

Trainable Document Separation

SDS:

Standard Document Separation

SC:

Subtree Classification

For example, if you select two or more simple fields, a grid is displayed so you can modify several fields at once. Similarly, selecting several classes enables you to edit more than one class at a time.

You can only edit multiple Project Tree items of the same type. This means that you cannot edit a field and a class at the same time.

You can however, edit several simple fields or several classes at the same time.

Any changes made here in bulk are saved automatically. The next time you open up the individual details for one of the Project Tree items, the changes made here are displayed.

You cannot select and edit multiple table fields at the same time.