This documentation supports the 22.1 version of Action Request System.
To view an earlier version, select the version from the Product version menu.

Analyzing the manual reconciliation effort by using the reconciliation report

Object reconciliation refers to the process of comparing and synchronizing objects across different versions of BMC Helix Innovation Suite . Object reconciliation is essential for ensuring consistency and improving operational efficiency.

To estimate the manual reconciliation effort required post upgrade, analyze the report generated by BMC Helix Innovation Suite . This report provides details about objects automatically reconciled during the upgrade and objects that require manual reconciliation. In addition, it gives an overview of the changes made to various objects during the upgrade.

All the objects that do not have conflicting changes, except for Developer Studio form views, are automatically reconciled during the upgrade.


Scenario: Analyzing the reconciliation report


Analyzing the reconciliation report

After performing an upgrade, Jonnie, an administrator at Apex Global wants to know the number of objects that require manual reconciliation so that he can estimate the effort involved.

He obtains the reconciliation report and analyzes the report to understand the manual reconciliation effort. Jonnie then performs manual reconciliation and completes the post upgrade tasks.


Before you begin

Make sure to complete migrating customized  BMC Helix CMDB and  AR System objects by using the Workflow Migration utility. For information about the Workflow Migration utility, see Migrating customizations using Workflow Migration Utility.


Obtaining the reconciliation report

The reconciliation report shows a list of objects that need a manual reconciliation. You can obtain the reconciliation report in one of the following ways:

  • By using the ReconReportUtility utility from the command line. Use this command line utility if you are not using Developer Studio in your BMC Helix SaaS environment. 
  • By using the AR System Upgrade Tracker form through Mid Tier


To obtain the reconciliation report by using the Autorecon utility

Use the ReconReportUtility utility to generate the reconciliation report if you are a Helix subscriber and have no access to Developer Studio . Although we recommend running this utility after the upgrade, if you need to analyze only the manual reconciliation effort, you can run the utility before the upgrade.

  1. On the BMC Electronic Product Distribution (EPD) Open link site, from Products, select BMC Helix Innovation Suite OnPrem.
  2. Select the latest version.
    The following screenshot shows the version.


  3. From the Product tab, select Workflow Migration Utility <version>.
    The ReconReportUtility is available with the Workflow Migration Utility.
    The following screenshot shows the workflow migration utility:
  4. Click Download.
    Download the Windows or Linux file as per your requirement.
  5. Save the workflow Migration utility on your local server that you use for migrating objects and where you have other clients such as Developer Studio installed.
  6. Unzip the file.
    The workflow Migration utility creates the following folders. You must store all these files in the same location:
    • CDMChecker
    • ReconReportUtility
    • The utility jar file migratecustomizations-21.30.00-SNAPSHOT.jar.
  7. Open the command prompt.
  8. Change to the directory where the ReconReportUtility is saved.

  9. Run the following utility at the command prompt:

    Recon.bat 
     [-x] [-u] [-p] [-w] [-portnum ] [-olddeffile] [-newDefFile] [-exf]
     [-autorecon] [-serverupgraded] [ -reconcilevuis ] [-reportfile] [-reportmode] [-o]
    
    

    The following table describes the command options, which can be used in any order in the command:

    OptionDescripName of the server to connect to.tion
    -xServer name.
    -u  

    Name that identifies the user account for BMC Helix Innovation Suite .

    -p 

    Password for the user account.

    -w

    External authentication string or Microsoft Windows operating system domain.

    -portnum Port number to connect to.
    -olddeffile 

    Path of the old definition file that includes all objects to be analyzed post upgrade.

    -newDefFilePath of the new definition file.
    Use this option when you run the utility before upgrade.
    -exfList of objects you want exclude from the analysis.
    -autorecon  

    Automatically reconcile non conflicting changes.

    Valid values:

    • True 
    • False
    -serverupgraded

    Determines if the AR System server upgraded or not.

    Valid values

    • True (Post upgrade)
    • False (Pre upgrade)
    -reconcilevuis 

    Reconcile Developer Studio form views.

    Valid values

    • True 
    • (Default) False
    -reportfilePath for the reconciliation report csv file.
    -reportmode

    Obtain report option:

    1: Report differences that need manual reconciliation.

    2: Report all differences.

    -o

    Log file path to store the log file

The reconciliation report is available in the CSV format.


Example of using the Autorecon utility

The following table show examples of generating report before and after upgrade:

ScenarioExample
Generate report before an upgrade by using a new definition file
recon.bat -x servername1 -u user -p password 
-portnum 0 -newdeffile "C:\NewBase\upgradeddefinitions.def" 
-autorecon false -serverupgraded false -reconcilevuis false 
-reportfile "C:\Report

Generates a report in a CSV format showing the manual reconciliation effort.

Generate report after an upgrade by using an old definition file
recon.bat -x servername1 -u user -p password 
-portnum 0 -olddeffile "C:\OldBase\olddefinitions.def" 
-autorecon true -serverupgraded true -reconcilevuis false 
-reportfile "C:\Reports\After

Automatically reconciles non conflicting changes and generates a report in a CSV format showing the manual reconciliation effort.

To obtain the reconciliation report by using the AR System Upgrade Tracker form

  1. In Mid Tier , open the AR System Upgrade Tracker form.
    For example: https://<localhost>/arsys/forms/onbmc-s/AR+System+Upgrade+Tracker/Default+Administrator+View/

    The following screenshot shows the AR System Upgrade Tracker form:
  2. Click New Search.
  3. Select Request ID.
  4. From Results, select and download the Manual Recon Report.zip file.
  5. In the File Name field, select the attachment.
  6. Click Save.


To analyze the reconciliation report

Perform the following steps after you download and save the Manual Recon Report.zip file of the previous version to your computer. The Manual Recon Report.zip file contains multiple files.

  1. Unzip the Manual Recon Report.zip file.
  2. From the unzipped files, open the Manual_Recon_List_*.xml file.
  3. Update the definition file (DEF) path to match the local file system path.

    Important

    The XML file includes the path of the Jenkins environment.

  4. Copy the XML file to the  Developer Studio workspace.
  5. Relaunch Developer Studio and switch to the Best Practice Customization mode.
  6. In the AR System Navigator, expand Recon Application.
    The following screenshot shows the Objects to Reconcile section:

  7. Click Objects to Reconcile.
    A report showing a list of objects that need manual reconciliation is displayed. The following screenshot shows a sample report:

After your analysis is complete, perform a manual object reconciliation of objects. 




Was this page helpful? Yes No Submitting... Thank you

Comments