Classify

Specifies the classification scope by referencing a Content Model or Content Category.
The set of Document Types available for assignment and classification is determined by this scope.

Usage

• Select the Content Model or Content Category that defines the document types to be used for classification.
• The classification method, training data, and configuration are inherited from the selected scope.
• Changing this property will affect which types are available for assignment and how classification is performed.

Impact

• Only Document Types defined within the selected scope are considered during classification.
• The classification method and rules configured on the selected Content Model are used to evaluate and assign types.
• If the scope is not set, classification cannot proceed and an error will be raised.

Example

> Set to a specific Content Model to restrict classification to its child Document Types, such as "HR Documents" or "Invoices".

Can be one of the following values:

Determines the classification granularity by specifying a level in the Content Model hierarchy.

Usage

• Set to DocType to classify as a specific Document Type (e.g., "Invoice", "Contract").
• Set to a higher level (such as Content Category) to classify into broader categories (e.g., "Financial", "Legal").
• If a numeric level is specified, it indicates the number of levels below the 'Content Model Scope'.

Impact

• Controls which types are considered as classification targets.
• Affects the detail and specificity of classification results.
• The 'Output Level' property can be set to a different value to output a broader or narrower classification.

Example

> Use DocType to assign types like "Invoice" or "Contract".
> Use a higher level to group documents under broader categories.

Specifies the Content Type to assign to a Batch Folder if classification fails to meet confidence requirements.

Usage

• Set this property to ensure that all documents are assigned a type, even if classification is inconclusive.
• Overrides the default type specified on the Content Model if set.
• Useful for exception handling, routing, or downstream processing.

Impact

• Prevents documents from remaining unclassified, which can help maintain workflow consistency and reporting accuracy.
• Ensures that ambiguous or low-confidence cases are handled in a predictable way.
• The assigned default type can be used to trigger exception handling, review, or alternate processing steps.

Example

> Assign a generic "Unclassified" or "Exception" type to documents that cannot be confidently matched. > This allows you to easily filter and review documents that require manual intervention.

Restricts reclassification to specific Content Types or their descendants.

Usage

• Leave empty to process all classified documents in scope.
• Add one or more Content Types to limit processing to those types and their descendants.
• This is useful for targeted reclassification, such as updating only certain document types after changes to classification logic.

Impact

• Limits the scope of reclassification, reducing processing time and risk of unintended changes.
• Ensures that only relevant documents are affected by the operation.
• When used with the 'Apply To' property set to 'Classified', only folders matching the filter (or their descendants) are reclassified.

Example

> Add "Invoice" and "Purchase Order" to reclassify only those types, leaving others unchanged. > This is helpful when updating classification logic for a subset of document types after a model update.

Can be one of the following values:

Controls the level in the Content Model hierarchy at which the classification result is assigned.

Usage

• Set to match 'Classification Level' for standard behavior, so the assigned type matches the classification target.
• Set to a higher level to output a broader classification (e.g., assign a Content Category instead of a Document Type).
• This property is automatically set to match 'Classification Level' unless changed.

Impact

• Determines the granularity of the assigned type.
• Affects downstream extraction, validation, and export logic, as only data elements available at the output level will be present.
• If set to a broader level, only the data and behaviors defined at that level (and above) are available for extraction and validation.

Example

> Set to DocType to assign specific document types, or to a parent category for broader grouping. > For example, if classifying at the "Form Type" level but outputting at the "Document Type" level, the assigned type will be the parent document type.

Can be one of the following values:

Determines which Batch Folders are included in the classification or reclassification operation.

This setting allows you to target classification to all folders, only those that are already classified, or only those that are unclassified.

Can be one of the following values:

Controls the strategy for handling Batch Folders that already have a Content Type assigned during classification or reclassification.

This setting determines whether and how the classification result updates, augments, or verifies the existing type assignment.

• Use 'Reclassify Mode' to control if the new classification result should overwrite, supplement, blend with, or simply verify the current Content Type.
• The selected mode affects whether the Batch Folder is reclassified, flagged for review, or assigned additional types.
• This is especially useful when updating classification logic, retraining, or handling exceptions in document processing.

Enables exception handling by flagging Batch Folders that fail classification.

