Stages Documentation

Use Scripting

ProcessClass

It corresponds to a process in Stages. A project can contain 0 or more processes (including baselines).

ID

  • Type: String
  • Documentation: Process ID; can be used to generate internal Stages URL links

ProcessKind

  • Type: Integer
  • Documentation: Returns the type of properties (In Stages Edit > Properties)
    • 0: Process
    • 1: Process Model
    • 2: Core Process
    • 3: Reference Model

WriteProtection

  • Type: Boolean
  • Documentation: (unsupported) Returns true if the process is write protected

Type

  • Type: String
  • Documentation: Returns the metamodel type (indent of the PKitProcess.xml)

Description

  • Type: String
  • Documentation: Text of the overview page (HTML encoded)

NavigationDescription

  • Type: String
  • Documentation: Description which will be shown on the left side (Process navigation)
    • Edit > Edit Overview Page > Description on process navigation (left side)
    • HTML encoded

State

  • Type: String
  • Documentation: State of the Process Baseline
    • (value from PKitConfig.xml property process.element.state.validStates)

LockingState

  • Type: String
  • Documentation: Returns the Locking State:
    • nl - NO_LOCK
    • rp - READ_PROTECTED
    • wp - WRITE_PROTECTED
    • pl - PROCESS_LOCK
    • pail - PROCESS_AND_INTERFACE_LOCK

ProjectID

  • Type: Integer
  • Documentation: Returns the project ID

ReferenceModel

  • Type: Boolean
  • Documentation: Return true of process is a reference model

Model

  • Type: Boolean
  • Documentation: Returns true if process is a process model

Version

  • Type: String
  • Documentation: Returns the baseline name or value of process.cms.working.revision property in case of the working revision (should not be used to check for a working revision, use WorkingRevision instead)

VersionDescription

  • Type: String
  • Documentation: Returns the description of the baseline (version) (HTML encoded)

ValidVersion

  • Type: Boolean
  • Documentation: Returns true if this baseline (version) if the valid (default) baseline

WorkingRevision

  • Type: Boolean
  • Documentation: Returns true if this baseline (version) is the working revision

Identity

  • Type: String
  • Documentation: Returns the internal Stages Identity of the baseline (version)

UnsafeDescription

  • Type: Boolean
  • Documentation: Returns if the Process Description is set to unsafe mode (No HTML validation)

DisplayNavigationDescription

  • Type: Description
  • Documentation: Returns a description object of the navigation description

DisplayDescription

  • Type: Description
  • Documentation: Returns a description object of the baseline (version) description