Siebel Interactive Designer API Reference
Introduction
How This Guide Is Organized
Revision History
Back to top
Application File Reference
Setting Variables in the Siebel Application CFG File
Files in the Application Base Directory
home.htm
kernel.htm
onl_boot.htm
Siebhome.htm
About the cs Directory
Files in the Custom Directory
app_config.js
customCode.js
Files in the ds Directory
pagesetID_x.js
prodlistdata.htm
Files in the jd Directory
intl.js
Files in the pg Directory
pagesetID_1.htm . . . pagesetID_"n".htm
pagesetID_i.htm
Associating a Pageset UI Definition File with a Particular Pageset
Defining Which Frames Display Each of the Display Pages
Specifying Which Frame Displays Exception Messages
onlink.css
oc_default_ui.htm
pl_bullet1.gif, pl_bullet2.gif, pl_bullet3.gif, pl_bullet4.gif
Files in the ui Directory
about.htm (example only)
help*.gif (example only)
help_*.htm (example only)
helpset.htm (example only)
nf_white.htm
ol_fly.htm (example only)
ol_ui.htm
trans.gif
welcome.htm
Back to top
Reserved Word Reference
Interactive Designer and Browser-Based Applications Reserved Words
JavaScript Reserved Words
Back to top
Siebel-Specific Functions
AddToSSCart
BuildAttributeList
BuildChildList
BuildProductStr
Supporting Cell Functions
BuildQuestionAnswerString()
CreateOpportunity()
GetCDAEntryArg()
GetCDAEntryArgs()
GetPrice
Additional Pricing Functions
GotoSSConfigurator
GoToSSView
SendSelectionInformationToServer
Using the CDA Service Broker in the ISSCDA RT UI Service
ShowCDA
ShowCDAWithDynDefStr
ShowProductDetails
Back to top
Utility Functions
ConvertFloatToCurrency
ConvertStrToDynDefObj
FrameToOLString
GetCSPath
GetCustomPath
GetDSPath
GetJDPath
GetPagesetDisplayArea()
GetPGPath
GetTopPath
GetUIPath
GetVisibleDisplayArea()
RegisterUI
RegisterUIElement
ShowAbout
ShowHelp
Back to top
User Interface Layout and Control Functions
RegisterCascade
RegisterExceptionFrames
RegisterFrameSet
RegisterMVar
RegisterPageLocation
RegisterPriorityPages
Back to top
Pageset Functions
Start On Active
Parameter Passing Formats
Implementing Start On Active
Start on Active File Format Conventions
Start on Active File Function Overview
SOALoadPageset (defaultPg, isActive)
SOAPassDynaObject ()
BuildTarget
Link Output Targets
Subconfiguration Link Output Targets
Optional Subconfiguration Link Output Targets
Image Output Targets
Text Output Targets
Content Sources for Output Targets
N-Back Link Target
N-Back Return Target
BuildWidget
Check Box Input UI Controls
Image Map Input UI Controls
List Box Input UI Controls
Radio Button Input UI Controls
Text Entry Input UI Controls
LinkToSubConfig
LoadFile
LoadPageset
LoadPagesetWithDynDefObj
Back to top
Contents List Functions
RegisterContentsListFrame
SetContentsListFrame
ShowContentsList
Back to top
Callout Point Functions
ClearAllOverrideFunctions
ClearOverrideFunction
OverrideFunction
COP_AppDataVersionCheck
COP_BeforeConfiguration
COP_BeforeDisplayPriceString
COP_InvalidItemAdded
COP_PagesetVersionCheck
COP_ValidItemAdded
InitApp
ORP_DisplayPrice
ORP_DisplayPriceString
Back to top
Data Access Functions
GetCurrInstance
GetFeatureData
GetInputState
GetInputValue
GetResultsValue
SetInputValue
PostThis()
Back to top
Data Objects
ConfigTable_Obj
ConfigTableArray_Obj
FeatureTable_Obj
FeatureTableArray_Obj
InputState_Obj
Label_Obj
Label_Obj.GetLabelName
Label_Obj.GetNumLabels
Back to top
API Examples
Example 1: Create a Custom Input UI Control
Example 2: Define a Pageset Layout
Contents of xxx_i.htm
Contents of oc_default_ui.htm
Example 3: Create a Custom Output Target
Example 4: Add Custom Behavior with a Callout Point
Example 5: Use the CDA Service Broker
Back to top
