Difference between revisions of "TestFileAttachment"

From GreenVulcano Wiki
Jump to: navigation, search
(→‎{{GVCONSOLE}} Configuration)
 
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
==Description==
 
==Description==
  
−
[[File:GVExamplesTestFileAttachment.jpg|thumb|TestFileAttachment description]]This example shows how use {{GVESB}} to send an email containing attachments.
+
[[File:GVExamplesTestFileAttachment.jpg|thumb|TestFileAttachment description]]This example shows how to use {{GVESB}} to send an email containing attachments.
  
  
−
TestFileAttachment services executes the following operations:
+
TestFileAttachment service executes the following operations:
  
−
* Reads a file from a directory of input (in this case TestAttach/input)
+
* Reads a file from an input directory (TestAttach/input)
 
* Sends an email with this file as attachment
 
* Sends an email with this file as attachment
−
* Moves sent file to another directory (we choose TestAttach/sent)
+
* Moves the sent file to another directory (TestAttach/sent)
  
 
=={{VULCON}} Configuration==
 
=={{VULCON}} Configuration==
  
−
To configure TestFileAttachment service follow these steps:
+
The preferred mode for creating a Service (at least its skeleton) is through the Service Wizard. Before using it you must first configure the VCL plugins neeeded. 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.  
−
# Define the [[System]], [[Channel]] and [[Operation|Operations]] required
 
−
# Define the [[Service|Services]]
 
−
# Implement the [[Flow|flows]].
 
  
 
===Defining System, Channel and Operations===
 
===Defining System, Channel and Operations===
  
−
To define a System, go to {{VULCON}} core view and, into Systems element, insert the System GVESB if it is not already present. Inside of it create the Channel TEST_CHANNEL_FILE in which the following operations will be configured:
+
To define a System, go to {{VULCON}} core view and, into Systems element, insert the System GVESB if it is not already present.  
 +
From there create the Channel TEST_CHANNEL_FILE in which the following operations will be configured:
  
 
* [[filemanager-call]]
 
* [[filemanager-call]]
Line 27: Line 25:
 
| name || ScanAttachments
 
| name || ScanAttachments
 
FileCommands:
 
