Administer > Service Request Catalog Customization > Working with manifest.xml

Working with the manifest file

This file contains information about the presentation of the Dashboard and other landing pages for your company. This file also points to other resources that contribute to the look and feel of your user interface, such as your company name, color palette, and other presentation styles.

The manifest.xml file has basic sections for capturing this information.

<configuration name="">
	<companyDisplayNameKey> 
	<resources>
	<styles>
	<launchersGroup>
	<widgetsGroup>
</configuration>

See the Appendix C: XML tag reference for more information about configuring the individual tags in each section.

Use the validator tool for manifest.xml

Service Request Catalog comes with a prepackaged validation tool that you can use to help ensure that your manifest.xml file is valid and usable. The validator tool can be found in the Service Request Catalog release .zip package. The vtool consists of the following two script files for Windows and Linux operating systems:

  • validator.bat
  • validator.sh

For example, you would enter the following command on a Windows system to use the validation tool:

validate.bat -c "<path>"

Note The <path> placeholder tag represents the file system path where you have the manifest.xml file.

After running this command, you will receive the following message if your manifest.xml file is valid:

"manifest.xml is valid!"

If your manifest file is not valid, you will receive an error message. The following table demonstrates some of the error messages you may receive:

Error: Cannot read manifest file: <path> Description
org.xml.sax.SAXParseException: cvc-datatype-valid.1.2.1: 'abc' is not a valid value for 'integer'. A string value is present in some elements that requires an in integer value.
org.xml.sax.SAXParseException: cvc-complex-type.2.4.b: The content of element 'configurations' is not complete. One of '{configuration}' is expected. The <configurations> parent node must contain at least one <configuration> child node.
org.xml.sax.SAXParseException: cvc-complex-type.2.4.a: Invalid content was found starting with element 'resources'. One of '{styles, widgetsGroup, launchersGroup}' is expected. The <resources> element can contain only one of each of the following: <styles>, <widgetsGroup>, <launchersGroup>
org.xml.sax.SAXParseException: cvc-complex-type.4: Attribute 'displayOn' must appear on element 'launchers'. The displayOn attribute is not present in the <launchers> element.
org.xml.sax.SAXParseException: cvc-enumeration-valid: Value 'CHOICE' is not facet-valid with respect to enumeration '[TEXT, TEXTAREA, DROPDOWN, HIDDEN]'. It must be a value from the enumeration. Type of fields in the <launcher> must be a value from the enumeration [TEXT, TEXTAREA, DROPDOWN, HIDDEN].