Learn more about reporting output styles - HxGN SDx - Update 63 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

This functionality was modified in an update. For more information, see Learn more about reporting output styles (modified in an update).

List view

The list view style, or new window format, is the normal output format for a query, and is most useful where the results of the query are more of an emphasis than the format. The Configure Report dialog box can still be used to order the columns in the list view, set criteria on the data to be returned, and define the order of the result set. The list view window appears as another window within the Desktop Client.

Excel report styles

The Excel report styles (Excel, Excel Extended, and Excel Repeated) support .xls, .xlsx, and .xlsm file types.

Excel

The report results are displayed as a Microsoft Excel spreadsheet, and can be saved out as such.

The following example shows the results of the output from running a Method Access report.

SPF DTC Excel Example Graphic

Excel Extended

The Excel Extended style provides a more detailed report format than the Excel style. In this reporting output style, the relationships to the first object are all listed on separate rows.

The output from running a Method Access report is shown below. Displaying the two Access Groups in different rows makes the separate relationships between Method and Access Group much clearer.

SPF DTC ExcelExtended Example Graphic

Excel Repeated

The Excel Repeated style displays the output in a more condensed format than the other Excel output modes. In the Excel Repeated mode, if an object has a one-to-one relationship to a second object, the two objects will be displayed in the same row in the spreadsheet. The second object will be displayed as a property of the first object. If the relationship between the two objects is one-to-many, the relationship will be on a separate row. Properties on relationships are also listed on the same row.

In the example below, the method name, the Client API, and the Access Group are all listed on the same row. The relationship between the method and the Client API is one-to-one, so they are on the same row. The relationships between the method and the Access Group are one-to-many, so they are on separate rows.

Depending on the quantity of one-to-one relationships, this report output mode can result in a much smaller Microsoft Excel spreadsheet than the other Excel report output modes.

Word

Results are displayed in Microsoft Word format and can be saved out as a Microsoft Word document.

HTML

The results are displayed in a new default web browser window.

The layout for the report is hard-coded into the server reporting code. Users wishing to customize the layout for web-style reporting should consider using the XHTML output type.

XHTML

The XHTML output type is the result of an XSL transformation of an XML Document and is a means of converting XML data into a more usable format.

The XSL Transformation is achieved by the combining of two XML-style documents to produce an HTML page.

XSL can host scripting languages, such as JavaScript and VBScript, and has its own built-in query language called Xpath.

XHTML (Word)

Results are displayed in XHTML format and output into a Microsoft Word document.

XHTML (Excel)

Results are displayed in XHTML format and output into a Microsoft Excel spreadsheet.

Custom Report

You can send the report results to a custom reporting application if your system administrator has set up such a configuration.

Excel (OpenXML)

Results are generated into a Microsoft Excel spreadsheet using OpenXML SDK format. This is a more efficient method for dealing with large amounts of data. We recommend you use this output style if you need to output a large number of objects into your report.

The Excel (OpenXML) output style is only compatible with Microsoft Excel version 2010 and newer.

CSV (Comma separated value)

Results are generated as tabular data in plain text using a CSV format. This is an efficient method for returning records separated by a character or string, such as a comma or tab. We recommend this output style for importing data into Data Validator.

A separate dialog box, CSV Report Settings dialog box, lets you configure the CSV report format to include different settings like properties delimiter, UoM value delimiter, date, time, encoder formats, and so on.

CSV Repeated

CSV Repeated mode is the same as CSV mode, but has support for multiple related fields. If there are multiple relationships between two objects, each relationship will be on a separate row. For example, if you create a method that uses CSV Repeated output style and you have tag that has two discipline codes, when you output the data this will result in a CSV file with two rows. We recommend that you use this output style to output data that uses multiple related fields for import into Data Validator.

Tag number

Discipline

TAG_123456

Mechanical

TAG_123456

Electrical