Echelon NodeBuilder Resource Report Generator User Manual

NodeBuilder® Resource Report Generator User’s Guide Release 1 Revision 1 @ ECHELON® C o r p o r a t i o n 078-0260-01A

Reading Reports Each resource is listed on its own page and contains detailed information about its type, attributes, related formats, and other usef

3. Select Show All from the report page. This displays all resources in that category (for example, all network variable types). 4. Right click th

12. Click Save. Saving a Resource Report as a PDF File You can convert a resource file to an Adobe Portable Document Format (PDF) file, using Adobe A

3. On the View menu, point to Text Size, and then click Smallest. This compresses the size of the Web page text and significantly reduces the page co

4 Resource Report Generator Wizard The NodeBuilder Report Generator Wizard provides a simple, easy-to-use interface for generating resource reports

Generating a Resource Report You can create a resource report using the NodeBuilder Resource Report Generator Wizard. To generate a report, follow th

Welcome Page You can choose the report output destination folder and prepare reports for hosting using the Welcome page. Set the options as describ

Resource Reports Page You can specify the location of the resource report using the Resource Reports page. You can specify a location on a local comp

Report Language Selection Page You can choose between 29 different report languages using the Report Language Selection page. You can define a list o

Support Files Preferences Page You can specify the location of the support files that are required to view a report using the Support Files Preferenc

Echelon, LON, LONWORKS, LonTalk, Neuron, LONMARK, 3120, 3150, NodeBuilder, ShortStack, the LonUsers logo, the Echelon logo, and the LONMARK logo are

Dependencies Handling Page You can include resource definitions for resources that are referenced by your report using the Dependencies Handling page

Server and Transformation Page You can specify the index page file name and the transformation stylesheet on the Server and Transformation page. The

Finish Page You can generate your report using the options that you specified in the wizard using the Finish page. Set the Launch Browser upon Comple

Report Generator Progress Window The Report Generator Progress window displays the status of your report while the report is being created. Depending

5 Generating Reports Locally and for Hosting You can prepare resource reports for local use and for hosting on a server. Locally stored reports rem

Generating a Local Report You can generate and view a report on your local hard disk. To generate a local report, follow these steps: 1. Start the

7. Select a resource file set from the Resource File Set list. 8. Choose whether or not you want to exclude any file sets from your report with th

The default names are index.html and index.xsl. For viewing local reports, enter any report start page name with an .html or .htm file extension. For

Generating a Report for Hosting You can generate a report to be hosted on a Web server. This allows multiple users to view your report. The followi

Resource File Set list. Preferences are ignored for all other file sets listed in the Resource File Set list. 9. Clear the Exclude this File Set fro

Table of Contents Introduction 2 Getting Started 3 System Requirements ...

17. Click Next. 18. Type names in Report Start Page Name and Initial XSLT Transformation Stylesheet. Consult your Webmaster before setting the nam

Note: This procedure only tests that the report was successfully hosted and that the links work properly. It does not verify each file of the report.

Verifying Hosted Reports You can verify that a report has been hosted correctly and that the Web server and related infrastructure have been set up c

Hosting Reports for User-Defined Resources This example shows you how to report generate and host user-defined, non-standard resource reports. 1. St

7. Click Next. 8. Set your reporting preferences for each resource file set listed in the Resource Reports page. 9. Choose whether or not you want

15. Click Next. 16. Clear the Automatically Report Referenced Resources checkbox if you do not want referenced resources to be included in the repor

22. Set Launch Usage Hint Editor features to start the Usage Hint Editor upon completion of the Wizard. You can start the Usage Hint Editor at any ti

Resource File Validations When you generate a resource report with the report generator, it reports problems in the resource file set. Problems may

Table 5.1 Resource File Validation Warnings Warning Message Displayed Description Missing Strings Warning: String ^<scope selector>:<index

Table 5.1 Resource File Validation Warnings Warning Message Displayed Description Dangling Reference Warning: Fail to resolve reference for <refer

1 Introduction The NodeBuilder Resource Report Generator is a NodeBuilder Resource Editor plug-in that helps you create reports that document resour

6 Providing Supplementary Information When the report generator generates a report, only data that is present in the selected resource file sets is

Usage.xml Data A usage.xml file contains usage hints displayed in XHTML text. Each hint can include any XHTML and HTML tags that can be included in a

Using the Usage Hint Editor Software The Usage Hint Editor provides a simple interface with three main components: a Resource pane, a Hint pane, and

Table 6.2 Usage Hint Editor Resource Categories Category Description This entry represents a hint that applies to the entire set. You can click the p

Hint Pane The Hint pane shows the usage hint text for the currently selected resource item in the Resource pane. The Hint pane provides a simple XHTM

Starting the Usage Hint Editor You can start the Usage Hint Editor automatically when you run the report generator, or you can start the Usage Hint E

Creating a Usage Hint You can create a usage hint for any resource item. To create a usage hint for a resource item, follow these steps. 1. Start t

XHTML Restrictions You must enter usage hints in an XHTML compliant format. However, not all data that may appear in an XHTML page may also appear i

7 Customizing Report Presentations This section shows you how to change the appearance of resource reports. This section provides only information a

XSLT Transformations A resource report consists of a set of XML files that can be viewed in a Web browser. The XML files contain unformatted data.

2 Getting Started The following section provides you with information on how to set up your computer to view, generate, and maintain resource repor

XSLT transformation stylesheets and JavaScript code control the entire transformation process. These files are all stored in the Templates folder on

Creating a Custom Report Presentation You can customize reports in two ways: you can change the layout and look of a report or you can change how a r

50 NodeBuilder Resource Report Generator User’s Guide 6. Specify the name and location of your modified XSLT transformation stylesheet in the Serv

System Requirements To generate reports, you need a computer with the NodeBuilder software and Internet access (optional). To view reports, you only

3 Viewing Reports This section describes how to view and analyze reports. A description of the report structure is also provided. 5 NodeBuilder Re

Report Structure Each report created by the report generator contains a single HTML page that serves as an index page. This page, also known as the r

Navigation The resource report resembles a Web page and navigating through a report is much like navigating through a Web site. To view a report, lau