CA Service Desk Manager allows customers to extend the design forms as required. The Customization Upgrade utility facilitates smooth upgrade and merging of the customized forms into the latest CA SDM version.
Before implementing CA Service Management 14.1.04.1, backup the Out of the box (OOTB) web directory located at $NX_ROOT/bopcfg/www/htmpl.
Copy the backup directory to $NX_ROOT/samples/customization_upgrade/htmpl/original folder.
Create a backup of the site/mods folder. This folder is used by the utility to identify the customized files for processing.
Implement the CA Service Management 14.1.04.1 for CA SDM.
Tip: We recommend that you clean up the unused HTMPL and CSS files from the customization folder before merging the content.
For the utility to run successfully, the following folder locations are required:
The utility merges the customization in the OOTB files of the latest release, and then places the merged files in the target location. A log file is also generated, which indicates the status of each file:
Important! We recommend that you use the utility to merge only the HTMPL and CSS files. We currently do not provide support to merge the failed files and such files must be merged manually.
Follow these steps:
In CA SDM, as an administrator, navigate to the location that contains the utility.
Important: When using \ as the file separator to define folder locations on Windows, use another \ as the escape character.
Define the location of the OOTB files from the latest release.
For example, NEW_BASE_FOLDER=$NX_ROOT/bopcfg/www/htmpl
Important! This utility reads the folder recursively to find corresponding files to compare and merge, like any other compare tool. Therefore, the relative path to an htmpl file from PREVIOUS_BASE_FOLDER, CUSTOMIZED_FOLDER, and NEW_BASE_FOLDER folders must match.
For example, if you want to merge about.htmpl file that is located in $CUSTOMIZED_FOLDER/web/analyst; ensure that the file exists in $PREVIOUS_BASE_FOLDER/web/analyst and $NEW_BASE_FOLDER/web/analyst folder locations.
If the relative folder paths mismatch, the utility might throw errors.
Define the location of the target folder that is used by the utility to create the merged files.
Tip: Do not define the MERGED_FOLDER path to any existing CA SDM folder, as the utility might rename the folder.
Temporary location to contain the processing files.
For example, TEMP_LOC=$NX_ROOT/temp
Note: Ensure enough space to contain the files in the PREVIOUS_BASE_FOLDER, CUSTOMIZED_FOLDER, and NEW_BASE_FOLDER locations.
Location that contains the log and differences files for debugging.
For example, LOG_LOC=$NX_ROOT/log/UpgradeFactoryLogs
Note: When you execute the script, it prompts the variables that you defined in cu_env.properties, which you can update, if necessary.
The merge process runs similar to the one as indicated in this image:
After the merge process completes successfully, you can view the result similar to the one as indicated in the image:
Verify the $NX_ROOT/log/customization_merging.log log file to ensure successful merging of the customization.
To manage the log level, edit the $NX_ROOT/site/cfg/log4j.properties file.
Manually merge the files that the utility failed to merge.
Copy the files from the merged folder location to $NX_ROOT/site/mods folder.
Execute the following command on the CA SDM server to clear the cache:
You can use any diff tools to verify that the merging process was successful.
Verification method 1: Compare the differences
In both the comparisons the differences must match, which indicates that the merge was successful. If not, then, manually merge the files.
Verification method 2: Compare the customization
In both the comparisons, the customization must match. If not, then, manually merge the files.
The merge utility fails when your customization falls under the following scenarios: