This documentation applies to the 8.1 version of Remedy ITSM Deployment, which is in "End of Version Support." You will not be able to leave comments.

To view the latest version, select the version from the Product version menu.

Generating overlays for modified legacy objects using the BPCU

In Overlay mode, the Best Practice Conversion Utility (BPCU) compares objects in an overlay hash file with the objects on a server, generates a report of their differences, and performs the following tasks based on the contents of the report:

  • For permitted customizations, the BPCU generates an overlay by creating a copy of each object, and sets its Overlay property to Overlay.
  • For permitted extensions, the BPCU generates a custom object and sets the Overlay property to Custom.

In Overlay mode, the BPCU ignores all the overlay, overlaid, and custom objects on the server. Therefore, running the BPCU multiple times in Overlay mode does not cause problems for such objects, including objects that are shared among applications.

To generate overlays for pre-7.6.04 objects

  1. Generate a difference report, and fix all the non-permitted extensions and customizations that are identified.
    If nonpermitted extensions and customizations are found among the set of objects to be processed, the BPCU does not run in Overlay mode.
  2. At the command prompt, go to the <utilityInstallDir>\Best_Practice_Conversion_Utility folder.
  3. Run the BPCU in Overlay mode by executing the following command with the appropriate arguments (see the following table):
    • (Microsoft Window)  bpcu.bat
    • (UNIX)  bpcu.sh

 Command-line options for Overlay mode

OptionDescription
-xName of the server on which to perform the operation.
-uUser name.
-pUser password.
-a(Optional) User authentication string.
-t(Optional) TCP port of the server on which to perform the operation.
-r(Optional) RPC port of the server on which to perform the operation.
-fAbsolute path to the overlay hash file provided by BMC (include full path and file name).
-c

(Optional) Full path to the XML file containing a list of objects to include in or to exclude from the operation.

Note 

The following sample files are available bpcu<version>.zip file: Best_Practice_Conversion_Utility\obj-filter-lst_template.txt  Best_Practice_Conversion_Utility\obj-filter-lst_template.xml

This option applies to all modes except when two overlay hash files are compared in ReportDiff mode.

 -e(Optional) Comma-separated list of form names whose associated fields and views are the only objects processed by the operation. 
-o(Optional) Name of the difference report. Do not include a file extension.
-T

(Optional) Format of the difference report. Possible values are as follows:

  • 0 — HTML (Default)
  • 1 — CSV
  • 2 — XLSX
-m

Utility mode. Possible values are as follows:

  •  o 
  •  overlay 
-k

(Optional) Indicates whether to display or hide the list of objects that are skipped during conversion. Possible values are as follows:

  • 0 — (Default) Hide this list in the difference report.
  • 1 — Display this list in the difference report.
-PComma-separated list of prefixes in the names of user-created objects. 
All objects whose name begins with one of these prefixes are converted into overlays or custom objects.
This option applies only to active links, active link guides, filters, filter guides, escalations, menus, and all types of containers. (Per BMC recommendations, to modify such objects in pre-7.6.04 releases, you should make a copy of the origin object and add a prefix or suffix to its name.) 
You must ensure that the corresponding out-of-the-box object exists and is the same type in the 7.6.04 release.
-SComma-separated list of suffixes in the names of user-created objects. 
All objects whose name ends with one of these suffixes are converted into overlays or custom objects. 
This option applies only to active links, active link guides, filters, filter guides, escalations, menus, and all types of containers. (Per BMC recommendations, to modify such objects in pre-7.6.04 releases, you should make a copy of the origin object and add a prefix or suffix to its name.) 
Ensure that the corresponding out-of-the-box object exists and is the same type in the 7.6.04 release.
-i

(Optional) Flag that specifies whether to include overlay and custom objects in the "addition" section of the difference report. Possible values are as follows:

  • 0 — (Default) Exclude from addition section.
  • 1 — Include in addition section.

BPCU-generated difference report

The BPCU generates a report that shows differences between the unmodified objects represented in an overlay hash file and objects on a server. It also shows which changed objects can be converted into overlays or custom objects, and which objects have been changed in a way that makes the conversion impossible. 

Difference reports are produced in HTML, comma-separated values (CSV), or Microsoft Excel (XLSX) formats. By default, the report name uses the following format: 

bpcu-diff-report_date_timestamp.extension

Difference reports are stored in the <utilityInstallDir>\Best_Practice_Conversion_Utility\output folder. 

The following table describes the information that a difference report provides about objects and where you can find the information.

Information in a difference report generated by BPCU

InformationXLSX report formatHTML report format

Statistical information about all types of objects found on the server where BPCU was executed:

  • Total count of objects
  • Number of new objects
  • Number of changed objects
  • Percentage customization
  • Number of new and changed objects with nonpermitted modifications 

    The following types of statistical information is displayed only when you use a certain execution parameter.
  • Number of new objects that are not converted to custom objects when you execute BPCU in Overlay mode
  • Number of changed objects that are not converted to overlays when you execute BPCU in Overlay mode

Dashboard worksheet

Dashboard tab

Whether an object on the server is new

Difference Report 
worksheet, in rows with 
the value Extension in the Customization 
Type column

Extensions tab

Whether an object on the server has been modified

Difference Report 
worksheet, in rows with 
the value Customization
in the Customization 
Type column

Customizations tab

Whether modified objects in the server contain permitted or nonpermitted modifications: 

  • If an object contains nonpermitted modifications, it is flagged as an object that cannot be converted into an overlay. All such objects must be fixed before running BPCU in Overlay mode.
  • If an object contains permitted modifications, its flagged as an object that can be converted into an overlay.

    Note: When you run the BPCU in ReportDiff mode with the -k option and its value as 1, the Customizations tab displays the Skipped During Conversion column. This column displays the value true for objects that are skipped during conversion whether they were modified in a permitted or nonpermitted manner. Therefore, even if the Convertible to Overlay column for a particular object displays the value false, you do not need to fix any nonpermitted modifications made on it.

Difference Report worksheet, in rows with the value Customization in the Customization Type column

  • Permitted modifications: 
    Convertible to Overlay = true
  • Nonpermitted modifications: 
    Convertible to Overlay = false

Customizations tab, all panels

  • Permitted modifications:
    Convertible to Overlay = true
  • Nonpermitted modifications:
    Convertible to Overlay = false
  • Version of the utility that was executed to generate the 
    report
  • Date and time when the report was generated
  • Parameters supplied to the utility for the current execution
  • AR System applications installed in the execution environment

Execution Information worksheet

Execution Information tab

Note

BPCU does not include information in a difference report about objects that are unchanged.

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments