New & Noteworthy for IBM Engineering Lifecycle Optimization - Publishing 7.0

Folder enhancements (Document Builder) Create and select folders

You can now create a new folder when selecting a folder (in the Select Folder window). You can also select a folder when creating a report or schedule, uploading an asset, or generating a document.

Image of creating a new folder in the Select Folder window when uploading an asset:

Image of selecting a folder when uploading a template:

Image of the newly added folder selected when uploading a template:

Image of an expanded folder containing the uploaded template:

Image of selecting a folder when generating a document:

Image of selecting a folder when creating a schedule:

Image of selecting a folder when designing a report:
Drag and drop assets, delete assets, and copy assets from one folder to another

You can now drag and drop folders and assets from one location to another, to organize and move them with less effort. This feature is available on all tabs of the Design page as well as the Generate and View pages. Simply drag the asset towards the destination folder to move the folder or asset to its destination.

Image of a test template being dragged to a test folder:

You can also delete folders and copy assets from one folder to another.

Image of a selected folder and a template being copied to a target folder:

Image of the copied folder:

Image of a folder and template selected for deletion:
Group by folders - new installation

You can now group artifacts by folders in the Design and Generate pages. Any artifacts not grouped will appear in the default folder that is named "Ready-to-use Assets". You can also generate sample assets and view them under the default folder.

Image of the Group by Folders filter and Ready-to-use Assets folder:

Create folders - new installation

When you choose to group artifacts by folders, the Create folder icon is visible. Click the icon to create a folder.

Image of the Create folder window:

When you save the folder, a new folder is created under that tab.

Image of a newly created folder:

Nest folders

You can also create nested folders by selecting an existing folder's checkbox and creating a new folder. A nested folder with the previously selected folder as its parent is created.

Image of creating a nested folder with the parent folder selected:

Image of a nested folder:
Move assets from one folder to another

You can now move assets, reports, documents, or schedules from one folder to another.

Image of the Move icon above a list of templates, with a template selected:

Image of selecting a folder to move the template to:

Image of the template moved to a different folder:
Desktop client Add icons to the table of contents for HTML output

In split HTML output, you can now add icons to the table of contents.

Image of an icon in the table of contents:
Clickable regions for different hyperlinks within images for HTML output

You can now define a clickable region by adding an HTML snippet to an Image element of a template.

A new property named Image map is added for the Image element under the Specific tab. You can add the HTML map element to the image.

Attributes like "internal" and "local" also apply for the "area" HTML element, and work the same way as the Hyperlink's element properties with the same name.

Image of a template with an image map with clickable regions and different hyperlinks using a simple value:

Image of an template with an image map with clickable regions and different hyperlinks using a data expression:
Customizable TOC for HTML split mode

For split HTML output, you can now customize the names of ToC, ToF, ToT, and Files. Add these names in the Properties view for these new properties such as "ToC Label". You can also show or hide these tabs in the output by using properties such as "Display ToC".

Image of the new properties:
Image map supports internal and unique bookmarks linking for HTML output

You can now have Image map links pointing internally and to unique bookmarks as well for HTML output.
Improved error logging for dragging and dropping JSON text

When you drag and drop JSON text, error messages now provide more information about the problem in the JSON content.
Maintain aspect ratio for images

The new property Maintain image aspect ratio can be set to either true or false. It is available under the Size tab for images and the Specific tab for text.
The aspect ratio and dimensions of an image are not considered when an image is provided with height and width in pixels. However, if you provide only height in pixels and not width, then the width is decided according to the aspect ratio of the image considering the height. If you provide only width in pixels and not height, then the height is decided according to the aspect ratio of the image considering the width.

Image of maintain image aspect ratio:
Performance improvement for large HTML output files

You can now disable breadcrumbs creation for HTML output using the Disable Breadcrumbs property to improve navigation performance when the output is very large.

Simplified document comparison

With simplified document comparison, you can now specify another configuration as the base document under the same data source. IBM Engineering Lifecycle Optimization - Publishing (PUB) generates the target document as well as the base document and then compares them to generate a comparison document.

The existing document comparison functionality is still available, so you can compare a Microsoft Word document or generate and compare a base document for a different configuration in a single step.

A new menu item named OSLC Base Configuration Selection was added to select the base configuration in the properties of the data source.

Image of the
OSLC Base Configuration Selection menu item:

When you select the base configuration, the URI for the selected configuration is added to the new Base Configuration-Context data source property.

Image of the
Base Configuration-Context data source property:

The base document is generated using the same template that is used for target document generation. If you select a base Word document in the Word Output properties and also select a base configuration context, the comparison document is generated against the base document (from the Base Configuration-Context property).

