NLF load format for documents - 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)

To make it easier for NLF to load documents, users can either fully define the document by specifying each class and all the relationships that make up a document, or they can define the document in a shorthand format in which only the document master is fully defined. This has special keywords that make it easier to create the revision and version objects.

.SPFTemplateMaster

..Name|DocABC

..Description|NLF Document ABC

..SPFDocCategory|e1TemplateDocuments

..SPFDocType|e1XSLReportTemplate

..SPFTitle|Test

..SPFDocState|RESERVED

..SPFMajorRevision|01 Note: This parameter is a Revision parameter.

..SPFMinorRevision|A Note: This parameter is a Revision parameter.

If a revision, version property, or the keyword Action is detected on the document master class instance, then the revision, version, and the associated relationships are referenced or generated automatically.

The way in which this is achieved is by first finding out the associated revision and version class definition. This is done by expanding up the SPFIncludes relationship from the specified document master class definition.

The name and description of the revision and version objects will be the same as the document master.

Format

Description

Example

.DocumentMasterClass_Type

Defines the class definition of the document master.

. SPFTemplateMaster

..Name|Value

Defines the name of the object instance in the database.

..Name|DocABC

..Description|Value

Defines the description of the object instance in the database.

..Description|NLF Document ABC

..PropertDef|value|UOM|Type

Defines the value of the given property name. If the property is of type UoMListType, the third field includes the name of UOM.

For each property found, the associated class definition is determined by looking at the realizes and exposes relationships, and then the property is added to the correct object.

..SPFDocumentCategory|e1TemplateDocuments

To update a property on a document master, revision, or version, update it as a single class update.

For example, the following NLF updates the master document only:

.SPFTemplateMaster

..Name|DocABC

..SPFTitle|Test Update capability

The following NLF example signs off a document:

.SPFTemplateMaster

..Name|DocABC

..Action|SignOff|NLF Loadfile signoff

The following NLF revises a document:

.SPFTemplateMaster

..Name|DocABC

..Action|Revise|Rev01A|01|C