Users can change the default lifecycle model configuration by editing file editing configurations.xml file using the information given below.
File Details
- File Name: configurations.xml
- Location: $CARBON_HOME\repository\confresources
- Purpose:
XML Elements
Click on an element to view its details along with sub element details if any.
Anchor | ||||
---|---|---|---|---|
|
- <aspect>
- <configuration>
- <lifecycle>
- <scxml>
- <state>
- <datamodel>
- <data>
- <item>
- <permissions>
- <permission>
- <validations>
- <validation>
- <parameter>
- <js>
- <console>
- <script>
- <server>
- <script>
- <execution>
- <parameter>
- <ui>
- <transition event="" target=""/><transition>
...
<aspect>
Anchor | ||||
---|---|---|---|---|
|
...
Attribute | Description | Type | Default Value | Fixed Values | Mandatory/Optional | Notes |
---|---|---|---|---|---|---|
name | Transition Validators, Transition Executors, Transition User Interfaces and Transition Scripts 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. The user can define only one such element of each kind, since the underline implementation will ignore multiple elements and take only one into consideration. |
|
Sample Implementations
...
<item>
Anchor | ||||
---|---|---|---|---|
|
XML Syntax | <item name="" forEvent=""/> |
---|---|
Description |
|
Type | |
Default Value | |
Fixed Values | |
Mandatory/Optional |
...
Attribute | Description | Type | 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. | |||||
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. |
Sample Implementations
...
<permissions>
Anchor | ||||
---|---|---|---|---|
|
...
This element doesn't have any attributes.
...
<permission>
Anchor | ||||
---|---|---|---|---|
|
...
Attribute | Description | Type | Default Value | Fixed Values | Mandatory/Optional | Notes |
---|---|---|---|---|---|---|
roles |
Sample Implementations
...
<validations>
Anchor | ||||
---|---|---|---|---|
|
...
This element doesn't have any attributes.
...
<validation>
Anchor | ||||
---|---|---|---|---|
|
...
Attribute | Description | Type | 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. | |||||
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 . |
Sample Implementations
...
<parameter>
Anchor | ||||
---|---|---|---|---|
|
...
Attribute | Description | Type | Default Value | Fixed Values | Mandatory/Optional | Notes |
---|---|---|---|---|---|---|
name |
| |||||
value |
Sample Implementations
...
<js>
Anchor | ||||
---|---|---|---|---|
|
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 |
Type | |
Default Value | |
Fixed Values | |
Mandatory/Optional |
...
Attribute | Description | Type | Default Value | Fixed Values | Mandatory/Optional | Notes |
---|---|---|---|---|---|---|
forEvent | Defines the transition action where this JavaScript function needs to be executed. |
Sample Implementations
...
<console>
Anchor | ||||
---|---|---|---|---|
|
...
Attribute | Description | Type | Default Value | Fixed Values | Mandatory/Optional | Notes |
---|---|---|---|---|---|---|
function | Defines the name of the function which will be executed at a transition from one state to another. |
Sample Implementations
...
<script>
Anchor | ||||
---|---|---|---|---|
|
...
Attribute | Description | Type | Default Value | Fixed Values | Mandatory/Optional | Notes |
---|---|---|---|---|---|---|
type |
| Set to text/javascript because, at the time of this writing, Governance Registry only supports JavaScript as a scripting language. |
Sample Implementations
...
<server>
Anchor | ||||
---|---|---|---|---|
|
...
Attribute | Description | Type | Default Value | Fixed Values | Mandatory/Optional | Notes |
---|---|---|---|---|---|---|
function |
|
Sample Implementations
...
<Execution>
Anchor | ||||
---|---|---|---|---|
|
XML Syntax | <execution forEvent="" class=""/> |
---|---|
Description | An executor is business logic that is executed once a state transition happens in a lifecycle. The |
Type | |
Default Value | |
Fixed Values | |
Mandatory/Optional |
Attributes of the Element
Attribute | Description | Type | Default Value | Fixed Values | Mandatory/Optional | Notes |
---|---|---|---|---|---|---|
forEvent | Defines the event for which this execution should be performed. This It gives user the flexibility to define executions for each event. | |||||
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 . |
Sample Implementations
...
XML Syntax | <execution forEvent="" class=""/> |
---|---|
Description | An executor is business logic that is executed once a state transition happens in a lifecycle. The |
Type | |
Default Value | |
Fixed Values | |
Mandatory/Optional |
Attributes of the Element
Attribute | Description | Type | 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. | |||||
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 . |
Sample Implementations
...
A valid event value must be given to this attribute. | String | N/A |
| Mandatory | promote/demote/publish - When this event is invoked, the life cycle's state changes from its current state to the target state which is defined in the "target" attribute of the <transition> element. | |
class | Defines the class that needs to be executed at runtime, when the user invokes the corresponding event within a given state. This class consists of business logic to be executed and facilitates environment changes during state transitions. A user must give the full, qualified name of a class that implements the | String | N/A | org.wso2.carbon.governance.registry.extensions. | Mandatory | The class named "org.wso2.carbon.governance .registry.extensions.executors.ServiceVersionExecutor" does provide the necessary business logic for the complete default lifecycle configuration model. |
Sample Implementations
Code Block |
---|
<execution forEvent="Promote" class="org.wso2.carbon.governance.registry.extensions.executors.ServiceVersionExecutor"> |
...
<parameter>
Anchor | ||||
---|---|---|---|---|
|
XML Syntax | <parameter name="" value=""/> |
---|---|
Description | The parameter elements incorporate the transition of the underlying resource by changing the environment during the state transition by providing the necessary arguments for the methods defined in the business class which is declared by the class attribute within the <execution> element. The value of the name attribute can be given any name, but it has to be referred by the given name at the back end class defined within the <execution> element. If we omit the <parameter> element under the <execution> element during the state transition, the underlying resource does not move its environment(its storage path). |
Mandatory/Optional | Optional |
Attributes of the Element
Attribute | Description | Type | Default Value | Fixed Values | Mandatory/Optional | Notes |
---|---|---|---|---|---|---|
name | The 'name' attribute is referred by the business logic defined in the 'class' attribute of the <execution> element. | String | N/A |
| Mandatory | User should define a name for the given name attribute of the <parameter> element. It does not have any default values. Parameter will be referred later on by its name. |
value | The 'value' attribute is used to compute the parameter's logic. | String | N/A | N/A | 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. The value of the media types are predefined. Those values can't be changed. |
Sample Implementations
Code Block |
---|
<execution forEvent="Promote" class="org.wso2.carbon.governance.registry.extensions.executors.ServiceVersionExecutor">
<parameter name="currentEnvironment" value="/_system/governance/branches/testing/{@resourcePath}/{@version}/{@resourceName}"/>
<parameter name="targetEnvironment" value="/_system/governance/branches/production/{@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> |
...
<ui>
Anchor | ||||
---|---|---|---|---|
|
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. |
Type | |
Default Value | |
Fixed Values | |
Mandatory/Optional |
...
Attribute | Description | Type | Default Value | Fixed Values | Mandatory/Optional | Notes |
---|---|---|---|---|---|---|
forEvent | Defines the event for which this UI will be presented. | |||||
href | Defines the hyperlink that will be opened and presented to the user, when a lifecycle operation is performed from the Management Console. |
Sample Implementations
...
<transition>
Anchor |
---|
...
|
...
|
...
XML Syntax | <transition event="" target=""/> |
---|---|
Description |
...
Defines the transitions of a state. In Governance Registry 4.1.1, users are allowed to define the transitions (the name and the target state) instead of using static transitions. Previously, the configuration did not have a direct method of defining the transition event names or, most importantly, the target of the transition. There were only two transitions that were supported by default. With the new, SCXML-based configuration model, any number of transitions from one state are supported. Also, this model has the capacity to define the target state of the transition |
...
and the name of the event as well. | |
Type | |
Default Value | |
Fixed Values | |
Mandatory/Optional |
Attributes of the Element
Attribute | Description | Type | 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. |
...
target | Defines the target state of the transition. |
Sample Implementations
Excerpt | ||
---|---|---|
| ||
The description of lifeCycle configuration model and its elements. |