Flexible Report Templates

Add or overlay predefined page sets to the current session.

A report is used to automate the generation and presentation of standard animations, plots and tables. The content and layout of a report is defined by a report definition. A report definition specifies how to post-process result information for a particular test or analysis data file. Report definitions typically consist of a series of pages containing HyperView, HyperGraph and TextView windows.

Flexible report templates allows you to easily compare test and simulation data. Channel Mapping is available, which allows you to reconcile mismatched channels (Type, Request and Component data). You can save the reconnected channels to a configuration file and use this file later. From the dialog, you can directly edit parameter attributes for parameters created with the Parameters Browser.

To access the dialog, go to File > Session > Flexible Reports.

Parameter: The Parameter list displays the parameters included in the currently selected report template.
Current Parameter Value: This column lists the value of the corresponding parameter in the Parameter column. You can select the parameter to edit it directly.; The checkbox next to the plot file parameter indicates whether or not HyperWorks uses the file. When deactivated, HyperWorks will not generate curves from those unchecked files. Any curve referencing these curves will also not be generated.
Default Parameter Value: This columns lists the default values for each parameter listed in the dialog. It is a non-editable field. By default, this column is hidden. Press the arrow, , to display the column.

Click Apply to append, replace, or overlay new pages. When using Overlay and Replace in situations where multiple applications of the same report exist, the program asks you to select the correct report to overlay or replace.

Add a Report Template

Go to File > Session > Flexible Reports.
From the Flexible Report Templates dialog, click Add.
Use the File Browser to select the report template (.tpl file).
The dialog is populated with the file's information.

Delete a Report Template

Go to File > Session > Flexible Reports.
From the Flexible Report Templates dialog, under the Report Templates column, select the template to delete.
Click Delete.
The file and its content is removed from the dialog.

Use Autofill Directory

Fills the Current Parameter Value field(s) with parameter information that is based on information from the selected field.

Go to File > Session > Flexible Reports.
From the Flexible Report Templates dialog, click Add to add a report template.
The Parameter column lists the template's data files. The Current Parameter Value column displays the filenames used in the session.
Click Apply to plot the data.
Click PLOT_FILE_1 to activate the parameter.
Click the file folder icon to select a new file.
To autofill the remaining files in the Reports panel, right-click the file path next to PLOT_FILE_1 and select Autofill directory.
By selecting Autofill directory, the other files needed for the report template are updated to use the files in the selected directory.

Figure 2.

Channel Mapping

Use Channel Mapping to add flexibility to HyperGraph by reconciling reports with mismatched channels.

After loading a report template and selecting it from the Report Templates list, click Check Plot Channels to display the Channel Mapping dialog. HyperGraph checks the data types, requests, and components between the files and displays the matched and unmatched channels in the dialog. All channels referring to a file can be skipped, and you can check and reconnect their types, requests and components in case there is a mismatch. If there is an unmatched channel and you select a component from one of the drop-down menus (Data Type, Request or Component) to correct it, HyperGraph automatically fixes the other mismatched components. Mismatched channels are displayed with a red

next to them. A green check mark,

, indicates a match.

Filtering and Sorting Data Lists

The Channel Mapping dialog contains filtering and sorting functionality to facilitate matching the data type, request, and component channels, along with other display and filtering options related to the lists that are displayed in the Data Type, Request, and Component fields. You can filter the Data Type and Request column data with strings (wild card support is not available).

Display Channels: Select All to display all channels.; Select Matched to only display the matched channels.; Select Unmatched to only display the unmatched channels.

The following options are available in the filter area at the top of the Channel Mapping dialog.

Select Best Match: Inserts the best matches into the selected fields, according to the matching algorithm. The results are sorted using a string match to the shortest distance. The icon to the right of the field changes from this, , to a yellow star, , upon selecting this option.
Confirm: Click Confirm to approve the current best match selections. The icon displayed in the the selected fields is updated from this, , to this, .; If you do not confirm the best match results, and you exit out of the Channel Mapping dialog and return to it later, the best match results will no longer be sorted and displayed. You will have to redo this operation.
Reset: Resets the fields to the default, or previous, selections. The and icons return to the .
Auto-connect similar channels: This option is on by default. If you want to manually correct one or more channels without similar channels updating automatically, deselect the Auto-connect similar channels option.
Note: If you reselect Auto-connect similar channels before saving your selections to a config file, and you attempt to a match a channel, all similar channels will be mapped, and your previous manually selections are overridden.

Some options described above are also be available via a context menu if you right-click while one or more fields are selected from the dialog, as shown below. You can select only some of the channels listed and choose Select Best Match from the context menu to sort the currently selected channels. Click Confirm to approve the results.

