What’s new in Engineering Publishing 7.0.3

Learn more about what’s new and changed in IBM Engineering Lifecycle Optimization - Publishing (PUB). 7.0.3

For more information about features in IBM Engineering Lifecycle Management, see What's new in ELM 7.0.3.

Redesigned Engineering Lifecycle Management product documentation

The hosting of Engineering Lifecycle Management documentation is redesigned in IBM documentation. The following changes are made to the hosting of ELM product documentation.

Common changes in Engineering Publishing

Included macro in Microsoft Excel output

When you generate a document by using PUB, you can add a stylesheet with macros to the Excel output. PUB now run a post-processing macro to edit the format, create a chart, and so on.

Added stylesheet with macros to the Excel output

When you generate document by using IBM Engineering Lifecycle Optimization - Publishing, you can now add stylesheet with macros to the Excel output. With stylesheet, you can apply predefined layout and formatting, enforcing uniform looks across the documents.

Generate protected Microsoft Excel documents

IBM Engineering Lifecycle Optimization - Publishing (PUB) now has the feature to protect the generated Microsoft Excel document with a password and make it read-only. With this feature, you can achieve enhanced security for your document. For more information, see Adding password protection to Microsoft Word, Microsoft Excel and PDF documents.

Background color property is supported for rows that are added dynamically

IBM Engineering Lifecycle Optimization - Publishing now supports background color property for rows that are added dynamically in a table by using script expression with variables.

Display data in a single cell or multiple cells in the Data Expression tab

You can now choose to display the text in Microsoft Excel output in a single cell or multiple cells in the Data Expression tab in IBM Engineering Lifecycle Optimization - Publishing. For more information, see Microsoft Excel output properties reference for document specifications.

Display data in a single cell or multiple cells in Microsoft Excel in Script expression tab

You can choose to display the text in Microsoft Excel output in a single cell or multiple cells. Use XHTML to the text element, select XHTML Output in the Script expression tab, then set the property Data in single cell to true in the Document Specification of Microsoft Excel output.

Improved Microsoft Excel list output for single and multiple cells

IBM Engineering Lifecycle Optimization - Publishing (PUB) now supports list in single and multiple cells along with numbering in Microsoft Excel output. You can choose to display a list in a single cell or multiple cells using List in single cell property available for Microsoft Excel output in the document specification.

Integrating IBM Engineering Lifecycle Optimization - Publishing (PUB) Document Studio with Document Builder

You can now integrate Document Studio with Publishing Document Builder that is configured with Jazz® Team Server (JTS) authentication. You can create, modify, or update resources directly from Document Studio. The integration works for JTS configured with Jazz Authorization Server (JAS) using application password, container authenticated JTS, and JTS configured with Lightweight Directory Access Protocol (LDAP).

IBM Engineering Lifecycle Optimization - Publishing supports caption-side and text-align properties for caption tag in XHTML

While processing XHTML data during document generation, PUB now supports caption-side and text-align CSS style properties. The caption tag defines a table caption in XHTML. By default in the PUB output, the table caption positions beneath a table and the text are left-aligned. You can now position the caption at the beginning or base of a table and align horizontally inin Microsoft Word, Microsoft Excel, PDF, and HTML output.

IBM Engineering Lifecycle Optimization - Publishing supports column or row height property for table tag XHTML

While processing XHTML data during document generation, PUB now supports cell height and row height CSS style properties. The height attribute of a cell is used to set the height of the enclosing row in XHTML. In XHTML, the highest of the cell height or row height value is considered to set row height.

Sample template and stylesheet for Microsoft Excel included in PUB

You can now find an extra sample template and stylesheet for Microsoft Excel in PUB. The sample template and stylesheet are available at PUB_install_dir/templates/EWM and PUB_install_dir/utils/excel/ directory. The stylesheet contains sample macros that can be used to add any chart, position the chart, delete the sheets based on certain conditions, and more.

Default Microsoft Word output file extension is changed

The default Microsoft Word output file extension is set to .docx, which creates smaller, lighter files you can read and transfer.

DOORS add-in Publish menu supports new languages

DOORS add-in Publish menu and submenu items now support 11 new languages other than English. The newly supported languages are as follows: de (German), es (Spanish), fr (French), it (Italian), ja (Japanese), ko (Korean), pt (Portuguese), ru (Russian), tr (Turkish), zh (Chinese), and zh_tw (Traditional Chinese).

Customize the image quality of the PDF output of a template

PUB introduces a new feature that is called Image quality to preserve the quality of the images when a PUB template is converted to a pdf file. Previously, the image quality of the PDF file would be degraded when converted from a PUB template. For more information, see PDF output properties reference for document specifications.

Enabled POX profile support for smart-card and SSL certificate authentication

The POX profile header now works with SSL certificate and smart-card authentication in PUB. Configure the POX profile header in the Extra headers field with authentication set to SSL certificate or smart-card.

