Template customization audit tool#

Overview#

You can run the template customization audit tool on a selected hierarchy node to identify template definitions and instances that were not delivered in the standard template packages during an installation or upgrade.

The audit report includes custom model schema definitions as well as data, domain, and view instances created on the hierarchy node as a result of workflow execution.

Use the report to verify that there are no unexpected instances at the specified hierarchy node.

Run the template customization audit tool#

  1. Log in as a customer administrator or higher.

  2. Set the hierarchy path to the level from which you want to run your audit.

    From a given hierarchy node, you can audit customized templates at the node, and at nodes directly above or below the node in the hierarchy tree.

  3. Choose Administration Tools > Reports > Audit Template Customization.

  4. Choose the hierarchy node for which you want to audit customized templates.

  5. Click Save.

Next steps

View the audit report. See “View Template Customization Audit Reports”.

View template customization audit reports#

  1. Log in as provider, reseller, customer, or higher level administrator.

  2. Choose Administration Tools > Reports > Template Customization Reports. A list of template customization audit reports is displayed.

  3. Click a report to view the details. The message field shows how many customized templates were found at the hierarchy node. The details fields lists the model type and instance of each customized template.

Example template customization audit reports#

The purpose of a Template Customization Audit Reports is to provide a record of changes as a result of workflow execution at a particular hierarchy, in particular:

  • data, relation, and view instances of standard models that include for example Configuration Templates, Field Display Policies, Macros.

  • custom model schema definitions that may have been created at the site (for example, instances of data/DataModel) as a result of a custom adaptation.

Consider an example customization report that was created at a Site hierarchy called: LOC001.

After the report is created from the Administration Tools > Reports > Audit Template Customization menu, it shows as an item in the list of reports on the Administration Tools > Reports > Template Customization Reports menu.

The report can be identified by checking the creation Timestamp and Message columns of the list. The message would contain the number of templates and the phrase that shows the Site hierarchy, for example:

544 customized templates were found at sys.hcs.CS-P.CS-NB.AAAGlobal.LOC001

The Details list in the report shows entries of the format:

Model Type: data/User, \
Instance: bkey(["QAS0003", "hcs.CS-P.CS-NB.AAAGlobal.LOC001"]), \
pkid(5949dd115da9aa9559aa2386)

Model Type: data/ConfigurationTemplate, \
Instance: bkey(["Reference CUCM User Template", \
                "device/cucm/User", \
                "hcs.CS-P.CS-NB.AAAGlobal.LOC001"]), \
pkid(5949dcd15da9aa9559aa1b2d)

Model Type: data/Macro, \
Instance: bkey(["CUSTOMER_INI_ENABLED", \
                "hcs.CS-P.CS-NB.AAAGlobal.LOC001"]), \
 pkid(5949db2a5da9aa9559aa01d9)

From the list details, it is possible to see the model instances created at the site - defined by type, business key and pkid.

This provides administrators with information when inspecting data at a hierarchy for troubleshooting or for reference when contacting support operators.