SetPageStatus

The action assigns a page status to an object of the Document Hierarchy.

Syntax

bool SetPageStatus (StrParam)

Parameters

Numeric value that represents the status.
The Invoices application (as an example) employs three default Page Statuses:
  • 49 = ScanOK
  • 1 = Incomplete/Not validated
  • 0 = Complete

You can define your own statuses by using the Filter tab of a task's Task Settings dialog.

Returns

Always True.

Level

Page or field level.

Details

The action assigns the page status that you enter to the page object of the Document Hierarchy. The current object can be the page or field. If the current object is a field object, it sets the page status for its parent page object.
Example:

A scan task might assign Other as the Page Type and 49 as the default Page Status for every successfully scanned image in the batch.

The following sequence is an example of a rule that converts Other pages to Invoices pages, and assigns a Page Status to each:

SetPageType(Invoice)
SetPageStatus(1)       

This combination establishes the page as an Invoices page, and gives it a status of 1. This means that the page is not validated and must be processed by a task that applies Validation rules (a Recognition or Verification task, for example).