Unknown macro: {next_previous_links}
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Make sure to go through the following lifecycle configuration definitions when adding a new custom lifecycle via the ES Management Console. 

WSO2 Enterprise Store uses the lifecycle API provided by WSO2 Governance Registry. However, ES does not support all the lifecycle elements provided by the WSO2 Governance Registry.

XML elements

Click on an element to view its details along with sub-element details if any.

  • <aspect>
  •       <configuration>
  •            <lifecycle>
  •                <scxml>
  •                     <state>
  •                          <datamodel>
  •                               <data>
  •                                     <item>
  •                                           <permissions>
  •                                                 <permission>
  •                                           <validations>
  •                                                 <validation>
  •                                                       <parameter>
  •                                     <js>
  •                                           <console>
  •                                                 <script>
  •                                           <server>
  •                                                 <script>
  •                                     <execution>
  •                                           <parameter>
  •                                     <ui>
  •                          <transition>

 


<aspect> 

XML Syntax<aspect name="" class="">
DescriptionThis element defines the various aspects of the lifecycle.
Mandatory/OptionalMandatory
Attributes
AttributeDescriptionDefault ValuesFixed ValuesMandatory/
Optional
nameDefines the name of the lifecycle. As ES does not allow you to create two lifecycles with the same name, the name of the lifecycle should be unique.N/A Mandatory
class

Defines the class that is associated with the lifecycle.

  • The default class in ES extends the default WSO2 Governance Registry aspect class and includes the ES permission model. Therefore, if you wish to use the ES permission model, it is mandatory to use the default ES class for the aspect.
  • As ES uses the lifecycle API provided by WSO2 Governance Registry, if required you can define your own class, but by doing this you will not have access to the permission model in ES.

org.wso2.jaggery.scxml.aspects.
JaggeryTravellingPermissionLifeCycle

 

 Mandatory
Sample implementations
<aspect name="Test" class="org.wso2.jaggery.scxml.aspects.JaggeryTravellingPermissionLifeCycle">

Back to Top ^


<configuration> 

XML Syntax<configuration type="">
DescriptionThis element describes the way in which the lifecycle configurations are setup.
Mandatory/OptionalMandatory
Attributes
AttributeDescriptionDefault ValueFixed ValuesMandatory/
Optional
typeDefines how the lifecycle is configured.N/A

literal - This option depicts that the lifecycle configurations are setup using the ES Management Console.

Mandatory
Sample implementations
<configuration type="literal">

Back to Top ^


<scxml> 

XML Syntax<scxml xmlns="" version="" initialstate="">
Description

This is the element that contains the new, SCXML-based configuration. State Chart XML (SCXML) is an open standard that ES supports. Up to this point of the configuration, there can be only one of each of the elements described above. They all provide metadata about the lifecycle (name, class, and other information). The subsequent elements are the actual SCXML configuration.

Mandatory/OptionalMandatory
Attributes
AttributeDescriptionDefault ValueFixed ValuesMandatory/Optional
xmlnsState Chart XML (SCXML) specification. 
http://www.w3.org/2005/07/scxml
Mandatory
versionVersion number of the State Chart XML (SCXML). 1.0Optional
initialstate

Defines the initial state of the lifecycle. The initial state does not have to be the first state of the configuration. Furthermore, by changing the value of this attribute, you can easily modify the initial state and the flow of your lifecycle.

   
Sample implementations
<scxml xmlns="http://www.w3.org/2005/07/scxml" version="1.0" initialstate="">

Back to Top ^


<state> 

XML Syntax<state id="">
Description

Defines the states of the lifecycle. A lifecycle can have multiple states and if needed, you can define more than one state element in the configuration.

Mandatory/OptionalMandatory
Attributes
AttributeDescriptionDefault ValueFixed ValuesMandatory/
Optional
id

Defines the name of the lifecycle state.

ES does not support multiple lifecycle states with the same name. Therefore, make sure to have unique names for all the state names within a lifecycle.

N/A Mandatory
Sample implementations
<state id="Development"></state>

 

Back to Top ^


<datamodel> 

XML Syntax<datamodel>
Description

This element contains all the custom elements, which are defined in the lifecycle model. Based on the SCXML specification, you can define a data model to a lifecycle state and you can use this extension to define custom elements.

Mandatory/OptionalOptional

This element has no attributes.

Back to Top ^


<data> 

XML Syntax<data name="">
Description

