Lifecycle Configuration Elements

Users can change the default lifecycle model configuration by editing the .xml files in the <GREG_HOME>/repository/resources/lifecycles directory using the information given below.

EndpointLifeCycle.xml

<aspect name="EndpointLifeCycle" class="org.wso2.carbon.governance.registry.extensions.aspects.DefaultLifeCycle">
    <configuration type="literal">
        <lifecycle>
            <scxml xmlns="http://www.w3.org/2005/07/scxml"
                   version="1.0"
                   initialstate="Active">
                <state id="Active">
                    <transition event="Deactivate" target="Off"/>
                </state>
                <state id="Off">
                    <transition event="Activate" target="Active"/>
                </state>
            </scxml>
        </lifecycle>
    </configuration>
</aspect>

<aspect>

XML Syntax	`<aspect name="" class="">`
Description	This element defines lifecycles as aspects.
Mandatory/Optional	Mandatory

Attributes of the Element

Attribute Description Default Value Mandatory/Optional Notes

name

Contains the name of the lifecycle. Governance Registry does not allow you to create two lifecycles with the same name.

EndpointLifeCycle

Mandatory

class

Defines the class that is associated with the lifecycle.

org.wso2.carbon.governance.

registry.extensions.aspects.

DefaultLifeCycle

Mandatory

A user has the ability to define his/her own class as shown here, but the default class provided with the Governance Registry distribution has the capability to handle any configuration that follows the above template.

XML Syntax	`<configuration type="">`
Description	This element describes the way the lifecycle configuration is setup.
Mandatory/Optional	Mandatory

XML Syntax	`<state id="">`
Description	The `state` element defines the states of the lifecycle. A lifecycle can have multiple states, and in the configuration, more than one state element can be given.
Mandatory/Optional	Mandatory

XML Syntax	`<datamodel>`
Description	This element contains all the custom elements which are defined in the lifecycles model. The SCXML specification allows users to define a data model to a state and this extension is used to define custom elements.
Mandatory/Optional	Optional

XML Syntax	`<data name=""/>`
Description	Custom `data` elements (according to the SCXML specification) serve to define check items, transition permission, transition validations, transition scripts, transition executions, and transition UIs. This element describes the data of its child elements.
Mandatory/Optional	Optional

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/Optional	Optional

Attribute	Description	Default Value	Fixed Values	Mandatory/Optional	Notes
name	Defines the name of the check item. Governance Registry allows 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.

XML Syntax	`<permissions>`
Description	The `permissions` element defines permissions for that specified action and hold more than one child element which defines permissions. Under check items, the `permissions` element defines the users that have the capability of checking (check/uncheck) that check item. If a user does not have permissions to check a check item, then the management console will display that specific item in disabled mode. The idea behind this is to let the user know that there are some more check items in that state, but that he or she does not have permission to check them (so as to avoid user confusion).
Mandatory/Optional	Optional

XML Syntax	`<permission roles=""/>`
Description	This element is a child element of the `permissions` element and will define the roles that have permissions to do the specified action. Here, the attribute `roles` accepts a comma (",") separated list and these roles should be present in Governance Registry.
Mandatory/Optional	Optional

XML Syntax
Description	Defines the validations that need to be completed for each action. This element can contain one or more `validation` elements. Check Item Validators are one of many well-defined extension points supported by the WSO2 Governance Registry. Read more on Supported Extension Points for a complete list of extension points supported by WSO2 Governance Registry.
Mandatory/Optional	Optional

XML Syntax	`<validation forEvent="" class=""/>`
Description	Validations are an important part of lifecycles. The `validation` element defines the event and the validation class that has to be invoked at runtime.
Mandatory/Optional	Optional

XML Syntax	`<console function=""/>`
Description	Defines the JavaScript function that needs to be executed on the client side.
Type
Mandatory/Optional	Optional

Attribute	Description	Default Value	Fixed Values	Mandatory/Optional	Notes
forEvent	Defines the event for which this validation should be performed. This gives user the flexibility to define validations for each event. The user has the ability to define validations for check items, which 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 executed at runtime to perform the validation. A user must give the full, qualified name of a class that implements the `CustomValidations` interface, as the value of the attribute `class`.	N/A		Mandatory

XML Syntax	`<parameter name="" value=""/>`
Description	The `parameter` elements are used to give parameters to the validation and execution classes. It is up to the user to define the `name value` pairs, and the parameter element has attributes to define these values. A `validation` element or an `execution` element can have more than one `parameter` element and it is up to the user code to handle this. The underline implementation of the `DefaultLifeCycle` class will pass all the parameters in a map object.
Mandatory/Optional	Optional

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

XML Syntax
Description	Governance Registry 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 need to be executed for different events.
Mandatory/Optional	Optional

XML Syntax	`<script type="text/javascript"/>`
Description	Contains the actual JavaScript code segment. A user has the ability to define any code segment here.
Mandatory/Optional	Optional

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 need to be executed on the server side.
Mandatory/Optional	Optional

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.
Mandatory/Optional	Optional

Attribute	Description	Default Value	Fixed Values	Mandatory/Optional	Notes
forEvent	Defines the event for which this execution should be performed. This gives user the flexibility to define executions for each event.			Mandatory	The forEvent value is defined under the <transition> element with the "event" attribute.
class	Defines 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`.			Mandatory	This class defines the business logic that is executed when the specified event is taken place. This class manipulates the current and target environment of the underlying artifact when the state transition is performed on it.

Attribute	Description	Default Value	Fixed Values	Mandatory/Optional	Notes
name	The name attribute defines the name of the parameter. This parameter element defined under the `<execution>` element.		currentEnvironment - This defines the fully qualified path of the underlying resource at its current state(before the transition is taken place) targetEnvironment - This parameter defines the fully qualified path to which the particular resource is transitted when the particular state transition is taken 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 artifact(service) when the particular state transition is taken.	all these parameters are mandatory.
value	value attribute defines that the value hold by the parameter. This parameter element defined under the `<execution>` element.

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 provides a convenient way for a user to pass input that would be utilized when performing a transition. Note that, for the value of href, it will not accept any external reference link for the value. It is required to provide a relative path in the carbon server as the value of href.
Mandatory/Optional	Optional

Lifecycle Configuration Elements

EndpointLifeCycle.xml

<aspect>

Attributes of the Element

<configuration>

Attributes of the Element

<scxml>

Attributes of the Element

<state>

Attributes of the Element

ServerLifeCycle.xml

<aspect>

Attributes of the Element

<configuration>

Attributes of the Element

<scxml>

Attributes of the Element

<state>

Attributes of the Element

ServiceLifeCycle.xml

<datamodel>

<data>

Attributes of the Element

<item>

Attributes of the Element

<permissions>

<permission>

Attributes of the Element

<validations>

<validation>

Attributes of the Element

<parameter>

Attributes of the Element

<js>

Attributes of the Element

<console>

Attributes of the Element

<script>

Attributes of the Element

<server>

Attributes of the Element

<Execution>

Attributes of the Element

<parameter>

Attributes of the Element

<ui>

Attributes of the Element

<transition>

Attributes of the Element

Attribute	Description	Default Value	Fixed Values	Mandatory/Optional	Notes
forEvent	Defines the event for which this UI will be presented.	N/A		Optional	The forEvent value is defined under the <transition> element with the "event" attribute.
href	Defines the hyperlink that will be opened and presented to the user, when a lifecycle transition operation is performed from the Management Console.	N/A		Optional

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