About the Report Generator

The Report Generator application allows you to generate and print reports directly from the supported oscilloscope applications. The Report Generator is integrated with applications and enhances the application capabilities by simplifying the process of creating and maintaining reports.

The Report Generator application includes the following features:

•	Automates the process of compiling the test results

•	Automates the process of generating the reports

•	Allows you to create layouts using the factory default templates or user defined templates

•	Creates custom templates

•	Saves files in the custom file formats such as .rgt, .rpl, or .rpt.

•	Exports files in .rtf file format

•	Prints Template or Report to a file

See also

Steps to set up the Report Generator

Starting the Report Generator Application

About the Test Template Editor

About the Report Layout Editor

About the Report Viewer


Starting the Report Generator

You can generate and print reports directly from the oscilloscope. To start the Report Generator, go to Utilities > Reports.

See also

Create a new or edit an existing test template

Define a new or edit an existing report layout.

Generate, print, or view a report.


Shortcut Keys

Shortcut Keys for the Report Generator


About the Template Editor

The Report Generator provides a number of factory default test templates. The Template editor allows you to create custom test templates.

You can use the Template Editor to do the following tasks:

•	Create test templates

•	Edit test templates in the .rgt format (report generator template)

•	Cut, copy, and paste items across templates

•	Save the test templates that you created

•	Reuse the test templates in other reports

When the report is generated, the application fills in the fields of the template using the acquired data from the oscilloscope.

The Template Editor has a palette list that displays the following groups of fields: the Application Fields, Oscilloscope Fields, and Native Fields. The template editor provides you with the option to create custom groups; these groups once created, appear in the palette list. The fields are listed according to the group selected. You can use these fields to design and create a template.

You can place the fields in the template, and then move and size them appropriately. Multiple fields can be selected and placed in the template. You can select more than one field and make the following changes: cut, copy, paste, align, delete, size, edit font, and change the caption of the fields.

Once a template is defined and saved, either select Done to close the template editor, or use the Layout icon to directly go to the report layout editor.

See also

Using the Template Editor


Default Template Editor Settings


Palette List

To view the palette list, select View > Palette Toolbar.

The palette list is a list of items or "Fields" that can be dragged and dropped on to the templates to design the reports.

The Palette list includes the following categories of fields:

Native Fields; lists fields used mainly to enhance the appearance of the report, such as Line, Rectangle, and Date.

<Application> Fields; fields related to the application. The <Application> is replaced with the name of the application from which you opened Report Generator.

Oscilloscope Fields: groups of fields related to the data acquired from the oscilloscope.

Custom Groups; lists fields for new groups not included with the base Report Generator application.

The fields often contain a hierarchy. For example, a "Horizontal" field will have subordinate fields such as Position, Scale, and so on. If a Field has subordinate fields under it, a + (plus) symbol will precede the field name in the palette list.


Application Fields

These fields are unique for each application. When you select the applications field tab, a list appears with the names of the currently available applications.  Refer to the online help that corresponds with each application for descriptions of the application fields for which you are generating a report.


Native Fields

You can enhance the report using the following parameters from the Native fields: Static Text, Rectangle, Line, Logo, Table, Date, and Time.

You can drag any of the fields from the Native field and drop it in the test template.

Static Text

1.	From the Native fields, drag and drop the static text field.

2.	In the Edit Text dialog box, select Virtual Keyboard [image].

3.	Enter the static text.

4.	Select OK.

Rectangle

1.	From the Native Fields, drag and drop the Rectangle object into the test template.

The black squares that appear at the corners of the rectangle allow you to change the rectangle size.

Line

1.	From the Native Fields, drag and drop the Line object into the test template.

The black squares that appear at the corners of the line allow you to change the line size.

Logo

1.	From the Native Fields, drag and drop the Logo field into the test template.

2.	In the Edit Image dialog box, Select [image].

In the Virtual Keyboard enter the path and filename and select Enter.

      Or

Select Browse to navigate to the location of the logo graphic.

3.	Select OK.

Table

1.	From the Native Fields, drag and drop the table field into the test template.

2.	In the Edit Table dialog box, you can select the number of rows and columns.

•	Select [image] next to Number of Rows and Number of Columns to open the virtual keypad.

