Create a new report configuration object - 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)

A report configuration object generates basic and inverted CSV files using view definitions and graph definitions, respectively.

Main details

  1. Click File > New > Exchange Data > Report Configuration.

  2. In the New Report Configuration dialog box, type a name and description for the report configuration.

Report configuration details

  1. Specify a shared location to save the generated CSV files and control files in the Export directory path text box.

  2. To create a basic CSV file, click Find beside the View definition box, and select the view definition to use to collect data about the object.

  3. To create an inverted CSV file, click Find beside the Graph definitions for inverted csv box, and select the graph definition to use to collect data about the object.

  4. Select an export details object from the Export details for control file generation list.

  5. Select a revision state from the Filter revisions list to export the required revisions of a document to your CSV file.

  6. Select the Export in background check box if you want a Scheduler task for generating the CSV files to run in the background.

    • A notification is generated and displayed in the List of Notifications if the Scheduler task is successful.

    • You can select this option to export large data sets.

    The Scheduler task is deleted automatically if it is processed successfully.

  7. Select the Export UIDs for Inverted CSV check box to export the UIDs of the objects.

  8. Select the Export named objects for inverted CSV check box to export only those objects that have the Name property specified in the CSV file.

  9. Select the Export object classification name for INV CSV check box to export the primary classification name of the object, if available, into the inverted CSV.

  10. Select the Is CSV repeated check box if your CSV must be generated in repeated rows.

  11. Select the Do not download attached files check box if you don’t want to export the physical files. Only the file metadata will be exported.

    When should I select the Do Not Upload Attached Files check box?

    You can select the Do not upload Attached Files check box when you are planning to export or migrate files in bulk from the source system to the target system and manually copy the files from the source system vault into the target system vault.

    In the import definition, ensure that the SPFLocalFileName and SPFRemoteFileName properties for the file object is mapped with the Create/Update action. For more information on creating import definitions, see Create an import definition.

  12. Select the Export CDW objects check box if you want to selectively export CDW objects to the target system. For more information on selective export of CDW objects, see Exchanging published documents.

    The Export CDW objects check box must be selected to ensure that the delete instructions for the exported CDW objects are exported correctly.

CSV report settings

  1. Specify a delimiter in the UOM value delimiter text box to separate the UoM values in the report.

  2. Select a date and time format for the report from the DateTime format list. The default format is dd-MM-yyyy.

  3. Select a character encoding format for the report from the Character encoding list. The default format is ISO-8859-15.

  4. To extract the enum or UoM values into the report, select the output format of the enums from the Output Enums by list . The default format is Display Name.

  5. Select the Split UOM for basic CSV check box to display the value and the UoM in separate columns in the report.

Optional Report Configuration

  • Select the Is published data check box if you are exporting published documents.

  • IObject properties other than Name and Description will not be exported in an inverted CSV file.

  • Generation of inverted CSV files for documents is not supported. However, you can generate inverted CSV files for any relationship between documents and other objects.

  • You can control the document revisions by selecting the required revision state from the Filter revisions list. However, if you have already configured your graph definition to expand edge definitions to collect the specific revisions, you need not use the Filter revisions option.

    For example, if your graph definition is configured to expand issued revisions of documents only, but you select the Working revision in the Filter revisions list, then the generated CSV will not contain any revisions. We recommend selecting revision states from the Filter revisions list only if your graph definition is not configured to collect the required revisions of your documents.

  • If you are exporting published documents, you must also select an export details object from the Export details for control file generation list, as it contains the details of the target system to which you are exporting the published documents. Also, the document version is related to the export details object. When different versions of a document are exported successively, the tombstone files from all the versions are merged, and the merged tombstone file containing the consolidation instructions is exported with the published document.

  • If you are exporting a document published for a specific tool for the first time, the SPFOriginatorGUID property will be instantiated on the ISPFTEFSignature interface with a unique UID. This property is used to uniquely identify the tool signature of the authoring tool on the target system.

  • For enums or UOM values, the option selected in the Export CFIHOS format list overrides the option selected in the Output Enums by list. For example, if you select the By CFIHOS Name option from the Export CFIHOS format list, and you also select any option from the Output Enums by list, the enums or UoM values will be extracted based on the CFIHOS name.