Stages Documentation

Use Scripting

ProcessElementClass

Is a kind of placeholder for all Elements in the metamodel. Each element like artifacts, roles, and metric share the same properites.

DisplayName

  • Type: String
  • Documentation: Name of the element

Type

  • Type: String
  • Documentation: Element type (e.g. artifact, role)

SortKey

  • Type: Integer
  • Documentation: Returns:
    • 0 (unsorted)
    • 1 (sorted alphabetically)
    • else sortkey which indicates the order

SubType

  • Type: String
  • Documentation: Subtype of the element

Id

  • Type: String
  • Documentation: Id of the element

IndexMode

  • Type: Integer
  • Documentation: Returns:
    • 0: element folder (contains only subelements)
    • -1: For
    • 1: For INDEX Pages

Visible

  • Type: Boolean
  • Documentation: Returns true if element is tailored away

Filtered

  • Type: Boolean
  • Documentation: Returns if the process element is filtered or not

Hierarchic

  • Type: Boolean
  • Documentation: Returns true if element is “Element folder (contains only subelements)”

Labels

  • Type: String
  • Documentation: Returns the labels of the element

LastChangeUser

  • Type: String
  • Documentation: Returns the user name who made the last modification

Timestamp

  • Type: Timestamp
  • Documentation: Returns the timestamp of the last modification

Abbreviation

  • Type: String
  • Documentation: Short name of the element

SecurityLevel

  • Type: Integer
  • Documentation: Security level 0-5

State

  • Type: String
  • Documentation: State of the element

TailoringJustification

  • Type: String
  • Documentation: Justification comment from the tailoring

Description

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

DisplayDescription

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

RealElement

  • Type: ProcessElementElement
  • Documentation: Returns in case of a shadow element (linked) the corresponding real element

URL

  • Type: String
  • Documentation: Returns null. Only used for internal purposes

DisplayTailoringJustification

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

Identity

  • Type: String
  • Documentation: Returns the internal Stages identity of the process element

UnsafeDescription

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

Guid

  • Type: String
  • Documentation: Returns the internal GUID of the process element

TypeNameSingular

  • Type: String
  • Documentation: Type name of the element from properties file singular

SubtypeNameSingular

  • Type: String
  • Documentation: Subtype name of the element from properties file singular

TypeNamePlural

  • Type: String
  • Documentation: Type name of the element from properties file plural

SubtypeNamePlural

  • Type: String
  • Documentation: Subtype name of the element from properties file plural

EnactmentScriptName

  • Type: String
  • Documentation: Name of the assigned enactment script

Frozen

  • ​​​​​​​Type: Boolean
  • Documentation: Is Element frozen

FreezeRoot

  • ​​​​​​​Type: ProcessElementElement
  • Documentation: Frozen root element