Along with a variety & wide range of domain coverage in SHR out-of-the-box content, Customizations with SHR offer a powerful & a much sought after flexibility. While customizations can be extensively carried out with the product, maintaining and making them available post product upgrades is an equally important task as well.
When a new version of SHR is released and adopted by customers, there is always is a concern on the customizations that were done which are tailor made for specific customer use cases. It is so vital to keep them secured and use them with latest version of SHR as well.
In this blog, we will take you through steps and tips to ensure Universe & report level customizations performed stay intact and also advocate the best practices on maintenance aspects.
Report and Universe Customization
Report and Universe customization is one of the most widely ventured areas of extensions and here we strongly advocate making use of Content Development Environment (CDE) to secure content for easy maintenance of the report related artifacts (.BIAR files)
Note: It is very essential to make sure that the customizations are carried out on a copy of the Universe & reports & that the out of the box content remain untouched.
Steps to create installable package of custom Reports & Universe.
Create an ‘Application’ content pack using CDE, illustrated with an example as below:
Note: Remove model_template.xml and stream_template.xml files which are available in the package structure by default.
Create manifest template for the ‘Application’ package.
Syntax: ant createManifestTemplate
If the package is applicable to only one Toplology (RTSM/OM/Vcenter) source, it needs to be accordingly specified under <metadata> tag.
So also, fill in required metadata details for the content and publisher names.
For more details please refer to “ContentDevelopment Reference Guide”.
Run the ‘ant’ utility to build the installable package.
Copy the installable package in %PMDB_HOME%/packages folder and install using ‘deployment manager’.
a) Copy the package from ‘dist’ folder to %PMDB_HOME%/packages
b) Launch Deployment manager and install the custom content.
Other areas of customization:
Custom groups are one of the most employed features of SHR as far as customization is concerned. The custom group XMLs created are copied under
Downtime is also one of the most used features of the SHR and the XMLs may need to be backed-up for all practical future references. The configured downtime XMLs would be available under the following location.
Any custom Domain & ETL packages that are already installed should have been part of %PMDB_HOME%/packages. Hence no additional backup task is required.
Any scripts created for custom usages, have to be backed up manually and redeployed post upgrade.
There are several exposed properties in %PMDB_HOME%/data/config.prp. This requires to be manually backed-up for references.
A very useful thing to do would be to document the list of customizations that are carried out with SHR. It is indeed a very a great practice to have an orderly way to keep the customizations secured.
Finally, SHR offers a great scope to extend the product in accordance to customer needs. While creating the customization is an important task, keeping them secured is equally vital as well. Hope this document has touch based on the key areas of customization which requires the attention of the SHR user.