Page Comparison

You can change the default lifecycle model configuration by editing configurationsediting the configurations.xml  file  using the information given below.

...

• File Name: configurations.xml
• Location: <ES_HOME>\repository\resources
• Purpose: Defines Allows you to define lifecycles, which are applied for asset types.

...

<aspect> 

Attributes

...

A user has the ability to define his/her

Attribute	Description	Type	Default ValueValues	Fixed Values	Mandatory/ Optional	Notes
name	Contains Defines 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.		org.wso2.jaggery.scxml.aspects. JaggeryTravellingPermissionLifeCycle		Mandatory	org.wso2.carbon.governance.registry. extensions.aspects.DefaultLifeCycle		Mandatory	You can define your own class as shown here, but the default class provided with the ES distribution has the capability to handle any configuration that follows the above template.

Sample implementations

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

...

Anchor
configuration configuration

<configuration> 

Attributes

...

Attribute	Description	Type	Default Value	Fixed Values	Mandatory/ Optional	Notes
type	Define Defines how the lifecycle configuration optionsis configured.		N/A	literal - If the configuration is setup through the management console Use this option when the lifecycle configurations are setup using the ES Management Console. resource -  If the configuration is setup through  Use this option when the lifecycle configurations are setup via the registry.xml file.	Mandatory

Sample implementations

<configuration type="resource">

Back to Top ^

...

Anchor
scxml scxml

<scxml> 

Attributes

...

Attribute	Description	Type	Default Value	Fixed Values	Mandatory/Optional	Notes
xmlns	State Chart XML (SCXML) specification.			http://www.w3.org/2005/07/scxml	Mandatory
version	Version number of the State Chart XML (SCXML).			1.0	Optional
initialstate	Defines the initial state of the lifecycle. The initial state does not have to be the first state of the configuration. AlsoFurthermore, by changing the value of this attribute, a user you can quickly easily modify the initial state and the flow of the lifecycle.

Sample implementations

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

Back to Top ^

...

Anchor
state state

<state> 

Attributes

...

Attribute	Description	Type	Default Value	Fixed Values	Mandatory/ Optional	Notes
id	The ID attribute of the state element defines the Defines the name of that the lifecycle state.		N/A		Mandatory

Sample implementations

<state id="Development"></state>

Back to Top ^

...

Anchor
datamodel datamodel

<datamodel> 

...

This element has no attributes.

Back to Top ^

...

Anchor
data data

<data> 

Attributes

...

Attribute	Description	Type	Default Value	Fixed Values	Mandatory/ Optional	Notes
name	Defines the extension point (e.g., Transition Validators, Transition Executors, Transition User Interfaces and Transition Scripts are one of many well-defined extension points supported by ES) that is used in the lifecycle. You can define only one such element extension point of each a kind as , because the underline underlined implementation ignores multiple elements and takes only one into consideration. For transitionApproval, the following rules apply regarding roles and votes: roles="" - Any user can vote roles="admin" - Only users with an admin role can vote   votes="2" - Two votes are required for approval.			checkItems - If the user is defining check items as its child elements. transitionValidations - If the data element defines transition validations. transitionPermission - If the data element defines transition permissions. transitionScripts - If the data element describes the transition scripts. transitionExecution - If the data element defines programmable executions for transitions. transitionUI - If the data element defines custom UIs accepting that accept user input for transitions. transitionApproval - If the data element defines lifecycle transition transitions that need user approvals.	Mandatory

Sample implementations

<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 ^

...

Anchor
item item

<item> 

Attributes

...

Attribute	Description	Type	Default Value	Fixed Values	Mandatory/ Optional	Notes
name	Defines the name of the check item. ES allows you to define check items for each transition.		N/A		Optional
forEvent	Defines 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.		Optional	The 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>

...

Anchor
permissions permissions

<permissions> 

This element doesn't have any attributes.

...

Anchor
permission permission

<permission> 

Attributes

...

Attribute	Description	Type	Default Value	Fixed Values	Mandatory/ Optional	Notes
roles	Defines the name of the user role to do the specified action.				Mandatory	Multiple You can define multiple user roles can be define here with as comma (",") separated.

Sample Implementations

<permission roles="admin,manager"/>