•	In the Virtual Keypad, enter the number, and select Enter.

3.	Select OK.

Date and Time

From the Native fields, drag and drop the Date and Time field. The Date and Time are taken from the oscilloscope system information at the time the report is generated.


Oscilloscope Fields

The oscilloscope fields are grouped into ten subgroups:

Waveform Group: The Waveform group has the entire active live channels and independent channels (only CH1 to CH4) waveforms in both jpeg and bmp. These waveforms are generated to smoothen out the stair-step effect seen on the display.

Vertical Group: The Vertical group has all vertical related fields such as the vertical scale, position, offset, and others.

Horizontal Group: The Horizontal group has all horizontal related fields such as the horizontal divisions, scale, record length, position, sample rate, and others.

Math Group: The Math group has all the math related fields such as the math definition for a specified math channel, magnitude, spectral gate, spectral phase, spectral window, spectral frequencies of the math channel, and others.

Trigger Group: The Trigger group has all trigger related fields such as the trigger type, mode, level, and various fields related to different trigger types.

Measurement Group: The Measurement group has all the measurements such as the eight automated measurements and the immediate measurements.

Acquisition Group: The Acquisition group has all acquisition related fields such as the acquisition mode, acquisition state, repetitive mode, fast acquisition mode, and others.

Cursor Group: The Cursor group has all the cursor related fields such as the cursor mode, source, state and type of the cursor, H Bars, V Bars, and others.

Zoom Group: The Zoom group has all zoom related fields such as the zoom horizontal position, horizontal scale, and others.

Histogram Group: The Histogram group has all histogram fields such as the coordinates of the histogram box, mode, size, source, and others.

Screen snapshot: The Screen Snapshot group has two variations: one in color and the other in black-and-white. For these screenshots, the attributes are graticule, ink-saver, and jpeg.


Template Editor Menus

The menu bar has the following menus.

File

Edit

View

Object

Window

Help


Template Editor: File Menu


Template Editor: Edit Menu

The available Edit menu selections depend on whether or not a template is active. In other words, the client area is empty or has a test template open.


Template Editor: View Menu

A ( [image]) appears next to the selected menu item.


Template Editor: Object Menu

The available object menu selections depend on whether a parameter in the client area is selected or not.


Template Editor: Window Menu


Template Editor: Help Menu


Template Editor: Toolbars

You can choose to display or hide these toolbars using View > Toolbars. The Template Editor window has the following toolbars.

Standard

Align/Size

Layout

Action


Template Editor: Standard Toolbar

To view the standard toolbar:

Go to View > Toolbar > Standard.


Template Editor: Align or Size Toolbar

To view the align or size toolbar:

Go to View > Toolbar > Align/Size.


Template Editor: Layout Toolbar

To view the layout toolbar:

Go to View > Toolbar > Layout.


Template Editor: Action Toolbar

To view the action toolbar:

Go to View > Toolbar > Action

The Layout button also prompts you to save documents.


Template Editor: Status Bar

The Status bar displays the status of the application and tool tips for selected options.


Using the Template Editor

To create a new template, follow these steps:

1.	From the Palette List drag and drop the fields that you want in the report.

If you drag and drop a group from the Palette List, all the fields within the group are placed in the test template.

2.	Organize the fields as you want them to appear in the report.

3.	After you have finished creating the template, select File > Save.

To edit an existing template:

1.	Open an existing template using Browse > Open. Select the template to edit.

2.	Organize the fields as you want them to appear in the report.

3.	From the Palette List, drag and drop the fields that you want in the report.

If you drag and drop a group from the Palette List, all the fields within the group are placed    in the test template.

4.	Organize the fields as you want them to appear in the report.

5.	After you have finished editing the template, select File > Save.

See also

Create Custom Groups

Edit Custom Groups

Change Template Size

Edit Caption

Change Font

Align Fields

Make Same Size.

Template Editor Window


Create Custom Groups

You can create custom groups using fields from the Palette List. To create custom groups:

1.	Go to Edit > Create Custom Group.

2.	In the Create Custom Group dialog box, enter the group name. You can enter the group name using the Virtual Keyboard.

3.	Select Next. The Select Fields dialog box displays all the fields of the Palette List.

Select fields in the Available Groups and Fields: area to add to the custom group.

4.	Use Add>> to add selected fields to the new group. Use Add All to add all available fields to the new group.

5.	Use <<Remove to remove selected fields from the selected group. Use Remove All to remove all fields from the selected group.

6.	Select Finish.


Editing Custom Groups

To edit custom groups:

1.	Go to Edit > Edit Custom Group.

2.	In the Edit Custom Group dialog box, select a group to edit.

3.	Select Next.

4.	Use Add>> to add selected fields to the new group. Use Add All to add all available fields to the new group.

5.	Use <<Remove to remove selected fields from the selected group. Use Remove All to remove all fields from the selected group.

6.	Select Finish.


Delete Custom Groups

To delete custom groups:

1.	Go to Edit > Edit Custom Group.

2.	In the Edit Custom Group dialog box, select a group to delete.

3.	Select Delete. A message box appears asking you to confirm your choice.

4.	Select Yes to delete.


Change Template Size

To change template size:

1.	Go to Edit > Change Template Size.

2.	In the Change Template dialog box, select the Template Size as 1/4 page, 1/2 page, or Full page.

If the printer is not available, select the Page Size as Default (8.5" x 11"); otherwise, select Configure Page.

3.	In Page Setup dialog box, select the paper size, source, orientation, and margins.

4.	Select OK to return to Change Template Size dialog box.

5.	Select OK.

Note: Do not reduce the template size beyond the content filled in the template. You may lose information.


Select All

To cut, copy, or delete the fields from the test template, you need to select the fields. You can also select the fields from the test template by selecting CTRL+ selecting the fields.

To select all:

1.	Go to Edit > Select All


Find

You can search for text in the test template. To find a text string,

1.	Select Edit> Find.

2.	In the Find dialog box, enter the search string using the Virtual Keyboard.

3.	Select Find Next until you find the required search string.


Replace

You can search and replace the text in the test template. To replace a text string go to
Edit > Replace.

1.	In Replace dialog box, enter the search string using the Virtual Keyboard in the Find what field.

2.	In Replace with field, using the Virtual Keyboard, enter the replacement string.

3.	Select Find Next until you find the required search string.

4.	Select Replace to replace one instance of the string.
Or
Select Replace All to replace all instances of the string.

5.	Select Cancel after you have replaced the strings.


Bring to Front

You can bring the selected fields to the front. To bring to front:

1.	 Go to Object > Bring To Front.


Send to Back

You can send the selected fields to the back. To send to back:

1.	Go to Object > Send To Back.


Show/Hide Text

You can show or hide the captions for the selected fields.

1.	Go to Object > Show/Hide Text.


Position Caption

You can position the caption of the selected fields on either the left or on the top of the field. To position caption text:

1.	 Go to Object > Position Caption to the Left, or on Top.


Edit Caption

You can edit the caption of the selected parameter or object. To edit the caption, follow these steps:

1.	Select the caption you want to edit.

2.	Select Object > Edit Caption.

3.	In the Edit Caption dialog box, select [image] to enter the caption using the Virtual Keyboard. You can also type in the new caption.

4.	Select OK.


Change Font

You can change the font used for the selected field or fields in the template. To change the font:

1.	Select the fields or fields in the test template.

2.	Select Object > Change Font or right click the field to display the options.

4.	In the Font dialog box, choose the font, font style, size, effects, and script.

5.	Select OK.


Align Fields

You can align the text displayed in fields to the top, bottom, left, or right of the field. To align text in fields go to Object > Align Fields.

1.	Select the fields in the test template.

2.	Select Object > Align Fields > Top, Bottom, Left, or Right to align the field text accordingly.


Make Same Size

To make two or more fields of the same size, go to Object > Make Same Size. Select one field as the dominant field to which the other fields will be sized.

1.	You can set the selected fields to same height, width, or both.

2.	Select the fields in the test template.

3.	Select Object > Make Same Size > Height, Width, or Both to make the selected fields the same size.


About the Report Layout Editor

The Report Layout Editor helps you define the layout for reports. After you create the report layout, you can reuse it to generate multiple reports.

You can use the Report Layout Editor to do the following tasks:

•	Select the number of test templates per page

•	Position the various templates in the report

•	Create a report with up to five pages with different layout sizes

•	Enter unique, easy to recognize layout names for subreports with a unique test title. This unique test title helps you to select the required template when generating a report.

•	Reuse layouts in other test templates.

•	Define headers and footers.

To display the Report Layout Editor, select Define Report Layout > New.

The Report Layout Editor window has two panes:

List of Templates: Displays a list of templates, template sizes, template folders, and buttons that allow you to clear or place a template in a report layout tile.

New: Opens a new template.

Directory: Opens a Browse window to select the templates folder.

Place on Tile: Places the selected template on the tile.

Clear Tile: Clears the selected template from the tile.

Report Layout: Displays the selected report layout and the header and the footer definition.


Default Report Layout Editor Settings


Report Layout Editor Window

The Report Layout Editor window contains a menu bar, a tool bar, a list of templates pane, and a report layout pane.

See also

Menu

Toolbars

List of Templates Pane

Report Layout Pane

Status bar


List of Templates Pane

The List of Templates Pane displays the path of the template, templates in the folder, file names, and template sizes. You can select the template from this list and place it in the Report Layout pane.

In the List of Templates Pane, you can do the following:

•	Use the Virtual Keyboard to select a different path where you have saved customized templates. You can also use the Directory button to displays a Browse for Folder window.

•	Create a new template by selecting New. The Template Editor Window is displayed, where you can create a new template.

•	Drag and drop the Template File into the report layout pane's tile or select the template file and select Place on Tile >>.

•	Clear the selected tile in the report layout pane by selecting << Clear Tile.


Report Layout Pane

Depending on the number of tests selected per page, the Report Layout pane appears as shown in the following figure:

In the Report Layout Pane, you can do the following:

•	Specify a title for each test.

•	Define or modify the header and footer.

•	Navigate between pages of the report layout.


Report Layout Editor: Menus

The menu bar in the Report Layout Editor window has the following menus:

File

Edit

View

Layout

Page

Help


Report Layout Editor: File Menu


Report Layout Editor: Edit Menu


Report Layout Editor: View Menu

A ( [image]) appears next to the menu item selected.


Report Layout Editor: Layout Menu

A ( [image]) appears next to the menu item selected.


Report Layout Editor: Page Menu


Report Layout Editor: Help Menu


Report Layout Editor: Toolbars

You can choose whether or not to display the toolbars using View > Toolbars. The Report Layout Editor window has the following toolbars.

Standard

Page

Layout

Action


Report Layout Editor: Standard Toolbar

To view the standard toolbar go to View > Toolbars > Standard.


Report Layout Editor: Layout Toolbar

To view the layout toolbar go to View > Toolbars > Layout.


Report Layout Editor: Page Toolbar

To view the page toolbar go to View > Toolbars > Page.


Report Layout Editor: Action Toolbar

To view the action toolbar go to View > Toolbars > Action.


Using Report Layout Editor
Using the Report Layout Editor

To define a report layout, follow these steps:

1.	Set the report layout.

Select Layout > One Test Per Page / Two Tests Per Page / Three Tests Per Page. The Report Layout pane displays tiles depending on the selected number of tests per page.

2.	Add the templates.

The List of Templates pane displays the templates in the default directory — C:\TekApplications\tdsrt-eye\ReportGenerator\modules\<modulename>Templates, where "modulename" can be SerialAnalysis, InfiniBand, or PCIExpress.

From the List of Templates pane, select, drag and drop the templates into the tiles in the Report Layout pane. You can use the Place on Tile and Clear Tile buttons to add or delete the templates.

If you want to define a new template, select New in the List of Templates pane.

To browse for a folder other than the default templates, select Directory to display the Browse for Folder dialog box. Navigate to the folder where you have the templates stored and select OK.

3.	Define the Header and Footer.

4.	Save the report layout.

Select File > Save to display the Save dialog box. Enter the report layout name and select Save.

The report layout is saved in the .rpl format.

To edit an existing report layout, follow these steps:

1.	Change the report layout.

Select Layout > One Test Per Page / Two Tests Per Page / Three Tests Per Page. The Report Layout pane displays tiles depending on the selected number of tests per page.

The application displays an alert message — All the Test(s) information in the current page will be lost. Do you want to continue?

