iBotServiceサービス

iBotServiceサービスを使用して、Oracle Analyticsエージェントの保存、編集、削除、登録、登録解除、カスタマイズ、および実行を行います。Oracle Business Intelligence 11g (11.1.1)リリース以降、iBotsという名前はエージェントに変更されました。

メソッド名	説明
deleteIBot()メソッド	エージェントをカタログから削除し、Oracle Analyticsスケジューラから登録解除します。
enableIBot()メソッド	Oracle Analyticsエージェントを有効にします。
executeIBotNow()メソッド	カタログに保存されているエージェントを実行します。
getAgentPaths()メソッド	指定されたユーザーのエージェントのパスを取得します。
getAgents()メソッド	指定されたパスからエージェントを取得します。
moveIBot()メソッド	エージェントをカタログ・フォルダから別のカタログ・フォルダに移動します。
purgeAlerts()メソッド	削除するアラートを指定します。
getIBotStatus()メソッド	指定されたエージェントのステータスを取得します。
sendMessage()メソッド	Oracle Analyticsのユーザー、グループ、またはその両方に、メッセージを送信します。
subscribe()メソッド	公開されているエージェントに登録します。登録のカスタマイズも行います。
unsubscribe()メソッド	エージェントから登録解除します。
writeIBot()メソッド	新しいエージェントをカタログに書き込み、これをOracle Analyticsスケジューラに登録します。

deleteIBot()メソッド

deleteIBot()メソッドを使用して、保存されているエージェントを削除します。エージェントを削除すると、カタログからこれ(オブジェクト)が削除されるだけでなく、Oracle Analyticsスケジューラからエージェントが登録解除されます。このメソッドは、WebCatalogServiceのdeleteitem()メソッドとは異なります。deleteitem()メソッドの場合、エージェントはOracle Analyticsスケジューラから登録解除されません。

シグネチャ

void deleteIBot(String path, String sessionID);

引数	説明
String path	カタログ内のエージェントのフルパスおよび名前を指定します。たとえば、/users/jchan/iBots/BrandDollars
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

enableIBot()メソッド

enableIBot()メソッドを使用して、Oracle Analyticsエージェントを有効にします。

シグネチャ

enableIBotResult enableIBot(String path, boolean enable, String sessionID);

引数	説明
String path	カタログ内のエージェントのフルパスおよび名前を指定します。たとえば、/users/jchan/iBots/BrandDollars
boolean enable	指定されたエージェントを有効にするかどうかを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

enableIBotResultを返します。

executeIBotNow()メソッド

executeIBotNow()メソッドを使用して、カタログに保存されているエージェントを実行します。このメソッドでは、エージェントの元のスケジュールは変更されません。

シグネチャ

void executeIBotNow(String path, String sessionID);

引数	説明
String path	カタログ内のエージェントのフルパスおよび名前を指定します。たとえば、/users/jchan/iBots/BrandDollars
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

getAgentPaths()メソッド

getAgentPaths()メソッドを使用して、指定したユーザーのOracle Analyticsエージェントのパスを取得します。

シグネチャ

getAgentPathsResult getAgentPaths(String userID, String sessionID);

引数	説明
String userID	エージェントのパスを取得するユーザーのユーザーIDを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

getAgentPathsResultを返します。

getAgents()メソッド

getAgents()メソッドを使用して、指定したパスのOracle Analyticsエージェントを取得します。

シグネチャ

getAgentsResult getAgents(String agentPath, String sessionID);

引数	説明
String agentPath	カタログ内のフルパスを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

getAgentsResultを返します。

getIBotStatus()メソッド

getIBotStatus()メソッドを使用して、指定したOracle Analyticsエージェントのステータスを取得します。

シグネチャ

getIBotStatusResult getIBotStatus(String path, String sessionID);

引数	説明
String path	カタログ内のエージェントのフルパスを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

getIBotStatusResultを返します。

moveIBot()メソッド

moveIBot()メソッドを使用して、エージェントをカタログ・フォルダから別のカタログ・フォルダに移動します。このメソッドは、WebCatalogServiceサービスのmoveItem()メソッドとは異なります。moveItem()メソッドの場合、カタログ・オブジェクトを移動し、さらにOracle Analyticsスケジューラにオブジェクトが移動されたことを通知します。

シグネチャ

void moveIBot(String fromPath, String toPath, boolean resolveLinks, boolean allowOverwrite, String sessionID);

