10.15.2013 System Development - Rational Solution for Audit Compliance - Reporting

1. ®
IBM Software Group
Reducing risk and cost with
automated document generation
Jennifer Althouse – jalthous@us.ibm.com
Industry Specialist
© 2009 IBM Corporation

2. IBM Software Group | Rational software
Agenda
 What are the documentation challenges?
 Why Rational Publishing Engine?
 Demonstration
IBM INTERNAL
2

3. IBM Software Group | Rational software
What are the documentation challenges?
3

4. IBM Software Group | Rational software
Documentation challenges
Missing
Missing
information
information
Format
Format
inconsistencies
inconsistencies
NonNoncompliance
compliance
with standards
with standards
Corporate
Corporate
branding
branding
errors
errors
Incorrect
Incorrect
legal /standard
legal /standard
text
text
Out-of-date
Out-of-date
documents
documents
Reduced
Reduced
productivity
productivity
Traditional, manual processes can lead to documentation chaos
4

5. IBM Software Group | Rational software
Why Rational Publishing Engine?
5

6. IBM Software Group | Rational software
High Quality, Compliant Documents in minutes
using Rational Publishing Engine
 Document Creation Made
Simple
Usability
 High Quality, Compliant
Documents
 High Performance
Document Generation
Rational
Publishing
Engine
Speed
Flexible
output
6

7. IBM Software Group | Rational software
Rational Publishing Engine: document automation across the
development lifecycle
 Create documents from data across
a wide range of distributed and
diverse data sources
 Access data from a wide range of
Rational tools, including:
 Asset Manager, DOORS,
ClearCase/ClearQuest, Team
Concert, Focal Point, Quality
Manager, RequisitePro, Rhapsody,
Requirements Composer, System
Architect, Tau
 Access data from third party tools
via XML and REST interfaces
Source 1
Source 2
Source 3
…
Source n
7

8. IBM Software Group | Rational software
Linked requirements to model elements
Requirements in DOORS
Requirements in Rhapsody

9. IBM Software Group | Rational software
Generated document

10. IBM Software Group | Rational software
Rational Publishing Engine: document creation made simple
Simple creation of reusable templates
Usability
 Document Studio interface with
intuitive drag and drop template
building capability
 Integrated preview capability
avoids wasted time in validating
template changes
 Powerful scripting language
support (Javascript) with
expression editor for ease of use
 Create single templates to
generate all different types of
output format
10

11. IBM Software Group | Rational software
Rational Publishing Engine: document creation made simple
Simple generation of complex documents
 Launcher interface to quickly and easily control document
generation
Usability
 Also available as a wizard embedded into some data sources
 The user generating the document requires no domain knowledge
 Use out-of-the-box templates for
quick ROI
11

12. IBM Software Group | Rational software
Rational Publishing Engine: high quality, compliant documents
 Template driven document generation ensures the output
complies with any required formatting standards and
contains correct branding and legal information
Flexible
output
 Support for multiple output formats (MS Word, HTML, PDF,
XSL-FO…)
12

13. IBM Software Group | Rational software
Rational Publishing Engine: high quality, compliant documents
 Support for a huge range of
document features
Flexible
output
Richly formatted text
Images
Tables
OLEs
Tables of Contents
Figures & Captions
Headers & Footers
Page size & Orientation
Hyperlinks – Internal or
external
Full multi-cultural support
Conditional formatting
Etc…
13

14. IBM Software Group | Rational software
Rational Publishing Engine - components
New in
RPE 1.2
14

15. IBM Software Group | Rational software
The Central Library
 The Central Library is a data catalog that allows:
 Central definition and maintenance of assets
–
For Example:
–
Templates
–
Style Sheets
–
Snippets
–
Debug, log and runtime settings
–
Variables
–
Variable Sets
 Remote monitoring and control of document generation

16. IBM Software Group | Rational software
Templates & Tutorials
Further resources for you to explore
Tutorials:
Systems Engineering: Reporting on Rhapsody Models with RPE
http://ibmfederal.us/demos/RErpe/
Generating Professional Documentation with Rational Publishing Engine
(DOORS focused)
http://ibmfederal.us/demos/DErpe/
RRC templates: <jazzserver>serverconfrmreportinginitializationtemplatesrrdg
There is one called AuditHistory.dta
RQM Templates : https://jazz.net/downloads/rational-qualitymanager/releases/4.0.4?p=allDownloads
Look in the "Extras" section and you'll see "Sample Quality Management templates
for IBM Rational Reporting for Document Generation (RRDG)"
16

17. IBM Software Group | Rational software
Additional Resources
Further resources for you to explore
 ibm.com/software/awdtools/pubengine/
 Additional Product Information
 Product demonstrations
 Product datasheets
 ibm.com/developerWorks
User Forums
Product tutorials
Tech Notes, etc…
17

18. IBM Software Group | Rational software
Design Partner Program for Medical Devices
Mission: To involve clients early in the design and development process of our solutions to improve
quality, deliver the right strategy and features based on the medical devices industry specific
business problems, increase client satisfaction and loyalty, and secure references.
What is it?
What is it?
 Small set of select clients
invited to participate
 Long-term relationship
 Meetings on a recurring
basis
 Collaboration between
Rational Offering,
Strategy and Delivery
teams and our clients
regarding future solution
features, capabilities and
strategies
Geared towards
Geared towards
Clients who…
Clients who…
 Have a large, vested
interest in the success of
Rational solutions in their
IT environment
 Are forward thinking and
innovative
 Want an ongoing working
relationship with Rational
 Have a desire to ensure
their industry business
problems are heard
Results in
Results in
 Solutions that our clients
are excited about and
committed to because
they have exerted
considerable influence as
part of the development
process
 Rational and clients both
benefiting from working
together to make industry
solutions more valuable
and relevant
 Facilitates ability to solicit
and incorporate feedback
Would you be interested in either joining this one or creating a DPP for your industry?
18

19. IBM Software Group | Rational software
Show link to IEC sections
Summary - Automate Document Generation
Generate the right document at the right time
Compliance is determined by inspection of all documentation
required by this standard including the RISK MANAGEMENT
FILE, and assessment of the PROCESSES, ACTIVITIES and
TASKS required for the software safety class.

This standard does not prescribe the name, format, or
explicit content of the documentation to be produced…
the decision of how to package this documentation is left
to the user of the standard.
Increase productivity by allowing
engineers to focus on engineering
 NOT formatting concerns

Maintain accuracy through quick
one-click document generation
 Captures last minute changes from
data held in different source
applications

Enhance documentation quality thru
template reuse
Rational Publishing Engine
19

20. IBM Software Group | Rational software
Questions?
© Copyright IBM Corporation 2009. All rights reserved. The information contained in these materials is provided for informational purposes only, and is provided AS IS without warranty of any
kind, express or implied. IBM shall not be responsible for any damages arising out of the use of, or otherwise related to, these materials. Nothing contained in these materials is intended to, nor
shall have the effect of, creating any warranties or representations from IBM or its suppliers or licensors, or altering the terms and conditions of the applicable license agreement governing the use
of IBM software. References in these materials to IBM products, programs, or services do not imply that they will be available in all countries in which IBM operates. Product release dates and/or
capabilities referenced in these materials may change at any time at IBM’s sole discretion based on market opportunities or other factors, and are not intended to be a commitment to future product
or feature availability in any way. IBM, the IBM logo, Rational, the Rational logo, Rational, the Rational logo, and other IBM products and services are trademarks of the International Business
Machines Corporation, in the United States, other countries or both. Other company, product, or service names may be trademarks or service marks of others.