Completing the prechecks for versions 20.02.03 to 23.3.01

How prechecks work

The prechecks identify the supported and unsupported scenarios to help you take corrective actions. The precheck identifies whether an SRD has the following configurations:

• SRD with Advanced Interface Form (AIF) reference
• SRD with a custom approval process
• SRD with a Quick Launch Request
• Process definition template (PDT) has a variable mapping with a service request field
• PDT has a custom Application Object Template (AOT)
• SRD with a PDT that has several fulfillments
• SRD with a PDT that has parallel fulfillments
• SRD with a PDT that has nested conditions
• SRD has embedded PDTs

Before you begin

Make sure that the administrator has the SRD Migration Admin (IS persona). These permissions are granted from Action Request System. For more information, see Creating and modifying users and Creating and assigning functional roles.

Task 1: To download the precheck utility files

1. Log in to Electronic Product Distribution by using your Subscription ID.

2. Select Downloads & Products > Product Download Tool. 
3. On the Electronic Product Distribution page, in Licensed Products, search BMC Helix Digital Workplace. 
4. Select the applicable version.
5. Download the following migration utility file and the related D2P package:
   • BMC Helix Digital Workplace SRD to DWP Catalog Prechecker Utility.zip
   • BMC Helix Digital Workplace SRD to DWP Catalog Prechecker D2P package.zip
     
     The following image shows the prechecker files on EPD:
     
     

1. Extract the BMC Helix Digital Workplace SRD to DWP Catalog Prechecker Utility.zip file by using 7-Zip. 
2. Verify the following extracted files:
   • BMC Helix Digital Workplace SRD to DWP Catalog Prechecker Utility.jar
   • runPrechecker.bat
   • runPrechecker.sh

Task 2: To deploy the precheck utility D2P package

1. As an administrator, log in to Action Request System.
2. Select AR System Administrator > AR System  Deployment Management Console. 
3. Select Transfer Package > Import.
4. In the dialog box, click Browse to navigate to the local folder where you downloaded the BMC Helix Digital Workplace SRD to DWP Catalog Prechecker D2P package.zip file. 
5. Select the file and click OK.
   You should be able to view the BMC Helix Digital Workplace SRD to DWP Catalog Prechecker D2P package in the AR System Deployment Management Console.

Task 3: To run the precheck utility

1. Navigate to the folder in which you extracted the .zip files.
2. Open a command prompt. 

3. Authenticate and run the precheck utility by typing the following command; provide the host name, port, user name, and password of Action Request System in which you deployed the D2P file:

   +x ./runPrechecker.sh <ARserver hostname> <Port number> <User name> <Password>

   The utility starts running with the following message:
   Prechecker started with parameters: host:hostname port:Portnumber user:UsernameDepending on the number of SRDs in the system and their complexity, it might take some time to complete the run. 
   
   After the utility run is completed successfully, the following message is displayed:
   Prechecker completed successfully. Please check the generated csv file : precheck_report.csv.
   
   

4. Verify that the CSV file is created by navigating to the folder in which you extracted the .zip files. 
   You should see a folder named Precheck Report that contains the CSV file. 
   
   

The following image is an example of a successful run of the precheck utility:

Task 4: To analyze the precheck report

1. Navigate to the folder in which the CSV report is saved. 
2. View the SRDs with the following precheck scores:
   • SUPPORTED—The SRD contains all supported scenarios. The specific supported scenarios are described in the Supported column.
   • UNSUPPORTED—The SRD contains one or more unsupported scenarios. The specific unsupported scenarios are described in the Not supported column.
   • SUPPORTED WITH CAUTION—The SRD contains scenarios that will be migrated but will need a manual review and updates to the migrated workflow. The specific scenarios that might need a manual review are described in the Supported With Caution column. 
3. Identify the SRDs that you need to modify so that they have the Supported score.
   SRDs that are supported by the precheck utility are also supported by the migration utility. 
   This information gives you an estimated effort required to modify the SRDs in your system. 

The following image is an example of a precheck report CSV file:

Troubleshooting

Refer to the following table to resolve common issues related to precheck: 

After you have run the precheck utility and analyzed the report, you can upgrade BMC Service Request Management and BMC Helix Digital Workplace Catalog to the versions supported by the migration utility. You can then use the migration utility for a quick and seamless migration of the SRDs.