This functionality is only available for certain module packages. Info / Copyright

Action: check


Parameters

Description

TYPE 

Type of task to perform the action. Possible values are:
PROJECT: Check project
PAGES: Check page
INSTALLATIONSPACE: Check layout space

ONLYCOMPLETED: Check only completed messages of a project

PARTS: Check parts

PROJECTNAME

Project name with complete file path (optional).
If nothing is entered, the selected project will be used if the action is to be run over the user interface (e.g. via the script or ribbon). When executing from the Windows command line, PROJECTNAME must be specified or ProjectAction has to be used before that. Otherwise a system message will appear.

VERIFICATIONSCHEME 

Name of scheme used for the check run (optional, scheme name only, without file path).
Default value: most recently used scheme.

USEPAGEFILTER

Determines whether only filtered pages or all project pages will be used (optional). Default value: 0

PAGENAME 

Name of the pages to be checked (optional).

SELn

Object ID of the pages to be checked (optional). Here, n is a number, e.g., /SEL1:38/4/12/0. Alternative to PAGENAME. This parameter has an effect only if the TYPE parameter has the following value: PAGE.

INSTALLATIONSPACENAME

Name of the layout space to be checked (optional). The value is stored in the Layout space name (ID 36452) property.

Notes:

  • If a page is stated explicitly via the PAGENAME parameter, only this page will be checked, and the USEPAGEFILTER parameter will be ignored.
  • If no page is explicitly stated via the PAGENAME parameter, the project pages will be determined. If the USEPAGEFILTER parameter is set to 1 (i.e. a scheme is activated), only the filtered pages in the page navigator are checked. If the USEPAGEFILTER parameter is not used or set to 0, all project pages will be checked.