引数	説明
String fromPath	移動するエージェントのフル・カタログ・パスを指定します。
String toPath	エージェントの移動先のフル・カタログ・パスを指定します。
boolean resolveLinks	子オブジェクトを移動するかどうかを指定します。この引数をTRUEに設定し、fromPath引数に指定したバスがリンクである場合、このリンクが指す子オブジェクトは移動されます。
boolean allowOverwrite	既存のオブジェクトをオーバーライドするかどうかを指定します。この引数をTRUEに設定し、toPathによって指定されたパスに別のカタログ・オブジェクトが存在する場合、このオブジェクトは上書きされます。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

purgeAlerts()メソッド

purgeAlerts()メソッドを使用して、指定した時間より古いアラートを削除します。

シグネチャ

purgeAlertsResult purgeAlerts(Unsigned Integer maxAgeSecs, String userGlob, String sessionID);

引数	説明
Unsigned Integer maxAgeSecs	アラートの経過時間を秒数で指定します。これより古いアラートは削除されます。0を指定すると、経過時間に関係なくアラートが削除されます。
String userGlob	アラートを削除する必要があるユーザーを指定します。すべてのユーザーのアラートを削除するには、ワイルドカード*を指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

削除されたアラートの数、何人のユーザーのアラートをチェックしたか、アラートの残数およびエラーの発生有無を返します。

sendMessage()メソッド

sendMessage()メソッドを使用して、Oracle Analyticsのユーザー、グループ、またはその両方にメッセージを送信します。メッセージは、対応する受信者の配信プロファイルに従って配信されます。このプロファイルは、Oracle Analyticsプレゼンテーション・サービスの「マイ・アカウント」ダイアログで設定されたものです。

シグネチャ

String sendMessage(String[] recipient, String[] group, String subject, String body, String priority, String sessionID);

引数	説明
String[] recipient	メッセージを送信するOracle AnalyticsユーザーのGUIDを指定します。この引数には、1つ以上のユーザーを含めることができます。
String[] group	メッセージを送信するOracle AnalyticsグループのGUIDを指定します。この引数には、複数のグループを含めることができます。
String subject	メッセージの件名の行を指定します。
String body	メッセージの本文に含めるテキストを指定します。
String priority	メッセージの優先度を指定します。High、Normal、またはLowを指定できます。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

subscribe()メソッド

subscribe()メソッドを使用して、公開されたエージェントに登録します。エージェントでカスタマイズが可能な場合、カスタマイズXMLも指定できます。

シグネチャ

void subscribe(String path, String customizationXml, String sessionID);

引数	説明
String path	カタログ内のエージェントのフルパスおよび名前を指定します。たとえば、/users/jchan/iBots/BrandDollars
String customizationXml	カスタマイズXMLを指定します(エージェントがカスタマイズを許可している場合のみ)。 このXMLは、orahome/bifoundation/web/schemas/analysis_customizationで使用可能なカスタマイズ・スキーマに対して検証されます。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

unsubscribe()メソッド

unsubscribe()メソッドを使用して、エージェントから登録解除します。このメソッドでは、ユーザーのカスタマイズの削除も行います。

シグネチャ

void unsubscribe(String path, String sessionID);

引数	説明
String path	カタログ内のエージェントのフルパスおよび名前を指定します。たとえば、/users/jchan/iBots/BrandDollars
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

writeIBot()メソッド

writeIBot()メソッドを使用して、新しいエージェントをカタログに書き込み、これをOracle Analyticsスケジューラに登録します。このメソッドは、WebCatalogServiceのwriteObjects()メソッドとは異なります。writeObjects()メソッドは、カタログへの書き込みのみを行います。

シグネチャ

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

引数	説明
CatalogObject obj	カタログに書き込まれるオブジェクトを指定します。 このオブジェクトのXMLは、orahome/bifoundation/web/schemasディレクトリにあるanalysis_ibot.xsdに対して検証されます。
String path	カタログ内のエージェントのフルパスおよび名前を指定します。たとえば、/users/jchan/iBots/BrandDollars
boolean resolveLinks	TRUEに設定され、カタログ内のパスがリンクを参照する場合、オブジェクトはリンクが指す場所に書き込まれます。
boolean allowOverwrite	既存のオブジェクトをオーバーライドするかどうかを指定します。パスによって指定された場所にすでに存在するオブジェクトをオーバーライドするには、TRUEに設定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。