Siebel Advisor API Reference > Application File Reference for Siebel Advisor > Files in the pg Directory >

Associating a Pageset UI Definition File with a Particular Pageset


Because each pageset can have its own frameset layout, you must specify which file defines the frameset layout of the current pageset. Usually the Pageset UI Definition file is named pagesetID_ui.htm.

Use the RegisterFrameSet function to identify the Pageset UI Definition file associated with the current pageset. The syntax of this function is:

RegisterFrameSet(name,frameset_name,frame_name[,path])

where:

name

String used as the setLoaded parameter of the Pageset UI Definition file. This is usually the name of the frameset.

frameset_name

String identifying the file name of the Pageset UI Definition file.

frame_name

String identifying the complete path, from the top of the application, and name of the application frame, by default, mainArea, inside which the pageset frameset appears.

path

Optional string identifying the complete path.

Sample usage:

ISS.RegisterFrameSet("dogs_ui","dogs_ui.htm",
ISS.GetPagesetDisplayArea()
"server_name/CDA_application_root_directory/ui");

The first argument of the RegisterFrameSet function. In the example above, dogs_ui must be identical to the string used as the setLoaded parameter, most commonly, oc_default_ui or pagesetID_ui, inside the Pageset UI Definition file.

Siebel Advisor API Reference