SOADocPlan
Documentation Plan for NetBeans 6.0 SOA Pack
Last Revised: July 27, 2007
Contents |
Introduction
This plan describes the documentation deliverables for the SOA part of NetBeans IDE 6.0 (Beta and FCS releases).
- This plan is a subset of the NetBeans 6.0 Umbrella Doc Plan.
- SOA Tutorials Doc Plan.
- SOA Runtime Doc Plan
For NetBeans 6.0, the SOA functionality includes the following:
Design Time
- BPEL Designer
- XSLT Editor
- CASA Editor
- Cross-Project XML References
Runtime
JBI Components provided with Application Server:
- BPEL SE
- Java-ee SE
- SQL SE
- XSLT SE
- File BC
- HTTP BC
- JMS BC
Developer information about the SOA functionality in the IDE.
BPEL Designer
The BPEL Designer is a tool integrated in the Netbeans IDE for editing, compiling, and deploying BPEL processes compliant with the WS-BPEL 2.0 specification.
BPEL Designer Features
After the NetBeans 6.0 Preview release in May, no new major features are planned for BPEL Designer in NetBeans 6.0 FCS.
Documentation Deliverables
The following table lists the documentation deliverables that will be updated or created for the BPEL Designer feature of NetBeans 6.0. The Target Publication Milestone column lists the milestone releases for which a deliverable will be updated.
The Priority column indicates the following priorities for specific deliverables:
1 Top priority
2 Secondary priority, the target publication milestone can slip
3 Defer until after FCS
| Deliverable Title | Priority | Target Publish Milestone | Owner | Status | Comments |
|---|---|---|---|---|---|
| Online Help | |||||
| Online Help goes to enterprise\bpel\bpelhelp\javahelp | 1 | Beta 2, FCS | Irina | 6.0 Preview version exists | > 90 topics; update as needed for new features |
| Guide | |||||
| Developer Guide to the BPEL Designer | 2 | Beta 2, FCS | Irina | 6.0 Preview version exists | 12 chapters; update as needed for new features |
| Existing Tutorials | |||||
| Understanding the Travel Reservation Service | 1 | Beta 2, FCS | Irina | 6.0 Preview version exists | Update to match the UI; demos to be updated |
| A Simple Synchronous BPEL Process | 1 | Beta 2, FCS | Irina | 6.0 Preview version exists | Update to match the UI |
| A Simple Asynchronous BPEL Process | 2 | FCS | Irina | 6.0 Preview version exists | Update to match the UI |
| Refactoring in a BPEL Module Project Using NetBeans Enterprise Pack | 2 | FCS | Irina | 5.5 version exists | Major changes from 5.5 to 6.0 |
| Using Correlation Sets, Properties, and Property Aliases | 2 | FCS | Irina | 6.0 Preview version exists | Update to match the UI |
| Using the BPEL Mapper to Edit BPEL Processes | 2 | FCS | Irina | 5.5 version exists | Update to match the UI and introduce new features |
| Designing a Product Delivery Process | 3 | post-FCS | Irina | New tutorial based on a sample application from QE | Only post-FCS if resources are available |
| Technical Article | |||||
| XPath Functions and Operations | 2 | FCS | Irina | 6.0 Preview version exists | Update if needed |
CASA Editor
The CASA Editor, or the Composite Application (Service Assembly) Editor, allows users to edit the deployment configuration of a JBI Service Assembly. It provides support for common editing scenarios, such as adding and modifying concrete WSDL elements, adding and removing service connections between Service Units, and connecting to endpoints of external Service Units.
New Features for NetBeans 6.0 FCS:
- JavaEE SE support
- Drag-n-drop of NetBeans JavaEE projects into CASA
- Connect JavaEE service unit endpoints with other endpoints
- BC-BC support
- Allow BC-to-BC connection be made within CASA
- Generate deployment artifacts needed to support BC-BC connections
- Project plug-in framework
- Allow external SE SU project to plug-in project specific extensions
Documentation Deliverables
The documentation development for this release will be focused on providing both task-based and conceptual information about the CASA Editor.
The Priority column indicates the following priorities for specific deliverables:
1 Top priority
2 Secondary priority, the target publication milestone can slip
3 Defer until after FCS
| Deliverable Title | Priority | Target Publish Milestone | Owner | Status | Comments |
|---|---|---|---|---|---|
| Online Help | |||||
| Online Help goes to enterprise/compapp/casaeditor | 1 | Beta 1(done), Beta 2, FCS | MJ | Done for Beta 1 | > 10 topics; Make existing help more robust. Add context to the help. |
| Guide, Video, Article | |||||
| TBD | 3 | post-FCS | MJ, (Vince) | New | To provide conceptual background to the CASA Editor. Illustrate concepts with an article to be accessed via the SOA learning trail. |
| Tutorials | |||||
| Quick Start Guide to CASA Editor | 2 | Beta 1, Beta 2, FCS | MJ | Done for Beta 1 | A simplified quick start guide |
| Using Advanced Features of the CASA Editor | 2 | FCS | MJ | New | Cover Drag 'n Drop, connecting to external Service Units, and other advanced features |
| Using BC to BC Feature of the CASA Editor | 2 | FCS | MJ | New | Illustrates the new BC to BC feature |
Detailed CASA Editor Doc Plan (Sun internal link)
(Public link to detailed CASA Editor Doc Plan to be available soon.)
XSLT Designer
The XSLT Designer is used to develop, deploy and test XSL Transformation Services.
New Features for NetBeans 6.0 FCS:
- Added predicates
- New transformation descriptor structure
- Some changes in the XSLT Service wizard (rel. point 2)
- New Transform Map navigator node structure (rel. point 2)
- Multi-view editor for transformation descriptor (source and tree views)
- Transformation processes - a sequential list of activities can be executed as a transformation process
- Transformation by part - XSL stylesheets can now be applied to individual message parts, referenced by name, and explicitly assigned to other messages.
- Runtime parameter support - values for parameters defined in XSL stylesheets can be provided during application of the transformation.
- Service Bridge terminology is obsolete
Documentation Deliverables
Documentation for NetBeans 6.0 primarily will be about updating existing documentation and tutorials from the NetBeans 6.0Preview release.
| Deliverable Title | Priority | Target Publish Milestone | Owner | Status | Comments |
|---|---|---|---|---|---|
| Online Help | |||||
| Online Help | 1 | Beta 2, FCS | MJ | 6.0 Preview version exists | > 25 topics; Update as needed to reflect new features. |
| Tutorials | |||||
| XSLT Designer Quick Start Guide | 2 | Beta 2, FCS | MJ | Done for Beta 1 | Update to reflect new features |
| Working With a Service Bridge XSL Transformation Service | 2 | Beta 2, FCS | MJ | Done for Beta 1, but not included due to bug | Update to match the UI (Service Bridge Terminology is obsolete) |
Cross-Project XML References
The Cross-Project XML references feature enables creating references through various projects in the IDE. The IDE online help to cover high-level overview. The writer will work with docs team to ensure updates to topics in other help modules.
| Deliverable Title | Priority | Target Publish Milestone | Owner | Status | Comments |
|---|---|---|---|---|---|
| Online Help | |||||
| Online Help | 1 | Beta 2, FCS | MJ | 6.0 Preview version exists | > 10 topics; Update as needed to reflect new features |
| Tutorial | |||||
| TBD | 2 | Beta 2, FCS | MJ | New | Need to locate any existing projects from developers that illustrate this feature |
Blueprints
As discussed with the development team, the blueprint samples are being tested and will remain packaged in the IDE. Updating the existing 5.5 tutorials on the blueprint samples will be possible only if docs have enough resources to do this until FCS.
See the BPEL Blueprints for NetBeans 5.5 here.
Technical Articles
Updating of the existing technical articles that apply to the 5.5 and 5.5.1 releases is TBD. The plan for new technical articles is TBD and will be added later. The plan for delivering technical articles needs to be discussed further with the development team and scheduled for resources.
Method of Delivery
| Title | Delivery Mechanism | Format |
|---|---|---|
| Tutorials | NetBeans.org; Integrated into netbeans cvs repository (for publication on www.netbeans.org) | HTML |
| Online Help | IDE; Integrated into uml project in netbeans cvs repository | JavaHelp |
| Technical Articles | NetBeans.org; integrated into www cvs repository | HTML |
| Blueprints | https://blueprints.dev.java.net/bpcatalog/ee5/soa/; packaged as sample apps in the IDE | HTML |
Schedule and Milestones
The schedule of SOA documentation deliverables will follow the overall NB 6.0 documentation deliverable schedule, as outlined in the Milestones section of the NB 6.0 Umbrella doc plan.
Revision History
- Jul 19, 2007: Updated XSLT Designer Section
- Jul 18, 2007: Initial Version
- Jul 27, 2007: Updated with the information about blueprints