Select Yes to continue or No to stop.

2.	Add or Remove the templates.

In the Report Layout pane, select the tile to which you want to add or remove the template.

To remove a template from the Report Layout, follow these steps:

•	In the List of Templates pane, select Clear Tile.

•	The application displays an alert message — The test is already filled with data. Do you want to remove it?

•	Select Yes to continue or No to stop.

To add a template to the Report Layout, follow these steps:

•	The List of Templates pane displays the templates in the default directory —C:\TekApplications\tdsrt-eye\ReportGenerator\modules\ <modulename>\Templates, where "modulename" can be SerialAnalysis, InfiniBand, or PCIExpress.

•	From the List of Templates pane, drag and drop the templates into the tiles in the Report Layout pane.

•	Select the Place on Tile button to move the template to the selected tile.

•	If you want to define a new template, select New in the List of Templates pane.

•	To browse for a folder other than the default templates, select Directory to display the Browse for Folder dialog box. Navigate to the folder where you have the templates stored and select OK.

3.	Modify the Header and Footer.

4.	Save the report layout.

Select File > Save to display the Save dialog box. Enter the report layout name and select Save.

The report layout is saved in the .rpl format.


Configure Page

You can configure the paper size, source, orientation, and margins. To configure page go to
File > Page Setup > Configure Page.

After you have configured the page setup, select OK.


Go To Page

You can go to different pages in the report layout using the Go To Page dialog box. To go to page select Edit> Go To.

1.	In the Enter Page Number field, enter the page number or select [image] to display the Virtual Keyboard.

2.	Select Go To. The Report Layout pane displays the relevant page.


Change Report Layout

You can change the report layout to fit one, two or four tests per page.

Go to Layout > One Test Per Page / Two Tests Per Page / Four Tests Per Page


Insert Pages

To insert pages:

•	Select Page> Insert Blank > Before Current Page / After Current Page to insert a new page before the current page or after the current page.

•	Select Page> Insert Copy > Before Current Page / After Current Page to insert copy of the current page. You can insert the page, before the current page or after the current page.

Note: When you insert a copy of a page before or after the current page, the layout of the current page is the same layout as the new page.


About the Report Viewer

The Report Viewer allows you to view the generated report.

Under the Generate Report tab, select Generate or View to display the Report Viewer and browse for the report that you want to generate or view.

See also

Using Report Viewer


Report Viewer Window

The Report Viewer window comprises a menu bar, a toolbar, an align/size bar, and a client area.

See also

Menus

Toolbars

Status bar


Report Viewer: Menus

The menu bar has the following menus.

File

Edit

View

Object

Help


Report Viewer: File Menu


Report Viewer Edit Menu
Report Viewer: Edit Menu

The available edit menu selections depend on whether a field is selected or not.


Report Viewer: View Menu

A ( [image]) appears next to the menu item selected.


Report Viewer: Object Menu

The available object menu selections depend on whether a field in the client area is selected or not.


Report Viewer: Help Menu


Report Viewer: Toolbars

You can choose to display or hide these toolbars using View > Toolbars. The Report Viewer has the following toolbars:

Toolbars

Align/Size Bar

Status Bar

Separators


Report Viewer: Standard Toolbar
Report Viewer: Toolbars

To view the toolbar, go to View >Toolbar.


Report Viewer: Align/Size Bar

To view the align/size bar, go to View >Align/Size Bar.


Report Viewer: Status Bar

The Status bar displays the status of the application and tool tips for the selected options.


Report Viewer: Seperators
Report Viewer: Separators

To view the separators, go to View > Separators.

Shows or hides the report separators.


Using the Report Viewer

Click on each of these links to use the Report Viewer:

To View a Report

To Edit Text

To Find Text

To Replace Text

You can select some objects and bring to front or send to back. You can show/hide text, position caption to the left, or on top. You can change font, align selected fields, or make the selected fields to same size. You can also export a report as an rtf.


Export to RTF

You can export a report generated by the Report Generator to rich text format. From the report select File > Export to RTF.

Note: Text and Images in the rtf file may not be completely visible. To make the text and images visible, select the text or image and re-size it.


Find

To search for text in a report go to Edit > Find.

1.	In the Find dialog box, enter the search string using the Virtual Keyboard.

2.	Select Find Next until you find the required search string.


Report Viewer: Replace

To search and replace text go to Edit > Replace.

1.	In the Replace dialog box, enter the search string using the Virtual Keyboard in the Find what field.

2.	In the Replace with field, using the Virtual Keyboard enter the replacement string.

3.	Select Find Next until you find the required search string.

4.	Select Replace to replace one instance of the string.

Or

5.	Select Replace All to replace all instances of the string.

6.	Select Cancel after you have replaced the strings.


Report Viewer: Change Font

To change font go to Object > Change Font.

1.	Select the fields or fields in the report.

2.	Select Object > Change Font or right-click on the field to display the options.

3.	In the Font dialog box, choose the font size, color, style, and effects.

4.	Select OK.


Report Viewer: Make Same Size

You can make two or more selected fields of the same height, width, or both go to
Object > Make Same Size. Select one field as the dominant field to which the other fields will be sized. Use the Ctrl key to select the fields.

1.	Select the fields in the report.

2.	Select Object > Make Same Size > Height, Width, or Both to make the selected fields to the same size.


Create or Edit a Test Template

To create a new test template or edit an existing template, go to
Utilities > Reports > Define Test Template.

To create a new test template:

1.	Under the Define Test Template tab, select New. The Template Editor window appears with an empty client area.

2.	Create the template using the Palette list.

3.	After you have completed creating a new test template, select Done.

See Template Editor for more information about Template Editor.

To edit an existing test template:

1.	Under the Define Test Template tab, select Browse.

2.	The open window displays the existing factory default templates and customized templates in C:\TekApplications\tdsrteye\ReportGenerator\modules\<modulename>\Templates, where "modulename" can be SerialAnalysis, InfiniBand, or PCIExpress.

3.	Select the template that you want to use.

4.	Select Open.

5.	In the Define Test Template tab, select Edit Template. The Template Editor window appears with the client area displaying the selected template.

6.	Edit the template using the Palette list.

7.	After you have completed editing an existing test template, select Done.

See Template Editor for more information about Template Editor.


Define or Edit a Report Layout

To create a new report layout or edit an existing report layout go to
Utilities > Reports > Define Report Layout.

To create a new report layout:

1.	Under the Define Report Layout tab, select New. The Report Layout Editor window appears with an empty report layout area.

2.	Create the report by defining the report layout and dragging and dropping the templates to the report layout area.

3.	After you have completed creating a new report layout, select Done.

See Report Layout Editor for more information about the Report Layout Editor.

To edit an existing report layout:

1.	Under the Define Report Layout tab, select Browse.

2.	The Open window displays the existing factory default report layout and customized report layouts in C:\TekApplications\tdsrt-eye\ReportGenerator\modules\<modulename>\Layouts, where the "modulename" can be SerialAnalysis, InfiniBand, or PCIExpress.

3.	Select the report layout that you want to use.

4.	Select Open.

5.	In the Define Report Layout tab, select Edit Layout.

6.	The Report Layout Editor window appears with the report layout area displaying the customized report layout and the selected template files.

7.	Edit the report layout using the List of Templates and defining the Report Layout.

8.	After you have completed editing an existing report layout, select Done.

See Report Layout Editor for more information about the Report Layout Editor.


Generate, Print or View a Report

To generate, print, or view a report, go to Utilities > Reports > Generate Report.

To generate a report:

1.	Under the Generate Report tab, select Browse.

2.	The Open window displays the existing reports in C:\TekApplications\tdsrt-eye\ReportGenerator\modules\<modulename>\Layouts, where "modulename" can be SerialAnalysis, InfiniBand, or PCIExpress.

3.	Select the report layout that you want to generate.

4.	Select Open.

To print a report:

1.	Under the Generate Report tab, select Browse.

2.	The Open window displays the existing reports in C:\TekApplications\tdsrt-eye\ReportGenerator\modules\<modulename>\Reports, where "modulename" can be SerialAnalysis, InfiniBand, or PCIExpress.

3.	Select the report that you want to print and select Open. The Report Viewer displays the selected report with current data from the application.

If the page settings do not match the page settings for the Report, a Page Size Mismatch message box displays a message — The current page settings do not match the page settings for the Report. Do you want to continue?