Use DOORS text and background colors in your reports

IBM Engineering Lifecycle Optimization - Publishing can now fetch text color and background color from DOORS columns. This feature enables the user to extract colors from the DOORS columns, and generate the document-style report with colors exactly as rendered in DOORS. To extract the color, the user can use the custom attribute in the template that returns the color from DOORS.

Add custom properties to the generated PDF documents

IBM Engineering Lifecycle Optimization - Publishing now supports Custom Properties feature in PDF outputs. Previously, the user was able to add the custom properties only to the Microsoft Word outputs, but now it is possible for the PDF outputs as well. With this feature, you can add custom document properties that store other metadata, such as the version number, company name, or any other values directly in the PDF document. For more information, see Adding a document property element.

Engineering Publishing Desktop Client

Updated the embedded browser technology to Microsoft Edge Webview2 UI control

The embedded browser technology that is used for the OSLC selection and creation dialogs is updated in IBM Engineering Lifecycle Optimization - Publishing version 7.0.3. Previously, the embedded browser was based on Internet Explorer (IE) technology, which is Microsoft .Net web browser UI control. However, as Internet Explorer is no longer supported by some third-party applications in the recent versions, the IE dependency of the browser is removed. The embedded browser is now updated to use Microsoft Edge Webview2 UI control technology.

Added another Rhapsody® Model Manager (RMM) sample template

A new sample RMM template that is named ArchitectureElement.dta is added in the PUB_install_dir/templates directory. The new template enables the report to include RMM Architecture Element and all its aggregates.

IBM Engineering Lifecycle Optimization - Publishing (PUB) clears unused variables and attributes from Script Expression tab

When PUB Designer creates a template by using JavaScript, PUB now clears the variables and attributes that are not used in Script Expression to reduce the chance of unexpected output.

IBM Engineering Lifecycle Optimization - Publishing (PUB) supports importing styles from Microsoft Word documents

PUB now supports importing styles from Microsoft Word documents during template design. It helps the template designer to quickly create styles in the PUB template based on the styles already defined in the Microsoft Word document.

Environmental variable is now supported for data source properties

Environment variable is now supported for the data source properties such as View, Baseline, Configuration context, and Base configuration context.

New predefined data source schema for Global Configuration Management (GCM)
When you add a data source schema, you can now select the following new predefined schema- GCM Configurations. The new predefined data source schema reduces the time that it takes to design a template, as you need to replace only the name and port, instead of manually entering the complete URL.
Provided an option to remove custom metadata property

You can now delete the custom metadata property by selecting the property and clicking Delete.

Added configuration information in Find feature

The Find feature to search data source URL now includes the configuration information. Using Find option in Configure REST data source or Configure XML data source window, auto populates the Configuration context field, if the configuration information is available in the selected URL.

Configuration context can be set for the data source configuration element
You can now set a configuration context for the Data source configuration element to override the default configuration context. For this purpose, a new property that is named Configuration-Context is available in the Properties > Dynamic configuration tab.
Note:

The Dynamic configuration tab displays after you enter a value for the Target Data source property in the Data tab.

Configuration information available for templates created from web resource URLs

When you create a document template from a web resource URL, which has configuration information, then the resource type is correctly identified and the relevant snippets are loaded.

Enhanced template in Document Studio

You can define the content of a template by using data expressions, script expressions, or simple values. The tabs are now arranged alphabetically as Data Expression tab, Script Expression tab, and Simple Value tab. The tab now displays the context query in expanded form without any selection, making it easier to select the attribute.

Removed Starter templates section from welcome page of Publishing Launcher application

The Starter templates section is removed from the welcome page of the IBM Engineering Lifecycle Optimization - Publishing Launcher application due to security restrictions of the embedded Microsoft Edge browser. The removal of the section does not affect any functions that are related to templates or document specifications in the PUB Launcher application.

The default preferences in Document Studio and Launcher are enhanced to reduce the number of clicks
The following default preferences in Document Studio and Launcher are changed to reduce the number of clicks:
  • Window > Preferences > PUB > Document Design > Keep current palette tool selected after insertion in Template? > Set as No
  • Window > Preferences > PUB > Document Design > Enable Palette Drawers > Set as No
  • Window > Preferences > PUB > Document Execution > Use Publish Wizard > Set as No
The following new preference is added to Document Studio and Launcher to reduce the number of clicks:
  • Window > Preferences > PUB > Document Execution > Auto save changes to the template before document generation > Set as Yes. For the first time, you must save the template by selecting the file path. Changes made to the template later are saved automatically before document generation.
  • In the Document Studio application, click File > New > Document Template. Now, a blank template opens where you can drag elements from the Palette view into the template content editor.

Option to insert text within every cell in a table

In Document Studio, by default you can insert the text elements within every cell in a table by using the Insert the Text element within every Cell option in the New Table window.

