|
Siebel Analytics Web Administration Guide > Working with Data and Managing the Web Catalog Using Siebel Analytics Web SOAP API > Description of Siebel Analytics Web SOAP API Methods >
WebCatalogService
Provides methods for navigating and managing the Web Catalog, and reading and writing Web Catalog objects in XML format. Table 52 shows the supported methods.
copyItem() Method
The copyItem() method copies an object from one location in the Web Catalog to another location in the Web Catalog. Signature
void copyItem(String pathSrc, String pathDest, String sessionID);
|
|
String pathSrc |
The current path to the object in the Web Catalog. |
String pathDest |
The location in the Web Catalog where the object should be copied. |
String sessionID |
A character string that identifies 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. |
createFolder() Method
The createFolder() method creates a new folder in the Web Catalog. Signature
void createFolder(String path, boolean createIfNotExists, String sessionID);
|
|
String path |
The location in the Web Catalog where the folder should be created, including the name of the new folder. |
boolean createIfNotExists |
A boolean value, 1 (true) or 0 (false). When set to true, the folder object is created in the Web Catalog if it does not already exist. When set to false, the folder object is not recreated if it already exists. |
String sessionID |
A character string that identifies 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. |
createLink() Method
The createLink() method creates a link to the Web Catalog. Signature
void createLink(String sPath, String sTargetPath, boolean overwriteIfExists, String sessionID);
|
|
String sPath |
The path to the parent object in the Web Catalog. |
String sTargetPath |
The location in the Web Catalog to which the link being created should refer. |
boolean overwriteIfExists |
A boolean value, 1 (true) or 0 (false). When set to true, the link is overwritten if it already exists in the Web Catalog. When set to false, the link is not overwritten if it already exists in the Web Catalog. |
String sessionID |
A character string that identifies 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. |
deleteItem() Method
The deleteItem() method deletes an object from the Web Catalog. To delete a folder, see removeFolder() Method. Signature
void deleteItem(String path, String sessionID);
|
|
String path |
The path to the object in the Web Catalog. |
String sessionID |
A character string that identifies 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. |
getItemInfo() Method
The getItemInfo() method gets Web Catalog information for an object. Signature
ItemInfo getItemInfo(String path, boolean resolveLinks, String sessionID);
|
|
String path |
The path to the object in the Web Catalog. |
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, Analytics retrieves information for the object pointed to by the link. |
String sessionID |
A character string that identifies 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. |
Returns
Returns Web Catalog information for an object in an ItemInfo structure. For more information, see ItemInfo Structure. getSubItems() Method
The getSubItems() method gets the collection of child subitems for an object in the Web Catalog. Signature
ItemInfo[] getSubItems(String path, String mask, boolean resolveLinks, GetSubItemsParams options, String sessionID);
|
|
String path |
The path to the parent object in the Web Catalog. |
String mask |
The mask that indicates the child subitems to retrieve. The mask character is an asterisk (*). To retrieve all child subitems, use a single asterisk. |
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, information is retrieved for the child subitems of the object pointed to by the link. |
GetSubItemsParams options |
Optional parameters supplied in the GetSubItemsParams structure. For information about the GetSubItemsParams structure, see GetSubItemsParams Structure. |
String sessionID |
A character string that identifies 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. |
Returns
Returns a collection of child subitems in an ItemInfo structure. For more information, see ItemInfo Structure. moveItem() Method
The moveItem() method moves an object in the Web Catalog to a different location in the Web Catalog. Signature
void moveItem(String pathScr, String pathDest, String sessionID);
|
|
String pathSrc |
The current path to the object in the Web Catalog. |
String pathDest |
The location in the Web Catalog where the object should be moved. |
String sessionID |
A character string that identifies 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. |
readObject() Method
The readObject() method reads an object from the Web Catalog and returns CatalogObject structure. Signature
CatalogObject readObject(String path, boolean returnXmlString, String sessionID);
|
|
String path |
The location where the retrieved object should be placed. |
boolean returnXmlString |
A boolean value, 1 (true) or 0 (false). When set to true, the catalogObject field returned in the CatalogObject structure is a character string that contains the XML representation of the object stored in the Web Catalog. When set to false, the SOAP client needs to analyze the xsi:type attribute of the root node of the returned XML to determine the type of object to create. If the xsi:type attribute is unknown, an exception may be thrown depending on the SOAP client's implementation. |
String sessionID |
A character string that identifies 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. |
Returns
Returns a CatalogObject structure containing the specified object from the Web Catalog. For a description of the CatalogObject structure, see CatalogObject Structure. removeFolder() Method
The removeFolder() method deletes a folder and its contents from the Web Catalog. To delete an object other than a folder and its contents, see deleteItem() Method. Signature
void removeFolder(String path, String sessionID);
|
|
String path |
The path to the folder in the Web Catalog. |
String sessionID |
A character string that identifies 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. |
setItemProperty() Method
The setItemProperty() method sets a property for an object in the Web Catalog. Signature
void setItemProperty(String path, String name, String value, String sessionID);
|
|
String path |
The path to the object in the Web Catalog. |
String name |
A character string that contains the name of the property to set. |
String value |
A character string that contains the new setting for the property. |
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. |
takeOwnership() Method
Take ownership on the specified item. Signature
void takeOwnership(String path, String sessionID);
|
|
String path |
The location in the Web Catalog of the object to take ownership. |
String sessionID |
A string value that contains the session ID to log off from the SOAP session. 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. |
writeObject() Method
The writeObject() method writes an object to the Web Catalog in XML format. Signature
void writeObject(CatalogObject object, String path, boolean resolveLinks, boolean allowOverwrite, String sessionID);
|
|
CatalogObject object |
The object to write to the Web Catalog, supplied in the CatalogObject structure. For information about the CatalogObject structure, see 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 COXmlDocument1. |
String path |
The location in the Web Catalog where the object 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 object 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 object already exists in the Web Catalog, it is overwritten. When set to false, if the object 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. |
writeReport() Method
The writeReport() method writes a set of results to the Web Catalog. Signature
void writeReport(CatalogObject object, String path, boolean resolveLinks, boolean allowOverwrite, String sessionID);
|
|
CatalogObject object |
The object to write to the Web Catalog, supplied in the CatalogObject structure. For information about the CatalogObject structure, see 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 queryitem1. |
String path |
The location in the Web Catalog where the results 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 results are 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 results already exist in the Web Catalog, they are overwritten. When set to false, if the results already exist in the Web Catalog, they are 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. |
writeDashboard() Method
The writeDashboard() method writes a dashboard object to the Web Catalog. Signature
void writeDashboard(CatalogObject object, String path, boolean resolveLinks, boolean allowOverwrite, String sessionID);
|
|
CatalogObject object |
The dashboard object to write to the Web Catalog, supplied in the CatalogObject structure. For information about the CatalogObject structure, see 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 dashboarditem1. |
String path |
The location in the Web Catalog where the dashboard object 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 object 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 object already exists in the Web Catalog, it is overwritten. When set to false, if the dashboard object 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. |
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);
|
|
CatalogObject object |
The dashboard prompt object to write to the Web Catalog, supplied in the CatalogObject structure. For information about the CatalogObject structure, see 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. |
writeDashboardPage() Method
The writeDashboardPage() method writes a dashboard page to the Web Catalog. Signature
void writeDashboardPage(CatalogObject object, String path, boolean resolveLinks, boolean allowOverwrite, String sessionID);
|
|
CatalogObject object |
The dashboard page object to write to the Web Catalog, supplied in the CatalogObject structure. For information about the CatalogObject structure, see 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 dashboardpageitem1. |
String path |
The location in the Web Catalog where the dashboard page 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 page 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 page already exists in the Web Catalog, it will be overwritten. When set to false, if the dashboard page 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. |
writeSavedFilter() Method
The writeSavedFilter() method i writes a filter to the Web Catalog. Signature
void writeSavedFilter(CatalogObject object, String path, boolean resolveLinks, boolean allowOverwrite, String sessionID);
|
|
CatalogObject object |
The filter object to write to the Web Catalog, supplied in the CatalogObject structure. For information about the CatalogObject structure, see 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 savedfilteritem1. |
String path |
The location in the Web Catalog where the filter 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 filter 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 filter already exists in the Web Catalog, it is overwritten. When set to false, if the filter 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. |
|
