Line list document methods - 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)

There are two stages to creating a line list record document:

  • Create a document from line list

  • Create list snapshot from the document

Create document method

Name: CreateSPFLLALineListRecordDocument

Client API: CreateClassObjAndRelWithPropertyOverrides

Arguments:

  • SPFArgument1="SPFLineListRecordDocumentClassClassDef"

  • SPFArgument2="False"

  • SPFArgument3="DC_Line_List_1"

  • SPFArgument4="+SPFLLALineListLineRecordDocument"

  • SPFArgument5=""

  • SPFArgument6=""

  • SPFArgument7=""

  • SPFArgument8=""

  • SPFArgument9=""

  • SPFArgument10="ISPFListEditControl.SPFPathDefnToRelatedItems.EDG_SPFLLALineListDocumentLineListRecord~ISPFListEditControl.SPFColSetToDisplayRelatedItems.SPFLLARecordsColumnSet~ISPFAuthPublishableDocumentRevision.SPFAuthPublishableToolID.LLAD~ISPFAuthPublishableDocumentRevision.SPFAuthPublishableTargetClassDef.LLALineListDocument~ISPFListDocRevSnapshot.SnapshotDataGraphDef.DGD_SPFLLALineListRecordDocumentRevision"

  • SPFArgument10 sets the properties shown in the table below.

Interface

Property

Value

Purpose

ISPFListEditControl

SPFPathDefnToRelatedItems

EDG_SPFLLALineListDocumentLineListRecord

Defines the path from the records to the snapshot.

ISPFListEditControl

SPFColSetToDisplayRelatedItems

SPFLLARecordsColumnSet

The column set to use for the snapshot.

ISPFAuthPublishableDocumentRevision

SPFAuthPublishableToolID

LLAD

The target domain of the publish data.

ISPFAuthPublishableDocumentRevision

SPFAuthPublishableTargetClassDef

LLALineListDocument

The class of the document to be created.

ISPFListDocRevSnapshot

SnapshotDataGraphDef

DGD_SPFLLALineListRecordDocumentRevision

Defines the objects that contain the data needed for the snapshot data file.

Snapshot document method

Name: CreateSPFLLADocSnapShot

Client API: CreateListDocumentSnapShot

Arguments:

Template = SPFLLASnapshottemplate - With logo and printing formatting, and so on

Maintain template column size = True - To use the format of the template

This method has the condition IsDocRevWkgAndVerCheckedIn that checks that the selected document is a working revision and that the version is checked in.