DriveWorks Pro 16: SpGetState [send feedback...]

SpGetState

Will return a table containing the given state's information from a particular specification.

Syntax

SpGetState(State Name, Specification Id)

Where:

State Name is the name of the state to return the information from.

Specification Id (optional) is the Id of the specification to return the current state information. If left blank the current specification will be used.

Example

RuleResultMeaning
SpGetState("Specify"){"Name","Type","All Teams","Team Names","Owner", "Creator"; "Specify", "Running", True,"Administrators|Sales|Ops|Engineering", True, True}This will return a table showing the information about the given state in the current specification.
SpGetState("Specify","174"){"Name","Type","All Teams","Team Names","Owner", "Creator"; "Specify", "Running", True,"Administrators|Sales|Ops|Engineering", True, True}This will return a table showing the information about the given state in the specification with the Id of 174.

Column Headers

The columns returned in the table and their meanings are listed below:

  • Name - The name of the states in the project.
  • Type - The type of state (running, paused or automatic)
  • All Teams - True if All is checked in the Specification Flow Security.
  • Team Names - A pipe delimited list will be returned of the teams that have permission to the state.

    The Team Names displayed are the Teams that have access to the state.

    In some circumstances this could differ from the Teams that have been set on the state itself.

    This is because subsequent Transitions could elevate a Team's permission to the state.

  • Owner - True if the Owner of the specification, as defined in the Specification Flow Security, has permission to the state.
  • Creator - True if the Creator of the specification, as defined in the Specification Flow Security, has permission to the state.

For more information on States and Specification Flow see Specification Flow

Table Result

The result from the function as displayed in a table (such as a Data Table).

NameTypeAll TeamsTeam NamesOwnerCreator
SpecifyRunningTrueAdministrators|Sales|Ops|EngineeringTrueTrue

Table of Contents