Publishing Document Builder

Extra Header property made editable in connection

To allow the users to add more headers to the data source connection, the Extra headers field in the Add data source connection window of Publishing Document Builder has been made editable. For more information, see Managing data sources in Publishing Document Builder.

Implement Group by (privacy settings) for resources

To align Publishing Document Builder with Jazz Reporting Service Report Builder and for ease of use, a new Group by feature is added to Publishing Document Builder. For more information, see Organizing and tagging resources, document-style reports, schedules and results.

New people picker component
A new people picker component is now introduced in Jazz Team Server (JTS) authenticated Publishing Document Builder. This change is a contribution to the ongoing user experience transformation and alignment with IBM's open source Carbon Design System. The people picker is a dialog box for selecting users and can be used for assigning an owner or a set of subscribers to an artifact. The following sections in Publishing Document Builder are updated with the new people picker component:
  • Resources page > Templates tab > Owners and Permission icon > Add or Remove button
  • Resources page > Stylesheets tab > Owners and Permission icon > Add or Remove button
  • Resources page > Reports tab > Owners and Permission icon > Add or Remove button
  • Resources page > Scripts tab > Owners and Permission icon > Add or Remove button
  • Schedules page > Edit icon > Add Owners button
  • Results page > Share controls icon > Add or Remove button
Select one or more different types of HTML elements during document generation

You can now select one or more different types of HTML elements to allow only selected attributes to be printed in the document. In the Edit advanced configuration modal for the reports, a new label that is named Data type is added for each variable with the following values: Simple text, Multi-value text, Boolean, Date, and User.

By default Simple text is selected. Based on the data type value selected, Generate document modal has different HTML elements for each variable.

Added Publishing Document Builder error messages in IBM Engineering Lifecycle Optimization - Publishing Documentation

Publishing Document Builder error messages is to IBM PUB Documentation. Hence, similar to the Document Studio and Launcher, users can now refer to the IBM Engineering Lifecycle Optimization - Publishing Documentation for Publishing Document Buildererrors as well. These error messages comprise three parts - Error name, Explanation, and User response.

Publishing Document Builder supports configuring data sources and variables by using metadata

Publishing Document Builder now supports configuring data sources and variables by using metadata similar to Launcher. Using metadata, the user can set the URI for data sources and provide values for template variables without any error. This makes document generation simpler for nontechnical users.

Email notifications for Jazz Team Server (JTS) users

Publishing Document Builder email notifications are now sent to JTS users. For more information, see Scheduling document-style report generation.

Disabled Move To and Copy To icons when no artifact is selected
By default, Move To and Copy To icons are disabled when an item is not selected in all the pages of Publishing Document Builder. The following icons are updated to align with IBM's open source Carbon Design System.
  • Copy To
  • Move To
  • Refresh
  • Manage Certificates
  • Create Folder
  • Expand All
  • Collapse All
Change in user experience of tags and folder path in Publishing Document Builder

Consistent with other ELM applications, Publishing Document Builder now displays the complete folder path instead of the folder name. Also, the look and feel of Tags is improved.

Change in user experience when using Publishing Document Builder with Jazz Team Server (JTS) authentication

Consistent with other IBM Engineering Lifecycle Management applications, Publishing Document Builder now displays a separate login window after the session expires. The Publishing Document Builder UI is not lost due to redirection, which occurs during JTS authentication.

Publishing Document Builder displays the template name that is associated with the data source

Publishing Document Builder now displays the template name that is associated with the data source in the generate document window. If the document style report has multiple templates, displaying the template name for the data source helps the user to understand the template that is in use.

Publishing Document Builder email notifications include template variable details

Document Builder email notifications now include template variable details. Hence, users can easily differentiate between reports in the email inbox by using template variable details. A PUB admin user can enable the inclusion of template variable details in email notifications. For more information, see Administering Publishing Document Builder.

Enhanced job details log in Publishing Document Builder

To improve the performance of Publishing Document Builder, the log that is generated from the Reports and Results pages displays only the first 20 entries. To view the complete log, you can download the log file in text format. For more information, see Susan the everyday user: Generating document-style reports.

Enhancement to Resource and Configuration pickers

When you add or edit a connection in Publishing Document Builder, ifPublishing Document Builder and the data source URL are registered in the same Jazz Team Server (JTS), then the data source is selected without providing credentials.

Updated Publishing Document Builder with the changes of sentence-style capitalization

To enhance the readability for the users, the Publishing Document Builder user interface is now updated for sentence-style capitalization usage. You can now see consistent sentence-style capitalization across all the user interface elements such as labels, messages, and dialog titles, of Publishing Document Builder.

Upload SSL certificate by using Enter connection credentials window

You can now upload an SSL certificate to the Enter connection credentials window. For more information, see Managing data sources in Publishing Document Builder .