Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

XML Syntax<execution forEvent="" class=""/>
Description

An executor is business logic that is executed once a state transition happens in a lifecycle. The execution element defines the event and the execution class that will be invoked at runtime.

Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Attributes of the Element
demote publish
AttributeDescriptionTypeDefault ValueFixed ValuesMandatory/OptionalNotes
forEvent

Defines the event for which this execution should be performed. This gives user the flexibility to define executions for each event.

String

 

promote
  • Promote - Event transits the LC state to next level.(development to QA)
  • Demote - Event transits the LC state to previous state.(QA to development)
  • Publish - Event transits the LC state from production to publish.(production to API Store).
  • Promote
  • Demote
  • Publish
Mandatory - A valid event value must be given.

promote/demote/publish - When

invoke

invokinf this event, the LC state

change

changes from its current state to target state which is defined within the <transition> element by the "target" attribute.

classDefines the class that needs to be executed at runtime. A user must give the full, qualified name of a class that implements the Execution interface, as the value of the attribute class. String  mandatoryMandatoryThis class consists of business logic which will be executed when the user invoke the corresponding event within a given state. This class facilitates the environment changes during the state transition

...

AttributeDescriptionTypeDefault ValueFixed ValuesMandatory/OptionalNotes
name

The 'name' attribute is referred by the business logic defined in the 'class' attribute of the <execution> element.

String

Literal: The values 'currentEnvironment' and 'targetEnvironment' are of String Literal type.MIME Media Type: The values 'service.mediatype', 'wsdl.mediatype' and 'endpoint.mediatype' denote the  parameters.

N/A
  • currentEnvironment - Denotes the fully-qualified path of the resource under the current state, which is the state in which the resource is currently in.
  • targetEnvironment - Denotes the path to which the resource has to move during state transition. 
  • service.mediatype - Points out the MIME mediatype of the service artifact.
  • wsdl.mediatype - Points out the MIME mediatype of the WSDL artifact.
  • endpoint.mediatype - Points out the MIME mediatype of the artifact name Endpoint.
Mandatory

Since the artifacts are to be governed, the current and target environment have to start with "/_system/governance". In other words, the artifacts that are governed must be stored under "/_system/governance/" directory at any state transition.

valueThe 'value' attribute is used to compute the parameter's logic. StringN/AN/AMandatory 
Sample Implementations

...