Relative URL Overview

This chapter describes how to invoke the relative URLs and how to use optional and required parameters in the relative URL path.

Invoking the Relative URLs

Invoke a relative URL by entering the URL into an XML-aware application. There are four relative URLs available: Agents URL, Alerts URL, MicroAgents URL, and Invoke URL.

The format for each relative URL is:

http://web_server:port/http/relative_url[?param=value&param=value&param=value...]

Each relative URL can take optional parameters. The MicroAgents URL and the Invoke URL each have required parameters. Examples of each relative URL, along with optional and required parameters, are provided later in this chapter.


	The relative URL examples in this chapter assume the WAR file was extracted into HAWK_HOME/webconsole/tomcat/webapps.

Invoking Relative URLs from the Index Page

You can also invoke Agents and Alerts from links on the TIBCO Hawk HTTP Adapter Index Page. These pages are invoked using the default stylesheet. After the page is displayed, you can add parameters to the path in the browser ’s address field as described later in this chapter. (The MicroAgents URL and Invoke URL have required parameters and cannot be invoked from the index page.)

Using Parameters in Relative URLs

The relative URLs use optional and required parameters. You can include parameters when you first enter the relative URL in the browser’s address field, or invoke the relative URL and then add parameters to the path.

The following considerations apply to parameters in relative URLs:

•

Parameter names are case-sensitive.

•

To include a parameter, type a ? (question mark) after the relative URL and enter the parameter and its value, separated by = (equal sign).

•

If a parameter contains special characters, follow the standard encoding rule for URLs, such as replacing a space with the character + (plus sign).

•

Use & (ampersand) between additional parameter pairs.

•

You can pass a null value to a parameter by not specifying a value after the = character.

Examples of using optional and required parameters with each relative URL are given later in this chapter.

Order of Parameters

If you are using the optional parameter Style, it is recommended to list it first. The order of any remaining optional or required parameters in the path is not important.

Additional Parameters

If an optional or required parameter takes additional parameters, you can include them in the relative URL.

For example, the Invoke URL has a required parameter, Method. The method getConfig requires the parameter Interface Name. You can enter the Interface Name parameter with the value hme0 in the Invoke URL as shown (text bold for emphasis):

http://localhost:8081/http/Invoke?Agent=Solaris_26&MicroAgent=Network&MAIndex=0&Method=getConfig&Interface+Name=hme0