Attribute Scope

Introduction

Scope determines the Attribute's relation to Annotations, Files and Objects.

Scope relation affects:

• How Attributes can be queried
• How & when Attributes are displayed in UI tools
• Other properties

The relationships are defined in the following tables.

Description

This table explains the common name, description, example entities.

Name	Description	Examples
Annotation	Each annotation instance.	A box or entity
File	Each file.	An image, video, text.
Object (Compound File)	Each Compound File.	A collection of Files (File), e.g. images, text, etc.

How to set these values

Calling Attribute Template Update or when creating using the UI wizard.

Globals

This table describes the technical relationship of the Attributes.

Name	Is Global?	global_type
Annotation	No	N/A
File	Yes	file
Object (Compound File)	Yes	compound_file

Triggers

Triggers determine when an Attribute shows in the UI.

Name	Triggers Available	Description
Annotation	Yes	(UI) Shows when the label is selected.
File	No	N/A
Object (Compound File)	No	N/A

Access Control

All scopes may be set to Read Only or not.

Display Table

Name	Query	Annotation UI	Catalog
Annotation	In Instance Dict	On Instance Selection	No
File	In File Dict	On File Selection	Yes
Object (Compound File)	In Compound File Dict	On Compound File Load	Yes

Query Syntax

See Query Syntax Reference