Whats New in Rational Publishing Engine V2.0.1
Dragos Cojocari, Architect, Rational Publishing Engine An IBM Proof of Technology
Contents Reporting and Document Generation Overview Rational Publishing Engine Summary Rational Publishing Engine Overview Additional Information 1 Go to 'View > Header and Footer' to change this to match the event title 1 RPE 2.0 Release Overview Rational Publishing Engine 2.0
Improve value for project teams and document controllers with enhancedautomation, template development, formatting, and performance Rational Publishing Engine 2.0 All new Web UI to improve every ones experience producing high fidelity project documents No coding knowledge or additional configuration required Built-in library support Report designers can quickly create reports from existing or upload new templates. Templates can be reused in other documents Find the assets that you want to work with by tagging, pagination, sorting or searching. Source 1 Source 2 Source 3 Source n RPE 2.0.1 Release Overview Rational Publishing Engine 2.0.1
Improve value for project teams and document controllers with enhancedautomation, template development, formatting, and performance Rational Publishing Engine 2.0.1 Continue the work started with 2.0 Improve Team support Share artifacts Promote documents Improve usability of 2.0 Simplified installation Group artifacts Core capabilities update Aspose upgrade Stabilize the new components Source 1 Source 2 Source 3 Source n RPE WebServices 2.0.1 Architecture
Components dgaas.war rpeng.war Packaged as .ear for Liberty and WAS deployments ( this is the preferred option) Deployment ear for Liberty/WAS Individual wars for Tomcat Same server Different servers - DGAAS_URL variable needs to be defined on each RPENG server com.ibm.rpe.web.app.ear RPE NG (rpeng.war) Web UI Document Storage Asset Storage DGaaS (dgaas.war) licensing doc gen no UI use RRDG Installing RPE 2.0.1 RPE 2.0.1 Installer
IM Supports 32 and 64 bit installations For 64 bit Linux platforms we onlysupport 64 bit versions Bundles Java 7 RPE Web UI - Manual installation Deploy the ear/war files Setup the Tomcat/Liberty/WAS shared library for license Define users and roles Define the system variables required by DGAAS to access RPENG DGAAS_USER, DGAAS_PASSWORD, DGAAS_AUTHENTICATION BASE_URL in the Admin page is required forand scheduling capabilities (Recommended) configure RPE to use DB2 instead of the built-in Derby (Recommended) use Liberty/WAS profile for production deployment Licensing in RPE 2.0.1 Uses the existing RPE_PUBLISH license feature
Clients must refresh their license to comply with the date based mechanism of RCL Requires RCL 1.8.4 No changes for existing clients RPE 2.0.X Web Services and Web UI A license is consumed as long as the Web UI is open A separate license is consumed while a document generated Installation cheat sheet for the RPE Web UI
Tests Clear browser cacheon client machines http(s)://server:port/dgaas/debug to check DGaaS is up and running Log in RPENG with your admin account and in the Admin page under System Health check that all is green Use Create examples from the design page to verify RPENG and DGaaS work together properly Run one of the examples and download the generated documents Logout and log back in as a different user. Troubleshooting rpeng.log and rpedgaas.log in %TEMP% folder Admin page list of failed jobs View page job details Clear browser cache - mandatory when upgrading from 2.0 to 2.0.1 RPE Web UI - Simpler Document Generation
Easy access UI for Generating and Using your existing document reports Simple approach for infrequent project team members Quickly design new reports that can be shared with the whole team Noteworthy No changes since 2.0 Worth mentioning
The Design tab is not visible to users that do not have the report designer role The name shown in the top right corner is the user ID if using the default Form authentication or the JTS user name if RPE is configured to use JTS for authentication RPE Web UI - Document Viewer
Quick document generation dashboard to access newly created document reports Download to local drive to share with wider team Check overall status for mandatory reports Noteworthy Whats new Worth mentioning
Multiple selection for tagging and deleting multiple documents Group by tags/name Share make the document available to everyone else Promote prevent the document from being deleted by the scheduled cleanup daemon Show link Worth mentioning The search box on the top right page only searches the current page of data The Group option does not persist between screen changes RPE Web UI - Document Generation
Document Progress indicated to show overall completion Generate new documents on demand Documents are generated from preconfigured reports Notifications given for document completion and readiness Noteworthy Whats new Worth mentioning Multiple selection for tagging
Group by tag Show link interesting for the dashboard widget Worth mentioning The search box on the top right page only searches the current page of data The Group option does not persist between screen changes Tagging in this screen ( if you are a report designer) will tag the report not the documents RPE Web UI - Run dialog Noteworthy Whats new Worth mentioning
Tag and share options when you start the document generation Worth mentioning Changed from 2.0.1: the data source screen is shown for all reports even if they do not have data sources Report Design Simple Design steps for reusable document reports
Organise reports using Tags Advanced Report Design
Full control for the report designer Noteworthy Whats new basic report configuration
Multiple selection for tagging and deleting Group by tag Show link Whats new advanced report configuration Document extension Worth mentioning The search box on the top right page only searches the current page of data The Group option does not persist between screen changes Use create the examples button for quickly testing that all works well Open Social Gadgets Embed RPE capabilities (ex: CLM like dashboards) Noteworthy Worth mentioning
For the widget to work the RPE admin must define the CORS_DOMAIN Java property for the RPE Web App. Example: CORS_DOMAIN=https://giediprime:9080/ The CLM admin maintaining the widget can get the report URL using the new Link buttons for the report from the Generate View More than one widget can be embedded The admin can specify in the widget preferences if the result is shared Using JTS for authentication to RPE
Prerequisites Deploy RPENG in an HTTPS enabled application container Define 1 admin user Login in RPENG Go through the Installation Cheat Sheet list to verify all is up and running Register RPE as an application in JTS RPENG Discovery URL: https://qualified.hostname.com:port/rpeng/scr Search for JTS authentication Configure RPE to use JTS for authentication In RPE go to the administrative page ( click on Administer below your user name) Select the Runtime Variables tab Change the Authentication Type to AUTH_TYPE_JTS Add at least 1 JTS user id in the RPE_WEB_ADMIN_USERS property Save ( do not save before) You will be logged out of RPE and the JTS authentication page will be shown RPE with JTS - Results What it does What it doesnt do Notes
You can log in with your JTS user name and password through the JTS login dialog Your name, as defined in JTS, will show on the top right corner Your, as defined in JTS, will be visible in the settings dialog The View Profile link under you user name is active What it doesnt do authenticating to JTS will not grant RPE access to your CLM data. You still need to provide your credentials in the report configuration Notes When you logout the screen will go blank for a few seconds before showing the login screen All users are report designers if the designer list is empty in the Administrator/Runtime Variables page Improvements to RRDG and desktop RPE
Output Aspose upgrade Macros are stripped from .docx documents Support for password protected images and documents Improved table layout XHTML support improvements RPE does not claim full support for XHTML. Studio Debugger can be configured not to visually select elements (speed up the process) Know defects, issues and limitations
RPE Launcher/Studio cannot work with the RPE WebServices 2.0 RPE WebServices 1.0 and RPE WebServices 2.0 will be merged in a future release When upgrading to the browser cache must be cleared to avoid using cached .js/.css files with 2.0.1 PDF performance decreased by 15% (less in real production environment) The PDF serialization time is only a small fraction of the overall document generation time. Most time is spent fetching data Bidi support is limited to Word output RPEdesktop and web UIs are not fully accessible RPE will create a number of temporary files in the temp folder that need to be manually cleared Best practices for the RPE Web Services 2.0
Report designers name and tag the reports consistently test the report in draft mode before publishing it Provide meaningful labels and descriptions to data sources Hide variables & data sources where applicable End users Tag your documents consistently Administrator Configure RPE with JTS Deploy the RPE widget in the CLM dashboards as needed 2626 2626 26 Find More Information Try out the new RPE in our sandbox environment (Bluemix): https://rpe.mybluemix.net/home RPE Information Center: 2.0 Public: 2.0.1 Internal: Rational Publishing Engine Blog: Evaluation / Trial Download:coordinated through IBM Sales evaluation / trial license keys needed separate download site To post questions visit Rational Publishing Engine Forum: https://jazz.net/forum/tags/rpe/ 26 Thank You JRS 6.0 Export to RPE Getting started with RPE 2.0.X
Login with a user with rpe_designer role Navigate to the Design page and use the Click here to generate examples link From the Generate page run the News Glimpse example. Select the BBC World News Feed Connection when prompted. The Learn page especially Get started with document generation Artifacts in RPE 2.0.X Artifacts Create, use and reuse
Templates*, stylesheets** Connections - associate a human readable label for a URI Reports equivalent of DSX files Create, use and reuse Upload templates and stylesheets Define connections Combine the above in reports *Document Studio is required to design and modify templates. **Microsoft Word is required to design and modify stylesheets. Working with Artifacts
Templates, Stylesheets, Connections Reports Templates and Stylesheets are uploaded Designer can change name, description and tag the artifacts Additional properties are available for connections: URI, authentication, configuration Best practices Use meaningful names for assets Provide descriptions Use a consistent tagging scheme Use tags Reports are created* in the 2.0.X Web UI Basic report view quick assembly of report Advanced view fine tuning of the report Best practices A report should require a minimum of effort from the end user Reports are created in draft mode and should be kept in Draft mode until testing and peer review are complete Re-label data sources and variables to make them more meaningful Associate connections with the data sources Hide data sources and variables that users do not need/should not modify *Uploading DSX files is not supported in RPE 2.0 Artifacts in RPE 2.0.X - Reports
Basic Report View Advanced Report View Working with documents
Search existing documents Generate a document immediately Schedule a document for execution Best practices Search if the document is already available before generating Tag the documents in a consistent manner Delete old documents Working with Documents Existing Documents
Find a previously generated document in the Documents page Search the documents on the page using the quick search Search all the documents with the advanced search Quickly find all the document generated for a report from the View Generated Documents action in the Generate page Working with documents - Generate
Finding the report to run Search the reports on the page using the quick search Search all the reports with the advanced search Generating a document Choose the connections for the reports data sources and provide your credentials Provide values for variables A document can be requested immediately or schedule for a later time Other tools for the end user
notifications Receive anwith a link to the document when its ready Not needed if RPE 2.0 is configured to use JTS for authentication Requires the administrator to configure server Notifications Review the outcome of recent document generation jobs