Create a visual intelligence report - SmartPlant Foundation - IM Update 48 - 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)

Log on to the Desktop Client as an administrator, and then perform the following steps to create your custom visual intelligence report:

1. Create a directed graph definition (GraphDef) using the SmartPlant Report Administration module.

You must create a directed GraphDef using the types of tags you want to include in the visual intelligence report. The following must be included:

Nodes

Description

Starting node

This node should be the interface definition of the tags you want to include. For example, use IPipelineSystem to report on pipelines.

Representation objects

This node is for the representation objects related to the tags.

Document master

This node is for the tool document master containing the tags.

For instructions, see Create a Graph Definition.

What does a directed GraphDef look like?

 <DirectedGraphDef>

<IObject UID="DGD_VIR_Pipeline_System" Name="Visual Intelligence Reports Pipeline System" ContainerID="DW.General_Schema" />

<IDirectedGraphDef GraphDefn="+IPipelineSystem/+IPipelineSystem/,PipingConnectors_21/PipeRun/+IPipelineSystem,OwnsPartOcc_12/PipeRunPart/PipeRun,DrawingItems_21/PartRepresentation/PipeRunPart,DwgRepresentationComposition_21/PipelineDocument/PartRepresentation" />

<ISchemaObj />

</DirectedGraphDef>

2. Create a view definition (ViewDef) based on the directed GraphDef you created in the first step.

You must create a ViewDef based on the directed GraphDef. The following properties must be included:

Properties

Description

DocID

A property representing the UID of the tool document master.

This property must be named DocID.

GOID

A property representing the Graphic ID of the representation objects.

This property must be named GOID.

Group by property

One or more properties you want to filter or group by. For example, use FluidCode to filter pipelines by fluid code.

SHARED Tip If you want sort by tag name, you must include a property representing tag names. This property must be named Name.

For instructions, see Create a View Definition.

What does a ViewDef look like?

<ViewDef>

<IObject UID="VD_VIR_Pipeline_System" Name="Visual Intelligence Reports Pipeline System" Description="Visual Intelligence Reports Pipeline System" ContainerID="DW.General_Schema" />

<ISchemaObj DisplayName="Visual Intelligence Reports Pipeline System" >

<IViewDef ViewPropsDefn="+IPipelineSystem/IObject/Name/Name/Identification/1,PipelineDocument/IObject/UID/DocID/Data/2,+IPipelineSystem/IFluidSystem/FluidCode/FluidCode/3,+IPipelineSystem/IFluidSystem/FluidSystem/FluidSystem/4,PartRepresentation/IDrawingRepresentation/GraphicOID/GOID/Data/5" GraphDefnUID="DGD_VIR_Pipeline_System" LastLocalID="5" />

</ViewDef>

3. Create one or more ad hoc reports based on the view definition you created in step 2.

You must create an ad hoc report based on the ViewDef. The following properties must be included:

Properties

Description

Set the Report output style to ...

New Window

Select these properties:

  • Filtering property, such as Document Revision or FluidCode

  • Name

  • GOID

  • DocID

You must set the Prompt value of the DocID property to True.

To group the report by a filtering property ...

Set the Set Order on the property to 1

To sort the report by each group ...

Set the Set Order on the property you want to sort each group by to 2

For instructions, see Adhoc reports.

What does the report definition XML look like?

Here is a report definition for the Pipelines by Fluid Requirement visual intelligence report:

SPF Report definition for “Pipelines by Fluid Requirement” VIR