Signature Returns startPage Method

Description of Services and Methods in Oracle BI EE Web Services 3-9

3.3 iBotService Service

Use this service to save, edit, delete, subscribe, unsubscribe, customize, and execute Oracle BI EE agents. Note that as of the Oracle Business Intelligence 11g 11.1.1 release, iBots have been renamed to agents. Table 3–4 shows the supported methods.

3.3.1 writeIBot Method

Use this method to write a new agent to the catalog and to register it with Oracle BI Scheduler. Note that this method is different from the WebCatalogService service’s writeObjects Method , which only writes to the catalog.

3.3.1.1 Signature

int writeIBot CatalogObject obj, String path, boolean resolveLinks, boolean allowOverwrite, String sessionID;

3.3.2 deleteIBot Method

Use this method to delete a saved agent. Deleting an agent not only removes it the object from the catalog, but it also deregisters the agent from the Oracle BI Scheduler. Note that this method is different from the WebCatalogService Service deleteitem Table 3–4 iBotService Methods Method Names Description Section 3.3.1, writeIBot Method Writes a new agent into the catalog and registers it with Oracle BI Scheduler. Section 3.3.2, deleteIBot Method Deletes an agent from the catalog and deregisters it from the Oracle BI Scheduler. Section 3.3.3, executeIBotNow Method Executes an agent saved in the catalog. Section 3.3.4, moveIBot Method Moves an agent from one catalog folder to another. Section 3.3.5, sendMessage Method Sends a message to an Oracle BI EE user, group, or user and group. Section 3.3.6, subscribe Method Subscribes to a published agent. Also customizes your subscription. Section 3.3.7, unsubscribe Method Unsubscribes from an agent. Arguments Description CatalogObject obj Specifies the object to be written to the catalog. The objects XML is validated against analysis_ibot.xsd, which is located in orahomebifoundationwebschemas directory. String path Specifies the full path and name of the agent in the catalog. For example, usersjchaniBotsBrandDollars. boolean resolveLinks If set to TRUE and the path in the catalog refers to a link, then the object is written to the location pointed to by the link. boolean allowOverwrite Specifies whether to overwrite an existing object. Set to TRUE to overwrite any object already present in the location specified by path. String sessionID Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. 3-10 Oracle Fusion Middleware Integrators Guide for Oracle Business Intelligence Enterprise Edition method because the deleteitem method does not deregister the agent from the Oracle BI Scheduler.

3.3.2.1 Signature

void deleteIBot String path, String sessionID;

3.3.3 executeIBotNow Method

Use this method to execute an agent that is stored in the catalog. Note that this method does not change the agent’s original schedule.

3.3.3.1 Signature

void executeIBotNowString path, String sessionID;

3.3.4 moveIBot Method

Use this method to move an agent from one catalog folder to another. Note that this method is different from the WebCatalogService Service moveItem method because the moveItem method moves the catalog object and informs the Oracle BI Scheduler that the object was moved.

3.3.4.1 Signature

void moveIBotString fromPath, String toPath, boolean resolveLinks, boolean allowOverwrite, String sessionID; Arguments Description String path Specifies the full path and name of the agent in the catalog. For example, usersjchaniBotsBrandDollars. String sessionID Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. Arguments Description String path Specifies the full path and name of the agent in the catalog. For example, usersjchaniBotsBrandDollars. String sessionID Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. Arguments Description String fromPath Specifies the full catalog path of the agent to be moved. String toPath Specifies the full catalog path where the agent will be moved to. boolean resolveLinks Specifies if you want to move the child objects. If this argument is set to TRUE and the path specified in the fromPath argument is a link, then the child object pointed to by that link will be moved. boolean allowOverwrite Specifies if you want to overwrite an existing object. If this argument is set to TRUE and another catalog object existed in the path specified by toPath, it will be overwritten. String sessionID Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.