This Report SDK contains the following contents:

• T-Plan Professional Templates
  • Adding and Modifying Templates
  • Monochrome Templates
• Modifying and Testing a template in Crystal Reports
• Report Parameters
• Correlation between T-Plan report tables, Source modules and Types
• Report.mdb Tables described
• T-Plan Remote Execution Console Templates
• T-Plan Administrator Templates
• T-Plan Incident Manager Templates
• IMS Report Parameters
• IMS Report Tables described
• Incident Manager - Single or Multiple setting
• T-Plan WebIMS

1)  T-Plan Professional Templates  back >> 

Templates that are supplied with T-Plan are written in Crystal Reports version 9.0. The run-time libraries shipped with T-Plan are Crystal version 9.0.

Template Name: The physical file name of Crystal report template.

Context: The T-Plan module where the report can be run from.

Report Type: Combined with the Context, gives the source table in Report.mdb.

Source Table: The table in the T-Plan Report.mdb file from which the report gets it's data.

Note (a) The Catalogue report template is effectively three reports, Reference Data, Software Release or Test Data, depending on where it is called from.

Note (b). The Statistic reports are called from the Statistic tab in Manage. They require Administrator privileges.

1a)  Adding and Modifying Templates  back >> 

T-Plan report generation works as follows:

Within each T-Plan module (Analyze, Design, Reference Data. etc) there are a predefined set of source tables available for use with Crystal reports. see section 2. These tables reside in the Report.mdb database, which can be found in the <Documents and Settings>\<UserName>\Local Settings\Application Data\T-Plan\Extensions\tpreport directory.

New user written report templates can be created using ONE of these tables as the source data. Once created, the template can be added to T-Plan using Template Extensions Administrator.

It is critical that the Type and Source fields are synchronized correctly, and match the source data for the template. The existing templates shipped with T-Plan offer a guide as to what are valid settings.

For existing standard templates that require personalizing, copies can be found in the Templates sub-directory of the T-Plan path.

These templates may be altered to suit the user and then added to T-Plan using the Extension Manager and selecting T-Plan Reporting Module. It is imperative that the Type and Source fields are identical to the standard template.

To amend or add reports you will require a full version of Crystal Reports Version 9 or above.

1b)  Monochrome Templates  back >> 

For users who prefer black and white reports a complete set of templates can be found in the 'mono' folder in the Templates sub-dicrectory.

1c)  Modifying and Testing a Template in Crystal Reports  back >> 

1. T-Plan runs a query against the T-Plan database to get the necessary dataset for the report.
2. The data is placed into the relevant table in Report.mdb database. This is located on the local hard drive in <Documents and Settings>\<UserName>\Local Settings\Application Data\T-Plan\Extensions\tpreport
3. A physical copy of the report template is placed into the TEMP folder (usually C:\Windows\Temp)
4. T-Plan invokes the Crystal Runtime Viewer and loads the report template into it.
5. The Viewer is passed the location of the Report.mdb and uses this as the source data for the report.
6. Finally, the report is displayed in the Crystal Viewer (or directly to the printer) complete with data .

When modifying and testing reports in Crystal Reports Developer environment it is necessary to set the location of Report.mdb manually. This is because step 5 above does not take place and the location will vary between different PCs. 

By default, all templates shipped with T-Plan are configured to look for Report.mdb in C:\Temp. Therefore when modifying and running templates in Crystal Developer environment it will be necessary to copy Report.mdb from it's "T-Plan" location to C:\Temp. As explained below.

1. Start Crystal Reports Designer and load the template you wish to alter.
2. Make any changes required.
3. Start T-Plan and preview the report that corresponds to the template you have loaded in Crystal.
4. The relevant table in the Report.mdb will have been populated with data. Reports run in T-Plan use a copy of the Report.mdb in <Documents and Settings>\<UserName>\Local Settings\Application Data\T-Plan\Extensions\tpreport, however....
5. The Report.mdb file must be copied to C:\Temp, this is where Crystal is expecting to find the source data for the report.
6. In Crystal Reports Designer, preview the report you have loaded. It will be using the same data as the report in T-Plan.
7. Having made your amendments to the template, save it under a new name and close Crystal.
8. The new template can be installed into T-Plan by adding it with the Extensions Manager. Note that the settings (Report Type & Context) must match those of the original report.

1d)  Report Parameters  back >> 

When each Crystal Report is generated, there are a set of parameters passed to the report by T-Plan. These are available to be used on each new report.

1e)  Correlation between T-Plan report tables, Source modules and Types  back >> 

The General Type indicates that the default report table for that source module is used. By selecting an alternative Type, you are overriding the default and effectively telling T-Plan to generate an alternative query to populate an alternative table.

