Project Auditor

Tigerstripe projects contain multiple artifacts, files and descriptors that all have cross-references. Before the corresponding Service Contract can be generated, all these references need to be valid and semantically correct. To that extend, a back-ground task in Eclipse audits every Tigerstripe project continuously and flags inconsistencies and errors.

The Tigerstripe Project Auditor implements a semantic check for Tigerstripe Projects making sure the user is aware of any inconsistencies or missing information. The Auditor is triggered automatically each time a project is opened, a new artifact is created or an existing artifact is modified and saved. Whenever an error is found, it is displayed in the Eclipse "Problem view".

There are several levels of severity in errors that the Tigerstripe Auditor will signal:

Errors: Errors prevent Tigerstripe Service Contracts to be generated successfully, e.g. missing dependencies, undefined artifact or symbol. When trying to export or generate a Tigerstripe that contains errors, a warning message is issued to confirm if the operation is to be performed as it is mostly likely going to fail.
Warnings: Warnings signal that a key component is missing in the design of a Tigerstripe Service Contract, however this component does not prevent a successful generation of the corresponding specification (regardless of the target integration profile). Warning typically signal that a significant piece of documentation is missing for specific components in a project and may raise questions and/or issues during the implementation phase of the generated Service Contract. It is recommended that these warnings are addressed before publishing a Service Contract for implementation.
Info: Info notifications signal that some secondary information was not captured within Tigerstripe and would potentially impact the clarity of the generated documentation.

Each error signaled in the Tigerstripe Auditor View includes the following information:

Severity Level: one of the Error, Warning or Info above..
Description: a textual description of the error
Resource: the resource (i.e. artifact, descriptor or file) where the error was found
Folder: the folder (i.e. the project) in which the resource is located