Oracle® Fusion Middleware Oracle Business Intelligence Publisher開発者ガイド 12c (12.2.1) E70034-01 |
|
前へ |
次へ |
この章では、BI Publisherサーバーのトップレベル・カタログとやり取りするためのCatalogServiceメソッドについて説明します。CatalogServiceは、フォルダ、レポート、データ・モデル、スタイル・テンプレート、サブテンプレートなどのすべてのレポート・オブジェクトを管理し、作成、削除、コピー、名前の変更などの一般的な操作に対応するメソッドを提供します。
この章の内容は次のとおりです。
copyObject()メソッドは、BI Publisherカタログ内のオブジェクトをコピーします。
シグネチャ
boolean copyObject(String srcOjectAbsolutePath, String destObjectAbsolutePath, String newName, String userID, String password);
このメソッドは、srcObjectAbsolutePathが参照するレポート・オブジェクトをdestFolderAbsolutePathが指定するコピー先フォルダにコピーします。
インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。
シグネチャ
boolean copyObjectInSession(String srcObjectAbsolutePath, String destFolderAbsolutePath, String newName, String bipSessionToken);
表6-2 copyObjectInSession()メソッドのパラメータ
パラメータ | 説明 |
---|---|
String srcOjectAbsolutePath |
コピーするカタログ・オブジェクトへのパスです。 |
String destObjectAbsolutePath |
オブジェクトのコピー先となるカタログ内の場所へのパスです。 |
String newName |
新しいオブジェクトに割り当てる名前です。 |
String bipSessionToken |
BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。 |
createFolder()メソッドを使用して、BI Publisherカタログ内にフォルダを作成します。
シグネチャ
String createFolder(String folderAbsolutePath, String userID, String password);
createFolderInSession()メソッドは、指定ユーザーに対してBI Publisherカタログ内にフォルダを作成します。
インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。
シグネチャ
String createFolderInSession(String folderAbsolutePath, String bipSessionToken);
表6-4 createFolderInSession()メソッドのパラメータ
パラメータ | 説明 |
---|---|
String folderAbsolutePath |
作成するフォルダへのパスです。(例: /HR Manager/Employee Reports/)。 |
String bipSessionToken |
BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。 |
createObject()メソッドは、BI Publisherカタログにオブジェクトを作成します。
シグネチャ
String createObject(String folderAbsolutePathURL, String objectName, String objectType, String objectDescription, byte[] objectData, String userID, String password);
表6-5 createObject()メソッドのパラメータ
パラメータ | 説明 |
---|---|
String folderAbsolutePathURL |
新しいオブジェクトを配置するカタログ内のフォルダへの絶対パスです。 |
String objectName |
新しいオブジェクトの名前です。 |
String objectType |
カタログ・オブジェクトのタイプです。有効な値は次のとおりです。
|
String objectDescription |
新しいオブジェクトの説明を指定します。 |
byte[] objectData |
オブジェクトのバイト・データです。 |
String userID |
BI Publisherのユーザー名を指定します。 |
String password |
ユーザー名のパスワードを指定します。 |
createObjectInSession()メソッドは、指定ユーザーに対していBI Publisherカタログ内にオブジェクトを作成します。
インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。
シグネチャ
String createObjectInSession(String folderAbsolutePathURL, String objectName, String objectType, String objectDescription, byte[] objectData, String bipSessionToken);
表6-6 createObjectInSession()メソッドのパラメータ
パラメータ | 説明 |
---|---|
String folderAbsolutePathURL |
新しいオブジェクトを配置するカタログ内のフォルダへの絶対パスです。 |
String objectName |
新しいオブジェクトの名前です。 |
String objectType |
カタログ・オブジェクトのタイプです。有効な値は次のとおりです。
|
String objectDescription |
新しいオブジェクトの説明を指定します。 |
byte[] objectData |
オブジェクトのバイト・データです。 |
String bipSessionToken |
BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。 |
deleteObject()メソッドは、BI Publisherカタログからオブジェクトを削除します。
シグネチャ
boolean deleteObject(String reportObjectAbsolutePath, String userID, String password);
deleteObjectInSession()メソッドは、指定ユーザーのBI Publisherカタログからオブジェクトを削除します。
インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。
シグネチャ
boolean deleteObjectInSession(String objectAbsolutePath, String bipSessionToken);
downloadObject()メソッドは、BI Publisherカタログからオブジェクトをダウンロードします。このメソッドはリクエストされたオブジェクトをバイナリで返します。
シグネチャ
byte[] downloadObject(String reportAbsolutePath, String userID, String password);
downloadObjectInSession()メソッドは、指定ユーザーのBI Publisherカタログからオブジェクトをダウンロードします。このメソッドはリクエストされたオブジェクトをバイナリで返します。
インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。
シグネチャ
byte[] downloadObjectInSession(String reportAbsolutePath, String bipSessionToken);
downloadXLIFF()メソッドは、カタログから翻訳ファイル(XLIFF)をダウンロードします。このメソッドは、リクエストされたXLIFFファイルをバイナリで返します。
シグネチャ
byte[] downloadXLIFF(String objectAbsolutePath, String userID, String password);
downloadXLIFFInSession()メソッドは、指定ユーザーのカタログdownloadXLIFFInSessionから翻訳ファイル(XLIFF)をダウンロードします。このメソッドは、リクエストされたXLIFFファイルをバイナリで返します。
インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。
シグネチャ
byte[] downloadXLIFFInSession(String objectAbsolutePath, String locale, String bipSessionToken);
表6-12 downloadXLIFFInSession()メソッドのパラメータ
パラメータ | 説明 |
---|---|
String objectAbsolutePath |
ダウンロードするXLIFFオブジェクトへのパスです。 |
String locale |
XLIFFオブジェクトのロケールです( |
String bipSessionToken |
BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。 |
getFolderContentsは、フォルダ内のすべてのアイテムを取得します。この操作では、指定されたフォルダ内のすべてのレポートとフォルダが返されます。これらのアイテムを使用して、実行するレポートや、さらに検索を行ってレポートを特定するフォルダを決定できます。
返されたオブジェクトの説明は、CatalogContentsを参照してください。
シグネチャ
CatalogContents getFolderContents(String folderAbsolutePath, String userID, String password);
getFolderContentsInSession()は、指定ユーザーのフォルダ内のアイテムをすべて取得します。この操作では、指定されたフォルダ内のすべてのレポートとフォルダが返されます。これらのアイテムを使用して、実行するレポートや、さらに検索を行ってレポートを特定するフォルダを決定できます。
返されたオブジェクトの説明は、CatalogContentsを参照してください。
インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。
シグネチャ
CatalogContents getFolderContentsInSession(String folderAbsolutePath, String bipSessionToken);
表6-14 getFolderContentsInSession()メソッドのパラメータ
パラメータ | 説明 |
---|---|
String folderAbsolutePath |
コンテンツ取得元となるフォルダへのパスです。(例: /HR Manager/Employee Reports/)。 |
String bipSessionToken |
BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。 |
getObject()メソッドは、カタログからオブジェクトをダウンロードします。このメソッドはリクエストされたオブジェクト・ファイルをバイナリで返します。
シグネチャ
byte[] getObject(String reportObjectAbsolutePath, String locale, String userID, String password);
getObjectInfo()メソッドは、BI Publisherカタログのオブジェクトに関する情報を取得します。このメソッドはCatalogObjectInfoオブジェクトを返します。CatalogObjectInfoを参照してください。
シグネチャ
CatalogObjectInfo getObjectInfo(String reportObjectAbsolutePath, String userID, String password);
getObjectInfoInSession()メソッドは、指定ユーザーのBI Publisherカタログのオブジェクトに関する情報を取得します。このメソッドはCatalogObjectInfoオブジェクトを返します。CatalogObjectInfoを参照してください。
インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。
シグネチャ
CatalogObjectInfo getObjectInfoInSession(String objectAbsolutePath, String bipSessionToken);
getObjectInSession()メソッドは、指定ユーザーのカタログからオブジェクトをダウンロードします。このメソッドはリクエストされたオブジェクト・ファイルをバイナリで返します。
インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。
シグネチャ
byte[] getObjectInSession(String objectAbsolutePath, String bipSessionToken);
objectExist()メソッドは、BI Publisherカタログ内のオブジェクトの有無を特定します。
シグネチャ
boolean objectExist(String reportObjectAbsolutePath, String userID, String password);
objectExist()メソッドは、指定ユーザーのBI Publisherカタログ内のオブジェクトの有無を特定します。
インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。
シグネチャ
boolean objectExistInSession(String reportObjectAbsolutePath, String bipSessionToken);
表6-20 objectExistInSession()メソッドのパラメータ
パラメータ | 説明 |
---|---|
String reportOjectAbsolutePath |
カタログ内でテスト対象となるオブジェクトへのパスです。例: /HR Manager/Employee Reports/Employee Data Model.xdm |
String bipSessionToken |
BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。 |
renameObject()メソッドは、BI Publisherカタログ内のオブジェクトの名前を変更します。
シグネチャ
boolean renameObject(String reportObjectAbsolutePath, String newName, String userID, String password);
renameObject()メソッドは、指定ユーザーのBI Publisherカタログ内にあるオブジェクトの名前を変更します。
インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。
シグネチャ
boolean renameObjectInSession(String objectAbsolutePath, String newName, String bipSessionToken);
表6-22 renameObjectInSession()メソッドのパラメータ
パラメータ | 説明 |
---|---|
String reportObjectAbsolutePath |
カタログ内にある、名前を変更するオブジェクトへのパスです。 |
String newName |
オブジェクトの新しい名前です。 |
String bipSessionToken |
BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。 |
updateObject()メソッドは、BI Publisherカタログ内のオブジェクトを更新します。
シグネチャ
boolean updateObject(String reportObjectAbsolutePath, byte[] objectData, String userID, String password);
updateObject()メソッドは、指定ユーザーのBI Publisherカタログ内にあるオブジェクトを更新します。
インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。
シグネチャ
boolean updateObjectInSession(String objectAbsolutePath, byte[] objectData, String bipSessionToken);
表6-24 updateObjectInSession()メソッドのパラメータ
パラメータ | 説明 |
---|---|
String reportOjectAbsolutePath |
カタログ内にある更新対象オブジェクトへのパスです。例: /HR Manager/Employee Reports/Employee Data Model.xdm |
byte[] objectData |
オブジェクトを更新する際に使用するデータです。 |
String bipSessionToken |
BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。 |
uploadObject()メソッドは、新しいオブジェクトをBI Publisherカタログにアップロードします。
シグネチャ
String uploadObject(String reportObjectAbsolutePathURL, String objectType, byte[] objectZippedData, String userID, String password);
表6-25 uploadObject()メソッドのパラメータ
パラメータ | 説明 |
---|---|
String reportObjectAbsolutePathURL |
カタログ内のオブジェクトへのパス。 |
String objectType |
アップロードするオブジェクトのタイプです。有効な値は次のとおりです。
|
byte[] objectZippedData |
ZIP形式でアップロードするオブジェクトです。 |
String userID |
BI Publisherのユーザー名を指定します。 |
String password |
ユーザー名のパスワードを指定します。 |
uploadObject()メソッドは、新しいオブジェクトを指定ユーザーのBI Publisherカタログにアップロードします。
インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。
シグネチャ
String uploadObject(String reportObjectAbsolutePathURL, String objectType, byte[] objectZippedData, String userID, String bipSessionToken);
表6-26 uploadObjectInSession()メソッドのパラメータ
パラメータ | 説明 |
---|---|
String reportObjectAbsolutePathURL |
カタログ内のオブジェクトへのパス。 |
String objectType |
アップロードするオブジェクトのタイプです。有効な値は次のとおりです。
|
byte[] objectZippedData |
ZIP形式でアップロードするオブジェクトです。 |
String bipSessionToken |
BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。 |
uploadXLIFF()メソッドは、翻訳ファイル(XLIFF)をカタログにアップロードします。
シグネチャ
boolean uploadXLIFF(String objectAbsolutePath, byte[] xliffData, String locale, String userID, String password);
uploadXLIFF()メソッドは、翻訳ファイル(XLIFF)を指定ユーザーのカタログにアップロードします。
インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。
シグネチャ
boolean uploadXLIFF(String objectAbsolutePath, byte[] xliffData, String locale, String bipSessionToken);
表6-28 uploadXLIFFInSession()メソッドのパラメータ
パラメータ | 説明 |
---|---|
String objectAbsolutePath |
アップロードするXLIFFオブジェクトへのパスです。 |
byte[] xliffData |
アップロードするXLIFFファイルです。 |
String locale |
XLIFFに割り当てられるロケールです( |
String bipSessionToken |
BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。 |