It must be noted that Types are specific to a particular Source Module. For example, Test Manager reports cannot be run from the Design module. The source table will fail to populate and an error will be generated.

When adding a new user written template to T-Plan Professional the correct settings are selected for Source Module and Type. If either of these are incorrect, the report will fail to generate.

1f)  Report.mdb Tables described  back >> 

There are no relationships between the tables in the T-Plan report database. Each table is populated independently by a separate query that is generated each time a report is run. The one exception to this rule are reports called from the Statistics tab, where two tables are populated simultaneously. They are TPRAnalyses and TPRStatistic. For full details please see The definitions of these tables listed below.

TpID fields contain GUIDs. These are 32 character Globally Unique Identifiers. They are used by the main T-Plan database for internal referencing and maintaining uniqueness.

tpNumber fields refer to the unique numbering system in T-Plan. Each 'Entity', e.g. Function, Script, etc. will have it's own unique number within a T-Plan database.

TPDesignRpt

The records in TPRDesign represent the hierarchy in Design. The ordering is such that each Entity is listed, followed by any attributes and Reference Data associated with that entity.

The level denotes the indentation of the entity within the Design tree structure. In order to replicate the original Design hierarchy order use order by tpSeqNo.

The final field, tpEntId, is used to determine the entity type. This is required when a database has been customised and either/both of the two Design entities are renamed from Specification and Script.

TPRCatalogue

TPRCatalogue is populated with one of three types of data. Reference Data, Software Releases or Test Data, depending on the module from where the report is launched.

The ordering is by tpSeqNo.

TPRCatSearch

TPRCatSearch contains a straightforward listing of all Catalogue entries displayed in the Results window of a Cataloque Search. This applies to Reference Data, Software Releases or Test Data, depending on the module from where the report is launched.

The ordering is by tpSeqNo.

TPREntSearch

TPREntSearch contains a straightforward listing of all entities displayed in the Results window of an Entity Search.

The Entities resulting from a search may be pulled from Analyze, Design and/or Manage, depending on the criteria of the search query.

The ordering is by tpSeqNo.

TPRptAudit

TPRAudit holds data from the Audit table of the main T-Plan database. It represents the Audit data exactly as shown in the T-Plan Audit window.

TPRRefDataToAnalyse

This table is no longer used.

TPRRefDataToDS

TPRRefDataToDS is the source of all Impact Analysis of Reference Data on Analyse, Design and Manage. It is populated by a query run against a selected instance of Reference Data.

Each record contains details of Test Conditions and their parent Entities that the Reference Data is directly or indirectly associated with.  

TPRptImpact

The Impact Analysis reports are all based on the same template (Impact Analysis.rpt) and use the same table for their source data (TPRptImpact).

The source data differs depending upon whether the report is called from Analyse or Design, Recursive or Single entity.

When run from Analyse the tpStatus field is populated with the Status of each Test Condition within a Suite/Script.

When run from Design, the tpStatus field is populated with the Status of each Script within a Suite.

TPRSpool

The records in TPRSpool represent the hierarchy in Analyze. The table is generated by selecting any entity from within the Analyze window.

The ordering is such that each Entitiy is listed, followed by any attributes and Reference Data associated with that entity.

The level denotes the indentation of the entity within the Analyze tree structure.

The final field, tpEntId, is used to determine the entity type. This is required when a database has been customised and either/both of the two Analyse entities are renamed from Function and Test Condition.

TPRStatistic

TPAnalyses

Populated when a Statistic has been selected and a report is called.

Each record in TPStatistic contains the Statistic Name and Suite Name. For Statistical history, there are a set of records for each statistical run. The difference between Runs is determined by the tpDate.

For each run, there are as many records as there are Test Statuses. The percentages of each Test Status achieved appear in their respective tpPercent fields.

When a query is run from Statistics, TPRStaistic and TPAnalyses are populated simultaneously. The link between them is the field tpStatName.

The ordering is by tpSeqNo.

TPRStatSearch

Condition Status Search results. Table will contain all Test Conditions resulting from a Test Condition search.

Populated with Condition Details (Name, Priority and Status), The parent (Function) of the Entity as well as Create and Modify data.

TPRTestLog

TPRTestLog table. There is one record for each Test Log. All records contain The same Suite and Script data, but the Creation, Modified and LogText will be unique for each record.

TPRTestManStatic

TPRTestManStatic contains details of all Attributes within the T-Plan System. For each Attribute there is a record containing Name and Description as well as the Attribute Value Name and Value itself.

TPRTestRefData

