Bug 778572 (SOA-1044)

I've moved this back to release, no time to get this done for 4.2.CP03

But someone of course still needs to QE this for 4.2.CP03 

cleaned up code samples in 2

*improved presentation of "out-of-box actions"
*cleaned up & added syntax highlighting to all code-sampes

On the title page:

------------
JBoss Enterprise SOA Platform 4.2 SOA ESB Message Action Guide
JBoss Enterprise SOA Platform Edition 1.3
------------

What is the reference to 1.3?

Note - the doc is missing its revision page.

=========================================

1.1.2. LongToDateConverter

It looks like this actin was deleted:
https://cloud.prod.atl2.jboss.com/jira/browse/JBESB-152;jsessionid=BE9600515828DE2DBD08A8BD0C8F39BE?page=com.atlassian.jira.ext.fisheye%3Afisheye
-issuepanel

It's not in the ESB source or javadocs - I'll check with Mark and Kevin.

=========================================

1.1.3. ObjectInvoke

We should also state which properties are required/optional - from the javadocs:

 <Action name="doCustomer" processor="ObjectInvoke">
     <property name="class-processor" value="CustomerProcessor" /> <!-- Required. Class processor used to process the message . -->
     <property name="class-method" value="fooMethodName" /> <!-- Optional. Default to name of action. -->
 
 </Action>
 
=========================================

1.1.4. ObjectToCSVString

We should also state which properties are required/optional - from the javadocs:

 <Action name="Customer-To-CSV" processor="ObjectToCSVString">
     <property name="bean-properties" value="name,address1,address2,phone" />
     <property name="fail-on-missing-property" value="true" /> <!-- (Optional) Default of false. -->
 </Action>
 

=========================================

1.1.8. XStreamToObject

exclude-package is also optional - from the javadocs:

 <Action name="doCustomer" processor="XStreamObject">
     <property name="class-alias" value="Customer" /> <!-- Optional. Class alias used in call to XStream.alias(String, Class) prior to deserialisation. -->
     <property name="incoming-type" value="CustomerProcessor" /> <!-- Required. Class for incoming type used to process the message after  deserialisation. -->
     <property name="exclude-package" value="false" /> <!-- Optional. Default "true".  Not applicable if a "class-alias" is specified. -->
     <property name="root-node" value="/root/Customer" /> 
     <!-- Optional. Specify an XPath expression be used to determine the root node used with XStream. 
     Useful when the object to convert is not the root node of the document -->
     <property name="aliases"> <!-- Optional list of extra aliases to add to XStream  -->
                <alias name="aliasName" class="className" /> 
                <alias name="aliasName" class="className" /> 
                ...
     </property>
     <property name="converters"> <!-- Optional list of converter to register with XStream  -->
                <converter class="className" /> 
                <converter class="className" /> 
                ...
 </Action>
 
What about the optional converters?

=========================================

1.2.1. jBPM - BpmProcessor

JBossESB can make calls into jBPM using the BpmProcessor action. Please also read the
jBPIntegrationGuide to learn how to call JBossESB from jBPM.

Should be: "also read the jBPMIntegrationGuide (SOA_ESB_JBPM_Integration_Guide.pdf)"

StartProcessCOmmand

Should be: StartProcessCommand

These two API commands:  setProcessInstanceVariables, getTokenVariables 
are not documented in the SOA_ESB_JBPM_Integration_Guide.pdf doc - I think
we should remove them from this doc too.

=========================================

1.3.5. Notifier

The code example includes "@" characters. These are used to substitute strings
from variables and is used in several of the quickstarts. In this example, however,
it may cause some user confusion. I'd just remove the "@" characters.

=========================================

1.3.5.3. NotifySQLTable

The SqlGatewayListener also requires a timestamp field - see https://jira.jboss.org/jira/browse/SOA-1111

Assigning back to Darrin to make the edits

resolved by mistake

I reviewed the WS-related parts of the document and found the following:

- The chapter 1.4.1 mentions a webservice_jbossws_adapter_01 quickstart that I was not able to find anywhere in SOA-P.
- "SOAP Response Message Consumption", p19: "The SOAP response object instance *can be is* attached..."

1  - its the version number of the book
2 - FIXED
3 - need confirmation that LongToDateConverter is removed.
4, 5 - Marked all properties with "required"/"optional"/"optional, defaults to "
6 - the 4.2.cp03 (CR5) javadocs don't show the optional converters.  4,3 does.  Can you check this, maybe added since CR5 ?
7 - FIXED, also reworded first paragraph slightly to help translation, please confirm is still appropriate.
8 - removed @
9 - I'm a little confused by SOA-1111 & related JIRAs.  Is the timestamp field supposed to be optional, or is that a bug in this release that will be fixed in CP04 ?

One more change to make:

Len DiMaggio wrote:
>    Did we delete the LongToDateConverter action? It's referenced in the 4.2 CP03 message action guide - but I can't find it in the release...or the ESB javadocs either.

It is a test action and should not be in the docs nor the release.  We
need to remove it from the docs if it is there.

        Kev (Conner)

Hey Darrin - almost done!

1 - OK
2 - OK
3 - See previous comment ^ from my by way of Kevin
4, 5 OK
6 - It's not there in CR7 too - let me make sure that they (the optional converters) do not exist until 4.3
7 - OK
8 - OK
9 - The bug will not be fixed for 4.2 CP03 - so don't change the doc - the user will have to look in the rel notes - the bug is that the field should be optional, but it is not in 4.2 CP03

Updated docs are here:
https://svn.corp.jboss.com/repos/soa/branches/4.2.0/build-tools/docs

Page 17 (sheet 25/34), code sample at the bottom of the page:
<soapenv:Envelope         xmlns:soapenv="http://schemas.xmlsoap.org/soap/
envelope/"

If there wasn't such a big space in the first line, boht lines could have been placed into one and the whole sample could have been able to be placed on the same page.

FIXED removed LongToDateConverter content
FIXED neatened up 2nd code sample on P17

Verified fixed at Jan 12 doc version in: https://svn.corp.jboss.com/repos/soa/branches/4.2.0/build-tools/docs

Closing for 4.2 CP03