Bookshelf Home | Contents | Index | Search | PDF

Siebel Interactive Designer API Reference > Pageset Functions > Start On Active >

Start on Active File Function Overview

---

InitApp(), a user-defined function customCode.js in the custom directory, is used to define the start state of the application. The API ISS.SOALoadPageset() calls Start on Active from the InitApp() function.

SOALoadPageset calls GetParmStr() to retrieve the URL query string. Before the string is returned, it is cleaned of special characters using the API CleanQuery(). If there is no query string, the default start page is passed as a parameter in ISS.SOALoadPageset() and loaded into the ISS.uiFrame. Otherwise, StartActive() is called to evaluate the query string.

StartActive first checks whether the query string matches the parameter pattern for the hidden frame approach. If so, the function LoadSOAFrame() is called to load the supplied file into ol_ui.dynaframe. This approach relies on the onLoad handler of the supplied file to call SOAPassDynaObject(). SOAPassDynaObject will parse the form contents into query string format and pass that string back into StartActive for evaluation.

If StartActive does not match the config_file_path pattern in the query string, it calls the GetPagesetID() function to parse out the pagesetid key/value pair. If the key/value pair is found, GetConfigObj() function is called to evaluate the string for dynamic defaults. If the pagesetid key/value pair cannot be retrieved, the default start page is loaded.

GetConfigObj() evaluates the query string against the supported parameter formats. If a pattern match is found, an ISS.DynDef_Obj is constructed with the key/value pairs specified in the query string. This object is returned to StartActive.

Finally, StartActive checks whether a configuration object was returned. If so, it calls ISS.LoadPagesetWithDynDefObj and passes the pagesetid and configuration object as parameters. If not, it calls ISS.LoadPageset with the pagesetid.

NOTE:  All calls to the Start On Active function should be of the form ISS.FunctionName(arg1,...argN);

Bookshelf Home | Contents | Index | Search | PDF