Used for Condition Reference Impact Analysis. The table is populated when a Test Condition is selected in the Analyze window. The first record will be details of the Test Condition itself.

Following record will contain Function name and description (the Condition's parent). Subsequent records will show any Scripts followed by any Suites with which the Test Condition has been associated.

The ordering is by tpSeqNo.

TPRTestStatusSummary

TPRTestStatusSummary is populated with Test status Data for selected Suites. The Test Status Descriptions are aggregated to give a count for each status, within a Suite.

The ordering is by tpSeqNo. To order in Original Suite order (replicating the Manage structure) it is necessary to sort by tpNameSeq. This is a because Crystal Reports has a bug which will not allow grouping in Original order .  

TPScheduleRpt

The records in TPScheduleRpt represent the hierarchy in Manage. The table is generated by selecting any entity from within the Manage window.

The ordering is such that each Entity is listed, followed by any attributes and Reference Data associated with that entity.

The level denotes the indentation of the entity within the Manage tree structure.

The tpCond fields are populated with Test Condition Status details. There is a separate entry for each Test Condition Status.

TPRScheduleRptExt

The records in TPScheduleRptExt are the same as the records in tpScheduleRpt but with the addition of notes fields for the Conditions from Analyze and the Scripts from Design.

2) T-Plan Remote Execution Console Templates

The report templates available in the Remote Execution Console are the same as those available from the Manage module in T-Plan Professional.

3)  T-Plan Administrator Templates  back >> 

The Administrator templates are created when the database is created. There is no provision for adding user created templates in T-Plan Administrator.

The templates are run directly from the Administrator database, rather than a separate report database file.

4)  T-Plan Incident Manager Templates  back >> 

Template Name. The physical file name of Crystal report template.

Module. The Incident Manager module where the report can be run from.

Source Table. For T-Plan IMS installations the reporting tables are located in the main IMS database. 

Because these tables are shared, in order that each report displays only those records relevant to a user request, the select statement used as the source data for the reports include a where clause:- WHERE tpUserID = <loggedon userID>

4a)  IMS Report Parameters  back >> 

When each Crystal Report is generated, there are a set of parameters passed to the report by Incident Manager. These are available to be used on each new report.

4b)  IMS Report Tables described  back >> 

There are no relationships between the tables used for reporting. Each table is populated independently by a separate query that is generated each time a report is run. 

TpID fields contain GUIDs. These are 32 character Globally Unique Identifiers. They are used by the main T-Plan database for internal referencing and maintaining uniqueness.

Links to Table definitions.

TPRPTStatic

A dump of all Static data relating to the IMS database. Each record will be populated by one of:- 

Department, Closure Code, Classification, Priority, Status, Prefix, System Reference, Software Release

Consequently, for example, If there are six Classifications in the database, there will be six records in the TPRptStatic table, one for each.

TPRPTIncidentRpt

Table is populated with data from the main Incident Manager database. 

The ordering is determined by the field tpSeqNo. Where there are more than one history log for an Incident, the logs are ordered most recent first.

tpLatest applies to Log entires only. A value of 1 indicates the Log entry is the Last to be raised for that Incident.

TPRptAudit

TPRAudit holds data from the Audit table of the main Incident manager database. It represents the Audit data exactly as shown in the Audit window.

TPRptStatistic

This contains data for IMS statistics. The table is populated by Statistic and records occur for each date/time the Statistic has been updated.

The ordering is by tpSequenceNo, which is correct for the Statistics to be displayed in Date order.

4c) Incident Manager - Single or Multiple setting  back >> 

There is an extra column within the T-Plan Incident Manager Extension Administration window (bottom pane when viewing the list of templates) which gives the option of setting a report to be run against a selection of Incidents (those highlighted at the time of requesting the report) or All Incidents.

In order to configure a template to be available to the end user for both 'Selected' and 'All' you must add your template to the IMSReport extension twice. Set the 'Multiple' check box to True for one of them.

The Report with Multiple set to True will generate a report based on only those Incidents that are selected at the time of the report request.

The Report with Multiple set to False will generate a report based on all Incidents in the current view.

It is a good idea to rename one of the two new report entries to distinguish between the two.

5)  WebIMS  back >> 

WebIMS report templates are exactly the same as those shipped with T-Plan Incident Manager and the source tables have an identical format.

Questions or comments

If you have any questions for our technical support staff, please contact us at support@t-plan.co.uk. You can also phone 0845 062 7744 (International: +44(0)1209 614714). When you get in touch, please have your customer ID number available. If you have any questions about the documentation, please contact us at support@t-plan.co.uk. Corporate Web Site at: www.t-plan.co.uk.