Difference between revisions of "GVExample TestProperty"

From GreenVulcano Wiki
Jump to: navigation, search
(Testing with {{GVCONSOLE}})
({{VULCON}} Configuration)
 
(4 intermediate revisions by one other user not shown)
Line 8: Line 8:
 
=={{VULCON}} Configuration==
 
=={{VULCON}} Configuration==
  
The preferred mode for creating a [[Service]] (at least its skeleton) is through the Service Wizard. Before using it you must first define a new [[Group]], [[System]] and [[Channel]], if you do not want to use those already present, and then start the Wizard.
+
There are more ways to create and configure a [[Service]] with {{GVESB}}: using the Service Wizard, by drag and drop into the Editor panel or directly from the {{L_VULCON}} core view. Because of the simplicity of this service we preferred to create and configure it using the Editor panel. First we must define a new [[Group]], [[System]] and [[Channel]], if you do not want to use those already present.
  
 
From the core view:
 
From the core view:
Line 19: Line 19:
 
# Click on this new Channel element and set the property ''id_channel''. We named it TEST_CHANNEL.
 
# Click on this new Channel element and set the property ''id_channel''. We named it TEST_CHANNEL.
  
For creating a new service using the Wizard execute the following steps:
+
Create a new service:
# From the Core View of {{VULCON}}. Right click the element Services -> Wizard New Service
+
# From the Core View of {{VULCON}}, right click the element Services -> Insert After (Insert Before) -> Service*
# A new window will be open where you can set the name of the Service you want to create, in this case we name it TestProperty, and as Group, we use TEST_GROUP. You can also select the scenario, for this example it will be [[Paradigms_of_communication#synchronous-synchronous|synchronous-synchronous]]. Click next.
+
# Set the Service properties: id-service as TestProperty, and group-name as TEST_GROUP.
# Set System as GVESB_TEST and Channel as TEST_CHANNEL. Then finish.
+
# Add into the Service TestProperty just created a new Operation: right click the element Service -> Insert After -> Operation*
 +
# Set the Operation property name as Request
 +
# Create a Participant: right click the element Operation -> Insert After (Insert Before) -> Participant*
 +
# Set the parameters id-system as GVESB_TEST and id-channel as TEST_CHANNEL.
  
[[File:GVExamples_TestProperty1.jpg|thumb|TestProperty Service]]As you can see from the core view, inside the Services element, a new Service named TestProperty has been created. The editor will be opened automatically, showing a workflow that must be modified successively as seen in the picture.
+
[[File:GVExamples_TestProperty1.jpg|thumb|TestProperty Service]]Now, you are able to configure your flow from the Editor view as seen in the picture. To do that right click the Operation element -> Open editor.  
  
 
Expand the [[Palette]] if it is not already visible from the Editor View. This can be done by clicking into a little arrow head present into the Editor right top corner. The steps are:
 
Expand the [[Palette]] if it is not already visible from the Editor View. This can be done by clicking into a little arrow head present into the Editor right top corner. The steps are:
 
# Add a [[Main_nodes|ChangeGVBuffer Node]]:  
 
# Add a [[Main_nodes|ChangeGVBuffer Node]]:  
## From the Palette drag and drop into the editor a ChangeGVBuffer Node. [[File:GVExamples_TestProperty2.jpg|thumb|Adding a ChangeGVBuffer Node]]A new windows will be open where you can set the element id and its input GVBuffer name. In this example we set
+
## From the Palette drag and drop into the editor a ChangeGVBuffer Node. [[File:GVExamples_TestProperty2.jpg|thumb|Adding a ChangeGVBuffer Node]]A new windows will be open where you can set the element id. In this example we set
#* id: test_property
+
##* id: test_property
#* input: data <br/> Then -> Next
+
##* input: data
## Choose the Virtual Layer Operation you need: in this case we add a [[ChangeGVBuffer]]. Then -> Next 
+
## From the Palette drag and drop into the editor an EndNode Node. A new windows will be open where you can set the element id. In this example we set
## You can also set an Operation Level 2: As we want to define some Properties, we select a PropertyDef.
+
##* id: end
## Set the property name as SQL and the value as <nowiki>sql{{ds.gv_test::select 'OK' from dual}}</nowiki>. Then -> Finish.
 