Custom data elements (according to the SCXML specification) serve to define check items and transition executions. This element describes the data of its child elements.

Mandatory/OptionalOptional
Attributes
AttributeDescriptionDefault ValueFixed ValuesMandatory/
Optional
Notes
name

Defines the extension point (e.g., Transition Executors) that is used in the lifecycle.

You can define only one extension point of a kind, because the underlined implementation ignores multiple elements and takes only one into consideration.

 
  • checkItems - If the user is defining check items as its child elements.
  • transitionExecution - If the data element defines programmable executions for transitions.
Mandatory 
Sample implementations
checkItems
<data name="checkItems">
   <item name="Effective Inspection Completed" forEvent="" />
   <item name="Test Cases Passed" forEvent="" />
   <item name="Smoke Test Passed" forEvent="" />
</data>

The above code snippet based on checkItems renders as follows in the Publisher:

 

transitionExecution
 
<data name="checkItems">
	<item name="Code Completed" forEvent="">
	<item name="WSDL, Schema Created" forEvent="">
</data>

<data name="transitionValidation">
	<validation forEvent="" class="">
		<parameter name="" value=""/>
	</validation>
</data>

<data name="transitionPermission">
	<permission forEvent="" roles=""/>
</data>

<data name="transitionScripts">
    <js forEvent="">
        <console function="">
            <script type="text/javascript">
            </script>
        </console>
        <server function="">
            <script type="text/javascript"></script>
        </server>
    </js>
</data>

<data name="transitionExecution">
	<execution forEvent="Promote" class="org.wso2.jaggery.scxml.generic.GenericExecutor">
</data>

<data name="transitionUI">
	<ui forEvent="Promote" href="../lifecycles/pre_invoke_aspect_ajaxprocessor.jsp?currentEnvironment=/_system/governance/trunk/"/>
</data>

<data name="transitionApproval">
	<approval forEvent="Promote" roles="" votes="5"/>
	<approval forEvent="Demote" roles="admin" votes="5"/>
</data>

 

Back to Top ^


<item> 

XML Syntax<item name="" forEvent="">
Description

These elements contain the check items for each state. There can be more than one of these elements.

Mandatory/OptionalOptional
Attributes
AttributeDescriptionDefault ValueFixed ValuesMandatory/
Optional
Notes
nameDefines the name of the check item. ES allows you to define check items for each transition.N/A Optional 
forEventDefines whether the check item is required for a specific transition. A check item can be required for more than one event, in which case, a user can give a comma (",") separated list for the forEvent attribute.Null : Keeping the forEvent attribute empty means that a specific check item is not required for any transition event. OptionalThe forEvent value is defined under the <transition> element with the event  attribute.
Sample implementations
<data name="checkItems">
    <item name="Effective Inspection Completed" forEvent=""></item>
     <item name="Test Cases Passed" forEvent=""></item>
    <item name="Smoke Test Passed" forEvent=""></item>
</data>

 

Back to Top ^


<js> 

XML Syntax<js forEvent="">
Description

ES lifecycle configuration has the ability to allow JavaScript functions to execute on both the server-side and the client-side. The js element defines the scripts that is executed for different events.

Mandatory/OptionalOptional
Attributes
AttributeDescriptionDefault ValueFixed ValuesMandatory/OptionalNotes
forEvent

Defines the respective transition for which the JavaScript function is executed.

  MandatoryThe forEvent value is defined under the <transition> element with the event  attribute.
Sample implementations
<js forEvent="">
     <console function="">....</console>
     <server function="">....</server>
</js>

 

Back to Top ^


<console> 

XML Syntax<console function=""/>
Description

Defines the JavaScript function that ES needs to execute on the client-side.

Mandatory/OptionalOptional
Attributes
AttributeDescriptionDefault ValueFixed ValuesMandatory/OptionalNotes
function

Defines the name of the function that is executed when an asset moves from one lifecycle state to another.

  Mandatory 
Sample implementations
<console function="">
	<script type="text/javascript"> </script>
</console>

Back to Top ^


<server> 

XML Syntax<server function="">
Description

This is the same as the console function and the only difference is that this element defines the scripts that are executed on the server-side.

Mandatory/OptionalOptional
Attributes
AttributeDescriptionDefault ValueFixed ValuesMandatory/
Optional
Notes
function

Defines the name of the function that is executed at an asset transition from one state to another.

  MandatoryThe function should be a ES supported scripting language.