Usage

• Enable this property to highlight documents that require manual review due to low-confidence or ambiguous classification results.
• Flags are automatically cleared if classification later succeeds.
• The flag message will indicate the reason for failure, such as "A tie has occurred" or "Document does not meet the confidence requirements."

Impact

• Improves quality control by drawing attention to documents that may need user intervention.
• Supports exception-based workflows and review queues.
• Flagged documents can be easily filtered and reviewed in the Grooper UI or through reporting.

Example

> Enable to ensure that all unclassified or uncertain documents are flagged for follow-up, allowing users to quickly identify and resolve issues.

Suppresses the storage of alternative classification candidates for each document.

Usage

• Enable this property to reduce storage requirements or if you do not need to review classification alternatives.
• By default, a list of candidates is saved for each document, which can be useful for auditing, troubleshooting, or reviewing classification decisions.
• Disabling candidate list storage may improve performance and reduce database size, but removes the ability to review alternative matches.

Impact

• When disabled, only the final classification result is saved, and the list of alternative candidates is not available for review.
• This can be beneficial in high-volume environments or when storage constraints are a concern.

Example

> Enable in production environments where only the final classification result is needed, and candidate review is not required. > Leave disabled during testing or model tuning to review and analyze classification alternatives.

When enabled (true), this property instructs the command to attempt conversion of any existing field values from the current Content Type to the new or promoted type assignment.

• If the structure of the new type is compatible, data values will be mapped to corresponding fields in the new Content Type.
• If disabled (false), existing data is not converted and only the type assignment is changed.

Usage Guidance

• Enable this option when you want to preserve as much data as possible during type changes, such as when correcting a misclassified document or promoting a secondary type to primary.
• Data conversion is only possible when the new Content Type shares compatible data elements with the previous type. Incompatible or missing fields will not be transferred.
• Use caution when converting between types with significantly different data models, as some data may be lost or unmapped.

Related Concepts

• See Content Type for details on document classification and data models.
• The 'Operation' property determines whether the type is added, promoted, or removed.
• For more information, refer to the documentation for Batch Folder and Assign Document Type.

The 'Include Sibling Types' property controls whether all Content Types listed in the primary type's 'Sibling Of' property are automatically assigned as secondary types when classifying a Batch Folder.

Usage

• Enable this property to ensure that any related or peer types defined as siblings of the classified Content Type are included as secondary types.
• This is useful for multi-type documents or scenarios where data from sibling types should be accessible for extraction, validation, or export.
• When enabled, the activity will add all sibling types not already present in the secondary type list.
• If disabled, only the primary type (and any manually specified secondary types) are assigned.

Example

If the classified type "Invoice" has "Purchase Order" and "Packing List" as siblings, enabling this property will assign all three types to the folder, making their data elements available in expressions and export mappings.

Impact

• Ensures that all peer types are available for cross-type validation, data sharing, and export scenarios.
• May increase the number of data elements and behaviors available to the folder, depending on the configuration of sibling types.

Related Concepts

• Content Type: The main or secondary document type assigned to a folder.
• 'Sibling Of': The property on Content Type that defines peer relationships.
• 'Secondary Types': Additional types assigned to a folder for multi-type scenarios.

A combination of the following flags:

The Error Disposition property determines the system's response to errors that occur while executing the activity.

• Flag: The affected Batch Folder or Batch Page will be flagged for review.
• Log: The error will be written to the Grooper event log.
• Stop: Processing will halt, the Batch will be set to an error state, and all pending tasks will be deleted.

You can combine multiple options using the IssueDisposition flags.
Adjust this property to match your organization's error handling and escalation policies.

If the number of consecutive errors reaches this value, a critical stop will occur and the Activity Processing service will halt further processing.

• Use this property to prevent runaway failures and to ensure that persistent errors are escalated for review.
• Set to a higher value to allow more retries before stopping, or to a lower value for stricter error control.

Can be one of the following values:

The Concurrency Mode property determines whether the activity can be executed in parallel across multiple Batch Objects, or if it must run sequentially.

• This setting affects which Processing Queue the activity is submitted to and how tasks are distributed.
• Choose the appropriate mode based on the activity's thread safety and resource requirements.