|
Siebel Analytics Web Administration Guide > Working with Data and Managing the Web Catalog Using Siebel Analytics Web SOAP API > Description of Methods in the Siebel Analytics Web SOAP API >
Writing a Dashboard Prompt to the Web Catalog Using the writeDashboardPrompt() Method in the Siebel Analytics Web SOAP API
The writeDashboardPrompt() method in the WebCatalogService service writes a dashboard prompt to the Web Catalog. Description of Parameters in the writeDashboardPrompt() Method
The writeDashboardPrompt() method parameters are described in the following table.
|
|
CatalogObject object |
The dashboard prompt object to write to the Web Catalog, supplied in the CatalogObject structure. For information about the CatalogObject structure, see Specifying Information for a Web Catalog Object Using the CatalogObject Structure in the Siebel Analytics Web SOAP API. All fields of object.itemInfo are ignored, except for the array of item properties, which are applied to the object. The signature of the resulting document is always globalfilteritem1. |
String path |
The location in the Web Catalog where the dashboard prompt should be written. |
Boolean resolveLinks |
A Boolean value, 1 (true) or 0 (false). When set to true, and the path in the Web Catalog refers to a link, the dashboard prompt is written to the location pointed to by the link. |
Boolean allowOverwrite |
A Boolean value, 1 (true) or 0 (false). When set to true, if the dashboard prompt already exists in the Web Catalog, it will be overwritten. When set to false, if the dashboard prompt already exists in the Web Catalog, it will not be overwritten. |
String sessionID |
A character string that contains the session ID. The session ID is usually returned by the logon call. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. |
|
