2.72:Asset Management

Asset management greatly improves your quality of life. A standard naming and foldering convention for your extractors and other assets will speed up the time you spend configuring and troubleshooting.

Data Type Naming Conventions

A standard naming convention for Data Type extractors is particularly helpful. This single object has multiple collation configurations (Key-Value Pair, Ordered Array, etc) that change the way data is returned. Furthermore, Data Types are used all over Grooper, not only to extract values, but to exclude values from extraction, to limit the scope of a document where extraction is performed, to classify documents, and more.

If you start naming your extractors "Value 1", "Value 2", "Value 3" and so on, these names are vague both in terms of what value they are extracting and how they are getting the value. A simple coded prefix to the extractors name can give users an idea of how that extractor works at a simple glance of the name. We prescribe you use the following prefix/suffix naming convention:

EXTRACTION - Content

The "Extraction" prefix, in all caps, provides Design Studio users information about how the extractor is configured. The "Content" suffix provides users information about what data the extractor is targeting.

Collation Prefixes =

The Extraction Prefix should at least provide users information about the collation provider used. See the table below for collation prefix naming.

Collation Provider	Extraction Prefix	Example Name
Individual Collation	none	Invoice Number
Combine Collation
Combine using the Individual method	CMB	CMB - Invoice Number
Combine using the Flow method	CMB-F	CMB-F - Invoice Number
Combine using the Geometric method	CMB-G	CMB-G - Invoice Number
Combine using the Sum method	CMB-S	CMB-S - Invoice Number
Array Collation
Array with a Horizontal layout	ARY-H	ARY-H - Invoice Number
Array with a Vertical layout	ARY-V	ARY-V - Invoice Number
Array with a Flow layout	ARY-F	ARY-F - Invoice Number
Ordered Array Collation
Ordered Array with a Horizontal layout	OA-H	OA-H - Invoice Number
Ordered Array with a Vertical layout	OA-V	OA-V - Invoice Number
Ordered Array with a Flow layout	OA-F	OA-F - Invoice Number
Key-Value Pair Collation
Key-Value Pair with a Horizontal layout	KVP-H	KVP-H - Invoice Number
Key-Value Pair with a Vertical layout	KVP-V	KVP-V - Invoice Number
Key-Value Pair with a Flow layout	KVP-F	KVP-F - Invoice Number
Key-Value List Collation
Key-Value List with a Horizontal layout	KVL-H	KVL-H - Invoice Number
Key-Value List with a Vertical layout	KVL-V	KVL-V - Invoice Number
Key-Value List with a Flow layout	KVL-F	KVL-F - Invoice Number
Split Collation
Split using Begin position	SPLT-BEG	SPLT-BEG - Invoice Number
Split using End position	SPLT-END	SPLT-END - Invoice Number
Split using Between position	SPLT-BTW	SPLT-BTW - Invoice Number
Split using Around position	SPLT-ARD	SPLT-ARD - Invoice Number
Other Collation Providers
Pattern-Based	PB	PB - Invoice Number
Multi-Column	MC	MC - Invoice Number

Usage Prefixes

If the Data Type is used for a purpose other than returning a value (either to a Data Field or to return values referenced by other extractors), it should also be noted in the Extraction Prefix. The Extraction Prefix should provide information about the extractor from general to specific.

For example, a section extractor using split collation with the Between position locating payment information sections would be named "SEC SPLT-BTW - Payment Info"

Usage	Extraction Prefix	Example Name
Classification Extractors
Positive Classification Extractor	CLAS	CLAS - Invoice
Negative Classification Extractor	CLAS-NEG	CLAS-NEG - Invoice
Separation Extractors
Change in Value Separation Extractor	SEP-CIV	SEP-CIV - Invoice
Pattern-Based Separation Extractor	SEP-PB	SEP-PB - Invoice Number
EPI Separation/Page Number Extractor	EPI	EPI - Page # of ##
Placehodler
Exclusion Extractor	EXCL	EXCL - Page Header
Subtraction Extractor	SUB	SUB - Page Footer
Input Filter Extractor	IF	IF SPLT-BTW- Payment Info
Note: The extractor's collation method should always be indicated in the Extraction Prefix. The example above would be a Data Type using the "between" Split collation as an input filter. If this extractor is just named "IF - Payment Info" you loose that at-a-glance knowledge of which collation method it's using to return that input filter.
Section Extractor	SEC	SEC SPLT-BEG - Payment Info
Table Extractors
Row extractor for Row Match	TBL-RM	TBL-RM OA-H - Payment Info
X-Axis extractor for Infer Grid	TBL-IGX	TBL-IGX OA-H - Payment Info
Y-Axis extractor for Infer Grid	TBL-IGY	TBL-IGY OA-V - Payment Info
Header extractor for Header-Value	TBL-HE	TBL-HE - Payment Info [Payment Date]
Note: The Content Suffix of a Data Type's name can provide extra information for the user. For example, placing "Payment Date" in square brackets indicates the Header Extractor is locating the "Payment Date" header for the "Payment Info" table.
Footer extractor for Header-Value	TBL-FOOT	TBL-FOOT- Payment Info [Total Line]
Note: For a Footer Extractor, you could place what is used as a footer in square brackets, giving the user more info than it's a footer extractor for the "Payment Info" table.