Siebel Applications Administration Guide > Usage Pattern Tracking > Application Programming Interfaces for Usage Pattern Tracking >

JavaScript Application Programming Interface

The JavaScript application programming interface (API) follows:

SiebelApp.S_App.TriggerUPTEvent(inputPropSet)

Example code for this API follows:

var uptRecord = CCFMiscUtil_CreatePropSet();

var details = CCFMiscUtil_CreatePropSet();

uptRecord.SetType("UPT");

uptRecord.SetProperty("Object Type", "Application");

uptRecord.SetProperty("Object Name", "Siebel Universal Agent");

uptRecord.SetProperty("Event Name", "UPTClientScript");

uptRecord.SetProperty("Event Sub name", "Test");

uptRecord.SetProperty("Event Source", "Client Script");

uptRecord.SetProperty("Event Context", "Test UPT");

details.SetType("UPT Details");

details.SetProperty("Detail1", "Test UPT Value1");

details.SetProperty("Detail2", "Test UPT Value2");

uptRecord.AddChild(details);

SiebelApp.S_App.TriggerUPTEvent(uptRecord)

Information about the input property set follows:

• The Object Type property is a value of Applet, Application, or BusComp. This default value is Application.
• The Object Name property is a value that you specify. The default value is the application name from the configuration file.
• The Event Name property is a value of UPTGeneric, UPTClientScript, or UPTServerScript. The default value is UPTClientScript.
• The Event SubName property is a value that you specify. You can specify no value.
• The Event Source property is a value that you specify. The default value is Client Script.
• The Event Context property is a value that you specify.