Batch Object - Flag Item

Flags the selected items in a batch with a specified reason for review or special handling.

Remarks

The Flag Item command is used to mark one or more Batch Objects as flagged, indicating that they require attention, review, or special processing. When executed, this command sets the 'Flagged' state on the selected items and assigns a reason using the 'Flag Reason' property.

Use this command in scenarios where you need to highlight items for exception handling, quality control, or workflow routing. The available flag reasons are determined by the current Task View context, and may include standard messages or custom text.

Flagged items are visually indicated in the UI and can be filtered, reviewed, or processed according to your organization's procedures. This command is commonly used during attended review activities, but can also be applied programmatically or as part of automated workflows.

> Note: Only items that are not already flagged can be flagged using this command.

Properties

Name	Type		Description
Flag Reason	String	►	Specifies the reason to assign when flagging the item. ConverterFlag Reason Converter The Flag Reason property allows you to annotate flagged items with a message describing why they require review or special handling. You may select a value from the list of available flag messages—provided by the current Task View—or enter a custom reason. Use a clear and descriptive reason to help reviewers understand the issue or required action. If this command is executed from a Task View on the Review Page, a drop-down list of standard flag reasons will be available for selection. Custom reasons can be entered directly if the desired message is not present in the list. Example flag reasons might include: Missing required data, Image quality issue, or Needs manual classification. The value you provide will be displayed in the item's properties and may be used for filtering, reporting, or workflow automation.

See Also

BatchBatch FolderBatch Page