# Add an [[Main_nodes|End Node]]:
 
## From the Palette drag and drop into the editor a EndNode Node. A new windows will be open where you can set the element id. In this example we set
 
#* id: end. <br/> Then -> Finish
 
 
# Create the connections:  
 
# Create the connections:  
 
## From the Palette click into the Default Connection (black arrow)
 
## From the Palette click into the Default Connection (black arrow)
## Create a connection between the Star Node and ''test_property'' ChangeGVBuffer Node. This is done by clicking first the Start Node and then the ''test_property'' node.  
+
## Create a connection between the Start Node and ''test_property'' ChangeGVBuffer Node. This is done by clicking first the Start Node and then the ''test_property'' node.  
 
## Create another Default Connection between  ''test_property'' ChangeGVBuffer Node and ''end'' node.
 
## Create another Default Connection between  ''test_property'' ChangeGVBuffer Node and ''end'' node.
 
# Save the Editor in the Eclipse Main Menu and close it. You can reopen it from the Core View by right clicking the respective element [[Operation]].
 
# Save the Editor in the Eclipse Main Menu and close it. You can reopen it from the Core View by right clicking the respective element [[Operation]].
Line 45: Line 44:
 
The flow is already created. Refresh the Core view in the apposite icon. Check from that the workflow elements will be configured as follow:  
 
The flow is already created. Refresh the Core view in the apposite icon. Check from that the workflow elements will be configured as follow:  
  
Service: group-name="TEST_GROUP", id-service="TestProperty", service-activation="on", statistics="off"
+
:Service: group-name="TEST_GROUP", id-service="TestProperty", service-activation="on", statistics="off"
Operation: name="Request", operation-activation="on"
+
:Operation: name="Request", operation-activation="on"
Participant: id-channel="TEST_CHANNEL", id-system="GVESB_TEST"
+
:Participant: id-channel="TEST_CHANNEL", id-system="GVESB_TEST"
The following table shows the parameters to be defined for nodes and subelements added:
+
 
 +
The following table shows the parameters to be defined for nodes and sub-elements added:
 
{|class="gvtable"
 
{|class="gvtable"
 
! Node !! Attribute
 
! Node !! Attribute
 
|-
 
|-
| ChangeGVBufferNode || id="set_properties" <br/>input="input"<br/> next-node-id="return_status"<br/>output="output"
+
| [[ChangeGVBufferNode]] || id="set_properties" <br/>input="input"<br/> next-node-id="return_status"<br/>output="output"
 
|-
 
|-
 
| ChangeGVBufferNode/ChangeGVBuffer || clear-data="false"
 
| ChangeGVBufferNode/ChangeGVBuffer || clear-data="false"
Line 61: Line 61:
 
|}                                 
 
|}                                 
  
We added more properties in order to illustrate some {{GVESB}} [[Placeholders]]. You can add more PropertyDef elements by right clicking the ''ChangeGVBuffer'' element present in the ChangeGVBufferNode -> Insert After -> PropertyDef. The defined properties are:
+
We added more properties in order to illustrate some {{GVESB}} [[Placeholders]]. You can add more PropertyDef elements by right clicking the ''ChangeGVBuffer'' element present in the [[ChangeGVBufferNode]] -> Insert After -> PropertyDef. The defined properties are:
 
{|class="gvtable"
 
{|class="gvtable"
 
! PropertyDef name !! value
 
! PropertyDef name !! value
Line 85: Line 85:
  
 
[[File:GVExamples_TestProperty3.jpg|thumb|TestProperty configuration]]Before finishing you must control that the {{VULCON}} Configuration has not errors. Errors are indicated by a red cross into the element icon.
 
[[File:GVExamples_TestProperty3.jpg|thumb|TestProperty configuration]]Before finishing you must control that the {{VULCON}} Configuration has not errors. Errors are indicated by a red cross into the element icon.
# As we can see, it is present an error in the ''end'' node. Clicking this element we realize that is missing the output field.
+
# Review all the properties just configured
# Set the parameter ''output'' as the ''output'' of the preceding node, that of ''test_property'' node.
 
# On clicking ''test_property'' element we see that the output has been setted automatically to ''output_1''. You can change this value or set it if is not present. We changed it to ''output''.
 
# Set the ''end'' element attribute output as ''output'' too.
 
 
# Save your changes using the Save icon present in the [[The_views|Core View]].
 
# Save your changes using the Save icon present in the [[The_views|Core View]].
  
Line 117: Line 114:
 
# Click OK.
 
# Click OK.
  
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{GVCONSOLE}} section [[Testing]]. In this section you can finally test your new service:
+
[[File:GVExamples_TestPropertyOutput.jpg|thumb|Testing TestProperty]]Go to the {{GVCONSOLE}} section [[Testing]]. In this section you can finally test your new service:
 
# Into the Service field select TestProperty
 
# Into the Service field select TestProperty
 
# Into the System field select GVESB_TEST (Optional)
 
# Into the System field select GVESB_TEST (Optional)

Latest revision as of 13:46, 28 May 2014

Description

TestProperty service shows the use of the various metadata. This example is limited to create some properties and set its value with the scope of illustrating how metadata can be used. But shows also how to construct the possible properties that you will need in more complex flows.


For more information about metadata (or placeholders) click here.

VulCon Configuration

There are more ways to create and configure a Service with GreenVulcano® ESB: using the Service Wizard, by drag and drop into the Editor panel or directly from the VulCon® core view. Because of the simplicity of this service we preferred to create and configure it using the Editor panel. First we must define a new Group, System and Channel, if you do not want to use those already present.

From the core view:

  1. Right click the element Groups -> Insert after (or Insert before) -> Group. A new element Group will be created.
  2. Click on the Group new element and set the attribute id-group from the Properties View. We named it TEST_GROUP.
  3. Expand the GVSystems item.
  4. Right clicking on Systems, insert-after -> System. A new element System will be created.
  5. Set the System parameters in the Properties panel. We named it GVESB_TEST
  6. You can insert a new Channel right clicking the new System element -> Insert after (or Insert before) -> Channel*. A new Channel element will be created
  7. Click on this new Channel element and set the property id_channel. We named it TEST_CHANNEL.

Create a new service:

  1. From the Core View of VulCon, right click the element Services -> Insert After (Insert Before) -> Service*
  2. Set the Service properties: id-service as TestProperty, and group-name as TEST_GROUP.
  3. Add into the Service TestProperty just created a new Operation: right click the element Service -> Insert After -> Operation*
  4. Set the Operation property name as Request
  5. Create a Participant: right click the element Operation -> Insert After (Insert Before) -> Participant*
  6. Set the parameters id-system as GVESB_TEST and id-channel as TEST_CHANNEL.
TestProperty Service

Now, you are able to configure your flow from the Editor view as seen in the picture. To do that right click the Operation element -> Open editor.

Expand the Palette if it is not already visible from the Editor View. This can be done by clicking into a little arrow head present into the Editor right top corner. The steps are:

  1. Add a ChangeGVBuffer Node:
    1. From the Palette drag and drop into the editor a ChangeGVBuffer Node.
      Adding a ChangeGVBuffer Node
      A new windows will be open where you can set the element id. In this example we set
      • id: test_property
      • input: data
    2. From the Palette drag and drop into the editor an EndNode Node. A new windows will be open where you can set the element id. In this example we set
      • id: end
  2. Create the connections:
    1. From the Palette click into the Default Connection (black arrow)
    2. Create a connection between the Start Node and test_property ChangeGVBuffer Node. This is done by clicking first the Start Node and then the test_property node.
    3. Create another Default Connection between test_property ChangeGVBuffer Node and end node.
  3. Save the Editor in the Eclipse Main Menu and close it. You can reopen it from the Core View by right clicking the respective element Operation.

The flow is already created. Refresh the Core view in the apposite icon. Check from that the workflow elements will be configured as follow:

Service: group-name="TEST_GROUP", id-service="TestProperty", service-activation="on", statistics="off"
Operation: name="Request", operation-activation="on"
Participant: id-channel="TEST_CHANNEL", id-system="GVESB_TEST"

The following table shows the parameters to be defined for nodes and sub-elements added:

Node Attribute
ChangeGVBufferNode id="set_properties"
input="input"
next-node-id="return_status"
output="output"
ChangeGVBufferNode/ChangeGVBuffer clear-data="false"
ChangeGVBufferNode/ChangeGVBuffer/PropertyDef name="SQL"
value="sql{{ds.gv_test::select 'OK' from dual}}"
GVEndNode id="return_status"
output="output"

We added more properties in order to illustrate some GreenVulcano® ESB Placeholders. You can add more PropertyDef elements by right clicking the ChangeGVBuffer element present in the ChangeGVBufferNode -> Insert After -> PropertyDef. The defined properties are:

PropertyDef name value
SQL sql{{ds.gv_test::select 'OK' from dual}}
SQLLIST [sqllist{{ds.gv_test::select name from city order by 1}}]
TIMESTAMP timestamp{{yyyyMMdd HH:mm:ss}}
OGNL Service: ognl{{#object.getService()}}
JAVASCRIPT System: js{{gvesb::object.getSystem()}}
SYSTEM Server Name: ${{jboss.server.name}}
CLASS %{{fqclass}}
DECODE decode{{ognl{{#object.getProperty('SQL')}}::OK::Sql OK::Sql KO}}
MINUTE Minute decode{{js{{gvesb::timestamp{{mm}} % 2 == 0}}::true::EVEN::ODD}}
TestProperty configuration

Before finishing you must control that the VulCon Configuration has not errors. Errors are indicated by a red cross into the element icon.

  1. Review all the properties just configured
  2. Save your changes using the Save icon present in the Core View.
Exporting configuration

Once the flow is correctly configured, you can export the configuration and pass it to the GreenVulcano® ESB import tool, in order to add into GreenVulcano® ESB the service just created.

  1. The Export function is available in the view "Project". Expand your project
  2. Before you proceed, press F5 to refresh the file list.
  3. Right click the conf folder. It will open a drop-down list.
  4. Export your project as a compressed file.

Testing with GV Console

It is finally the time to test your project. To do that execute the following steps:

Deploy new Service

To deploy the new Service follow this steps:

  1. Start GreenVulcano® ESB
  2. Access to the GV Console.
  3. In the Deploy New Service section click Browse and select the file where you saved the VulCon configuration.
  4. Click Submit.

The section Deploy Services will be open. In this section you can select the services you want to deploy.

  1. Clicking on service TestProperty a new view will be showed containing the file GVCore.xml present in local and on server side.
  2. Click Deploy. Now you can save the document and write some notes about it.
  3. Save the Document. By saving you will return to the Deploy Service section.
GV Console Utility section

Now pass to the GV Console section Utility.

  1. Click on Reload configuration
  2. Select GVCore.xml and then Reload. A new windows will be open to confirm the operation
  3. Click OK.
Testing TestProperty

Go to the GV Console section Testing. In this section you can finally test your new service:

  1. Into the Service field select TestProperty
  2. Into the System field select GVESB_TEST (Optional)
  3. Click Request

When the service completes, the Testing view will be expanded for containing the GVBUFFER OUTPUT. Standard fields and the detailed GVBuffer are described in the Output File Name (the default location is $GV_HOME/log/TestOutput.txt).

In case of error or exceptions you can review the logs file present in the folder $GV_HOME/log/.