Note: If the buttons at the top of the dialog are used, the actions are applied to all channels; if the context menu is used, the actions are only applied to the selected channels.

Once the channel mappings are resolved, click Save Config File to save the reconnected channels to configuration file which can be used for future mappings.

Click the File Browser icon in the Open Config File field to load a previously saved configuration file to correct any unmatched channels. Once loaded, click Apply on the main panel to plot your results.

Sorting Node IDs

You can also sort a large number of node IDs in the Channel Mapping dialog.

Whether you are sorting the entire table or only a certain number of selecting items using the context menu, Select Best Match sorts the entire list, and displays the lists beginning with the closest match. Click Confirm to display the sorted list of node IDs in the drop-down menu.

Note: When you choose Select Best Match, the sorted list is always displayed in the drop-down list. If you do not click Confirm to approve the best match, or if you click Reset, the original list is displayed.

Modes

Each time a report definition is loaded, you can overlay, append, or replace the pages of the new report.

Overlay Mode

Overlay mode combines report animations and plots for comparison in the session. Report definitions with different names can be overlaid if they have the same layout, which means the same number of pages, where each page has the same page layout and the same number of clients per window. If the report layout does not match, the report is added to the end of the session.

If Overlay is selected with HyperView or TextView windows, the existing window is overwritten.

When plots are overlaid, the axis of the existing plot is rescaled to match the overlaid plot and the curve colors assigned in the report definitions are retained. The axis of the existing plot can be preserved and new colors can be assigned to same-color curves using the following overlay options:

Autofit X Axis/Autofix Y Axis: Locks the x or y axis of the current plot so that it does not change as new plots are overlaid.
Auto place notes: Automatically fits any notes you add to the window.
Use report colors: When selected, line colors, line styles, symbol colors, and symbol styles are applied based on the report template. When the Use report colors checkbox is not selected, curve lines and symbols are colored based on the default colors specified in the preferences file. In both cases, the report template controls the display of curve lines and symbols.

Append Mode

Adds a report to the end of the current report.

Replace Mode

Replaces an existing report with a new report. Report definition names must match. If report definition names do not match, the report is added to the end of the session.

Note: When replacing and overlaying reports, matching report definitions must be used. If a page has been removed from a report during a session, the data for that page is ignored when replacing or overlaying.

Layers

Turn on/off the display of the various layers (all layers included in each individual report template are affected).

From the Flexible Report Templates dialog, click Layers to display the Layers dialog.

Note: Cells created by overlaying reports in TableView will not belong to a layer and therefore cannot be turned on/off via the Layers dialog.

Refresh: If you delete a curve or make other changes within the Flexible Report Templates dialog, such as adding another layer, click Refresh to reflect those changes inside the Layers dialog.
Rename: From the Layers dialog context menu, click Rename to rename the selected layer.
Delete: From the Layers dialog context menu, click Delete to delete the selected layer.
Note: Curves associated with the layer will be deleted in HyperGraph; models in HyperView or cells in TableView will not be deleted.

If you overlay two report templates, you will lose all the "saved" parameters.

By creating multiple report definitions, you can quickly post-process result information from various test and analysis sources. Report definitions can be interactively added to a session by adding separate report definition files. Report definitions can be placed directly in a session file or registered in your preference file so they are automatically loaded at startup. Report definitions added from the preferences file are not saved to the session file.

HyperView Multiple Result Files Use Cases

Report templates can be used for single model+multiple result files use cases as follows:

The model file and result files are saved as Parameters in the template with a special syntax used for the Result files.

The parameter name for the Result file is as follows:

RESULT_FILE_<PAGE#>_<WINDOW#>_<MODEL#>_<FILE#>.

Note: This naming scheme is implemented only for the single model+multiple result files scenario. In the case of a single model+single result file, the result file name remains as RESULT_FILE_<FILE#>.

The benefit of this new naming scheme is that it allows you to properly identify the results files belonging to a particular page/window/model. You can then choose to replace only that specific set of files without affecting other files.

To select and replace a particular result file, there are two options:

You can select a particular file parameter and replace it with a different file.

Figure 9.
You can select several or all result files and replace them with a different set of files. This can be done by clicking on the Add Multiple Result files icon in the Flexible Report Templates dialog. The Result File List dialog is opened which lists all the result files (RESULT_FILE_) in the report template.

Figure 10.

Through this dialog, you can select all the files or a subset of files, click on the Open icon and pick a different set of files to replace.

Note:

If the number of files picked to replace (M) is greater than the selected (N) files, then any extra files are ignored. On the other hand, if the number of files picked (M) is fewer than the selected (N) files, then only the first M files will be replaced.
Files picked for replacement are always sorted in alphabetical order before replacing. Currently, it is not possible to select files in a particular order and replace existing files. This limitation will be addressed in a future version.