Design deliverables - 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)

Design deliverables (such as design documents and tags) are progressed as a single object and its progress is tracked linearly (that is, it has sequential steps).

In design deliverable progress, a step may be linked to an event (for example, the sign-off of a deliverable at specified revisions or the issue of a deliverable on a transmittal for a specified reason).

Details of the properties and functionality exposed by these interfaces are given in the sections that follow.

SPFDesignDocMaster class

A design deliverable is identified by realizing the ISPFPrgDesignItem and ISPFPrgProgressItem interfaces and optionally realizing the ISPFPrgRegisteredItem interfaces. Progress items realizing the ISPFPrgDesignItem interface can only be associated to workpacks realizing the ISPFPrgDesignWorkpack interface.

SPFDesignDocMaster is one of the delivered progressable document classes; however, any class can be a progress item if it realizes these interfaces.

To enable a design document to be registered for progress, it must be allocated a weighting. (This can be done when it is created or later.)

The weighting field on the design document Create/Update form is only available if progress is switched on (by having a hierarchy selected) in the current configuration.

When the object is allocated, a weighting on the following interfaces are instantiated:

  • ISPFPrgDesignItem

  • ISPFPrgProgressItem

When the object is registered for progress, the ISPFPrgRegisteredItem interface is instantiated.

ISPFPrgWorkpack interface

See Progress workpacks and templates description.

SPFPrgWorkpackRegisteredWorkpack relationship definition

This relates the registered deliverable to its workpack.

ISPFPrgProgressItem interface

This interface needs to be instantiated by any item that is to be registered for progress.

The following properties are found on this interface.

Name

Description

Set on

SPFPrgWeighting

Percentage value that indicates how much work this deliverable represents in relation to its peers in the same workpack

Functionality configured on ISPFPrgProgressItem

The command Register for Progress is configured on this interface.

ISPFPrgDesignItem interface

This interface is instantiated when the object is allocated a weighting and enables the object to be registered for design progress.

ISPFPrgRegisteredItem interface

This implies that the deliverable on the workpack is registered for progress.

It contains the properties on the deliverable which are set based on their parent workpack's corresponding properties. It also holds the item steps. When a document is registered, it gets one step for each step on the workpack.

The following properties are found on this interface.

Name

Description

Set on

SPFPrgHasDueSteps

Has due steps

Code

SPFPrgItemDownstream

Workpacks instantiated from this template will allow the automatic calculation of remaining forecast dates for the registered documents in subsequent steps

New/Update Design Workpack/Workpack Template forms.

SPFPrgHasOverdueSteps

Has Overdue Steps

Code

SPFPrgHasPendingSteps

Has Pending Steps

Code

SPFPrgItemCalcOverride

Workpacks instantiated from this template will allow the user to manually override the calculated progress value for an individual step

New/Update Design Workpack/Workpack Template forms

SPFPrgPlannedProgress

The planned progress

New/Update Design Workpack/Workpack Template forms

SPFPrgForcastProgress

The forecast progress

Code

SPFPrgActualProgress

The actual progress

Code

SPFPrgProgressLastCalculated

Last time calculated for progress (whether through rollup or update)

Code

SPFPrgHoursToCompleteBudget

Budget man hours to complete

New/Update Design Workpack/Workpack Template forms

SPFPrgHoursToCompleteActual

Actual man hours to complete

Code

SPFPrgHoursToCompleteForcast

Forecast man hours to complete

Code

SPFPrgLastDistributed

Last time man hours redistributed

Code

SPFPrgReasonForCalcOverride

Reason for calculation override; optional free text entry field

New/Update Design Workpack form

Functionality configured on ISPFPrgRegisteredItem

The commands Unregister for Progress, Update Progress, and View Deliverable are configured on this interface.

SPFPrgItemSteps relationship definition

This links the deliverable to the item steps.

ISPFPrgItemStep interface

The individual item steps have this interface on them.

Name

Description

Set on

Actual Date

Actual date the step is completed

Update Progress form by user or automatically if step linked to a document status change

Forecast Date

Date the step is forecast to be complete

Calculated based on step durations and actual dates as steps complete

Plan Date

Date the step was originally planned to complete

Calculated based on step durations when item is first registered for progress

Replan Date

User entered new plan dates – only set during replan mode (see Change the replan dates). Actual Step Progress stores the amount of progress accrued by the step.

Either entered manually on Update Progress form or automatically if configured

Step Status

Status of step, such as Due, Overdue, Complete, and so on

Set in code

SPFPrgItemStepWorkpackStep relationship definition

This links the workpack step to the item steps. It relates an item step to a corresponding workpack step on its parent workpack.

SPFPrgItemStepSubSteps relationship definition

This links the item steps to any item sub steps.

ISPFPrgWorkpackStep interface

See Progress workpacks and templates.