After upgrading to Spectrum 24.3.9 OneClick Customizations are no longer working

Products

• Network Observability
• Spectrum

Issue/Introduction

We have recently upgraded to Spectrum 24.3.9 and we have noticed that our OneClick Customizations are no longer working.  These customizations were working previously as of 24.3.7 and have been added for many years in Spectrum without any problems.

When we load OneClick, we see many popups with error messages like

 

SPC-OCC-10244: The XML file: view-devicedetails-config.xml#factory was not found while parsing file view-devicedetails-config.xml  Please contact your system administrator to resolve the issue, then restart this client.  Config file table-model-config.xml#factory is not valid because it contains a directory/invalid character.

and

SPC-OCC-10243: The XML file table-model.config.xml#factory was not found.  Please contact your system administrator to resolve the issue, then restart the client.  Config file table-model-config.xml#factory is not valid because it contains a directory/invalid character.

Environment

Spectrum 24.3.9

OneClick Custom files. (working previous to the upgrade)

Cause

Missing # character in web.xml file for parameter configXmlfileNamePattern

If there is a custom file then OneClick will differentiate the factory file by adding #factory at the end of the file name, If there is no custom file then it doesn't suffix that #factory and hence it doesn't throw that error.  This is all internal to OneClick and how it works and is normally not present to the users.

 

Resolution

1. Make a backup of the web.xml file from $SPECROOT/tomcat/webapps/spectrum/WEB-INF directory.

2. Edit the web.xml file and search for configXmlfileNamePattern

3. Carefully edit the param-value below to include the # character in the exact place as shown below.

<param-value>^[a-zA-Z0-9._#-]+$</param-value>

4. Ensure that the updated value looks like this:

 

<servlet xmlns="">
    <servlet-name>FindConfigServlet</servlet-name>
    <servlet-class>com.aprisma.spectrum.app.web.servlet.FindConfigServlet</servlet-class>
    <init-param>
      <param-name>configXmlfileNamePattern</param-name>
      <param-value>^[a-zA-Z0-9._#-]+$</param-value>
    </init-param>
  </servlet>

 

5. Close out any existing clients and stop and restart Spectrum tomcat service.

Additional Information

This is scheduled to be fixed out of the box in Spectrum 24.3.10 under DE170604.

 

If you do not have any OneClick customizations, you will not see these errors.