Bug 1157468 - Contradicting statements on the same page
Summary: Contradicting statements on the same page
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: JBoss BPMS Platform 6
Classification: Retired
Component: Documentation
Version: 6.0.3
Hardware: Unspecified
OS: Unspecified
unspecified
high
Target Milestone: CR2
: One-off release
Assignee: Vikram Goyal
QA Contact: Jiri Svitak
Vikram Goyal
URL:
Whiteboard:
: 1121708 (view as bug list)
Depends On:
Blocks: 1157869
TreeView+ depends on / blocked
 
Reported: 2014-10-27 10:13 UTC by Andrea Ubbiali
Modified: 2015-06-02 01:36 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
: 1157869 (view as bug list)
Environment:
Build Name: 22688, User Guide-6.0-1 Build Date: 22-09-2014 06:10:00 Topic IDs: 13580-592078 [Specified]
Last Closed: 2015-04-16 21:50:49 UTC
Type: Bug
Embargoed:


Attachments (Terms of Use)

Description Andrea Ubbiali 2014-10-27 10:13:06 UTC
Title: Collaboration mechanisms

Describe the issue: Documentation in this paragraph is inconsistent and unusable


Suggestions for improvement: REWRITE maybe? also, the whole section does not seem to have been spell checked.

Additional information:

This is in the BPMS 6 User Guide

To be more specific

in A.3 "Messages: intended primarily for communication with other systems especially if a complex data type is required (it is possible ton define a Message structure that can become a process variable"

and then, an few lines below,

in 

"Messages are ment for inter-Process communication, not for communication with other external systems" 

SO WHICH STATEMENT IS TRUE??

in general there is no how-to documentation on this subject: nowhere in this User guide is it explained how to send and receive messages (or signals??) with DATA, and how they are correlated.  And nowhere in the developer's guide either.

Comment 2 Vikram Goyal 2014-10-27 10:25:14 UTC
Thanks for reporting this Andrea.

I am looking into it and will update it shortly.

Comment 3 Vikram Goyal 2014-10-27 23:32:55 UTC
Andrea. Once again, thanks for reporting this. I have had a better look at this.

I agree, we should provide info about how to use signals and messages and to do that I have created a separate bug to track the work [2].

I have removed the following statement:

"Messages are ment for inter-Process communication, not for communication with other external systems"

and also fixed many typos in those two sections. This work can be verified starting here [1].

Once it has been verified, I will update the docs on access.redhat.com with an async release.

[1] https://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_JBoss_BPM_Suite/6.0/html-single/User_Guide/index.html#sect-Collaboration_mechanisms

[2] https://bugzilla.redhat.com/show_bug.cgi?id=1157869

Comment 4 Jiri Svitak 2014-10-29 15:44:06 UTC
freely citing Maciej:

Messages are actually implemented as signals which makes them scoped only for given ksession so only communication within the process and between process instances.

For external system interaction send and receive task should be used with proper handler implementation. WorkItemHandler is the interface to implement and will be technology dependent (JMS, REST, WS, ..). Send and receive task implementation should require simple message object in contrary to 'ordinary' user specific service task implementations of WorkItemHandler interface.

Comment 5 Vikram Goyal 2015-04-16 00:47:21 UTC
Jiri - sorry for the delay in this. But I have fixed the text in the colloboration mechanisms chapter to clarify the definition of Messages from Maciej. This can be verified here [1].

Moving this back to ON_QA.

[1] https://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_JBoss_BPM_Suite/6.0/html-single/User_Guide/index.html#sect-Collaboration_mechanisms

Comment 6 Jiri Svitak 2015-04-16 09:27:27 UTC
Thanks Vikram, verified.

Comment 7 Vikram Goyal 2015-05-06 01:52:12 UTC
*** Bug 1121708 has been marked as a duplicate of this bug. ***


Note You need to log in before you can comment on or make changes to this bug.