Trailblazer example documentation improvments
---------------------------------------------
Key: SOAG-77
URL:
https://jira.jboss.org/jira/browse/SOAG-77
Project: SOA Governance
Issue Type: Task
Security Level: Public (Everyone can see)
Affects Versions: 1.0 MR1
Reporter: Jeff Yu
Assignee: Mark Little
Fix For: 1.0 MR2
Thanks Jeff Delong for following suggestions and feedback.
------------------------
A few suggestions on how to improve the documentation:
1) Have the readme refer to the docs/samplesguide/SamplesGuide. While much of the
information is redundant, the SamplesGuides has the information on the ChoreographyMonitor
and the error-client.
2) In the SamplesGuide.pdf, the code snippet from LoanBroker.java is unreadable.
3) Under 10 2 It says to run the commands from step 6 on. Is that really necessary?
4) Add more information on the role of the LoanBroker.java class, and how it's choice
of
if (score >= 4) {
//step 3a - send to Bank - async
System.out.println("sending to first Bank...");
sendToBank(bank1Invoker, customer, "b1");
Implements the Choreography conditional expression:
cdl:getVariable('creditCheckResult','','//@score') >= 4
5) It would be nice to have an architectural discussion here about how this choreography
is being monitored. (perhaps this is described in another document I have yet to read).
--------------------
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira