Siebel Analytics Web Services Guide > Description of Siebel Analytics Web SOAP API Methods > WebCatalogService Service >

writeDashboardPrompt() Method


The writeDashboardPrompt() method writes a dashboard prompt to the Web Catalog.

Signature

void writeDashboardPrompt(CatalogObject object, String path, boolean resolveLinks, boolean allowOverwrite, String sessionID);

Arguments
Description

CatalogObject object

The dashboard prompt object to write to the Web Catalog, supplied in the CatalogObject structure. For information about the CatalogObject structure, read CatalogObject Structure.

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 is overwritten. When set to false, if the dashboard prompt already exists in the Web Catalog, it is not 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.

Siebel Analytics Web Services Guide