DriveWorks Pro 15: How To: Diagnose Project Issues Using DriveWorks Specification Report (KB13022102) [send feedback...]

Introduction

DriveWorks produces Specification reports each time a specification is transitioned.

All specifications will have a Specification Report named Starting Specification based on Project <ProjectName>.

However this could be named Copying Specification <SpecificationName> based on Project <ProjectName>, depending if the Specification includes the ability to copy a specification.

Further Specification Reports will be produced when a specification transitions from a paused or Automatic state into another state. These reports will take the name of the transition, for example:

  • Edit
  • Release
  • Process - (if a custom transition called Process exists in the Specification Flow)

Additionally a Model Report is created after each model has been generated - See How To: Diagnose Project Issues Using DriveWorks Generation Report for more information about these.

The reports give valuable information that assist with diagnosing issues and checking the status of a specification.

When testing or diagnosing a DriveWorks implementation we recommend setting the reporting level to Verbose.

Please see Project Settings - Reporting Level for more information.

Return this setting to Minimal once testing is complete.

Specification Report

Specification reports are listed in the Reports section of the Specification Explorer.

To open a report:

  1. Select Specification Explorer from the task list of DriveWorks Administrator.
  2. Select the specification to view from the specification list.
  3. Double click the report listed in the reports section of the documents list.

The specification report will open in the DriveWorks Report Viewer

The report details all actions performed on the specification during the transition it was created for.

So, for example, if the transition did not require any documents to be created none will be listed.

Similarly if only one (of many) document is required only the one will be listed.

The report lists each output type in the order of action taken, and is divided into re-sizable columns:

  • Description - Describes the action performed during the transition. Any warnings or errors will also be detailed in this column.
  • Target - Lists the target the action was performed on.
  • Class - Classifies the action.
  • Time - Is the time taken to perform the action.
  • Status - Indicates if the action was successful, has any warnings or has any errors.

When the Reporting Level is set to Verbose, documents created from a template (Word, Excel or XML) will display each captured parameter and the value calculated to be driven into it.

Releasing Emails is always shown as an action, zero time taken and zero indicators indicate no emails were required.

Model information, if applicable, is shown in the report in a hierarchical structure. Models that are required, and are driven alternatives will appear first (if applicable), followed by the assembly they are driven into. The Assembly structure is shown in the order information was stored in the parameter. Drawings are listed as models alongside the model they are associated to.

Note that the information about models in a Specification Report relates to the information calculated by DriveWorks and stored ready for generation. Actual generation information is stored in the Model Generation Reports during model generation.

The Status column of the specification report gives a good indication that something may require attention.

Status Green - DriveWorks was able to accomplish all actions successfully

Status Orange - Indicates minor warnings that may require your attention.

Status Red - Indicates DriveWorks was unable to carry out the action and investigation is required.

Checking the Specification Report

Document and Model Parameters

To check the Specification Report for values that were calculated to be driven into documents or models, follow the steps to open the report above and:

  1. Locate the document or model with the issue from the Description column of the report
  2. Under the document or model will be the captured parameters along with the result that was calculated.
  3. Check this result with the generated document or model.


Knowledge Base Article Ref:KB13022102

Table of Contents