Analysis Tools - XML/HTML Project Reports

Transcription

1 Exclusively within Revolve Enterprise Edition there are tools that create HTML pages. These tools are located under the Analysis Tools selection under the Enterprise option on the menu bar. There are 4 tools: XML/HTML Project reports - Generate All, XML/HTML Project reports Generate HTML, XML/HTML Project reports Generate XML, XML/HTML Project reports Generate Reports. These pages allow viewing information about the components within a project, how they relate to each other, and the data files used. The reports can be viewed either on a website, or with the Revolve HTML browser. XML/HTML Project Reports Generate All First select Analysis Tools under Enterprise on the Revolve Tool Bar. There are two steps in the report generation process. First a set of XML files is generated and then these files are translated into HTML pages. The Generate All tool performs both of these steps, as well as the option to view the report pages. For a very large project, this could take many hours, and it is recommended that the steps be done individually, especially for medium to large projects. Page 1 of 12

2 First generate the XML, then the HTML, and then view the reports. To use the Generate All tools, first right click on the tool, and select properties. This will bring up the parameters window, as shown below. Page 2 of 12

3 The first parameter is Alternate XML file folder. Leaving this field blank will cause the default location (under the project directory) to be used. Alternatively, a different folder/location can be specified here. Page 3 of 12

4 The second parameter is Alternate HTML file folder. Leaving this field blank will cause the default location (under the project directory) to be used, or a different folder/location can be specified here. Page 4 of 12

5 The translation configuration file is used by the translation process to locate the XSL files and to specify the index and page sizes. You can enter a new location here, or leave blank to use the default location. Page 5 of 12

6 The reports can be generated with or without graphics. Generating the graphics will significantly increase generation time and also requires extra disk space. Graphics, as JPEG images, can be created for COBOL, JCL and screens (bms/mfs). Page 6 of 12

7 This parameter will create an HTML page with the contents of Revolve s project complete report. If you select this option, a Project Issues menu is created within the HTML reports that will display that page. Page 7 of 12

8 This parameter allows a link to be added to a report to allow source code to be invoked in an external viewer. Page 8 of 12

9 Selecting this option will automatically load the generated reports into an HTML browser when the generation has finished. If this option is not selected, clicking the view reports tool will do the same thing. XML/HTML Project Reports Generate XML If you are going to generate the XML and HTML individually, the XML must be generated first. Page 9 of 12

10 To use the XML/HTML Project Reports - Generate XML tool, first right click on the tool, and select properties. The parameters available for this tool are: Alternative XML file folder, Generate graphics, Generate Project Issues, and Allow viewing of source in external editor These are explained above in the section on XML/HTML Project Reports- Generate All. XML/HTML Project Reports Generate HTML If you are going to generate the XML and HTML individually, the HTML must be generated second. If you have already run the XML/HTML Project Reports Generate All, running the XML/HTML Project Reports Generate HTML will regenerate the HTML. Page 10 of 12

11 To use the XML/HTML Project Reports - Generate HTML tool, first right click on the tool, and select properties. The parameters available for this tool are: Alternative XML file folder, Alternative HTML file folder, Alternative XML translation configuration file and HTML viewer. These are explained above in the section on XML/HTML Project Reports - Generate All. XML/HTML Project Reports View Reports This tool will invoke the HTML Browser and display the reports. You must have run either the XML/HTML Project Reports-Generate all or both the XML/HTML Project Reports-Generate XML and the XML/HTML Project Reports-Generate HTML before running the XML/HTML Project Reports View Reports. Page 11 of 12

12 To use the XML/HTML Project Reports View Reports tool, first right click on the tool, and select properties. The only parameter available for this tool is Alternative HTML file folder. This is explained above in the section on XML/HTML Project Reports - Generate All. Page 12 of 12