License requirements

Edit online

You must have a license for IBM Engineering Lifecycle Optimization - Publishing and licenses for all the product sources to report on.

Overview

  • To use Engineering Publishing, you must configure a valid license server.
  • PUB licenses are floating or token-based. Nodelocked licenses cannot be used.
  • Temporary licenses are available for evaluation purposes, but they cannot be used with permanent user-based or floating licenses.

Installation options

Depending on your requirements, you have several ways to install PUB. You can install the full desktop product (Document Studio and Launcher) or the web version (Document Builder). If you need to generate simple reports from the provided templates, you can use the embedded functions in your IBM Engineering Lifecycle Management applications using Engineering Document Generation. For a detailed comparison of these options, see Document-style report generation with Engineering Publishing

License usage

A license key is consumed in the following scenarios:
  • When a client application is opened, a license is consumed until the license times out. When the client is closed, the license is released immediately.
  • For the IBM Engineering Requirements Management DOORS® Publish menu (add-in mode), no license is consumed when you open the Launcher user interface but one license is consumed if you generate a document-style report from the Launcher user interface.
  • For Publishing Document Builder, one license is consumed per user when you log in to the web user interface. No additional licenses are consumed when generating document-style reports or for scheduled document-style reports.

    Currently, the login check out happens on the machine where the document generation node is set up. If the document generation node is deployed on a remote machine, the license-related setup must be done on that remote machine. If there are multiple document generation nodes listed in the Runtime variables administration tab (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).

Table 1. License usage
PUB feature Open the user interface Generate a document-style report locally Generate a document-style report from Publishing Document Builder
Publishing Document Builder One license while logged in. N/A One license while logged in.
Launcher One license while Launcher is open; if Studio is already open, Launcher uses that license. None N/A
Document Studio One license is consumed while the Studio client is open; if Launcher is already open, Studio uses that license. None N/A
Engineering Requirements Management DOORS Publish menu None One license is consumed when Studio client or Launcher is open. Simultaneously, if a document-style report is generated from Engineering Requirements Management DOORS Publish menu on the same computer, the same license is used. N/A
DOORS menu: File > Export > Document Generation None None N/A
Multiple client instances or local document-style report generations on the same computer from the desktop client or DOORS DXL script or command line consume a single license.

For the desktop applications, licenses are configured with a timeout setting of 30 minutes unless a document-style report is being generated. If Launcher or Document Studio is open and unused for 30 minutes and no document-style report is being generated, the license is checked back in. You are prompted to either try to check the license out again or close PUB. Administrators can configure the license timeout settings by using the com.ibm.rational.rpe.desktop.release_license_idle_timeout parameter.

For Publishing Document Builder, the license is released after 30 minutes (session timeout). Administrators can configure the license timeout settings on the Publishing Document Builder runtime variables admin tab. You can also configure the license check-out settings for Publishing Document Builder on WebSphere® Liberty server .

Document-style report generation from within IBM products

PUB does not consume a license for document-style report generation requests from within IBM products that incorporate the EDG component. These products include IBM Engineering Requirements Management DOORS Next, IBM Engineering Workflow Management, and IBM Engineering Test Management, whether the document-style report uses sample or custom templates. Other IBM products that don't use the EDG component do require licenses, such as when you apply a template to a report exported from Jazz® Reporting Service or report on models in IBM Engineering Systems Design Rhapsody® - Model Manager.

For example, you can design a template in PUB Document Studio, deploy the template to Engineering Requirements Management DOORS Next, and then generate the document-style report from DOORS Next without consuming a license.

However, if you export a report from Jazz Reporting Service and then use PUB to format it and generate the document-style report, you need two licenses.

Example

You have 10 floating keys. With a floating key, users can share licenses from a common pool. Five users are report designers, who are assigned the task of authoring and creating document templates. Ten other users can generate document-style reports from the templates that report authors provided to them. These 15 users share 10 license keys.