Report styles configuration - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

The format, or layout, of a report is fully customizable. The layout definitions can be saved to create custom reports that can be reused.

Report output styles and templates 

An ad hoc report can be output in the following styles:

Output style

Template requirement

New Window

No template required

Excel

Template optional

Excel Extended

Template optional

Word

No template required

HTML

No template required

Custom Report

The Custom Report option allows you to send report data to a custom reporting application. (This option must be set up to use, for example, Crystal reports or Adobe Acrobat.)

XHTML

XSL template required

XHTML (Excel)

XHTML (Word)

Excel Repeated

Template optional

Excel (OpenXML)

Template required

CSV

No template required

CSV Repeated

No template required

Excel reports

If no Excel template has been specified by the user, the output format will be tabular and identical to the output style of the HTML report, except that the asp.net page used to display the results sets the MIME type to application/vnd.ms-excel instead of text/html. This has the effect of making the browser convert the normal HTML into Excel.

If a template has been specified for this output type, then the action of the server is different. It begins by running the report as with other output types, but then the template specified is downloaded from the SmartPlant Foundation File Service and populated on the Desktop Client.

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

Run Excel macro from report

When an Excel template is downloaded from the SmartPlant Foundation File Service, the Desktop Client attempts to run a macro if one is specified in the template.

The macro must be called Initialize_It, and if present, the desktop client code will execute the method after populating the Excel worksheet.

The Excel macro must reside in a VBA module or it will not run.

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.

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.

Word reports

The Word output type layout is similar to the Excel and HTML types, with the exception that it is in Microsoft Word format, and can be saved out as such. The mechanism of creating a Word document from the normal HTML output is identical to that of the Excel mechanism (when used without a template). In this instance, the MIME type of the Results web page is set to application/msword.

HTML reports

The HTML report layout is hard-coded into the server reporting code.

To customize the report layout for web page layout, use the XHTML output type.

When you run a report that specifies the HTML output type, you are presented with a new browser window showing the results. This result set HTML is compiled on the server at the point of the SPFReportResults.aspx page being loaded.

List View

The List View (shown as New window on the Configure Report dialog box) is the normal output format for a SmartPlant Foundation query. The Configure Report dialog box can 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.

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. This report style should be used in conjunction with the appropriate XSL template.

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.

  • The Excel (OpenXML) output style supports.xlt, .xltm, and .xlsm formats.

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.

If the CSV report is an input for Data Validator processes, we also recommend using the Name or UID format to extract enums or UoM values.

The 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 create a report that has a tag with two discipline codes, the result is a CSV file with two rows. We recommend you use this output style to output data that uses multiple related fields for import into Data Validator.

If the CSV report is an input for Data Validator processes, we also recommend using the Name or UID format to extract enums or UoM values.