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 a difference report using the BPCU

Run the Best Practice Conversion Utility (BPCU) in ReportDiff mode to compare objects between the overlay hash file and an BMC Remedy AR System server, and generate difference reports.

You need to determine which objects have been modified in ways that are not permitted in overlays. For any such objects, this can prevent an application upgrade from succeeding, if the upgrade affects that object.
Running the BPCU in ReportDiff mode allows you to determine such modifications, and to make the necessary corrections before upgrading any applications. It compares the current objects to a set of base objects that are defined in an overlay hash file.

To generate a difference report

  1. At the command prompt, go to the <utilityInstallDir>\Best_Practice_Conversion_Utility directory 
  2. Run BPCU in ReportDiff mode by executing the following command with the appropriate arguments (see the following table) 
    • Microsoft Windows: bpcu.bat
    • UNIX: bpcu.sh

    Following is an example of the command syntax

    bpcu -x localhost -t serverport -u Demo -p "DemoPassword" -m D -f "<hashFileLocation>\OverlayHashFile.xml"

    Command-line options for ReportDiff mode

     Click here to expand...

    Option

    Description

    -xName of the server on which to perform the operation.

    -u

    User name.

    -p

    User 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.

    -f

    Absolute path to the overlay hash file (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. 
    This option does not apply to ReportDiff mode when two overlay hash files are compared.

    -e

    (optional) Comma-separated list of form names whose associated fields and views are the only objects processed by the operation. 
    Do not use this option with the -s option.

    -o

    (optional) File name and path of the difference report. Do not include a file extension. 

    If you do not provide a file name, the following name is used: 
    bpcu-diff-report-date_timestamp.html

    If you do not provide a path, the utility places the report file in theinstallationDir\Best_Practice_Conversion_Utility\output folder.

    -T

    (optional) Format of the difference report. Values are:

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

    -i

    (optional) Flag that specifies whether to include overlay and custom objects in the "extension" section of the difference report. 
    This option applies only to file-to-server comparisons. Values are:

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

    -m

    Utility mode. Values are D or d or diff.

    -k

    (optional) Indicates whether to display or hide the list of objects that will be skipped in Overlay mode.

    • 0 — (Default) Hide this list in the difference report.
    • 1 — Display this list in the difference report.

     

  3. A BPCU difference report, bpcu-diff-report_date_timestamp.html, is generated and placed in the<utilityInstallDir>\Best_Practice_Conversion_Utility\output folder. The report is an HTML-formatted file that displays a list of the extensions and customizations in your setup, and indicates whether the extensions and customizations are permitted or non-permitted. The BPCU also generates some migrator .xml instruction files that are used in stage 5 of the upgrade process.

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