Create a visual intelligence 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

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 document master containing the tags.

For instructions, see Create a Graph Definition.

What does a GraphDef look like?

Here is an example of a graph definition for the Tags by Change Request Name visual intelligence report:

  <DirectedGraphDef>

    <IObject UID="DGD_VIR_FDWTagsAndChangeRequests" Name="Visual Intelligence Reports Tags and Change Requests"  />

    <IDirectedGraphDef GraphDefn="+IFDWTaggedItem/+IFDWTaggedItem/,SDAChangeRequestTags_21/ChangeRequests/+IFDWTaggedItem,FDWDrawingRepresentationFDWTag_21/FDWDrawingRepresentation/+IFDWTaggedItem,FDWDocumentRevisionDrawingRepresentation_21/TagDocumentRev/FDWDrawingRepresentation,SPFDocumentRevisions_21/TagDocMaster/TagDocumentRev" />

    <ISchemaObj />

  </DirectedGraphDef>

Here is an example of a graph definition for Pipelines by Fluid Requirement visual intelligence report:

<DirectedGraphDef>

    <IObject UID="DGD_VIR_SIO_Pipeline" Name="Visual Intelligence Reports Pipeline" Description="Visual Intelligence Reports Pipeline" />

    <IDirectedGraphDef GraphDefn="+IPipeline/+IPipeline/,PipelineRuns_12/PipeRun/+IPipeline,PipeRunItems_12/PipeRunItem/PipeRun" />

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

</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 document master.

  • This property must be named DocID.

  • If you are streaming the graphic data to SDx for 3D Project As-Built databases, then the DocID property is not required.

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?

Here is an example of a view definition for the Tags by Change Request Name visual intelligence report:

  <ViewDef>

    <IObject UID="VD_VIR_FDWTagsAndChangeRequests" Name="Visual Intelligence Reports Tags and Change Requests" Description="Visual Intelligence Reports Tags and Change Requests" />

    <ISchemaObj DisplayName="Visual Intelligence Reports Tags and Change Requests" />

    <IViewDef ViewPropsDefn="+IFDWTaggedItem/IObject/Name/Name/Identification/1,TagDocumentRev/IObject/UID/DocRevID/Data/2,TagDocMaster/IObject/UID/DocID/Data/3 ,ChangeRequests/IObject/Name/Change Request Name/4,ChangeRequests/ISDAChangeRequest/SDAChngReqPriority/Change Request Priority/5,ChangeRequests/ISDAChangeRequest/SDAChngReqStatus/Change Request Status/6,FDWDrawingRepresentation/IFDWDrawingRepresentation/FDWGraphicOID/GOID/Data/7,+IFDWTaggedItem/IObject/Description/Description/Data/8" GraphDefnUID="DGD_VIR_FDWTagsAndChangeRequests" LastLocalID="8" />

  </ViewDef>

Here is an example of a view definition for the Pipelines by Fluid Requirement visual intelligence report:

  <ViewDef>

    <IObject UID="VD_VIR_SIO_Pipeline" Name="Visual Intelligence Reports Pipeline" Description="Visual Intelligence Reports Pipeline" />

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

    <IViewDef ViewPropsDefn="+IPipeline/IObject/Name/Name/Identification/1,+IPipeline/IPipelineSystem/PipelineFluidCode/PipelineFluidCode/Data/2,+IPipeline/IPipelineSystem/PipelineFluidSystem/PipelineFluidSystem/Data/3,PipeRunItem/IGraphics3D/Graphics3DGUID/GOID/Data/4" GraphDefnUID="DGD_VIR_SIO_Pipeline" LastLocalID="4" />

  </ViewDef>

How can I include tag descriptions in the visual intelligence report?

If the visual intelligence report definition includes the Description property and the view definition (ViewDef) has a Description property, the tag description is included. For more information on including the Description property in your visual intelligence report, see Create a report definition. Select this report definition to create an ad-hoc report using the Desktop Client. This is your visual intelligence report.

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. If you are streaming the graphic data to SDx for 3D Project As-Built databases, then the DocID property is not required.

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 look like?

Here is a report definition for the Tags by Change Request Name visual intelligence report:

SDx Report definition for “Tags by Change Request Name” VIR as shown in the Desktop Client

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

SDx Report definition for “Pipelines by Fluid Requirement” VIR as shown in the Desktop Client