Sample implementations
<server function="">
	<script type="text/javascript"></script>
</server>

 

Back to Top ^


<Execution> 

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

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

Mandatory/OptionalOptional
Attributes
AttributeDescriptionDefault ValueFixed ValuesMandatory/
Optional
Notes
forEvent

Defines the event for which this execution is performed. This gives you the flexibility to define executions for each event.

  MandatoryThe forEvent value is defined under the <transition> element with the event attribute.
classDefines the class that is executed at runtime. A user must give the full, qualified name of a class that implements the Execution interface, as the value of the class attribute.   MandatoryThis class defines the business logic that is executed when the specified event takes place. This class manipulates the current and target environment of the underlying artifact when the state transition is performed on it.
Sample implementations
<execution forEvent="Promote" class="org.wso2.carbon.governance.registry.extensions.executors.ServiceVersionExecutor">

 

Back to Top ^


<parameter> 

XML Syntax<parameter name="" value=""/>
Description

The name attribute defines the name of the parameter and value attribute defines the corresponding value of the parameter. This parameter element is defined under the <execution> element.

Mandatory/OptionalOptional
Attributes
AttributeDescriptionDefault ValueFixed ValuesMandatory/
Optional
Notes
name

This attribute defines the name of the parameter. 

 
  • currentEnvironment - This defines the fully qualified path of the underlying resource at its current state (before the transition takes place).

  • targetEnvironment - This parameter defines the fully qualified path to which the particular resource is transited when a particular state transition takes place which is defined in the "forevent" attribute of the <execution> element. 
     
  • service.mediatype - This parameter denotes the MIME mediatype of the given service under the state transition.

  • wsdl.mediatype - This parameter denotes the MIME mediatype of the WSDL file for the corresponding service under the state transition.

  • endpoint.mediatype - This parameter denotes the MIME mediatype of the endpoint for the given asset type when the particular state transition takes place.
all these parameters are mandatory. 
valueThis attribute defines the value held by the parameter.    
Sample implementations
<data name="transitionExecution">
 <execution forEvent="Promote" class="org.wso2.carbon.governance.registry.extensions.executors.ServiceVersionExecutor">
 <parameter name="currentEnvironment" value="/_system/governance/trunk/{@resourcePath}/{@resourceName}"/>
 <parameter name="targetEnvironment" value="/_system/governance/branches/testing/{@resourcePath}/{@version}/{@resourceName}"/>
 <parameter name="service.mediatype" value="application/vnd.wso2-service+xml"/>
 <parameter name="wsdl.mediatype" value="application/wsdl+xml"/>
 <parameter name="endpoint.mediatype" value="application/vnd.wso2.endpoint"/>
 </execution> 
 </data>

 

Back to Top ^


<ui> 

XML Syntax<ui forEvent="" href=""/>
Description

A UI element is a mechanism to associate a user interface with a particular event during a given transition. This allows you to pass inputs that would be utilized when performing a transition. Note that you can not define an external reference link as the href attribute value. Instead you need to provide a relative path in the Carbon server as the value of the href attribute.

Mandatory/OptionalOptional
Attributes
AttributeDescriptionDefault ValueFixed ValuesMandatory/
Optional
Notes
forEvent

Defines the event for which the UI appears.

N/A OptionalThe forEvent value is defined under the <transition> element with the event  attribute.
hrefDefines the hyperlink that is opened and presented to the user, when a lifecycle transition operation is performed from the ES Management Console.N/A Optional 
Sample implementations
<ui forEvent="Promote" href="../lifecycles/pre_invoke_aspect_ajaxprocessor.jsp?currentEnvironment=/_system/governance/branches/testing/"/>

 

Back to Top ^


<transition> 

XML Syntax<transition event="" target=""/>
Description

Defines the transitions, by specifying the name of the lifecycle state and the target lifecycle state, instead of using static transitions. Any number of transitions for one lifecycle state are supported.

Mandatory/OptionalMandatory
Attributes
AttributeDescriptionDefault ValueFixed ValuesMandatory/
Optional
Notes
event

Defines the transition event name, e.g., Promote, Demote or any name that the user specifies.

N/A MandatoryThis event name is used in the forEvent to trigger a specific event, before this transition this going on.
targetDefines the target state of the transition.N/A Mandatory 
Sample implementations
<transition event="Promote" target="Tested"/>

Back to Top ^

  • No labels