[jboss-jira] [JBoss JIRA] Closed: (JBESB-324) Review the helloworld_file_action readme.txt

[Esteban Schifman (JIRA)]

     [ http://jira.jboss.com/jira/browse/JBESB-324?page=all ]

Esteban Schifman closed JBESB-324.
----------------------------------

    Resolution: Done

Last comment regarding post directory excluded from readme.txt.  The rest is fine

> Review the helloworld_file_action readme.txt
> --------------------------------------------
>
>                 Key: JBESB-324
>                 URL: http://jira.jboss.com/jira/browse/JBESB-324
>             Project: JBoss ESB
>          Issue Type: Task
>      Security Level: Public(Everyone can see) 
>          Components: Examples
>    Affects Versions: 4.0 CR2
>            Reporter: Burr Sutter
>         Assigned To: Esteban Schifman
>             Fix For: 4.0 CR2
>
>
> Please review the contents of the readme.txt in the helloworld_file_action quickstart.  Specifically the section that tries to describe the attributes of the fs-message-filter tag.
> It is pasted below but if you need to make edits please update the one in SVN directly.
> Overview:
> =========
>     This is a basic example of using the File gateway feature of the JBoss ESB
>     Files that are found in a particular directory with a particular 
>     extension are sent to a JMS queue with actions for processing.
>     
> Before Running:
> ===============
>     1.	Update the "jbosshome.dir" property in the quickstarts.properties file in "../".
> 	  2.	Make sure the jbossesb.sar is deployed on your JBoss Application Server.
> 	  3.	Make sure the JBoss Application server is running since it uses JBossMQ
> 	  4.  Open the jbossesb.xml configuration file and review this section:
> 	         <fs-bus busid="helloFileChannel" >
>           		<fs-message-filter
>           			directory="C:/tmp/ESBInput"
>           			input-suffix=".dat"
>           			work-suffix=".esbWorking"
>           			post-delete="false"
>           			post-directory="C:/tmp/ESBInputt"
>           			post-suffix=".sentToEsb"
>           			error-delete="false"
>           			error-directory="C:/tmp/ESBInput"
>           			error-suffix=".IN_ERROR"
>           		/>
>           	</fs-bus>
>           	
>     You will need to create a tmp/ESBInput directory or modify this section of 
>     jbossesb.xml
>     5.  If you change these settings make sure to also change the build.xml's runtest target
>     
> To Run:
> =======
> 		1.  In a command window type "ant run". You will see the service get registered in the 
> 		JBoss AS server console as well as by the activity in the command window where the service
> 		runs.
> 		2. Open another command window and type "ant runtest".  This will create a new file called
> 		"MyInput.dat" in the directory "/tmp/ESBInput" with the contents "Hello World In A File"
> 		3. You should see the output on the first command window running the service.
> 		4. Change the file name and contents and re-test.
> 		
> What to look at in this Quickstart:
> ===================================
> 		This example demonstrates the use of a file gateway that by default loads the file 
> 		and pushes into a JMS message queue. What follows is a more detailed discussion on the 
> 		file gateway:
> 		
>         * directory - the directory to be monitored for input file messages
>         * input-suffix - the file extension to be monitored, other files will be ignored
>         * work-suffix - the file extension that is used while the file is "in process" by the
>         ESB.  The file is considered to be "in process" while the gateway is passing it into
>         the ESB listener/service (in this case JMS queue).
>         * post-delete - "true" or "false". The file can be removed once has been successfully 
>         processed.
>         * post-directory - The place where the "processed" file ends up assuming no errors
>         and assuming post-delete="false"
>         * post-suffix - The file extension that is used to mark the file as "completed" 
>         * error-delete - "true" or "false". If there is an internal error and the file fails to
>         be loaded by the ESB, delete it. 
>         * error-directory - The place to drop any file that fails to be uploaded/processed
>         * error-suffix - The file extension that is used to mark a file has had an internal error.
>         Note: Error processing in this case means the file failed to pass through the gateway
>         and into the waiting queue.  This does NOT cover errors/exceptions in your action classes.
>         
>     

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira