Basic document forms - 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)

The forms for all documents are created interactively or loaded from load files, as document forms cannot make use of the form generation functionality due to the special nature of some of the document properties.

The document forms are always related to the version, except when supporting document reservation, as described below.

The Form Builder can create the forms as described in Configure forms. An easy way to create a new similar form is to do the following steps:

  • Find an existing form, and then expand its sections

  • Create a new form

  • Relate it to the new document version class definition

  • Run Form Builder on the new form

  • Drag the sections from the existing form onto the new form, and arrange them as required

  • Generate sections for new customer interfaces using the shortcut menu Generate Section command, and then drag the new section from the New Items window to the form

Notes on forms for complex objects

  • Documents are complex objects made up of a master, revision, and version. As discussed above, it is the document version that is presented in the client. Forms are always created for the lowest object of the complex, in this case, that is a document version. Form sections can be created for the objects at each level of the complex object, the version being identified by $3, the revision by $2, and the master by $1.

  • The Create and Query methods, as discussed later, are written with respect to the document version, retrieving the form related to the document version.

  • When the update command is run on one level of the complex object, the sections for the levels above are displayed as well. For example, update of a document revision displays the document master sections and the document revision sections.

Basic document form

The basic document form needs the following standard sections:

Name (display items)

Display as

Purpose

Level

DocNameDesc_C-Section

(Name and Description)

Main details

Activate, Revise, Copy, Create

$1/$2/$3

DocNameDesc_Q-Section

(Name and Description)

Main details

Query

$3

DocNameDesc_UI-Section

(Name and Description)

Main details

Update, GetInfo

$3

Configuration_UI-Section

(Configuration information)

Configuration details

Update, GetInfo

Not specified as it is a general form section

DocumentMaster

(status and title)

Details

Activate, Query, Revise, Copy, Create

$1

DocumentMasterRO

(Typing properties, status and title)

Details

Update, GetInfo

$1

RevisionAndRevScheme_Create

(Revision and scheme)

Revision details

Revise, Activate, Copy, Create

$2

DocumentRevision_Query

(Revision and scheme)

Revision details

Query

$2

DocumentRevision_Update

(Revision and scheme)

Revision details

Update, GetInfo

$2

DocVersionOwningGroup

(Owning group)

Owning group

GetInfo, Query

$3

DocVersionOwningGroupRqd

(Owning group)

Owning group

Revise, Update, Activate, Copy, Create

$3

DocGenDetails_QI-Section

(Last updated date, creation date and create user)

General details

GetInfo, Query

$3

HistoricalRev-Section***

(Revision scheme and issue date of revision being inserted)

Historical revision information

HistRev

Not specified as it is used on a custom form

PrevHistRevInfo-Section***

(Revision scheme and issue date of previous)

Previous revision information

HistRev

Not specified as it is used on a custom form

SelHistRevInfo-Section***

(Revision scheme and issue date of selected revision before which the new one is being inserted)

Selected revision information

HistRev

Not specified as this is used on a custom form

*** The historical revision sections are to support the insert historical revision method.

Details of these form sections can be found in Summary of Delivered Core Document Model.