Administer > Service Request Catalog Customization > Appendix C: XML Tag Reference

Appendix C: XML tag reference

For this XML tag Insert this value
<configurations>
</configurations> 		Define one or more <configuration></configuration> sections
<configuration name="default">
</configuration>

Define all the necessary values to describe company customization values. The company name that you configure should match the default company name that is in the end user operator record.
<companyDisplayNameKey> </companyDisplayNameKey>

company_name is defined in

...\resources\client\en\Custom.properties

Custom.properties Example:company_name = XYZ

Example:

<companyDisplayNameKey>company_name </companyDisplayNameKey>
<resources></resources> Define one or more <resource></resource> sections within this parameter
<resource></resource>

panel.swf should be in this folder:
...\secure\configuration\default\

Example:...\secure\configuration\default\panel.swf

panel.swf contains your custom color selections.

Example:<resource>panel.swf</resource>

<styles></styles> Define one or more <style><style> sections.
<style></style> styles.css should be in this folder
...\secure\configuration\default\

Example:...\secure\configuration\default\styles.swf

styles.xml contains your custom display settings.

Example:<style>styles.swf</style>
<launchersGroup>
</launchersGroup>

Define the launchers that will appear on each landing page.
<launchers
displayOn="landingpage"
showIconOnly="false" showButtons="true">
horizontalAlign="left"
</launchers>

Identify the third party launchers that will appear on the Dashboard and other landing pages.

displayOn=DASHBOARD|SERVICE|SUPPORT
showIconOnly= "true"|"false"
showButtons="true"|"false"
horizontalAlign="left|right"
<launcher
displayOrder="n"
launcherId="id"
target="_blank|_self"
showLogoBox="true"
showLogoDropShadow="true">

You can show the logo as an icon and apply a drop shadow to the icon.

displayOrder="n" - order of appearance (left-to-right and top-to-bottom)

launcherid="id"- a unique user-defined value for each launcher.

target="_blank|_self" - determines whether content is displayed in a new tab or the existing tab. "_blank" opens a new tab and "_self" retains the current tab.

showLogoBox="true"|"false"
showLogoDropShadow="true"|"false"
<logo></logo>

Your launcher logo file should be in this folder:

...\secure\configuration\default\applications

The optimum size is 83x83px and the resolution should be 72 dpi.

Example:...\secure\configuration\default\applications\abc.png

The file format must be .png, .gif, or .jpg

Example:<logo>abc.png</logo>

<titleKey></titleKey>

titleKey value from the Custom.properties file.

Example:<titleKey>launcherName</titleKey>

The inserted ID value cannot contain blanks. Use underscore characters as separators if necessary. The display value can contain blank characters.

Custom.properties Example:

Id Value          Display Value

launcherName = XYZ Company

<descriptionKey>
</descriptionKey>

descriptionKey value from the Custom.properties file.

Example:<descriptionKey>launcherDesc</descriptionKey>

The inserted ID value cannot contain blanks. Use underscore characters as separators if necessary. The display value can contain blank characters.

Custom.properties Example:

Id Value          Display Value

launcherDesc  = The XYZ Company gives you information about XYZ widgets!

<launcherType>
</launcherType>

Specify the type of third party link:

  • APP to link to an application, like Wikipedia.
  • MEDIA to open a video window.

The link type value must be upper case.

Example:<launcherType>MEDIA</launcherType>

<fields>
</fields>

Optional: Define one or more individual fields to appear in a popup window.

<field fieldID="ID">

Define a field that will appear in a pop-up window.

Field ID is a unique user-defined value for each field.

Example:<field fieldId="GetName">

<labelKey>
</labelKey>

labelKey value from the Custom.properties file.

Typically, this is an informational label or text string that might precede a text box or just communicate information.

Example:<labelKey>textLabel</labelKey>

Custom.properties Example:

Id Value   Display Value

textLabel = Select One:

or

textLabel = You are about to open a new window.

<type></type>

Type of field. Choose one:

  • TEXT to display any text
  • TEXTAREA to gather user information
  • DROPDOWN for list information
  • HIDDEN for passing information, like a token

Note: Make sure you type these values in upper case.

Examples:

<type>TEXT</type>

<type>TEXTAREA</type>

<type>DROPDOWN</type>

<type>HIDDEN</type>
<defaultValue>
</defaultValue>

Specify a constant value to display, such as a list item or other value that you want to pre-populate with static content.

Examples:<defaultValue>Welcome!</defaultValue> 

<options>
</options>
 Insert individual <option></option> values to define values for a dropdown list.
<option></option>

For each <option></option> tag set, insert <labelKey></labelKey> and <value></value> tags and related values.

Example:

<option>

    <labelKey></labelKey>

    <value></value>

</option>

<labelKey></labelKey> labelKey value from the Custom.properties file.

In an option list, specify the key name of a single list value that you want to display in the user interface.

Example:<labelKey>dropdown_1</labelKey>

Custom.properties Example:

Id Value     Display Value

dropdown1 = Black

dropdown2 = Red
<value></value>

This value can be the same as you defined in the Custom.properties file, or might be a different value to be passed to the third party application server.

Example:

<value>color</value>

<action></action>

The action describes how data will be passed to the third party application.

<link></link>

Insert the URL for the link in a CDATA tag.

Example:<![CDATA[www.google.com]]>

Example:<link><![CDATA[http://www.XYZ.com]]></link>

<method></method>

Specify the appropriate action:

  • GET enables form data to be encoded by the browser into a URL.
  • POST enables form data to be encapsulated in a message.

Note If the Post request is to access a different domain (server URL), you must confirm that there is a cross-domain policy file configured at the root directory of the remote domain. The cross domain policy file grants access to the sender passing transactional data to that server.

Example: Successful connection to a third-party application in a remote domain, like www.XYZ.com requires a crossdomain.xml file to exist at this location:

www.XYZ.com/crossdomain.xml

The crossdomain.xml file would contain a section like this:

<cross-domain-policy>
<allow-access-from domain="*.ABC.com" secure="false"/>
</cross-domain-policy>

Examples:

<method>GET</method>

<method>POST</method>