SAML update to properties.xml leads to error "The reference to entity "RelayState" must end with the ';' delimiter."

Products

• Clarity PPM On Premise
• Clarity PPM SaaS

Issue/Introduction

When setting up SAML signonURL and timeoutURL, and restarting services, an error is thrown:

ERROR StatusLogger Cannot start ShutdownCallbackRegistry, already shutting down.
[clarity config]$ service stop all
[Fatal Error] :47:300: The reference to entity "RelayState" must end with the ';' delimiter.
Warning: document is invalid: /opt/clarity/config/properties.xml
org.xml.sax.SAXParseException; systemId: file:///opt/niku/clarity/config/properties.xml; lineNumber: 47; columnNumber: 300; The reference to entity "RelayState" must end with the ';' delimiter.
        at org.apache.xerces.util.ErrorHandlerWrapper.createSAXParseException(Unknown Source)
        at org.apache.xerces.util.ErrorHandlerWrapper.fatalError(Unknown Source)
        at org.apache.xerces.impl.XMLErrorReporter.reportError(Unknown Source)
        at org.apache.xerces.impl.XMLErrorReporter.reportError(Unknown Source)
        at org.apache.xerces.impl.XMLErrorReporter.reportError(Unknown Source)
        at org.apache.xerces.impl.XMLScanner.reportFatalError(Unknown Source)
        at org.apache.xerces.impl.XMLScanner.scanAttributeValue(Unknown Source)
        at org.apache.xerces.impl.XMLNSDocumentScannerImpl.scanAttribute(Unknown Source)
        at org.apache.xerces.impl.XMLNSDocumentScannerImpl.scanStartElement(Unknown Source)
        at org.apache.xerces.impl.XMLDocumentFragmentScannerImpl$FragmentContentDispatcher.dispatch(Unknown

Environment

Release : 16.0.3+

Resolution

1. In properties.xml, edit the signonURL and timeoutURL as follows:
2. Replace the '&' character to escape the character:
   • From
   • &RelayState=
   • to
   • &RelayState=
3. Save and restart the services