Producing a Project Definition Report

Generating the Report

A spreadsheet report using MS Excel format can be generated for a loaded project from the Report Menu in the Design View 

The user will be prompted for the location to save the report and the file name. By default, the project will be saved inside the project folder, in the reports\definition_reports folder and named the same as the project name, suffixed with the version. Once generated, the user will be given the option to open the report.

Report Content

The title page of the report will contain the name of the project and its version. It will also contain a list of links to all the sheets in the project. Note that these links may not work if the spreadsheet is opened with a Spreadsheet tool other than MS Excel.

On the Properties page, information regarding the connections to the server and definitions of any Project Variables. Note that the connection credentials will never be shown in the report. For convenience, there is a link at the top back to the index page.

Any Project Notes will be shown on the Notes page. If there are no notes, this page will not be present.

The remaining Pages are for the Form Mappings. One page is generated for each form mapping defined in the project. Both enabled and disabled form mappings are included. Note that the form names are used in the report, not labels.

At the top of each Form Mapping page, the name of the source and target forms, together with the key options defined for this mapping can be found. There are also sections describing the source filter (if present), Key Mappings and any defined Lookups.

The Field Mappings are then presented in a table. The table has 5 columns, displaying the following information:

Column Name	Description
Target Field/Variable	The name of the field on the target form that is being set. Or the name of the temporary variable that is being set.
Mapping Type	The Type of mapping that has been defined for this field. For Example Simple, Assignment, Lookup, Value etc.
Source Field / Variable	If there is a single source field or variable that is being used to set this value, it is shown here. Note that not all mapping types have a single source  - Assignment mappings for example can combine values from several fields and variables.
Default Value	If a default has been specified for the mapping, the value is given here.
Mapping Detail	This contains different values for different mappings. For assignment mappings, the expression used to calculate the value is shown. For value mappings, the set of source->target value mappings are listed. For lookups, the name of the lookup, whether it is a lookup on the source or target server and the form being searched are given. This value can in some cases be quite large and the row will be extended in size to accommodate it.
Additional Detail	This lists other options or properties that may have been set on this mapping. For example for lookups, the action to take for No Match/Multiple match is given.

Note that the report is a snapshot of the loaded project, it will contain any unsaved changes. Once generated, the report can be edited in the same way as any other Excel document.