There are instances when organizations want to add client-specific validations, functionalities or new applications to Maximo Asset Management that don’t exist out-of-the-box. Luckily, Maximo caters to this with its add-on methodology and packages can be installed numerous times on different Maximo installations with custom add-on products.
Why is the custom add-on product feature necessary?
Sometimes customer-built customizations are lost during the process of installing or rebuilding a custom add-on product. For example, if the customer is extending their custom classes with other extending products, then those classes will be overwritten by other products once they have been installed, causing the customer customizations to be lost in the process.
The functionality and integrity of the add-on products can be maintained through the customproduct.xml.
What is customproduct.xml?
The customproduct.xml file tells us which Maximo objects we are extending and can also be used to point Maximo installations – updatedb – to the proper database change scripts (dbc) that will then install the product. It is vital to register all customizations and add-ons through the customproduct.xml file, otherwise the functionality will be lost during the patching/upgrading stage.
Where can the product.xml be placed?
In order to maintain the customizations, the custom product xml file should be placed in applications\maximo\properties\product folder. This customproduct xml file is a uniquely named XML file.
XML files in the product folder are run alphabetically.
If a customproduct.xml file needs to be run first, then it should be named as a_customproduct.xml (example a_XYZ.xml).
If a customproduct.xml file needs to be run last, then it should be named as z_customproduct.xml (example z_XYZ.xml).
Below is an example of a customproduct.xml file
What these XML tags imply:
dbmaxvarname – The dbmaxvarname is the varname in the maxvars table for the custom product. It will be created automatically when the updatedb utility is run with this customproduct xml file for the first time.
dbscripts – The directory in tools\maximo\en\cust where all script files will be located.
dbversion – Current database script number. Scripts will run in this version.
lastdbversion – Last released version or first script number for this release.
depends – Name of the file on which this product depends.
extensions – This is useful when more than one product implements the same object. For example, if productA has a class file for object PO and productB has a class file for the same object PO, then class file of productB should extend from class file of productA.
The customproduct.xml files defined in the product directory are run by using Updatedb utility in the tools\Maximo folder.
How custom add-on products work:
For each product description file in the Product folder, Updatedb runs database scripts in tools\Maximo\en\cust first, followed by the extensions. In the event that the ‘depends’ tag is present in the customproduct.xml file, then the updated utility checks if (a) the file name has been specified in the product directory and (b) if this file has already run before. If the file exists and has already run previously, it will continue running this file. Alternatively, it will skip this file and continue with the next file in alphabetical order. For example, Mobile-Calibration depends on Mobile. Mobile-Calibration should only be run if Mobile is already being run. In this case, we can add the ‘depends’ tag in the Mobile-Calibration product file.
If the customer wants to run part of the custom script\classes before the depended part, they can keep customproduct.xml without the depends tag to run at the beginning and then create another customproduct.xml with the depends tag to run later on for other products.
Extensions can contain mboset, mbo, attributename, service name, bean class name and regular java class name.
If you have any queries or comments about the contents of this blog, please send a message to BPD Zenith.