https://gvwiki.greenvulcano.com/gvwiki/api.php?action=feedcontributions&feedformat=atom&user=D.francoGreenVulcano Wiki - User contributions [en]2026-04-13T04:38:00ZUser contributionsMediaWiki 1.31.7https://gvwiki.greenvulcano.com/gvwiki/index.php?title=Imap-manage-call&diff=4505Imap-manage-call2016-03-11T18:09:09Z<p>D.franco: Created page with "==Description== {{GVESB}} plugin for managing emails through IMAP protocol. The message on wich operate is identified by its InternetMessageId contained into the '''MESSAGE_ID'..."</p>
<hr />
<div>==Description==<br />
<br />
{{GVESB}} plugin for managing emails through IMAP protocol.<br />
<br />
The message on wich operate is identified by its InternetMessageId contained into the '''MESSAGE_ID''' property of the input GVBuffer.<br />
<br />
The property '''MANAGED_MESSAGE_COUNT''' in the output [[GVBuffer]] contains the number:<br />
* 0 : no message processed<br />
* 1 : message <MESSAGE_ID> processed<br />
<br />
=={{VULCON}} / {{GVCONSOLE}} Configuration==<br />
<br />
The imap-manage-call Element is used by [[Channel]], [[routed-call]]. Its attributes are:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''call'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.imap.ManageEmailCallOperation'''.<br />
|-<br />
| name || required || Operation name. Used in the [[Flow]] section to associate workflow nodes to VCL operations.<br />
|-<br />
| jndi-name || optional || JNDI name of the mail Session configured in the application server.<br />
|-<br />
| folderFrom || optional || Folder from wich read email. Default to Inbox.<br />
|-<br />
| folderTo || optional || Folder on wich copy/move email.<br />
|-<br />
| action || required || Action to execute on message:<br />
* copy<br />
* move<br />
* delete<br />
* set-read<br />
* set-unread<br />
|}<br />
<br />
It has the following sub-elements:<br />
* [[Description]]</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=Imap-call&diff=4504Imap-call2016-03-11T17:32:06Z<p>D.franco: </p>
<hr />
<div>==Description==<br />
Use this {{GVESB}} plugin if you want to receive an email using IMAP protocol.<br />
<br />
=={{VULCON}} / {{GVCONSOLE}} Configuration==<br />
<br />
{{GVESB}} allows you to receive emails using the imap-call plugin. Received messages are translated into an XML document that describes the content of the message and its attachments if presents. <br />
<br />
The imap-call element is used by [[Channel]] and [[routed-call]] and has the following attributes:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''call'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.imap.IMAPCallOperation'''.<br />
|-<br />
| name || required || Operation name. Used in the 'Flow' section to associate workflow nodes to VCL operations.<br />
|-<br />
| jndi-name || required || JNDI name of the mail Session configured in the application server.<br />
The mail Sessions can be configured using the file ''mail-service.xml'' present into the folder //GV_HOME/application/deploy<br />
|-<br />
| override-protocol-host || optional || Corresponds to the property mail.protocol.host and overwrites the value of property mail.host specified in the configuration of the mail Session.<br />
|-<br />
| override-protocol-user || optional || Corresponds to the property mail.protocol.user and overwrites the value of property mail.user specified in the configuration of the mail Session.<br />
|-<br />
| delete-messages || optional || Mark a processed message as DELETED. Default false.<br />
|-<br />
| expunge || optional || Expunge (permanently remove) messages marked DELETED. Default false.<br />
|-<br />
| email-rx-cleaner || optional || RegExp pattern for email address cleaning. <br/> Default "[A-z][A-z0-9_]*([.][A-z0-9_]+)*[@][A-z0-9_]+([.][A-z0-9_]+)*[.][A-z]{2,4}".<br />
|-<br />
| export-EML || optional || Also export a message in EML format. Default false.<br />
|-<br />
| max-read-messages || optional || Maximum number of emails to be read. Default 10, a value of -1 means read all.<br />
|}<br />
<br />
The imap-call configuration node may contain the following sub-elements<br />
<br />
* Description<br />
* [[JNDIHelper]]<br />
* [[mail-properties]]</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=Imap-call&diff=4503Imap-call2016-03-11T17:15:05Z<p>D.franco: Created page with "==Description== Use this {{GVESB}} plugin if you want to receive an email using IMAP protocol. =={{VULCON}} / {{GVCONSOLE}} Configuration== {{GVESB}} allows you to receive emai..."</p>
<hr />
<div>==Description==<br />
Use this {{GVESB}} plugin if you want to receive an email using IMAP protocol.<br />
<br />
=={{VULCON}} / {{GVCONSOLE}} Configuration==<br />
<br />
{{GVESB}} allows you to receive emails using the pop-call plugin. Received messages are translated into an XML document that describes the content of the message and its attachments if presents. <br />
<br />
The pop-call element is used by [[Channel]] and [[routed-call]] and has the following attributes:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''call'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.imap.IMAPCallOperation'''.<br />
|-<br />
| name || required || Operation name. Used in the 'Flow' section to associate workflow nodes to VCL operations.<br />
|-<br />
| jndi-name || required || JNDI name of the mail Session configured in the application server.<br />
The mail Sessions can be configured using the file ''mail-service.xml'' present into the folder //GV_HOME/application/deploy<br />
|-<br />
| override-protocol-host || optional || Corresponds to the property mail.protocol.host and overwrites the value of property mail.host specified in the configuration of the mail Session.<br />
|-<br />
| override-protocol-user || optional || Corresponds to the property mail.protocol.user and overwrites the value of property mail.user specified in the configuration of the mail Session.<br />
|-<br />
| delete-messages || optional || Mark a processed message as DELETED. Default false.<br />
|-<br />
| expunge || optional || Expunge (permanently remove) messages marked DELETED. Default false.<br />
|-<br />
| email-rx-cleaner || optional || RegExp pattern for email address cleaning. <br/> Default "[A-z][A-z0-9_]*([.][A-z0-9_]+)*[@][A-z0-9_]+([.][A-z0-9_]+)*[.][A-z]{2,4}".<br />
|-<br />
| export-EML || optional || Also export a message in EML format. Default false.<br />
|-<br />
| max-read-messages || optional || Maximum number of emails to be read. Default 10, a value of -1 means read all.<br />
|}<br />
<br />
The imap-call configuration node may contain the following sub-elements<br />
<br />
* Description<br />
* [[JNDIHelper]]<br />
* [[mail-properties]]</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=FieldFormatters&diff=4495FieldFormatters2016-02-05T17:40:05Z<p>D.franco: </p>
<hr />
<div>=={{GVESB}} Configuration==<br />
<br />
The FieldFormatters Element is used by: <br />
* [[DBOFlatSelect]]<br />
* [[DBOMultiFlatSelect]]<br />
* [[DBOSelect]]<br />
* [[DBOThreadSelect]]<br />
<br />
The following table shows its attributes:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| id || required || Must match the @id of the statement on which output apply the formatters.<br />
The attribute's value cannot be null.<br />
|}<br />
<br />
Might contain the sub-elements:<br />
* [[Description]] <br />
* [[#FieldFormatter|FieldFormatter]]<br />
<br />
<br />
===FieldFormatter===<br />
<br />
The FieldFormatter element is used to force the Database table fields formatting.<br />
<br />
It is used by: [[FieldFormatters]].<br />
<br />
The following table shows the FieldFormatter element's attributes:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''field-formatter'''.<br />
|-<br />
| field-id || optional || Comma-separated list of 0-based positions of fields on which the formatter applies<br />
|-<br />
| field-name || optional || Comma-separated list of names of fields on which the formatter applies<br />
|-<br />
| number-format || optional || Default to "#,##0.###"<br />
|-<br />
| decimal-separator || optional || Default to ","<br />
|-<br />
| grouping-separator || optional || Default to "."<br />
|-<br />
| date-format || optional || Default to "yyyyMMdd HH:mm:ss"<br />
|-<br />
| field-length || optional || Default to "64"<br />
|-<br />
| filler-char || optional || Default to " "<br />
|-<br />
| terminator-char || optional || Default to ""<br />
|-<br />
| trim (none&#124;both&#124;right&#124;left) || optional || Default to "none"<br />
|-<br />
| padding || optional || Default to "none"<br />
|}<br />
<br />
Might contain the sub-element:<br />
* [[Description]]</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_CCardPay&diff=4247GVExample CCardPay2014-06-02T22:06:56Z<p>D.franco: /* {{GVCONSOLE}} Configuration */</p>
<hr />
<div>==Description==<br />
<br />
This service has the purpose of showing how {{GVESB}} uses [[DataHandler]] to query a DB and implement [[Web Services]].<br />
<br />
CCardPay Service executes the following operations:<br />
# Receives a [[Web Services|Web Service]] request from client, with a credit card number to be controlled.<br />
# If this card is locally managed, reads the data from DB using [[DataHandler]]. <br />
# If this card is managed by an external system, forwards a Web Service request to that system.<br />
# Returns the response to the client<br />
<br />
=={{VULCON}} Configuration==<br />
<br />
To configure CCardPay service follow these steps:<br />
# Define [[System|Systems]], [[Channel|Channels]] and [[Operation|Operations]]<br />
# Define the [[Service|Services]]<br />
# Implement the [[Flow|flows]].<br />
<br />
===Defining Systems, Channels, Operations and XPath===<br />
<br />
For this exercise, you need first of all to define an XPath for querying web services. This can be made in {{VULCON}} core view, simply by right-clicking on the element '''GVHpath/XPath''' and then selecting Insert after (or Insert before) -> XPathNamespace. Then fill the ampty field as in the following table.<br />
<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| XPathNamespace || namespace="http://www.credit.com/services"<br/>prefix="cred"<br />
|}<br />
<br />
In order to define a System, go to {{VULCON}} core view and insert the System CREDIT. Inside of it create the Channel CHANNEL_CREDIT_WS in order to create an "internal" [[Participant]]. We also create the System CREDIT_EXTERNAL with the Channel CHANNEL_CREDIT_EXT corresponding to an "external" [[Participant]]. <br />
<br />
Note that the easiest way to configure a [[Web Services|Web service]] with {{L_VULCON}} is using the Wizard. We start from a [http://en.wikipedia.org/wiki/Web_service Web Service] WSDL, that describes a withdrawal operation on a credit card.<br />
<br />
From the Core view of {{L_VULCON}}, right clicking the Services element, launch the [[Wizard Call Web Service]] and, after selecting the WSDL file -in this example we use [[ExternalCreditService.wsdl]] present in folder <nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl-, choose the parameters to create the {{GVESB}} service.<br />
<br />
Two new Services, Pay and Query, and two [[ws-call]] operations, pay and query, will be created into the System CREDIT, channel CREDIT_EXTERNAL. We change those names to CCardPay and CCardQuery for the services, PayExternal and QueryExternal for the [[ws-call]] operations respectively. Now is possible to modify the workflow.<br />
<br />
From the {{L_VULCON}} Core view, element System "CREDIT" -> Channel "CHANNEL_CREDIT_WS", insert a [[dh-call]] operation and set its attributes and sub-elements as follow:<br />
<br />
* [[dh-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[dh-call]] || name="DataHandler"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]] || name="CCardPay" <br/> jdbc-connection-name="ds.gv_test" <br/> <br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="decimal-separator" value="."<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="grouping-separator" value=","<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="format" value="#0.00"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]] || name="CCardPay" <br/> transformation="CCardPay" <br/> type="dbo"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]]/[[statement]] || id="0" <br/> type="update"<br />
update CREDIT_CARD set CREDIT= CREDIT - ?<br />
where CNUMBER=?<br />
and ENABLED='Y'<br />
and CREDIT >= ?<br />
|}<br />
<br />
The operation defined in the DataHandler makes use of the ''data-transformation'' module for the data transformations that allow to have data in XML format. So, you need to define the following parameters into the [[GVDataTransformation]] section:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[GVDataTransformation#DataSourceSet|DataSourceSet]]/[[GVDataTransformation#LocalFSDataSource|LocalFSDataSource]] || formatHandled="xsl" name="XSLDataSource" <br/> repositoryHome=<nowiki>"${{gv.app.home}}/gvdte/datasource/xsl"</nowiki> <br/> type="datasource" <br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="CCardPay" DataSourceSet="Default" <br/> XSLMapName="DataHandler/CREDIT/[[CCardPay.xsl]]"<br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalInput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalInput.xsl]]" <br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalOutput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalOutput.xsl]]" <br/> type="transformation"<br />
|}<br />
<br />
Now define a [[ws-call]] operation into [[System]] CREDIT_EXTERNAL -> [[Channel]] CHANNEL_CREDIT_EXT. Its attributes and sub-elements defined will be set as:<br />
* [[ws-call]]:<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| [[ws-call]] || name="PayExternal"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]] || operation="Pay" <br/> ref-dp="EXTERNAL::PayWSDataProvider"<br/> returnType="body-element"<br/> type="invoker"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/WSDLInfo || type="wsdlinfo"<br/>wsdl="file://<nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl/[[ExternalCreditService.wsdl]]"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/BasicHttpAuth || user="xmlp<nowiki>{{ws.auth.user}}</nowiki>"<br/>password="xmlp<nowiki>{{ws.auth.password}}</nowiki>"<br />
|}<br />
<br />
The ws-call operation already defined makes use of the [[Data provider]] module. So, you need to define the following parameters into the [[GVDataProviderManager]] section, present in the Adapter Core View of {{L_VULCON}}:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[Axis2MessageContextDataProvider]] || name="EXTERNAL::PayWSDataProvider"<br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field || direction="OUT" key="message"<br/><br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field/Expression || type="ognl"<br />
envelope.body.addChild(@org.apache.axis2.util.XMLUtils<br />
@toOM(#input.object.getDocumentElement()))<br />
|}<br />
<br />
===Flow implementation===<br />
<br />
[[File:GVExamplesCCardPayFlow.jpg|thumb|CCardPay flow]] In order to define the CCardPay service [[Flow]] design it as shown in the picture:<br />
<br />
<br />
The service receives a Web Service request from a client with a credit card number. If this card is managed locally, reads its data using [[DataHandler]], otherwise forwards the request to an external system using [[Web Services]].<br />
<br />
<br />
The following table shows the parameters to be defined for each Flow node:<br />
<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| first-node || Prepare<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]] || condition="isInternalCCard"<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]]/Property || name="IS_INTERNAL" operator="equal"<br/>type="gvbuffer-field"<br/>value="true"<br/>value-type="text"<br />
|-<br />
| [[ChangeGVBufferNode]] || dump-in-out="true" <br/>id="prepare" <br/>input="input" <br/>next-node-id="check_internal"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]] || clear-data="false"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="CNUMBER"<br/><nowiki>value="js{{gvesb::var doc=XMLUtils.parseObject_S(object.getObject(),false,true); XMLUtils.get_S(doc,'//cred:cnumber')}}"</nowiki><br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="IS_INTERNAL"<br/>value="sql{{ds.gv_test::select decode(count(*), 1, 'true', 'false') from credit_card where cnumber=ognl{{#object.getProperty('CNUMBER')}}}}"<br />
|-<br />
| [[GVNodeCheck]] || default-id="pay_external"<br/> id="check_internal"<br/> input="input" <br/>on-exception-id="end" <br />
|-<br />
| [[GVNodeCheck]]/GVRouting || condition="isInternalCCard" <br/>next-node-id="pay_internal"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/>id="pay_internal" <br/>id-system="CREDIT" <br/>input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="DataHandler" <br/>output="output"<br />
|-<br />
| [[GVOperationNode]]/InputServices/dh-selector-service || critical="yes"<br/>internal="yes"<br/> type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/dh-selector-service/dh-selector-call || DH_SERVICE_NAME="CCardPay"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/> id="pay_external" <br/>id-system="CREDIT_EXTERNAL" <br/> input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="PayExternal"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/gvdte-context-call || name="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalOutput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/gvdte-context-call || name="PayExternalOutput"<br />
|-<br />
| [[GVEndNode]] || end-business-process="yes" <br/>id="end" <br/>op-type="end" <br/>output="output"<br />
|}<br />
<br />
=={{GVCONSOLE}} Configuration==<br />
<br />
It is time to deploy and test your new Service. To do that follow these steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} Configuration file as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Browse... and select the file where you have saved the {{L_VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service CCardPay a new view will be open containing the file GVCore.xml present in local and in server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. Saving you return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{L_GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapters.xml and then Reload.<br />
# Confirm the operation.<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{L_GVCONSOLE}} section [[Testing]]. In this section you can finally test your new services:<br />
# From the Service list select CCardQuery<br />
# From the System list select CREDIT_EXTERNAL<br />
# Select the Payload on input containing the credit card number you want to use and the amount to reduce from.<br />
# Click RequestReply<br />
<br />
The Testing View will be expanded and it is also possible to view the GVBuffer Output panel where there are present some properties, among these the REC_READ property set to 1, representing the number of record read from DB. <br />
<br />
The file TestOutput.txt will be generated in the directory <nowiki>${{gv.app.home}}</nowiki>/log as previously set (see [[Testing]] area) containing information about the credit card numbers you passed in input and the number of records founded and updated.<br />
<syntaxhighlight lang="XML"><br />
<pre><br />
----------- TEST N. 0 2012.03.02 at 14:11:38 -----------<br />
Standard Field:<br />
system = CREDIT_EXTERNAL<br />
service = CCardPay<br />
id = 7F0001014F50AFC600014063<br />
retCode = 0<br />
GVBuffer: NULL<br />
<br />
Properties:<br />
REC_DISCARD = 0<br />
IS_INTERNAL = true<br />
REC_TOTAL = 1<br />
REC_UPDATE = 1<br />
REC_INSERT = 0<br />
REC_READ = 0<br />
CNUMBER = 1234123415555666<br />
REC_DISCARD_CAUSE = <br />
</pre><br />
</syntaxhighlight></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_CCardQuery&diff=4246GVExample CCardQuery2014-06-02T22:06:47Z<p>D.franco: /* {{GVCONSOLE}} Configuration */</p>
<hr />
<div>==Description==<br />
<br />
This service has the scope of showing how {{GVESB}} uses [[DataHandler]] for quering a DB and implements a [[Web Services]].<br />
<br />
CCardQuery Service executes the following operations:<br />
# Receives a [[Web Services|Web Service]] request from client, with a credit card number to be controlled.<br />
# If this card is locally managed, reads the data from DB using [[DataHandler]]. <br />
# If this card is managed by an external system, forwards a Web Service request to that system.<br />
# Returns the response to the client<br />
<br />
=={{VULCON}} Configuration==<br />
<br />
To configure CCardQuery service follow these steps:<br />
# Define [[System|Systems]], [[Channel|Channels]] and [[Operation|Operations]]<br />
# Define the [[Service|Services]]<br />
# Implement the [[Flow|flows]].<br />
<br />
===Defining Systems, Channels, Operations and XPath===<br />
<br />
For this exercise, you need first of all to define an XPath for querying web services. This can be made in {{VULCON}} core view, simply by right-clicking on the element '''GVHpath/XPath''' and then selecting Insert after (or Insert before) -> XPathNamespace. Then fill the ampty field as in the following table.<br />
<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| XPathNamespace || namespace="http://www.credit.com/services"<br/>prefix="cred"<br />
|}<br />
<br />
In order to define a System, go to {{VULCON}} core view and insert the System CREDIT. Inside of it create the Channel CHANNEL_CREDIT_WS in order to create an "internal" [[Participant]]. We also create the System CREDIT_EXTERNAL with the Channel CHANNEL_CREDIT_EXT corresponding to an "external" [[Participant]]. <br />
<br />
Note that the easiest way to configure a [[Web Services|Web service]] with {{L_VULCON}} is using the Wizard. We start from a [http://en.wikipedia.org/wiki/Web_service Web Service] WSDL, that describes a withdrawal operation on a credit card.<br />
<br />
From the Core view of {{L_VULCON}}, right clicking the Services element, launch the [[Wizard Call Web Service]] and, after selecting the WSDL file -in this example we use [[ExternalCreditService.wsdl]] present in folder <nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl-, choose the parameters to create the {{GVESB}} service.<br />
<br />
Two new Services, Pay and Query, and two [[ws-call]] operations, pay and query, will be created into the System CREDIT, channel CREDIT_EXTERNAL. We change those names to CCardPay and CCardQuery for the services, PayExternal and QueryExternal for the [[ws-call]] operations respectively. Now is possible to modify the workflow.<br />
<br />
From the {{L_VULCON}} Core view, element System "CREDIT" -> Channel "CHANNEL_CREDIT_WS", insert a [[dh-call]] operation and set its attributes and sub-elements as follow:<br />
<br />
* [[dh-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[dh-call]] || name="DataHandler"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]] || name="CCardQuery" <br/> jdbc-connection-name="ds.gv_test" <br/> <br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="decimal-separator" value="."<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="grouping-separator" value=","<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="format" value="#0.00"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOSelect]] || name="CCardQuery" <br/> transformation="CCardQuery" <br/> type="dbo" <br/><br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]]/[[statement]] || id="1" <br/> type="select" <br/> <br />
select p.NAME, cc.CNUMBER, cc.CREDIT, cc.ENABLED<br />
from PERSON p, CREDIT_CARD cc<br />
where p.ID = cc.ID_OWNER<br />
and cc.CNUMBER = <nowiki>@{{CNUMBER}}</nowiki><br />
|}<br />
<br />
The operation defined in the DataHandler makes use of the ''data-transformation'' module for the data transformations that allow to have data in XML format. So, you need to define the following parameters into the [[GVDataTransformation]] section:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[GVDataTransformation#DataSourceSet|DataSourceSet]]/[[GVDataTransformation#LocalFSDataSource|LocalFSDataSource]] || formatHandled="xsl" name="XSLDataSource" <br/> repositoryHome=<nowiki>"${{gv.app.home}}/gvdte/datasource/xsl"</nowiki> <br/> type="datasource" <br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="CCardQuery" DataSourceSet="Default" <br/> XSLMapName="DataHandler/CREDIT/[[CCardQuery.xsl]]"<br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="QueryExternalInput" DataSourceSet="Default" <br/> XSLMapName=" CREDIT_EXTERNAL/[[QueryExternalInput.xsl]]" <br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="QueryExternalOutput" DataSourceSet="Default" <br/> XSLMapName=" CREDIT_EXTERNAL/[[QueryExternalOutput.xsl]]" <br/> type="transformation"<br />
|}<br />
<br />
Now control that the [[ws-call]] element attributes and subelements defined into [[System]] CREDIT_EXTERNAL -> [[Channel]] CHANNEL_CREDIT_EXT will be set as:<br />
* [[ws-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[ws-call]] || name="QueryExternal"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]] || operation="Query" <br/> ref-dp="EXTERNAL::QueryWSDataProvider"<br/> returnType="body-element"<br/> type="invoker" <br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/WSDLInfo || type="wsdlinfo"<br/>wsdl="file://<nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl/[[ExternalCreditService.wsdl]]"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/BasicHttpAuth || user="xmlp<nowiki>{{ws.auth.user}}</nowiki>"<br/>password="xmlp<nowiki>{{ws.auth.password}}</nowiki>"<br />
|}<br />
<br />
The ws-call operation already defined makes use of the [[Data provider]] module. So, you need to define the following parameters into the [[GVDataProviderManager]] section, present in the Adapter Core View of {{L_VULCON}}:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[Axis2MessageContextDataProvider]] || name="EXTERNAL::PayWSDataProvider"<br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field || direction="OUT" key="message"<br/><br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field/Expression || type="ognl"<br />
envelope.body.addChild(@org.apache.axis2.util.XMLUtils<br />
@toOM(#input.object.getDocumentElement()))<br />
|}<br />
<br />
===Flow implementation===<br />
<br />
[[File:GVExamplesCCardQueryFlow.jpg|thumb|CCardQuery flow]] In order to define the CCardQuery service [[Flow]] design it as shown in the picture:<br />
<br />
<br />
The service receives a Web Service request from a client with a credit card number. If this card is managed locally, reads its data using [[DataHandler]], otherwise forwards the request to an external system using [[Web Services]].<br />
<br />
<br />
<br />
The following table shows the parameters to be defined for each Flow node:<br />
<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| first-node || Prepare<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]] || condition="isInternalCCard"<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]]/Property || name="IS_INTERNAL" operator="equal"<br/>type="gvbuffer-field"<br/>value="true"<br/>value-type="text"<br />
|-<br />
<br />
| [[ChangeGVBufferNode]] || dump-in-out="true" <br/>id="prepare" <br/>input="input" <br/>next-node-id="check_internal"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]] || clear-data="false"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="CNUMBER"<br/><nowiki>value="js{{gvesb::var doc=XMLUtils.parseObject_S(object.getObject(),false,true); XMLUtils.get_S(doc,'//cred:cnumber')}}"</nowiki><br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="sql{{ds.gv_test::select decode(count(*), 1, 'true', 'false') from credit_card where cnumber=ognl{{#object.getProperty('CNUMBER')}}}}"<br />
|-<br />
| [[GVNodeCheck]] || default-id="pay_external"<br/> id="check_internal"<br/> input="input" <br/>on-exception-id="end" <br />
|-<br />
| [[GVNodeCheck]]/GVRouting || condition="isInternalCCard" <br/>next-node-id="search_internal"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/>id="search_internal" <br/>id-system="CREDIT" <br/>input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="DataHandler" <br/>output="output"<br />
|-<br />
| [[GVOperationNode]]/InputServices/dh-selector-service || critical="yes"<br/>internal="yes"<br/> type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/dh-selector-service/dh-selector-call || DH_SERVICE_NAME="CCardQuery"<br/>name="setDBService"<br />
|-<br />
<br />
| [[GVOperationNode]] || dump-in-out="false" <br/> id="search_external" <br/>id-system="CREDIT_EXTERNAL" <br/> input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="QueryExternal"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/map-name-param || name="map-name" value="QueryExternalInput"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/gvdte-context-call || name="QueryExternalInput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/map-name-param || name="map-name" value="QueryExternalOutput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/gvdte-context-call || name="QueryExternalOutput"<br />
|-<br />
| [[GVEndNode]] || end-business-process="yes" <br/>id="end" <br/>op-type="end" <br/>output="output"<br />
|}<br />
<br />
=={{GVCONSOLE}} Configuration==<br />
<br />
It is time to deploy and test your new Service. To do that follow these steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} Configuration file as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Browse... and select the file where you have saved the {{L_VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service CCardQuery a new view will be open containing the file GVCore.xml present in local and in server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. Saving you return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{L_GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapters.xml and then Reload.<br />
# Confirm the operation.<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{L_GVCONSOLE}} section [[Testing]]. In this section you can finally test your new services:<br />
# From the Service list select CCardQuery<br />
# From the System list select CREDIT_EXTERNAL<br />
# Select the Payload on input containing the credit card number you want to test<br />
# Click RequestReply<br />
<br />
The Testing View will be expanded and it is also possible to view the GVBuffer Output panel where there are present some properties, among these the REC_READ property set to 1, representing the number of record read from DB. <br />
<br />
The file TestOutput.txt will be generated in the directory <nowiki>${{gv.app.home}}</nowiki>/log as previously set (see [[Testing]] area) containing information about owner, credit and state of the credit card number "1234123415555666" as passed in input.<br />
<syntaxhighlight lang="XML"><br />
<pre><br />
----------- TEST N. 0 2012.02.15 at 11:46:26 -----------<br />
Standard Field:<br />
system = CREDIT_EXTERNAL<br />
service = CCardQuery<br />
id = 7F0001014F3B87B900021429<br />
retCode = 0<br />
GVBuffer: class org.apache.xerces.dom.DocumentImpl<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<QueryResponse xmlns="http://www.credit.com/services"><br />
<name>MARIO BIANCHI</name><br />
<cnumber>1234123415555666</cnumber><br />
<credit>300.00000</credit><br />
<active>true</active><br />
</QueryResponse><br />
Properties:<br />
REC_DISCARD = 0<br />
IS_INTERNAL = true<br />
REC_TOTAL = 0<br />
REC_UPDATE = 0<br />
REC_INSERT = 0<br />
REC_READ = 1<br />
CNUMBER = 1234123415555666<br />
REC_DISCARD_CAUSE = <br />
</pre><br />
</syntaxhighlight></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_CCardQuery&diff=4245GVExample CCardQuery2014-06-02T21:48:44Z<p>D.franco: /* Flow implementation */</p>
<hr />
<div>==Description==<br />
<br />
This service has the scope of showing how {{GVESB}} uses [[DataHandler]] for quering a DB and implements a [[Web Services]].<br />
<br />
CCardQuery Service executes the following operations:<br />
# Receives a [[Web Services|Web Service]] request from client, with a credit card number to be controlled.<br />
# If this card is locally managed, reads the data from DB using [[DataHandler]]. <br />
# If this card is managed by an external system, forwards a Web Service request to that system.<br />
# Returns the response to the client<br />
<br />
=={{VULCON}} Configuration==<br />
<br />
To configure CCardQuery service follow these steps:<br />
# Define [[System|Systems]], [[Channel|Channels]] and [[Operation|Operations]]<br />
# Define the [[Service|Services]]<br />
# Implement the [[Flow|flows]].<br />
<br />
===Defining Systems, Channels, Operations and XPath===<br />
<br />
For this exercise, you need first of all to define an XPath for querying web services. This can be made in {{VULCON}} core view, simply by right-clicking on the element '''GVHpath/XPath''' and then selecting Insert after (or Insert before) -> XPathNamespace. Then fill the ampty field as in the following table.<br />
<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| XPathNamespace || namespace="http://www.credit.com/services"<br/>prefix="cred"<br />
|}<br />
<br />
In order to define a System, go to {{VULCON}} core view and insert the System CREDIT. Inside of it create the Channel CHANNEL_CREDIT_WS in order to create an "internal" [[Participant]]. We also create the System CREDIT_EXTERNAL with the Channel CHANNEL_CREDIT_EXT corresponding to an "external" [[Participant]]. <br />
<br />
Note that the easiest way to configure a [[Web Services|Web service]] with {{L_VULCON}} is using the Wizard. We start from a [http://en.wikipedia.org/wiki/Web_service Web Service] WSDL, that describes a withdrawal operation on a credit card.<br />
<br />
From the Core view of {{L_VULCON}}, right clicking the Services element, launch the [[Wizard Call Web Service]] and, after selecting the WSDL file -in this example we use [[ExternalCreditService.wsdl]] present in folder <nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl-, choose the parameters to create the {{GVESB}} service.<br />
<br />
Two new Services, Pay and Query, and two [[ws-call]] operations, pay and query, will be created into the System CREDIT, channel CREDIT_EXTERNAL. We change those names to CCardPay and CCardQuery for the services, PayExternal and QueryExternal for the [[ws-call]] operations respectively. Now is possible to modify the workflow.<br />
<br />
From the {{L_VULCON}} Core view, element System "CREDIT" -> Channel "CHANNEL_CREDIT_WS", insert a [[dh-call]] operation and set its attributes and sub-elements as follow:<br />
<br />
* [[dh-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[dh-call]] || name="DataHandler"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]] || name="CCardQuery" <br/> jdbc-connection-name="ds.gv_test" <br/> <br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="decimal-separator" value="."<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="grouping-separator" value=","<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="format" value="#0.00"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOSelect]] || name="CCardQuery" <br/> transformation="CCardQuery" <br/> type="dbo" <br/><br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]]/[[statement]] || id="1" <br/> type="select" <br/> <br />
select p.NAME, cc.CNUMBER, cc.CREDIT, cc.ENABLED<br />
from PERSON p, CREDIT_CARD cc<br />
where p.ID = cc.ID_OWNER<br />
and cc.CNUMBER = <nowiki>@{{CNUMBER}}</nowiki><br />
|}<br />
<br />
The operation defined in the DataHandler makes use of the ''data-transformation'' module for the data transformations that allow to have data in XML format. So, you need to define the following parameters into the [[GVDataTransformation]] section:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[GVDataTransformation#DataSourceSet|DataSourceSet]]/[[GVDataTransformation#LocalFSDataSource|LocalFSDataSource]] || formatHandled="xsl" name="XSLDataSource" <br/> repositoryHome=<nowiki>"${{gv.app.home}}/gvdte/datasource/xsl"</nowiki> <br/> type="datasource" <br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="CCardQuery" DataSourceSet="Default" <br/> XSLMapName="DataHandler/CREDIT/[[CCardQuery.xsl]]"<br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="QueryExternalInput" DataSourceSet="Default" <br/> XSLMapName=" CREDIT_EXTERNAL/[[QueryExternalInput.xsl]]" <br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="QueryExternalOutput" DataSourceSet="Default" <br/> XSLMapName=" CREDIT_EXTERNAL/[[QueryExternalOutput.xsl]]" <br/> type="transformation"<br />
|}<br />
<br />
Now control that the [[ws-call]] element attributes and subelements defined into [[System]] CREDIT_EXTERNAL -> [[Channel]] CHANNEL_CREDIT_EXT will be set as:<br />
* [[ws-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[ws-call]] || name="QueryExternal"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]] || operation="Query" <br/> ref-dp="EXTERNAL::QueryWSDataProvider"<br/> returnType="body-element"<br/> type="invoker" <br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/WSDLInfo || type="wsdlinfo"<br/>wsdl="file://<nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl/[[ExternalCreditService.wsdl]]"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/BasicHttpAuth || user="xmlp<nowiki>{{ws.auth.user}}</nowiki>"<br/>password="xmlp<nowiki>{{ws.auth.password}}</nowiki>"<br />
|}<br />
<br />
The ws-call operation already defined makes use of the [[Data provider]] module. So, you need to define the following parameters into the [[GVDataProviderManager]] section, present in the Adapter Core View of {{L_VULCON}}:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[Axis2MessageContextDataProvider]] || name="EXTERNAL::PayWSDataProvider"<br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field || direction="OUT" key="message"<br/><br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field/Expression || type="ognl"<br />
envelope.body.addChild(@org.apache.axis2.util.XMLUtils<br />
@toOM(#input.object.getDocumentElement()))<br />
|}<br />
<br />
===Flow implementation===<br />
<br />
[[File:GVExamplesCCardQueryFlow.jpg|thumb|CCardQuery flow]] In order to define the CCardQuery service [[Flow]] design it as shown in the picture:<br />
<br />
<br />
The service receives a Web Service request from a client with a credit card number. If this card is managed locally, reads its data using [[DataHandler]], otherwise forwards the request to an external system using [[Web Services]].<br />
<br />
<br />
<br />
The following table shows the parameters to be defined for each Flow node:<br />
<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| first-node || Prepare<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]] || condition="isInternalCCard"<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]]/Property || name="IS_INTERNAL" operator="equal"<br/>type="gvbuffer-field"<br/>value="true"<br/>value-type="text"<br />
|-<br />
<br />
| [[ChangeGVBufferNode]] || dump-in-out="true" <br/>id="prepare" <br/>input="input" <br/>next-node-id="check_internal"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]] || clear-data="false"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="CNUMBER"<br/><nowiki>value="js{{gvesb::var doc=XMLUtils.parseObject_S(object.getObject(),false,true); XMLUtils.get_S(doc,'//cred:cnumber')}}"</nowiki><br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="sql{{ds.gv_test::select decode(count(*), 1, 'true', 'false') from credit_card where cnumber=ognl{{#object.getProperty('CNUMBER')}}}}"<br />
|-<br />
| [[GVNodeCheck]] || default-id="pay_external"<br/> id="check_internal"<br/> input="input" <br/>on-exception-id="end" <br />
|-<br />
| [[GVNodeCheck]]/GVRouting || condition="isInternalCCard" <br/>next-node-id="search_internal"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/>id="search_internal" <br/>id-system="CREDIT" <br/>input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="DataHandler" <br/>output="output"<br />
|-<br />
| [[GVOperationNode]]/InputServices/dh-selector-service || critical="yes"<br/>internal="yes"<br/> type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/dh-selector-service/dh-selector-call || DH_SERVICE_NAME="CCardQuery"<br/>name="setDBService"<br />
|-<br />
<br />
| [[GVOperationNode]] || dump-in-out="false" <br/> id="search_external" <br/>id-system="CREDIT_EXTERNAL" <br/> input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="QueryExternal"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/map-name-param || name="map-name" value="QueryExternalInput"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/gvdte-context-call || name="QueryExternalInput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/map-name-param || name="map-name" value="QueryExternalOutput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/gvdte-context-call || name="QueryExternalOutput"<br />
|-<br />
| [[GVEndNode]] || end-business-process="yes" <br/>id="end" <br/>op-type="end" <br/>output="output"<br />
|}<br />
<br />
=={{GVCONSOLE}} Configuration==<br />
<br />
It is time to deploy and test your new Service. To do that follows these steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} Configuration file as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Sfoglia... (Browse) and select the file where you have saved the {{VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service CCardQuery a new view will be open containing the files GVCore.xml present in local and in server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. Saving you return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapters.xml and then Reload. A new windows will be open to confirm the operation<br />
# Click OK.<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{GVCONSOLE}} section [[Testing]]. In this section you can finally test your new services:<br />
# Into the Service voice select CCardQuery<br />
# Into the System voice select CREDIT_EXTERNAL<br />
# Select the Payload on input containing the credit card number you want to test<br />
# Click RequestReply<br />
<br />
The Testing View will be expanded and it is also possible to view the GVBuffer Output panel where there are present some properties, among these the REC_READ property set to 1, representing the number of record read from DB. <br />
<br />
The file TestOutput.txt will be generated in the directory <nowiki>${{gv.app.home}}</nowiki>/log as previously set (see [[Testing]] area) containing information about owner, credit and state of the credit card number "1234123415555666" as passed in input.<br />
<syntaxhighlight lang="XML"><br />
<pre><br />
----------- TEST N. 0 2012.02.15 at 11:46:26 -----------<br />
Standard Field:<br />
system = CREDIT_EXTERNAL<br />
service = CCardQuery<br />
id = 7F0001014F3B87B900021429<br />
retCode = 0<br />
GVBuffer: class org.apache.xerces.dom.DocumentImpl<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<QueryResponse xmlns="http://www.credit.com/services"><br />
<name>MARIO BIANCHI</name><br />
<cnumber>1234123415555666</cnumber><br />
<credit>300.00000</credit><br />
<active>true</active><br />
</QueryResponse><br />
Properties:<br />
REC_DISCARD = 0<br />
IS_INTERNAL = true<br />
REC_TOTAL = 0<br />
REC_UPDATE = 0<br />
REC_INSERT = 0<br />
REC_READ = 1<br />
CNUMBER = 1234123415555666<br />
REC_DISCARD_CAUSE = <br />
</pre><br />
</syntaxhighlight></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_CCardQuery&diff=4244GVExample CCardQuery2014-06-02T21:21:49Z<p>D.franco: /* Defining Systems, Channels, Operations and XPath */</p>
<hr />
<div>==Description==<br />
<br />
This service has the scope of showing how {{GVESB}} uses [[DataHandler]] for quering a DB and implements a [[Web Services]].<br />
<br />
CCardQuery Service executes the following operations:<br />
# Receives a [[Web Services|Web Service]] request from client, with a credit card number to be controlled.<br />
# If this card is locally managed, reads the data from DB using [[DataHandler]]. <br />
# If this card is managed by an external system, forwards a Web Service request to that system.<br />
# Returns the response to the client<br />
<br />
=={{VULCON}} Configuration==<br />
<br />
To configure CCardQuery service follow these steps:<br />
# Define [[System|Systems]], [[Channel|Channels]] and [[Operation|Operations]]<br />
# Define the [[Service|Services]]<br />
# Implement the [[Flow|flows]].<br />
<br />
===Defining Systems, Channels, Operations and XPath===<br />
<br />
For this exercise, you need first of all to define an XPath for querying web services. This can be made in {{VULCON}} core view, simply by right-clicking on the element '''GVHpath/XPath''' and then selecting Insert after (or Insert before) -> XPathNamespace. Then fill the ampty field as in the following table.<br />
<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| XPathNamespace || namespace="http://www.credit.com/services"<br/>prefix="cred"<br />
|}<br />
<br />
In order to define a System, go to {{VULCON}} core view and insert the System CREDIT. Inside of it create the Channel CHANNEL_CREDIT_WS in order to create an "internal" [[Participant]]. We also create the System CREDIT_EXTERNAL with the Channel CHANNEL_CREDIT_EXT corresponding to an "external" [[Participant]]. <br />
<br />
Note that the easiest way to configure a [[Web Services|Web service]] with {{L_VULCON}} is using the Wizard. We start from a [http://en.wikipedia.org/wiki/Web_service Web Service] WSDL, that describes a withdrawal operation on a credit card.<br />
<br />
From the Core view of {{L_VULCON}}, right clicking the Services element, launch the [[Wizard Call Web Service]] and, after selecting the WSDL file -in this example we use [[ExternalCreditService.wsdl]] present in folder <nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl-, choose the parameters to create the {{GVESB}} service.<br />
<br />
Two new Services, Pay and Query, and two [[ws-call]] operations, pay and query, will be created into the System CREDIT, channel CREDIT_EXTERNAL. We change those names to CCardPay and CCardQuery for the services, PayExternal and QueryExternal for the [[ws-call]] operations respectively. Now is possible to modify the workflow.<br />
<br />
From the {{L_VULCON}} Core view, element System "CREDIT" -> Channel "CHANNEL_CREDIT_WS", insert a [[dh-call]] operation and set its attributes and sub-elements as follow:<br />
<br />
* [[dh-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[dh-call]] || name="DataHandler"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]] || name="CCardQuery" <br/> jdbc-connection-name="ds.gv_test" <br/> <br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="decimal-separator" value="."<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="grouping-separator" value=","<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="format" value="#0.00"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOSelect]] || name="CCardQuery" <br/> transformation="CCardQuery" <br/> type="dbo" <br/><br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]]/[[statement]] || id="1" <br/> type="select" <br/> <br />
select p.NAME, cc.CNUMBER, cc.CREDIT, cc.ENABLED<br />
from PERSON p, CREDIT_CARD cc<br />
where p.ID = cc.ID_OWNER<br />
and cc.CNUMBER = <nowiki>@{{CNUMBER}}</nowiki><br />
|}<br />
<br />
The operation defined in the DataHandler makes use of the ''data-transformation'' module for the data transformations that allow to have data in XML format. So, you need to define the following parameters into the [[GVDataTransformation]] section:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[GVDataTransformation#DataSourceSet|DataSourceSet]]/[[GVDataTransformation#LocalFSDataSource|LocalFSDataSource]] || formatHandled="xsl" name="XSLDataSource" <br/> repositoryHome=<nowiki>"${{gv.app.home}}/gvdte/datasource/xsl"</nowiki> <br/> type="datasource" <br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="CCardQuery" DataSourceSet="Default" <br/> XSLMapName="DataHandler/CREDIT/[[CCardQuery.xsl]]"<br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="QueryExternalInput" DataSourceSet="Default" <br/> XSLMapName=" CREDIT_EXTERNAL/[[QueryExternalInput.xsl]]" <br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="QueryExternalOutput" DataSourceSet="Default" <br/> XSLMapName=" CREDIT_EXTERNAL/[[QueryExternalOutput.xsl]]" <br/> type="transformation"<br />
|}<br />
<br />
Now control that the [[ws-call]] element attributes and subelements defined into [[System]] CREDIT_EXTERNAL -> [[Channel]] CHANNEL_CREDIT_EXT will be set as:<br />
* [[ws-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[ws-call]] || name="QueryExternal"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]] || operation="Query" <br/> ref-dp="EXTERNAL::QueryWSDataProvider"<br/> returnType="body-element"<br/> type="invoker" <br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/WSDLInfo || type="wsdlinfo"<br/>wsdl="file://<nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl/[[ExternalCreditService.wsdl]]"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/BasicHttpAuth || user="xmlp<nowiki>{{ws.auth.user}}</nowiki>"<br/>password="xmlp<nowiki>{{ws.auth.password}}</nowiki>"<br />
|}<br />
<br />
The ws-call operation already defined makes use of the [[Data provider]] module. So, you need to define the following parameters into the [[GVDataProviderManager]] section, present in the Adapter Core View of {{L_VULCON}}:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[Axis2MessageContextDataProvider]] || name="EXTERNAL::PayWSDataProvider"<br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field || direction="OUT" key="message"<br/><br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field/Expression || type="ognl"<br />
envelope.body.addChild(@org.apache.axis2.util.XMLUtils<br />
@toOM(#input.object.getDocumentElement()))<br />
|}<br />
<br />
===Flow implementation===<br />
<br />
[[File:GVExamplesCCardQueryFlow.jpg|thumb|CCardQuery flow]] In order to define the CCardQuery service [[Flow]] design it as shown in the picture:<br />
<br />
<br />
The service receives a Web Service request from a client with a credit card number. If this card is managed locally, reads its data using Data Handler, otherwise forwards the request to an external system using Web Service.<br />
<br />
<br />
The following table shows the parameters to be defined for each Flow node:<br />
<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| first-node || Prepare<br />
|-<br />
| [[Conditions]]/GVBufferCondition || condition="isInternalCCard" <br/> Property:<br />
: name="IS_INTERNAL" operator="equal"<br />
: type="gvbuffer-field"<br />
: value="true"<br />
: value-type="text"<br />
|-<br />
| [[ChangeGVBufferNode]] || dump-in-out="true" <br/>id="prepare" <br/>input="input" <br/>next-node-id="check_internal" <br/>clear-data="false" <br/>PropertyDef:<br />
: name="CNUMBER"<br />
: <nowiki>value="js{{gvesb::var doc=XMLUtils.parseDOM_S(new java.lang.String(object.getObject()),false,true); XMLConfig.get(doc,'//cred:cnumber')}}" </nowiki><br/><br />
PropertyDef:<br />
: name="IS_INTERNAL"<br />
: value="sql{{ds.test_gv::select decode(count(*), 1, 'true', 'false') from credit_card where number=ognl{{#object.getProperty('CNUMBER')}}}}"<br />
|-<br />
| GVRouting || condition="isInternalCCard" <br/>next-node-id="search_internal"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/>id="search_internal" <br/>id-system="CREDIT" <br/>input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="DataHandler" <br/>output="output"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/> id="search_external" <br/>id-system="CREDIT_EXTERNAL" <br/> input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="QueryExternal" <br/>InputServices:<br />
: gvdte-service<br />
: crtical="yes", internal="yes"<br />
: remove-fields="yes" type="service"<br />
: map-name-param:name="map-name" type="param"<br />
: value="QueryExternalInput”<br />
: name="QueryExternalInput<br />
OutputServices:<br />
: gvdte-service:<br />
: critical="yes" internal="yes"<br />
: remove-fields="yes" type="service"<br />
: map-name-param:<br />
: name="map-name" type="param"<br />
: value="QueryExternalOutput"<br />
: name="QueryExternalOutput"<br />
|-<br />
| [[GVEndNode]] || end-business-process="yes" <br/>id="end" <br/>op-type="end" <br/>output="output"<br />
|}<br />
<br />
=={{GVCONSOLE}} Configuration==<br />
<br />
It is time to deploy and test your new Service. To do that follows these steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} Configuration file as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Sfoglia... (Browse) and select the file where you have saved the {{VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service CCardQuery a new view will be open containing the files GVCore.xml present in local and in server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. Saving you return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapters.xml and then Reload. A new windows will be open to confirm the operation<br />
# Click OK.<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{GVCONSOLE}} section [[Testing]]. In this section you can finally test your new services:<br />
# Into the Service voice select CCardQuery<br />
# Into the System voice select CREDIT_EXTERNAL<br />
# Select the Payload on input containing the credit card number you want to test<br />
# Click RequestReply<br />
<br />
The Testing View will be expanded and it is also possible to view the GVBuffer Output panel where there are present some properties, among these the REC_READ property set to 1, representing the number of record read from DB. <br />
<br />
The file TestOutput.txt will be generated in the directory <nowiki>${{gv.app.home}}</nowiki>/log as previously set (see [[Testing]] area) containing information about owner, credit and state of the credit card number "1234123415555666" as passed in input.<br />
<syntaxhighlight lang="XML"><br />
<pre><br />
----------- TEST N. 0 2012.02.15 at 11:46:26 -----------<br />
Standard Field:<br />
system = CREDIT_EXTERNAL<br />
service = CCardQuery<br />
id = 7F0001014F3B87B900021429<br />
retCode = 0<br />
GVBuffer: class org.apache.xerces.dom.DocumentImpl<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<QueryResponse xmlns="http://www.credit.com/services"><br />
<name>MARIO BIANCHI</name><br />
<cnumber>1234123415555666</cnumber><br />
<credit>300.00000</credit><br />
<active>true</active><br />
</QueryResponse><br />
Properties:<br />
REC_DISCARD = 0<br />
IS_INTERNAL = true<br />
REC_TOTAL = 0<br />
REC_UPDATE = 0<br />
REC_INSERT = 0<br />
REC_READ = 1<br />
CNUMBER = 1234123415555666<br />
REC_DISCARD_CAUSE = <br />
</pre><br />
</syntaxhighlight></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_CCardQuery&diff=4243GVExample CCardQuery2014-05-30T16:19:00Z<p>D.franco: </p>
<hr />
<div>==Description==<br />
<br />
This service has the scope of showing how {{GVESB}} uses [[DataHandler]] for quering a DB and implements a [[Web Services]].<br />
<br />
CCardQuery Service executes the following operations:<br />
# Receives a [[Web Services|Web Service]] request from client, with a credit card number to be controlled.<br />
# If this card is locally managed, reads the data from DB using [[DataHandler]]. <br />
# If this card is managed by an external system, forwards a Web Service request to that system.<br />
# Returns the response to the client<br />
<br />
=={{VULCON}} Configuration==<br />
<br />
To configure CCardQuery service follow these steps:<br />
# Define [[System|Systems]], [[Channel|Channels]] and [[Operation|Operations]]<br />
# Define the [[Service|Services]]<br />
# Implement the [[Flow|flows]].<br />
<br />
===Defining Systems, Channels, Operations and XPath===<br />
<br />
For this exercise, you need first of all to define an XPath for querying web services. This can be made in {{VULCON}} core view, simply by right-clicking on the element '''GVHpath/XPath''' and then selecting Insert after (or Insert before) -> XPathNamespace. Then fill the ampty field as in the following table.<br />
<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| XPathNamespace || namespace="http://www.credit.com/services"<br/>prefix="cred"<br />
|}<br />
<br />
In order to define a System, go to {{VULCON}} core view and insert the System CREDIT. Inside of it create the Channel CHANNEL_CREDIT_WS in order to create an "internal" [[Participant]]. We also create the System CREDIT_EXTERNAL with the Channel CHANNEL_CREDIT_EXT corresponding to an "external" [[Participant]]. <br />
<br />
Note that the easiest way to configure a [[Web Services|Web service]] with {{L_VULCON}} is using the Wizard. We start from a [http://en.wikipedia.org/wiki/Web_service Web Service] WSDL, that describes a withdrawal operation on a credit card.<br />
<br />
From the Core view of {{L_VULCON}}, right clicking the Services element, launch the [[Wizard Call Web Service]] and, after selecting the WSDL file -in this example we use [[ExternalCreditService.wsdl]] present in folder <nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl-, choose the parameters to create the {{GVESB}} service.<br />
<br />
Two new Services, Pay and Query, and two [[ws-call]] operations, pay and query, will be created into the System CREDIT, channel CREDIT_EXTERNAL. We change those names to CCardPay and CCardQuery for the services, PayExternal and QueryExternal for the [[ws-call]] operations respectively. Now is possible to modify the workflow.<br />
<br />
From the {{L_VULCON}} Core view, element System "CREDIT" -> Channel "CHANNEL_CREDIT_WS", insert a [[dh-call]] operation and set its attributes and sub-elements as follow:<br />
<br />
* [[dh-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[dh-call]] || name="DataHandler"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]] || name="CCardQuery" <br/> jdbc-connection-name="ds.gv_test" <br/> <br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="decimal-separator" value="."<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="grouping-separator" value=","<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="format" value="#0.00"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOSelect]] || name="CCardQuery" <br/> transformation="CCardQuery" <br/> type="dbo" <br/><br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]]/[[statement]] || id="1" <br/> type="select" <br/> <br />
select p.NAME, cc.CNUMBER, cc.CREDIT, cc.ENABLED<br />
from PERSON p, CREDIT_CARD cc<br />
where p.ID = cc.ID_OWNER<br />
and cc.CNUMBER = <nowiki>@{{CNUMBER}}</nowiki><br />
|}<br />
<br />
The operation defined in the DataHandler makes use of the ''data-transformation'' module for the data transformations that allow to have data in XML format. So, you need to define the following parameters into the [[GVDataTransformation]] section:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[GVDataTransformation#DataSourceSet|DataSourceSet]]/[[GVDataTransformation#LocalFSDataSource|LocalFSDataSource]] || formatHandled="xsl" name="XSLDataSource" <br/> repositoryHome=<nowiki>"${{gv.app.home}}/gvdte/datasource/xsl"</nowiki> <br/> type="datasource" <br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="CCardQuery" DataSourceSet="Default" <br/> XSLMapName="DataHandler/CREDIT/[[CCardQuery.xsl]]"<br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="QueryExternalInput" DataSourceSet="Default" <br/> XSLMapName=" CREDIT_EXTERNAL/[[QueryExternalInput.xsl]]" <br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="QueryExternalOutput" DataSourceSet="Default" <br/> XSLMapName=" CREDIT_EXTERNAL/[[QueryExternalOutput.xsl]]" <br/> type="transformation"<br />
|}<br />
<br />
Now control that the [[ws-call]] element attributes and subelements defined into [[System]] CREDIT_EXTERNAL -> [[Channel]] CHANNEL_CREDIT_EXT will be set as:<br />
* [[ws-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[ws-call]] || name="QueryExternal"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]] || operation="Query" <br/> ref-dp="EXTERNAL::QueryWSDataProvider"<br/> returnType="body-element"<br/> type="invoker" <br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/WSDLInfo || type="wsdlinfo"<br/>wsdl="file://<nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl/[[ExternalCreditService.wsdl]]"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/BasicHttpAuth || user="xmlp<nowiki>{{ws.auth.user}}</nowiki>"<br/>password="xmlp<nowiki>{{ws.auth.password}}</nowiki>"<br />
|}<br />
<br />
===Flow implementation===<br />
<br />
[[File:GVExamplesCCardQueryFlow.jpg|thumb|CCardQuery flow]] In order to define the CCardQuery service [[Flow]] design it as shown in the picture:<br />
<br />
<br />
The service receives a Web Service request from a client with a credit card number. If this card is managed locally, reads its data using Data Handler, otherwise forwards the request to an external system using Web Service.<br />
<br />
<br />
The following table shows the parameters to be defined for each Flow node:<br />
<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| first-node || Prepare<br />
|-<br />
| [[Conditions]]/GVBufferCondition || condition="isInternalCCard" <br/> Property:<br />
: name="IS_INTERNAL" operator="equal"<br />
: type="gvbuffer-field"<br />
: value="true"<br />
: value-type="text"<br />
|-<br />
| [[ChangeGVBufferNode]] || dump-in-out="true" <br/>id="prepare" <br/>input="input" <br/>next-node-id="check_internal" <br/>clear-data="false" <br/>PropertyDef:<br />
: name="CNUMBER"<br />
: <nowiki>value="js{{gvesb::var doc=XMLUtils.parseDOM_S(new java.lang.String(object.getObject()),false,true); XMLConfig.get(doc,'//cred:cnumber')}}" </nowiki><br/><br />
PropertyDef:<br />
: name="IS_INTERNAL"<br />
: value="sql{{ds.test_gv::select decode(count(*), 1, 'true', 'false') from credit_card where number=ognl{{#object.getProperty('CNUMBER')}}}}"<br />
|-<br />
| GVRouting || condition="isInternalCCard" <br/>next-node-id="search_internal"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/>id="search_internal" <br/>id-system="CREDIT" <br/>input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="DataHandler" <br/>output="output"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/> id="search_external" <br/>id-system="CREDIT_EXTERNAL" <br/> input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="QueryExternal" <br/>InputServices:<br />
: gvdte-service<br />
: crtical="yes", internal="yes"<br />
: remove-fields="yes" type="service"<br />
: map-name-param:name="map-name" type="param"<br />
: value="QueryExternalInput”<br />
: name="QueryExternalInput<br />
OutputServices:<br />
: gvdte-service:<br />
: critical="yes" internal="yes"<br />
: remove-fields="yes" type="service"<br />
: map-name-param:<br />
: name="map-name" type="param"<br />
: value="QueryExternalOutput"<br />
: name="QueryExternalOutput"<br />
|-<br />
| [[GVEndNode]] || end-business-process="yes" <br/>id="end" <br/>op-type="end" <br/>output="output"<br />
|}<br />
<br />
=={{GVCONSOLE}} Configuration==<br />
<br />
It is time to deploy and test your new Service. To do that follows these steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} Configuration file as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Sfoglia... (Browse) and select the file where you have saved the {{VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service CCardQuery a new view will be open containing the files GVCore.xml present in local and in server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. Saving you return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapters.xml and then Reload. A new windows will be open to confirm the operation<br />
# Click OK.<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{GVCONSOLE}} section [[Testing]]. In this section you can finally test your new services:<br />
# Into the Service voice select CCardQuery<br />
# Into the System voice select CREDIT_EXTERNAL<br />
# Select the Payload on input containing the credit card number you want to test<br />
# Click RequestReply<br />
<br />
The Testing View will be expanded and it is also possible to view the GVBuffer Output panel where there are present some properties, among these the REC_READ property set to 1, representing the number of record read from DB. <br />
<br />
The file TestOutput.txt will be generated in the directory <nowiki>${{gv.app.home}}</nowiki>/log as previously set (see [[Testing]] area) containing information about owner, credit and state of the credit card number "1234123415555666" as passed in input.<br />
<syntaxhighlight lang="XML"><br />
<pre><br />
----------- TEST N. 0 2012.02.15 at 11:46:26 -----------<br />
Standard Field:<br />
system = CREDIT_EXTERNAL<br />
service = CCardQuery<br />
id = 7F0001014F3B87B900021429<br />
retCode = 0<br />
GVBuffer: class org.apache.xerces.dom.DocumentImpl<br />
<?xml version="1.0" encoding="UTF-8"?><br />
<QueryResponse xmlns="http://www.credit.com/services"><br />
<name>MARIO BIANCHI</name><br />
<cnumber>1234123415555666</cnumber><br />
<credit>300.00000</credit><br />
<active>true</active><br />
</QueryResponse><br />
Properties:<br />
REC_DISCARD = 0<br />
IS_INTERNAL = true<br />
REC_TOTAL = 0<br />
REC_UPDATE = 0<br />
REC_INSERT = 0<br />
REC_READ = 1<br />
CNUMBER = 1234123415555666<br />
REC_DISCARD_CAUSE = <br />
</pre><br />
</syntaxhighlight></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_CCardPay&diff=4242GVExample CCardPay2014-05-30T15:59:44Z<p>D.franco: /* Defining Systems, Channels, Operations and XPath */</p>
<hr />
<div>==Description==<br />
<br />
This service has the purpose of showing how {{GVESB}} uses [[DataHandler]] to query a DB and implement [[Web Services]].<br />
<br />
CCardPay Service executes the following operations:<br />
# Receives a [[Web Services|Web Service]] request from client, with a credit card number to be controlled.<br />
# If this card is locally managed, reads the data from DB using [[DataHandler]]. <br />
# If this card is managed by an external system, forwards a Web Service request to that system.<br />
# Returns the response to the client<br />
<br />
=={{VULCON}} Configuration==<br />
<br />
To configure CCardPay service follow these steps:<br />
# Define [[System|Systems]], [[Channel|Channels]] and [[Operation|Operations]]<br />
# Define the [[Service|Services]]<br />
# Implement the [[Flow|flows]].<br />
<br />
===Defining Systems, Channels, Operations and XPath===<br />
<br />
For this exercise, you need first of all to define an XPath for querying web services. This can be made in {{VULCON}} core view, simply by right-clicking on the element '''GVHpath/XPath''' and then selecting Insert after (or Insert before) -> XPathNamespace. Then fill the ampty field as in the following table.<br />
<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| XPathNamespace || namespace="http://www.credit.com/services"<br/>prefix="cred"<br />
|}<br />
<br />
In order to define a System, go to {{VULCON}} core view and insert the System CREDIT. Inside of it create the Channel CHANNEL_CREDIT_WS in order to create an "internal" [[Participant]]. We also create the System CREDIT_EXTERNAL with the Channel CHANNEL_CREDIT_EXT corresponding to an "external" [[Participant]]. <br />
<br />
Note that the easiest way to configure a [[Web Services|Web service]] with {{L_VULCON}} is using the Wizard. We start from a [http://en.wikipedia.org/wiki/Web_service Web Service] WSDL, that describes a withdrawal operation on a credit card.<br />
<br />
From the Core view of {{L_VULCON}}, right clicking the Services element, launch the [[Wizard Call Web Service]] and, after selecting the WSDL file -in this example we use [[ExternalCreditService.wsdl]] present in folder <nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl-, choose the parameters to create the {{GVESB}} service.<br />
<br />
Two new Services, Pay and Query, and two [[ws-call]] operations, pay and query, will be created into the System CREDIT, channel CREDIT_EXTERNAL. We change those names to CCardPay and CCardQuery for the services, PayExternal and QueryExternal for the [[ws-call]] operations respectively. Now is possible to modify the workflow.<br />
<br />
From the {{L_VULCON}} Core view, element System "CREDIT" -> Channel "CHANNEL_CREDIT_WS", insert a [[dh-call]] operation and set its attributes and sub-elements as follow:<br />
<br />
* [[dh-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[dh-call]] || name="DataHandler"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]] || name="CCardPay" <br/> jdbc-connection-name="ds.gv_test" <br/> <br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="decimal-separator" value="."<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="grouping-separator" value=","<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="format" value="#0.00"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]] || name="CCardPay" <br/> transformation="CCardPay" <br/> type="dbo"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]]/[[statement]] || id="0" <br/> type="update"<br />
update CREDIT_CARD set CREDIT= CREDIT - ?<br />
where CNUMBER=?<br />
and ENABLED='Y'<br />
and CREDIT >= ?<br />
|}<br />
<br />
The operation defined in the DataHandler makes use of the ''data-transformation'' module for the data transformations that allow to have data in XML format. So, you need to define the following parameters into the [[GVDataTransformation]] section:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[GVDataTransformation#DataSourceSet|DataSourceSet]]/[[GVDataTransformation#LocalFSDataSource|LocalFSDataSource]] || formatHandled="xsl" name="XSLDataSource" <br/> repositoryHome=<nowiki>"${{gv.app.home}}/gvdte/datasource/xsl"</nowiki> <br/> type="datasource" <br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="CCardPay" DataSourceSet="Default" <br/> XSLMapName="DataHandler/CREDIT/[[CCardPay.xsl]]"<br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalInput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalInput.xsl]]" <br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalOutput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalOutput.xsl]]" <br/> type="transformation"<br />
|}<br />
<br />
Now define a [[ws-call]] operation into [[System]] CREDIT_EXTERNAL -> [[Channel]] CHANNEL_CREDIT_EXT. Its attributes and sub-elements defined will be set as:<br />
* [[ws-call]]:<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| [[ws-call]] || name="PayExternal"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]] || operation="Pay" <br/> ref-dp="EXTERNAL::PayWSDataProvider"<br/> returnType="body-element"<br/> type="invoker"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/WSDLInfo || type="wsdlinfo"<br/>wsdl="file://<nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl/[[ExternalCreditService.wsdl]]"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/BasicHttpAuth || user="xmlp<nowiki>{{ws.auth.user}}</nowiki>"<br/>password="xmlp<nowiki>{{ws.auth.password}}</nowiki>"<br />
|}<br />
<br />
The ws-call operation already defined makes use of the [[Data provider]] module. So, you need to define the following parameters into the [[GVDataProviderManager]] section, present in the Adapter Core View of {{L_VULCON}}:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[Axis2MessageContextDataProvider]] || name="EXTERNAL::PayWSDataProvider"<br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field || direction="OUT" key="message"<br/><br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field/Expression || type="ognl"<br />
envelope.body.addChild(@org.apache.axis2.util.XMLUtils<br />
@toOM(#input.object.getDocumentElement()))<br />
|}<br />
<br />
===Flow implementation===<br />
<br />
[[File:GVExamplesCCardPayFlow.jpg|thumb|CCardPay flow]] In order to define the CCardPay service [[Flow]] design it as shown in the picture:<br />
<br />
<br />
The service receives a Web Service request from a client with a credit card number. If this card is managed locally, reads its data using [[DataHandler]], otherwise forwards the request to an external system using [[Web Services]].<br />
<br />
<br />
The following table shows the parameters to be defined for each Flow node:<br />
<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| first-node || Prepare<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]] || condition="isInternalCCard"<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]]/Property || name="IS_INTERNAL" operator="equal"<br/>type="gvbuffer-field"<br/>value="true"<br/>value-type="text"<br />
|-<br />
| [[ChangeGVBufferNode]] || dump-in-out="true" <br/>id="prepare" <br/>input="input" <br/>next-node-id="check_internal"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]] || clear-data="false"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="CNUMBER"<br/><nowiki>value="js{{gvesb::var doc=XMLUtils.parseObject_S(object.getObject(),false,true); XMLUtils.get_S(doc,'//cred:cnumber')}}"</nowiki><br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="IS_INTERNAL"<br/>value="sql{{ds.gv_test::select decode(count(*), 1, 'true', 'false') from credit_card where cnumber=ognl{{#object.getProperty('CNUMBER')}}}}"<br />
|-<br />
| [[GVNodeCheck]] || default-id="pay_external"<br/> id="check_internal"<br/> input="input" <br/>on-exception-id="end" <br />
|-<br />
| [[GVNodeCheck]]/GVRouting || condition="isInternalCCard" <br/>next-node-id="pay_internal"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/>id="pay_internal" <br/>id-system="CREDIT" <br/>input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="DataHandler" <br/>output="output"<br />
|-<br />
| [[GVOperationNode]]/InputServices/dh-selector-service || critical="yes"<br/>internal="yes"<br/> type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/dh-selector-service/dh-selector-call || DH_SERVICE_NAME="CCardPay"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/> id="pay_external" <br/>id-system="CREDIT_EXTERNAL" <br/> input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="PayExternal"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/gvdte-context-call || name="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalOutput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/gvdte-context-call || name="PayExternalOutput"<br />
|-<br />
| [[GVEndNode]] || end-business-process="yes" <br/>id="end" <br/>op-type="end" <br/>output="output"<br />
|}<br />
<br />
=={{GVCONSOLE}} Configuration==<br />
<br />
It is time to deploy and test your new Service. To do that follow these steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} Configuration file as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Browse... and select the file where you have saved the {{L_VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service CCardPay a new view will be open containing the files GVCore.xml present in local and in server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. Saving you return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{L_GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapters.xml and then Reload.<br />
# Confirm the operation.<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{L_GVCONSOLE}} section [[Testing]]. In this section you can finally test your new services:<br />
# Into the Service voice select CCardPay<br />
# Into the System voice select CREDIT_EXTERNAL<br />
# Select the Payload on input containing the credit card number you want to use and the amount to reduce from.<br />
# Click RequestReply<br />
<br />
The Testing View will be expanded and it is also possible to view the GVBuffer Output panel where there are present some properties, among these the REC_READ property setted to 1, representing the number of record read from DB. <br />
<br />
The file TestOutput.txt will be generated in the directory <nowiki>${{gv.app.home}}</nowiki>/log as previously set (see [[Testing]] area) containing information about the credit card numbers you passed in input and the number of records founded and updated.<br />
<syntaxhighlight lang="XML"><br />
<pre><br />
----------- TEST N. 0 2012.03.02 at 14:11:38 -----------<br />
Standard Field:<br />
system = CREDIT_EXTERNAL<br />
service = CCardPay<br />
id = 7F0001014F50AFC600014063<br />
retCode = 0<br />
GVBuffer: NULL<br />
<br />
Properties:<br />
REC_DISCARD = 0<br />
IS_INTERNAL = true<br />
REC_TOTAL = 1<br />
REC_UPDATE = 1<br />
REC_INSERT = 0<br />
REC_READ = 0<br />
CNUMBER = 1234123415555666<br />
REC_DISCARD_CAUSE = <br />
</pre><br />
</syntaxhighlight></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_CCardPay&diff=4241GVExample CCardPay2014-05-30T15:43:40Z<p>D.franco: /* Defining Systems, Channels, Operations and XPath */</p>
<hr />
<div>==Description==<br />
<br />
This service has the purpose of showing how {{GVESB}} uses [[DataHandler]] to query a DB and implement [[Web Services]].<br />
<br />
CCardPay Service executes the following operations:<br />
# Receives a [[Web Services|Web Service]] request from client, with a credit card number to be controlled.<br />
# If this card is locally managed, reads the data from DB using [[DataHandler]]. <br />
# If this card is managed by an external system, forwards a Web Service request to that system.<br />
# Returns the response to the client<br />
<br />
=={{VULCON}} Configuration==<br />
<br />
To configure CCardPay service follow these steps:<br />
# Define [[System|Systems]], [[Channel|Channels]] and [[Operation|Operations]]<br />
# Define the [[Service|Services]]<br />
# Implement the [[Flow|flows]].<br />
<br />
===Defining Systems, Channels, Operations and XPath===<br />
<br />
For this exercise, you need first of all to define an XPath for querying web services. This can be made in {{VULCON}} core view, simply by right-clicking on the element '''GVHpath/XPath''' and then selecting Insert after (or Insert before) -> XPathNamespace. Then fill the ampty field as in the following table.<br />
<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| XPathNamespace || namespace="http://www.credit.com/services"<br/>prefix="cred"<br />
|}<br />
<br />
In order to define a System, go to {{VULCON}} core view and insert the System CREDIT. Inside of it create the Channel CHANNEL_CREDIT_WS in order to create an "internal" [[Participant]]. We also create the System CREDIT_EXTERNAL with the Channel CHANNEL_CREDIT_EXT corresponding to an "external" [[Participant]]. <br />
<br />
Note that the easiest way to configure a [[Web Services|Web service]] with {{L_VULCON}} is using the Wizard. We start from a [http://en.wikipedia.org/wiki/Web_service Web Service] WSDL, that describes a withdrawal operation on a credit card.<br />
<br />
From the Core view of {{L_VULCON}}, right clicking the Services element, launch the [[Wizard Call Web Service]] and, after selecting the WSDL file -in this example we use [[ExternalCreditService.wsdl]] present in folder <nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl-, choose the parameters to create the {{GVESB}} service.<br />
<br />
Two new Services, Pay and Query, and two [[ws-call]] operations, pay and query, will be created into the System CREDIT, channel CREDIT_EXTERNAL. We change those names to CCardPay and CCardQuery for the services, PayExternal and QueryExternal for the [[ws-call]] operations respectively. Now is possible to modify the workflow.<br />
<br />
From the {{L_VULCON}} Core view, element System "CREDIT" -> Channel "CHANNEL_CREDIT_WS", insert a [[dh-call]] operation and set its attributes and sub-elements as follow:<br />
<br />
* [[dh-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[dh-call]] || name="DataHandler"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]] || name="CCardPay" <br/> jdbc-connection-name="ds.gv_test" <br/> <br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="decimal-separator" value="."<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="grouping-separator" value=","<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="format" value="#0.00"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]] || name="CCardPay" <br/> transformation="CCardPay" <br/> type="dbo"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]]/[[statement]] || id="0" <br/> type="update"<br />
update CREDIT_CARD set CREDIT= CREDIT - ?<br />
where CNUMBER=?<br />
and ENABLED='Y'<br />
and CREDIT >= ?<br />
|}<br />
<br />
The operation defined in the DataHandler makes use of the ''data-transformation'' module for the data transformations that allow to have data in XML format. So, you need to define the following parameters into the [[GVDataTransformation]] section:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[GVDataTransformation#DataSourceSet|DataSourceSet]]/[[GVDataTransformation#LocalFSDataSource|LocalFSDataSource]] || formatHandled="xsl" name="XSLDataSource" <br/> repositoryHome=<nowiki>"${{gv.app.home}}/gvdte/datasource/xsl"</nowiki> <br/> type="datasource" <br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="CCardPay" DataSourceSet="Default" <br/> XSLMapName="DataHandler/CREDIT/[[CCardPay.xsl]]"<br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalInput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalInput.xsl]]" <br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalOutput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalOutput.xsl]]" <br/> type="transformation"<br />
|}<br />
<br />
Now define a [[ws-call]] operation into [[System]] CREDIT_EXTERNAL -> [[Channel]] CHANNEL_CREDIT_EXT. Its attributes and sub-elements defined will be setted as:<br />
* [[ws-call]]:<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| [[ws-call]] || name="PayExternal"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]] || operation="Pay" <br/> ref-dp="EXTERNAL::PayWSDataProvider"<br/> returnType="body-element"<br/> type="invoker"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/WSDLInfo || type="wsdlinfo"<br/>wsdl="file://<nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl/[[ExternalCreditService.wsdl]]"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/BasicHttpAuth || user="xmlp<nowiki>{{ws.auth.user}}</nowiki>"<br/>password="xmlp<nowiki>{{ws.auth.password}}</nowiki>"<br />
|}<br />
<br />
The ws-call operation already defined makes use of the [[Data provider]] module. So, you need to define the following parameters into the [[GVDataProviderManager]] section, present in the Adapter Core View of {{L_VULCON}}:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[Axis2MessageContextDataProvider]] || name="EXTERNAL::PayWSDataProvider"<br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field || direction="OUT" key="message"<br/><br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field/Expression || type="ognl"<br />
envelope.body.addChild(@org.apache.axis2.util.XMLUtils<br />
@toOM(#input.object.getDocumentElement()))<br />
|}<br />
<br />
===Flow implementation===<br />
<br />
[[File:GVExamplesCCardPayFlow.jpg|thumb|CCardPay flow]] In order to define the CCardPay service [[Flow]] design it as shown in the picture:<br />
<br />
<br />
The service receives a Web Service request from a client with a credit card number. If this card is managed locally, reads its data using [[DataHandler]], otherwise forwards the request to an external system using [[Web Services]].<br />
<br />
<br />
The following table shows the parameters to be defined for each Flow node:<br />
<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| first-node || Prepare<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]] || condition="isInternalCCard"<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]]/Property || name="IS_INTERNAL" operator="equal"<br/>type="gvbuffer-field"<br/>value="true"<br/>value-type="text"<br />
|-<br />
| [[ChangeGVBufferNode]] || dump-in-out="true" <br/>id="prepare" <br/>input="input" <br/>next-node-id="check_internal"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]] || clear-data="false"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="CNUMBER"<br/><nowiki>value="js{{gvesb::var doc=XMLUtils.parseObject_S(object.getObject(),false,true); XMLUtils.get_S(doc,'//cred:cnumber')}}"</nowiki><br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="IS_INTERNAL"<br/>value="sql{{ds.gv_test::select decode(count(*), 1, 'true', 'false') from credit_card where cnumber=ognl{{#object.getProperty('CNUMBER')}}}}"<br />
|-<br />
| [[GVNodeCheck]] || default-id="pay_external"<br/> id="check_internal"<br/> input="input" <br/>on-exception-id="end" <br />
|-<br />
| [[GVNodeCheck]]/GVRouting || condition="isInternalCCard" <br/>next-node-id="pay_internal"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/>id="pay_internal" <br/>id-system="CREDIT" <br/>input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="DataHandler" <br/>output="output"<br />
|-<br />
| [[GVOperationNode]]/InputServices/dh-selector-service || critical="yes"<br/>internal="yes"<br/> type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/dh-selector-service/dh-selector-call || DH_SERVICE_NAME="CCardPay"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/> id="pay_external" <br/>id-system="CREDIT_EXTERNAL" <br/> input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="PayExternal"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/gvdte-context-call || name="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalOutput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/gvdte-context-call || name="PayExternalOutput"<br />
|-<br />
| [[GVEndNode]] || end-business-process="yes" <br/>id="end" <br/>op-type="end" <br/>output="output"<br />
|}<br />
<br />
=={{GVCONSOLE}} Configuration==<br />
<br />
It is time to deploy and test your new Service. To do that follow these steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} Configuration file as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Browse... and select the file where you have saved the {{L_VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service CCardPay a new view will be open containing the files GVCore.xml present in local and in server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. Saving you return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{L_GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapters.xml and then Reload.<br />
# Confirm the operation.<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{L_GVCONSOLE}} section [[Testing]]. In this section you can finally test your new services:<br />
# Into the Service voice select CCardPay<br />
# Into the System voice select CREDIT_EXTERNAL<br />
# Select the Payload on input containing the credit card number you want to use and the amount to reduce from.<br />
# Click RequestReply<br />
<br />
The Testing View will be expanded and it is also possible to view the GVBuffer Output panel where there are present some properties, among these the REC_READ property setted to 1, representing the number of record read from DB. <br />
<br />
The file TestOutput.txt will be generated in the directory <nowiki>${{gv.app.home}}</nowiki>/log as previously set (see [[Testing]] area) containing information about the credit card numbers you passed in input and the number of records founded and updated.<br />
<syntaxhighlight lang="XML"><br />
<pre><br />
----------- TEST N. 0 2012.03.02 at 14:11:38 -----------<br />
Standard Field:<br />
system = CREDIT_EXTERNAL<br />
service = CCardPay<br />
id = 7F0001014F50AFC600014063<br />
retCode = 0<br />
GVBuffer: NULL<br />
<br />
Properties:<br />
REC_DISCARD = 0<br />
IS_INTERNAL = true<br />
REC_TOTAL = 1<br />
REC_UPDATE = 1<br />
REC_INSERT = 0<br />
REC_READ = 0<br />
CNUMBER = 1234123415555666<br />
REC_DISCARD_CAUSE = <br />
</pre><br />
</syntaxhighlight></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_CCardPay&diff=4240GVExample CCardPay2014-05-30T14:20:31Z<p>D.franco: /* Defining Systems, Channels, Operations and XPath */</p>
<hr />
<div>==Description==<br />
<br />
This service has the purpose of showing how {{GVESB}} uses [[DataHandler]] to query a DB and implement [[Web Services]].<br />
<br />
CCardPay Service executes the following operations:<br />
# Receives a [[Web Services|Web Service]] request from client, with a credit card number to be controlled.<br />
# If this card is locally managed, reads the data from DB using [[DataHandler]]. <br />
# If this card is managed by an external system, forwards a Web Service request to that system.<br />
# Returns the response to the client<br />
<br />
=={{VULCON}} Configuration==<br />
<br />
To configure CCardPay service follow these steps:<br />
# Define [[System|Systems]], [[Channel|Channels]] and [[Operation|Operations]]<br />
# Define the [[Service|Services]]<br />
# Implement the [[Flow|flows]].<br />
<br />
===Defining Systems, Channels, Operations and XPath===<br />
<br />
For this exercise, you need first of all to define an XPath for querying web services. This can be made in {{VULCON}} core view, simply by right-clicking on the element '''GVHpath/XPath''' and then selecting Insert after (or Insert before) -> XPathNamespace. Then fill the ampty field as in the following table.<br />
<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| XPathNamespace || namespace="http://www.credit.com/services"<br/>prefix="cred"<br />
|}<br />
<br />
In order to define a System, go to {{VULCON}} core view and insert the System CREDIT. Inside of it create the Channel CHANNEL_CREDIT_WS in order to create an "internal" [[Participant]]. We also create the System CREDIT_EXTERNAL with the Channel CHANNEL_CREDIT_EXT corresponding to an "external" [[Participant]]. <br />
<br />
Note that the easiest way to configure a [[Web Services|Web service]] with {{L_VULCON}} is using the Wizard. We start from a [http://en.wikipedia.org/wiki/Web_service Web Service] WSDL, that describes a withdrawal operation on a credit card.<br />
<br />
From the Core view of {{L_VULCON}}, right clicking the Services element, launch the [[Wizard Call Web Service]] and, after selecting the WSDL file -in this example we use [[ExternalCreditService.wsdl]] present in folder <nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl-, choose the parameters to create the {{GVESB}} service.<br />
<br />
Two new Services, Pay and Query, and two [[ws-call]] operations, pay and query, will be created into the System CREDIT, channel CREDIT_EXTERNAL. We change those names to CCardPay and CCardQuery for the services, PayExternal and QueryExternal for the [[ws-call]] operations respectively. Now is possible to modify the workflow.<br />
<br />
From the {{L_VULCON}} Core view, element System "CREDIT" -> Channel "CHANNEL_CREDIT_WS", insert a [[dh-call]] operation and set its attributes and sub-elements as follow:<br />
<br />
* [[dh-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[dh-call]] || name="DataHandler"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]] || name="CCardPay" <br/> jdbc-connection-name="ds.gv_test" <br/> <br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="decimal-separator" value="."<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="grouping-separator" value=","<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="format" value="#0.00"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]] || name="CCardPay" <br/> transformation="CCardPay" <br/> type="dbo"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]]/[[statement]] || id="0" <br/> type="update"<br />
update CREDIT_CARD set CREDIT= CREDIT - ?<br />
where CNUMBER=?<br />
and ENABLED='Y'<br />
and CREDIT >= ?<br />
|}<br />
<br />
The operation defined in the DataHandler makes use of the ''data-transformation'' module for the data transformations that allows to have data in XML format. So, you need to define the following parameters into the [[GVDataTransformation]] section:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[GVDataTransformation#DataSourceSet|DataSourceSet]]/[[GVDataTransformation#LocalFSDataSource|LocalFSDataSource]] || formatHandled="xsl" name="XSLDataSource" <br/> repositoryHome=<nowiki>"${{gv.app.home}}/gvdte/datasource/xsl"</nowiki> <br/> type="datasource" <br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="CCardPay" DataSourceSet="Default" <br/> XSLMapName="DataHandler/CREDIT/[[CCardPay.xsl]]"<br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalInput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalInput.xsl]]" <br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalOutput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalOutput.xsl]]" <br/> type="transformation"<br />
|}<br />
<br />
Now define a [[ws-call]] operation into [[System]] CREDIT_EXTERNAL -> [[Channel]] CHANNEL_CREDIT_EXT. Its attributes and sub-elements defined will be setted as:<br />
* [[ws-call]]:<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| [[ws-call]] || name="PayExternal"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]] || operation="Pay" <br/> ref-dp="EXTERNAL::PayWSDataProvider"<br/> returnType="body-element"<br/> type="invoker"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/WSDLInfo || type="wsdlinfo"<br/>wsdl="file://<nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl/[[ExternalCreditService.wsdl]]"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/BasicHttpAuth || user="xmlp<nowiki>{{ws.auth.user}}</nowiki>"<br/>password="xmlp<nowiki>{{ws.auth.password}}</nowiki>"<br />
|}<br />
<br />
The ws-call operation already defined makes use of the [[Data provider]] module. So, you need to define the following parameters into the [[GVDataProviderManager]] section, present in the Adapter Core View of {{L_VULCON}}:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[Axis2MessageContextDataProvider]] || name="EXTERNAL::PayWSDataProvider"<br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field || direction="OUT" key="message"<br/><br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field/Expression || type="ognl"<br />
envelope.body.addChild(@org.apache.axis2.util.XMLUtils<br />
@toOM(#input.object.getDocumentElement()))<br />
|}<br />
<br />
===Flow implementation===<br />
<br />
[[File:GVExamplesCCardPayFlow.jpg|thumb|CCardPay flow]] In order to define the CCardPay service [[Flow]] design it as shown in the picture:<br />
<br />
<br />
The service receives a Web Service request from a client with a credit card number. If this card is managed locally, reads its data using [[DataHandler]], otherwise forwards the request to an external system using [[Web Services]].<br />
<br />
<br />
The following table shows the parameters to be defined for each Flow node:<br />
<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| first-node || Prepare<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]] || condition="isInternalCCard"<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]]/Property || name="IS_INTERNAL" operator="equal"<br/>type="gvbuffer-field"<br/>value="true"<br/>value-type="text"<br />
|-<br />
| [[ChangeGVBufferNode]] || dump-in-out="true" <br/>id="prepare" <br/>input="input" <br/>next-node-id="check_internal"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]] || clear-data="false"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="CNUMBER"<br/><nowiki>value="js{{gvesb::var doc=XMLUtils.parseObject_S(object.getObject(),false,true); XMLUtils.get_S(doc,'//cred:cnumber')}}"</nowiki><br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="IS_INTERNAL"<br/>value="sql{{ds.gv_test::select decode(count(*), 1, 'true', 'false') from credit_card where cnumber=ognl{{#object.getProperty('CNUMBER')}}}}"<br />
|-<br />
| [[GVNodeCheck]] || default-id="pay_external"<br/> id="check_internal"<br/> input="input" <br/>on-exception-id="end" <br />
|-<br />
| [[GVNodeCheck]]/GVRouting || condition="isInternalCCard" <br/>next-node-id="pay_internal"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/>id="pay_internal" <br/>id-system="CREDIT" <br/>input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="DataHandler" <br/>output="output"<br />
|-<br />
| [[GVOperationNode]]/InputServices/dh-selector-service || critical="yes"<br/>internal="yes"<br/> type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/dh-selector-service/dh-selector-call || DH_SERVICE_NAME="CCardPay"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/> id="pay_external" <br/>id-system="CREDIT_EXTERNAL" <br/> input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="PayExternal"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/gvdte-context-call || name="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalOutput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/gvdte-context-call || name="PayExternalOutput"<br />
|-<br />
| [[GVEndNode]] || end-business-process="yes" <br/>id="end" <br/>op-type="end" <br/>output="output"<br />
|}<br />
<br />
=={{GVCONSOLE}} Configuration==<br />
<br />
It is time to deploy and test your new Service. To do that follow these steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} Configuration file as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Browse... and select the file where you have saved the {{L_VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service CCardPay a new view will be open containing the files GVCore.xml present in local and in server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. Saving you return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{L_GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapters.xml and then Reload.<br />
# Confirm the operation.<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{L_GVCONSOLE}} section [[Testing]]. In this section you can finally test your new services:<br />
# Into the Service voice select CCardPay<br />
# Into the System voice select CREDIT_EXTERNAL<br />
# Select the Payload on input containing the credit card number you want to use and the amount to reduce from.<br />
# Click RequestReply<br />
<br />
The Testing View will be expanded and it is also possible to view the GVBuffer Output panel where there are present some properties, among these the REC_READ property setted to 1, representing the number of record read from DB. <br />
<br />
The file TestOutput.txt will be generated in the directory <nowiki>${{gv.app.home}}</nowiki>/log as previously set (see [[Testing]] area) containing information about the credit card numbers you passed in input and the number of records founded and updated.<br />
<syntaxhighlight lang="XML"><br />
<pre><br />
----------- TEST N. 0 2012.03.02 at 14:11:38 -----------<br />
Standard Field:<br />
system = CREDIT_EXTERNAL<br />
service = CCardPay<br />
id = 7F0001014F50AFC600014063<br />
retCode = 0<br />
GVBuffer: NULL<br />
<br />
Properties:<br />
REC_DISCARD = 0<br />
IS_INTERNAL = true<br />
REC_TOTAL = 1<br />
REC_UPDATE = 1<br />
REC_INSERT = 0<br />
REC_READ = 0<br />
CNUMBER = 1234123415555666<br />
REC_DISCARD_CAUSE = <br />
</pre><br />
</syntaxhighlight></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_CCardPay&diff=4239GVExample CCardPay2014-05-30T13:38:09Z<p>D.franco: /* Defining Systems, Channels and Operations */</p>
<hr />
<div>==Description==<br />
<br />
This service has the purpose of showing how {{GVESB}} uses [[DataHandler]] to query a DB and implement [[Web Services]].<br />
<br />
CCardPay Service executes the following operations:<br />
# Receives a [[Web Services|Web Service]] request from client, with a credit card number to be controlled.<br />
# If this card is locally managed, reads the data from DB using [[DataHandler]]. <br />
# If this card is managed by an external system, forwards a Web Service request to that system.<br />
# Returns the response to the client<br />
<br />
=={{VULCON}} Configuration==<br />
<br />
To configure CCardPay service follow these steps:<br />
# Define [[System|Systems]], [[Channel|Channels]] and [[Operation|Operations]]<br />
# Define the [[Service|Services]]<br />
# Implement the [[Flow|flows]].<br />
<br />
===Defining Systems, Channels, Operations and XPath===<br />
<br />
For this exercise, you need first of all to define an XPath for querying web services. This can be made in {{VULCON}} core view, simply by right-clicking on the element '''GVHpath/XPath''' and then selecting Insert after (or Insert before) -> XPathNamespace. Then fill the ampty field as in the following table.<br />
<br />
* [[dh-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| XPathNamespace || namespace="http://www.credit.com/services"<br/>prefix="cred"<br />
|}<br />
<br />
In order to define a System, go to {{VULCON}} core view and insert the System CREDIT. Inside of it create the Channel CHANNEL_CREDIT_WS in order to create an "internal" [[Participant]]. We also create the System CREDIT_EXTERNAL with the Channel CHANNEL_CREDIT_EXT corresponding to an "external" [[Participant]]. <br />
<br />
Note that the easiest way to configure a [[Web Services|Web service]] with {{L_VULCON}} is using the Wizard. We start from a [http://en.wikipedia.org/wiki/Web_service Web Service] WSDL, that describes a withdrawal operation on a credit card.<br />
<br />
From the Core view of {{L_VULCON}}, right clicking the Services element, launch the [[Wizard Call Web Service]] and, after selecting the WSDL file -in this example we use [[ExternalCreditService.wsdl]] present in folder <nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl-, choose the parameters to create the {{GVESB}} service.<br />
<br />
Two new Services, Pay and Query, and two [[ws-call]] operations, pay and query, will be created into the System CREDIT, channel CREDIT_EXTERNAL. We change those names to CCardPay and CCardQuery for the services, PayExternal and QueryExternal for the [[ws-call]] operations respectively. Now is possible to modify the workflow.<br />
<br />
From the {{L_VULCON}} Core view, element System "CREDIT" -> Channel "CHANNEL_CREDIT_WS", insert a [[dh-call]] operation and set its attributes and sub-elements as follow:<br />
<br />
* [[dh-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[dh-call]] || name="DataHandler"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]] || name="CCardPay" <br/> jdbc-connection-name="ds.gv_test" <br/> <br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="decimal-separator" value="."<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="grouping-separator" value=","<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="format" value="#0.00"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]] || name="CCardPay" <br/> transformation="CCardPay" <br/> type="dbo"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]]/[[statement]] || id="0" <br/> type="update"<br />
update CREDIT_CARD set CREDIT= CREDIT - ?<br />
where CNUMBER=?<br />
and ENABLED='Y'<br />
and CREDIT >= ?<br />
|}<br />
<br />
The operation defined in the DataHandler makes use of the ''data-transformation'' module for the data transformations that allows to have data in XML format. So, you need to define the following parameters into the [[GVDataTransformation]] section:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[GVDataTransformation#DataSourceSet|DataSourceSet]]/[[GVDataTransformation#LocalFSDataSource|LocalFSDataSource]] || formatHandled="xsl" name="XSLDataSource" <br/> repositoryHome=<nowiki>"${{gv.app.home}}/gvdte/datasource/xsl"</nowiki> <br/> type="datasource" <br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="CCardPay" DataSourceSet="Default" <br/> XSLMapName="DataHandler/CREDIT/[[CCardPay.xsl]]"<br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalInput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalInput.xsl]]" <br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalOutput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalOutput.xsl]]" <br/> type="transformation"<br />
|}<br />
<br />
Now define a [[ws-call]] operation into [[System]] CREDIT_EXTERNAL -> [[Channel]] CHANNEL_CREDIT_EXT. Its attributes and sub-elements defined will be setted as:<br />
* [[ws-call]]:<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| [[ws-call]] || name="PayExternal"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]] || operation="Pay" <br/> ref-dp="EXTERNAL::PayWSDataProvider"<br/> returnType="body-element"<br/> type="invoker"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/WSDLInfo || type="wsdlinfo"<br/>wsdl="file://<nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl/[[ExternalCreditService.wsdl]]"<br />
|}<br />
<br />
The ws-call operation already defined makes use of the [[Data provider]] module. So, you need to define the following parameters into the [[GVDataProviderManager]] section, present in the Adapter Core View of {{L_VULCON}}:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[Axis2MessageContextDataProvider]] || name="EXTERNAL::PayWSDataProvider"<br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field || direction="OUT" key="message"<br/><br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field/Expression || type="ognl"<br />
envelope.body.addChild(@org.apache.axis2.util.XMLUtils<br />
@toOM(#input.object.getDocumentElement()))<br />
|}<br />
<br />
===Flow implementation===<br />
<br />
[[File:GVExamplesCCardPayFlow.jpg|thumb|CCardPay flow]] In order to define the CCardPay service [[Flow]] design it as shown in the picture:<br />
<br />
<br />
The service receives a Web Service request from a client with a credit card number. If this card is managed locally, reads its data using [[DataHandler]], otherwise forwards the request to an external system using [[Web Services]].<br />
<br />
<br />
The following table shows the parameters to be defined for each Flow node:<br />
<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| first-node || Prepare<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]] || condition="isInternalCCard"<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]]/Property || name="IS_INTERNAL" operator="equal"<br/>type="gvbuffer-field"<br/>value="true"<br/>value-type="text"<br />
|-<br />
| [[ChangeGVBufferNode]] || dump-in-out="true" <br/>id="prepare" <br/>input="input" <br/>next-node-id="check_internal"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]] || clear-data="false"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="CNUMBER"<br/><nowiki>value="js{{gvesb::var doc=XMLUtils.parseObject_S(object.getObject(),false,true); XMLUtils.get_S(doc,'//cred:cnumber')}}"</nowiki><br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="IS_INTERNAL"<br/>value="sql{{ds.gv_test::select decode(count(*), 1, 'true', 'false') from credit_card where cnumber=ognl{{#object.getProperty('CNUMBER')}}}}"<br />
|-<br />
| [[GVNodeCheck]] || default-id="pay_external"<br/> id="check_internal"<br/> input="input" <br/>on-exception-id="end" <br />
|-<br />
| [[GVNodeCheck]]/GVRouting || condition="isInternalCCard" <br/>next-node-id="pay_internal"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/>id="pay_internal" <br/>id-system="CREDIT" <br/>input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="DataHandler" <br/>output="output"<br />
|-<br />
| [[GVOperationNode]]/InputServices/dh-selector-service || critical="yes"<br/>internal="yes"<br/> type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/dh-selector-service/dh-selector-call || DH_SERVICE_NAME="CCardPay"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/> id="pay_external" <br/>id-system="CREDIT_EXTERNAL" <br/> input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="PayExternal"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/gvdte-context-call || name="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalOutput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/gvdte-context-call || name="PayExternalOutput"<br />
|-<br />
| [[GVEndNode]] || end-business-process="yes" <br/>id="end" <br/>op-type="end" <br/>output="output"<br />
|}<br />
<br />
=={{GVCONSOLE}} Configuration==<br />
<br />
It is time to deploy and test your new Service. To do that follow these steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} Configuration file as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Browse... and select the file where you have saved the {{L_VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service CCardPay a new view will be open containing the files GVCore.xml present in local and in server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. Saving you return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{L_GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapters.xml and then Reload.<br />
# Confirm the operation.<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{L_GVCONSOLE}} section [[Testing]]. In this section you can finally test your new services:<br />
# Into the Service voice select CCardPay<br />
# Into the System voice select CREDIT_EXTERNAL<br />
# Select the Payload on input containing the credit card number you want to use and the amount to reduce from.<br />
# Click RequestReply<br />
<br />
The Testing View will be expanded and it is also possible to view the GVBuffer Output panel where there are present some properties, among these the REC_READ property setted to 1, representing the number of record read from DB. <br />
<br />
The file TestOutput.txt will be generated in the directory <nowiki>${{gv.app.home}}</nowiki>/log as previously set (see [[Testing]] area) containing information about the credit card numbers you passed in input and the number of records founded and updated.<br />
<syntaxhighlight lang="XML"><br />
<pre><br />
----------- TEST N. 0 2012.03.02 at 14:11:38 -----------<br />
Standard Field:<br />
system = CREDIT_EXTERNAL<br />
service = CCardPay<br />
id = 7F0001014F50AFC600014063<br />
retCode = 0<br />
GVBuffer: NULL<br />
<br />
Properties:<br />
REC_DISCARD = 0<br />
IS_INTERNAL = true<br />
REC_TOTAL = 1<br />
REC_UPDATE = 1<br />
REC_INSERT = 0<br />
REC_READ = 0<br />
CNUMBER = 1234123415555666<br />
REC_DISCARD_CAUSE = <br />
</pre><br />
</syntaxhighlight></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_CCardPay&diff=4238GVExample CCardPay2014-05-30T11:11:31Z<p>D.franco: /* Flow implementation */</p>
<hr />
<div>==Description==<br />
<br />
This service has the purpose of showing how {{GVESB}} uses [[DataHandler]] to query a DB and implement [[Web Services]].<br />
<br />
CCardPay Service executes the following operations:<br />
# Receives a [[Web Services|Web Service]] request from client, with a credit card number to be controlled.<br />
# If this card is locally managed, reads the data from DB using [[DataHandler]]. <br />
# If this card is managed by an external system, forwards a Web Service request to that system.<br />
# Returns the response to the client<br />
<br />
=={{VULCON}} Configuration==<br />
<br />
To configure CCardPay service follow these steps:<br />
# Define [[System|Systems]], [[Channel|Channels]] and [[Operation|Operations]]<br />
# Define the [[Service|Services]]<br />
# Implement the [[Flow|flows]].<br />
<br />
===Defining Systems, Channels and Operations===<br />
<br />
In order to define a System, go to {{VULCON}} core view and insert the System CREDIT. Inside of it create the Channel CHANNEL_CREDIT_WS in order to create an "internal" [[Participant]]. We also create the System CREDIT_EXTERNAL with the Channel CHANNEL_CREDIT_EXT corresponding to an "external" [[Participant]]. <br />
<br />
Note that the easiest way to configure a [[Web Services|Web service]] with {{L_VULCON}} is using the Wizard. We start from a [http://en.wikipedia.org/wiki/Web_service Web Service] WSDL, that describes a withdrawal operation on a credit card.<br />
<br />
From the Core view of {{L_VULCON}}, right clicking the Services element, launch the [[Wizard Call Web Service]] and, after selecting the WSDL file -in this example we use [[ExternalCreditService.wsdl]] present in folder <nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl-, choose the parameters to create the {{GVESB}} service.<br />
<br />
Two new Services, Pay and Query, and two [[ws-call]] operations, pay and query, will be created into the System CREDIT, channel CREDIT_EXTERNAL. We change those names to CCardPay and CCardQuery for the services, PayExternal and QueryExternal for the [[ws-call]] operations respectively. Now is possible to modify the workflow.<br />
<br />
From the {{L_VULCON}} Core view, element System "CREDIT" -> Channel "CHANNEL_CREDIT_WS", insert a [[dh-call]] operation and set its attributes and sub-elements as follow:<br />
<br />
* [[dh-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[dh-call]] || name="DataHandler"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]] || name="CCardPay" <br/> jdbc-connection-name="ds.test_gv" <br/> <br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="decimal-separator" value="."<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="grouping-separator" value=","<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="format" value="#0.00"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]] || name="CCardPay" <br/> transformation="CCardPay" <br/> type="dbo"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]]/[[statement]] || id="0" <br/> type="update"<br />
update CREDIT_CARD set CREDIT= CREDIT - ?<br />
where CNUMBER=?<br />
and ENABLED='Y'<br />
and CREDIT >= ?<br />
|}<br />
<br />
The operation defined in the DataHandler makes use of the ''data-transformation'' module for the data transformations that allows to have data in XML format. So, you need to define the following parameters into the [[GVDataTransformation]] section:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[GVDataTransformation#DataSourceSet|DataSourceSet]]/[[GVDataTransformation#LocalFSDataSource|LocalFSDataSource]] || formatHandled="xsl" name="XSLDataSource" <br/> repositoryHome=<nowiki>"${{gv.app.home}}/gvdte/datasource/xsl"</nowiki> <br/> type="datasource" <br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="CCardPay" DataSourceSet="Default" <br/> XSLMapName="DataHandler/CREDIT/[[CCardPay.xsl]]"<br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalInput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalInput.xsl]]" <br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalOutput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalOutput.xsl]]" <br/> type="transformation"<br />
|}<br />
<br />
Now define a [[ws-call]] operation into [[System]] CREDIT_EXTERNAL -> [[Channel]] CHANNEL_CREDIT_EXT. Its attributes and sub-elements defined will be setted as:<br />
* [[ws-call]]:<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| [[ws-call]] || name="PayExternal"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]] || operation="Pay" <br/> ref-dp="EXTERNAL::PayWSDataProvider"<br/> returnType="body-element"<br/> type="invoker"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/WSDLInfo || type="wsdlinfo"<br/>wsdl="file://<nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl/[[ExternalCreditService.wsdl]]"<br />
|}<br />
<br />
The ws-call operation already defined makes use of the [[Data provider]] module. So, you need to define the following parameters into the [[GVDataProviderManager]] section, present in the Adapter Core View of {{L_VULCON}}:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[Axis2MessageContextDataProvider]] || name="EXTERNAL::PayWSDataProvider"<br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field || direction="OUT" key="message"<br/><br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field/Expression || type="ognl"<br />
envelope.body.addChild(@org.apache.axis2.util.XMLUtils<br />
@toOM(#input.object.getDocumentElement()))<br />
|}<br />
<br />
===Flow implementation===<br />
<br />
[[File:GVExamplesCCardPayFlow.jpg|thumb|CCardPay flow]] In order to define the CCardPay service [[Flow]] design it as shown in the picture:<br />
<br />
<br />
The service receives a Web Service request from a client with a credit card number. If this card is managed locally, reads its data using [[DataHandler]], otherwise forwards the request to an external system using [[Web Services]].<br />
<br />
<br />
The following table shows the parameters to be defined for each Flow node:<br />
<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| first-node || Prepare<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]] || condition="isInternalCCard"<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]]/Property || name="IS_INTERNAL" operator="equal"<br/>type="gvbuffer-field"<br/>value="true"<br/>value-type="text"<br />
|-<br />
| [[ChangeGVBufferNode]] || dump-in-out="true" <br/>id="prepare" <br/>input="input" <br/>next-node-id="check_internal"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]] || clear-data="false"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="CNUMBER"<br/><nowiki>value="js{{gvesb::var doc=XMLUtils.parseObject_S(object.getObject(),false,true); XMLUtils.get_S(doc,'//cred:cnumber')}}"</nowiki><br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="IS_INTERNAL"<br/>value="sql{{ds.gv_test::select decode(count(*), 1, 'true', 'false') from credit_card where cnumber=ognl{{#object.getProperty('CNUMBER')}}}}"<br />
|-<br />
| [[GVNodeCheck]] || default-id="pay_external"<br/> id="check_internal"<br/> input="input" <br/>on-exception-id="end" <br />
|-<br />
| [[GVNodeCheck]]/GVRouting || condition="isInternalCCard" <br/>next-node-id="pay_internal"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/>id="pay_internal" <br/>id-system="CREDIT" <br/>input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="DataHandler" <br/>output="output"<br />
|-<br />
| [[GVOperationNode]]/InputServices/dh-selector-service || critical="yes"<br/>internal="yes"<br/> type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/dh-selector-service/dh-selector-call || DH_SERVICE_NAME="CCardPay"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/> id="pay_external" <br/>id-system="CREDIT_EXTERNAL" <br/> input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="PayExternal"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/gvdte-context-call || name="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalOutput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/gvdte-context-call || name="PayExternalOutput"<br />
|-<br />
| [[GVEndNode]] || end-business-process="yes" <br/>id="end" <br/>op-type="end" <br/>output="output"<br />
|}<br />
<br />
=={{GVCONSOLE}} Configuration==<br />
<br />
It is time to deploy and test your new Service. To do that follow these steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} Configuration file as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Browse... and select the file where you have saved the {{L_VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service CCardPay a new view will be open containing the files GVCore.xml present in local and in server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. Saving you return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{L_GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapters.xml and then Reload.<br />
# Confirm the operation.<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{L_GVCONSOLE}} section [[Testing]]. In this section you can finally test your new services:<br />
# Into the Service voice select CCardPay<br />
# Into the System voice select CREDIT_EXTERNAL<br />
# Select the Payload on input containing the credit card number you want to use and the amount to reduce from.<br />
# Click RequestReply<br />
<br />
The Testing View will be expanded and it is also possible to view the GVBuffer Output panel where there are present some properties, among these the REC_READ property setted to 1, representing the number of record read from DB. <br />
<br />
The file TestOutput.txt will be generated in the directory <nowiki>${{gv.app.home}}</nowiki>/log as previously set (see [[Testing]] area) containing information about the credit card numbers you passed in input and the number of records founded and updated.<br />
<syntaxhighlight lang="XML"><br />
<pre><br />
----------- TEST N. 0 2012.03.02 at 14:11:38 -----------<br />
Standard Field:<br />
system = CREDIT_EXTERNAL<br />
service = CCardPay<br />
id = 7F0001014F50AFC600014063<br />
retCode = 0<br />
GVBuffer: NULL<br />
<br />
Properties:<br />
REC_DISCARD = 0<br />
IS_INTERNAL = true<br />
REC_TOTAL = 1<br />
REC_UPDATE = 1<br />
REC_INSERT = 0<br />
REC_READ = 0<br />
CNUMBER = 1234123415555666<br />
REC_DISCARD_CAUSE = <br />
</pre><br />
</syntaxhighlight></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_CCardPay&diff=4237GVExample CCardPay2014-05-30T10:31:21Z<p>D.franco: /* {{GVCONSOLE}} Configuration */</p>
<hr />
<div>==Description==<br />
<br />
This service has the purpose of showing how {{GVESB}} uses [[DataHandler]] to query a DB and implement [[Web Services]].<br />
<br />
CCardPay Service executes the following operations:<br />
# Receives a [[Web Services|Web Service]] request from client, with a credit card number to be controlled.<br />
# If this card is locally managed, reads the data from DB using [[DataHandler]]. <br />
# If this card is managed by an external system, forwards a Web Service request to that system.<br />
# Returns the response to the client<br />
<br />
=={{VULCON}} Configuration==<br />
<br />
To configure CCardPay service follow these steps:<br />
# Define [[System|Systems]], [[Channel|Channels]] and [[Operation|Operations]]<br />
# Define the [[Service|Services]]<br />
# Implement the [[Flow|flows]].<br />
<br />
===Defining Systems, Channels and Operations===<br />
<br />
In order to define a System, go to {{VULCON}} core view and insert the System CREDIT. Inside of it create the Channel CHANNEL_CREDIT_WS in order to create an "internal" [[Participant]]. We also create the System CREDIT_EXTERNAL with the Channel CHANNEL_CREDIT_EXT corresponding to an "external" [[Participant]]. <br />
<br />
Note that the easiest way to configure a [[Web Services|Web service]] with {{L_VULCON}} is using the Wizard. We start from a [http://en.wikipedia.org/wiki/Web_service Web Service] WSDL, that describes a withdrawal operation on a credit card.<br />
<br />
From the Core view of {{L_VULCON}}, right clicking the Services element, launch the [[Wizard Call Web Service]] and, after selecting the WSDL file -in this example we use [[ExternalCreditService.wsdl]] present in folder <nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl-, choose the parameters to create the {{GVESB}} service.<br />
<br />
Two new Services, Pay and Query, and two [[ws-call]] operations, pay and query, will be created into the System CREDIT, channel CREDIT_EXTERNAL. We change those names to CCardPay and CCardQuery for the services, PayExternal and QueryExternal for the [[ws-call]] operations respectively. Now is possible to modify the workflow.<br />
<br />
From the {{L_VULCON}} Core view, element System "CREDIT" -> Channel "CHANNEL_CREDIT_WS", insert a [[dh-call]] operation and set its attributes and sub-elements as follow:<br />
<br />
* [[dh-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[dh-call]] || name="DataHandler"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]] || name="CCardPay" <br/> jdbc-connection-name="ds.test_gv" <br/> <br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="decimal-separator" value="."<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="grouping-separator" value=","<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="format" value="#0.00"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]] || name="CCardPay" <br/> transformation="CCardPay" <br/> type="dbo"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]]/[[statement]] || id="0" <br/> type="update"<br />
update CREDIT_CARD set CREDIT= CREDIT - ?<br />
where CNUMBER=?<br />
and ENABLED='Y'<br />
and CREDIT >= ?<br />
|}<br />
<br />
The operation defined in the DataHandler makes use of the ''data-transformation'' module for the data transformations that allows to have data in XML format. So, you need to define the following parameters into the [[GVDataTransformation]] section:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[GVDataTransformation#DataSourceSet|DataSourceSet]]/[[GVDataTransformation#LocalFSDataSource|LocalFSDataSource]] || formatHandled="xsl" name="XSLDataSource" <br/> repositoryHome=<nowiki>"${{gv.app.home}}/gvdte/datasource/xsl"</nowiki> <br/> type="datasource" <br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="CCardPay" DataSourceSet="Default" <br/> XSLMapName="DataHandler/CREDIT/[[CCardPay.xsl]]"<br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalInput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalInput.xsl]]" <br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalOutput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalOutput.xsl]]" <br/> type="transformation"<br />
|}<br />
<br />
Now define a [[ws-call]] operation into [[System]] CREDIT_EXTERNAL -> [[Channel]] CHANNEL_CREDIT_EXT. Its attributes and sub-elements defined will be setted as:<br />
* [[ws-call]]:<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| [[ws-call]] || name="PayExternal"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]] || operation="Pay" <br/> ref-dp="EXTERNAL::PayWSDataProvider"<br/> returnType="body-element"<br/> type="invoker"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/WSDLInfo || type="wsdlinfo"<br/>wsdl="file://<nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl/[[ExternalCreditService.wsdl]]"<br />
|}<br />
<br />
The ws-call operation already defined makes use of the [[Data provider]] module. So, you need to define the following parameters into the [[GVDataProviderManager]] section, present in the Adapter Core View of {{L_VULCON}}:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[Axis2MessageContextDataProvider]] || name="EXTERNAL::PayWSDataProvider"<br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field || direction="OUT" key="message"<br/><br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field/Expression || type="ognl"<br />
envelope.body.addChild(@org.apache.axis2.util.XMLUtils<br />
@toOM(#input.object.getDocumentElement()))<br />
|}<br />
<br />
===Flow implementation===<br />
<br />
[[File:GVExamplesCCardPayFlow.jpg|thumb|CCardPay flow]] In order to define the CCardPay service [[Flow]] design it as shown in the picture:<br />
<br />
<br />
The service receives a Web Service request from a client with a credit card number. If this card is managed locally, reads its data using [[DataHandler]], otherwise forwards the request to an external system using [[Web Services]].<br />
<br />
<br />
The following table shows the parameters to be defined for each Flow node:<br />
<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| first-node || Prepare<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]] || condition="isInternalCCard"<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]]/Property || name="IS_INTERNAL" operator="equal"<br/>type="gvbuffer-field"<br/>value="true"<br/>value-type="text"<br />
|-<br />
| [[ChangeGVBufferNode]] || dump-in-out="true" <br/>id="prepare" <br/>input="input" <br/>next-node-id="check_internal"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]] || clear-data="false"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="CNUMBER"<br/><nowiki>value="js{{gvesb::var doc=XMLUtils.parseDOM_S(new java.lang.String(object.getObject()),false,true); XMLConfig.get(doc,'//cred:cnumber')}}" </nowiki><br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="IS_INTERNAL"<br/>value="sql{{ds.test_gv::select decode(count(*), 1, 'true', 'false') from credit_card where cnumber=ognl{{#object.getProperty('CNUMBER')}}}}"<br />
|-<br />
| [[GVNodeCheck]] || default-id="pay_external"<br/> id="check_internal"<br/> input="input" <br/>on-exception-id="end" <br />
|-<br />
| [[GVNodeCheck]]/GVRouting || condition="isInternalCCard" <br/>next-node-id="pay_internal"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/>id="pay_internal" <br/>id-system="CREDIT" <br/>input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="DataHandler" <br/>output="output"<br />
|-<br />
| [[GVOperationNode]]/InputServices/dh-selector-service || critical="yes"<br/>internal="yes"<br/> type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/dh-selector-service/dh-selector-call || DH_SERVICE_NAME="CCardPay"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/> id="pay_external" <br/>id-system="CREDIT_EXTERNAL" <br/> input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="PayExternal"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/gvdte-context-call || name="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalOutput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/gvdte-context-call || name="PayExternalOutput"<br />
|-<br />
| [[GVEndNode]] || end-business-process="yes" <br/>id="end" <br/>op-type="end" <br/>output="output"<br />
|}<br />
<br />
=={{GVCONSOLE}} Configuration==<br />
<br />
It is time to deploy and test your new Service. To do that follow these steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} Configuration file as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Browse... and select the file where you have saved the {{L_VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service CCardPay a new view will be open containing the files GVCore.xml present in local and in server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. Saving you return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{L_GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapters.xml and then Reload.<br />
# Confirm the operation.<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{L_GVCONSOLE}} section [[Testing]]. In this section you can finally test your new services:<br />
# Into the Service voice select CCardPay<br />
# Into the System voice select CREDIT_EXTERNAL<br />
# Select the Payload on input containing the credit card number you want to use and the amount to reduce from.<br />
# Click RequestReply<br />
<br />
The Testing View will be expanded and it is also possible to view the GVBuffer Output panel where there are present some properties, among these the REC_READ property setted to 1, representing the number of record read from DB. <br />
<br />
The file TestOutput.txt will be generated in the directory <nowiki>${{gv.app.home}}</nowiki>/log as previously set (see [[Testing]] area) containing information about the credit card numbers you passed in input and the number of records founded and updated.<br />
<syntaxhighlight lang="XML"><br />
<pre><br />
----------- TEST N. 0 2012.03.02 at 14:11:38 -----------<br />
Standard Field:<br />
system = CREDIT_EXTERNAL<br />
service = CCardPay<br />
id = 7F0001014F50AFC600014063<br />
retCode = 0<br />
GVBuffer: NULL<br />
<br />
Properties:<br />
REC_DISCARD = 0<br />
IS_INTERNAL = true<br />
REC_TOTAL = 1<br />
REC_UPDATE = 1<br />
REC_INSERT = 0<br />
REC_READ = 0<br />
CNUMBER = 1234123415555666<br />
REC_DISCARD_CAUSE = <br />
</pre><br />
</syntaxhighlight></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_CCardPay&diff=4236GVExample CCardPay2014-05-30T09:04:40Z<p>D.franco: /* Flow implementation */</p>
<hr />
<div>==Description==<br />
<br />
This service has the purpose of showing how {{GVESB}} uses [[DataHandler]] to query a DB and implement [[Web Services]].<br />
<br />
CCardPay Service executes the following operations:<br />
# Receives a [[Web Services|Web Service]] request from client, with a credit card number to be controlled.<br />
# If this card is locally managed, reads the data from DB using [[DataHandler]]. <br />
# If this card is managed by an external system, forwards a Web Service request to that system.<br />
# Returns the response to the client<br />
<br />
=={{VULCON}} Configuration==<br />
<br />
To configure CCardPay service follow these steps:<br />
# Define [[System|Systems]], [[Channel|Channels]] and [[Operation|Operations]]<br />
# Define the [[Service|Services]]<br />
# Implement the [[Flow|flows]].<br />
<br />
===Defining Systems, Channels and Operations===<br />
<br />
In order to define a System, go to {{VULCON}} core view and insert the System CREDIT. Inside of it create the Channel CHANNEL_CREDIT_WS in order to create an "internal" [[Participant]]. We also create the System CREDIT_EXTERNAL with the Channel CHANNEL_CREDIT_EXT corresponding to an "external" [[Participant]]. <br />
<br />
Note that the easiest way to configure a [[Web Services|Web service]] with {{L_VULCON}} is using the Wizard. We start from a [http://en.wikipedia.org/wiki/Web_service Web Service] WSDL, that describes a withdrawal operation on a credit card.<br />
<br />
From the Core view of {{L_VULCON}}, right clicking the Services element, launch the [[Wizard Call Web Service]] and, after selecting the WSDL file -in this example we use [[ExternalCreditService.wsdl]] present in folder <nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl-, choose the parameters to create the {{GVESB}} service.<br />
<br />
Two new Services, Pay and Query, and two [[ws-call]] operations, pay and query, will be created into the System CREDIT, channel CREDIT_EXTERNAL. We change those names to CCardPay and CCardQuery for the services, PayExternal and QueryExternal for the [[ws-call]] operations respectively. Now is possible to modify the workflow.<br />
<br />
From the {{L_VULCON}} Core view, element System "CREDIT" -> Channel "CHANNEL_CREDIT_WS", insert a [[dh-call]] operation and set its attributes and sub-elements as follow:<br />
<br />
* [[dh-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[dh-call]] || name="DataHandler"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]] || name="CCardPay" <br/> jdbc-connection-name="ds.test_gv" <br/> <br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="decimal-separator" value="."<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="grouping-separator" value=","<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="format" value="#0.00"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]] || name="CCardPay" <br/> transformation="CCardPay" <br/> type="dbo"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]]/[[statement]] || id="0" <br/> type="update"<br />
update CREDIT_CARD set CREDIT= CREDIT - ?<br />
where CNUMBER=?<br />
and ENABLED='Y'<br />
and CREDIT >= ?<br />
|}<br />
<br />
The operation defined in the DataHandler makes use of the ''data-transformation'' module for the data transformations that allows to have data in XML format. So, you need to define the following parameters into the [[GVDataTransformation]] section:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[GVDataTransformation#DataSourceSet|DataSourceSet]]/[[GVDataTransformation#LocalFSDataSource|LocalFSDataSource]] || formatHandled="xsl" name="XSLDataSource" <br/> repositoryHome=<nowiki>"${{gv.app.home}}/gvdte/datasource/xsl"</nowiki> <br/> type="datasource" <br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="CCardPay" DataSourceSet="Default" <br/> XSLMapName="DataHandler/CREDIT/[[CCardPay.xsl]]"<br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalInput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalInput.xsl]]" <br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalOutput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalOutput.xsl]]" <br/> type="transformation"<br />
|}<br />
<br />
Now define a [[ws-call]] operation into [[System]] CREDIT_EXTERNAL -> [[Channel]] CHANNEL_CREDIT_EXT. Its attributes and sub-elements defined will be setted as:<br />
* [[ws-call]]:<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| [[ws-call]] || name="PayExternal"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]] || operation="Pay" <br/> ref-dp="EXTERNAL::PayWSDataProvider"<br/> returnType="body-element"<br/> type="invoker"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/WSDLInfo || type="wsdlinfo"<br/>wsdl="file://<nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl/[[ExternalCreditService.wsdl]]"<br />
|}<br />
<br />
The ws-call operation already defined makes use of the [[Data provider]] module. So, you need to define the following parameters into the [[GVDataProviderManager]] section, present in the Adapter Core View of {{L_VULCON}}:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[Axis2MessageContextDataProvider]] || name="EXTERNAL::PayWSDataProvider"<br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field || direction="OUT" key="message"<br/><br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field/Expression || type="ognl"<br />
envelope.body.addChild(@org.apache.axis2.util.XMLUtils<br />
@toOM(#input.object.getDocumentElement()))<br />
|}<br />
<br />
===Flow implementation===<br />
<br />
[[File:GVExamplesCCardPayFlow.jpg|thumb|CCardPay flow]] In order to define the CCardPay service [[Flow]] design it as shown in the picture:<br />
<br />
<br />
The service receives a Web Service request from a client with a credit card number. If this card is managed locally, reads its data using [[DataHandler]], otherwise forwards the request to an external system using [[Web Services]].<br />
<br />
<br />
The following table shows the parameters to be defined for each Flow node:<br />
<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| first-node || Prepare<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]] || condition="isInternalCCard"<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]]/Property || name="IS_INTERNAL" operator="equal"<br/>type="gvbuffer-field"<br/>value="true"<br/>value-type="text"<br />
|-<br />
| [[ChangeGVBufferNode]] || dump-in-out="true" <br/>id="prepare" <br/>input="input" <br/>next-node-id="check_internal"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]] || clear-data="false"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="CNUMBER"<br/><nowiki>value="js{{gvesb::var doc=XMLUtils.parseDOM_S(new java.lang.String(object.getObject()),false,true); XMLConfig.get(doc,'//cred:cnumber')}}" </nowiki><br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="IS_INTERNAL"<br/>value="sql{{ds.test_gv::select decode(count(*), 1, 'true', 'false') from credit_card where cnumber=ognl{{#object.getProperty('CNUMBER')}}}}"<br />
|-<br />
| [[GVNodeCheck]] || default-id="pay_external"<br/> id="check_internal"<br/> input="input" <br/>on-exception-id="end" <br />
|-<br />
| [[GVNodeCheck]]/GVRouting || condition="isInternalCCard" <br/>next-node-id="pay_internal"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/>id="pay_internal" <br/>id-system="CREDIT" <br/>input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="DataHandler" <br/>output="output"<br />
|-<br />
| [[GVOperationNode]]/InputServices/dh-selector-service || critical="yes"<br/>internal="yes"<br/> type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/dh-selector-service/dh-selector-call || DH_SERVICE_NAME="CCardPay"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/> id="pay_external" <br/>id-system="CREDIT_EXTERNAL" <br/> input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="PayExternal"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/gvdte-context-call || name="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalOutput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/gvdte-context-call || name="PayExternalOutput"<br />
|-<br />
| [[GVEndNode]] || end-business-process="yes" <br/>id="end" <br/>op-type="end" <br/>output="output"<br />
|}<br />
<br />
=={{GVCONSOLE}} Configuration==<br />
<br />
It is time to deploy and test your new Service. To do that follow these steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} Configuration file as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Browse... and select the file where you have saved the {{L_VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service CCardPay a new view will be open containing the files GVCore.xml present in local and in server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. Saving you return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{L_GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapters.xml and then Reload. A new windows will be open to confirm the operation<br />
# Click OK.<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{L_GVCONSOLE}} section [[Testing]]. In this section you can finally test your new services:<br />
# Into the Service voice select CCardPay<br />
# Into the System voice select CREDIT_EXTERNAL<br />
# Select the Payload on input containing the credit card number you want to use and the amount to reduce from.<br />
# Click RequestReply<br />
<br />
The Testing View will be expanded and it is also possible to view the GVBuffer Output panel where there are present some properties, among these the REC_READ property setted to 1, representing the number of record read from DB. <br />
<br />
The file TestOutput.txt will be generated in the directory <nowiki>${{gv.app.home}}</nowiki>/log as previously setted (see [[Testing]] area) containing information about the credit card numbers you passed in input and the number of records founded and updated.<br />
<syntaxhighlight lang="XML"><br />
<pre><br />
----------- TEST N. 0 2012.03.02 at 14:11:38 -----------<br />
Standard Field:<br />
system = CREDIT_EXTERNAL<br />
service = CCardPay<br />
id = 7F0001014F50AFC600014063<br />
retCode = 0<br />
GVBuffer: NULL<br />
<br />
Properties:<br />
REC_DISCARD = 0<br />
IS_INTERNAL = true<br />
REC_TOTAL = 1<br />
REC_UPDATE = 1<br />
REC_INSERT = 0<br />
REC_READ = 0<br />
CNUMBER = 1234123415555666<br />
REC_DISCARD_CAUSE = <br />
</pre><br />
</syntaxhighlight></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_CCardPay&diff=4235GVExample CCardPay2014-05-30T08:59:43Z<p>D.franco: /* Defining Systems, Channels and Operations */</p>
<hr />
<div>==Description==<br />
<br />
This service has the purpose of showing how {{GVESB}} uses [[DataHandler]] to query a DB and implement [[Web Services]].<br />
<br />
CCardPay Service executes the following operations:<br />
# Receives a [[Web Services|Web Service]] request from client, with a credit card number to be controlled.<br />
# If this card is locally managed, reads the data from DB using [[DataHandler]]. <br />
# If this card is managed by an external system, forwards a Web Service request to that system.<br />
# Returns the response to the client<br />
<br />
=={{VULCON}} Configuration==<br />
<br />
To configure CCardPay service follow these steps:<br />
# Define [[System|Systems]], [[Channel|Channels]] and [[Operation|Operations]]<br />
# Define the [[Service|Services]]<br />
# Implement the [[Flow|flows]].<br />
<br />
===Defining Systems, Channels and Operations===<br />
<br />
In order to define a System, go to {{VULCON}} core view and insert the System CREDIT. Inside of it create the Channel CHANNEL_CREDIT_WS in order to create an "internal" [[Participant]]. We also create the System CREDIT_EXTERNAL with the Channel CHANNEL_CREDIT_EXT corresponding to an "external" [[Participant]]. <br />
<br />
Note that the easiest way to configure a [[Web Services|Web service]] with {{L_VULCON}} is using the Wizard. We start from a [http://en.wikipedia.org/wiki/Web_service Web Service] WSDL, that describes a withdrawal operation on a credit card.<br />
<br />
From the Core view of {{L_VULCON}}, right clicking the Services element, launch the [[Wizard Call Web Service]] and, after selecting the WSDL file -in this example we use [[ExternalCreditService.wsdl]] present in folder <nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl-, choose the parameters to create the {{GVESB}} service.<br />
<br />
Two new Services, Pay and Query, and two [[ws-call]] operations, pay and query, will be created into the System CREDIT, channel CREDIT_EXTERNAL. We change those names to CCardPay and CCardQuery for the services, PayExternal and QueryExternal for the [[ws-call]] operations respectively. Now is possible to modify the workflow.<br />
<br />
From the {{L_VULCON}} Core view, element System "CREDIT" -> Channel "CHANNEL_CREDIT_WS", insert a [[dh-call]] operation and set its attributes and sub-elements as follow:<br />
<br />
* [[dh-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[dh-call]] || name="DataHandler"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]] || name="CCardPay" <br/> jdbc-connection-name="ds.test_gv" <br/> <br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="decimal-separator" value="."<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="grouping-separator" value=","<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="format" value="#0.00"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]] || name="CCardPay" <br/> transformation="CCardPay" <br/> type="dbo"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]]/[[statement]] || id="0" <br/> type="update"<br />
update CREDIT_CARD set CREDIT= CREDIT - ?<br />
where CNUMBER=?<br />
and ENABLED='Y'<br />
and CREDIT >= ?<br />
|}<br />
<br />
The operation defined in the DataHandler makes use of the ''data-transformation'' module for the data transformations that allows to have data in XML format. So, you need to define the following parameters into the [[GVDataTransformation]] section:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[GVDataTransformation#DataSourceSet|DataSourceSet]]/[[GVDataTransformation#LocalFSDataSource|LocalFSDataSource]] || formatHandled="xsl" name="XSLDataSource" <br/> repositoryHome=<nowiki>"${{gv.app.home}}/gvdte/datasource/xsl"</nowiki> <br/> type="datasource" <br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="CCardPay" DataSourceSet="Default" <br/> XSLMapName="DataHandler/CREDIT/[[CCardPay.xsl]]"<br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalInput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalInput.xsl]]" <br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalOutput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalOutput.xsl]]" <br/> type="transformation"<br />
|}<br />
<br />
Now define a [[ws-call]] operation into [[System]] CREDIT_EXTERNAL -> [[Channel]] CHANNEL_CREDIT_EXT. Its attributes and sub-elements defined will be setted as:<br />
* [[ws-call]]:<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| [[ws-call]] || name="PayExternal"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]] || operation="Pay" <br/> ref-dp="EXTERNAL::PayWSDataProvider"<br/> returnType="body-element"<br/> type="invoker"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/WSDLInfo || type="wsdlinfo"<br/>wsdl="file://<nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl/[[ExternalCreditService.wsdl]]"<br />
|}<br />
<br />
The ws-call operation already defined makes use of the [[Data provider]] module. So, you need to define the following parameters into the [[GVDataProviderManager]] section, present in the Adapter Core View of {{L_VULCON}}:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[Axis2MessageContextDataProvider]] || name="EXTERNAL::PayWSDataProvider"<br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field || direction="OUT" key="message"<br/><br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field/Expression || type="ognl"<br />
envelope.body.addChild(@org.apache.axis2.util.XMLUtils<br />
@toOM(#input.object.getDocumentElement()))<br />
|}<br />
<br />
===Flow implementation===<br />
<br />
[[File:GVExamplesCCardPayFlow.jpg|thumb|CCardPay flow]] In order to define the CCardPay service [[Flow]] design it as shown in the picture:<br />
<br />
<br />
The service receives a Web Service request from a client with a credit card number. If this card is managed locally, reads its data using [[DataHandler]], otherwise forwards the request to an external system using [[Web Services]].<br />
<br />
<br />
The following table shows the parameters to be defined for each Flow node:<br />
<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| first-node || Prepare<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]] || condition="isInternalCCard"<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]]/Property || name="IS_INTERNAL" operator="equal"<br/>type="gvbuffer-field"<br/>value="true"<br/>value-type="text"<br />
|-<br />
| [[ChangeGVBufferNode]] || dump-in-out="true" <br/>id="prepare" <br/>input="input" <br/>next-node-id="check_internal"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]] || clear-data="false"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="CNUMBER"<br/><nowiki>value="js{{gvesb::var doc=XMLUtils.parseDOM_S(new java.lang.String(object.getObject()),false,true); XMLConfig.get(doc,'//cred:cnumber')}}" </nowiki><br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="IS_INTERNAL"<br/>value="sql{{ds.test_gv::select decode(count(*), 1, 'true', 'false') from credit_card where cnumber=ognl{{#object.getProperty('CNUMBER')}}}}"<br />
|-<br />
| [[GVNodeCheck]] || default-id="pay_external"<br/> id="check_internal"<br/> input="input" <br/>on-exception-id="end" <br />
|-<br />
| [[GVNodeCheck]]/GVRouting || condition="isInternalCCard" <br/>next-node-id="pay_internal"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/>id="pay_internal" <br/>id-system="CREDIT" <br/>input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="DataHandler" <br/>output="output"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/> id="pay_external" <br/>id-system="CREDIT_EXTERNAL" <br/> input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="PayExternal"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/gvdte-context-call || name="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalOutput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/gvdte-context-call || name="PayExternalOutput"<br />
|-<br />
| [[GVEndNode]] || end-business-process="yes" <br/>id="end" <br/>op-type="end" <br/>output="output"<br />
|}<br />
<br />
=={{GVCONSOLE}} Configuration==<br />
<br />
It is time to deploy and test your new Service. To do that follow these steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} Configuration file as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Browse... and select the file where you have saved the {{L_VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service CCardPay a new view will be open containing the files GVCore.xml present in local and in server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. Saving you return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{L_GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapters.xml and then Reload. A new windows will be open to confirm the operation<br />
# Click OK.<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{L_GVCONSOLE}} section [[Testing]]. In this section you can finally test your new services:<br />
# Into the Service voice select CCardPay<br />
# Into the System voice select CREDIT_EXTERNAL<br />
# Select the Payload on input containing the credit card number you want to use and the amount to reduce from.<br />
# Click RequestReply<br />
<br />
The Testing View will be expanded and it is also possible to view the GVBuffer Output panel where there are present some properties, among these the REC_READ property setted to 1, representing the number of record read from DB. <br />
<br />
The file TestOutput.txt will be generated in the directory <nowiki>${{gv.app.home}}</nowiki>/log as previously setted (see [[Testing]] area) containing information about the credit card numbers you passed in input and the number of records founded and updated.<br />
<syntaxhighlight lang="XML"><br />
<pre><br />
----------- TEST N. 0 2012.03.02 at 14:11:38 -----------<br />
Standard Field:<br />
system = CREDIT_EXTERNAL<br />
service = CCardPay<br />
id = 7F0001014F50AFC600014063<br />
retCode = 0<br />
GVBuffer: NULL<br />
<br />
Properties:<br />
REC_DISCARD = 0<br />
IS_INTERNAL = true<br />
REC_TOTAL = 1<br />
REC_UPDATE = 1<br />
REC_INSERT = 0<br />
REC_READ = 0<br />
CNUMBER = 1234123415555666<br />
REC_DISCARD_CAUSE = <br />
</pre><br />
</syntaxhighlight></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_CCardPay&diff=4234GVExample CCardPay2014-05-30T08:35:58Z<p>D.franco: /* Flow implementation */</p>
<hr />
<div>==Description==<br />
<br />
This service has the purpose of showing how {{GVESB}} uses [[DataHandler]] to query a DB and implement [[Web Services]].<br />
<br />
CCardPay Service executes the following operations:<br />
# Receives a [[Web Services|Web Service]] request from client, with a credit card number to be controlled.<br />
# If this card is locally managed, reads the data from DB using [[DataHandler]]. <br />
# If this card is managed by an external system, forwards a Web Service request to that system.<br />
# Returns the response to the client<br />
<br />
=={{VULCON}} Configuration==<br />
<br />
To configure CCardPay service follow these steps:<br />
# Define [[System|Systems]], [[Channel|Channels]] and [[Operation|Operations]]<br />
# Define the [[Service|Services]]<br />
# Implement the [[Flow|flows]].<br />
<br />
===Defining Systems, Channels and Operations===<br />
<br />
In order to define a System, go to {{VULCON}} core view and insert the System CREDIT. Inside of it create the Channel CHANNEL_CREDIT_WS in order to create an "internal" [[Participant]]. We also create the System CREDIT_EXTERNAL with the Channel CHANNEL_CREDIT_EXT corresponding to an "external" [[Participant]]. <br />
<br />
Note that the easiest way to configure a [[Web Services|Web service]] with {{L_VULCON}} is using the Wizard. We start from a [http://en.wikipedia.org/wiki/Web_service Web Service] WSDL, that describes a withdrawal operation on a credit card.<br />
<br />
From the Core view of {{L_VULCON}}, right clicking the Services element, launch the [[Wizard Call Web Service]] and, after selecting the WSDL file -in this example we use [[ExternalCreditService.wsdl]] present in folder <nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl-, choose the parameters to create the {{GVESB}} service.<br />
<br />
Two new Services, Pay and Query, and two [[ws-call]] operations, pay and query, will be created into the System CREDIT, channel CREDIT_EXTERNAL. We change those names to CCardPay and CCardQuery for the services, PayExternal and QueryExternal for the [[ws-call]] operations respectively. Now is possible to modify the workflow.<br />
<br />
From the {{L_VULCON}} Core view, element System "CREDIT" -> Channel "CHANNEL_CREDIT_WS", insert a [[dh-call]] operation and set its attributes and sub-elements as follow:<br />
<br />
* [[dh-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[dh-call]] || name="DataHandler"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]] || name="CREDIT::CCardPay" <br/> jdbc-connection-name="ds.test_gv" <br/> <br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="decimal-separator" value="."<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="grouping-separator" value=","<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="format" value="#0.00"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]] || name="CCardPay" <br/> transformation="CCardPay" <br/> type="dbo"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]]/[[statement]] || id="0" <br/> type="update"<br />
update CREDIT_CARD set CREDIT= CREDIT - ?<br />
where CNUMBER=?<br />
and ENABLED='Y'<br />
and CREDIT >= ?<br />
|}<br />
<br />
The operation defined in the DataHandler makes use of the ''data-transformation'' module for the data transformations that allows to have data in XML format. So, you need to define the following parameters into the [[GVDataTransformation]] section:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[GVDataTransformation#DataSourceSet|DataSourceSet]]/[[GVDataTransformation#LocalFSDataSource|LocalFSDataSource]] || formatHandled="xsl" name="XSLDataSource" <br/> repositoryHome=<nowiki>"${{gv.app.home}}/gvdte/datasource/xsl"</nowiki> <br/> type="datasource" <br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="CCardPay" DataSourceSet="Default" <br/> XSLMapName="DataHandler/CREDIT/[[CCardPay.xsl]]"<br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalInput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalInput.xsl]]" <br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalOutput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalOutput.xsl]]" <br/> type="transformation"<br />
|}<br />
<br />
Now define a [[ws-call]] operation into [[System]] CREDIT_EXTERNAL -> [[Channel]] CHANNEL_CREDIT_EXT. Its attributes and sub-elements defined will be setted as:<br />
* [[ws-call]]:<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| [[ws-call]] || name="PayExternal"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]] || operation="Pay" <br/> ref-dp="EXTERNAL::PayWSDataProvider"<br/> returnType="body-element"<br/> type="invoker"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/WSDLInfo || type="wsdlinfo"<br/>wsdl="file://<nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl/[[ExternalCreditService.wsdl]]"<br />
|}<br />
<br />
The ws-call operation already defined makes use of the [[Data provider]] module. So, you need to define the following parameters into the [[GVDataProviderManager]] section, present in the Adapter Core View of {{L_VULCON}}:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[Axis2MessageContextDataProvider]] || name="EXTERNAL::PayWSDataProvider"<br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field || direction="OUT" key="message"<br/><br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field/Expression || type="ognl"<br />
envelope.body.addChild(@org.apache.axis2.util.XMLUtils<br />
@toOM(#input.object.getDocumentElement()))<br />
|}<br />
<br />
===Flow implementation===<br />
<br />
[[File:GVExamplesCCardPayFlow.jpg|thumb|CCardPay flow]] In order to define the CCardPay service [[Flow]] design it as shown in the picture:<br />
<br />
<br />
The service receives a Web Service request from a client with a credit card number. If this card is managed locally, reads its data using [[DataHandler]], otherwise forwards the request to an external system using [[Web Services]].<br />
<br />
<br />
The following table shows the parameters to be defined for each Flow node:<br />
<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| first-node || Prepare<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]] || condition="isInternalCCard"<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]]/Property || name="IS_INTERNAL" operator="equal"<br/>type="gvbuffer-field"<br/>value="true"<br/>value-type="text"<br />
|-<br />
| [[ChangeGVBufferNode]] || dump-in-out="true" <br/>id="prepare" <br/>input="input" <br/>next-node-id="check_internal"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]] || clear-data="false"<br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="CNUMBER"<br/><nowiki>value="js{{gvesb::var doc=XMLUtils.parseDOM_S(new java.lang.String(object.getObject()),false,true); XMLConfig.get(doc,'//cred:cnumber')}}" </nowiki><br />
|-<br />
| [[ChangeGVBufferNode]]/[[ChangeGVBuffer]]/PropertyDef || name="IS_INTERNAL"<br/>value="sql{{ds.test_gv::select decode(count(*), 1, 'true', 'false') from credit_card where cnumber=ognl{{#object.getProperty('CNUMBER')}}}}"<br />
|-<br />
| [[GVNodeCheck]] || default-id="pay_external"<br/> id="check_internal"<br/> input="input" <br/>on-exception-id="end" <br />
|-<br />
| [[GVNodeCheck]]/GVRouting || condition="isInternalCCard" <br/>next-node-id="pay_internal"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/>id="pay_internal" <br/>id-system="CREDIT" <br/>input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="DataHandler" <br/>output="output"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/> id="pay_external" <br/>id-system="CREDIT_EXTERNAL" <br/> input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="PayExternal"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/gvdte-context-call || name="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalOutput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/gvdte-context-call || name="PayExternalOutput"<br />
|-<br />
| [[GVEndNode]] || end-business-process="yes" <br/>id="end" <br/>op-type="end" <br/>output="output"<br />
|}<br />
<br />
=={{GVCONSOLE}} Configuration==<br />
<br />
It is time to deploy and test your new Service. To do that follow these steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} Configuration file as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Browse... and select the file where you have saved the {{L_VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service CCardPay a new view will be open containing the files GVCore.xml present in local and in server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. Saving you return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{L_GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapters.xml and then Reload. A new windows will be open to confirm the operation<br />
# Click OK.<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{L_GVCONSOLE}} section [[Testing]]. In this section you can finally test your new services:<br />
# Into the Service voice select CCardPay<br />
# Into the System voice select CREDIT_EXTERNAL<br />
# Select the Payload on input containing the credit card number you want to use and the amount to reduce from.<br />
# Click RequestReply<br />
<br />
The Testing View will be expanded and it is also possible to view the GVBuffer Output panel where there are present some properties, among these the REC_READ property setted to 1, representing the number of record read from DB. <br />
<br />
The file TestOutput.txt will be generated in the directory <nowiki>${{gv.app.home}}</nowiki>/log as previously setted (see [[Testing]] area) containing information about the credit card numbers you passed in input and the number of records founded and updated.<br />
<syntaxhighlight lang="XML"><br />
<pre><br />
----------- TEST N. 0 2012.03.02 at 14:11:38 -----------<br />
Standard Field:<br />
system = CREDIT_EXTERNAL<br />
service = CCardPay<br />
id = 7F0001014F50AFC600014063<br />
retCode = 0<br />
GVBuffer: NULL<br />
<br />
Properties:<br />
REC_DISCARD = 0<br />
IS_INTERNAL = true<br />
REC_TOTAL = 1<br />
REC_UPDATE = 1<br />
REC_INSERT = 0<br />
REC_READ = 0<br />
CNUMBER = 1234123415555666<br />
REC_DISCARD_CAUSE = <br />
</pre><br />
</syntaxhighlight></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_CCardPay&diff=4233GVExample CCardPay2014-05-29T17:22:46Z<p>D.franco: /* {{GVCONSOLE}} Configuration */</p>
<hr />
<div>==Description==<br />
<br />
This service has the purpose of showing how {{GVESB}} uses [[DataHandler]] to query a DB and implement [[Web Services]].<br />
<br />
CCardPay Service executes the following operations:<br />
# Receives a [[Web Services|Web Service]] request from client, with a credit card number to be controlled.<br />
# If this card is locally managed, reads the data from DB using [[DataHandler]]. <br />
# If this card is managed by an external system, forwards a Web Service request to that system.<br />
# Returns the response to the client<br />
<br />
=={{VULCON}} Configuration==<br />
<br />
To configure CCardPay service follow these steps:<br />
# Define [[System|Systems]], [[Channel|Channels]] and [[Operation|Operations]]<br />
# Define the [[Service|Services]]<br />
# Implement the [[Flow|flows]].<br />
<br />
===Defining Systems, Channels and Operations===<br />
<br />
In order to define a System, go to {{VULCON}} core view and insert the System CREDIT. Inside of it create the Channel CHANNEL_CREDIT_WS in order to create an "internal" [[Participant]]. We also create the System CREDIT_EXTERNAL with the Channel CHANNEL_CREDIT_EXT corresponding to an "external" [[Participant]]. <br />
<br />
Note that the easiest way to configure a [[Web Services|Web service]] with {{L_VULCON}} is using the Wizard. We start from a [http://en.wikipedia.org/wiki/Web_service Web Service] WSDL, that describes a withdrawal operation on a credit card.<br />
<br />
From the Core view of {{L_VULCON}}, right clicking the Services element, launch the [[Wizard Call Web Service]] and, after selecting the WSDL file -in this example we use [[ExternalCreditService.wsdl]] present in folder <nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl-, choose the parameters to create the {{GVESB}} service.<br />
<br />
Two new Services, Pay and Query, and two [[ws-call]] operations, pay and query, will be created into the System CREDIT, channel CREDIT_EXTERNAL. We change those names to CCardPay and CCardQuery for the services, PayExternal and QueryExternal for the [[ws-call]] operations respectively. Now is possible to modify the workflow.<br />
<br />
From the {{L_VULCON}} Core view, element System "CREDIT" -> Channel "CHANNEL_CREDIT_WS", insert a [[dh-call]] operation and set its attributes and sub-elements as follow:<br />
<br />
* [[dh-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[dh-call]] || name="DataHandler"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]] || name="CREDIT::CCardPay" <br/> jdbc-connection-name="ds.test_gv" <br/> <br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="decimal-separator" value="."<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="grouping-separator" value=","<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="format" value="#0.00"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]] || name="CCardPay" <br/> transformation="CCardPay" <br/> type="dbo"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]]/[[statement]] || id="0" <br/> type="update"<br />
update CREDIT_CARD set CREDIT= CREDIT - ?<br />
where CNUMBER=?<br />
and ENABLED='Y'<br />
and CREDIT >= ?<br />
|}<br />
<br />
The operation defined in the DataHandler makes use of the ''data-transformation'' module for the data transformations that allows to have data in XML format. So, you need to define the following parameters into the [[GVDataTransformation]] section:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[GVDataTransformation#DataSourceSet|DataSourceSet]]/[[GVDataTransformation#LocalFSDataSource|LocalFSDataSource]] || formatHandled="xsl" name="XSLDataSource" <br/> repositoryHome=<nowiki>"${{gv.app.home}}/gvdte/datasource/xsl"</nowiki> <br/> type="datasource" <br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="CCardPay" DataSourceSet="Default" <br/> XSLMapName="DataHandler/CREDIT/[[CCardPay.xsl]]"<br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalInput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalInput.xsl]]" <br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalOutput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalOutput.xsl]]" <br/> type="transformation"<br />
|}<br />
<br />
Now define a [[ws-call]] operation into [[System]] CREDIT_EXTERNAL -> [[Channel]] CHANNEL_CREDIT_EXT. Its attributes and sub-elements defined will be setted as:<br />
* [[ws-call]]:<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| [[ws-call]] || name="PayExternal"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]] || operation="Pay" <br/> ref-dp="EXTERNAL::PayWSDataProvider"<br/> returnType="body-element"<br/> type="invoker"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/WSDLInfo || type="wsdlinfo"<br/>wsdl="file://<nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl/[[ExternalCreditService.wsdl]]"<br />
|}<br />
<br />
The ws-call operation already defined makes use of the [[Data provider]] module. So, you need to define the following parameters into the [[GVDataProviderManager]] section, present in the Adapter Core View of {{L_VULCON}}:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[Axis2MessageContextDataProvider]] || name="EXTERNAL::PayWSDataProvider"<br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field || direction="OUT" key="message"<br/><br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field/Expression || type="ognl"<br />
envelope.body.addChild(@org.apache.axis2.util.XMLUtils<br />
@toOM(#input.object.getDocumentElement()))<br />
|}<br />
<br />
===Flow implementation===<br />
<br />
[[File:GVExamplesCCardPayFlow.jpg|thumb|CCardPay flow]] In order to define the CCardPay service [[Flow]] design it as shown in the picture:<br />
<br />
<br />
The service receives a Web Service request from a client with a credit card number. If this card is managed locally, reads its data using [[DataHandler]], otherwise forwards the request to an external system using [[Web Services]].<br />
<br />
<br />
The following table shows the parameters to be defined for each Flow node:<br />
<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| first-node || Prepare<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]] || condition="isInternalCCard"<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]]/Property || name="IS_INTERNAL" operator="equal"<br/>type="gvbuffer-field"<br/>value="true"<br/>value-type="text"<br />
|-<br />
| [[ChangeGVBufferNode]] || dump-in-out="true" <br/>id="prepare" <br/>input="input" <br/>next-node-id="check_internal" <br/>clear-data="false"<br />
|-<br />
| [[ChangeGVBufferNode]]/PropertyDef || name="CNUMBER"<br/><nowiki>value="js{{gvesb::var doc=XMLUtils.parseDOM_S(new java.lang.String(object.getObject()),false,true); XMLConfig.get(doc,'//cred:cnumber')}}" </nowiki><br />
|-<br />
| [[ChangeGVBufferNode]]/PropertyDef || name="IS_INTERNAL"<br/>value="sql{{ds.test_gv::select decode(count(*), 1, 'true', 'false') from credit_card where cnumber=ognl{{#object.getProperty('CNUMBER')}}}}"<br />
|-<br />
| [[GVNodeCheck]] || default-id="PayExternal"<br/> id="check_internal"<br/> input="input" <br/>on-exception-id="end" <br />
|-<br />
| [[GVNodeCheck]]/GVRouting || condition="isInternalCCard" <br/>next-node-id="pay_internal"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/>id="pay_internal" <br/>id-system="CREDIT" <br/>input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="DataHandler" <br/>output="output"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/> id="PayExternal" <br/>id-system="CREDIT_EXTERNAL" <br/> input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="PayExternal"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/gvdte-context-call || name="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalOutput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/gvdte-context-call || name="PayExternalOutput"<br />
|-<br />
| [[GVEndNode]] || end-business-process="yes" <br/>id="end" <br/>op-type="end" <br/>output="output"<br />
|}<br />
<br />
=={{GVCONSOLE}} Configuration==<br />
<br />
It is time to deploy and test your new Service. To do that follow these steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} Configuration file as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Browse... and select the file where you have saved the {{L_VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service CCardPay a new view will be open containing the files GVCore.xml present in local and in server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. Saving you return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{L_GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapters.xml and then Reload. A new windows will be open to confirm the operation<br />
# Click OK.<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{L_GVCONSOLE}} section [[Testing]]. In this section you can finally test your new services:<br />
# Into the Service voice select CCardPay<br />
# Into the System voice select CREDIT_EXTERNAL<br />
# Select the Payload on input containing the credit card number you want to use and the amount to reduce from.<br />
# Click RequestReply<br />
<br />
The Testing View will be expanded and it is also possible to view the GVBuffer Output panel where there are present some properties, among these the REC_READ property setted to 1, representing the number of record read from DB. <br />
<br />
The file TestOutput.txt will be generated in the directory <nowiki>${{gv.app.home}}</nowiki>/log as previously setted (see [[Testing]] area) containing information about the credit card numbers you passed in input and the number of records founded and updated.<br />
<syntaxhighlight lang="XML"><br />
<pre><br />
----------- TEST N. 0 2012.03.02 at 14:11:38 -----------<br />
Standard Field:<br />
system = CREDIT_EXTERNAL<br />
service = CCardPay<br />
id = 7F0001014F50AFC600014063<br />
retCode = 0<br />
GVBuffer: NULL<br />
<br />
Properties:<br />
REC_DISCARD = 0<br />
IS_INTERNAL = true<br />
REC_TOTAL = 1<br />
REC_UPDATE = 1<br />
REC_INSERT = 0<br />
REC_READ = 0<br />
CNUMBER = 1234123415555666<br />
REC_DISCARD_CAUSE = <br />
</pre><br />
</syntaxhighlight></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_CCardPay&diff=4232GVExample CCardPay2014-05-29T17:10:02Z<p>D.franco: /* Flow implementation */</p>
<hr />
<div>==Description==<br />
<br />
This service has the purpose of showing how {{GVESB}} uses [[DataHandler]] to query a DB and implement [[Web Services]].<br />
<br />
CCardPay Service executes the following operations:<br />
# Receives a [[Web Services|Web Service]] request from client, with a credit card number to be controlled.<br />
# If this card is locally managed, reads the data from DB using [[DataHandler]]. <br />
# If this card is managed by an external system, forwards a Web Service request to that system.<br />
# Returns the response to the client<br />
<br />
=={{VULCON}} Configuration==<br />
<br />
To configure CCardPay service follow these steps:<br />
# Define [[System|Systems]], [[Channel|Channels]] and [[Operation|Operations]]<br />
# Define the [[Service|Services]]<br />
# Implement the [[Flow|flows]].<br />
<br />
===Defining Systems, Channels and Operations===<br />
<br />
In order to define a System, go to {{VULCON}} core view and insert the System CREDIT. Inside of it create the Channel CHANNEL_CREDIT_WS in order to create an "internal" [[Participant]]. We also create the System CREDIT_EXTERNAL with the Channel CHANNEL_CREDIT_EXT corresponding to an "external" [[Participant]]. <br />
<br />
Note that the easiest way to configure a [[Web Services|Web service]] with {{L_VULCON}} is using the Wizard. We start from a [http://en.wikipedia.org/wiki/Web_service Web Service] WSDL, that describes a withdrawal operation on a credit card.<br />
<br />
From the Core view of {{L_VULCON}}, right clicking the Services element, launch the [[Wizard Call Web Service]] and, after selecting the WSDL file -in this example we use [[ExternalCreditService.wsdl]] present in folder <nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl-, choose the parameters to create the {{GVESB}} service.<br />
<br />
Two new Services, Pay and Query, and two [[ws-call]] operations, pay and query, will be created into the System CREDIT, channel CREDIT_EXTERNAL. We change those names to CCardPay and CCardQuery for the services, PayExternal and QueryExternal for the [[ws-call]] operations respectively. Now is possible to modify the workflow.<br />
<br />
From the {{L_VULCON}} Core view, element System "CREDIT" -> Channel "CHANNEL_CREDIT_WS", insert a [[dh-call]] operation and set its attributes and sub-elements as follow:<br />
<br />
* [[dh-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[dh-call]] || name="DataHandler"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]] || name="CREDIT::CCardPay" <br/> jdbc-connection-name="ds.test_gv" <br/> <br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="decimal-separator" value="."<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="grouping-separator" value=","<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="format" value="#0.00"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]] || name="CCardPay" <br/> transformation="CCardPay" <br/> type="dbo"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]]/[[statement]] || id="0" <br/> type="update"<br />
update CREDIT_CARD set CREDIT= CREDIT - ?<br />
where CNUMBER=?<br />
and ENABLED='Y'<br />
and CREDIT >= ?<br />
|}<br />
<br />
The operation defined in the DataHandler makes use of the ''data-transformation'' module for the data transformations that allows to have data in XML format. So, you need to define the following parameters into the [[GVDataTransformation]] section:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[GVDataTransformation#DataSourceSet|DataSourceSet]]/[[GVDataTransformation#LocalFSDataSource|LocalFSDataSource]] || formatHandled="xsl" name="XSLDataSource" <br/> repositoryHome=<nowiki>"${{gv.app.home}}/gvdte/datasource/xsl"</nowiki> <br/> type="datasource" <br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="CCardPay" DataSourceSet="Default" <br/> XSLMapName="DataHandler/CREDIT/[[CCardPay.xsl]]"<br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalInput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalInput.xsl]]" <br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalOutput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalOutput.xsl]]" <br/> type="transformation"<br />
|}<br />
<br />
Now define a [[ws-call]] operation into [[System]] CREDIT_EXTERNAL -> [[Channel]] CHANNEL_CREDIT_EXT. Its attributes and sub-elements defined will be setted as:<br />
* [[ws-call]]:<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| [[ws-call]] || name="PayExternal"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]] || operation="Pay" <br/> ref-dp="EXTERNAL::PayWSDataProvider"<br/> returnType="body-element"<br/> type="invoker"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/WSDLInfo || type="wsdlinfo"<br/>wsdl="file://<nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl/[[ExternalCreditService.wsdl]]"<br />
|}<br />
<br />
The ws-call operation already defined makes use of the [[Data provider]] module. So, you need to define the following parameters into the [[GVDataProviderManager]] section, present in the Adapter Core View of {{L_VULCON}}:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[Axis2MessageContextDataProvider]] || name="EXTERNAL::PayWSDataProvider"<br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field || direction="OUT" key="message"<br/><br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field/Expression || type="ognl"<br />
envelope.body.addChild(@org.apache.axis2.util.XMLUtils<br />
@toOM(#input.object.getDocumentElement()))<br />
|}<br />
<br />
===Flow implementation===<br />
<br />
[[File:GVExamplesCCardPayFlow.jpg|thumb|CCardPay flow]] In order to define the CCardPay service [[Flow]] design it as shown in the picture:<br />
<br />
<br />
The service receives a Web Service request from a client with a credit card number. If this card is managed locally, reads its data using [[DataHandler]], otherwise forwards the request to an external system using [[Web Services]].<br />
<br />
<br />
The following table shows the parameters to be defined for each Flow node:<br />
<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| first-node || Prepare<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]] || condition="isInternalCCard"<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]]/Property || name="IS_INTERNAL" operator="equal"<br/>type="gvbuffer-field"<br/>value="true"<br/>value-type="text"<br />
|-<br />
| [[ChangeGVBufferNode]] || dump-in-out="true" <br/>id="prepare" <br/>input="input" <br/>next-node-id="check_internal" <br/>clear-data="false"<br />
|-<br />
| [[ChangeGVBufferNode]]/PropertyDef || name="CNUMBER"<br/><nowiki>value="js{{gvesb::var doc=XMLUtils.parseDOM_S(new java.lang.String(object.getObject()),false,true); XMLConfig.get(doc,'//cred:cnumber')}}" </nowiki><br />
|-<br />
| [[ChangeGVBufferNode]]/PropertyDef || name="IS_INTERNAL"<br/>value="sql{{ds.test_gv::select decode(count(*), 1, 'true', 'false') from credit_card where cnumber=ognl{{#object.getProperty('CNUMBER')}}}}"<br />
|-<br />
| [[GVNodeCheck]] || default-id="PayExternal"<br/> id="check_internal"<br/> input="input" <br/>on-exception-id="end" <br />
|-<br />
| [[GVNodeCheck]]/GVRouting || condition="isInternalCCard" <br/>next-node-id="pay_internal"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/>id="pay_internal" <br/>id-system="CREDIT" <br/>input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="DataHandler" <br/>output="output"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/> id="PayExternal" <br/>id-system="CREDIT_EXTERNAL" <br/> input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="PayExternal"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/gvdte-context-call || name="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalOutput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/gvdte-context-call || name="PayExternalOutput"<br />
|-<br />
| [[GVEndNode]] || end-business-process="yes" <br/>id="end" <br/>op-type="end" <br/>output="output"<br />
|}<br />
<br />
=={{GVCONSOLE}} Configuration==<br />
<br />
It is time to deploy and test your new Service. To do that follows these steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} Configuration file as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Sfoglia... (Browse) and select the file where you have saved the {{L_VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service CCardPay a new view will be open containing the files GVCore.xml present in local and in server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. Saving you return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{L_GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapters.xml and then Reload. A new windows will be open to confirm the operation<br />
# Click OK.<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{L_GVCONSOLE}} section [[Testing]]. In this section you can finally test your new services:<br />
# Into the Service voice select CCardPay<br />
# Into the System voice select CREDIT_EXTERNAL<br />
# Select the Payload on input containing the credit card number you want to use and the amount to reduce from.<br />
# Click RequestReply<br />
<br />
The Testing View will be expanded and it is also possible to view the GVBuffer Output panel where there are present some properties, among these the REC_READ property setted to 1, representing the number of record read from DB. <br />
<br />
The file TestOutput.txt will be generated in the directory <nowiki>${{gv.app.home}}</nowiki>/log as previously setted (see [[Testing]] area) containing information about the credit card numbers you passed in input and the number of records founded and updated.<br />
<syntaxhighlight lang="XML"><br />
<pre><br />
----------- TEST N. 0 2012.03.02 at 14:11:38 -----------<br />
Standard Field:<br />
system = CREDIT_EXTERNAL<br />
service = CCardPay<br />
id = 7F0001014F50AFC600014063<br />
retCode = 0<br />
GVBuffer: NULL<br />
<br />
Properties:<br />
REC_DISCARD = 0<br />
IS_INTERNAL = true<br />
REC_TOTAL = 1<br />
REC_UPDATE = 1<br />
REC_INSERT = 0<br />
REC_READ = 0<br />
CNUMBER = 1234123415555666<br />
REC_DISCARD_CAUSE = <br />
</pre><br />
</syntaxhighlight></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_CCardPay&diff=4231GVExample CCardPay2014-05-29T16:52:22Z<p>D.franco: /* Flow implementation */</p>
<hr />
<div>==Description==<br />
<br />
This service has the purpose of showing how {{GVESB}} uses [[DataHandler]] to query a DB and implement [[Web Services]].<br />
<br />
CCardPay Service executes the following operations:<br />
# Receives a [[Web Services|Web Service]] request from client, with a credit card number to be controlled.<br />
# If this card is locally managed, reads the data from DB using [[DataHandler]]. <br />
# If this card is managed by an external system, forwards a Web Service request to that system.<br />
# Returns the response to the client<br />
<br />
=={{VULCON}} Configuration==<br />
<br />
To configure CCardPay service follow these steps:<br />
# Define [[System|Systems]], [[Channel|Channels]] and [[Operation|Operations]]<br />
# Define the [[Service|Services]]<br />
# Implement the [[Flow|flows]].<br />
<br />
===Defining Systems, Channels and Operations===<br />
<br />
In order to define a System, go to {{VULCON}} core view and insert the System CREDIT. Inside of it create the Channel CHANNEL_CREDIT_WS in order to create an "internal" [[Participant]]. We also create the System CREDIT_EXTERNAL with the Channel CHANNEL_CREDIT_EXT corresponding to an "external" [[Participant]]. <br />
<br />
Note that the easiest way to configure a [[Web Services|Web service]] with {{L_VULCON}} is using the Wizard. We start from a [http://en.wikipedia.org/wiki/Web_service Web Service] WSDL, that describes a withdrawal operation on a credit card.<br />
<br />
From the Core view of {{L_VULCON}}, right clicking the Services element, launch the [[Wizard Call Web Service]] and, after selecting the WSDL file -in this example we use [[ExternalCreditService.wsdl]] present in folder <nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl-, choose the parameters to create the {{GVESB}} service.<br />
<br />
Two new Services, Pay and Query, and two [[ws-call]] operations, pay and query, will be created into the System CREDIT, channel CREDIT_EXTERNAL. We change those names to CCardPay and CCardQuery for the services, PayExternal and QueryExternal for the [[ws-call]] operations respectively. Now is possible to modify the workflow.<br />
<br />
From the {{L_VULCON}} Core view, element System "CREDIT" -> Channel "CHANNEL_CREDIT_WS", insert a [[dh-call]] operation and set its attributes and sub-elements as follow:<br />
<br />
* [[dh-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[dh-call]] || name="DataHandler"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]] || name="CREDIT::CCardPay" <br/> jdbc-connection-name="ds.test_gv" <br/> <br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="decimal-separator" value="."<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="grouping-separator" value=","<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="format" value="#0.00"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]] || name="CCardPay" <br/> transformation="CCardPay" <br/> type="dbo"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]]/[[statement]] || id="0" <br/> type="update"<br />
update CREDIT_CARD set CREDIT= CREDIT - ?<br />
where CNUMBER=?<br />
and ENABLED='Y'<br />
and CREDIT >= ?<br />
|}<br />
<br />
The operation defined in the DataHandler makes use of the ''data-transformation'' module for the data transformations that allows to have data in XML format. So, you need to define the following parameters into the [[GVDataTransformation]] section:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[GVDataTransformation#DataSourceSet|DataSourceSet]]/[[GVDataTransformation#LocalFSDataSource|LocalFSDataSource]] || formatHandled="xsl" name="XSLDataSource" <br/> repositoryHome=<nowiki>"${{gv.app.home}}/gvdte/datasource/xsl"</nowiki> <br/> type="datasource" <br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="CCardPay" DataSourceSet="Default" <br/> XSLMapName="DataHandler/CREDIT/[[CCardPay.xsl]]"<br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalInput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalInput.xsl]]" <br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalOutput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalOutput.xsl]]" <br/> type="transformation"<br />
|}<br />
<br />
Now define a [[ws-call]] operation into [[System]] CREDIT_EXTERNAL -> [[Channel]] CHANNEL_CREDIT_EXT. Its attributes and sub-elements defined will be setted as:<br />
* [[ws-call]]:<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| [[ws-call]] || name="PayExternal"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]] || operation="Pay" <br/> ref-dp="EXTERNAL::PayWSDataProvider"<br/> returnType="body-element"<br/> type="invoker"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/WSDLInfo || type="wsdlinfo"<br/>wsdl="file://<nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl/[[ExternalCreditService.wsdl]]"<br />
|}<br />
<br />
The ws-call operation already defined makes use of the [[Data provider]] module. So, you need to define the following parameters into the [[GVDataProviderManager]] section, present in the Adapter Core View of {{L_VULCON}}:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[Axis2MessageContextDataProvider]] || name="EXTERNAL::PayWSDataProvider"<br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field || direction="OUT" key="message"<br/><br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field/Expression || type="ognl"<br />
envelope.body.addChild(@org.apache.axis2.util.XMLUtils<br />
@toOM(#input.object.getDocumentElement()))<br />
|}<br />
<br />
===Flow implementation===<br />
<br />
[[File:GVExamplesCCardPayFlow.jpg|thumb|CCardPay flow]] In order to define the CCardPay service [[Flow]] design it as shown in the picture:<br />
<br />
<br />
The service receives a Web Service request from a client with a credit card number. If this card is managed locally, reads its data using [[DataHandler]], otherwise forwards the request to an external system using [[Web Services]].<br />
<br />
<br />
The following table shows the parameters to be defined for each Flow node:<br />
<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| first-node || Prepare<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]] || condition="isInternalCCard"<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]]/Property || name="IS_INTERNAL" operator="equal"<br/>type="gvbuffer-field"<br/>value="true"<br/>value-type="text"<br />
|-<br />
| [[ChangeGVBufferNode]] || dump-in-out="true" <br/>id="prepare" <br/>input="input" <br/>next-node-id="check_internal" <br/>clear-data="false"<br />
|-<br />
| [[ChangeGVBufferNode]]/PropertyDef || name="CNUMBER"<br/><nowiki>value="js{{gvesb::var doc=XMLUtils.parseDOM_S(new java.lang.String(object.getObject()),false,true); XMLConfig.get(doc,'//cred:cnumber')}}" </nowiki><br />
|-<br />
| [[ChangeGVBufferNode]]/PropertyDef || name="IS_INTERNAL"<br/>value="sql{{ds.test_gv::select decode(count(*), 1, 'true', 'false') from credit_card where cnumber=ognl{{#object.getProperty('CNUMBER')}}}}"<br />
|-<br />
| [[GVNodeCheck]] || default-id="PayExternal"<br/> id="check_internal"<br/> input="input" <br/>on-exception-id="end" <br />
|-<br />
| [[GVNodeCheck]]/GVRouting || condition="isInternalCCard" <br/>next-node-id="pay_internal"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/>id="pay_internal" <br/>id-system="CREDIT" <br/>input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="DataHandler" <br/>output="output"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/> id="pay_external" <br/>id-system="CREDIT_EXTERNAL" <br/> input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="PayExternal"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/gvdte-context-call || name="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalOutput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/gvdte-context-call || name="PayExternalOutput"<br />
|-<br />
| [[GVEndNode]] || end-business-process="yes" <br/>id="end" <br/>op-type="end" <br/>output="output"<br />
|}<br />
<br />
=={{GVCONSOLE}} Configuration==<br />
<br />
It is time to deploy and test your new Service. To do that follows these steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} Configuration file as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Sfoglia... (Browse) and select the file where you have saved the {{L_VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service CCardPay a new view will be open containing the files GVCore.xml present in local and in server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. Saving you return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{L_GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapters.xml and then Reload. A new windows will be open to confirm the operation<br />
# Click OK.<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{L_GVCONSOLE}} section [[Testing]]. In this section you can finally test your new services:<br />
# Into the Service voice select CCardPay<br />
# Into the System voice select CREDIT_EXTERNAL<br />
# Select the Payload on input containing the credit card number you want to use and the amount to reduce from.<br />
# Click RequestReply<br />
<br />
The Testing View will be expanded and it is also possible to view the GVBuffer Output panel where there are present some properties, among these the REC_READ property setted to 1, representing the number of record read from DB. <br />
<br />
The file TestOutput.txt will be generated in the directory <nowiki>${{gv.app.home}}</nowiki>/log as previously setted (see [[Testing]] area) containing information about the credit card numbers you passed in input and the number of records founded and updated.<br />
<syntaxhighlight lang="XML"><br />
<pre><br />
----------- TEST N. 0 2012.03.02 at 14:11:38 -----------<br />
Standard Field:<br />
system = CREDIT_EXTERNAL<br />
service = CCardPay<br />
id = 7F0001014F50AFC600014063<br />
retCode = 0<br />
GVBuffer: NULL<br />
<br />
Properties:<br />
REC_DISCARD = 0<br />
IS_INTERNAL = true<br />
REC_TOTAL = 1<br />
REC_UPDATE = 1<br />
REC_INSERT = 0<br />
REC_READ = 0<br />
CNUMBER = 1234123415555666<br />
REC_DISCARD_CAUSE = <br />
</pre><br />
</syntaxhighlight></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_CCardPay&diff=4230GVExample CCardPay2014-05-29T16:46:17Z<p>D.franco: /* Flow implementation */</p>
<hr />
<div>==Description==<br />
<br />
This service has the purpose of showing how {{GVESB}} uses [[DataHandler]] to query a DB and implement [[Web Services]].<br />
<br />
CCardPay Service executes the following operations:<br />
# Receives a [[Web Services|Web Service]] request from client, with a credit card number to be controlled.<br />
# If this card is locally managed, reads the data from DB using [[DataHandler]]. <br />
# If this card is managed by an external system, forwards a Web Service request to that system.<br />
# Returns the response to the client<br />
<br />
=={{VULCON}} Configuration==<br />
<br />
To configure CCardPay service follow these steps:<br />
# Define [[System|Systems]], [[Channel|Channels]] and [[Operation|Operations]]<br />
# Define the [[Service|Services]]<br />
# Implement the [[Flow|flows]].<br />
<br />
===Defining Systems, Channels and Operations===<br />
<br />
In order to define a System, go to {{VULCON}} core view and insert the System CREDIT. Inside of it create the Channel CHANNEL_CREDIT_WS in order to create an "internal" [[Participant]]. We also create the System CREDIT_EXTERNAL with the Channel CHANNEL_CREDIT_EXT corresponding to an "external" [[Participant]]. <br />
<br />
Note that the easiest way to configure a [[Web Services|Web service]] with {{L_VULCON}} is using the Wizard. We start from a [http://en.wikipedia.org/wiki/Web_service Web Service] WSDL, that describes a withdrawal operation on a credit card.<br />
<br />
From the Core view of {{L_VULCON}}, right clicking the Services element, launch the [[Wizard Call Web Service]] and, after selecting the WSDL file -in this example we use [[ExternalCreditService.wsdl]] present in folder <nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl-, choose the parameters to create the {{GVESB}} service.<br />
<br />
Two new Services, Pay and Query, and two [[ws-call]] operations, pay and query, will be created into the System CREDIT, channel CREDIT_EXTERNAL. We change those names to CCardPay and CCardQuery for the services, PayExternal and QueryExternal for the [[ws-call]] operations respectively. Now is possible to modify the workflow.<br />
<br />
From the {{L_VULCON}} Core view, element System "CREDIT" -> Channel "CHANNEL_CREDIT_WS", insert a [[dh-call]] operation and set its attributes and sub-elements as follow:<br />
<br />
* [[dh-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[dh-call]] || name="DataHandler"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]] || name="CREDIT::CCardPay" <br/> jdbc-connection-name="ds.test_gv" <br/> <br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="decimal-separator" value="."<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="grouping-separator" value=","<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="format" value="#0.00"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]] || name="CCardPay" <br/> transformation="CCardPay" <br/> type="dbo"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]]/[[statement]] || id="0" <br/> type="update"<br />
update CREDIT_CARD set CREDIT= CREDIT - ?<br />
where CNUMBER=?<br />
and ENABLED='Y'<br />
and CREDIT >= ?<br />
|}<br />
<br />
The operation defined in the DataHandler makes use of the ''data-transformation'' module for the data transformations that allows to have data in XML format. So, you need to define the following parameters into the [[GVDataTransformation]] section:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[GVDataTransformation#DataSourceSet|DataSourceSet]]/[[GVDataTransformation#LocalFSDataSource|LocalFSDataSource]] || formatHandled="xsl" name="XSLDataSource" <br/> repositoryHome=<nowiki>"${{gv.app.home}}/gvdte/datasource/xsl"</nowiki> <br/> type="datasource" <br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="CCardPay" DataSourceSet="Default" <br/> XSLMapName="DataHandler/CREDIT/[[CCardPay.xsl]]"<br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalInput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalInput.xsl]]" <br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalOutput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalOutput.xsl]]" <br/> type="transformation"<br />
|}<br />
<br />
Now define a [[ws-call]] operation into [[System]] CREDIT_EXTERNAL -> [[Channel]] CHANNEL_CREDIT_EXT. Its attributes and sub-elements defined will be setted as:<br />
* [[ws-call]]:<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| [[ws-call]] || name="PayExternal"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]] || operation="Pay" <br/> ref-dp="EXTERNAL::PayWSDataProvider"<br/> returnType="body-element"<br/> type="invoker"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/WSDLInfo || type="wsdlinfo"<br/>wsdl="file://<nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl/[[ExternalCreditService.wsdl]]"<br />
|}<br />
<br />
The ws-call operation already defined makes use of the [[Data provider]] module. So, you need to define the following parameters into the [[GVDataProviderManager]] section, present in the Adapter Core View of {{L_VULCON}}:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[Axis2MessageContextDataProvider]] || name="EXTERNAL::PayWSDataProvider"<br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field || direction="OUT" key="message"<br/><br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field/Expression || type="ognl"<br />
envelope.body.addChild(@org.apache.axis2.util.XMLUtils<br />
@toOM(#input.object.getDocumentElement()))<br />
|}<br />
<br />
===Flow implementation===<br />
<br />
[[File:GVExamplesCCardPayFlow.jpg|thumb|CCardPay flow]] In order to define the CCardPay service [[Flow]] design it as shown in the picture:<br />
<br />
<br />
The service receives a Web Service request from a client with a credit card number. If this card is managed locally, reads its data using [[DataHandler]], otherwise forwards the request to an external system using [[Web Services]].<br />
<br />
<br />
The following table shows the parameters to be defined for each Flow node:<br />
<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| first-node || Prepare<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]] || condition="isInternalCCard"<br />
|-<br />
| [[Conditions]]/[[GVBufferCondition]]/Property || name="IS_INTERNAL" operator="equal"<br/>type="gvbuffer-field"<br/>value="true"<br/>value-type="text"<br />
|-<br />
| [[ChangeGVBufferNode]] || dump-in-out="true" <br/>id="prepare" <br/>input="input" <br/>next-node-id="check_internal" <br/>clear-data="false"<br />
|-<br />
| [[ChangeGVBufferNode]]/PropertyDef || name="CNUMBER"<br/><nowiki>value="js{{gvesb::var doc=XMLUtils.parseDOM_S(new java.lang.String(object.getObject()),false,true); XMLConfig.get(doc,'//cred:cnumber')}}" </nowiki><br />
|-<br />
| [[ChangeGVBufferNode]]/PropertyDef || name="IS_INTERNAL"<br/>value="sql{{ds.test_gv::select decode(count(*), 1, 'true', 'false') from credit_card where cnumber=ognl{{#object.getProperty('CNUMBER')}}}}"<br />
|-<br />
| [[GVNodeCheck]] || default-id="pay_external"<br/> id="check_internal"<br/> input="input" <br/>on-exception-id="end" <br />
|-<br />
| [[GVNodeCheck]]/GVRouting || condition="isInternalCCard" <br/>next-node-id="pay_internal"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/>id="pay_internal" <br/>id-system="CREDIT" <br/>input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="DataHandler" <br/>output="output"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/> id="pay_external" <br/>id-system="CREDIT_EXTERNAL" <br/> input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="PayExternal"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/gvdte-context-call || name="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalOutput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/gvdte-context-call || name="PayExternalOutput"<br />
|-<br />
| [[GVEndNode]] || end-business-process="yes" <br/>id="end" <br/>op-type="end" <br/>output="output"<br />
|}<br />
<br />
=={{GVCONSOLE}} Configuration==<br />
<br />
It is time to deploy and test your new Service. To do that follows these steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} Configuration file as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Sfoglia... (Browse) and select the file where you have saved the {{L_VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service CCardPay a new view will be open containing the files GVCore.xml present in local and in server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. Saving you return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{L_GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapters.xml and then Reload. A new windows will be open to confirm the operation<br />
# Click OK.<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{L_GVCONSOLE}} section [[Testing]]. In this section you can finally test your new services:<br />
# Into the Service voice select CCardPay<br />
# Into the System voice select CREDIT_EXTERNAL<br />
# Select the Payload on input containing the credit card number you want to use and the amount to reduce from.<br />
# Click RequestReply<br />
<br />
The Testing View will be expanded and it is also possible to view the GVBuffer Output panel where there are present some properties, among these the REC_READ property setted to 1, representing the number of record read from DB. <br />
<br />
The file TestOutput.txt will be generated in the directory <nowiki>${{gv.app.home}}</nowiki>/log as previously setted (see [[Testing]] area) containing information about the credit card numbers you passed in input and the number of records founded and updated.<br />
<syntaxhighlight lang="XML"><br />
<pre><br />
----------- TEST N. 0 2012.03.02 at 14:11:38 -----------<br />
Standard Field:<br />
system = CREDIT_EXTERNAL<br />
service = CCardPay<br />
id = 7F0001014F50AFC600014063<br />
retCode = 0<br />
GVBuffer: NULL<br />
<br />
Properties:<br />
REC_DISCARD = 0<br />
IS_INTERNAL = true<br />
REC_TOTAL = 1<br />
REC_UPDATE = 1<br />
REC_INSERT = 0<br />
REC_READ = 0<br />
CNUMBER = 1234123415555666<br />
REC_DISCARD_CAUSE = <br />
</pre><br />
</syntaxhighlight></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_CCardPay&diff=4229GVExample CCardPay2014-05-29T16:19:02Z<p>D.franco: /* Defining Systems, Channels and Operations */</p>
<hr />
<div>==Description==<br />
<br />
This service has the purpose of showing how {{GVESB}} uses [[DataHandler]] to query a DB and implement [[Web Services]].<br />
<br />
CCardPay Service executes the following operations:<br />
# Receives a [[Web Services|Web Service]] request from client, with a credit card number to be controlled.<br />
# If this card is locally managed, reads the data from DB using [[DataHandler]]. <br />
# If this card is managed by an external system, forwards a Web Service request to that system.<br />
# Returns the response to the client<br />
<br />
=={{VULCON}} Configuration==<br />
<br />
To configure CCardPay service follow these steps:<br />
# Define [[System|Systems]], [[Channel|Channels]] and [[Operation|Operations]]<br />
# Define the [[Service|Services]]<br />
# Implement the [[Flow|flows]].<br />
<br />
===Defining Systems, Channels and Operations===<br />
<br />
In order to define a System, go to {{VULCON}} core view and insert the System CREDIT. Inside of it create the Channel CHANNEL_CREDIT_WS in order to create an "internal" [[Participant]]. We also create the System CREDIT_EXTERNAL with the Channel CHANNEL_CREDIT_EXT corresponding to an "external" [[Participant]]. <br />
<br />
Note that the easiest way to configure a [[Web Services|Web service]] with {{L_VULCON}} is using the Wizard. We start from a [http://en.wikipedia.org/wiki/Web_service Web Service] WSDL, that describes a withdrawal operation on a credit card.<br />
<br />
From the Core view of {{L_VULCON}}, right clicking the Services element, launch the [[Wizard Call Web Service]] and, after selecting the WSDL file -in this example we use [[ExternalCreditService.wsdl]] present in folder <nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl-, choose the parameters to create the {{GVESB}} service.<br />
<br />
Two new Services, Pay and Query, and two [[ws-call]] operations, pay and query, will be created into the System CREDIT, channel CREDIT_EXTERNAL. We change those names to CCardPay and CCardQuery for the services, PayExternal and QueryExternal for the [[ws-call]] operations respectively. Now is possible to modify the workflow.<br />
<br />
From the {{L_VULCON}} Core view, element System "CREDIT" -> Channel "CHANNEL_CREDIT_WS", insert a [[dh-call]] operation and set its attributes and sub-elements as follow:<br />
<br />
* [[dh-call]]:<br />
{|class="gvtable"<br />
! Element !! Value <br />
|-<br />
| [[dh-call]] || name="DataHandler"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]] || name="CREDIT::CCardPay" <br/> jdbc-connection-name="ds.test_gv" <br/> <br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="decimal-separator" value="."<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="grouping-separator" value=","<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DHVariables]]/[[DHVariables#DHVariable|DHVariable]] || name="format" value="#0.00"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]] || name="CCardPay" <br/> transformation="CCardPay" <br/> type="dbo"<br />
|-<br />
| [[dh-call]]/[[DBOBuilder]]/[[DBOUpdate]]/[[statement]] || id="0" <br/> type="update"<br />
update CREDIT_CARD set CREDIT= CREDIT - ?<br />
where CNUMBER=?<br />
and ENABLED='Y'<br />
and CREDIT >= ?<br />
|}<br />
<br />
The operation defined in the DataHandler makes use of the ''data-transformation'' module for the data transformations that allows to have data in XML format. So, you need to define the following parameters into the [[GVDataTransformation]] section:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[GVDataTransformation#DataSourceSet|DataSourceSet]]/[[GVDataTransformation#LocalFSDataSource|LocalFSDataSource]] || formatHandled="xsl" name="XSLDataSource" <br/> repositoryHome=<nowiki>"${{gv.app.home}}/gvdte/datasource/xsl"</nowiki> <br/> type="datasource" <br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="CCardPay" DataSourceSet="Default" <br/> XSLMapName="DataHandler/CREDIT/[[CCardPay.xsl]]"<br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalInput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalInput.xsl]]" <br/> type="transformation"<br />
|-<br />
| Transformations/[[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalOutput" DataSourceSet="Default" <br/> XSLMapName="CREDIT_EXTERNAL/[[PayExternalOutput.xsl]]" <br/> type="transformation"<br />
|}<br />
<br />
Now define a [[ws-call]] operation into [[System]] CREDIT_EXTERNAL -> [[Channel]] CHANNEL_CREDIT_EXT. Its attributes and sub-elements defined will be setted as:<br />
* [[ws-call]]:<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| [[ws-call]] || name="PayExternal"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]] || operation="Pay" <br/> ref-dp="EXTERNAL::PayWSDataProvider"<br/> returnType="body-element"<br/> type="invoker"<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]]/WSDLInfo || type="wsdlinfo"<br/>wsdl="file://<nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl/[[ExternalCreditService.wsdl]]"<br />
|}<br />
<br />
The ws-call operation already defined makes use of the [[Data provider]] module. So, you need to define the following parameters into the [[GVDataProviderManager]] section, present in the Adapter Core View of {{L_VULCON}}:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[Axis2MessageContextDataProvider]] || name="EXTERNAL::PayWSDataProvider"<br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field || direction="OUT" key="message"<br/><br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field/Expression || type="ognl"<br />
envelope.body.addChild(@org.apache.axis2.util.XMLUtils<br />
@toOM(#input.object.getDocumentElement()))<br />
|}<br />
<br />
===Flow implementation===<br />
<br />
[[File:GVExamplesCCardPayFlow.jpg|thumb|CCardPay flow]] In order to define the CCardPay service [[Flow]] design it as shown in the picture:<br />
<br />
<br />
The service receives a Web Service request from a client with a credit card number. If this card is managed locally, reads its data using [[DataHandler]], otherwise forwards the request to an external system using [[Web Services]].<br />
<br />
<br />
The following table shows the parameters to be defined for each Flow node:<br />
<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| first-node || Prepare<br />
|-<br />
| [[Conditions]]/GVBufferCondition || condition="isInternalCCard" <br/> Property:<br />
: name="IS_INTERNAL" operator="equal"<br/>type="gvbuffer-field"<br/>value="true"<br/>value-type="text"<br />
|-<br />
| [[ChangeGVBufferNode]] || dump-in-out="true" <br/>id="prepare" <br/>input="input" <br/>next-node-id="check_internal" <br/>clear-data="false" <br/>PropertyDef:<br />
: name="CNUMBER"<br/><nowiki>value="js{{gvesb::var doc=XMLUtils.parseDOM_S(new java.lang.String(object.getObject()),false,true); XMLConfig.get(doc,'//cred:cnumber')}}" </nowiki><br/><br />
PropertyDef:<br />
: name="IS_INTERNAL"<br/>value="sql{{ds.test_gv::select decode(count(*), 1, 'true', 'false') from credit_card where <br />
:: cnumber=ognl{{#object.getProperty('CNUMBER')}}}}"<br />
|-<br />
| [[GVNodeCheck]] || default-id="pay_external"<br/> id="check_internal"<br/> input="input" <br/>on-exception-id="end" <br />
|-<br />
| [[GVNodeCheck]]/GVRouting || condition="isInternalCCard" <br/>next-node-id="pay_internal"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/>id="pay_internal" <br/>id-system="CREDIT" <br/>input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="DataHandler" <br/>output="output"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/> id="pay_external" <br/>id-system="CREDIT_EXTERNAL" <br/> input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="PayExternal"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/gvdte-context-call || name="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalOutput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/gvdte-context-call || name="PayExternalOutput"<br />
|-<br />
| [[GVEndNode]] || end-business-process="yes" <br/>id="end" <br/>op-type="end" <br/>output="output"<br />
|}<br />
<br />
=={{GVCONSOLE}} Configuration==<br />
<br />
It is time to deploy and test your new Service. To do that follows these steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} Configuration file as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Sfoglia... (Browse) and select the file where you have saved the {{L_VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service CCardPay a new view will be open containing the files GVCore.xml present in local and in server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. Saving you return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{L_GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapters.xml and then Reload. A new windows will be open to confirm the operation<br />
# Click OK.<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{L_GVCONSOLE}} section [[Testing]]. In this section you can finally test your new services:<br />
# Into the Service voice select CCardPay<br />
# Into the System voice select CREDIT_EXTERNAL<br />
# Select the Payload on input containing the credit card number you want to use and the amount to reduce from.<br />
# Click RequestReply<br />
<br />
The Testing View will be expanded and it is also possible to view the GVBuffer Output panel where there are present some properties, among these the REC_READ property setted to 1, representing the number of record read from DB. <br />
<br />
The file TestOutput.txt will be generated in the directory <nowiki>${{gv.app.home}}</nowiki>/log as previously setted (see [[Testing]] area) containing information about the credit card numbers you passed in input and the number of records founded and updated.<br />
<syntaxhighlight lang="XML"><br />
<pre><br />
----------- TEST N. 0 2012.03.02 at 14:11:38 -----------<br />
Standard Field:<br />
system = CREDIT_EXTERNAL<br />
service = CCardPay<br />
id = 7F0001014F50AFC600014063<br />
retCode = 0<br />
GVBuffer: NULL<br />
<br />
Properties:<br />
REC_DISCARD = 0<br />
IS_INTERNAL = true<br />
REC_TOTAL = 1<br />
REC_UPDATE = 1<br />
REC_INSERT = 0<br />
REC_READ = 0<br />
CNUMBER = 1234123415555666<br />
REC_DISCARD_CAUSE = <br />
</pre><br />
</syntaxhighlight></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_CCardPay&diff=4228GVExample CCardPay2014-05-29T14:27:48Z<p>D.franco: /* Description */</p>
<hr />
<div>==Description==<br />
<br />
This service has the purpose of showing how {{GVESB}} uses [[DataHandler]] to query a DB and implement [[Web Services]].<br />
<br />
CCardPay Service executes the following operations:<br />
# Receives a [[Web Services|Web Service]] request from client, with a credit card number to be controlled.<br />
# If this card is locally managed, reads the data from DB using [[DataHandler]]. <br />
# If this card is managed by an external system, forwards a Web Service request to that system.<br />
# Returns the response to the client<br />
<br />
=={{VULCON}} Configuration==<br />
<br />
To configure CCardPay service follow these steps:<br />
# Define [[System|Systems]], [[Channel|Channels]] and [[Operation|Operations]]<br />
# Define the [[Service|Services]]<br />
# Implement the [[Flow|flows]].<br />
<br />
===Defining Systems, Channels and Operations===<br />
<br />
In order to define a System, go to {{VULCON}} core view and insert the System CREDIT. Inside of it create the Channel CHANNEL_CREDIT_WS in order to create an "internal" [[Participant]]. We also create the System CREDIT_EXTERNAL with the Channel CHANNEL_CREDIT_EXT corresponding to an "external" [[Participant]]. <br />
<br />
Note that the easiest way to configure a [[Web Services|Web service]] with {{L_VULCON}} is using the Wizard. We start from a [http://en.wikipedia.org/wiki/Web_service Web Service] WSDL, that describes a withdrawal operation on a credit card.<br />
<br />
From the Core view of {{L_VULCON}}, right clicking the Services element, launch the [[Wizard Call Web Service]] and, after selecting the WSDL file -in this example we use [[ExternalCreditService.wsdl]] present in folder <nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl-, choose the parameters to create the {{GVESB}} service.<br />
<br />
A two new Services, Pay and Query, and two [[ws-call]] operations, pay and query will be created into the System CREDIT, channel CREDIT_EXTERNAL. We changed those names to CCardPay and CCardQuery for the services, PayExternal and QueryExternal for the [[ws-call]] operations respectively. Now you can modify your workflow.<br />
<br />
From the {{L_VULCON}} Core view, element System "CREDIT" -> Channel "CHANNEL_CREDIT_WS", insert a [[dh-call]] operation and set its attributes and sub-elements as follow:<br />
<br />
* [[dh-call]]:<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| name || DataHandler<br />
|-<br />
| [[dh-call]]/DBOBuilder || name="CREDIT::CCardPay" <br/> jdbc-connection-name="ds.test_gv" <br/> <br />
DHVariables:<br />
: name="decimal-separator" value="."<br />
: name="grouping-separator" value=","<br />
: name="format" value="#0.00"<br />
|-<br />
| [[dh-call]]/DBOBuilder/DBOUpdate || name="CCardPay" <br/> transformation="CCardPay" <br/> type="dbo" <br/>statement:<br />
: id="0" <br/> type="update"<br />
update CREDIT_CARD set CREDIT= CREDIT - ?<br />
where CNUMBER=?<br />
and ENABLED='Y'<br />
and CREDIT >= ?<br />
|}<br />
<br />
The operation defined in the DataHandler makes use of the ''data-transformation'' module for the data transformations that allows to have data in XML format. So, you need to define the following parameters into the [[GVDataTransformation]] section:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[GVDataTransformation#DataSourceSet|DataSourceSet]]/[[GVDataTransformation#LocalFSDataSource|LocalFSDataSource]] || formatHandled="xsl" name="XSLDataSource" <br/> repositoryHome=<nowiki>"${{gv.app.home}}/gvdte/datasource/xsl"</nowiki> <br/> type="datasource" <br />
|-<br />
| [[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="CCardPay" DataSourceSet="Default" <br/> XSLMapName="DataHandler/CREDIT/[[CCardPay.xsl]]"<br/> type="transformation"<br />
|-<br />
| [[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalInput" DataSourceSet="Default" <br/> XSLMapName=" CREDIT_EXTERNAL/[[PayExternalInput.xsl]]" <br/> type="transformation"<br />
|-<br />
| [[GVDataTransformation#XSLTransformation|XSLTransformation]] || name="PayExternalOutput" DataSourceSet="Default" <br/> XSLMapName=" CREDIT_EXTERNAL/[[PayExternalOutput.xsl]]" <br/> type="transformation"<br />
|}<br />
<br />
Now define a [[ws-call]] operation into [[System]] CREDIT_EXTERNAL -> [[Channel]] CHANNEL_CREDIT_EXT. Its attributes and sub-elements defined will be setted as:<br />
* [[ws-call]]:<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| Name || PayExternal<br />
|-<br />
| [[Ws-call#AxisWebServiceInvoker|ws-call/AxisWebServiceInvoker]] || operation="Pay" <br/> ref-dp="EXTERNAL::PayWSDataProvider"<br/> returnType="body-element"<br/> type="invoker" <br/> WSDLInfo:<br />
: type="wsdlinfo"<br />
: wsdl="file://<nowiki>${{gv.app.home}}</nowiki>/xmlconfig/wsdl/[[ExternalCreditService.wsdl]]"<br />
|}<br />
<br />
The ws-call operation already defined makes use of the [[Data provider]] module. So, you need to define the following parameters into the [[GVDataProviderManager]] section, present in the Adapter Core View of {{L_VULCON}}:<br />
{|class="gvtable"<br />
! Element !! Attributes<br />
|-<br />
| [[Axis2MessageContextDataProvider]] || name="EXTERNAL::PayWSDataProvider"<br />
|-<br />
| [[Axis2MessageContextDataProvider]]/Field || direction="OUT" key="message"<br/><br />
Expression<br />
: type="ognl"<br />
envelope.body.addChild(@org.apache.axis2.util.XMLUtils<br />
@toOM(#input.object.getDocumentElement()))<br />
|}<br />
<br />
===Flow implementation===<br />
<br />
[[File:GVExamplesCCardPayFlow.jpg|thumb|CCardPay flow]] In order to define the CCardPay service [[Flow]] design it as shown in the picture:<br />
<br />
<br />
The service receives a Web Service request from a client with a credit card number. If this card is managed locally, reads its data using [[DataHandler]], otherwise forwards the request to an external system using [[Web Services]].<br />
<br />
<br />
The following table shows the parameters to be defined for each Flow node:<br />
<br />
{|class="gvtable"<br />
! Attribute !! Value <br />
|-<br />
| first-node || Prepare<br />
|-<br />
| [[Conditions]]/GVBufferCondition || condition="isInternalCCard" <br/> Property:<br />
: name="IS_INTERNAL" operator="equal"<br/>type="gvbuffer-field"<br/>value="true"<br/>value-type="text"<br />
|-<br />
| [[ChangeGVBufferNode]] || dump-in-out="true" <br/>id="prepare" <br/>input="input" <br/>next-node-id="check_internal" <br/>clear-data="false" <br/>PropertyDef:<br />
: name="CNUMBER"<br/><nowiki>value="js{{gvesb::var doc=XMLUtils.parseDOM_S(new java.lang.String(object.getObject()),false,true); XMLConfig.get(doc,'//cred:cnumber')}}" </nowiki><br/><br />
PropertyDef:<br />
: name="IS_INTERNAL"<br/>value="sql{{ds.test_gv::select decode(count(*), 1, 'true', 'false') from credit_card where <br />
:: cnumber=ognl{{#object.getProperty('CNUMBER')}}}}"<br />
|-<br />
| [[GVNodeCheck]] || default-id="pay_external"<br/> id="check_internal"<br/> input="input" <br/>on-exception-id="end" <br />
|-<br />
| [[GVNodeCheck]]/GVRouting || condition="isInternalCCard" <br/>next-node-id="pay_internal"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/>id="pay_internal" <br/>id-system="CREDIT" <br/>input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="DataHandler" <br/>output="output"<br />
|-<br />
| [[GVOperationNode]] || dump-in-out="false" <br/> id="pay_external" <br/>id-system="CREDIT_EXTERNAL" <br/> input="input" <br/>next-node-id="end" <br/>op-type="call" <br/>operation-name="PayExternal"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/InputServices/gvdte-service/gvdte-context-call || name="PayExternalInput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service || critical="yes" internal="yes"<br/>remove-fields="yes" type="service"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/map-name-param || name="map-name" value="PayExternalOutput"<br />
|-<br />
| [[GVOperationNode]]/OutputServices/gvdte-service/gvdte-context-call || name="PayExternalOutput"<br />
|-<br />
| [[GVEndNode]] || end-business-process="yes" <br/>id="end" <br/>op-type="end" <br/>output="output"<br />
|}<br />
<br />
=={{GVCONSOLE}} Configuration==<br />
<br />
It is time to deploy and test your new Service. To do that follows these steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} Configuration file as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Sfoglia... (Browse) and select the file where you have saved the {{L_VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service CCardPay a new view will be open containing the files GVCore.xml present in local and in server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. Saving you return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{L_GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapters.xml and then Reload. A new windows will be open to confirm the operation<br />
# Click OK.<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{L_GVCONSOLE}} section [[Testing]]. In this section you can finally test your new services:<br />
# Into the Service voice select CCardPay<br />
# Into the System voice select CREDIT_EXTERNAL<br />
# Select the Payload on input containing the credit card number you want to use and the amount to reduce from.<br />
# Click RequestReply<br />
<br />
The Testing View will be expanded and it is also possible to view the GVBuffer Output panel where there are present some properties, among these the REC_READ property setted to 1, representing the number of record read from DB. <br />
<br />
The file TestOutput.txt will be generated in the directory <nowiki>${{gv.app.home}}</nowiki>/log as previously setted (see [[Testing]] area) containing information about the credit card numbers you passed in input and the number of records founded and updated.<br />
<syntaxhighlight lang="XML"><br />
<pre><br />
----------- TEST N. 0 2012.03.02 at 14:11:38 -----------<br />
Standard Field:<br />
system = CREDIT_EXTERNAL<br />
service = CCardPay<br />
id = 7F0001014F50AFC600014063<br />
retCode = 0<br />
GVBuffer: NULL<br />
<br />
Properties:<br />
REC_DISCARD = 0<br />
IS_INTERNAL = true<br />
REC_TOTAL = 1<br />
REC_UPDATE = 1<br />
REC_INSERT = 0<br />
REC_READ = 0<br />
CNUMBER = 1234123415555666<br />
REC_DISCARD_CAUSE = <br />
</pre><br />
</syntaxhighlight></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_TOUPPER_A&diff=4227GVExample TOUPPER A2014-05-29T13:35:33Z<p>D.franco: /* Defining Workflow Operations */</p>
<hr />
<div>==Description==<br />
<br />
This simple example shows how to configure an asynchronous service with a [[GVForwards|JMS Forward]] . <br />
The Service TOUPPER_A is composed of three workflows that define the Client/ESB/Server interaction:<br />
# the Client invokes the ''Request'' workflow to enqueue the input data into a request queue<br />
# the [[GVForwards|JMS Forward]] (a {{GVESB}} component), listening on the request queue, extracts the JMS message and invokes the ''FWD_TOUPPER_A'' workflow that converts the payload to uppercase (simulate a Server invocation) then enqueues the new payload into a response queue<br />
# the Client invokes the ''getReply'' workflow to dequeue the output data from a response queue<br />
<br />
==How To==<br />
<br />
The preferred mode for creating a Service (at least its skeleton) is through the Service Wizard. Before using it you must first configure the JMS Queue and the VCL plugins to interact with the JMS queue and execute the uppercase conversion. So let's define a new Group, System and Channel, if you do not want to use those already present, and then start the Wizard. <br />
<br />
===Configuring JMS queues in JBoss===<br />
<br />
The JMS queues are configured in JBoss by an XML file, ''gvesb-mq-destinations-service.xml'' present in <nowiki>$GV_HOME</nowiki>/application/deploy.<br />
<br />
A queue has:<br />
* A name that serves to identify it to JBoss.<br />
* A JNDI Name used by a client to connect to the queue.<br />
* MaxDeliveryAttempts (optional), to indicate how many times a message is put back into the queue for processing if the application does not confirm its reading.<br />
* RedeliveryDelay (optional), to indicate the delay (in ms) after a message will be put back into the queue if the application does not confirm its reading.<br />
<br />
The JndiName can be checked using the JBoss's jmx-console to find the MBean "service=JNDIView".<br />
<br />
In this example we use 2 queues:<br />
* ''TOUPPER_A_Request_Queue''<br />
* ''TOUPPER_A_Response_Queue''<br />
<br />
To configure both queues go to the configuration file and insert the following MBean definitions:<br />
<syntaxhighlight lang="XML"><br />
<mbean code="org.jboss.jms.server.destination.QueueService"<br />
name="jboss.messaging.destination:service=Queue,name=TOUPPER_A_Request_Queue"<br />
xmbean-dd="xmdesc/Queue-xmbean.xml"><br />
<depends optional-attribute-name="ServerPeer">jboss.messaging:service=ServerPeer</depends><br />
<depends>jboss.messaging:service=PostOffice</depends><br />
<attribute name="JNDIName">gvesb/jms/queue/TOUPPER_A_Request_Queue</attribute><br />
<attribute name="RedeliveryDelay">60000</attribute><br />
<attribute name="MaxDeliveryAttempts">100</attribute><br />
</mbean><br />
<mbean code="org.jboss.jms.server.destination.QueueService"<br />
name="jboss.messaging.destination:service=Queue,name=TOUPPER_A_Response_Queue"<br />
xmbean-dd="xmdesc/Queue-xmbean.xml"><br />
<depends optional-attribute-name="ServerPeer">jboss.messaging:service=ServerPeer</depends><br />
<depends>jboss.messaging:service=PostOffice</depends><br />
<attribute name="JNDIName">gvesb/jms/queue/TOUPPER_A_Response_Queue</attribute><br />
<attribute name="RedeliveryDelay">60000</attribute><br />
<attribute name="MaxDeliveryAttempts">100</attribute><br />
</mbean><br />
</syntaxhighlight><br />
<br />
===Defining Group, System and Channel===<br />
<br />
From the core view:<br />
# Right click the element Groups -> Insert after (or Insert before) -> Group. A new element Group will be created. <br />
# Click on the Group new element and set the attribute ''id-group'' from the Properties View. We named it DEFAULT_GRP<br />
# Expand the GVSystems item.<br />
# Right clicking on Systems, insert-after -> System. A new element System will be created.<br />
# Set the [[System]] parameters in the [[VulCon_perspective|Properties panel]]. We named it GVESB_TEST<br />
# 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<br />
# Click on this new Channel element and set the property ''id_channel''. We named it TEST_CHANNEL_A<br />
<br />
<br />
===Defining Workflow Operations===<br />
<br />
Once you have created the [[Channel]], insert into the operations you need for the workflow. In this case:<br />
<br />
{|class="gvtable"<br />
! Plugin !! Value<br />
|-<br />
| [[jms-enqueue]] || connection-factory="java:/XAConnectionFactory"<br/>delivery-mode="persistent"<br/>destination-name="gvesb/jms/queue/TOUPPER_A_Request_Queue"<br/>name="JMSEnqueueTo::TOUPPER_A_Req"<br/> ref-dp="WriteString_JMSBytesMessageDataProvider"<br />
|-<br />
| [[jms-enqueue]]/[[XAHelper]] || auto-enlist="false"<br/>transaction-status="TMSUCCESS"<br/>(You can find XAHelper section by adding it on the queue)<br />
|-<br />
| [[jms-enqueue]] || connection-factory="java:/XAConnectionFactory"<br/>delivery-mode="persistent"<br/>destination-name="gvesb/jms/queue/TOUPPER_A_Response_Queue"<br/>name="JMSEnqueueTo::TOUPPER_A_Resp"<br/> ref-dp="WriteString_JMSBytesMessageDataProvider"<br />
|-<br />
| [[jms-enqueue]]/[[XAHelper]] || auto-enlist="false"<br/>transaction-status="TMSUCCESS"<br />
|-<br />
| [[jms-dequeue]] || connection-factory="java:/XAConnectionFactory"<br/>destination-name="gvesb/jms/queue/TOUPPER_A_Response_Queue"<br/>name="JMSDequeueTo::TOUPPER_A_Resp"<br/> ref-dp="ReadString_JMSBytesMessageDataProvider"<br/> receive-type="timeout"<br />
|-<br />
| [[jms-dequeue]]/[[XAHelper]] || auto-enlist="false"<br/>transaction-status="TMSUCCESS"<br />
|-<br />
| [[test-service-call]] || name="toupper_call" service="toupper"<br />
|}<br />
<br />
The ''WriteString_JMSBytesMessageDataProvider'' creates a JMS BytesMessage and write in its body the expected input java.lang.String converted to byte[].<br/><br />
The ''ReadString_JMSBytesMessageDataProvider'' extract the input JMS BytesMessage body as byte[] and convert it into a java.lang.String.<br/><br />
Check that [[Data provider|Data Providers]] ''WriteString_JMSBytesMessageDataProvider'' and ''ReadString_JMSBytesMessageDataProvider'' are present in the element DataProviders (JMSBytesMessageDataProvider and StringDataProvider respectively), visualized from the {{VULCON}} Adapter view. If don't, you can add it setting their attributes as seen in the following table:<br />
{|class="gvtable"<br />
! Data Provider !! Value<br />
|-<br />
| [[Data provider|JMSBytesMessageDataProvider]] || name="WriteString_JMSBytesMessageDataProvider"<br />
|-<br />
| [[Data provider|JMSBytesMessageDataProvider]]/[[Field]] || direction="OUT"<br/>key="output"<br/>type="field"<br />
|-<br />
| [[Data provider|JMSBytesMessageDataProvider]]/Expression || type="ognl"<br/>writeBytes(#input.object.getBytes('UTF-8'))<br />
|-<br />
| [[Data provider|StringDataProvider]] || name="ReadString_JMSBytesMessageDataProvider"<br />
|-<br />
| [[Data provider|StringDataProvider]]/[[Field]] || direction="INOUT"<br/>key="buffer"<br/>type="field"<br />
|-<br />
| [[Data provider|StringDataProvider]]/Expression || type="ognl"<br/>#bArr = new byte[object.getBodyLength()], object.reset(), object.readBytes(#bArr), new java.lang.String(#bArr, 'UTF-8')<br />
|}<br />
<br />
[[File:NewServiceWizard.jpg|thumb|New {{GVESB}} Service Wizard]]Now we are able to use the Wizard.<br />
# From the Core View of {{VULCON}}. Right click the element Services -> Wizard New Service<br />
# A new windows will be open where you can set the name of the Service you want to create, in this case we named TOUPPER_A, and your Group, we used DEFAULT_GRP. You can also select the paradigm, for this example will be [[Paradigms_of_communication#asynchronous-synchronous|asynchronous-synchronous]]. Click next.<br />
# Set System as GVESB_TEST and Channel as TEST_CHANNEL_A. Then chose as Request Operation ''JMSEnqueueTo::TOUPPER_A_Req'', and the response Operation ''toupper_call''. Then finish.<br />
<br />
<br />
[[File:GVExamplesTOUPPER_AEditor.jpg |thumb |TOUPPER_A flow]]As you can see from the core view, inside the Services element, a new Service named TOUPPER_A has been created.<br/>This service contains three Operations (Workflows)<br />
We setted the first one as a Request (to enqueue), and the second as a GetReply (to dequeue).<br />
Nodes will be setted as seen in the following table:<br />
{|class="gvtable"<br />
! Node !! Request !! GetReply<br />
|-<br />
| [[GVOperationNode]] || output="output_JMSEnqueueTo::TOUPPER_A_Req"<br/>id="request"<br/>id-system="GVESB_TEST"<br/>input="input_JMSEnqueueTo::TOUPPER_A_Req"<br/>next-node-id="check_status" op-type="enqueue"<br/>operation-name="JMSEnqueueTo::TOUPPER_A_Req" || output="output_JMSDequeueTo::TOUPPER_A_Resp"<br/>id="request"<br/>id-system="GVESB_TEST"<br/>input="input_JMSDequeueTo::TOUPPER_A_Resp"<br/>next-node-id="check_status" op-type="dequeue"<br/>operation-name="JMSDequeueTo::TOUPPER_A_Resp"<br/>[[Op-type#DequeueFilter|DequeueFilter]]:<br />
: [[Op-type#IDFilter|IDFilter]]<br />
:: enabled="yes" use-input="yes"<br />
|-<br />
| [[GVNodeCheck]] || default-id="return_status"<br/>id="check_status"<br/>input="output_JMSEnqueueTo::TOUPPER_A_Req"<br/>on-exception-id="return_error"<br/>op-type="check" || default-id="return_status"<br/>id="check_status"<br/>input="output_JMSDequeueTo::TOUPPER_A_Resp"<br/>on-exception-id="return_error"<br/>op-type="check"<br />
|-<br />
| [[GVEndNode]] || id="return_status"<br/>op-type="end"<br/>output="output_JMSEnqueueTo::TOUPPER_A_Req" || id="return_status"<br/>op-type="end"<br/>output="output_JMSDequeueTo::TOUPPER_A_Resp"<br />
|-<br />
| [[GVEndNode]] || id="return_error"<br/>output="output_JMSEnqueueTo::TOUPPER_A_Req" || id="return_error"<br/>output="output_JMSDequeueTo::TOUPPER_A_Resp" <br />
|} <br />
<br />
Operation FWD_TOUPPER_A will be configured as follow:<br />
Attributes: name="Forward" operation-activation="on" out-check-type="none"<br />
{|class="gvtable"<br />
! Nodes/Subelements !! Attributes<br />
|-<br />
| [[GVOperationNode]] || id-system="GVESB_TEST"<br/> input="input"<br/> next-node-id="enqueue_response" op-type="call"<br/> operation-name="toupper_call" output="output"<br />
|-<br />
| [[GVOperationNode]] || id="enqueue_response" id-system="GVESB_TEST"<br/> input="output" next-node-id="end"<br/> op-type="enqueue"<br/> operation-name="JMSEnqueueTo::TOUPPER_A_Resp"<br/> output="output"<br />
|-<br />
| [[GVEndNode]] || end-business-process="no" id="end" op-type="end"<br/> output="output" <br/> ChangeGVBuffer: clear-data="true"<br />
|} <br />
<br />
The GVCore.xml configuration file will be changed as follow:<br />
* Into ''GVForwards'' element will be added the tag<br />
<syntaxhighlight lang="XML"><br />
<ForwardConfiguration dump-message="true" enabled="true"<br />
forwardName="FWD_TOUPPER_A" name="ToupperA"<br />
ref-dp="ReadString_JMSBytesMessageDataProvider"><br />
<ForwardDeployment connection-factory="java:/XAConnectionFactory"<br />
destination="gvesb/jms/queue/TOUPPER_A_Request_Queue"<br />
destination-type="queue" reconnect-interval-sec="10"<br />
transacted="true" transaction-timeout-sec="30"><br />
<XAHelper auto-enlist="false" transaction-status="TMSUCCESS"/><br />
</ForwardDeployment><br />
</ForwardConfiguration><br />
</syntaxhighlight><br />
* Into ''Services'' element will be added the tag<br />
<syntaxhighlight lang="XML"><br />
<Service group-name="DEFAULT_GRP" id-service="TOUPPER_A"<br />
service-activation="on" statistics="off"><br />
<Operation name="Request" operation-activation="on"<br />
out-check-type="sys-svc-id" type="operation"><br />
<Description>VulCon generated Operation</Description><br />
<Participant id-channel="TEST_CHANNEL_A" id-system="GVESB_TEST"/><br />
<Flow first-node="request" point-x="50" point-y="150"><br />
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"<br />
id="request" id-system="GVESB_TEST"<br />
input="input_JMSEnqueueTo::TOUPPER_A_Req"<br />
next-node-id="check_status" op-type="enqueue"<br />
operation-name="JMSEnqueueTo::TOUPPER_A_Req"<br />
output="output_JMSEnqueueTo::TOUPPER_A_Req"<br />
point-x="200" point-y="150" type="flow-node"/><br />
<GVNodeCheck class="it.greenvulcano.gvesb.core.flow.GVNodeCheck"<br />
default-id="return_status" id="check_status"<br />
input="output_JMSEnqueueTo::TOUPPER_A_Req"<br />
on-exception-id="return_error" op-type="check"<br />
point-x="350" point-y="150" type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_status" op-type="end"<br />
output="output_JMSEnqueueTo::TOUPPER_A_Req"<br />
point-x="700" point-y="150" type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_error" op-type="end"<br />
output="output_JMSEnqueueTo::TOUPPER_A_Req"<br />
point-x="350" point-y="300" type="flow-node"/><br />
</Flow><br />
</Operation><br />
<Operation name="GetReply" operation-activation="on"<br />
out-check-type="sys-svc-id" type="operation"><br />
<Description>VulCon generated Operation</Description><br />
<Participant id-channel="TEST_CHANNEL_A" id-system="GVESB_TEST"/><br />
<Flow first-node="request" point-x="50" point-y="150"><br />
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"<br />
id="request" id-system="GVESB_TEST"<br />
input="input_JMSDequeueTo::TOUPPER_A_Resp"<br />
next-node-id="check_status" op-type="dequeue"<br />
operation-name="JMSDequeueTo::TOUPPER_A_Resp"<br />
output="output_JMSDequeueTo::TOUPPER_A_Resp"<br />
point-x="200" point-y="150" type="flow-node"><br />
<DequeueFilter><br />
<IDFilter enabled="yes" name="IDFilter" type="filter"<br />
use-input="yes"/><br />
</DequeueFilter><br />
</GVOperationNode><br />
<GVNodeCheck class="it.greenvulcano.gvesb.core.flow.GVNodeCheck"<br />
default-id="return_status" id="check_status"<br />
input="output_JMSDequeueTo::TOUPPER_A_Resp" <br />
on-exception-id="return_error" op-type="check"<br />
point-x="350" point-y="150" type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_status" op-type="end" <br />
output="output_JMSDequeueTo::TOUPPER_A_Resp"<br />
point-x="700" point-y="150" type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_error" op-type="end"<br />
output="output_JMSDequeueTo::TOUPPER_A_Resp"<br />
point-x="350" point-y="300" type="flow-node"/><br />
</Flow><br />
</Operation><br />
<Operation forward-name="FWD_TOUPPER_A" name="Forward"<br />
operation-activation="on" out-check-type="none"<br />
type="operation"><br />
<Participant id-channel="TEST_CHANNEL_A" id-system="GVESB_TEST"/><br />
<Flow first-node="call_server" point-x="20" point-y="150"><br />
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"<br />
id="call_server" id-system="GVESB_TEST" input="input"<br />
next-node-id="enqueue_response" op-type="call"<br />
operation-name="toupper_call" output="output"<br />
point-x="147" point-y="148" type="flow-node"/><br />
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"<br />
id="enqueue_response" id-system="GVESB_TEST"<br />
input="output" next-node-id="end"<br />
op-type="enqueue"<br />
operation-name="JMSEnqueueTo::TOUPPER_A_Resp"<br />
output="output" point-x="319" point-y="152"<br />
type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
end-business-process="no" id="end" op-type="end"<br />
output="output" point-x="532" point-y="149"<br />
type="flow-node"><br />
<ChangeGVBuffer clear-data="true"/><br />
</GVEndNode><br />
</Flow><br />
</Operation><br />
</Service><br />
</syntaxhighlight><br />
* Into ''System'' element will be added the tag<br />
<syntaxhighlight lang="XML"><br />
<Channel id-channel="TEST_CHANNEL_A"><br />
<jms-enqueue acknowledge-type="auto-acknowledge"<br />
class="it.greenvulcano.gvesb.virtual.j2ee.JMSEnqueueOperation"<br />
connection-factory="java:/XAConnectionFactory"<br />
delivery-mode="persistent"<br />
destination-name="gvesb/jms/queue/TOUPPER_A_Request_Queue"<br />
destination-type="queue"<br />
name="JMSEnqueueTo::TOUPPER_A_Req" priority="4"<br />
ref-dp="WriteString_JMSBytesMessageDataProvider"<br />
transacted="false" type="enqueue"><br />
<XAHelper auto-enlist="false" transaction-status="TMSUCCESS"/><br />
</jms-enqueue><br />
<jms-enqueue acknowledge-type="auto-acknowledge"<br />
class="it.greenvulcano.gvesb.virtual.j2ee.JMSEnqueueOperation"<br />
connection-factory="java:/XAConnectionFactory"<br />
delivery-mode="persistent"<br />
destination-name="gvesb/jms/queue/TOUPPER_A_Response_Queue"<br />
destination-type="queue"<br />
name="JMSEnqueueTo::TOUPPER_A_Resp" priority="4"<br />
ref-dp="WriteString_JMSBytesMessageDataProvider"<br />
transacted="false" type="enqueue"><br />
<XAHelper auto-enlist="false" transaction-status="TMSUCCESS"/><br />
</jms-enqueue><br />
<jms-dequeue acknowledge-type="auto-acknowledge"<br />
class="it.greenvulcano.gvesb.virtual.j2ee.JMSDequeueOperation"<br />
connection-factory="java:/XAConnectionFactory"<br />
destination-name="gvesb/jms/queue/TOUPPER_A_Response_Queue"<br />
destination-type="queue"<br />
name="JMSDequeueTo::TOUPPER_A_Resp"<br />
receive-timeout-overridable="false"<br />
receive-type="timeout"<br />
ref-dp="ReadString_JMSBytesMessageDataProvider"<br />
transacted="false" type="dequeue"><br />
<XAHelper auto-enlist="false" transaction-status="TMSUCCESS"/><br />
</jms-dequeue><br />
<test-service-call class="it.greenvulcano.gvesb.virtual.internal.TestServiceCall"<br />
name="toupper_call" service="toupper" type="call"/><br />
</Channel><br />
</syntaxhighlight><br />
<br />
Now you are able to test your first {{VULCON}} service from the {{L_GVCONSOLE}}. But first you need to export the configuration.<br />
<br />
[[File:GVExamplesTOUPPER5.jpg|thumb|Exporting configuration]]Once the flow is correctly configured, the user can export the configuration and pass it to the {{GVESB}} import tool, in order to add into the {{GVESB}} the service just created.<br />
<br />
# The Export function is available in the view "Project". Expand the project<br />
# Before you proceed press F5 to refresh the file list.<br />
# Right click the ''conf'' folder. It will open a drop-down list. <br />
# Export your project as a compressed file.<br />
<br />
===Testing with {{GVCONSOLE}}===<br />
<br />
It is finally the time to test your project. To do that execute the following steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} project as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Browse and select the file where you saved the {{VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Selecting the TOUPPER_A service a new view will be shown. In this view is the contents of the file GVCore.xml in the local version and the one on the server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. By saving you will return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapter.xml, then Reload.<br />
# Finally confirm the operation.<br />
<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{GVCONSOLE}} section [[Testing]]. In this section you can finally test your new service. Remember that Service TOUPPER_A is composed by three independent Operations:<br />
<br />
*'''Request'''<br />
# Into the Service field select TOUPPER_A<br />
# Into the System field select GVESB_TEST<br />
# Into the Payload area insert the text to convert in uppercase<br />
# Click Request<br />
<br />
*'''FWD_TOUPPER_A''', executed by {{GVESB}} [[GVForwards|JMS Forward]].<br />
<br />
*'''getReply'''<br />
# Clear the Payload area<br />
# Click getReply<br />
<br />
When each test completes, the Testing view will be expanded for containing the GVBUFFER OUTPUT. In this case no properties have been defined, thus only main informations about the process (System, Service, Id, etc.) are shown. To view the service payload output click on ''Show as Text'' button. Standard fields and the detailed GVBuffer are described in the [[Testing#Data_input|Output File Name]] (the default location is <nowiki>$GV_HOME</nowiki>/log/TestOutput.txt). <br />
<br />
In case of error or exceptions you can review the logs file in the <nowiki>$GV_HOME</nowiki>/log/ folder.</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_TOUPPER_A&diff=4226GVExample TOUPPER A2014-05-29T11:02:59Z<p>D.franco: /* Testing with {{GVCONSOLE}} */</p>
<hr />
<div>==Description==<br />
<br />
This simple example shows how to configure an asynchronous service with a [[GVForwards|JMS Forward]] . <br />
The Service TOUPPER_A is composed of three workflows that define the Client/ESB/Server interaction:<br />
# the Client invokes the ''Request'' workflow to enqueue the input data into a request queue<br />
# the [[GVForwards|JMS Forward]] (a {{GVESB}} component), listening on the request queue, extracts the JMS message and invokes the ''FWD_TOUPPER_A'' workflow that converts the payload to uppercase (simulate a Server invocation) then enqueues the new payload into a response queue<br />
# the Client invokes the ''getReply'' workflow to dequeue the output data from a response queue<br />
<br />
==How To==<br />
<br />
The preferred mode for creating a Service (at least its skeleton) is through the Service Wizard. Before using it you must first configure the JMS Queue and the VCL plugins to interact with the JMS queue and execute the uppercase conversion. So let's define a new Group, System and Channel, if you do not want to use those already present, and then start the Wizard. <br />
<br />
===Configuring JMS queues in JBoss===<br />
<br />
The JMS queues are configured in JBoss by an XML file, ''gvesb-mq-destinations-service.xml'' present in <nowiki>$GV_HOME</nowiki>/application/deploy.<br />
<br />
A queue has:<br />
* A name that serves to identify it to JBoss.<br />
* A JNDI Name used by a client to connect to the queue.<br />
* MaxDeliveryAttempts (optional), to indicate how many times a message is put back into the queue for processing if the application does not confirm its reading.<br />
* RedeliveryDelay (optional), to indicate the delay (in ms) after a message will be put back into the queue if the application does not confirm its reading.<br />
<br />
The JndiName can be checked using the JBoss's jmx-console to find the MBean "service=JNDIView".<br />
<br />
In this example we use 2 queues:<br />
* ''TOUPPER_A_Request_Queue''<br />
* ''TOUPPER_A_Response_Queue''<br />
<br />
To configure both queues go to the configuration file and insert the following MBean definitions:<br />
<syntaxhighlight lang="XML"><br />
<mbean code="org.jboss.jms.server.destination.QueueService"<br />
name="jboss.messaging.destination:service=Queue,name=TOUPPER_A_Request_Queue"<br />
xmbean-dd="xmdesc/Queue-xmbean.xml"><br />
<depends optional-attribute-name="ServerPeer">jboss.messaging:service=ServerPeer</depends><br />
<depends>jboss.messaging:service=PostOffice</depends><br />
<attribute name="JNDIName">gvesb/jms/queue/TOUPPER_A_Request_Queue</attribute><br />
<attribute name="RedeliveryDelay">60000</attribute><br />
<attribute name="MaxDeliveryAttempts">100</attribute><br />
</mbean><br />
<mbean code="org.jboss.jms.server.destination.QueueService"<br />
name="jboss.messaging.destination:service=Queue,name=TOUPPER_A_Response_Queue"<br />
xmbean-dd="xmdesc/Queue-xmbean.xml"><br />
<depends optional-attribute-name="ServerPeer">jboss.messaging:service=ServerPeer</depends><br />
<depends>jboss.messaging:service=PostOffice</depends><br />
<attribute name="JNDIName">gvesb/jms/queue/TOUPPER_A_Response_Queue</attribute><br />
<attribute name="RedeliveryDelay">60000</attribute><br />
<attribute name="MaxDeliveryAttempts">100</attribute><br />
</mbean><br />
</syntaxhighlight><br />
<br />
===Defining Group, System and Channel===<br />
<br />
From the core view:<br />
# Right click the element Groups -> Insert after (or Insert before) -> Group. A new element Group will be created. <br />
# Click on the Group new element and set the attribute ''id-group'' from the Properties View. We named it DEFAULT_GRP<br />
# Expand the GVSystems item.<br />
# Right clicking on Systems, insert-after -> System. A new element System will be created.<br />
# Set the [[System]] parameters in the [[VulCon_perspective|Properties panel]]. We named it GVESB_TEST<br />
# 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<br />
# Click on this new Channel element and set the property ''id_channel''. We named it TEST_CHANNEL_A<br />
<br />
<br />
===Defining Workflow Operations===<br />
<br />
Once you have created the [[Channel]], insert into the operations you need for the workflow. In this case:<br />
<br />
{|class="gvtable"<br />
! Plugin !! Value<br />
|-<br />
| [[jms-enqueue]] || connection-factory="java:/XAConnectionFactory"<br/>delivery-mode="persistent"<br/>destination-name="gvesb/jms/queue/TOUPPER_A_Request_Queue"<br/>name="JMSEnqueueTo::TOUPPER_A_Req"<br/> ref-dp="WriteString_JMSBytesMessageDataProvider"<br />
|-<br />
| [[jms-enqueue]]/[[XAHelper]] || auto-enlist="false"<br/>transaction-status="TMSUCCESS"<br/>(You can find XAHelper section by adding it on the queue)<br />
|-<br />
| [[jms-enqueue]] || connection-factory="java:/XAConnectionFactory"<br/>delivery-mode="persistent"<br/>destination-name="gvesb/jms/queue/TOUPPER_A_Response_Queue"<br/>name="JMSEnqueueTo::TOUPPER_A_Resp"<br/> ref-dp="WriteString_JMSBytesMessageDataProvider"<br />
|-<br />
| [[jms-enqueue]]/[[XAHelper]] || auto-enlist="false"<br/>transaction-status="TMSUCCESS"<br />
|-<br />
| [[jms-dequeue]] || connection-factory="java:/XAConnectionFactory"<br/>destination-name="gvesb/jms/queue/TOUPPER_A_Response_Queue"<br/>name="JMSDequeueTo::TOUPPER_A_Resp"<br/> ref-dp="ReadString_JMSBytesMessageDataProvider"<br/> receive-type="timeout"<br />
|-<br />
| [[jms-dequeue]]/[[XAHelper]] || auto-enlist="false"<br/>transaction-status="TMSUCCESS"<br />
|-<br />
| [[test-service-call]] || name="toupper_call" service="toupper"<br />
|}<br />
<br />
The ''WriteString_JMSBytesMessageDataProvider'' creates a JMS BytesMessage and write in its body the expected input java.lang.String converted to byte[].<br/><br />
The ''ReadString_JMSBytesMessageDataProvider'' extract the input JMS BytesMessage body as byte[] and convert it into a java.lang.String.<br/><br />
Check that [[Data provider|Data Providers]] ''WriteString_JMSBytesMessageDataProvider'' and ''ReadString_JMSBytesMessageDataProvider'' are present in the element DataProviders (JMSBytesMessageDataProvider and StringDataProvider respectively), visualized from the {{VULCON}} Adapter view. If don't, you can add it setting their attributes as seen in the following table:<br />
{|class="gvtable"<br />
! Data Provider !! Value<br />
|-<br />
| [[Data provider|JMSBytesMessageDataProvider]] || name="WriteString_JMSBytesMessageDataProvider"<br />
|-<br />
| [[Data provider|JMSBytesMessageDataProvider]]/[[Field]] || direction="OUT"<br/>key="output"<br/>type="field"<br />
|-<br />
| [[Data provider|JMSBytesMessageDataProvider]]/Expression || type="ognl"<br/>writeBytes(#input.object.getBytes('UTF-8'))<br />
|-<br />
| [[Data provider|StringDataProvider]] || name="ReadString_JMSBytesMessageDataProvider"<br />
|-<br />
| [[Data provider|StringDataProvider]]/[[Field]] || direction="INOUT"<br/>key="buffer"<br/>type="field"<br />
|-<br />
| [[Data provider|StringDataProvider]]/Expression || type="ognl"<br/>#bArr = new byte[object.getBodyLength()], object.reset(), object.readBytes(#bArr), new java.lang.String(#bArr, 'UTF-8')<br />
|}<br />
<br />
[[File:NewServiceWizard.jpg|thumb|New {{GVESB}} Service Wizard]]Now we are able to use the Wizard.<br />
# From the Core View of {{VULCON}}. Right click the element Services -> Wizard New Service<br />
# A new windows will be open where you can set the name of the Service you want to create, in this case we named TOUPPER_A, and your Group, we used DEFAULT_GRP. You can also select the paradigm, for this example will be [[Paradigms_of_communication#asynchronous-synchronous|asynchronous-synchronous]]. Click next.<br />
# Set System as GVESB_TEST and Channel as TEST_CHANNEL_A. Then chose as Request Operation ''JMSEnqueueTo::TOUPPER_A_Req'', and the response Operation ''toupper_call''. Then finish.<br />
<br />
<br />
[[File:GVExamplesTOUPPER_AEditor.jpg |thumb |TOUPPER_A flow]]As you can see from the core view, inside the Services element, a new Service named TOUPPER_A has been created.<br/>This service contains three Operations (Workflows)<br />
We setted the first one as a Request (to enqueue), and the second as a GetReply (to dequeue).<br />
Nodes will be setted as seen in the following table:<br />
{|class="gvtable"<br />
! Node !! Request !! GetReply<br />
|-<br />
| GVOperationNode || output="output_JMSEnqueueTo::TOUPPER_A_Req"<br/>id="request"<br/>id-system="GVESB_TEST"<br/>input="input_JMSEnqueueTo::TOUPPER_A_Req"<br/>next-node-id="check_status" op-type="enqueue"<br/>operation-name="JMSEnqueueTo::TOUPPER_A_Req" || output="output_JMSDequeueTo::TOUPPER_A_Resp"<br/>id="request"<br/>id-system="GVESB_TEST"<br/>input="input_JMSDequeueTo::TOUPPER_A_Resp"<br/>next-node-id="check_status" op-type="dequeue"<br/>operation-name="JMSDequeueTo::TOUPPER_A_Resp"<br/>DequeueFilter:<br />
: IDFilter<br />
:: enabled="yes" use-input="yes"<br />
|-<br />
| GVNodeCheck || default-id="return_status"<br/>id="check_status"<br/>input="output_JMSEnqueueTo::TOUPPER_A_Req"<br/>on-exception-id="return_error"<br/>op-type="check" || default-id="return_status"<br/>id="check_status"<br/>input="output_JMSDequeueTo::TOUPPER_A_Resp"<br/>on-exception-id="return_error"<br/>op-type="check"<br />
|-<br />
| GVEndNode || id="return_status"<br/>op-type="end"<br/>output="output_JMSEnqueueTo::TOUPPER_A_Req" || id="return_status"<br/>op-type="end"<br/>output="output_JMSDequeueTo::TOUPPER_A_Resp"<br />
|-<br />
| GVEndNode || id="return_error"<br/>output="output_JMSEnqueueTo::TOUPPER_A_Req" || id="return_error"<br/>output="output_JMSDequeueTo::TOUPPER_A_Resp" <br />
|} <br />
<br />
Operation FWD_TOUPPER_A will be configured as follow:<br />
Attributes: name="Forward" operation-activation="on" out-check-type="none"<br />
{|class="gvtable"<br />
! Nodes/Subelements !! Attributes<br />
|-<br />
| GVOperationNode || id-system="GVESB_TEST"<br/> input="input"<br/> next-node-id="enqueue_response" op-type="call"<br/> operation-name="toupper_call" output="output"<br />
|-<br />
| GVOperationNode || id="enqueue_response" id-system="GVESB_TEST"<br/> input="output" next-node-id="end"<br/> op-type="enqueue"<br/> operation-name="JMSEnqueueTo::TOUPPER_A_Resp"<br/> output="output"<br />
|-<br />
| GVEndNode || end-business-process="no" id="end" op-type="end"<br/> output="output" <br/> ChangeGVBuffer: clear-data="true"<br />
|} <br />
<br />
The GVCore.xml configuration file will be changed as follow:<br />
* Into ''GVForwards'' element will be added the tag<br />
<syntaxhighlight lang="XML"><br />
<ForwardConfiguration dump-message="true" enabled="true"<br />
forwardName="FWD_TOUPPER_A"<br />
ref-dp="ReadString_JMSBytesMessageDataProvider"><br />
<ForwardDeployment connection-factory="java:/XAConnectionFactory"<br />
destination="gvesb/jms/queue/TOUPPER_A_Request_Queue"<br />
destination-type="queue" reconnect-interval-sec="10"<br />
transacted="true" transaction-timeout-sec="30"><br />
<XAHelper auto-enlist="false" transaction-status="TMSUCCESS"/><br />
</ForwardDeployment><br />
</ForwardConfiguration><br />
</syntaxhighlight><br />
* Into ''Services'' element will be added the tag<br />
<syntaxhighlight lang="XML"><br />
<Service group-name="DEFAULT_GRP" id-service="TOUPPER_A"<br />
service-activation="on" statistics="off"><br />
<Operation name="Request" operation-activation="on"<br />
out-check-type="sys-svc-id" type="operation"><br />
<Description>VulCon generated Operation</Description><br />
<Participant id-channel="TEST_CHANNEL_A" id-system="GVESB_TEST"/><br />
<Flow first-node="request" point-x="50" point-y="150"><br />
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"<br />
id="request" id-system="GVESB_TEST"<br />
input="input_JMSEnqueueTo::TOUPPER_A_Req"<br />
next-node-id="check_status" op-type="enqueue"<br />
operation-name="JMSEnqueueTo::TOUPPER_A_Req"<br />
output="output_JMSEnqueueTo::TOUPPER_A_Req"<br />
point-x="200" point-y="150" type="flow-node"/><br />
<GVNodeCheck class="it.greenvulcano.gvesb.core.flow.GVNodeCheck"<br />
default-id="return_status" id="check_status"<br />
input="output_JMSEnqueueTo::TOUPPER_A_Req"<br />
on-exception-id="return_error" op-type="check"<br />
point-x="350" point-y="150" type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_status" op-type="end"<br />
output="output_JMSEnqueueTo::TOUPPER_A_Req"<br />
point-x="700" point-y="150" type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_error" op-type="end"<br />
output="output_JMSEnqueueTo::TOUPPER_A_Req"<br />
point-x="350" point-y="300" type="flow-node"/><br />
</Flow><br />
</Operation><br />
<Operation name="GetReply" operation-activation="on"<br />
out-check-type="sys-svc-id" type="operation"><br />
<Description>VulCon generated Operation</Description><br />
<Participant id-channel="TEST_CHANNEL_A" id-system="GVESB_TEST"/><br />
<Flow first-node="request" point-x="50" point-y="150"><br />
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"<br />
id="request" id-system="GVESB_TEST"<br />
input="input_JMSDequeueTo::TOUPPER_A_Resp"<br />
next-node-id="check_status" op-type="dequeue"<br />
operation-name="JMSDequeueTo::TOUPPER_A_Resp"<br />
output="output_JMSDequeueTo::TOUPPER_A_Resp"<br />
point-x="200" point-y="150" type="flow-node"><br />
<DequeueFilter><br />
<IDFilter enabled="yes" name="IDFilter" type="filter"<br />
use-input="yes"/><br />
</DequeueFilter><br />
</GVOperationNode><br />
<GVNodeCheck class="it.greenvulcano.gvesb.core.flow.GVNodeCheck"<br />
default-id="return_status" id="check_status"<br />
input="output_JMSDequeueTo::TOUPPER_A_Resp" <br />
on-exception-id="return_error" op-type="check"<br />
point-x="350" point-y="150" type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_status" op-type="end" <br />
output="output_JMSDequeueTo::TOUPPER_A_Resp"<br />
point-x="700" point-y="150" type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_error" op-type="end"<br />
output="output_JMSDequeueTo::TOUPPER_A_Resp"<br />
point-x="350" point-y="300" type="flow-node"/><br />
</Flow><br />
</Operation><br />
<Operation forward-name="FWD_TOUPPER_A" name="Forward"<br />
operation-activation="on" out-check-type="none"<br />
type="operation"><br />
<Participant id-channel="TEST_CHANNEL_A" id-system="GVESB_TEST"/><br />
<Flow first-node="call_server" point-x="20" point-y="150"><br />
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"<br />
id="call_server" id-system="GVESB_TEST" input="input"<br />
next-node-id="enqueue_response" op-type="call"<br />
operation-name="toupper_call" output="output"<br />
point-x="147" point-y="148" type="flow-node"/><br />
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"<br />
id="enqueue_response" id-system="GVESB_TEST"<br />
input="output" next-node-id="end"<br />
op-type="enqueue"<br />
operation-name="JMSEnqueueTo::TOUPPER_A_Resp"<br />
output="output" point-x="319" point-y="152"<br />
type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
end-business-process="no" id="end" op-type="end"<br />
output="output" point-x="532" point-y="149"<br />
type="flow-node"><br />
<ChangeGVBuffer clear-data="true"/><br />
</GVEndNode><br />
</Flow><br />
</Operation><br />
</Service><br />
</syntaxhighlight><br />
* Into ''System'' element will be added the tag<br />
<syntaxhighlight lang="XML"><br />
<Channel id-channel="TEST_CHANNEL_A"><br />
<jms-enqueue acknowledge-type="auto-acknowledge"<br />
class="it.greenvulcano.gvesb.virtual.j2ee.JMSEnqueueOperation"<br />
connection-factory="java:/XAConnectionFactory"<br />
delivery-mode="persistent"<br />
destination-name="gvesb/jms/queue/TOUPPER_A_Request_Queue"<br />
destination-type="queue"<br />
name="JMSEnqueueTo::TOUPPER_A_Req" priority="4"<br />
ref-dp="WriteString_JMSBytesMessageDataProvider"<br />
transacted="false" type="enqueue"><br />
<XAHelper auto-enlist="false" transaction-status="TMSUCCESS"/><br />
</jms-enqueue><br />
<jms-enqueue acknowledge-type="auto-acknowledge"<br />
class="it.greenvulcano.gvesb.virtual.j2ee.JMSEnqueueOperation"<br />
connection-factory="java:/XAConnectionFactory"<br />
delivery-mode="persistent"<br />
destination-name="gvesb/jms/queue/TOUPPER_A_Response_Queue"<br />
destination-type="queue"<br />
name="JMSEnqueueTo::TOUPPER_A_Resp" priority="4"<br />
ref-dp="WriteString_JMSBytesMessageDataProvider"<br />
transacted="false" type="enqueue"><br />
<XAHelper auto-enlist="false" transaction-status="TMSUCCESS"/><br />
</jms-enqueue><br />
<jms-dequeue acknowledge-type="auto-acknowledge"<br />
class="it.greenvulcano.gvesb.virtual.j2ee.JMSDequeueOperation"<br />
connection-factory="java:/XAConnectionFactory"<br />
destination-name="gvesb/jms/queue/TOUPPER_A_Response_Queue"<br />
destination-type="queue"<br />
name="JMSDequeueTo::TOUPPER_A_Resp"<br />
receive-timeout-overridable="false"<br />
receive-type="timeout"<br />
ref-dp="ReadString_JMSBytesMessageDataProvider"<br />
transacted="false" type="dequeue"><br />
<XAHelper auto-enlist="false" transaction-status="TMSUCCESS"/><br />
</jms-dequeue><br />
<test-service-call class="it.greenvulcano.gvesb.virtual.internal.TestServiceCall"<br />
name="toupper_call" service="toupper" type="call"/><br />
</Channel><br />
</syntaxhighlight><br />
<br />
Now you are able to test your first {{VULCON}} service from the {{L_GVCONSOLE}}. But first you need to export the configuration.<br />
<br />
[[File:GVExamplesTOUPPER5.jpg|thumb|Exporting configuration]]Once the flow is correctly configured, the user can export the configuration and pass it to the {{GVESB}} import tool, in order to add into the {{GVESB}} the service just created.<br />
<br />
# The Export function is available in the view "Project". Expand the project<br />
# Before you proceed press F5 to refresh the file list.<br />
# Right click the ''conf'' folder. It will open a drop-down list. <br />
# Export your project as a compressed file.<br />
<br />
===Testing with {{GVCONSOLE}}===<br />
<br />
It is finally the time to test your project. To do that execute the following steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} project as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Browse and select the file where you saved the {{VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Selecting the TOUPPER_A service a new view will be shown. In this view is the contents of the file GVCore.xml in the local version and the one on the server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. By saving you will return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapter.xml, then Reload.<br />
# Finally confirm the operation.<br />
<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{GVCONSOLE}} section [[Testing]]. In this section you can finally test your new service. Remember that Service TOUPPER_A is composed by three independent Operations:<br />
<br />
*'''Request'''<br />
# Into the Service field select TOUPPER_A<br />
# Into the System field select GVESB_TEST<br />
# Into the Payload area insert the text to convert in uppercase<br />
# Click Request<br />
<br />
*'''FWD_TOUPPER_A''', executed by {{GVESB}} [[GVForwards|JMS Forward]].<br />
<br />
*'''getReply'''<br />
# Clear the Payload area<br />
# Click getReply<br />
<br />
When each test completes, the Testing view will be expanded for containing the GVBUFFER OUTPUT. In this case no properties have been defined, thus only main informations about the process (System, Service, Id, etc.) are shown. To view the service payload output click on ''Show as Text'' button. Standard fields and the detailed GVBuffer are described in the [[Testing#Data_input|Output File Name]] (the default location is <nowiki>$GV_HOME</nowiki>/log/TestOutput.txt). <br />
<br />
In case of error or exceptions you can review the logs file in the <nowiki>$GV_HOME</nowiki>/log/ folder.</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_TOUPPER_A&diff=4225GVExample TOUPPER A2014-05-29T10:58:30Z<p>D.franco: /* Testing with {{GVCONSOLE}} */</p>
<hr />
<div>==Description==<br />
<br />
This simple example shows how to configure an asynchronous service with a [[GVForwards|JMS Forward]] . <br />
The Service TOUPPER_A is composed of three workflows that define the Client/ESB/Server interaction:<br />
# the Client invokes the ''Request'' workflow to enqueue the input data into a request queue<br />
# the [[GVForwards|JMS Forward]] (a {{GVESB}} component), listening on the request queue, extracts the JMS message and invokes the ''FWD_TOUPPER_A'' workflow that converts the payload to uppercase (simulate a Server invocation) then enqueues the new payload into a response queue<br />
# the Client invokes the ''getReply'' workflow to dequeue the output data from a response queue<br />
<br />
==How To==<br />
<br />
The preferred mode for creating a Service (at least its skeleton) is through the Service Wizard. Before using it you must first configure the JMS Queue and the VCL plugins to interact with the JMS queue and execute the uppercase conversion. So let's define a new Group, System and Channel, if you do not want to use those already present, and then start the Wizard. <br />
<br />
===Configuring JMS queues in JBoss===<br />
<br />
The JMS queues are configured in JBoss by an XML file, ''gvesb-mq-destinations-service.xml'' present in <nowiki>$GV_HOME</nowiki>/application/deploy.<br />
<br />
A queue has:<br />
* A name that serves to identify it to JBoss.<br />
* A JNDI Name used by a client to connect to the queue.<br />
* MaxDeliveryAttempts (optional), to indicate how many times a message is put back into the queue for processing if the application does not confirm its reading.<br />
* RedeliveryDelay (optional), to indicate the delay (in ms) after a message will be put back into the queue if the application does not confirm its reading.<br />
<br />
The JndiName can be checked using the JBoss's jmx-console to find the MBean "service=JNDIView".<br />
<br />
In this example we use 2 queues:<br />
* ''TOUPPER_A_Request_Queue''<br />
* ''TOUPPER_A_Response_Queue''<br />
<br />
To configure both queues go to the configuration file and insert the following MBean definitions:<br />
<syntaxhighlight lang="XML"><br />
<mbean code="org.jboss.jms.server.destination.QueueService"<br />
name="jboss.messaging.destination:service=Queue,name=TOUPPER_A_Request_Queue"<br />
xmbean-dd="xmdesc/Queue-xmbean.xml"><br />
<depends optional-attribute-name="ServerPeer">jboss.messaging:service=ServerPeer</depends><br />
<depends>jboss.messaging:service=PostOffice</depends><br />
<attribute name="JNDIName">gvesb/jms/queue/TOUPPER_A_Request_Queue</attribute><br />
<attribute name="RedeliveryDelay">60000</attribute><br />
<attribute name="MaxDeliveryAttempts">100</attribute><br />
</mbean><br />
<mbean code="org.jboss.jms.server.destination.QueueService"<br />
name="jboss.messaging.destination:service=Queue,name=TOUPPER_A_Response_Queue"<br />
xmbean-dd="xmdesc/Queue-xmbean.xml"><br />
<depends optional-attribute-name="ServerPeer">jboss.messaging:service=ServerPeer</depends><br />
<depends>jboss.messaging:service=PostOffice</depends><br />
<attribute name="JNDIName">gvesb/jms/queue/TOUPPER_A_Response_Queue</attribute><br />
<attribute name="RedeliveryDelay">60000</attribute><br />
<attribute name="MaxDeliveryAttempts">100</attribute><br />
</mbean><br />
</syntaxhighlight><br />
<br />
===Defining Group, System and Channel===<br />
<br />
From the core view:<br />
# Right click the element Groups -> Insert after (or Insert before) -> Group. A new element Group will be created. <br />
# Click on the Group new element and set the attribute ''id-group'' from the Properties View. We named it DEFAULT_GRP<br />
# Expand the GVSystems item.<br />
# Right clicking on Systems, insert-after -> System. A new element System will be created.<br />
# Set the [[System]] parameters in the [[VulCon_perspective|Properties panel]]. We named it GVESB_TEST<br />
# 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<br />
# Click on this new Channel element and set the property ''id_channel''. We named it TEST_CHANNEL_A<br />
<br />
<br />
===Defining Workflow Operations===<br />
<br />
Once you have created the [[Channel]], insert into the operations you need for the workflow. In this case:<br />
<br />
{|class="gvtable"<br />
! Plugin !! Value<br />
|-<br />
| [[jms-enqueue]] || connection-factory="java:/XAConnectionFactory"<br/>delivery-mode="persistent"<br/>destination-name="gvesb/jms/queue/TOUPPER_A_Request_Queue"<br/>name="JMSEnqueueTo::TOUPPER_A_Req"<br/> ref-dp="WriteString_JMSBytesMessageDataProvider"<br />
|-<br />
| [[jms-enqueue]]/[[XAHelper]] || auto-enlist="false"<br/>transaction-status="TMSUCCESS"<br/>(You can find XAHelper section by adding it on the queue)<br />
|-<br />
| [[jms-enqueue]] || connection-factory="java:/XAConnectionFactory"<br/>delivery-mode="persistent"<br/>destination-name="gvesb/jms/queue/TOUPPER_A_Response_Queue"<br/>name="JMSEnqueueTo::TOUPPER_A_Resp"<br/> ref-dp="WriteString_JMSBytesMessageDataProvider"<br />
|-<br />
| [[jms-enqueue]]/[[XAHelper]] || auto-enlist="false"<br/>transaction-status="TMSUCCESS"<br />
|-<br />
| [[jms-dequeue]] || connection-factory="java:/XAConnectionFactory"<br/>destination-name="gvesb/jms/queue/TOUPPER_A_Response_Queue"<br/>name="JMSDequeueTo::TOUPPER_A_Resp"<br/> ref-dp="ReadString_JMSBytesMessageDataProvider"<br/> receive-type="timeout"<br />
|-<br />
| [[jms-dequeue]]/[[XAHelper]] || auto-enlist="false"<br/>transaction-status="TMSUCCESS"<br />
|-<br />
| [[test-service-call]] || name="toupper_call" service="toupper"<br />
|}<br />
<br />
The ''WriteString_JMSBytesMessageDataProvider'' creates a JMS BytesMessage and write in its body the expected input java.lang.String converted to byte[].<br/><br />
The ''ReadString_JMSBytesMessageDataProvider'' extract the input JMS BytesMessage body as byte[] and convert it into a java.lang.String.<br/><br />
Check that [[Data provider|Data Providers]] ''WriteString_JMSBytesMessageDataProvider'' and ''ReadString_JMSBytesMessageDataProvider'' are present in the element DataProviders (JMSBytesMessageDataProvider and StringDataProvider respectively), visualized from the {{VULCON}} Adapter view. If don't, you can add it setting their attributes as seen in the following table:<br />
{|class="gvtable"<br />
! Data Provider !! Value<br />
|-<br />
| [[Data provider|JMSBytesMessageDataProvider]] || name="WriteString_JMSBytesMessageDataProvider"<br />
|-<br />
| [[Data provider|JMSBytesMessageDataProvider]]/[[Field]] || direction="OUT"<br/>key="output"<br/>type="field"<br />
|-<br />
| [[Data provider|JMSBytesMessageDataProvider]]/Expression || type="ognl"<br/>writeBytes(#input.object.getBytes('UTF-8'))<br />
|-<br />
| [[Data provider|StringDataProvider]] || name="ReadString_JMSBytesMessageDataProvider"<br />
|-<br />
| [[Data provider|StringDataProvider]]/[[Field]] || direction="INOUT"<br/>key="buffer"<br/>type="field"<br />
|-<br />
| [[Data provider|StringDataProvider]]/Expression || type="ognl"<br/>#bArr = new byte[object.getBodyLength()], object.reset(), object.readBytes(#bArr), new java.lang.String(#bArr, 'UTF-8')<br />
|}<br />
<br />
[[File:NewServiceWizard.jpg|thumb|New {{GVESB}} Service Wizard]]Now we are able to use the Wizard.<br />
# From the Core View of {{VULCON}}. Right click the element Services -> Wizard New Service<br />
# A new windows will be open where you can set the name of the Service you want to create, in this case we named TOUPPER_A, and your Group, we used DEFAULT_GRP. You can also select the paradigm, for this example will be [[Paradigms_of_communication#asynchronous-synchronous|asynchronous-synchronous]]. Click next.<br />
# Set System as GVESB_TEST and Channel as TEST_CHANNEL_A. Then chose as Request Operation ''JMSEnqueueTo::TOUPPER_A_Req'', and the response Operation ''toupper_call''. Then finish.<br />
<br />
<br />
[[File:GVExamplesTOUPPER_AEditor.jpg |thumb |TOUPPER_A flow]]As you can see from the core view, inside the Services element, a new Service named TOUPPER_A has been created.<br/>This service contains three Operations (Workflows)<br />
We setted the first one as a Request (to enqueue), and the second as a GetReply (to dequeue).<br />
Nodes will be setted as seen in the following table:<br />
{|class="gvtable"<br />
! Node !! Request !! GetReply<br />
|-<br />
| GVOperationNode || output="output_JMSEnqueueTo::TOUPPER_A_Req"<br/>id="request"<br/>id-system="GVESB_TEST"<br/>input="input_JMSEnqueueTo::TOUPPER_A_Req"<br/>next-node-id="check_status" op-type="enqueue"<br/>operation-name="JMSEnqueueTo::TOUPPER_A_Req" || output="output_JMSDequeueTo::TOUPPER_A_Resp"<br/>id="request"<br/>id-system="GVESB_TEST"<br/>input="input_JMSDequeueTo::TOUPPER_A_Resp"<br/>next-node-id="check_status" op-type="dequeue"<br/>operation-name="JMSDequeueTo::TOUPPER_A_Resp"<br/>DequeueFilter:<br />
: IDFilter<br />
:: enabled="yes" use-input="yes"<br />
|-<br />
| GVNodeCheck || default-id="return_status"<br/>id="check_status"<br/>input="output_JMSEnqueueTo::TOUPPER_A_Req"<br/>on-exception-id="return_error"<br/>op-type="check" || default-id="return_status"<br/>id="check_status"<br/>input="output_JMSDequeueTo::TOUPPER_A_Resp"<br/>on-exception-id="return_error"<br/>op-type="check"<br />
|-<br />
| GVEndNode || id="return_status"<br/>op-type="end"<br/>output="output_JMSEnqueueTo::TOUPPER_A_Req" || id="return_status"<br/>op-type="end"<br/>output="output_JMSDequeueTo::TOUPPER_A_Resp"<br />
|-<br />
| GVEndNode || id="return_error"<br/>output="output_JMSEnqueueTo::TOUPPER_A_Req" || id="return_error"<br/>output="output_JMSDequeueTo::TOUPPER_A_Resp" <br />
|} <br />
<br />
Operation FWD_TOUPPER_A will be configured as follow:<br />
Attributes: name="Forward" operation-activation="on" out-check-type="none"<br />
{|class="gvtable"<br />
! Nodes/Subelements !! Attributes<br />
|-<br />
| GVOperationNode || id-system="GVESB_TEST"<br/> input="input"<br/> next-node-id="enqueue_response" op-type="call"<br/> operation-name="toupper_call" output="output"<br />
|-<br />
| GVOperationNode || id="enqueue_response" id-system="GVESB_TEST"<br/> input="output" next-node-id="end"<br/> op-type="enqueue"<br/> operation-name="JMSEnqueueTo::TOUPPER_A_Resp"<br/> output="output"<br />
|-<br />
| GVEndNode || end-business-process="no" id="end" op-type="end"<br/> output="output" <br/> ChangeGVBuffer: clear-data="true"<br />
|} <br />
<br />
The GVCore.xml configuration file will be changed as follow:<br />
* Into ''GVForwards'' element will be added the tag<br />
<syntaxhighlight lang="XML"><br />
<ForwardConfiguration dump-message="true" enabled="true"<br />
forwardName="FWD_TOUPPER_A"<br />
ref-dp="ReadString_JMSBytesMessageDataProvider"><br />
<ForwardDeployment connection-factory="java:/XAConnectionFactory"<br />
destination="gvesb/jms/queue/TOUPPER_A_Request_Queue"<br />
destination-type="queue" reconnect-interval-sec="10"<br />
transacted="true" transaction-timeout-sec="30"><br />
<XAHelper auto-enlist="false" transaction-status="TMSUCCESS"/><br />
</ForwardDeployment><br />
</ForwardConfiguration><br />
</syntaxhighlight><br />
* Into ''Services'' element will be added the tag<br />
<syntaxhighlight lang="XML"><br />
<Service group-name="DEFAULT_GRP" id-service="TOUPPER_A"<br />
service-activation="on" statistics="off"><br />
<Operation name="Request" operation-activation="on"<br />
out-check-type="sys-svc-id" type="operation"><br />
<Description>VulCon generated Operation</Description><br />
<Participant id-channel="TEST_CHANNEL_A" id-system="GVESB_TEST"/><br />
<Flow first-node="request" point-x="50" point-y="150"><br />
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"<br />
id="request" id-system="GVESB_TEST"<br />
input="input_JMSEnqueueTo::TOUPPER_A_Req"<br />
next-node-id="check_status" op-type="enqueue"<br />
operation-name="JMSEnqueueTo::TOUPPER_A_Req"<br />
output="output_JMSEnqueueTo::TOUPPER_A_Req"<br />
point-x="200" point-y="150" type="flow-node"/><br />
<GVNodeCheck class="it.greenvulcano.gvesb.core.flow.GVNodeCheck"<br />
default-id="return_status" id="check_status"<br />
input="output_JMSEnqueueTo::TOUPPER_A_Req"<br />
on-exception-id="return_error" op-type="check"<br />
point-x="350" point-y="150" type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_status" op-type="end"<br />
output="output_JMSEnqueueTo::TOUPPER_A_Req"<br />
point-x="700" point-y="150" type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_error" op-type="end"<br />
output="output_JMSEnqueueTo::TOUPPER_A_Req"<br />
point-x="350" point-y="300" type="flow-node"/><br />
</Flow><br />
</Operation><br />
<Operation name="GetReply" operation-activation="on"<br />
out-check-type="sys-svc-id" type="operation"><br />
<Description>VulCon generated Operation</Description><br />
<Participant id-channel="TEST_CHANNEL_A" id-system="GVESB_TEST"/><br />
<Flow first-node="request" point-x="50" point-y="150"><br />
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"<br />
id="request" id-system="GVESB_TEST"<br />
input="input_JMSDequeueTo::TOUPPER_A_Resp"<br />
next-node-id="check_status" op-type="dequeue"<br />
operation-name="JMSDequeueTo::TOUPPER_A_Resp"<br />
output="output_JMSDequeueTo::TOUPPER_A_Resp"<br />
point-x="200" point-y="150" type="flow-node"><br />
<DequeueFilter><br />
<IDFilter enabled="yes" name="IDFilter" type="filter"<br />
use-input="yes"/><br />
</DequeueFilter><br />
</GVOperationNode><br />
<GVNodeCheck class="it.greenvulcano.gvesb.core.flow.GVNodeCheck"<br />
default-id="return_status" id="check_status"<br />
input="output_JMSDequeueTo::TOUPPER_A_Resp" <br />
on-exception-id="return_error" op-type="check"<br />
point-x="350" point-y="150" type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_status" op-type="end" <br />
output="output_JMSDequeueTo::TOUPPER_A_Resp"<br />
point-x="700" point-y="150" type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_error" op-type="end"<br />
output="output_JMSDequeueTo::TOUPPER_A_Resp"<br />
point-x="350" point-y="300" type="flow-node"/><br />
</Flow><br />
</Operation><br />
<Operation forward-name="FWD_TOUPPER_A" name="Forward"<br />
operation-activation="on" out-check-type="none"<br />
type="operation"><br />
<Participant id-channel="TEST_CHANNEL_A" id-system="GVESB_TEST"/><br />
<Flow first-node="call_server" point-x="20" point-y="150"><br />
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"<br />
id="call_server" id-system="GVESB_TEST" input="input"<br />
next-node-id="enqueue_response" op-type="call"<br />
operation-name="toupper_call" output="output"<br />
point-x="147" point-y="148" type="flow-node"/><br />
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"<br />
id="enqueue_response" id-system="GVESB_TEST"<br />
input="output" next-node-id="end"<br />
op-type="enqueue"<br />
operation-name="JMSEnqueueTo::TOUPPER_A_Resp"<br />
output="output" point-x="319" point-y="152"<br />
type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
end-business-process="no" id="end" op-type="end"<br />
output="output" point-x="532" point-y="149"<br />
type="flow-node"><br />
<ChangeGVBuffer clear-data="true"/><br />
</GVEndNode><br />
</Flow><br />
</Operation><br />
</Service><br />
</syntaxhighlight><br />
* Into ''System'' element will be added the tag<br />
<syntaxhighlight lang="XML"><br />
<Channel id-channel="TEST_CHANNEL_A"><br />
<jms-enqueue acknowledge-type="auto-acknowledge"<br />
class="it.greenvulcano.gvesb.virtual.j2ee.JMSEnqueueOperation"<br />
connection-factory="java:/XAConnectionFactory"<br />
delivery-mode="persistent"<br />
destination-name="gvesb/jms/queue/TOUPPER_A_Request_Queue"<br />
destination-type="queue"<br />
name="JMSEnqueueTo::TOUPPER_A_Req" priority="4"<br />
ref-dp="WriteString_JMSBytesMessageDataProvider"<br />
transacted="false" type="enqueue"><br />
<XAHelper auto-enlist="false" transaction-status="TMSUCCESS"/><br />
</jms-enqueue><br />
<jms-enqueue acknowledge-type="auto-acknowledge"<br />
class="it.greenvulcano.gvesb.virtual.j2ee.JMSEnqueueOperation"<br />
connection-factory="java:/XAConnectionFactory"<br />
delivery-mode="persistent"<br />
destination-name="gvesb/jms/queue/TOUPPER_A_Response_Queue"<br />
destination-type="queue"<br />
name="JMSEnqueueTo::TOUPPER_A_Resp" priority="4"<br />
ref-dp="WriteString_JMSBytesMessageDataProvider"<br />
transacted="false" type="enqueue"><br />
<XAHelper auto-enlist="false" transaction-status="TMSUCCESS"/><br />
</jms-enqueue><br />
<jms-dequeue acknowledge-type="auto-acknowledge"<br />
class="it.greenvulcano.gvesb.virtual.j2ee.JMSDequeueOperation"<br />
connection-factory="java:/XAConnectionFactory"<br />
destination-name="gvesb/jms/queue/TOUPPER_A_Response_Queue"<br />
destination-type="queue"<br />
name="JMSDequeueTo::TOUPPER_A_Resp"<br />
receive-timeout-overridable="false"<br />
receive-type="timeout"<br />
ref-dp="ReadString_JMSBytesMessageDataProvider"<br />
transacted="false" type="dequeue"><br />
<XAHelper auto-enlist="false" transaction-status="TMSUCCESS"/><br />
</jms-dequeue><br />
<test-service-call class="it.greenvulcano.gvesb.virtual.internal.TestServiceCall"<br />
name="toupper_call" service="toupper" type="call"/><br />
</Channel><br />
</syntaxhighlight><br />
<br />
Now you are able to test your first {{VULCON}} service from the {{L_GVCONSOLE}}. But first you need to export the configuration.<br />
<br />
[[File:GVExamplesTOUPPER5.jpg|thumb|Exporting configuration]]Once the flow is correctly configured, the user can export the configuration and pass it to the {{GVESB}} import tool, in order to add into the {{GVESB}} the service just created.<br />
<br />
# The Export function is available in the view "Project". Expand the project<br />
# Before you proceed press F5 to refresh the file list.<br />
# Right click the ''conf'' folder. It will open a drop-down list. <br />
# Export your project as a compressed file.<br />
<br />
===Testing with {{GVCONSOLE}}===<br />
<br />
It is finally the time to test your project. To do that execute the following steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} project as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Browse and select the file where you saved the {{VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Selecting the TOUPPER_A service a new view will be shown. In this view is the contents of the file GVCore.xml in the local version and the one on the server.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. By saving you will return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapter.xml, then Reload.<br />
# Finally confirm the operation.<br />
<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{GVCONSOLE}} section [[Testing]]. In this section you can finally test your new service. Remember that Service TOUPPER_A is composed by three independent Operations:<br />
<br />
'''Request'''<br />
# Into the Service field select TOUPPER_A<br />
# Into the System field select GVESB_TEST<br />
# Into the Payload area insert the text to convert in uppercase<br />
# Click Request<br />
<br />
The '''FWD_TOUPPER_A''' is executed by {{GVESB}} [[GVForwards|JMS Forward]].<br />
<br />
'''getReply'''<br />
# Clear the Payload area<br />
# Click getReply<br />
<br />
When each test completes, the Testing view will be expanded for containing the GVBUFFER OUTPUT. In this case no properties have been defined, thus only main informations about the process (System, Service, Id, etc.) are shown. To view the service payload output click on ''Show as Text'' button. Standard fields and the detailed GVBuffer are described in the [[Testing#Data_input|Output File Name]] (the default location is <nowiki>$GV_HOME</nowiki>/log/TestOutput.txt). <br />
<br />
In case of error or exceptions you can review the logs file in the <nowiki>$GV_HOME</nowiki>/log/ folder.</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_TOUPPER_A&diff=4224GVExample TOUPPER A2014-05-29T10:18:51Z<p>D.franco: </p>
<hr />
<div>==Description==<br />
<br />
This simple example shows how to configure an asynchronous service with a [[GVForwards|JMS Forward]] . <br />
The Service TOUPPER_A is composed of three workflows that define the Client/ESB/Server interaction:<br />
# the Client invokes the ''Request'' workflow to enqueue the input data into a request queue<br />
# the [[GVForwards|JMS Forward]] (a {{GVESB}} component), listening on the request queue, extracts the JMS message and invokes the ''FWD_TOUPPER_A'' workflow that converts the payload to uppercase (simulate a Server invocation) then enqueues the new payload into a response queue<br />
# the Client invokes the ''getReply'' workflow to dequeue the output data from a response queue<br />
<br />
==How To==<br />
<br />
The preferred mode for creating a Service (at least its skeleton) is through the Service Wizard. Before using it you must first configure the JMS Queue and the VCL plugins to interact with the JMS queue and execute the uppercase conversion. So let's define a new Group, System and Channel, if you do not want to use those already present, and then start the Wizard. <br />
<br />
===Configuring JMS queues in JBoss===<br />
<br />
The JMS queues are configured in JBoss by an XML file, ''gvesb-mq-destinations-service.xml'' present in <nowiki>$GV_HOME</nowiki>/application/deploy.<br />
<br />
A queue has:<br />
* A name that serves to identify it to JBoss.<br />
* A JNDI Name used by a client to connect to the queue.<br />
* MaxDeliveryAttempts (optional), to indicate how many times a message is put back into the queue for processing if the application does not confirm its reading.<br />
* RedeliveryDelay (optional), to indicate the delay (in ms) after a message will be put back into the queue if the application does not confirm its reading.<br />
<br />
The JndiName can be checked using the JBoss's jmx-console to find the MBean "service=JNDIView".<br />
<br />
In this example we use 2 queues:<br />
* ''TOUPPER_A_Request_Queue''<br />
* ''TOUPPER_A_Response_Queue''<br />
<br />
To configure both queues go to the configuration file and insert the following MBean definitions:<br />
<syntaxhighlight lang="XML"><br />
<mbean code="org.jboss.jms.server.destination.QueueService"<br />
name="jboss.messaging.destination:service=Queue,name=TOUPPER_A_Request_Queue"<br />
xmbean-dd="xmdesc/Queue-xmbean.xml"><br />
<depends optional-attribute-name="ServerPeer">jboss.messaging:service=ServerPeer</depends><br />
<depends>jboss.messaging:service=PostOffice</depends><br />
<attribute name="JNDIName">gvesb/jms/queue/TOUPPER_A_Request_Queue</attribute><br />
<attribute name="RedeliveryDelay">60000</attribute><br />
<attribute name="MaxDeliveryAttempts">100</attribute><br />
</mbean><br />
<mbean code="org.jboss.jms.server.destination.QueueService"<br />
name="jboss.messaging.destination:service=Queue,name=TOUPPER_A_Response_Queue"<br />
xmbean-dd="xmdesc/Queue-xmbean.xml"><br />
<depends optional-attribute-name="ServerPeer">jboss.messaging:service=ServerPeer</depends><br />
<depends>jboss.messaging:service=PostOffice</depends><br />
<attribute name="JNDIName">gvesb/jms/queue/TOUPPER_A_Response_Queue</attribute><br />
<attribute name="RedeliveryDelay">60000</attribute><br />
<attribute name="MaxDeliveryAttempts">100</attribute><br />
</mbean><br />
</syntaxhighlight><br />
<br />
===Defining Group, System and Channel===<br />
<br />
From the core view:<br />
# Right click the element Groups -> Insert after (or Insert before) -> Group. A new element Group will be created. <br />
# Click on the Group new element and set the attribute ''id-group'' from the Properties View. We named it DEFAULT_GRP<br />
# Expand the GVSystems item.<br />
# Right clicking on Systems, insert-after -> System. A new element System will be created.<br />
# Set the [[System]] parameters in the [[VulCon_perspective|Properties panel]]. We named it GVESB_TEST<br />
# 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<br />
# Click on this new Channel element and set the property ''id_channel''. We named it TEST_CHANNEL_A<br />
<br />
<br />
===Defining Workflow Operations===<br />
<br />
Once you have created the [[Channel]], insert into the operations you need for the workflow. In this case:<br />
<br />
{|class="gvtable"<br />
! Plugin !! Value<br />
|-<br />
| [[jms-enqueue]] || connection-factory="java:/XAConnectionFactory"<br/>delivery-mode="persistent"<br/>destination-name="gvesb/jms/queue/TOUPPER_A_Request_Queue"<br/>name="JMSEnqueueTo::TOUPPER_A_Req"<br/> ref-dp="WriteString_JMSBytesMessageDataProvider"<br />
|-<br />
| [[jms-enqueue]]/[[XAHelper]] || auto-enlist="false"<br/>transaction-status="TMSUCCESS"<br/>(You can find XAHelper section by adding it on the queue)<br />
|-<br />
| [[jms-enqueue]] || connection-factory="java:/XAConnectionFactory"<br/>delivery-mode="persistent"<br/>destination-name="gvesb/jms/queue/TOUPPER_A_Response_Queue"<br/>name="JMSEnqueueTo::TOUPPER_A_Resp"<br/> ref-dp="WriteString_JMSBytesMessageDataProvider"<br />
|-<br />
| [[jms-enqueue]]/[[XAHelper]] || auto-enlist="false"<br/>transaction-status="TMSUCCESS"<br />
|-<br />
| [[jms-dequeue]] || connection-factory="java:/XAConnectionFactory"<br/>destination-name="gvesb/jms/queue/TOUPPER_A_Response_Queue"<br/>name="JMSDequeueTo::TOUPPER_A_Resp"<br/> ref-dp="ReadString_JMSBytesMessageDataProvider"<br/> receive-type="timeout"<br />
|-<br />
| [[jms-dequeue]]/[[XAHelper]] || auto-enlist="false"<br/>transaction-status="TMSUCCESS"<br />
|-<br />
| [[test-service-call]] || name="toupper_call" service="toupper"<br />
|}<br />
<br />
The ''WriteString_JMSBytesMessageDataProvider'' creates a JMS BytesMessage and write in its body the expected input java.lang.String converted to byte[].<br/><br />
The ''ReadString_JMSBytesMessageDataProvider'' extract the input JMS BytesMessage body as byte[] and convert it into a java.lang.String.<br/><br />
Check that [[Data provider|Data Providers]] ''WriteString_JMSBytesMessageDataProvider'' and ''ReadString_JMSBytesMessageDataProvider'' are present in the element DataProviders (JMSBytesMessageDataProvider and StringDataProvider respectively), visualized from the {{VULCON}} Adapter view. If don't, you can add it setting their attributes as seen in the following table:<br />
{|class="gvtable"<br />
! Data Provider !! Value<br />
|-<br />
| [[Data provider|JMSBytesMessageDataProvider]] || name="WriteString_JMSBytesMessageDataProvider"<br />
|-<br />
| [[Data provider|JMSBytesMessageDataProvider]]/[[Field]] || direction="OUT"<br/>key="output"<br/>type="field"<br />
|-<br />
| [[Data provider|JMSBytesMessageDataProvider]]/Expression || type="ognl"<br/>writeBytes(#input.object.getBytes('UTF-8'))<br />
|-<br />
| [[Data provider|StringDataProvider]] || name="ReadString_JMSBytesMessageDataProvider"<br />
|-<br />
| [[Data provider|StringDataProvider]]/[[Field]] || direction="INOUT"<br/>key="buffer"<br/>type="field"<br />
|-<br />
| [[Data provider|StringDataProvider]]/Expression || type="ognl"<br/>#bArr = new byte[object.getBodyLength()], object.reset(), object.readBytes(#bArr), new java.lang.String(#bArr, 'UTF-8')<br />
|}<br />
<br />
[[File:NewServiceWizard.jpg|thumb|New {{GVESB}} Service Wizard]]Now we are able to use the Wizard.<br />
# From the Core View of {{VULCON}}. Right click the element Services -> Wizard New Service<br />
# A new windows will be open where you can set the name of the Service you want to create, in this case we named TOUPPER_A, and your Group, we used DEFAULT_GRP. You can also select the paradigm, for this example will be [[Paradigms_of_communication#asynchronous-synchronous|asynchronous-synchronous]]. Click next.<br />
# Set System as GVESB_TEST and Channel as TEST_CHANNEL_A. Then chose as Request Operation ''JMSEnqueueTo::TOUPPER_A_Req'', and the response Operation ''toupper_call''. Then finish.<br />
<br />
<br />
[[File:GVExamplesTOUPPER_AEditor.jpg |thumb |TOUPPER_A flow]]As you can see from the core view, inside the Services element, a new Service named TOUPPER_A has been created.<br/>This service contains three Operations (Workflows)<br />
We setted the first one as a Request (to enqueue), and the second as a GetReply (to dequeue).<br />
Nodes will be setted as seen in the following table:<br />
{|class="gvtable"<br />
! Node !! Request !! GetReply<br />
|-<br />
| GVOperationNode || output="output_JMSEnqueueTo::TOUPPER_A_Req"<br/>id="request"<br/>id-system="GVESB_TEST"<br/>input="input_JMSEnqueueTo::TOUPPER_A_Req"<br/>next-node-id="check_status" op-type="enqueue"<br/>operation-name="JMSEnqueueTo::TOUPPER_A_Req" || output="output_JMSDequeueTo::TOUPPER_A_Resp"<br/>id="request"<br/>id-system="GVESB_TEST"<br/>input="input_JMSDequeueTo::TOUPPER_A_Resp"<br/>next-node-id="check_status" op-type="dequeue"<br/>operation-name="JMSDequeueTo::TOUPPER_A_Resp"<br/>DequeueFilter:<br />
: IDFilter<br />
:: enabled="yes" use-input="yes"<br />
|-<br />
| GVNodeCheck || default-id="return_status"<br/>id="check_status"<br/>input="output_JMSEnqueueTo::TOUPPER_A_Req"<br/>on-exception-id="return_error"<br/>op-type="check" || default-id="return_status"<br/>id="check_status"<br/>input="output_JMSDequeueTo::TOUPPER_A_Resp"<br/>on-exception-id="return_error"<br/>op-type="check"<br />
|-<br />
| GVEndNode || id="return_status"<br/>op-type="end"<br/>output="output_JMSEnqueueTo::TOUPPER_A_Req" || id="return_status"<br/>op-type="end"<br/>output="output_JMSDequeueTo::TOUPPER_A_Resp"<br />
|-<br />
| GVEndNode || id="return_error"<br/>output="output_JMSEnqueueTo::TOUPPER_A_Req" || id="return_error"<br/>output="output_JMSDequeueTo::TOUPPER_A_Resp" <br />
|} <br />
<br />
Operation FWD_TOUPPER_A will be configured as follow:<br />
Attributes: name="Forward" operation-activation="on" out-check-type="none"<br />
{|class="gvtable"<br />
! Nodes/Subelements !! Attributes<br />
|-<br />
| GVOperationNode || id-system="GVESB_TEST"<br/> input="input"<br/> next-node-id="enqueue_response" op-type="call"<br/> operation-name="toupper_call" output="output"<br />
|-<br />
| GVOperationNode || id="enqueue_response" id-system="GVESB_TEST"<br/> input="output" next-node-id="end"<br/> op-type="enqueue"<br/> operation-name="JMSEnqueueTo::TOUPPER_A_Resp"<br/> output="output"<br />
|-<br />
| GVEndNode || end-business-process="no" id="end" op-type="end"<br/> output="output" <br/> ChangeGVBuffer: clear-data="true"<br />
|} <br />
<br />
The GVCore.xml configuration file will be changed as follow:<br />
* Into ''GVForwards'' element will be added the tag<br />
<syntaxhighlight lang="XML"><br />
<ForwardConfiguration dump-message="true" enabled="true"<br />
forwardName="FWD_TOUPPER_A"<br />
ref-dp="ReadString_JMSBytesMessageDataProvider"><br />
<ForwardDeployment connection-factory="java:/XAConnectionFactory"<br />
destination="gvesb/jms/queue/TOUPPER_A_Request_Queue"<br />
destination-type="queue" reconnect-interval-sec="10"<br />
transacted="true" transaction-timeout-sec="30"><br />
<XAHelper auto-enlist="false" transaction-status="TMSUCCESS"/><br />
</ForwardDeployment><br />
</ForwardConfiguration><br />
</syntaxhighlight><br />
* Into ''Services'' element will be added the tag<br />
<syntaxhighlight lang="XML"><br />
<Service group-name="DEFAULT_GRP" id-service="TOUPPER_A"<br />
service-activation="on" statistics="off"><br />
<Operation name="Request" operation-activation="on"<br />
out-check-type="sys-svc-id" type="operation"><br />
<Description>VulCon generated Operation</Description><br />
<Participant id-channel="TEST_CHANNEL_A" id-system="GVESB_TEST"/><br />
<Flow first-node="request" point-x="50" point-y="150"><br />
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"<br />
id="request" id-system="GVESB_TEST"<br />
input="input_JMSEnqueueTo::TOUPPER_A_Req"<br />
next-node-id="check_status" op-type="enqueue"<br />
operation-name="JMSEnqueueTo::TOUPPER_A_Req"<br />
output="output_JMSEnqueueTo::TOUPPER_A_Req"<br />
point-x="200" point-y="150" type="flow-node"/><br />
<GVNodeCheck class="it.greenvulcano.gvesb.core.flow.GVNodeCheck"<br />
default-id="return_status" id="check_status"<br />
input="output_JMSEnqueueTo::TOUPPER_A_Req"<br />
on-exception-id="return_error" op-type="check"<br />
point-x="350" point-y="150" type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_status" op-type="end"<br />
output="output_JMSEnqueueTo::TOUPPER_A_Req"<br />
point-x="700" point-y="150" type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_error" op-type="end"<br />
output="output_JMSEnqueueTo::TOUPPER_A_Req"<br />
point-x="350" point-y="300" type="flow-node"/><br />
</Flow><br />
</Operation><br />
<Operation name="GetReply" operation-activation="on"<br />
out-check-type="sys-svc-id" type="operation"><br />
<Description>VulCon generated Operation</Description><br />
<Participant id-channel="TEST_CHANNEL_A" id-system="GVESB_TEST"/><br />
<Flow first-node="request" point-x="50" point-y="150"><br />
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"<br />
id="request" id-system="GVESB_TEST"<br />
input="input_JMSDequeueTo::TOUPPER_A_Resp"<br />
next-node-id="check_status" op-type="dequeue"<br />
operation-name="JMSDequeueTo::TOUPPER_A_Resp"<br />
output="output_JMSDequeueTo::TOUPPER_A_Resp"<br />
point-x="200" point-y="150" type="flow-node"><br />
<DequeueFilter><br />
<IDFilter enabled="yes" name="IDFilter" type="filter"<br />
use-input="yes"/><br />
</DequeueFilter><br />
</GVOperationNode><br />
<GVNodeCheck class="it.greenvulcano.gvesb.core.flow.GVNodeCheck"<br />
default-id="return_status" id="check_status"<br />
input="output_JMSDequeueTo::TOUPPER_A_Resp" <br />
on-exception-id="return_error" op-type="check"<br />
point-x="350" point-y="150" type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_status" op-type="end" <br />
output="output_JMSDequeueTo::TOUPPER_A_Resp"<br />
point-x="700" point-y="150" type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_error" op-type="end"<br />
output="output_JMSDequeueTo::TOUPPER_A_Resp"<br />
point-x="350" point-y="300" type="flow-node"/><br />
</Flow><br />
</Operation><br />
<Operation forward-name="FWD_TOUPPER_A" name="Forward"<br />
operation-activation="on" out-check-type="none"<br />
type="operation"><br />
<Participant id-channel="TEST_CHANNEL_A" id-system="GVESB_TEST"/><br />
<Flow first-node="call_server" point-x="20" point-y="150"><br />
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"<br />
id="call_server" id-system="GVESB_TEST" input="input"<br />
next-node-id="enqueue_response" op-type="call"<br />
operation-name="toupper_call" output="output"<br />
point-x="147" point-y="148" type="flow-node"/><br />
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"<br />
id="enqueue_response" id-system="GVESB_TEST"<br />
input="output" next-node-id="end"<br />
op-type="enqueue"<br />
operation-name="JMSEnqueueTo::TOUPPER_A_Resp"<br />
output="output" point-x="319" point-y="152"<br />
type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
end-business-process="no" id="end" op-type="end"<br />
output="output" point-x="532" point-y="149"<br />
type="flow-node"><br />
<ChangeGVBuffer clear-data="true"/><br />
</GVEndNode><br />
</Flow><br />
</Operation><br />
</Service><br />
</syntaxhighlight><br />
* Into ''System'' element will be added the tag<br />
<syntaxhighlight lang="XML"><br />
<Channel id-channel="TEST_CHANNEL_A"><br />
<jms-enqueue acknowledge-type="auto-acknowledge"<br />
class="it.greenvulcano.gvesb.virtual.j2ee.JMSEnqueueOperation"<br />
connection-factory="java:/XAConnectionFactory"<br />
delivery-mode="persistent"<br />
destination-name="gvesb/jms/queue/TOUPPER_A_Request_Queue"<br />
destination-type="queue"<br />
name="JMSEnqueueTo::TOUPPER_A_Req" priority="4"<br />
ref-dp="WriteString_JMSBytesMessageDataProvider"<br />
transacted="false" type="enqueue"><br />
<XAHelper auto-enlist="false" transaction-status="TMSUCCESS"/><br />
</jms-enqueue><br />
<jms-enqueue acknowledge-type="auto-acknowledge"<br />
class="it.greenvulcano.gvesb.virtual.j2ee.JMSEnqueueOperation"<br />
connection-factory="java:/XAConnectionFactory"<br />
delivery-mode="persistent"<br />
destination-name="gvesb/jms/queue/TOUPPER_A_Response_Queue"<br />
destination-type="queue"<br />
name="JMSEnqueueTo::TOUPPER_A_Resp" priority="4"<br />
ref-dp="WriteString_JMSBytesMessageDataProvider"<br />
transacted="false" type="enqueue"><br />
<XAHelper auto-enlist="false" transaction-status="TMSUCCESS"/><br />
</jms-enqueue><br />
<jms-dequeue acknowledge-type="auto-acknowledge"<br />
class="it.greenvulcano.gvesb.virtual.j2ee.JMSDequeueOperation"<br />
connection-factory="java:/XAConnectionFactory"<br />
destination-name="gvesb/jms/queue/TOUPPER_A_Response_Queue"<br />
destination-type="queue"<br />
name="JMSDequeueTo::TOUPPER_A_Resp"<br />
receive-timeout-overridable="false"<br />
receive-type="timeout"<br />
ref-dp="ReadString_JMSBytesMessageDataProvider"<br />
transacted="false" type="dequeue"><br />
<XAHelper auto-enlist="false" transaction-status="TMSUCCESS"/><br />
</jms-dequeue><br />
<test-service-call class="it.greenvulcano.gvesb.virtual.internal.TestServiceCall"<br />
name="toupper_call" service="toupper" type="call"/><br />
</Channel><br />
</syntaxhighlight><br />
<br />
Now you are able to test your first {{VULCON}} service from the {{L_GVCONSOLE}}. But first you need to export the configuration.<br />
<br />
[[File:GVExamplesTOUPPER5.jpg|thumb|Exporting configuration]]Once the flow is correctly configured, the user can export the configuration and pass it to the {{GVESB}} import tool, in order to add into the {{GVESB}} the service just created.<br />
<br />
# The Export function is available in the view "Project". Expand the project<br />
# Before you proceed press F5 to refresh the file list.<br />
# Right click the ''conf'' folder. It will open a drop-down list. <br />
# Export your project as a compressed file.<br />
<br />
===Testing with {{GVCONSOLE}}===<br />
<br />
It is finally the time to test your project. To do that execute the following steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} project as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Browse and select the file where you saved the {{VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service TOUPPER_A a new view will be showed containing the files GVCore.xml present in local and on server side.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. By saving you will return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapter.xml, then Reload. A new windows will be open to confirm the operation<br />
# Click OK.<br />
<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{GVCONSOLE}} section [[Testing]]. In this section you can finally test your new service. Remember that Service TOUPPER_A is composed by three independent Operations:<br />
<br />
'''Request'''<br />
# Into the Service field select TOUPPER_A<br />
# Into the System field select GVESB_TEST<br />
# Into the Payload area insert the text to convert in uppercase<br />
# Click Request<br />
<br />
The '''FWD_TOUPPER_A''' is executed by {{GVESB}} [[GVForwards|JMS Forward]].<br />
<br />
'''getReply'''<br />
# Clear the Payload area<br />
# Click getReply<br />
<br />
When each test completes, the Testing view will be expanded for containing the GVBUFFER OUTPUT. In this case no properties have been defined so there are only be presents the main informations about the process (System, Service, Id, etc.). To view the service payload output click on ''Show as Text'' button. Standard fields and the detailed GVBuffer are described in the [[Testing#Data_input|Output File Name]] (the default location is <nowiki>$GV_HOME</nowiki>/log/TestOutput.txt). <br />
<br />
In case of error or exceptions you can review the logs file present in the folder <nowiki>$GV_HOME</nowiki>/log/.</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_TOUPPER_A&diff=4223GVExample TOUPPER A2014-05-28T16:38:07Z<p>D.franco: /* Defining Workflow Operations */</p>
<hr />
<div>==Description==<br />
<br />
This simple example shows how to configure an asynchronous service with a [[GVForwards|JMS Forward]] . <br />
The Service TOUPPER_A is composed of three workflows that define the Client/ESB/Server interaction:<br />
# the Client invokes the ''Request'' workflow to enqueue the input data into a request queue<br />
# the [[GVForwards|JMS Forward]] (a {{GVESB}} component), listening on the request queue, extracts the JMS message and invokes the ''FWD_TOUPPER_A'' workflow that converts the payload to uppercase (simulate a Server invocation) then enqueues the new payload into a response queue<br />
# the Client invokes the ''getReply'' workflow to dequeue the output data from a response queue<br />
<br />
==How To==<br />
<br />
The preferred mode for creating a Service (at least its skeleton) is through the Service Wizard. Before using it you must first configure the JMS Queue and the VCL plugins to interact with the JMS queue and execute the uppercase conversion. So let's define a new Group, System and Channel, if you do not want to use those already present, and then start the Wizard. <br />
<br />
===Configuring JMS queues in JBoss===<br />
<br />
The JMS queues are configured in JBoss by an XML file, ''gvesb-mq-destinations-service.xml'' present in <nowiki>$GV_HOME</nowiki>/application/deploy.<br />
<br />
A queue has:<br />
* A name that serves to identify it to JBoss.<br />
* A JNDI Name used by a client to connect to the queue.<br />
* MaxDeliveryAttempts (optional), to indicate how many times a message is put back into the queue for processing if the application does not confirm its reading.<br />
* RedeliveryDelay (optional), to indicate the delay (in ms) after a message will be put back into the queue if the application does not confirm its reading.<br />
<br />
The JndiName can be checked using the JBoss's jmx-console to find the MBean "service=JNDIView".<br />
<br />
In this example we use 2 queues:<br />
* ''TOUPPER_A_Request_Queue''<br />
* ''TOUPPER_A_Response_Queue''<br />
<br />
To configure both queues go to the configuration file and insert the following MBean definitions:<br />
<syntaxhighlight lang="XML"><br />
<mbean code="org.jboss.jms.server.destination.QueueService"<br />
name="jboss.messaging.destination:service=Queue,name=TOUPPER_A_Request_Queue"<br />
xmbean-dd="xmdesc/Queue-xmbean.xml"><br />
<depends optional-attribute-name="ServerPeer">jboss.messaging:service=ServerPeer</depends><br />
<depends>jboss.messaging:service=PostOffice</depends><br />
<attribute name="JNDIName">gvesb/jms/queue/TOUPPER_A_Request_Queue</attribute><br />
<attribute name="RedeliveryDelay">60000</attribute><br />
<attribute name="MaxDeliveryAttempts">100</attribute><br />
</mbean><br />
<mbean code="org.jboss.jms.server.destination.QueueService"<br />
name="jboss.messaging.destination:service=Queue,name=TOUPPER_A_Response_Queue"<br />
xmbean-dd="xmdesc/Queue-xmbean.xml"><br />
<depends optional-attribute-name="ServerPeer">jboss.messaging:service=ServerPeer</depends><br />
<depends>jboss.messaging:service=PostOffice</depends><br />
<attribute name="JNDIName">gvesb/jms/queue/TOUPPER_A_Response_Queue</attribute><br />
<attribute name="RedeliveryDelay">60000</attribute><br />
<attribute name="MaxDeliveryAttempts">100</attribute><br />
</mbean><br />
</syntaxhighlight><br />
<br />
===Defining Group, System and Channel===<br />
<br />
From the core view:<br />
# Right click the element Groups -> Insert after (or Insert before) -> Group. A new element Group will be created. <br />
# Click on the Group new element and set the attribute ''id-group'' from the Properties View. We named it DEFAULT_GRP<br />
# Expand the GVSystems item.<br />
# Right clicking on Systems, insert-after -> System. A new element System will be created.<br />
# Set the [[System]] parameters in the [[VulCon_perspective|Properties panel]]. We named it GVESB_TEST<br />
# 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<br />
# Click on this new Channel element and set the property ''id_channel''. We named it TEST_CHANNEL_A<br />
<br />
<br />
===Defining Workflow Operations===<br />
<br />
Once you have created the [[Channel]], insert into the operations you need for the workflow. In this case:<br />
<br />
{|class="gvtable"<br />
! Plugin !! Value<br />
|-<br />
| [[jms-enqueue]] || connection-factory="java:/XAConnectionFactory"<br/>delivery-mode="persistent"<br/>destination-name="gvesb/jms/queue/TOUPPER_A_Request_Queue"<br/>name="JMSEnqueueTo::TOUPPER_A_Req"<br/> ref-dp="WriteString_JMSBytesMessageDataProvider"<br />
|-<br />
| [[jms-enqueue]]/[[XAHelper]] || auto-enlist="false"<br/>transaction-status="TMSUCCESS"<br/>(You can find XAHelper section by adding it on the queue)<br />
|-<br />
| [[jms-enqueue]] || connection-factory="java:/XAConnectionFactory"<br/>delivery-mode="persistent"<br/>destination-name="gvesb/jms/queue/TOUPPER_A_Response_Queue"<br/>name="JMSEnqueueTo::TOUPPER_A_Resp"<br/> ref-dp="WriteString_JMSBytesMessageDataProvider"<br />
|-<br />
| [[jms-enqueue]]/[[XAHelper]] || auto-enlist="false"<br/>transaction-status="TMSUCCESS"<br />
|-<br />
| [[jms-dequeue]] || connection-factory="java:/XAConnectionFactory"<br/>destination-name="gvesb/jms/queue/TOUPPER_A_Response_Queue"<br/>name="JMSDequeueTo::TOUPPER_A_Resp"<br/> ref-dp="ReadString_JMSBytesMessageDataProvider"<br/> receive-type="timeout"<br />
|-<br />
| [[jms-dequeue]]/[[XAHelper]] || auto-enlist="false"<br/>transaction-status="TMSUCCESS"<br />
|-<br />
| [[test-service-call]] || name="toupper_call" service="toupper"<br />
|}<br />
<br />
The ''WriteString_JMSBytesMessageDataProvider'' creates a JMS BytesMessage and write in its body the expected input java.lang.String converted to byte[].<br/><br />
The ''ReadString_JMSBytesMessageDataProvider'' extract the input JMS BytesMessage body as byte[] and convert it into a java.lang.String.<br/><br />
Check that [[Data provider|Data Providers]] ''WriteString_JMSBytesMessageDataProvider'' and ''ReadString_JMSBytesMessageDataProvider'' are present in the element DataProviders (JMSBytesMessageDataProvider and StringDataProvider respectively), visualized from the {{VULCON}} Adapter view. If don't, you can add it setting their attributes as seen in the following table:<br />
{|class="gvtable"<br />
! Data Provider !! Value<br />
|-<br />
| [[Data provider|JMSBytesMessageDataProvider]] || name="WriteString_JMSBytesMessageDataProvider"<br />
|-<br />
| [[Data provider|JMSBytesMessageDataProvider]]/[[Field]] || direction="OUT"<br/>key="output"<br/>type="field"<br />
|-<br />
| [[Data provider|JMSBytesMessageDataProvider]]/Expression || type="ognl"<br/>writeBytes(#input.object.getBytes('UTF-8'))<br />
|-<br />
| [[Data provider|StringDataProvider]] || name="ReadString_JMSBytesMessageDataProvider"<br />
|-<br />
| [[Data provider|StringDataProvider]]/[[Field]] || direction="INOUT"<br/>key="buffer"<br/>type="field"<br />
|-<br />
| [[Data provider|StringDataProvider]]/Expression || type="ognl"<br/>#bArr = new byte[object.getBodyLength()], object.reset(), object.readBytes(#bArr), new java.lang.String(#bArr, 'UTF-8')<br />
|}<br />
<br />
[[File:NewServiceWizard.jpg|thumb|New {{GVESB}} Service Wizard]]Now we are able to use the Wizard.<br />
# From the Core View of {{VULCON}}. Right click the element Services -> Wizard New Service<br />
# A new windows will be open where you can set the name of the Service you want to create, in this case we named TOUPPER_A, and your Group, we used DEFAULT_GRP. You can also select the paradigm, for this example will be [[Paradigms_of_communication#asynchronous-synchronous|asynchronous-synchronous]]. Click next.<br />
# Set System as GVESB_TEST and Channel as TEST_CHANNEL_A. Then chose as Request Operation ''JMSEnqueueTo::TOUPPER_A_Req'', and the response Operation ''toupper_call''. Then finish.<br />
<br />
<br />
[[File:GVExamplesTOUPPER_AEditor.jpg |thumb |TOUPPER_A flow]]As you can see from the core view, inside the Services element, a new Service named TOUPPER_A has been created.<br/>This service contains three Operations (Workflows)<br />
We setted the first one as a Request (to enqueue), and the second as a GetReply (to dequeue).<br />
Nodes will be setted as seen in the following table:<br />
{|class="gvtable"<br />
! Node !! Request !! GetReply<br />
|-<br />
| GVOperationNode || output: output_JMSEnqueueTo::TOUPPER_A_Req<br/>id="request"<br/>id-system="GVESB_TEST"<br/>input="input_JMSEnqueueTo::TOUPPER_A_Req"<br/>next-node-id="check_status" op-type="enqueue"<br/>operation-name="JMSEnqueueTo::TOUPPER_A_Req" || output: "output_JMSDequeueTo::TOUPPER_A_Resp"<br/>id="request"<br/>id-system="GVESB_TEST"<br/>input="input_JMSDequeueTo::TOUPPER_A_Resp"<br/>next-node-id="check_status" op-type="dequeue"<br/>operation-name="JMSDequeueTo::TOUPPER_A_Resp"<br/>DequeueFilter:<br />
: IDFilter<br />
:: enabled="yes" use-input="yes"<br />
|-<br />
| GVNodeCheck || default-id="return_status"<br/>id="check_status"<br/>input="output_JMSEnqueueTo::TOUPPER_A_Req"<br/>on-exception-id="return_error"<br/>op-type="check" || default-id="return_status"<br/>id="check_status"<br/>input="output_JMSDequeueTo::TOUPPER_A_Resp"<br/>on-exception-id="return_error"<br/>op-type="check"<br />
|-<br />
| GVEndNode || id="return_status"<br/>op-type="end"<br/>output="output_JMSEnqueueTo::TOUPPER_A_Req" || id="return_status"<br/>op-type="end"<br/>output="output_JMSDequeueTo::TOUPPER_A_Resp"<br />
|-<br />
| GVEndNode || id="return_error"<br/>output="output_JMSEnqueueTo::TOUPPER_A_Req" || id="return_error"<br/>output="output_JMSDequeueTo::TOUPPER_A_Resp" <br />
|} <br />
<br />
Operation FWD_TOUPPER_A will be configured as follow:<br />
Attributes: name="Forward" operation-activation="on" out-check-type="none"<br />
{|class="gvtable"<br />
! Nodes/Subelements !! Attributes<br />
|-<br />
| GVOperationNode || id-system="GVESB"<br/> input="input"<br/> next-node-id="enqueue_response" op-type="call"<br/> operation-name="toupper_call" output="output"<br />
|-<br />
| GVOperationNode || id="enqueue_response" id-system="GVESB"<br/> input="output" next-node-id="end"<br/> op-type="enqueue"<br/> operation-name="JMSEnqueueTo::TOUPPER_A_Resp"<br/> output="output"<br />
|-<br />
| GVEndNode || end-business-process="no" id="end" op-type="end"<br/> output="output" <br/> ChangeGVBuffer: clear-data="true"<br />
|} <br />
<br />
The GVCore.xml configuration file will be changed as follow:<br />
* Into ''GVForwards'' element will be added the tag<br />
<syntaxhighlight lang="XML"><br />
<ForwardConfiguration dump-message="true" enabled="true"<br />
forwardName="FWD_TOUPPER_A"<br />
ref-dp="ReadString_JMSBytesMessageDataProvider"><br />
<ForwardDeployment connection-factory="java:/XAConnectionFactory"<br />
destination="gvesb/jms/queue/TOUPPER_A_Request_Queue"<br />
destination-type="queue" reconnect-interval-sec="10"<br />
transacted="true" transaction-timeout-sec="30"><br />
<XAHelper auto-enlist="false" transaction-status="TMSUCCESS"/><br />
</ForwardDeployment><br />
</ForwardConfiguration><br />
</syntaxhighlight><br />
* Into ''Services'' element will be added the tag<br />
<syntaxhighlight lang="XML"><br />
<Service group-name="DEFAULT_GRP" id-service="TOUPPER_A"<br />
service-activation="on" statistics="off"><br />
<Operation name="Request" operation-activation="on"<br />
out-check-type="sys-svc-tid" type="operation"><br />
<Description>VulCon generated Operation</Description><br />
<Participant id-channel="TEST_CHANNEL_A" id-system="GVESB_TEST"/><br />
<Flow first-node="request" point-x="50" point-y="150"><br />
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"<br />
id="request" id-system="GVESB_TEST"<br />
input="input_JMSEnqueueTo::TOUPPER_A_Req"<br />
next-node-id="check_status" op-type="enqueue"<br />
operation-name="JMSEnqueueTo::TOUPPER_A_Req"<br />
output="output_JMSEnqueueTo::TOUPPER_A_Req"<br />
point-x="200" point-y="150" type="flow-node"/><br />
<GVNodeCheck class="it.greenvulcano.gvesb.core.flow.GVNodeCheck"<br />
default-id="return_status" id="check_status"<br />
input="output_JMSEnqueueTo::TOUPPER_A_Req"<br />
on-exception-id="return_error" op-type="check"<br />
point-x="350" point-y="150" type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_status" op-type="end"<br />
output="output_JMSEnqueueTo::TOUPPER_A_Req"<br />
point-x="700" point-y="150" type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_error" op-type="end"<br />
output="output_JMSEnqueueTo::TOUPPER_A_Req"<br />
point-x="350" point-y="300" type="flow-node"/><br />
</Flow><br />
</Operation><br />
<Operation name="GetReply" operation-activation="on"<br />
out-check-type="sys-svc-tid" type="operation"><br />
<Description>VulCon generated Operation</Description><br />
<Participant id-channel="TEST_CHANNEL_A" id-system="GVESB_TEST"/><br />
<Flow first-node="request" point-x="50" point-y="150"><br />
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"<br />
id="request" id-system="GVESB_TEST"<br />
input="input_JMSDequeueTo::TOUPPER_A_Resp"<br />
next-node-id="check_status" op-type="dequeue"<br />
operation-name="JMSDequeueTo::TOUPPER_A_Resp"<br />
output="output_JMSDequeueTo::TOUPPER_A_Resp"<br />
point-x="200" point-y="150" type="flow-node"><br />
<DequeueFilter><br />
<IDFilter enabled="yes" name="IDFilter" type="filter"<br />
use-input="yes"/><br />
</DequeueFilter><br />
</GVOperationNode><br />
<GVNodeCheck class="it.greenvulcano.gvesb.core.flow.GVNodeCheck"<br />
default-id="return_status" id="check_status"<br />
input="output_JMSDequeueTo::TOUPPER_A_Resp" <br />
on-exception-id="return_error" op-type="check"<br />
point-x="350" point-y="150" type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_status" op-type="end" output="output_null"<br />
point-x="700" point-y="150" type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_error" op-type="end"<br />
output="output_JMSDequeueTo::TOUPPER_A_Resp"<br />
point-x="350" point-y="300" type="flow-node"/><br />
</Flow><br />
</Operation><br />
<Operation forward-name="FWD_TOUPPER_A" name="Forward"<br />
operation-activation="on" out-check-type="none"<br />
type="operation"><br />
<Participant id-channel="TEST_CHANNEL_A" id-system="GVESB"/><br />
<Flow first-node="call_server" point-x="20" point-y="150"><br />
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"<br />
id="call_server" id-system="GVESB" input="input"<br />
next-node-id="enqueue_response" op-type="call"<br />
operation-name="toupper_call" output="output"<br />
point-x="147" point-y="148" type="flow-node"/><br />
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"<br />
id="enqueue_response" id-system="GVESB"<br />
input="output" next-node-id="end"<br />
op-type="enqueue"<br />
operation-name="JMSEnqueueTo::TOUPPER_A_Resp"<br />
output="output" point-x="319" point-y="152"<br />
type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
end-business-process="no" id="end" op-type="end"<br />
output="output" point-x="532" point-y="149"<br />
type="flow-node"><br />
<ChangeGVBuffer clear-data="true"/><br />
</GVEndNode><br />
</Flow><br />
</Operation><br />
</Service><br />
</syntaxhighlight><br />
* Into ''System'' element will be added the tag<br />
<syntaxhighlight lang="XML"><br />
<Channel id-channel="TEST_CHANNEL_A"><br />
<jms-enqueue acknowledge-type="auto-acknowledge"<br />
class="it.greenvulcano.gvesb.virtual.j2ee.JMSEnqueueOperation"<br />
connection-factory="java:/XAConnectionFactory"<br />
delivery-mode="persistent"<br />
destination-name="gvesb/jms/queue/TOUPPER_A_Request_Queue"<br />
destination-type="queue"<br />
name="JMSEnqueueTo::TOUPPER_A_Req" priority="4"<br />
ref-dp="WriteString_JMSBytesMessageDataProvider"<br />
transacted="false" type="enqueue"><br />
<XAHelper auto-enlist="false" transaction-status="TMSUCCESS"/><br />
</jms-enqueue><br />
<jms-enqueue acknowledge-type="auto-acknowledge"<br />
class="it.greenvulcano.gvesb.virtual.j2ee.JMSEnqueueOperation"<br />
connection-factory="java:/XAConnectionFactory"<br />
delivery-mode="persistent"<br />
destination-name="gvesb/jms/queue/TOUPPER_A_Response_Queue"<br />
destination-type="queue"<br />
name="JMSEnqueueTo::TOUPPER_A_Resp" priority="4"<br />
transacted="false" type="enqueue"><br />
<XAHelper auto-enlist="false" transaction-status="TMSUCCESS"/><br />
</jms-enqueue><br />
<jms-dequeue acknowledge-type="auto-acknowledge"<br />
class="it.greenvulcano.gvesb.virtual.j2ee.JMSDequeueOperation"<br />
connection-factory="java:/XAConnectionFactory"<br />
destination-name="gvesb/jms/queue/TOUPPER_A_Response_Queue"<br />
destination-type="queue"<br />
name="JMSDequeueTo::TOUPPER_A_Resp"<br />
receive-timeout-overridable="false"<br />
receive-type="timeout" transacted="false" type="dequeue"><br />
<XAHelper auto-enlist="false" transaction-status="TMSUCCESS"/><br />
</jms-dequeue><br />
<test-service-call class="it.greenvulcano.gvesb.virtual.internal.TestServiceCall"<br />
name="toupper_call" service="toupper" type="call"/><br />
</Channel><br />
</syntaxhighlight><br />
<br />
Now you are able to test your first {{VULCON}} service from the {{L_GVCONSOLE}}. But first you need to export the configuration.<br />
<br />
[[File:GVExamplesTOUPPER5.jpg|thumb|Exporting configuration]]Once the flow is correctly configured, the user can export the configuration and pass it to the {{GVESB}} import tool, in order to add into the {{GVESB}} the service just created.<br />
<br />
# The Export function is available in the view "Project". Expand the project<br />
# Before you proceed press F5 to refresh the file list.<br />
# Right click the ''conf'' folder. It will open a drop-down list. <br />
# Export your project as a compressed file.<br />
<br />
===Testing with {{GVCONSOLE}}===<br />
<br />
It is finally the time to test your project. To do that execute the following steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} project as <nowiki>"${{gv.app.home}}/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Browse and select the file where you saved the {{VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service TOUPPER_A a new view will be showed containing the files GVCore.xml present in local and on server side.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. By saving you will return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and GVAdapter.xml, then Reload. A new windows will be open to confirm the operation<br />
# Click OK.<br />
<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{GVCONSOLE}} section [[Testing]]. In this section you can finally test your new service. Remember that Service TOUPPER_A is composed by three independent Operations:<br />
<br />
'''Request'''<br />
# Into the Service field select TOUPPER_A<br />
# Into the System field select GVESB_TEST<br />
# Into the Payload area insert the text to convert in uppercase<br />
# Click Request<br />
<br />
The '''FWD_TOUPPER_A''' is executed by {{GVESB}} [[GVForwards|JMS Forward]].<br />
<br />
'''getReply'''<br />
# Clear the Payload area<br />
# Click getReply<br />
<br />
When each test completes, the Testing view will be expanded for containing the GVBUFFER OUTPUT. In this case no properties have been defined so there are only be presents the main informations about the process (System, Service, Id, etc.). To view the service payload output click on ''Show as Text'' button. Standard fields and the detailed GVBuffer are described in the [[Testing#Data_input|Output File Name]] (the default location is <nowiki>$GV_HOME</nowiki>/log/TestOutput.txt). <br />
<br />
In case of error or exceptions you can review the logs file present in the folder <nowiki>$GV_HOME</nowiki>/log/.</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_TOUPPER&diff=4222GVExample TOUPPER2014-05-28T15:28:40Z<p>D.franco: /* Testing with {{GVCONSOLE}} */</p>
<hr />
<div>==Description==<br />
<br />
This example shows a simple [[Paradigms_of_communication|synchronous service]] and its configuration.<br />
The service accepts a string as input, then returns it converted to uppercase.<br />
<br />
==How To==<br />
<br />
[[File:NewVulconProject.jpg|thumb| New Vulcon Project]]As this might be our first example, the first step will be the creation of a new {{VULCON}} Project.<br />
# From the Menu panel of Eclipse click File -> New -> Project. A new windows will be open containing the projects type.<br />
# Select Vulcon -> "New Vulcon Project" item. Then click Next<br />
# Set the project name and Location. We named the project GVEXAMPLE and choose a Location of your choice. Then click finish. The new {{VULCON}} project GVEXAMPLE has been created.<br />
<br />
<br />
The preferred mode for creating a [[Service]] (at least its skeleton) is through the Service Wizard. Before using it you must first configure the test VCL plugin tho execute the uppercase conversion. So let's define a new [[Group]], [[System]] and [[Channel]], if you do not want to use those already present, and then start the Wizard.<br />
<br />
From the core view:<br />
# Right click the element Groups -> Insert after (or Insert before) -> Group. A new element Group will be created. <br />
# Click on the Group new element and set the attribute ''id-group'' from the Properties View. We named it TEST_GROUP.<br />
# Expand the GVSystems item.<br />
# Right clicking on Systems, insert-after -> System. A new element System will be created.<br />
# Set the [[System]] parameters in the [[VulCon_perspective|Properties panel]]. We named it GVESB_TEST<br />
# 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<br />
# Click on this new Channel element and set the property ''id_channel''. We named it TEST_CHANNEL<br />
# Finally, insert the operation you need for the workflow. In this case a ''test-service-call''. Right clicking Channel -> Insert after -> [[test-service-call]]. A new element ''test-service-call'' will be created.<br />
# Set the [[test-service-call]] attributes. From the properties view set the ''name'' attribute as ''test'' and the ''service'' attribute as ''toupper''.<br />
<br />
[[File:NewServiceWizard.jpg|thumb|New {{GVESB}} Service Wizard]]Now we are able to use the Wizard.<br />
# From the Core View of {{VULCON}}. Right click the element Services -> Wizard New Service<br />
# 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 TOUPPER, and as Group, we use TEST_GROUP. You can also select the communication paradigm, for this example it will be [[Paradigms_of_communication#synchronous-synchronous|synchronous-synchronous]]. Click next.<br />
# Set System as GVESB_TEST and Channel as TEST_CHANNEL. Then choose the Operation, in this case ''test''. Then finish.<br />
<br />
<br />
[[File:TOUPPEREditor.jpg |thumb |TOUPPER flow]]As you can see from the core view, inside the Services element, a new Service named TOUPPER has been created. The editor will be opened automatically, showing the nodes involved in our [[Flow]].<br />
* The [[Main_nodes|Start node]] sets the flow first node. In this case ''request''<br />
* The [[Operations |Operation node]] ''request'' calls the ''test-service-call'' operation '''test''' and executes it.<br />
* A [[Main_nodes|Check node]] named ''check_status'' is also inserted for controlling the success of the preceding node.<br />
* If ''success'' flow passes to the [[Main_nodes|End node]] ''return_status''<br />
* In case of Error, flow goes to the [[Main_nodes|End node]] ''return_error''. The difference with ''return_status'' is signed by the [[Palette|Connection]] with ''check_status'' Check node. In this case an [[Palette|Error Connection]] (the Red arrow) have been used. <br />
* Save clicking the ''Save'' icon from the Core View<br />
<br />
The GVCore.xml configuration file will be changed as follows:<br />
* Into ''Groups'' element will be added the tag<br />
<syntaxhighlight lang="XML"><br />
<Group group-activation="on" id-group="TEST_GROUP"/><br />
</syntaxhighlight><br />
* Into ''Services'' element will be added the tag<br />
<syntaxhighlight lang="XML"><br />
<Service group-name="TEST_GROUP" id-service="TOUPPER" service-activation="on"<br />
statistics="off"><br />
<Operation name="RequestReply" operation-activation="on"<br />
out-check-type="sys-svc-tid" type="operation"><br />
<Description>VulCon generated Operation</Description><br />
<Participant id-channel="TEST_CHANNEL" id-system="GVESB_TEST"/><br />
<Flow first-node="request" point-x="50" point-y="150"><br />
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"<br />
id="request" id-system="GVESB_TEST"<br />
input="input_test" next-node-id="check_status"<br />
op-type="call" operation-name="test"<br />
output="output_test" point-x="200" point-y="150"<br />
type="flow-node"/><br />
<GVNodeCheck class="it.greenvulcano.gvesb.core.flow.GVNodeCheck"<br />
default-id="return_status" id="check_status"<br />
input="output_test" on-exception-id="return_error"<br />
op-type="check" point-x="350" point-y="150"<br />
type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_status" op-type="end" output="output_test"<br />
point-x="700" point-y="50" type="flow-node"/><br />
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"<br />
id="return_error" op-type="end" output="output_test"<br />
point-x="700" point-y="250" type="flow-node"/><br />
</Flow><br />
</Operation><br />
</Service><br />
</syntaxhighlight><br />
* Into ''Systems'' element will be added the tag<br />
<syntaxhighlight lang="XML"><br />
<System id-system="GVESB_TEST" system-activation="on"><br />
<Channel id-channel="TEST_CHANNEL"><br />
<test-service-call class="it.greenvulcano.gvesb.virtual.internal.TestServiceCall"<br />
name="test" service="toupper" type="call"/><br />
</Channel><br />
</System><br />
</syntaxhighlight><br />
<br />
Now you are able to test your first {{VULCON}} Service from the {{L_GVCONSOLE}}. But first you need to export the configuration.<br />
<br />
[[File:GVExamplesTOUPPER5.jpg|thumb|Exporting configuration]]Once the flow is correctly configured, the user can export the configuration and pass it to the {{GVESB}} import tool, in order to add into the {{GVESB}} the service just created.<br />
# The Export function is available in the view "Project". Expand the project<br />
# Before you proceed press F5 to refresh the file list.<br />
# Right click the ''conf'' folder. It will open a drop-down list. <br />
# Export your project as a VulCon project file (.zip).<br />
<br />
===Testing with {{GVCONSOLE}}===<br />
<br />
It is finally the time to test your project. To do that execute the following steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} project as <nowiki>REPG1.zip</nowiki>. To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Browse and select the file where you saved the {{VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service TOUPPER a new view will be showed containing the file ''GVCore.xml'' present in local and on server side.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. By saving you will return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and then Reload. A new windows will be open to confirm the operation<br />
# Click OK.<br />
<br />
[[File:GVConsoleTesting.jpg|thumb|{{GVCONSOLE}} Testing section]]Go to the {{GVCONSOLE}} section [[Testing]]. In this section you can finally test your new service:<br />
# Into the Service field select TOUPPER<br />
# Into the System field select GVESB_TEST (Optional)<br />
# Into the Payload area insert the text to convert in uppercase<br />
# Click RequestReply<br />
<br />
When the service completes, the Testing view will be expanded for containing the GVBUFFER OUTPUT. In this case no properties have been defined, so only the main information about the process is present (System, Service, Id, etc.). To view the service payload output click on ''Show as Text'' button. Standard fields and the detailed GVBuffer are described in the [[Testing#Data_input|Output File Name]] (the default location is <nowiki>$GV_HOME</nowiki>/log/TestOutput.txt). <br />
<br />
In case of error or exceptions you can review the logs file present in the folder <nowiki>$GV_HOME</nowiki>/log/.</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVExample_TestProperty&diff=4221GVExample TestProperty2014-05-28T13:46:16Z<p>D.franco: /* {{VULCON}} Configuration */</p>
<hr />
<div>==Description==<br />
<br />
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. <br />
<br />
<br />
For more information about metadata (or placeholders) click [[Placeholders|here]].<br />
<br />
=={{VULCON}} Configuration==<br />
<br />
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.<br />
<br />
From the core view:<br />
# Right click the element Groups -> Insert after (or Insert before) -> Group. A new element Group will be created. <br />
# Click on the Group new element and set the attribute ''id-group'' from the Properties View. We named it TEST_GROUP.<br />
# Expand the GVSystems item.<br />
# Right clicking on Systems, insert-after -> System. A new element System will be created.<br />
# Set the [[System]] parameters in the [[VulCon_perspective|Properties panel]]. We named it GVESB_TEST<br />
# 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<br />
# Click on this new Channel element and set the property ''id_channel''. We named it TEST_CHANNEL.<br />
<br />
Create a new service:<br />
# From the Core View of {{VULCON}}, right click the element Services -> Insert After (Insert Before) -> Service*<br />
# Set the Service properties: id-service as TestProperty, and group-name as TEST_GROUP.<br />
# Add into the Service TestProperty just created a new Operation: right click the element Service -> Insert After -> Operation*<br />
# Set the Operation property name as Request<br />
# Create a Participant: right click the element Operation -> Insert After (Insert Before) -> Participant*<br />
# Set the parameters id-system as GVESB_TEST and id-channel as TEST_CHANNEL.<br />
<br />
[[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. <br />
<br />
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:<br />
# Add a [[Main_nodes|ChangeGVBuffer Node]]: <br />
## 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<br />
##* id: test_property<br />
##* input: data<br />
## 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<br />
##* id: end<br />
# Create the connections: <br />
## From the Palette click into the Default Connection (black arrow)<br />
## 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. <br />
## Create another Default Connection between ''test_property'' ChangeGVBuffer Node and ''end'' node.<br />
# 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]].<br />
<br />
The flow is already created. Refresh the Core view in the apposite icon. Check from that the workflow elements will be configured as follow: <br />
<br />
:Service: group-name="TEST_GROUP", id-service="TestProperty", service-activation="on", statistics="off"<br />
:Operation: name="Request", operation-activation="on"<br />
:Participant: id-channel="TEST_CHANNEL", id-system="GVESB_TEST"<br />
<br />
The following table shows the parameters to be defined for nodes and sub-elements added:<br />
{|class="gvtable"<br />
! Node !! Attribute<br />
|-<br />
| [[ChangeGVBufferNode]] || id="set_properties" <br/>input="input"<br/> next-node-id="return_status"<br/>output="output"<br />
|-<br />
| ChangeGVBufferNode/ChangeGVBuffer || clear-data="false"<br />
|-<br />
| ChangeGVBufferNode/ChangeGVBuffer/PropertyDef || name="SQL" <br/>value="<nowiki>sql{{ds.gv_test::select 'OK' from dual}}</nowiki>"<br />
|-<br />
| GVEndNode || id="return_status" <br/> output="output"<br />
|} <br />
<br />
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:<br />
{|class="gvtable"<br />
! PropertyDef name !! value<br />
|-<br />
| SQL || <nowiki>sql{{ds.gv_test::select 'OK' from dual}}</nowiki><br />
|-<br />
| SQLLIST || <nowiki>[sqllist{{ds.gv_test::select name from city order by 1}}]</nowiki><br />
|-<br />
| TIMESTAMP || <nowiki>timestamp{{yyyyMMdd HH:mm:ss}}</nowiki><br />
|-<br />
| OGNL || Service: <nowiki>ognl{{#object.getService()}}</nowiki><br />
|-<br />
| JAVASCRIPT || System: <nowiki>js{{gvesb::object.getSystem()}}</nowiki><br />
|-<br />
| SYSTEM || Server Name: <nowiki>${{jboss.server.name}}</nowiki><br />
|-<br />
| CLASS || <nowiki>%{{fqclass}}</nowiki><br />
|-<br />
| DECODE || <nowiki>decode{{ognl{{#object.getProperty('SQL')}}::OK::Sql OK::Sql KO}}</nowiki><br />
|-<br />
| MINUTE || Minute <nowiki>decode{{js{{gvesb::timestamp{{mm}} % 2 == 0}}::true::EVEN::ODD}}</nowiki><br />
|}<br />
<br />
[[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.<br />
# Review all the properties just configured <br />
# Save your changes using the Save icon present in the [[The_views|Core View]].<br />
<br />
[[File:GVExamplesTOUPPER5.jpg|thumb|Exporting configuration]]Once the flow is correctly configured, you can export the configuration and pass it to the {{GVESB}} import tool, in order to add into {{GVESB}} the service just created.<br />
# The Export function is available in the view "Project". Expand your project<br />
# Before you proceed, press F5 to refresh the file list.<br />
# Right click the ''conf'' folder. It will open a drop-down list. <br />
# Export your project as a compressed file.<br />
<br />
===Testing with {{GVCONSOLE}}===<br />
<br />
It is finally the time to test your project. To do that execute the following steps:<br />
<br />
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]To deploy the new Service follow this steps:<br />
# [[Starting|Start {{GVESB}}]]<br />
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]]. <br />
# In the Deploy New Service section click Browse and select the file where you saved the {{VULCON}} configuration.<br />
# Click Submit.<br />
<br />
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.<br />
# Clicking on service TestProperty a new view will be showed containing the file ''GVCore.xml'' present in local and on server side.<br />
# Click Deploy. Now you can save the document and write some notes about it.<br />
# Save the Document. By saving you will return to the [[Deploy Service]] section.<br />
<br />
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{GVCONSOLE}} section [[Utility]]. <br />
# Click on [[Reload_Configuration|Reload configuration]]<br />
# Select GVCore.xml and then Reload. A new windows will be open to confirm the operation<br />
# Click OK.<br />
<br />
[[File:GVExamples_TestPropertyOutput.jpg|thumb|Testing TestProperty]]Go to the {{GVCONSOLE}} section [[Testing]]. In this section you can finally test your new service:<br />
# Into the Service field select TestProperty<br />
# Into the System field select GVESB_TEST (Optional)<br />
# Click Request<br />
<br />
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 [[Testing#Data_input|Output File Name]] (the default location is <nowiki>$GV_HOME</nowiki>/log/TestOutput.txt). <br />
<br />
In case of error or exceptions you can review the logs file present in the folder <nowiki>$GV_HOME</nowiki>/log/.</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=Rest-call&diff=4102Rest-call2013-08-01T13:25:30Z<p>D.franco: </p>
<hr />
<div><div class="version_ge3.4"><br />
==Description==<br />
<br />
The {{GVESB}} plugin '''rest-call''' defines the parameters for calling a Web Service using REST mode.<br />
<br />
=={{VULCON}} / {{GVCONSOLE}} Configuration==<br />
<br />
The rest-call Element is used by [[Channel]] and [[routed-call]]. Its attributes are:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''call'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.ws.rest.RestCallOperation'''.<br />
|-<br />
| name || required || Operation name. Used in the [[Flow]] section to associate workflow nodes to VCL operations.<br />
|}<br />
<br />
and its subelements:<br />
* [[Description]]<br />
* [[rest-call#RestServiceInvoker|RestServiceInvoker]]<br />
* [[Proxy]]<br />
<br />
===RestServiceInvoker===<br />
<br />
This element is used by [[rest-call]].<br />
<br />
Its attributes are:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''invoker'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.ws.rest.RestServiceInvoker'''.<br />
|-<br />
| endpoint || required || Endpoint exposed by the Rest Web Service to invoke. Can contain placeholders. It must be already escaped, if needed.<br />
|-<br />
| method || required || HTTP method to execute to the server.<br />
The attribute's admitted values are:<br />
* GET<br />
* POST<br />
* PUT<br />
* DELETE<br />
* HEAD<br />
* OPTIONS<br />
|-<br />
| timeout || optional || Timeout in seconds.<br />
|-<br />
| ref-dp || optional || Name of [[Data_provider|Data Provider]] to use for preparing the request.<br />
|-<br />
| throwsFault || optional || If ''true'' throws Exception "Error invoking operation". If ''false'' returns the Fault response. Default to false.<br />
The attribute's admitted values are:<br />
* true<br />
* false<br />
|-<br />
| returnType || optional || Defines how to set the response data in the object field of output [[GVBuffer]]:<br />
* context : the MessageContext<br />
* envelope : the envelope as XML serialized as string<br />
* body : the body as XML serialized as string<br />
* body-element : the first child of body as XML serialized as string<br />
* header : the header as XML serialized as string<br />
* envelope-om : the envelope as OMMessage<br />
* body-om : the body as OMMessage<br />
* body-element-om : the first child of body as OMMessage<br />
* header-om : the header as OMMessage<br />
Default: context<br />
|-<br />
| mediaType || optional || This is used to specify the message format which the message needs to be serialized. See 'messageFormatters' configuration in axis2.xml file. Default value is: 'application/x-www-form-urlencoded'<br />
|-<br />
| contentType || optional || This is used to specify the message builder which the message needs to be serialized. See 'messageBuilders' configuration in axis2.xml file. Defaults to the value specified in 'mediaType' attribute.<br />
|-<br />
| responseMode || optional || This is used to specify if invoked service returns a response (OUT_IN) or not (OUT_ONLY). Default value is: OUT_IN<br />
|}<br />
<br />
and has the sub-element:<br />
* [[Description]]<br />
</div></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=Rest-call&diff=4101Rest-call2013-08-01T13:24:10Z<p>D.franco: </p>
<hr />
<div><div class="version_ge3.4"><br />
==Description==<br />
<br />
The {{GVESB}} plugin '''rest-call''' defines the parameters for calling a Web Service using REST mode.<br />
<br />
=={{VULCON}} / {{GVCONSOLE}} Configuration==<br />
<br />
The rest-call Element is used by [[Channel]] and [[routed-call]]. Its attributes are:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''call'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.ws.rest.RestCallOperation'''.<br />
|-<br />
| name || required || Operation name. Used in the [[Flow]] section to associate workflow nodes to VCL operations.<br />
|}<br />
<br />
and its subelements:<br />
* [[Description]]<br />
* [[rest-call#RestServiceInvoker|RestServiceInvoker]]<br />
* [[Proxy]]<br />
<br />
===RestServiceInvoker===<br />
<br />
This element is used by [[ws-call]].<br />
<br />
Its attributes are:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''invoker'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.ws.rest.RestServiceInvoker'''.<br />
|-<br />
| endpoint || required || Endpoint exposed by the Rest Web Service to invoke. Can contain placeholders. It must be already escaped, if needed.<br />
|-<br />
| method || required || HTTP method to execute to the server.<br />
The attribute's admitted values are:<br />
* GET<br />
* POST<br />
* PUT<br />
* DELETE<br />
* HEAD<br />
* OPTIONS<br />
|-<br />
| timeout || optional || Timeout in seconds.<br />
|-<br />
| ref-dp || optional || Name of [[Data_provider|Data Provider]] to use for preparing the request.<br />
|-<br />
| throwsFault || optional || If ''true'' throws Exception "Error invoking operation". If ''false'' returns the Fault response. Default to false.<br />
The attribute's admitted values are:<br />
* true<br />
* false<br />
|-<br />
| returnType || optional || Defines how to set the response data in the object field of output [[GVBuffer]]:<br />
* context : the MessageContext<br />
* envelope : the envelope as XML serialized as string<br />
* body : the body as XML serialized as string<br />
* body-element : the first child of body as XML serialized as string<br />
* header : the header as XML serialized as string<br />
* envelope-om : the envelope as OMMessage<br />
* body-om : the body as OMMessage<br />
* body-element-om : the first child of body as OMMessage<br />
* header-om : the header as OMMessage<br />
Default: context<br />
|-<br />
| mediaType || optional || This is used to specify the message format which the message needs to be serialized. See 'messageFormatters' configuration in axis2.xml file. Default value is: 'application/x-www-form-urlencoded'<br />
|-<br />
| contentType || optional || This is used to specify the message builder which the message needs to be serialized. See 'messageBuilders' configuration in axis2.xml file. Defaults to the value specified in 'mediaType' attribute.<br />
|-<br />
| responseMode || optional || This is used to specify if invoked service returns a response (OUT_IN) or not (OUT_ONLY). Default value is: OUT_IN<br />
|}<br />
<br />
and has the sub-element:<br />
* [[Description]]<br />
</div></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=Rest-call&diff=4100Rest-call2013-07-31T13:46:35Z<p>D.franco: </p>
<hr />
<div><div class="version_ge3.4"><br />
==Description==<br />
<br />
The {{GVESB}} plugin '''ws-call''' defines the parameters for calling a Web Service using REST mode.<br />
<br />
=={{VULCON}} / {{GVCONSOLE}} Configuration==<br />
<br />
The rest-call Element is used by [[Channel]] and [[routed-call]]. Its attributes are:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''call'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.ws.rest.RestCallOperation'''.<br />
|-<br />
| name || required || Operation name. Used in the [[Flow]] section to associate workflow nodes to VCL operations.<br />
|}<br />
<br />
and its subelements:<br />
* [[Description]]<br />
* [[rest-call#RestServiceInvoker|RestServiceInvoker]]<br />
* [[Proxy]]<br />
<br />
===RestServiceInvoker===<br />
<br />
This element is used by [[ws-call]].<br />
<br />
Its attributes are:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''invoker'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.ws.rest.RestServiceInvoker'''.<br />
|-<br />
| endpoint || required || Endpoint exposed by the Rest Web Service to invoke. Can contain placeholders. It must be already escaped, if needed.<br />
|-<br />
| method || required || HTTP method to execute to the server.<br />
The attribute's admitted values are:<br />
* GET<br />
* POST<br />
* PUT<br />
* DELETE<br />
* HEAD<br />
* OPTIONS<br />
|-<br />
| timeout || optional || Timeout in seconds.<br />
|-<br />
| ref-dp || optional || Name of [[Data_provider|Data Provider]] to use for preparing the request.<br />
|-<br />
| throwsFault || optional || If ''true'' throws Exception "Error invoking operation". If ''false'' returns the Fault response. Default to false.<br />
The attribute's admitted values are:<br />
* true<br />
* false<br />
|-<br />
| returnType || optional || Defines how to set the response data in the object field of output [[GVBuffer]]:<br />
* context : the MessageContext<br />
* envelope : the envelope as XML serialized as string<br />
* body : the body as XML serialized as string<br />
* body-element : the first child of body as XML serialized as string<br />
* header : the header as XML serialized as string<br />
* envelope-om : the envelope as OMMessage<br />
* body-om : the body as OMMessage<br />
* body-element-om : the first child of body as OMMessage<br />
* header-om : the header as OMMessage<br />
Default: context<br />
|-<br />
| mediaType || optional || This is used to specify the message format which the message needs to be serialized. See 'messageFormatters' configuration in axis2.xml file. Default value is: 'application/x-www-form-urlencoded'<br />
|-<br />
| contentType || optional || This is used to specify the message builder which the message needs to be serialized. See 'messageBuilders' configuration in axis2.xml file. Defaults to the value specified in 'mediaType' attribute.<br />
|-<br />
| responseMode || optional || This is used to specify if invoked service returns a response (OUT_IN) or not (OUT_ONLY). Default value is: OUT_IN<br />
|}<br />
<br />
and has the sub-element:<br />
* [[Description]]<br />
</div></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=Rest-call&diff=4099Rest-call2013-07-31T13:18:39Z<p>D.franco: </p>
<hr />
<div>==Description==<br />
<br />
<div class="version_ge3.4"><br />
The {{GVESB}} plugin '''ws-call''' defines the parameters for calling a Web Service using REST mode.<br />
</div><br />
<br />
=={{VULCON}} / {{GVCONSOLE}} Configuration==<br />
<br />
The rest-call Element is used by [[Channel]] and [[routed-call]]. Its attributes are:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''call'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.ws.rest.RestCallOperation'''.<br />
|-<br />
| name || required || Operation name. Used in the [[Flow]] section to associate workflow nodes to VCL operations.<br />
|}<br />
<br />
and its subelements:<br />
* [[Description]]<br />
* [[rest-call#RestServiceInvoker|RestServiceInvoker]]<br />
* [[Proxy]]<br />
<br />
===RestServiceInvoker===<br />
<br />
This element is used by [[ws-call]].<br />
<br />
Its attributes are:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''invoker'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.ws.rest.RestServiceInvoker'''.<br />
|-<br />
| endpoint || required || Endpoint exposed by the Rest Web Service to invoke. Can contain placeholders. It must be already escaped, if needed.<br />
|-<br />
| method || required || HTTP method to execute to the server.<br />
The attribute's admitted values are:<br />
* GET<br />
* POST<br />
* PUT<br />
* DELETE<br />
* HEAD<br />
* OPTIONS<br />
|-<br />
| timeout || optional || Timeout in seconds.<br />
|-<br />
| ref-dp || optional || Name of [[Data_provider|Data Provider]] to use for preparing the request.<br />
|-<br />
| throwsFault || optional || If ''true'' throws Exception "Error invoking operation". If ''false'' returns the Fault response. Default to false.<br />
The attribute's admitted values are:<br />
* true<br />
* false<br />
|-<br />
| use-saaj || optional || Defines whether to use SAAJ to invoke the WebService mode instead of the default Axis2 mode. <br/> NOTE: If you choose to use SAAJ as a way of calling the WebService, Axis2 modules are not enabled. <br/> The attribute's admitted values are:<br />
* true<br />
* false<br />
|-<br />
| returnType || optional || Defines how to set the response data in the object field of output [[GVBuffer]]:<br />
* context : the MessageContext<br />
* envelope : the envelope as XML serialized as string<br />
* body : the body as XML serialized as string<br />
* body-element : the first child of body as XML serialized as string<br />
* header : the header as XML serialized as string<br />
* envelope-om : the envelope as OMMessage<br />
* body-om : the body as OMMessage<br />
* body-element-om : the first child of body as OMMessage<br />
* header-om : the header as OMMessage<br />
Default: context<br />
|-<br />
| mediaType || optional || This is used to specify the message format which the message needs to be serialized. See 'messageFormatters' configuration in axis2.xml file. Default value is: 'application/x-www-form-urlencoded'<br />
|-<br />
| contentType || optional || This is used to specify the message builder which the message needs to be serialized. See 'messageBuilders' configuration in axis2.xml file. Defaults to the value specified in 'mediaType' attribute.<br />
|-<br />
| responseMode || optional || This is used to specify if invoked service returns a response (OUT_IN) or not (OUT_ONLY). Default value is: OUT_IN<br />
|}<br />
<br />
and has the sub-element:<br />
* [[Description]]</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=Description&diff=4098Description2013-07-31T13:11:24Z<p>D.franco: </p>
<hr />
<div>[[File:Description.jpg|thumb|Groups section Description]]<br />
Each element of the configuration provides a field '''Description''' optional that might contain free text available to the user.<br />
<br />
This field can be used for notes and information that help users in configuration management and by the application {{L_GVCONSOLE}} to enrich the reports relating to the configuration.<br />
<br />
The Description is always optional, but if used can not be empty. The element value cannot be null.<br />
<br />
The Description Element is used by: [[JNDIHelper|Advanced]], [[ServiceAlias#AliasMapping|AliasMapping]], [[Smtp-call#attachments|attachments]], [[GVWebServices#AxisExtra|AxisExtra]], [[Ws-call#AxisWebServiceInvoker|AxisWebServiceInvoker]], [[rest-call#RestServiceInvoker|RestServiceInvoker]], [[Smtp-call#destinations|bcc]], [[GVWebServices#Binding|Binding]], [[birt-report-call]], [[Base64Transformation]], [[GVServices#BpelEngineConfiguration|BpelEngineConfiguration]], [[BpelOperation#BpelFlow|BpelFlow]], [[BpelOperation]], [[GVWebServices#BusinessWebServices|BusinessWebServices]], [[GVConnectorConfiguration#Call|Call]], [[CallDescriptor]], [[Generic-call#call-parameter|call-parameter]], [[CallSPFormatter]], [[CallSPBaseFormatter|CallSPSimpleBaseFormatter]], [[Smtp-call#destinations|cc]], [[ChangeGVBuffer]], [[GVConnectorConfiguration#Channels|Channels]], [[GVConnectorConfiguration#ComplexExtension|ComplexExtension]], [[GVConnectorConfiguration#CompressExtension|CompressExtension]], [[GVJdbc#Connection|Connection]], [[GVWebServices#connectionProperty|connectionFactory]], [[GVWebServices#connectionProperty|connectionProperty]], [[GVJdbc#Connections|Connections]], [[GVConnectorConfiguration#ConnectorService|ConnectorService]], [[GVConnectorConfiguration#ConnectorServices|ConnectorServices]], [[Http-call#constructor-args|constructor-args]], [[Http-call#constructor-param|constructor-param]], [[Http-call#CustomProtocol|CustomProtocol]], [[DBOperations#DataSourceConnection|DataSourceConnection]], [[GVJDBCConnectionBuilder#DataSourceConnectionBuilder|DataSourceConnectionBuilder]], [[db-call]], [[DBOBuilder]], [[DBOCallSP]], [[DBOInsert]], [[DBOInsertOrUpdate]], [[DBOperations]], [[DBOSelect]], [[DBOThreadSelect]], [[DBOUpdate]], [[DBOUpdateOrInsert]], [[GVConnectorConfiguration#DecompressExtension|DecompressExtension]], [[GVConnectorConfiguration#DecryptExtension|DecryptExtension]], [[Smtp-call#destinations|destinations]], [[DBOBuilder|DHAlias]], [[DBOBuilder|DHAliasList]], [[dh-call]], [[DHVariables#DHVariable|DHVariable]], [[DMLWriteFormatter]], [[GVJdbc#Driver|Driver]], [[GVJDBCConnectionBuilder#DriverConnectionBuilder|DriverConnectionBuilder]], [[GVJDBCConnectionBuilder#DriverPoolConnectionBuilder|DriverPoolConnectionBuilder]], [[GVJdbc#Drivers|Drivers]], [[GVConnectorConfiguration#DTEExtension|DTEExtension]], [[GVConnectorConfiguration#EncryptExtension|EncryptExtension]], [[Http-call#endpoint|endpoint]], [[GVWebServices#EngageModule|EngageModule]], [[GVBIRTReportConfiguration#Engine|Engine]], [[ShellCommands#env-property]], [[excel-call]], [[excelreader-call]], [[GVBIRTReportConfiguration#ExcelReportRender|ExcelReportRender]], [[JNDIHelper|Extended]], [[GVConnectorConfiguration#Extension|Extension]], [[GVConnectorConfiguration#Extensions|Extensions]], [[GVConnectorConfiguration#External-Component|External-Component]], [[GVConnectorConfiguration#ExternalComponents|ExternalComponents]], [[GVConnectorConfiguration#External-Params|External-Params]], [[Extract-data-call#extract-data|extract-data]], [[extract-data-call]], [[FieldFormatters#FieldFormatter|FieldFormatter]], [[FieldFormatters]], [[Smtp-call#file-attachment|file-attachment]], [[Filemanager-call#FileCopyCommand|FileCopyCommand]], [[Filemanager-call#FileDeleteCommand|FileDeleteCommand]], [[Fsmonitor-call#FileFilter|FileFilter]], [[filemanager-call]], [[Fsmonitor-call#FileMonitorStatus|FileMonitorStatus]], [[Filemanager-call#FileMoveCommand|FileMoveCommand]], [[filereader-call]], [[Filemanager-call#FileSearchCommand|FileSearchCommand]], [[Filemanager-call#FileUnZipCommand|FileUnZipCommand]], [[filewriter-call]], [[Filemanager-call#FileZipCommand|FileZipCommand]], [[GVExcelWorkbookConfiguration#Font|Font]], [[GVExcelWorkbookConfiguration#Format|Format]], [[fsmonitor-call]], [[FTPManager]], [[generic-call]], [[GenericRetriever]], [[GVConnectorConfiguration#GenericTransaction|GenericTransaction]], [[GVConnectorConfiguration#GreenVulcanoCoreChannel|GreenVulcanoCoreChannel]], [[GVJbpmTaskListenerManager#GreenVulcanoPool|GreenVulcanoPool]], [[GVWebServices#GreenVulcanoWebService|GreenVulcanoWebService]], [[GVWebServices#GreenVulcanoWebServices|GreenVulcanoWebServices]], [[GVJbpmTaskListenerManager#GroupsJbpm|groupJbpm]], [[GVJbpmTaskListenerManager#GroupsJbpm|GroupsJbpm]], [[GVAdapterOpenSpCoop]], [[GVBIRTReportConfiguration]], [[Smtp-call#gvBuffer|gvBuffer]], [[GVBufferCondition]], [[GVBufferMapping#GVBufferFieldOutput|GVBufferFieldOutput]], [[GVBufferMapping]], [[Statement#GVBufferParam|GVBufferParam]], [[Statement#GVBufferParamResolver|GVBufferParamResolver]], [[GVConnectorConfiguration]], [[GVHL7ListenerManager#GVCoreApplication|GVCoreApplication]], [[gvcore-call]], [[GVDataHandlerConfiguration]], [[GVDataProviderManager]], [[GVExcelCreatorConfiguration]], [[Excel-call#GVExcelReport|GVExcelReport]], [[GVExcelWorkbookConfiguration#GVExcelWorkbook|GVExcelWorkbook]], [[GVExcelWorkbookConfiguration]], [[GVHL7ListenerManager]], [[GVJBPMConfiguration]], [[GVJbpmTaskListenerManager#GVJbpmListeners|GVJbpmListeners]], [[GVJbpmTaskListenerManager]], [[GVJdbc]], [[GVJDBCConnectionBuilder]], [[GVMailServices]], [[GVSQLErrorMapping]], [[GVWebServices]], [[GVHL7ListenerManager#HL7Activation|HL7Activation]], [[hl7-call]], [[GVHL7ListenerManager#HL7Listener|HL7Listener]], [[GVBIRTReportConfiguration#HTMLReportRender|HTMLReportRender]], [[http-call]], [[GVMailServices#imap|imap]], [[Fsmonitor-call#InMemoryMonitorStatus|InMemoryMonitorStatus]], [[jmx-call#invoke-parameter|invoke-parameter]], [[j2ee-ejb-call]], [[j2ee-jca-call]], [[Retriever_Config#JavaScriptRetriever|JavaScriptRetriever]], [[GVWebServices#JAXMLRegistry|JAXMLRegistry]], [[jbpm-call]], [[jbpm-task-call]], [[J2ee-jca-call#jca-connection-spec|jca-connection-spec]], [[J2ee-jca-call#jca-interaction-spec|jca-interaction-spec]], [[DBOperations#JDBCConnection|JdbcConnection]], [[jms-dequeue]], [[jms-enqueue]], [[jmx-call]], [[JNDIHelper]], [[Fsmonitor-call#LocalFileSystemMonitor|LocalFileSystemMonitor]], [[Smtp-call#destinations|mail-address]], [[Smtp-call#mail-message|mail-message]], [[GVMailServices#mail-service|mail-service]], [[Smtp-call#message-body|message-body]], [[GVMailServices#mime|mime]], [[GVWebServices#ModuleProperty|ModuleProperty]], [[openspcoop-call]], [[GVConnectorConfiguration#OperationDetails|OperationDetails]], [[GVBIRTReportConfiguration#Option|Option]], [[GVBIRTReportConfiguration#Options|Options]], [[Statement#Param|Param]], [[parameter]], [[GVBIRTReportConfiguration#Parameter|Parameter]], [[GVBIRTReportConfiguration#Parameters|Parameters]], [[J2ee-jca-call#param-gvbuffer|param-gvbuffer]], [[Jbpm-call#ParamJbpm|ParamJbpm]], [[Statement#ParamResolver|ParamResolver]], [[Jbpm-call|ParamsJbpm]], [[Jbpm-task-call#ParamsTask|ParamsTask]], [[GVWebServices#PasswordCallback|PasswordCallback]], [[GVBIRTReportConfiguration#PDFReportRender|PDFReportRender]], [[GVJDBCConnectionBuilder#PoolParameters|PoolParameters]], [[GVMailServices#pop3|pop3]], [[pop-call]], [[GVWebServices#Properties|Properties]], [[J2ee-jca-call#property|property]], [[GVBufferCondition#Property|Property]], [[GVBufferCondition#PropertyCompare|PropertyCompare]], [[GVSavePointNode#PropertyDef|PropertyDef]], [[GVConnectorConfiguration#Property-Field|Property-Field]], [[Proxy]], [[GVWebServices#PasswordCallback|PwCbBasicHandler]], [[QueryFormatter]], [[QueryFormatter#QueryXMLBaseFormatter|QueryXMLBaseFormatter]], [[GVBufferCondition#RangeDef|RangeDef]], [[Remotemanager-call#RemoteDeleteCommand |RemoteDeleteCommand]], [[Remotemanager-call#RemoteDownloadCommand |RemoteDownloadCommand]], [[Fsmonitor-call#RemoteFileSystemMonitor|RemoteFileSystemMonitor]], [[remotemanager-call]], [[Remotemanager-call#RemoteMoveCommand |RemoteMoveCommand]], [[Remotemanager-call#RemoteSearchCommand |RemoteSearchCommand]], [[Remotemanager-call#RemoteUploadCommand |RemoteUploadCommand]], [[GVBIRTReportConfiguration#Renders|Renders]], [[GVBIRTReportConfiguration#Report|Report]], [[GVBIRTReportConfiguration#ReportGroups|ReportGroup]], [[GVBIRTReportConfiguration#ReportGroups|ReportGroups]], [[ResultSet]], [[GVBufferCondition#RetCodeField|RetCodeField]], [[Retriever_Config|RetrieverConfig]], [[routed-call]], [[routed-dequeue]], [[routed-enqueue]], [[ServiceAlias]], [[GVHTTPAdapter#ServletMappings|ServletMapping]], [[SFTPManager]], [[Excel-call#Sheet|Sheet]], [[GVExcelWorkbookConfiguration#SheetConfig|SheetConfig]], [[shell-call]], [[Simpleformatter]], [[GVMailServices#smtp|smtp]], [[smtp-call]], [[J2ee-jca-call#spec-constructor|spec-constructor]], [[J2ee-jca-call#spec-property|spec-property]], [[SPOutputParams#SPOutputParam|SPOutputParam]], [[SPOutputParams]], [[J2ee-jca-call#string-to-xml|string-to-xml]], [[Retriever_Config#TableRetriever|TableRetriever]], [[GVConnectorConfiguration#TestExtension|TestExtension]], [[test-service-call]], [[Smtp-call#destinations|to]], [[GVHTTPAdapter#Transaction|Transaction]], [[GVConnectorConfiguration#Transactions|Transactions]], [[GVWebServices#UDDI|UDDI]], [[GVWebServices#UserDef|UserDef]], [[GVJbpmTaskListenerManager#UsersJbpm|userJbpm]], [[GVJbpmTaskListenerManager#UsersJbpm|UsersJbpm]], [[GVConnectorConfiguration#UserTransaction|UserTransaction]], [[GVConnectorConfiguration#VCLChannel|VCLChannel]], [[GVConnectorConfiguration#VCLOperation|VCLOperation]], [[VCLRouting]], [[GVWebServices#WebService|WebService]], [[J2ee-ejb-call#WLSSubjectBuilder|WLSSubjectBuilder]], [[ws-call]], [[rest-call]], [[Ws-call#WSDLInfo|WSDLInfo]], [[GVWebServices#WSOperation|WSOperation]], [[XAHelper]], [[J2ee-jca-call#xml-data|xml-data]], [[Filereader-call#xml-processor|xml-processor]], [[Ws-call#XPathNamespace|XPathNamespace]], [[Statement#XPathParamResolver|XPathParamResolver]].</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=Rest-call&diff=4097Rest-call2013-07-31T13:01:00Z<p>D.franco: </p>
<hr />
<div>==Description==<br />
<br />
The {{GVESB}} plugin '''ws-call''' defines the parameters for calling a Web Service using REST mode.<br />
<br />
=={{VULCON}} / {{GVCONSOLE}} Configuration==<br />
<br />
The rest-call Element is used by [[Channel]] and [[routed-call]]. Its attributes are:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''call'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.ws.rest.RestCallOperation'''.<br />
|-<br />
| name || required || Operation name. Used in the [[Flow]] section to associate workflow nodes to VCL operations.<br />
|}<br />
<br />
and its subelements:<br />
* [[Description]]<br />
* [[rest-call#RestServiceInvoker|RestServiceInvoker]]<br />
* [[Proxy]]<br />
<br />
===RestServiceInvoker===<br />
<br />
This element is used by [[ws-call]].<br />
<br />
Its attributes are:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''invoker'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.ws.rest.RestServiceInvoker'''.<br />
|-<br />
| endpoint || required || Endpoint exposed by the Rest Web Service to invoke. Can contain placeholders. It must be already escaped, if needed.<br />
|-<br />
| method || required || HTTP method to execute to the server.<br />
The attribute's admitted values are:<br />
* GET<br />
* POST<br />
* PUT<br />
* DELETE<br />
* HEAD<br />
* OPTIONS<br />
|-<br />
| timeout || optional || Timeout in seconds.<br />
|-<br />
| ref-dp || optional || Name of [[Data_provider|Data Provider]] to use for preparing the request.<br />
|-<br />
| throwsFault || optional || If ''true'' throws Exception "Error invoking operation". If ''false'' returns the Fault response. Default to false.<br />
The attribute's admitted values are:<br />
* true<br />
* false<br />
|-<br />
| use-saaj || optional || Defines whether to use SAAJ to invoke the WebService mode instead of the default Axis2 mode. <br/> NOTE: If you choose to use SAAJ as a way of calling the WebService, Axis2 modules are not enabled. <br/> The attribute's admitted values are:<br />
* true<br />
* false<br />
|-<br />
| returnType || optional || Defines how to set the response data in the object field of output [[GVBuffer]]:<br />
* context : the MessageContext<br />
* envelope : the envelope as XML serialized as string<br />
* body : the body as XML serialized as string<br />
* body-element : the first child of body as XML serialized as string<br />
* header : the header as XML serialized as string<br />
* envelope-om : the envelope as OMMessage<br />
* body-om : the body as OMMessage<br />
* body-element-om : the first child of body as OMMessage<br />
* header-om : the header as OMMessage<br />
Default: context<br />
|-<br />
| mediaType || optional || This is used to specify the message format which the message needs to be serialized. See 'messageFormatters' configuration in axis2.xml file. Default value is: 'application/x-www-form-urlencoded'<br />
|-<br />
| contentType || optional || This is used to specify the message builder which the message needs to be serialized. See 'messageBuilders' configuration in axis2.xml file. Defaults to the value specified in 'mediaType' attribute.<br />
|-<br />
| responseMode || optional || This is used to specify if invoked service returns a response (OUT_IN) or not (OUT_ONLY). Default value is: OUT_IN<br />
|}<br />
<br />
and has the sub-element:<br />
* [[Description]]</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=Rest-call&diff=4096Rest-call2013-07-31T13:00:12Z<p>D.franco: </p>
<hr />
<div>==Description==<br />
<br />
The {{GVESB}} plugin '''ws-call''' defines the parameters for calling a Web Service using REST mode.<br />
<br />
=={{VULCON}} / {{GVCONSOLE}} Configuration==<br />
<br />
The rest-call Element is used by [[Channel]] and [[routed-call]]. Its attributes are:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''call'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.ws.rest.RestCallOperation'''.<br />
|-<br />
| name || required || Operation name. Used in the [[Flow]] section to associate workflow nodes to VCL operations.<br />
|}<br />
<br />
and its subelements:<br />
* [[Description]]<br />
* [[rest-call#RestServiceInvoker|RestServiceInvoker]]<br />
* [[Proxy]]<br />
<br />
==RestServiceInvoker==<br />
<br />
This element is used by [[ws-call]].<br />
<br />
Its attributes are:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''invoker'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.ws.rest.RestServiceInvoker'''.<br />
|-<br />
| endpoint || required || Endpoint exposed by the Rest Web Service to invoke. Can contain placeholders. It must be already escaped, if needed.<br />
|-<br />
| method || required || HTTP method to execute to the server.<br />
The attribute's admitted values are:<br />
* GET<br />
* POST<br />
* PUT<br />
* DELETE<br />
* HEAD<br />
* OPTIONS<br />
|-<br />
| timeout || optional || Timeout in seconds.<br />
|-<br />
| ref-dp || optional || Name of [[Data_provider|Data Provider]] to use for preparing the request.<br />
|-<br />
| throwsFault || optional || If ''true'' throws Exception "Error invoking operation". If ''false'' returns the Fault response. Default to false.<br />
The attribute's admitted values are:<br />
* true<br />
* false<br />
|-<br />
| use-saaj || optional || Defines whether to use SAAJ to invoke the WebService mode instead of the default Axis2 mode. <br/> NOTE: If you choose to use SAAJ as a way of calling the WebService, Axis2 modules are not enabled. <br/> The attribute's admitted values are:<br />
* true<br />
* false<br />
|-<br />
| returnType || optional || Defines how to set the response data in the object field of output [[GVBuffer]]:<br />
* context : the MessageContext<br />
* envelope : the envelope as XML serialized as string<br />
* body : the body as XML serialized as string<br />
* body-element : the first child of body as XML serialized as string<br />
* header : the header as XML serialized as string<br />
* envelope-om : the envelope as OMMessage<br />
* body-om : the body as OMMessage<br />
* body-element-om : the first child of body as OMMessage<br />
* header-om : the header as OMMessage<br />
Default: context<br />
|-<br />
| mediaType || optional || This is used to specify the message format which the message needs to be serialized. See 'messageFormatters' configuration in axis2.xml file. Default value is: 'application/x-www-form-urlencoded'<br />
|-<br />
| contentType || optional || This is used to specify the message builder which the message needs to be serialized. See 'messageBuilders' configuration in axis2.xml file. Defaults to the value specified in 'mediaType' attribute.<br />
|-<br />
| responseMode || optional || This is used to specify if invoked service returns a response (OUT_IN) or not (OUT_ONLY). Default value is: OUT_IN<br />
|}<br />
<br />
and has the sub-element:<br />
* [[Description]]</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=Rest-call&diff=4095Rest-call2013-07-31T12:55:00Z<p>D.franco: </p>
<hr />
<div>==Description==<br />
<br />
The {{GVESB}} plugin '''ws-call''' defines the parameters for calling a Web Service using REST mode.<br />
<br />
=={{VULCON}} / {{GVCONSOLE}} Configuration==<br />
<br />
The rest-call Element is used by [[Channel]] and [[routed-call]]. Its attributes are:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''call'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.ws.rest.RestCallOperation'''.<br />
|-<br />
| name || required || Operation name. Used in the [[Flow]] section to associate workflow nodes to VCL operations.<br />
|}<br />
<br />
and its subelements:<br />
* [[Description]]<br />
* [[rest-call#RestServiceInvoker|RestServiceInvoker]]<br />
* [[Proxy]]<br />
<br />
===RestServiceInvoker===<br />
<br />
This element is used by [[ws-call]].<br />
<br />
Its attributes are:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''invoker'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.ws.rest.RestServiceInvoker'''.<br />
|-<br />
| endpoint || required || Endpoint exposed by the Rest Web Service to invoke. Can contain placeholders. It must be already escaped, if needed.<br />
|-<br />
| method || required || HTTP method to execute to the server.<br />
The attribute's admitted values are:<br />
* GET<br />
* POST<br />
* PUT<br />
* DELETE<br />
* HEAD<br />
* OPTIONS<br />
|-<br />
| timeout || optional || Timeout in seconds.<br />
|-<br />
| ref-dp || optional || Name of [[Data_provider|Data Provider]] to use for preparing the request.<br />
|-<br />
| throwsFault || optional || If ''true'' throws Exception "Error invoking operation". If ''false'' returns the Fault response. Default to false.<br />
The attribute's admitted values are:<br />
* true<br />
* false<br />
|-<br />
| use-saaj || optional || Defines whether to use SAAJ to invoke the WebService mode instead of the default Axis2 mode. <br/> NOTE: If you choose to use SAAJ as a way of calling the WebService, Axis2 modules are not enabled. <br/> The attribute's admitted values are:<br />
* true<br />
* false<br />
|-<br />
| returnType || optional || Defines how to set the response data in the object field of output [[GVBuffer]]:<br />
* context : the MessageContext<br />
* envelope : the envelope as XML serialized as string<br />
* body : the body as XML serialized as string<br />
* body-element : the first child of body as XML serialized as string<br />
* header : the header as XML serialized as string<br />
* envelope-om : the envelope as OMMessage<br />
* body-om : the body as OMMessage<br />
* body-element-om : the first child of body as OMMessage<br />
* header-om : the header as OMMessage<br />
Default: context<br />
|-<br />
| mediaType || optional || This is used to specify the message format which the message needs to be serialized. See 'messageFormatters' configuration in axis2.xml file. Default value is: 'application/x-www-form-urlencoded'<br />
|-<br />
| contentType || optional || This is used to specify the message builder which the message needs to be serialized. See 'messageBuilders' configuration in axis2.xml file. Defaults to the value specified in 'mediaType' attribute.<br />
|-<br />
| responseMode || optional || This is used to specify if invoked service returns a response (OUT_IN) or not (OUT_ONLY). Default value is: OUT_IN<br />
|}<br />
<br />
and has the sub-element:<br />
* [[Description]]</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=Rest-call&diff=4094Rest-call2013-07-31T12:52:26Z<p>D.franco: </p>
<hr />
<div>==Description==<br />
<br />
<div class="version_ge3.4"><br />
The {{GVESB}} plugin '''ws-call''' defines the parameters for calling a Web Service using REST mode.<br />
</div><br />
<br />
=={{VULCON}} / {{GVCONSOLE}} Configuration==<br />
<br />
The rest-call Element is used by [[Channel]] and [[routed-call]]. Its attributes are:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''call'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.ws.rest.RestCallOperation'''.<br />
|-<br />
| name || required || Operation name. Used in the [[Flow]] section to associate workflow nodes to VCL operations.<br />
|}<br />
<br />
and its subelements:<br />
* [[Description]]<br />
* [[rest-call#RestServiceInvoker|RestServiceInvoker]]<br />
* [[Proxy]]<br />
<br />
===RestServiceInvoker===<br />
<br />
This element is used by [[ws-call]].<br />
<br />
Its attributes are:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''invoker'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.ws.rest.RestServiceInvoker'''.<br />
|-<br />
| endpoint || required || Endpoint exposed by the Rest Web Service to invoke. Can contain placeholders. It must be already escaped, if needed.<br />
|-<br />
| method || required || HTTP method to execute to the server.<br />
The attribute's admitted values are:<br />
* GET<br />
* POST<br />
* PUT<br />
* DELETE<br />
* HEAD<br />
* OPTIONS<br />
|-<br />
| timeout || optional || Timeout in seconds.<br />
|-<br />
| ref-dp || optional || Name of [[Data_provider|Data Provider]] to use for preparing the request.<br />
|-<br />
| throwsFault || optional || If ''true'' throws Exception "Error invoking operation". If ''false'' returns the Fault response. Default to false.<br />
The attribute's admitted values are:<br />
* true<br />
* false<br />
|-<br />
| use-saaj || optional || Defines whether to use SAAJ to invoke the WebService mode instead of the default Axis2 mode. <br/> NOTE: If you choose to use SAAJ as a way of calling the WebService, Axis2 modules are not enabled. <br/> The attribute's admitted values are:<br />
* true<br />
* false<br />
|-<br />
| returnType || optional || Defines how to set the response data in the object field of output [[GVBuffer]]:<br />
* context : the MessageContext<br />
* envelope : the envelope as XML serialized as string<br />
* body : the body as XML serialized as string<br />
* body-element : the first child of body as XML serialized as string<br />
* header : the header as XML serialized as string<br />
* envelope-om : the envelope as OMMessage<br />
* body-om : the body as OMMessage<br />
* body-element-om : the first child of body as OMMessage<br />
* header-om : the header as OMMessage<br />
Default: context<br />
|-<br />
| mediaType || optional || This is used to specify the message format which the message needs to be serialized. See 'messageFormatters' configuration in axis2.xml file. Default value is: 'application/x-www-form-urlencoded'<br />
|-<br />
| contentType || optional || This is used to specify the message builder which the message needs to be serialized. See 'messageBuilders' configuration in axis2.xml file. Defaults to the value specified in 'mediaType' attribute.<br />
|-<br />
| responseMode || optional || This is used to specify if invoked service returns a response (OUT_IN) or not (OUT_ONLY). Default value is: OUT_IN<br />
|}<br />
<br />
and has the sub-element:<br />
* [[Description]]</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=Rest-call&diff=4093Rest-call2013-07-31T11:30:17Z<p>D.franco: </p>
<hr />
<div>==Description==<br />
<br />
<div class="version_ge3.4"><br />
The {{GVESB}} plugin '''ws-call''' defines the parameters for calling a Web Service using REST mode.<br />
</div><br />
<br />
=={{VULCON}} / {{GVCONSOLE}} Configuration==<br />
<br />
The rest-call Element is used by [[Channel]] and [[routed-call]]. Its attributes are:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''call'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.ws.rest.RestCallOperation'''.<br />
|-<br />
| name || required || Operation name. Used in the [[Flow]] section to associate workflow nodes to VCL operations.<br />
|}<br />
<br />
and its subelements:<br />
* [[Description]]<br />
* [[rest-call#RestServiceInvoker|RestServiceInvoker]]<br />
* [[Proxy]]<br />
<br />
===RestServiceInvoker===<br />
<br />
This element is used by [[ws-call]].<br />
<br />
Its attributes are:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''invoker'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.ws.rest.RestServiceInvoker'''.<br />
|-<br />
| endpoint || required || Endpoint exposed by the Rest Web Service to invoke. Can contain placeholders. It must be already escaped, if needed.<br />
|-<br />
| method || required || HTTP method to execute to the server.<br />
The attribute's admitted values are:<br />
* GET<br />
* POST<br />
* PUT<br />
* DELETE<br />
* HEAD<br />
* OPTIONS<br />
|-<br />
| timeout || optional || Timeout in seconds.<br />
|-<br />
| ref-dp || optional || Name of [[Data_provider|Data Provider]] to use for preparing the request.<br />
|-<br />
| throwsFault || optional || If ''true'' throws Exception "Error invoking operation". If ''false'' returns the Fault response. Default to false.<br />
The attribute's admitted values are:<br />
* true<br />
* false<br />
|-<br />
| use-saaj || optional || Defines whether to use SAAJ to invoke the WebService mode instead of the default Axis2 mode. <br/> NOTE: If you choose to use SAAJ as a way of calling the WebService, Axis2 modules are not enabled. <br/> The attribute's admitted values are:<br />
* true<br />
* false<br />
|-<br />
| returnType || optional || Defines how to set the response data in the object field of output [[GVBuffer]]:<br />
* context : the MessageContext<br />
* envelope : the envelope as XML serialized as string<br />
* body : the body as XML serialized as string<br />
* body-element : the first child of body as XML serialized as string<br />
* header : the header as XML serialized as string<br />
* envelope-om : the envelope as OMMessage<br />
* body-om : the body as OMMessage<br />
* body-element-om : the first child of body as OMMessage<br />
* header-om : the header as OMMessage<br />
Default: context<br />
|-<br />
| mediaType || optional || This is used to specify the message format which the message needs to be serialized. See 'messageFormatters' configuration in axis2.xml file. Default value is: 'application/x-www-form-urlencoded'<br />
|-<br />
| contentType || optional || This is used to specify the message builder which the message needs to be serialized. See 'messageBuilders' configuration in axis2.xml file. Defaults to the value specified in 'mediaType' attribute.<br />
|-<br />
| responseMode || optional || This is used to specify if invoked service returns a response (OUT_IN) or not (OUT_ONLY). Default value is: OUT_IN<br />
|}<br />
<br />
<br />
<br />
UNDER CONSTRUCTION...</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=Rest-call&diff=4092Rest-call2013-07-31T11:08:07Z<p>D.franco: </p>
<hr />
<div>==Description==<br />
<br />
<div class="version_ge3.4"><br />
The {{GVESB}} plugin '''ws-call''' defines the parameters for calling a Web Service using REST mode.<br />
</div><br />
<br />
=={{VULCON}} / {{GVCONSOLE}} Configuration==<br />
<br />
The rest-call Element is used by [[Channel]] and [[routed-call]]. Its attributes are:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''call'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.ws.rest.RestCallOperation'''.<br />
|-<br />
| name || required || Operation name. Used in the [[Flow]] section to associate workflow nodes to VCL operations.<br />
|}<br />
<br />
and its subelements:<br />
* [[Description]]<br />
* [[rest-call#RestServiceInvoker|RestServiceInvoker]]<br />
* [[Proxy]]<br />
<br />
===RestServiceInvoker===<br />
<br />
<br />
<br />
<br />
<br />
UNDER CONSTRUCTION...</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=Description&diff=4091Description2013-07-31T11:01:04Z<p>D.franco: </p>
<hr />
<div>[[File:Description.jpg|thumb|Groups section Description]]<br />
Each element of the configuration provides a field '''Description''' optional that might contain free text available to the user.<br />
<br />
This field can be used for notes and information that help users in configuration management and by the application {{L_GVCONSOLE}} to enrich the reports relating to the configuration.<br />
<br />
The Description is always optional, but if used can not be empty. The element value cannot be null.<br />
<br />
The Description Element is used by: [[JNDIHelper|Advanced]], [[ServiceAlias#AliasMapping|AliasMapping]], [[Smtp-call#attachments|attachments]], [[GVWebServices#AxisExtra|AxisExtra]], [[Ws-call#AxisWebServiceInvoker|AxisWebServiceInvoker]], [[Smtp-call#destinations|bcc]], [[GVWebServices#Binding|Binding]], [[birt-report-call]], [[Base64Transformation]], [[GVServices#BpelEngineConfiguration|BpelEngineConfiguration]], [[BpelOperation#BpelFlow|BpelFlow]], [[BpelOperation]], [[GVWebServices#BusinessWebServices|BusinessWebServices]], [[GVConnectorConfiguration#Call|Call]], [[CallDescriptor]], [[Generic-call#call-parameter|call-parameter]], [[CallSPFormatter]], [[CallSPBaseFormatter|CallSPSimpleBaseFormatter]], [[Smtp-call#destinations|cc]], [[ChangeGVBuffer]], [[GVConnectorConfiguration#Channels|Channels]], [[GVConnectorConfiguration#ComplexExtension|ComplexExtension]], [[GVConnectorConfiguration#CompressExtension|CompressExtension]], [[GVJdbc#Connection|Connection]], [[GVWebServices#connectionProperty|connectionFactory]], [[GVWebServices#connectionProperty|connectionProperty]], [[GVJdbc#Connections|Connections]], [[GVConnectorConfiguration#ConnectorService|ConnectorService]], [[GVConnectorConfiguration#ConnectorServices|ConnectorServices]], [[Http-call#constructor-args|constructor-args]], [[Http-call#constructor-param|constructor-param]], [[Http-call#CustomProtocol|CustomProtocol]], [[DBOperations#DataSourceConnection|DataSourceConnection]], [[GVJDBCConnectionBuilder#DataSourceConnectionBuilder|DataSourceConnectionBuilder]], [[db-call]], [[DBOBuilder]], [[DBOCallSP]], [[DBOInsert]], [[DBOInsertOrUpdate]], [[DBOperations]], [[DBOSelect]], [[DBOThreadSelect]], [[DBOUpdate]], [[DBOUpdateOrInsert]], [[GVConnectorConfiguration#DecompressExtension|DecompressExtension]], [[GVConnectorConfiguration#DecryptExtension|DecryptExtension]], [[Smtp-call#destinations|destinations]], [[DBOBuilder|DHAlias]], [[DBOBuilder|DHAliasList]], [[dh-call]], [[DHVariables#DHVariable|DHVariable]], [[DMLWriteFormatter]], [[GVJdbc#Driver|Driver]], [[GVJDBCConnectionBuilder#DriverConnectionBuilder|DriverConnectionBuilder]], [[GVJDBCConnectionBuilder#DriverPoolConnectionBuilder|DriverPoolConnectionBuilder]], [[GVJdbc#Drivers|Drivers]], [[GVConnectorConfiguration#DTEExtension|DTEExtension]], [[GVConnectorConfiguration#EncryptExtension|EncryptExtension]], [[Http-call#endpoint|endpoint]], [[GVWebServices#EngageModule|EngageModule]], [[GVBIRTReportConfiguration#Engine|Engine]], [[ShellCommands#env-property]], [[excel-call]], [[excelreader-call]], [[GVBIRTReportConfiguration#ExcelReportRender|ExcelReportRender]], [[JNDIHelper|Extended]], [[GVConnectorConfiguration#Extension|Extension]], [[GVConnectorConfiguration#Extensions|Extensions]], [[GVConnectorConfiguration#External-Component|External-Component]], [[GVConnectorConfiguration#ExternalComponents|ExternalComponents]], [[GVConnectorConfiguration#External-Params|External-Params]], [[Extract-data-call#extract-data|extract-data]], [[extract-data-call]], [[FieldFormatters#FieldFormatter|FieldFormatter]], [[FieldFormatters]], [[Smtp-call#file-attachment|file-attachment]], [[Filemanager-call#FileCopyCommand|FileCopyCommand]], [[Filemanager-call#FileDeleteCommand|FileDeleteCommand]], [[Fsmonitor-call#FileFilter|FileFilter]], [[filemanager-call]], [[Fsmonitor-call#FileMonitorStatus|FileMonitorStatus]], [[Filemanager-call#FileMoveCommand|FileMoveCommand]], [[filereader-call]], [[Filemanager-call#FileSearchCommand|FileSearchCommand]], [[Filemanager-call#FileUnZipCommand|FileUnZipCommand]], [[filewriter-call]], [[Filemanager-call#FileZipCommand|FileZipCommand]], [[GVExcelWorkbookConfiguration#Font|Font]], [[GVExcelWorkbookConfiguration#Format|Format]], [[fsmonitor-call]], [[FTPManager]], [[generic-call]], [[GenericRetriever]], [[GVConnectorConfiguration#GenericTransaction|GenericTransaction]], [[GVConnectorConfiguration#GreenVulcanoCoreChannel|GreenVulcanoCoreChannel]], [[GVJbpmTaskListenerManager#GreenVulcanoPool|GreenVulcanoPool]], [[GVWebServices#GreenVulcanoWebService|GreenVulcanoWebService]], [[GVWebServices#GreenVulcanoWebServices|GreenVulcanoWebServices]], [[GVJbpmTaskListenerManager#GroupsJbpm|groupJbpm]], [[GVJbpmTaskListenerManager#GroupsJbpm|GroupsJbpm]], [[GVAdapterOpenSpCoop]], [[GVBIRTReportConfiguration]], [[Smtp-call#gvBuffer|gvBuffer]], [[GVBufferCondition]], [[GVBufferMapping#GVBufferFieldOutput|GVBufferFieldOutput]], [[GVBufferMapping]], [[Statement#GVBufferParam|GVBufferParam]], [[Statement#GVBufferParamResolver|GVBufferParamResolver]], [[GVConnectorConfiguration]], [[GVHL7ListenerManager#GVCoreApplication|GVCoreApplication]], [[gvcore-call]], [[GVDataHandlerConfiguration]], [[GVDataProviderManager]], [[GVExcelCreatorConfiguration]], [[Excel-call#GVExcelReport|GVExcelReport]], [[GVExcelWorkbookConfiguration#GVExcelWorkbook|GVExcelWorkbook]], [[GVExcelWorkbookConfiguration]], [[GVHL7ListenerManager]], [[GVJBPMConfiguration]], [[GVJbpmTaskListenerManager#GVJbpmListeners|GVJbpmListeners]], [[GVJbpmTaskListenerManager]], [[GVJdbc]], [[GVJDBCConnectionBuilder]], [[GVMailServices]], [[GVSQLErrorMapping]], [[GVWebServices]], [[GVHL7ListenerManager#HL7Activation|HL7Activation]], [[hl7-call]], [[GVHL7ListenerManager#HL7Listener|HL7Listener]], [[GVBIRTReportConfiguration#HTMLReportRender|HTMLReportRender]], [[http-call]], [[GVMailServices#imap|imap]], [[Fsmonitor-call#InMemoryMonitorStatus|InMemoryMonitorStatus]], [[jmx-call#invoke-parameter|invoke-parameter]], [[j2ee-ejb-call]], [[j2ee-jca-call]], [[Retriever_Config#JavaScriptRetriever|JavaScriptRetriever]], [[GVWebServices#JAXMLRegistry|JAXMLRegistry]], [[jbpm-call]], [[jbpm-task-call]], [[J2ee-jca-call#jca-connection-spec|jca-connection-spec]], [[J2ee-jca-call#jca-interaction-spec|jca-interaction-spec]], [[DBOperations#JDBCConnection|JdbcConnection]], [[jms-dequeue]], [[jms-enqueue]], [[jmx-call]], [[JNDIHelper]], [[Fsmonitor-call#LocalFileSystemMonitor|LocalFileSystemMonitor]], [[Smtp-call#destinations|mail-address]], [[Smtp-call#mail-message|mail-message]], [[GVMailServices#mail-service|mail-service]], [[Smtp-call#message-body|message-body]], [[GVMailServices#mime|mime]], [[GVWebServices#ModuleProperty|ModuleProperty]], [[openspcoop-call]], [[GVConnectorConfiguration#OperationDetails|OperationDetails]], [[GVBIRTReportConfiguration#Option|Option]], [[GVBIRTReportConfiguration#Options|Options]], [[Statement#Param|Param]], [[parameter]], [[GVBIRTReportConfiguration#Parameter|Parameter]], [[GVBIRTReportConfiguration#Parameters|Parameters]], [[J2ee-jca-call#param-gvbuffer|param-gvbuffer]], [[Jbpm-call#ParamJbpm|ParamJbpm]], [[Statement#ParamResolver|ParamResolver]], [[Jbpm-call|ParamsJbpm]], [[Jbpm-task-call#ParamsTask|ParamsTask]], [[GVWebServices#PasswordCallback|PasswordCallback]], [[GVBIRTReportConfiguration#PDFReportRender|PDFReportRender]], [[GVJDBCConnectionBuilder#PoolParameters|PoolParameters]], [[GVMailServices#pop3|pop3]], [[pop-call]], [[GVWebServices#Properties|Properties]], [[J2ee-jca-call#property|property]], [[GVBufferCondition#Property|Property]], [[GVBufferCondition#PropertyCompare|PropertyCompare]], [[GVSavePointNode#PropertyDef|PropertyDef]], [[GVConnectorConfiguration#Property-Field|Property-Field]], [[Proxy]], [[GVWebServices#PasswordCallback|PwCbBasicHandler]], [[QueryFormatter]], [[QueryFormatter#QueryXMLBaseFormatter|QueryXMLBaseFormatter]], [[GVBufferCondition#RangeDef|RangeDef]], [[Remotemanager-call#RemoteDeleteCommand |RemoteDeleteCommand]], [[Remotemanager-call#RemoteDownloadCommand |RemoteDownloadCommand]], [[Fsmonitor-call#RemoteFileSystemMonitor|RemoteFileSystemMonitor]], [[remotemanager-call]], [[Remotemanager-call#RemoteMoveCommand |RemoteMoveCommand]], [[Remotemanager-call#RemoteSearchCommand |RemoteSearchCommand]], [[Remotemanager-call#RemoteUploadCommand |RemoteUploadCommand]], [[GVBIRTReportConfiguration#Renders|Renders]], [[GVBIRTReportConfiguration#Report|Report]], [[GVBIRTReportConfiguration#ReportGroups|ReportGroup]], [[GVBIRTReportConfiguration#ReportGroups|ReportGroups]], [[ResultSet]], [[GVBufferCondition#RetCodeField|RetCodeField]], [[Retriever_Config|RetrieverConfig]], [[routed-call]], [[routed-dequeue]], [[routed-enqueue]], [[ServiceAlias]], [[GVHTTPAdapter#ServletMappings|ServletMapping]], [[SFTPManager]], [[Excel-call#Sheet|Sheet]], [[GVExcelWorkbookConfiguration#SheetConfig|SheetConfig]], [[shell-call]], [[Simpleformatter]], [[GVMailServices#smtp|smtp]], [[smtp-call]], [[J2ee-jca-call#spec-constructor|spec-constructor]], [[J2ee-jca-call#spec-property|spec-property]], [[SPOutputParams#SPOutputParam|SPOutputParam]], [[SPOutputParams]], [[J2ee-jca-call#string-to-xml|string-to-xml]], [[Retriever_Config#TableRetriever|TableRetriever]], [[GVConnectorConfiguration#TestExtension|TestExtension]], [[test-service-call]], [[Smtp-call#destinations|to]], [[GVHTTPAdapter#Transaction|Transaction]], [[GVConnectorConfiguration#Transactions|Transactions]], [[GVWebServices#UDDI|UDDI]], [[GVWebServices#UserDef|UserDef]], [[GVJbpmTaskListenerManager#UsersJbpm|userJbpm]], [[GVJbpmTaskListenerManager#UsersJbpm|UsersJbpm]], [[GVConnectorConfiguration#UserTransaction|UserTransaction]], [[GVConnectorConfiguration#VCLChannel|VCLChannel]], [[GVConnectorConfiguration#VCLOperation|VCLOperation]], [[VCLRouting]], [[GVWebServices#WebService|WebService]], [[J2ee-ejb-call#WLSSubjectBuilder|WLSSubjectBuilder]], [[ws-call]], [[rest-call]], [[Ws-call#WSDLInfo|WSDLInfo]], [[GVWebServices#WSOperation|WSOperation]], [[XAHelper]], [[J2ee-jca-call#xml-data|xml-data]], [[Filereader-call#xml-processor|xml-processor]], [[Ws-call#XPathNamespace|XPathNamespace]], [[Statement#XPathParamResolver|XPathParamResolver]].</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=Routed-call&diff=4090Routed-call2013-07-31T10:50:00Z<p>D.franco: </p>
<hr />
<div>Used to make a routing mechanism at the level of communication channel, based on some conditions applied to the buffer GVBuffer.<br />
During the execution of flows, the operation is seen as a simple call.<br />
The implementation of the routed call checks the conditions and invokes a sub-operations accordingly.<br />
<br />
To configure a ''routed-call'' it is necessary:<br />
* defines sub-operations: Each sub operation is identified by a unique name within the routed-call. <br/> The sub-operation can be selected are only those of type "call".<br />
* defines routing conditions: Check the values in GVBuffer fields. Each routing condition has a unique name within the routed-call.<br />
* associate routing conditions to operations: Sub items 'VCLRouting' associate routing conditions with operations. The evaluation order is defined by the order of [[VCLRouting]] items. <br/> The sub-operation is performed corresponding to the first condition verified.<br />
<br />
The routed-call Element is used by [[Channel]], routed-call.<br />
<br />
It has the attributes:<br />
{|class="gvtable"<br />
! Attribute !! Type !! Description<br />
|-<br />
| type || fixed || This attribute must assume the value '''call'''.<br />
|-<br />
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.RoutedCall'''.<br />
|-<br />
| name || required || Operation name. Used in the 'Flow' section to associate workflow nodes to VCL operations.<br />
|}<br />
<br />
and may have as subelements:<br />
<br />
* Description,<br />
* [[GVBufferCondition]](s),<br />
* (j2ee-ejb-call | j2ee-jca-call | jmx-call | smtp-call | pop-call | ws-call | rest-call | http-call | hl7-call | jbpm-call | jbpm-task-call | openspcoop-call | db-call | dh-call | extract-data-call | routed-call | gvcore-call | excel-call | excelreader-call | birt-report-call | test-service-call | generic-call | shell-call | filereader-call | filewriter-call | filemanager-call | fsmonitor-call | remotemanager-call)(s),<br />
* [[VCLRouting]],<br />
* [[ServiceAlias]]</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=Rest-call&diff=4089Rest-call2013-07-31T09:40:21Z<p>D.franco: </p>
<hr />
<div>==Description==<br />
<br />
<div class="version_ge3.4"><br />
The {{GVESB}} plugin '''ws-call''' defines the parameters for calling a Web Service using REST mode.<br />
</div><br />
<br />
=={{VULCON}} / {{GVCONSOLE}} Configuration==<br />
<br />
<br />
<br />
<br />
UNDER CONSTRUCTION...</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=Rest-call&diff=4088Rest-call2013-07-31T09:39:43Z<p>D.franco: </p>
<hr />
<div><div class="version_ge3.4"><br />
==Description==<br />
<br />
The {{GVESB}} plugin '''ws-call''' defines the parameters for calling a Web Service using REST mode.<br />
<br />
=={{VULCON}} / {{GVCONSOLE}} Configuration==<br />
<br />
<br />
<br />
<br />
UNDER CONSTRUCTION...<br />
</div></div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=Rest-call&diff=4087Rest-call2013-07-31T08:40:37Z<p>D.franco: </p>
<hr />
<div>==Description==<br />
<br />
<div class="version_ge3.4"><br />
The {{GVESB}} plugin '''ws-call''' defines the parameters for calling a Web Service using REST mode.<br />
</div><br />
<br />
=={{VULCON}} / {{GVCONSOLE}} Configuration==<br />
<br />
<br />
<br />
<br />
UNDER CONSTRUCTION...</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=Rest-call&diff=4086Rest-call2013-07-31T08:40:10Z<p>D.franco: </p>
<hr />
<div>==Description==<br />
<br />
<div class="version_ge3.3"><br />
The {{GVESB}} plugin '''ws-call''' defines the parameters for calling a Web Service using REST mode.<br />
</div><br />
<br />
=={{VULCON}} / {{GVCONSOLE}} Configuration==<br />
<br />
<br />
<br />
<br />
UNDER CONSTRUCTION...</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=Plugins&diff=4085Plugins2013-07-31T08:35:10Z<p>D.franco: </p>
<hr />
<div>In {{GVESB}}, a plug-in is a software component that extends the capability to access an external system, database or data in general. <br />
<br />
For example, plug-ins are commonly used in {{GVESB}} to read Excel files ([[excelreader-call]]), or for reading/writing a file ([[filereader-call]] / [[filewriter-call]]).<br />
<br />
<br />
The following tables show all the available {{GVESB}} plugins grouped by technology:<br />
<br />
<br />
'''File system'''<br />
<br />
{|class="gvtable" style="width: 80%"<br />
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...<br />
|-<br />
| [[File:GVFileReader.png |20px]] || [[filereader-call]] || reading a file present in the file system<br />
|-<br />
| [[File:GVFileWriter.png |20px]] || [[filewriter-call]] || writing a file in the file system<br />
|-<br />
| [[File:GVFileManager.png |20px]] || [[filemanager-call]] || searching, moving, coping, deleting, compressing and uncompressing a file <br />
|-<br />
| [[File:GVFsMonitor2.png |20px]] || [[fsmonitor-call]] || getting a XML report of a directory containing the existing, created, modified and deleted files, from the last scan<br />
|-<br />
| [[File:GVRemoteManager.png |20px]] || [[remotemanager-call]] || performing operations to a file present in a remote file system via FTP/SFTP/FTPS<br />
|-<br />
| [[File:GVShellID.png |20px]] || [[shell-call]] || executing a shell command<br />
|-<br />
| [[File:GVRSHFileReader.png |20px]] || [[rsh-filereader-call]] || reading a file in a local or remote file system through the {{GVESB}} RSH RMI server<br />
|-<br />
| [[File:GVRSHFileWriter.png |20px]] || [[rsh-filewriter-call]] || writing a file in a local or remote file system through the {{GVESB}} RSH RMI server<br />
|-<br />
| [[File:GVRSHCall.png |20px]] || [[rsh-call]] || executing a shell command in a local or remote system through the {{GVESB}} RSH RMI server<br />
|}<br />
<br />
'''WebService'''<br />
<br />
{|class="gvtable" style="width: 80%"<br />
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...<br />
|-<br />
| [[File:GVWsCall.png | 20px]] || [[ws-call]] || defining useful information for making a call to a Web Service<br />
|-<br />
| [[File:GVRestCall.png | 20px]] || [[rest-call]] || defining useful information for making a call to a Web Service using Rest mode<br />
|}<br />
<br />
'''Data Base'''<br />
<br />
{|class="gvtable" style="width: 80%"<br />
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...<br />
|-<br />
| [[File:GVDBCall.png | 20px]] || [[db-call]] || basic DB interaction<br />
|-<br />
| [[File:GVDHCall.png | 20px]] || [[dh-call]] || defining the parameter for making a call to [[DataHandler]]<br />
|-<br />
| [[File:GVBirtReportCall.png | 20px]] || [[birt-report-call]] || defining the parameter to generate a BIRT report<br />
|-<br />
| [[File:GVExcelCall.png | 20px]] || [[excel-call]] || defining the parameter to create an Excel report from a DB select<br />
|}<br />
<br />
'''JMS'''<br />
<br />
{|class="gvtable" style="width: 80%"<br />
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...<br />
|-<br />
| [[File:Enqueue32.png | 20px]] || [[jms-enqueue]] || performing a queuing/publish operation on a JMS queue/topic<br />
|-<br />
| [[File:Dequeue32.png | 20px]] || [[jms-dequeue]] || performing a reception operation from a JMS queue/topic<br />
|}<br />
<br />
'''Routing'''<br />
<br />
{|class="gvtable" style="width: 80%"<br />
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...<br />
|-<br />
| [[File:GVRoutedCall.png | 20px]] || [[routed-call]] || creating a routing mechanism at the level of communication channel<br/> during the execution of flows, the operation is seen as a simple call<br />
|-<br />
| [[File:GVRoutedDequeueCall.png | 20px]] || [[routed-dequeue]] || creating a routing mechanism at the level of communication channel<br/> during the execution of flows, the operation is seen as a simple dequeue<br />
|-<br />
| [[File:GVRoutedEnqueueCall.png | 20px]] || [[routed-enqueue]] || creating a routing mechanism at the level of communication channel<br/> during the execution of flows, the operation is seen as a simple enqueue<br />
|}<br />
<br />
'''Mail'''<br />
<br />
{|class="gvtable" style="width: 80%"<br />
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...<br />
|-<br />
| [[File:GVSmtpCall.png | 20px]] || [[smtp-call]] || sending an email<br />
|-<br />
| [[File:GVPopCall.png | 20px]] || [[pop-call]] || receiving an email<br />
|}<br />
<br />
'''J2EE'''<br />
<br />
{|class="gvtable" style="width: 80%"<br />
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...<br />
|-<br />
| [[File:GVEjbCall.png | 20px]] || [[j2ee-ejb-call]] || invoking an Enterprise Java Bean<br />
|-<br />
| [[File:GVJcaCall.png | 20px]] || [[j2ee-jca-call]] || invoking an adapter JCA (Java Connector Architecture) that exposes the interface CCI (Common Client Interface).<br />
|}<br />
<br />
'''LDAP'''<br />
<br />
{|class="gvtable" style="width: 80%"<br />
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...<br />
|-<br />
| [[File:GVLDAPSearch.png | 20px]] || [[ldap-search-call]] || searching data on LDAP servers<br />
|-<br />
| [[File:GVLDAPUpdate.png | 20px]] || [[ldap-update-call]] || updating data on LDAP servers<br />
|}<br />
<br />
'''Communication'''<br />
<br />
{|class="gvtable" style="width: 80%"<br />
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...<br />
|-<br />
| [[File:GVHttpCall.png | 20px]] || [[http-call]] || calling HTTP methods on remote servers<br />
|-<br />
| [[File:GVHl7Call.png | 20px]] || [[hl7-call]] || invoking synchronous services on systems that use the HL7 v2 protocol with messages either standard or in XML format<br />
|-<br />
| [[File:call.png | 20px]] || [[jbpm-call]] || using the JBPM plugin<br />
|-<br />
| [[File:call.png | 20px]] || [[jbpm-task-call]] || using the JBPM TASK plugin<br />
|-<br />
| [[File:GVopenspcoopCall.png | 20px]] || [[openspcoop-call]] || using the Open SPCoop plugin<br />
|}<br />
<br />
'''Utility'''<br />
<br />
{|class="gvtable" style="width: 80%"<br />
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...<br />
|-<br />
| [[File:GVJmxCall.png | 20px]] || [[jmx-call]] || invoking MBean methods or set/get attributes on servers<br />
|-<br />
| [[File:GVextractData.png | 20px]] || [[extract-data-call]] || extract data from the body of the message<br />
|-<br />
| [[File:GVtest.png | 20px]] || [[test-service-call]] || simulate a test service<br />
|-<br />
| [[File:GVExcelReaderCall.png | 20px]] || [[excelreader-call]] || reading from a Excel file<br />
|-<br />
| [[File:GVGenericCall.png | 20px]] || [[generic-call]] || doing a [[Develop Generic VCL Call|user developed generic plug-in]] invocation<br />
|- <br />
| [[File:GVCoreCall.png | 20px]] || [[gvcore-call]] || invoking directly a flow of the {{GVESB}} core <br />
|- <br />
| [[File:GVRulesCall.png | 20px]] || [[rules-call]] || invoking a Rule Engine service<br />
|}<br />
<br />
<br />
'''Twitter'''<br />
<br />
{|class="gvtable" style="width: 80%"<br />
! style="width: 5%" | !! style="width: 20%" | Plug-in !! style="width: 75%" | Use this for ...<br />
|-<br />
| [[File:Tweet.png | 20px]] || [[twitter-update-status]] || tweet<br />
|-<br />
| [[File:Retweet.png | 20px]] || [[twitter-retweet-status]] || retweet<br />
|-<br />
| [[File:Follow.png | 20px]] || [[twitter-enable-notification]] || follow<br />
|-<br />
| [[File:Unfollow.png | 20px]] || [[twitter-disable-notification]] || unfollow<br />
|-<br />
| [[File:Follower.png | 20px]] || [[twitter-get-followers-ids]] || get followers<br />
|- <br />
| [[File:AddUser.png | 20px]] || [[twitter-get-friends-ids]] || get friends<br />
|- <br />
| [[File:Message.png | 20px]] || [[twitter-send-direct-message]] || send direct tweet<br />
|}<br />
<br />
{{VOTE}}</div>D.francohttps://gvwiki.greenvulcano.com/gvwiki/index.php?title=Channel&diff=4084Channel2013-07-31T08:32:59Z<p>D.franco: /* {{VULCON}} / {{GVCONSOLE}} Configuration */</p>
<hr />
<div>==Description==<br />
<br />
The '''Operations''' are grouped into '''Channels''', how organize the '''Operation''' within the '''Channels''' is a choice of {{GVESB}} developer <br />
<br />
Usually the '''Operations''' are grouped by:<br />
*Technology: Some servers may have different technological interfaces (eg HTTP, RMI), then you can allocate additional channels to group operations based on the technology used.<br />
* Abstraction: It 'possible that a system is actually composed of several heterogeneous systems (such a situation can occur, for example, during a migration, or due to modification or replacement of systems). For each subsystem is possible to build a Channel.<br />
<br />
=={{VULCON}} / {{GVCONSOLE}} Configuration==<br />
<br />
The Channel is identified by an unique attribute id-channel, this attribute is unique within the System entity. The Channel subelement are the Operations, {{GVESB}} offers a wide variety of Operations that you can use in your service. See [[plugins]] section.<br />
<br />
==How To==<br />
<br />
From the {{L_VULCON}} Core view, it is possible to insert a new Channel by right clicking the [[System]] element you are working on. Then ''Insert after'' and press Channel*. A new Channel element will be created. Fill the ''id-channel'' property in the properties view. Now you can insert all the operations needed.</div>D.franco