Create a new report - 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
  1. Click File > New > Report.

  2. Select a report type from the list, and click OK.

  3. Select the check boxes for the properties that you want to include in the report.

  4. Select the type of report output style from the Report output style list.

    • You can send the report output to a list view, to a file in Excel, Word, ASCII, Excel Register, and other formats, or to a custom reporting application if your system administrator has set up such a configuration.

    • If you specify Excel or Excel Register as the destination file type, you can use an existing Excel file as a template to format the report. You can also define your own Excel file templates.

      For more information about the report output styles, see Learn more about reporting output styles.

    • If you specify ASCII as the output format, provide a delimiter in the Delimiter box. The default value is a colon (:). There is no specific template for ASCII.

    • If you are running this report on a shared object, select Display latest values only to display only the most recently published values for the shared object. The report highlights values that are inconsistent with values published from other tools. If you do not select this option, the report shows all the different published values as a comma-separated list.

    • If you select the Context object required option, the report can be run only from a contextual object, such as a method configured on the Actions menu. If you set this option, the report will not appear in the Reports feature set in the Web Client.

    • If you select the option Include intermediate nodes, all the intermediate nodes in an expansion are included from the top down. This includes the parent nodes even when any child items are missing or are excluded from the report criteria.

    • If you select the Terminated workflows report option, the report extracts information on terminated workflows for a set of objects. Selecting this option displays the Starting Objects Criteria for Terminated Workflows Reports column in the Report details section of the form. You must select the Related Items for which you want the terminated workflows report and set the criteria accordingly.

    • If you select the Ignore Config option, the report extracts information for one or more selected objects from multiple configurations (plants or projects) and displays the result in a single file. When this option is selected, the report extracts information from the multiple configurations, irrespective of access permissions. You must select the CSV or CSV Repeated report output style to enable this option.

    • Use the Excel (OpenXML) output style if you are outputting a large number of items into your Excel report. Select the ExcelOpenXML Template from the template list. The Excel (OpenXML) output style is only compatible with Microsoft Excel version 2010 and newer.

    • Use the CSV output style to output tabular data in a plain text form. A CSV report has records separated by a character or string, most commonly using a comma or tab. A settings option lets you select the CSV report format to include properties or UoM value delimiters, date, time, and encoder formats.

    • Use CSV Repeated output style to output tabular data that supports multiple related fields. If you have multiple relationships between two objects, each relationship will be on a separate row. For example, if a tag has two disciplines and you use CSV Repeated output style, the tag will have two rows, one for each discipline. Using the existing CSV format only produces one line for the tag with both disciplines comma separated.

  5. Set the sort and search options for each property, as necessary.

    • You can set the report to sort properties in ascending or descending order. You can also set a value for each property by right-clicking or clicking the Sort Order column so that properties are sorted in the order you have defined:

      • By right-clicking the column, the greatest value incremented by one is assigned to the property.

      • By clicking the column, the greatest value incremented by one is assigned to the property, meanwhile a spin box is shown, allowing you to change the value.

    • You can define search criteria for each property by selecting Criteria. For more information about setting criteria to filter report results, see Define filter criteria for an Adhoc report.

    • You can allow users to specify search criteria for a row each time the report is run by setting the Prompt option to True. You cannot define criteria for a report and set the report to prompt the user for a value. These two features are mutually exclusive.

  6. For a quick view of the report, click Apply. You can view the report and return to the dialog box to make changes.

  7. To run the report and exit the report definition, click OK on the Edit Report Definition dialog box.

  • Reports run with the Include Intermediate Nodes option enabled typically perform better. Where the additional rows in the report output are not wanted, it may be possible in some cases to post-process the output to remove them.

  • When creating a graph definition, consider if an edge definition expansion would be more efficient than a relationship definition expansion. Discrimination criteria added to an edge definition (in the form of an appropriate property comparison or valid end interface) may yield a smaller result set and create more efficient queries that do not query unnecessary database tables.

    If a graph definition is used for a document report, which has an expansion from Files to its attached object, an edge definition expansion is more efficient than a SPFFileComposition relationship expansion. This is because the edge definition expansion only considers documents and automatically excludes other object types, such as technical queries or submittals, and so on. For example:

    <EdgeDef>
      <IObject UID="EDG_TestVersion" Name="TestVersion" />
      <IPositionCriteria />
      <IEdgeDef StartInterfaceName="ISPFBusinessFile" PathDefn="+SPFFileComposition" ValidEndInterfaceDefUIDs="IFDWDocumentVersion" />
      <ISimpleCriteria PropComparisons="" />
      <ISPFEdgeDefExt />
      <IEdgeDef2 />
      <ISchemaObj />
    </EdgeDef>