...

Anchor
validations validations

<validations> 

This element doesn't does not have any attributes.

Back to Top ^

...

Anchor
validation validation

<validation> 

Attributes

...

Attribute	Description	Type	Default Value	Fixed Values	Mandatory/ Optional	Notes
forEvent	Defines the event for which this validation should be performed. This gives user you the flexibility to define validations for each event. The user has As you have the ability to define validations for check items, which it makes it easy to validate different things at different levels.		N/A		Mandatory	The forEvent value is defined under the <transition> element with the "event"  attribute.
class	Defines the class that needs to be is executed at runtime to perform the validation. A user You must give the full, qualified name of a class that implements the CustomValidations interface, as the value of for the class attribute class.		N/A		Mandatory

Sample implementations

<validation forEvent="" class=""></validation>

...

Anchor
parameter parameter

<parameter> 

Attributes

...

Attribute	Description	Type	Default Value	Fixed Values	Mandatory/ Optional	Notes
name	User defined value Defines the name used to identify the parameter.		N/A		Mandatory
value	Defines the value of user the defined parameter.		N/A		Mandatory

Sample implementations

 <parameter name="endpoint.mediatype" value="application/vnd.wso2.endpoint"/>

Back to Top ^

...

Anchor
js js

<js> 

Attributes

...

Attribute	Description	Type	Default Value	Fixed Values	Mandatory/Optional	Notes
forEvent	Defines Defines the transition action where this respective transition for which the JavaScript function needs to be is executed.				Mandatory	The forEvent value is defined under the <transition> element with the "event"  attribute.

Sample implementations

<js forEvent="">
     <console function="">....</console>
     <server function="">....</server>
</js>

...

Anchor
console console

<console> 

Attributes

...

Attribute	Description	Type	Default Value	Fixed Values	Mandatory/Optional	Notes
function	Defines the name of the function which will be executed at a transition that is executed when an asset moves from one lifecycle state to another.				Mandatory

Sample implementations

<console function="">
	<script type="text/javascript"> </script>
</console>

...

Anchor
script script

<script> 

Attributes

...

Attribute	Description	Type	Default Value	Fixed Values	Mandatory/ Optional	Notes
type	ES supports The scripting language that is supported by ES.			Set to text/javascript because at the time of this writing, ES only supports JavaScript as a scripting language.	Mandatory

Sample implementations

<script type="text/javascript"></script>

...

Anchor
server server

<server> 

Attributes

...

Attribute	Description	Type	Default Value	Fixed Values	Mandatory/ Optional	Notes
function	Defines the name of the function which will be that is executed at a an asset transition from one state to another.				Mandatory	The function should be a ES supported scripting language.

Sample implementations

<server function="">
	<script type="text/javascript"></script>
</server>

...

Anchor
execution execution

<Execution> 

Attributes

...

Attribute	Description	Type	Default Value	Fixed Values	Mandatory/ Optional	Notes
forEvent	Defines the event for which this execution should be is performed. This gives user you the flexibility to define executions for each event.				Mandatory	The forEvent value is defined under the <transition> element with the "event"  attribute attribute.
class	Defines the class that needs to be 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 class.				Mandatory	This class defines the business logic that is executed when the specified event is taken 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">

...

Anchor
execution execution

<parameter> 

Attributes

Attributes of the element

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 ^

...

Anchor
ui ui

<ui> 

Attributes

...

Attribute	Description	Type	Default Value	Fixed Values	Mandatory/ Optional	Notes
forEvent	Defines the event for which this the UI will be presentedappears.		N/A		Optional	The forEvent value is defined under the <transition> element with the "event"  attribute.
href	Defines the hyperlink that will be 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 ^

...

Anchor
transition transition

<transition> 

Attributes

...

Attribute	Description	Type	Default Value	Fixed Values	Mandatory/ Optional	Notes
event	Defines the transition event name, for example, to "Promote" or "Demote" e.g., Promote, Demote or any name that the user specifies.		N/A		Mandatory	This event name is used in the forEvent to trigger a specific event, before this transition this going on.
target	Defines the target state of the transition.		N/A		Mandatory

Sample

...

implementations

<transition event="Promote" target="Tested"/>

...