The Results window shows three documents: the target, base, and comparison documents. All output files are generated under the same output folder:
  • <target_document_name>.doc
  •   base_<target_document_name>.doc
  •   compare_<target_document_name>.doc
If variables or attributes are used in JavaScript Code element, you can still set Library script property to true and Publishing will use the script as library.
Document Builder Document generation license consumption improvements

In previous versions, Document Builder consumed two licenses in order for a user to generate a document (one license to log in, and another license to generate a document). Now only one license is consumed per user when the user logs in. No additional license is required to generate a document.

Currently, the login check out happens on the machine where the document generation node is set up. In case the document generation node is deployed on a remote machine, the license related setup must be done on that remote machine. In case there are multiple document generation nodes listed in the Runtime variables page (for example http://machine1:8080/dgaas,http://machine2:8080/dgaas/,http://machine3:8080/dgaas), then the first node in the list is used for license checkout. Therefore the license related setup should be done on the first node (http://machine1:8080/dgaas).
Generate comparison document

You can now generate comparison documents from Document Builder. In the Connections tab of the Design page, a new Base Configuration property is available in the Add or Edit Connection window.
To generate a comparison document, select a base configuration and then a base document is generated and compared with the target document.

Image of the Base Configuration property:
Improved workload distribution for load balancing

IBM Engineering Lifecycle Optimization - Publishing now supports the load balancing of document generation nodes (http://<hostname:port>/dgaas). On the Runtime Variables page, in the Document generation URL field, you can specify a semicolon-separated (;) list of document generation node URLs. In the Load balancing algorithm field, you select one of the following load-balancing algorithms:
  • Weighted Round Robin (default): If you select this algorithm, you can also specify weights for the node URLs, for example, http://myMachine1:8080/dgaas=4;http://myMachine2:8080/dgaas=3;http://myMachine3:8080/dgaas=2. A node with no specified weight is assigned a default weight of 1. Nodes with higher weights receive more requests than those with lower weights. However, the nodes continue to receive requests in a round robin sequence. For example, consider three servers named A, B, and C with assigned weights of 1, 2, and 3. The sequence in which the servers handle every 6 (1+2+3) incoming document generation requests is ABCBCC.
Image of the Weighted Round Robin option:
  • Least Jobs: If you select this algorithm, the node that handles the least number of document generation requests handles the new document generation request.
Image of the Least Jobs option:
  • Dynamic weights: Under this algorithm, each document generation node is assigned a score based on the node attributes such as available memory, CPU usage, concurrent document generation limit, or availability. The node with the highest score is selected for document generation when a request comes. The value of these attributes are updated at regular intervals and the assigned scores as well.
Now available in ELM installation launchpad

You can now install Document Builder from the IBM Engineering Lifecycle Management (ELM) installation launchpad. Document Builder is installed into a separate package group from the ELM applications into its own installation folder with its own Liberty runtime.

Image of the ELM launchpad:

Post-installation, run the Document_Builder_InstallDir\server\server.startup.bat script to start Document Builder and the Document_Builder_InstallDir\server\server.shutdown.bat script  to stop the application, for example C:\Program Files\IBM\DocumentBuilder\server\server.startup.bat.

There is a change in the ports that are used by Document Builder. The default ports are now 9081 for http and 9444 for https. ELM already uses the previous default ports of 9080 and 9443.

After successfully starting Document Builder, log in to either https://hostname:9444/rpeng/login.jsp or http://hostname:9081/rpeng/login.jsp  with the default user.

Edit the user configuration groups in the basicUserRegistry.xml file and edit the role mapping in the application.xml file as shown below. These files are located in the Document_Builder_InstallDir\server\liberty\clmServerTemplate\conf directory.

Image of the application and registry files:

Document Builder will continue to be available from the IBM Engineering Lifecycle Optimization - Publishing launchpad.

Specify the name of the generated document

When you configure a report, you can now set or change the file name of the generated document on the Output tab.

Image of the report configuration:
Output enhancements Support for PDF/A output

You can now output documents to PDF/A compliant format in the desktop client or in Document Builder.

Image of the PDF/A compliant output property in the desktop client:

Product name change Rational Publishing Engine was renamed

In this release, IBM Rational Publishing Engine was renamed to IBM Engineering Lifecycle Optimization - Publishing (PUB). All references to the product name have been changed in the user interfaces for Document Studio, Launcher, and Document Builder. For details, see Renaming the IBM Continuous Engineering Portfolio.

© Copyright IBM Corporation 2020  |  Contact  |  Privacy Policy  |  Terms of Use