FileCommands:
−
: FileSearchCommand  
+
: [[Filemanager-call#FileSearchCommand|FileSearchCommand]]
 
:: filePattern=".*"  
 
:: filePattern=".*"  
 
:: returnFullPath="true"
 
:: returnFullPath="true"
Line 38: Line 36:
 
| name || MoveAttachments
 
| name || MoveAttachments
 
FileCommands:
 
FileCommands:
−
: FileMoveCommand:
+
: [[Filemanager-call#FileMoveCommand|FileMoveCommand]]:
 
:: filePattern=".*"
 
:: filePattern=".*"
 
:: sourcePath="<nowiki>${{gv.app.home}}</nowiki>/TEST/TESTFS/TestAttach/input"
 
:: sourcePath="<nowiki>${{gv.app.home}}</nowiki>/TEST/TESTFS/TestAttach/input"
Line 54: Line 52:
 
: destinations:
 
: destinations:
 
:: to:  
 
:: to:  
−
::: mail-address: address="gv2@gv.com"/>
+
::: mail-address: address="gv2@gv.com"
−
: message-body: gvBuffer-dump="false">
+
: message-body: gvBuffer-dump="false"
 
:: message-text: ${'Attachment file list:\n'+property['GV_SMTP_ATTACHMENTS']}
 
:: message-text: ${'Attachment file list:\n'+property['GV_SMTP_ATTACHMENTS']}
 
|}
 
|}
  
−
[[File:GVExamplesTestFileAttachmentFlow.jpg|thumb|TestFileAttachment flow]]
+
===Flow implementation===
 +
 
 +
[[File:GVExamples_TestFileAttachmentWizard.jpg|thumb|New {{GVESB}} Service Wizard]]Now we are able to use the Wizard.
 +
# From the Core View of {{VULCON}}. Right click the element Services -> Wizard New Service
 +
# A new window will be open where you can set the name of the Service you want to create. Set id-service as TestFileAttachment, and Group as TEST_GROUP. The scenario will be [[Paradigms_of_communication#synchronous-synchronous|synchronous-synchronous]]. Click next.
 +
# Set System as GVESB and Channel as TEST_CHANNEL_FILE. Then choose the first Operation to be executed, in this case ''ScanAttachments''. Then finish.
 +
 
 +
 
 +
[[File:GVExamplesTestFileAttachmentFlow.jpg|thumb|TestFileAttachment flow]] As you can see from the core view, inside the Services element, a new Service named TestFileAttachment has been created. The editor will be opened automatically, showing the nodes involved in our [[Flow]]. To implement the TestFileAttachment service [[Flow]] design it as shown in the picture:
 +
 
 +
The following table shows the nodes and attributes to be defined:
 +
 
 +
{|class="gvtable"
 +
! Attribute/Subelement !! Value
 +
|-
 +
| first-node || Prepare
 +
|-
 +
| Conditions/GVBufferCondition || condition="FilesFound" type="condition"
 +
Property:
 +
: name="GVFM_FOUND_FILES_NUM"
 +
: operator="greater"
 +
: type="gvbuffer-field"
 +
: value="0"
 +
: value-type="integer"
 +
|-
 +
| GVOperationNode || dump-in-out="false" <br/>id="list_files" <br/>id-system="GVESB" input="input" <br/>next-node-id="check_files"  <br/>op-type="call" <br/>operation-name="ScanAttachments"  <br/>output="files"
 +
|-
 +
| GVNodeCheck || default-id="end-nofiles"  <br/>id="check_files" <br/> input="files"  <br/>on-exception-id="end"<br/>GVRouting:
 +
: condition="FilesFound"
 +
: next-node-id="prepare"
 +
|-
 +
| ChangeGVBufferNode || dump-in-out="true"  <br/>id="prepare"  <br/>input="files" <br/> next-node-id="send_email" <br/> output="files"
 +
ChangeGVBuffer: clear-data="false"
 +
: OGNLScript: property['GV_SMTP_ATTACHMENTS'] = property['GVFM_FOUND_FILES_LIST']
 +
|-
 +
| GVOperationNode || dump-in-out="false"  <br/>id="send_email" <br/>id-system="GVESB"  <br/>input="files" <br/>next-node-id="move_files"  <br/> operation-name="SendEmail"  <br/>output="files"
 +
|-
 +
| GVOperationNode || dump-in-out="false" <br/> id="move_files" <br/>id-system="GVESB"  <br/>input="files" <br/>next-node-id="end"  <br/>operation-name="MoveAttachments"  <br/>output="files"
 +
|-
 +
| GVEndNode || end-business-process="yes"  <br/>id="end-nofiles" <br/>output="files"
 +
|-
 +
| GVEndNode || end-business-process="yes"  <br/>id="end" <br/> output="files"
 +
|}
 +
 
 +
Save the editor clicking on the Save icon of Eclipse. Control that there are not errors in the flow and save it in the apposite icon present in the Core View of {{L_VULCON}}. From the Project view, expand your project, refresh (f5), and right clicking the folder "conf" export your new configuration.
 +
 
 +
=={{GVCONSOLE}} Configuration==
 +
 
 +
It is time to deploy and test your new Service. To do that execute the following steps:
 +
 
 +
[[File:GVCONSOLEDeploy.jpg|thumb|Deploy new Service]]Suppose you have saved the {{VULCON}} Configuration file as <nowiki>"$GV_HOME/TEST/REPG1.zip"</nowiki>. To deploy the new Service follow this steps:
 +
# [[Starting|Start {{GVESB}}]]
 +
# [[GV_Console#Access|Access to the {{GVCONSOLE}}]].
 +
# In the Deploy New Service section click Browse and select the file where you saved the {{VULCON}} configuration.
 +
# Click Submit.
 +
 
 +
The section [[Deploy_Service|Deploy Services]] will be open. In this section you can select the services you want to deploy.
 +
# Clicking on service TestFileAttachment a new view will be showed containing the files GVCore.xml present in local and on server side.
 +
# Click Deploy. Now you can save the document and write some notes about it.
 +
# Save the Document. By saving you will return to the [[Deploy Service]] section.
 +
 
 +
[[File:GVConsoleUtilityReload1.jpg|thumb|{{GVCONSOLE}} Utility section]]Now pass to the {{GVCONSOLE}} section [[Utility]].
 +
# Click on [[Reload_Configuration|Reload configuration]]
 +
# Select GVCore.xml and then Reload. A new windows will be open to confirm the operation
 +
# Click OK.
 +
 
 +
[[File:GVExamplesTestFileAttachmentOutput.jpg|thumb|Testing TestFileAttachment]]Go to the {{GVCONSOLE}} section [[Testing]]. In this section you can finally test your new services:
 +
# Into the Service voice select TestFileAttachment
 +
# Into the System voice select GVESB
 +
# Click RequestReply
 +
 
 +
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 GVFM_FOUND_FILES_NUM property set to 3, representing the number of files found.
 +
 
 +
The file TestOutput.txt will be generated in the directory $GV_HOME/log as previously set (see [[Testing]], [[Testing#Data_input|Data input]] area) containing information about the files found and the email already sent.
 +
<syntaxhighlight lang="XML">
 +
<pre>
 +
----------- TEST N. 0 2012.02.15 at 18:02:32 -----------
 +
Standard Field:
 +
system  = GVESB
 +
service  = EmailFileAttachment
 +
id      = 7F0001014F3BE51400059DBA
 +
retCode  = 0
 +
GVBuffer: class java.lang.String
 +
 
 +
Properties:
 +
messageID = <9388830.11329325352084.JavaMail.gv1@gv.com>
 +
GVFM_FOUND_FILES_LIST = $GV_HOME/TEST/TESTFS/TestAttach/input/001.txt;
 +
                                $GV_HOME/TEST/TESTFS/TestAttach/input/002.txt;
 +
                                $GV_HOME/TEST/TESTFS/TestAttach/input/003.txt
 +
GVFM_FOUND_FILES_NUM = 3
 +
GV_SMTP_ATTACHMENTS = $GV_HOME/TEST/TESTFS/TestAttach/input/001.txt;
 +
                              $GV_HOME/TEST/TESTFS/TestAttach/input/002.txt;
 +
                              $GV_HOME/TEST/TESTFS/TestAttach/input/003.txt
 +
</pre>
 +
</syntaxhighlight>
 +
 
 +
Set a new account with the properties:<br/>
 +
Server SMTP/POP3
 +
* SMTP : localhost:3025
 +
* POP3: localhost:3110
 +
* Server mailbox: gv1@gv.com (gv1/gv1)
 +
* Client mailbox:  gv2@gv.com (gv2/gv2)<br/>gv3@gv.com (gv3/gv3)
 +
 
 +
[[File:GVExamplesTestFileAttachmentEmail.jpg|thumb|TestFileAttachment email]]You will receive an email as this shown in the picture.
 +
 
 +
 
 +
You can also check that the files were moved into the directory $GV_HOME/TEST/TESTFS/TestAttach/sent.

Latest revision as of 11:54, 20 February 2012

Description

TestFileAttachment description

This example shows how to use GreenVulcano® ESB to send an email containing attachments.


TestFileAttachment service executes the following operations:

  • Reads a file from an input directory (TestAttach/input)
  • Sends an email with this file as attachment
  • Moves the sent file to another directory (TestAttach/sent)

VulCon Configuration

The preferred mode for creating a Service (at least its skeleton) is through the Service Wizard. Before using it you must first configure the VCL plugins neeeded. 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.

Defining System, Channel and Operations

To define a System, go to VulCon core view and, into Systems element, insert the System GVESB if it is not already present. From there create the Channel TEST_CHANNEL_FILE in which the following operations will be configured:

Attribute/Subelement Value
name ScanAttachments

FileCommands:

FileSearchCommand
filePattern=".*"
returnFullPath="true"
sourcePath="${{gv.app.home}}/TEST/TESTFS/TestAttach/input"
Attribute/Subelement Value
name MoveAttachments

FileCommands:

FileMoveCommand:
filePattern=".*"
sourcePath="${{gv.app.home}}/TEST/TESTFS/TestAttach/input"
targetPath="${{gv.app.home}}/TEST/TESTFS/TestAttach/sent"
Attribute Value
jndi-name gvesb.mailServer
name SendEmail
mail-message content-type="text-html"
high-priority="true"
sender-display-name="GV ESB"
subject="Test send attachments"
destinations:
to:
mail-address: address="gv2@gv.com"
message-body: gvBuffer-dump="false"
message-text: ${'Attachment file list:\n'+property['GV_SMTP_ATTACHMENTS']}

Flow implementation

New GreenVulcano® ESB Service Wizard

Now we are able to use the Wizard.

  1. From the Core View of VulCon. Right click the element Services -> Wizard New Service
  2. A new window will be open where you can set the name of the Service you want to create. Set id-service as TestFileAttachment, and Group as TEST_GROUP. The scenario will be synchronous-synchronous. Click next.
  3. Set System as GVESB and Channel as TEST_CHANNEL_FILE. Then choose the first Operation to be executed, in this case ScanAttachments. Then finish.


TestFileAttachment flow

As you can see from the core view, inside the Services element, a new Service named TestFileAttachment has been created. The editor will be opened automatically, showing the nodes involved in our Flow. To implement the TestFileAttachment service Flow design it as shown in the picture:

The following table shows the nodes and attributes to be defined:

Attribute/Subelement Value
first-node Prepare
Conditions/GVBufferCondition condition="FilesFound" type="condition"

Property:

name="GVFM_FOUND_FILES_NUM"
operator="greater"
type="gvbuffer-field"
value="0"
value-type="integer"
GVOperationNode dump-in-out="false"
id="list_files"
id-system="GVESB" input="input"
next-node-id="check_files"
op-type="call"
operation-name="ScanAttachments"
output="files"
GVNodeCheck default-id="end-nofiles"
id="check_files"
input="files"
on-exception-id="end"
GVRouting:
condition="FilesFound"
next-node-id="prepare"
ChangeGVBufferNode dump-in-out="true"
id="prepare"
input="files"
next-node-id="send_email"
output="files"

ChangeGVBuffer: clear-data="false"

OGNLScript: property['GV_SMTP_ATTACHMENTS'] = property['GVFM_FOUND_FILES_LIST']
GVOperationNode dump-in-out="false"
id="send_email"
id-system="GVESB"
input="files"
next-node-id="move_files"
operation-name="SendEmail"
output="files"
GVOperationNode dump-in-out="false"
id="move_files"
id-system="GVESB"
input="files"
next-node-id="end"
operation-name="MoveAttachments"
output="files"
GVEndNode end-business-process="yes"
id="end-nofiles"
output="files"
GVEndNode end-business-process="yes"
id="end"
output="files"

Save the editor clicking on the Save icon of Eclipse. Control that there are not errors in the flow and save it in the apposite icon present in the Core View of VulCon®. From the Project view, expand your project, refresh (f5), and right clicking the folder "conf" export your new configuration.

GV Console Configuration

It is time to deploy and test your new Service. To do that execute the following steps:

Deploy new Service

Suppose you have saved the VulCon Configuration file as "$GV_HOME/TEST/REPG1.zip". To deploy the new Service follow this steps:

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

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

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

Now pass to the GV Console section Utility.

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

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

  1. Into the Service voice select TestFileAttachment
  2. Into the System voice select GVESB
  3. Click RequestReply

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 GVFM_FOUND_FILES_NUM property set to 3, representing the number of files found.

The file TestOutput.txt will be generated in the directory $GV_HOME/log as previously set (see Testing, Data input area) containing information about the files found and the email already sent. 

<pre>
----------- TEST N. 0 2012.02.15 at 18:02:32 -----------
Standard Field:
	system   = GVESB
	service  = EmailFileAttachment
	id       = 7F0001014F3BE51400059DBA
	retCode  = 0
GVBuffer: class java.lang.String

Properties:
	messageID = <9388830.11329325352084.JavaMail.gv1@gv.com>
	GVFM_FOUND_FILES_LIST = $GV_HOME/TEST/TESTFS/TestAttach/input/001.txt;
                                $GV_HOME/TEST/TESTFS/TestAttach/input/002.txt;
                                $GV_HOME/TEST/TESTFS/TestAttach/input/003.txt
	GVFM_FOUND_FILES_NUM = 3
	GV_SMTP_ATTACHMENTS = $GV_HOME/TEST/TESTFS/TestAttach/input/001.txt;
                              $GV_HOME/TEST/TESTFS/TestAttach/input/002.txt;
                              $GV_HOME/TEST/TESTFS/TestAttach/input/003.txt
</pre>

Set a new account with the properties:
Server SMTP/POP3

  • SMTP : localhost:3025
  • POP3: localhost:3110
  • Server mailbox: gv1@gv.com (gv1/gv1)
  • Client mailbox: gv2@gv.com (gv2/gv2)
    gv3@gv.com (gv3/gv3)
TestFileAttachment email

You will receive an email as this shown in the picture.


You can also check that the files were moved into the directory $GV_HOME/TEST/TESTFS/TestAttach/sent.

Retrieved from "https://gvwiki.greenvulcano.com/gvwiki/index.php?title=TestFileAttachment&oldid=2455"