Select Yes to continue. If the printer is installed, the report is printed.

Select No to not send the report to the printer.

To view a report:

1.	Select File > Open. The Open dialog box displays all the reports in the default directory C:\TekApplications\tdsrt-eye\ReportGenerator\modules\<modulename>\Reports, where "modulename" can be SerialAnalysis, InfiniBand, or PCIExpress.

2.	Select the report that you want to view and select Open.

Note: You can also use these steps to open a report or a test template.


Report Generator Error Codes

This table lists the report generator error codes and the possible solutions.


Template Editor Window
The Template Editor Window

The Template Editor window contains a menu bar, a toolbar, a client area, a palette list, and a status bar. When you select the New Template button in your application, the Report Generator removes test templates from the client area. When you select the Edit Template button, the Report Generator displays the selected template in the client area.

In the template editor, you can select a field and right-click on it. This brings up a context menu for the field with the following items: Cut, Copy, Delete, Bring To Front, Send To Back, Hide Text, Position Caption on Top, Edit Caption, Change Font, Align Fields, and Make Same Size.

See also

Menus

Toolbars

Palette List

Status Bar


Application Directories and File Names

The <modulename> can be SerialAnalysis, InfiniBand, or PCIExpress.


File Name Extensions


Virtual Keyboard

Selecting [image] displays the Virtual Keyboard similar to the keyboard. The field on the top displays what you have selected. After you have selected the required content, select Enter.


Status bar

The Status bar displays the status of the application and tool tips for selected options.


Define Header and Footer

To modify the Header Definition, do the following:

1.	In the Report Layout pane, select Header - Click to Modify.

2.	In the Header/Footer Definition dialog box, select the header position - Header Left, Header Center, or Header Right.

3.	Enter the Header definition in the text box.

Select [image] to display the Virtual Keyboard. In the Virtual Keyboard, select the text and Enter.

Or

To insert the special text, select the Insert Special Text button to display a sub menu. Select Date, File Name, Author, Page X of Y, Page X, or Logo.

4.	Select Set Font to change the font style, size, effects, color, and script for each field separately, then select OK.

5.	In the Header/Footer Definition dialog box, select OK.

To modify Footer Definition, do the following:

1.	In the Report Layout pane, select Footer - Click to Modify.

2.	In the Header/Footer Definition dialog box, select the footer position - Footer Left, Footer Center, or Footer Right.

3.	Enter the Footer definition in the text box.
Select [image] to display the Virtual Keyboard. In the Virtual Keyboard, select the text and select Enter.
Or
To insert the special text, select the Insert Special Text button to display a sub menu. Select Date, File Name, Author, Page X of Y, Page X, or Logo.

4.	Select Set Font to change the font style, size, effects, color, and script for each field separately, then select OK.

5.	In the Header/Footer Definition dialog box, select OK.


To View a Report

To display the selected report:

1.	Select File > Open. The Open dialog box displays all the reports in the default directory - C:\TekApplications\tdsrt-eye\ReportGenerator\modules\<modulename>\Reports, where "modulename" can be SerialAnalysis, InfiniBand, or PCIExpress.

2.	Select the report that you want to view and select Open.


To Edit Text

Select Edit > Add Text Field. The Edit Text dialog box appears.

1.	In the Text field, enter the text or select to display the Virtual Keyboard.

2.	In the Virtual Keyboard, enter the text and select Enter.

3.	In the Edit Text dialog box, select OK.


To Find text

Select Edit > Find. The Find dialog box appears.

1.	In the Find what field, enter the text or select to display the Virtual Keyboard.

2.	In the Virtual Keyboard, enter the text and select Enter.

3.	In the Find dialog box, select Find Next until you find that text that you are searching for.


To Replace text

You can search and replace the text in the test template.

1.	Select Edit > Replace.

2.	In the Replace dialog box, enter the search string using the Virtual Keyboard in the Find what field.

3.	In the Replace with field, using the Virtual Keyboard enter the replacement string.

4.	Select Find Next until you find the required search string.

5.	Select Replace to replace one instance of the string.

Or

Select Replace All to replace all instances of the string.

6.	Click Cancel after you have replaced the strings.


