ADL Workbench Help Page - Compilation

previousHomeNext

Overview

The ADL workbench allows an entire archetype repository, or any part thereof, to be compiled, i.e. for all or some archetypes to be parsed en masse. The simplest operation is simply to compile all archetypes. Subtrees of archetypes and single archetypes can be compiled as well.

Compiling the Whole Repository

All archetypes in the repository can be compiled using Repository > Build All or F7. The operation can be interrupted using Repository > Interrupt Build or Shift+Esc. The Status tab (bottom right) shows the progress of the compilation operation, while the Error tab indicates archetypes that have errors or warnings.

Every node in the tree indicates its compilation status. The key is shown at right.		 Comipiler statuses
Compiler status key.

Compiling a Subtree

In the same manner as for the whole repository, a specific subtree can be compiled. Select the folder node in the Explorer on the left, and then use Repository > Build Subtree or Ctrl+F7 to build only the archetypes in that tree. The Status and Error tabs provide the same information as described above, for the relevant subtree.

Status Output

The status window provides feedback from the parser, and indicates whether an archetype has parsed properly or not. It also indicates terms found in the ontology section of the archetype that are not used in the defnition.		 Status 1
parse failure with validity error		 Status 2
parse failure with syntax error

Error Output

The error output of the compiler is available in the Error tab at the bottom of the tool. It groups errors into three categories:
  • Parse Errors: files that failed to parse, i.e. archetypes containing ADL syntax errors, or that contain semantic errors, e.g. missing codes;
  • Validity Errors: semantic errors rendering the archetype incorrect according to the specification.
  • Warnings: anomalies in archetypes that are likely to be unintentional and need to be corrected, but which don't actually affect the correctness of the archetype.
Errors are shown under the archetype id for which they occur, and the full message is available under each id.

Double-click on the archetype id to go to the archetype in the explorer. The error message is now available in the Status tab.		 Error tab
Error report overview		 Error tab
Error message

$LastChangedDate: $ $LastChangedRevision$