iBotService Service
Use the iBotService service to save, edit, delete, subscribe, unsubscribe, customize, and execute Oracle Analytics agents. Note that as of the Oracle Business Intelligence 11g (11.1.1) release, "iBots" have been renamed to "agents."
| Method Names | Description |
|---|---|
|
Deletes an agent from the catalog and deregisters it from the Oracle Analytics Scheduler. |
|
|
Enables an Oracle Analytics agent. |
|
|
Executes an agent saved in the catalog. |
|
|
Gets the paths of the agents of a specified user. |
|
|
Gets the agents from a specified path. |
|
|
Moves an agent from one catalog folder to another. |
|
|
Specifies the alerts to be deleted. |
|
|
Gets the status of the specified agent. |
|
|
Sends a message to an Oracle Analytics user, group, or user and group. |
|
|
Subscribes to a published agent. Also customizes your subscription. |
|
|
Unsubscribes from an agent. |
|
|
Writes a new agent into the catalog and registers it with Oracle Analytics Scheduler. |
deleteIBot() Method
Use the deleteIBot() 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 Analytics Scheduler. Note that this method is different from the deleteitem() method of WebCatalogService because the deleteitem() method doesn't deregister the agent from the Oracle Analytics Scheduler.
Signature
void deleteIBot(String path, String sessionID);
| Arguments | Description |
|---|---|
|
String path |
Specifies the full path and name of the agent in the catalog. For example, /users/jchan/iBots/BrandDollars. |
|
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. |
enableIBot() Method
Use the enableIBot() method to enable an Oracle Analytics agent.
Signature
enableIBotResult enableIBot(String path, boolean enable, String sessionID);
| Argument | Description |
|---|---|
|
String path |
Specifies the full path and name of the agent in the catalog. For example, /users/jchan/iBots/BrandDollars. |
| boolean enable | Specifies whether to enable the specified agent. |
|
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. |
Returns
Returns enableIBotResult.
executeIBotNow() Method
Use the executeIBotNow() method to execute an agent that's stored in the catalog. Note that this method doesn't change the agent's original schedule.
Signature
void executeIBotNow(String path, String sessionID);
| Arguments | Description |
|---|---|
|
String path |
Specifies the full path and name of the agent in the catalog. For example, /users/jchan/iBots/BrandDollars. |
|
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. |
getAgentPaths() Method
Use the getAgentPaths() method to get the paths of the Oracle Analytics agents of a specified user.
Signature
getAgentPathsResult getAgentPaths(String userID, String sessionID);
| Argument | Description |
|---|---|
|
String userID |
Specifies the user ID of the user to get the paths of the agents. |
|
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. |
Returns
Returns getAgentPathsResult.
getAgents() Method
Use the getAgents() method to get the Oracle Analytics agents in a specified path.
Signature
getAgentsResult getAgents(String agentPath, String sessionID);
| Argument | Description |
|---|---|
|
String agentPath |
Specifies the full path in the catalog. |
|
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. |
Returns
Returns getAgentsResult.
getIBotStatus() Method
Use the getIBotStatus() method to get the status of the specified Oracle Analytics agent.
Signature
getIBotStatusResult getIBotStatus(String path, String sessionID);
| Argument | Description |
|---|---|
|
String path |
Specifies the full path of the agent in the catalog. |
|
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. |
Returns
Returns getIBotStatusResult.
moveIBot() Method
Use the moveIBot() method to move an agent from one catalog folder to another. Note that this method is different from the moveItem() method of WebCatalogService Service because the moveItem() method moves the catalog object and informs the Oracle Analytics Scheduler that the object was moved.
Signature
void moveIBot(String fromPath, String toPath, boolean resolveLinks, boolean allowOverwrite, String sessionID);
| 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 is 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 is 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 is 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. |
purgeAlerts() Method
Use the purgeAlerts() method to delete the alerts that are older than the specified time.
Signature
purgeAlertsResult purgeAlerts(Unsigned Integer maxAgeSecs, String userGlob, String sessionID);
| Argument | Description |
|---|---|
|
Unsigned Integer maxAgeSecs |
Specifies the age of the alert in seconds. Alerts older than this will be deleted. Use 0 to delete the alert irrespective of the age. |
|
String userGlob |
Specifies the user whose alerts has to be deleted. Specify the wildcard * to delete alerts for all users. |
|
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. |
Returns
Returns the number of alerts purged, how many user's alerts were checked, alerts remaining, and if any errors occured.
sendMessage() Method
Use the sendMessage() method to send a message to an Oracle Analytics user, group, or user and group. The message is delivered according to the corresponding recipient's delivery profile, which was set up in the My Account dialog in Oracle Analytics Presentation Services.
Signature
String sendMessage(String[] recipient, String[] group, String subject, String body, String priority, String sessionID);
| Arguments | Description |
|---|---|
|
String[] recipient |
Specifies the GUID of the Oracle Analytics user to whom you want to send the message. You can include more than one user in this argument. |
|
String[] group |
Specifies the GUID of the Oracle Analytics group to whom you want to send the message. You can include more than one group in this argument. |
|
String subject |
Specifies the subject line of the message. |
|
String body |
Specifies the text to be included in the body of the message. |
|
String priority |
Specifies the message's priority. You can specify "High," "Normal," or "Low." |
|
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. |
subscribe() Method
Use the subscribe() method to subscribe to a published agent. If the agent allows customization, then you can also specify the customization XML.
Signature
void subscribe(String path, String customizationXml, String sessionID);
| Arguments | Description |
|---|---|
|
String path |
Specifies the full path and name of the agent in the catalog. For example, /users/jchan/iBots/BrandDollars. |
|
String customizationXml |
Specifies the customization XML (only if the agent allows customizations). This XML is validated against the customization schema available in orahome/bifoundation/web/schemas/analysis_customization. |
|
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. |
unsubscribe() Method
Use the unsubscribe() method to unsubscribe from an agent. This method also deletes any user customizations.
Signature
void unsubscribe(String path, String sessionID);
| Arguments | Description |
|---|---|
|
String path |
Specifies the full path and name of the agent in the catalog. For example, /users/jchan/iBots/BrandDollars. |
|
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. |
writeIBot() Method
Use the writeIBot() method to write a new agent to the catalog and to register it with Oracle Analytics Scheduler. Note that this method is different from the writeObjects() method of WebCatalogService. The writeObjects() method only writes to the catalog.
Signature
int writeIBot(CatalogObject obj, String path, boolean resolveLinks, boolean allowOverwrite, String sessionID);
| Arguments | Description |
|---|---|
|
CatalogObject obj |
Specifies the object to be written to the catalog. The object's XML is validated against analysis_ibot.xsd, which is located in orahome/bifoundation/web/schemas directory. |
|
String path |
Specifies the full path and name of the agent in the catalog. For example, /users/jchan/iBots/BrandDollars. |
|
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. |