Copyright and Version Information

Copyright © Tektronix, Inc. All rights reserved. Licensed software products are owned by Tektronix or its suppliers and are protected by United States copyright laws and international treaty provisions.

Use, duplication or disclosure by the Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013, or subparagraphs (c)(1) and (2) of the Commercial Computer Software - Restricted Rights clause at FAR 52.227-19, as applicable.

Tektronix products are covered by U.S. and foreign patents, issued and pending. Information in this documentation supercedes that in all previously published material. Specifications and price change privileges reserved.

Tektronix, Inc. P.O. Box 500, Beaverton, OR 97077

TEKTRONIX, TEK, and TEKPROBE are registered trademarks of Tektronix, Inc.

MATLAB is a trademark of The MathWorks, Inc

Report Generator Online Help Version 1.06.001


View a Report

To display the selected report:

1.	Select File > Open. The Open dialog box displays all the reports in the default directory -C:\TekApplications\tdsrt-eye\ReportGenerator\modules\<modulename>Reports, where "modulename" can be SerialAnalysis, InfiniBand, or PCIExpress.

2.	Select the report that you want to view and select Open.


Bring to Front
Bring to Front : You can bring the selected fields to the front. To bring to front go to Object > Bring To Front.


Send to Back
Send to Back: You can send the selected fields to the back. To send to back go to Object > Send To Back.


Show/Hide Text
Show/Hide Text: You can show or hide the captions for the selected fields. Select
Object > Show/Hide Text.


Position Caption
Position Caption You can position the caption of the selected fields on either the left or on the top. To position caption go to Object > Position Caption to the Left, or on Top.


Align Fields

You can align the fields to top, bottom, left, or right. To align fields, go to Object > Align Fields.

1. Select the fields in the test template.

2. Select Object > Align Fields > Top, Bottom, Left, or Right to align the fields accordingly.


Make Same Size

You can make two or more selected fields of the same height, width, or both go to Object > Make Same Size. Select one field as the dominant field to which the other fields will be sized. Use the Ctrl key to select the fields.

1. You can set the selected fields to same height, width, or both.

2. Select the fields in the test template.

3. Select Object > Make Same Size > Height, Width, or Both to make the selected fields the same size.


Export to RTF

To export a file to rtf format, go to File> Export to RTF.

You can export a report as a .rtf (rich text format) file.


View a Report

To display the selected report:

1. Select File> Open. The Open dialog box displays all the reports in the default directory -C:\TekApplications\tdsrt-eye\ReportGenerator\modules\<modulename>Reports, where "modulename" can be SerialAnalysis, InfiniBand, or PCIExpress.

2. Select the report that you want to view and select Open.


Edit Text

Select Edit > Add Text Field. The Edit Text dialog box appears.

1. In the Text field, enter the text or select to display the Virtual Keyboard.

2. In the Virtual Keyboard, enter the text and select Enter.

3. In the Edit Text dialog box, select OK.


Find Text

Select Edit > Find. The Find dialog box appears.

1. In the Find what field, enter the text or select to display the Virtual Keyboard.

2. In the Virtual Keyboard, enter the text and select Enter.

3. In the Find dialog box, select Find Next until you find that text that you are searching for.


Replace Text

In the Replace dialog box,

1. Select Find Next to find the text that you are searching for.

2. Select Replace to replace one instance of the text that you want to replace.

3. Select Replace All to replace all instances of the text that you want to replace.

4. Select Cancel to cancel the operation and close the dialog


Steps to set up the Report Generator


Definitions of the User Interface Items


Report Layout Editor: Adding a Template

Using the Report Layout Editor, you can add a template to an existing report. Follow these steps to add a template to the report:

1.	Open a new layout using Define Report Layout.

2.	Select File > Open and browse for generated reports. The report is displayed in the Report Layout pane.

3.	From the standard toolbar, select Insert New Page before Current Page or Insert New Page after Current Page.

4.	From the List of Templates pane, select the template that you want to add to the current page layout. Drag and drop the template file on to the report or use Place on Tile to add the template.

5.	Add test titles for this layout.

6.	Select File > Save to save the modified report as a .rpl or .rpt file.

7.	Generate a report for the unfilled template from the .rpl or .rpt file using Generate Report.