注意：こちらに掲載されているすべてのコードは、「疑似コード」です。実際に使用するコードは、ユーザーの使用環境により異なります。こちらの例は、あくまで参照目的でご利用ください。
シングルサインオン
| Expand |
|---|
| title | LOGINUSER（シングルサインオン） |
|---|
|
このサービスは、Yellowfinに接続し、指定されたユーザーのログオントークンを取得します。このトークンがYellowfinログオンURLに渡されると、認証されるユーザーのログイン画面が無効化され、そのユーザーのセッションがただちに開始されます。 | Code Block |
|---|
AdministrationServiceResponse rs = null;
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setFunction("LOGINUSER");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
ap.setPassword("test");
rsr.setPerson(ap);
rs = rssbs.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success");
out.write("URL: http://<yellowfin-server>/logon.i4?LoginWebserviceId=" + rs.getLoginSessionId());
} else {
out.write("Failure");
}
|
「LOGINUSER」関数は、指定されたユーザーをYellowfinにシングルサインオンさせます。「AdministrationPerson」オブジェクトの内容は、ログインしているユーザーを定義するために使用されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “LOGINUSER” | | Webサービス関数です。 | Person | AdministrationPerson | ユーザー作成プロセスに関する新規ユーザー詳細のすべてを保持する、「AdministrationPerson」オブジェクトです。 | OrgRef | String | クライアント組織の内部参照IDです（こちらの設定は、オプションです）。ユーザーを、指定されたクライアント組織にログインさせます。こちらを設定しない場合、ユーザーのログオン時に「クライアント組織の選択」ページが表示されます。 |
「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | ログインするユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 | Password | String | 新規ユーザーのパスワードです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | LoginSessionId | String | 一意のログイントークンです。このトークンは、ログインURLに付加され、ユーザーをYellowfinに直接移動させます。 |
ログイントークンを使用したYellowfinへのリダイレクトWebサービス呼び出しから受信したトークン（AdministrationResponse.LoginSessionIdのコンテンツ）を使用して、ユーザーを以下のURLに転送することができます。 http://<YELLOWFIN-SERVER>/logon.i4?LoginWebserviceId=<TOKEN>
このURLを使用することにより、Yellowfinの認証画面がバイパスされ、ユーザーはYellowfinに直接移動します。 トークンには有効期限があります。5分以内に使用する必要があり、一旦使用すると再利用はできません。サードパーティアプリケーションから、Yellowfinに呼び出しを行う場合は、LOGINUSER Webサービスを、再度呼び出す必要があります。 JavaScript APIでのトークンの使用埋め込みJavaScript APIウィジェットで、SSO（シングルサインオン）トークンを使用することもできます。トークンは、以下のように、スクリプトレットURLに追加されます。 <script type="text/javascript" src="http://localhost/JsAPI?dashUUID=e9a6ab0a-bcb0-4fe6-9663-4dd33e58f08e&token=<TOKEN>"></script>
セッションオプションの指定このシングルサインオンリクエストを介して作成されるセッションに対してのみ機能を切り替える、変数/スイッチを渡すことができます。このようなオプションを有効にするには、「AdministrationRequest」でParameters属性を使用して渡すか、リダイレクトURLに付加します。 パラメーターは、以下のようにキー値ペアの一覧として、「AdministrationRequest.Parameters」属性に追加されます。 YFTOOLBAR=TRUE
ENTRY=DASHBOARD
ログインURLで渡されるオプションは、以下のようになります。 http://<yellowfin-server>/logon.i4?LoginWebserviceId=<token>&yftoolbar=true&entry=DASHBOARD
使用可能なオプション一覧は、以下の通りです。 パラメーターオプションキー | URLオプションキー | 説明 | YFTOOLBAR | yftoolbar | 「TRUE」、または「FALSE」に設定します。このセッションのYellowfinツールバーを隠します。
| ENTRY | entry | ログインプロセス完了時の、ユーザーの唯一のエントリーポイントを指定します。他のパラメーターとともに使用することで、ユーザーに表示される内容を指定します。値の選択肢は、以下の通りです。 DASHBOARDREPORTLISTBROWSEBROWSETABCREATEREPORTEDITREPORTVIEWREPORTADMINISTRATIONEDITDASHBOARDVIEWDASHBOARDVIEWSTORYBOARDTIMELINE
| REPORTID | reportid | 「ENTRY = EDITREPORT」、または「VIEWREPORT」とともに使用します。これは、リダイレクト先レポートの内部IDです。
| REPORTUUID | reportuuid | 「ENTRY = EDITREPORT」、または「VIEWREPORT」とともに使用します。これは、リダイレクト先レポートのUUIDです。
| STORYBOARDUUID | storyboarduuid | 「ENTRY = VIEWSTORYBOARD」とともに使用します。これは、リダイレクト先ストーリーボードのUUIDです。
| MOBILEDEVICE | mobiledevice | 「TRUE」、または「FALSE」に設定します。ユーザーを、Yellowfinインターフェースのモバイルバージョンに移動させます。
| REPORTNAME | reportname | 「ENTRY = EDITREPORT」、または「VIEWREPORT」とともに使用します。これは、リダイレクト先レポートの名前です。
| DISABLESOURCEFILTERS | | 「TRUE」、または「FALSE」に設定します。このセッションにおける、このユーザーのソースフィルター、またはクライアント参照フィルターを無効化します。これにより、ユーザーはすべてのデータを参照することができます。クライアントソースの置換に基づくコンテンツには、機能しません。
| DISABLEHEADER | disableheader | 「TRUE」、または「FALSE」に設定します。このセッションのYellowfinヘッダーを隠します。
| HIDEHEADER | hideheader | 「DISABLEHEADER」と同様です。
| DISABLEFOOTER | disablefooter | 「TRUE」、または「FALSE」に設定します。このセッションのYellowfinフッターを隠します。
| HIDEFOOTER | hidefooter | 「DISABLEFOOTER」と同様です。
| DISABLESIDENAV | disablesidenav | 「TRUE」、または「FALSE」に設定します。このセッションのYellowfinサイドナビゲーションを隠します。
| HIDESIDENAV | hidesidenav | 「DISABLESIDENAV」と同様です。
| DISABLELOGOFF | disablelogoff | 「TRUE」、または「FALSE」に設定します。このセッションのYellowfinログオフリンクを隠します。
| HIDELOGOFF | hidelogoff | 「DISABLELOGOFF」と同様です。
| REASONCODE | reasoncode | このセッションで生成されるすべてのイベントに記録されるカスタム文字列（80文字のASCII文字）です。イベントは、Yellowfinデータベースのイベントテーブルに記録されます。
このオプションは、JavaScript APIで使用することもできます。 | REASONDESCRIPTION | reasondescription | このセッションで生成されるすべてのイベントに記録されるカスタム文字列（2048文字のASCII文字）です。イベントは、Yellowfinデータベースのイベントテーブルに記録されます。
このオプションは、JavaScript APIで使用することもできます。 | DASHBOARDID | dashboardid | 「ENTRY = EDITDASHBOARD」、または「VIEWDASHBOARD」とともに使用します。これは、リダイレクト先ダッシュボードタブの内部IDです。
| DASHBOARDUUID | dashboarduuid | 「ENTRY = EDITDASHBOARD」、または「VIEWDASHBOARD」とともに使用します。これは、リダイレクト先ダッシュボードタブの内部IDです。
| FILTER<ID> | filter<ID> | 「ENTRY = VIEWREPORT」とともに使用します。指定されたレポートのフィルター値を上書きします。「FILTER」にはフィルターの内部IDを付加し、その後にフィルター値の文字列表現が続きます。例：
FILTER2134=MALE
ひとつのレポートで、複数のフィルターを渡すことができます。
| SOURCEFILTER_<FILTERCODE> | | このセッションの、このユーザーのソースフィルター値を上書きします。
「SOURCEFILTER_」には、「ソースフィルター」設定ページの「フィルタータイプコード」を付加し、その後にアクセスできるようにする値を続けます。例：
SOURCEFILTER_COUNTRY=AU
ひとつのセッションで、複数のソースフィルター値を渡すことができます。
こちらのオプションは、JavaScript APIで使用することもできます。 | CONTENT_<INCLUDE/EXCLUDE> | | このセッションで、ユーザーが持つコンテンツアクセス権を上書きします。「CONTENT_」には、「INCLUDE」、または「EXCLUDE」を付加します。このキーの値は、コンテンツフォルダーコードまたはコンテンツフォルダーUUIDです。
「INCLUDE」を選択した場合、これらは、ユーザーがアクセスできる唯一のコンテンツフォルダーになります。
「EXCLUDE」を選択した場合、これらの除外されたコンテンツフォルダーは、ユーザーが通常アクセスできるコンテンツから削除されます。
コンテンツの「INCLUDE」、および「EXCLUDE」は、フォルダーレベルに基づきます。指定したフォルダーのすべてのフォルダーが「INCLUDE」、または「EXCLUDE」されます。
フォルダーのコード、およびUUIDを使用した「INCLUDE」、または「EXCLUDE」の例：
CONTENT_INCLUDE=TUTORIAL
CONTENT_INCLUDE=c83357db-8aef-4ec7-ab72-fce34de9ee77
CONTENT_EXCLUDE=TUTORIAL
CONTENT_EXCLUDE=c83357db-8aef-4ec7-ab72-fce34de9ee77
同じセッションで、「INCLUDE」と「EXCLUDE」の両方を使用することは論理的ではありません。
このオプションは、JavaScript APIで使用することもできます。 |
|
| Expand |
|---|
| title | LOGINUSERNOPASSWORD（シングルサインオン） |
|---|
|
このサービスは、「LOGINUSER」と完全に互換がありますが、ログインするユーザーにパスワードは必要ありません。 オプションは「LOGINUSER」と同様ですが、以下の点が異なります。 - 「AdministrationRequest.Function」は、「
LOGINUSERNOPASSWORD」に設定されます。 - 「AdministrationPerson.Password」は、空欄にすることができます。
この機能を有効にするためには、Yellowfinデータベースの構成テーブルに、追加のパラメーターを追加する必要があります。 | IpOrg | ConfigTypeCode | ConfigCode | ConfigData | 1 | SYSTEM | SIMPLE_AUTHENTICATION | TRUE |
データベースの変更を有効にするために、Yellowfinの再起動が必要になることがあります。 こちらの設定オプションがYellowfinに追加されていない場合、「Webサービスエラー26: UNSECURE_LOGIN_NOT_ENABLED」が発生します。 |
ユーザーの複製と管理
ユーザーの複製とは、OEMアプリケーション内の各ユーザーを、Yellowfinユーザーに同期させることを指します。
これにより、Yellowfinでは、ログインしているユーザーを識別し、必要に応じて、制限を適用することができます。同期は通常、OEMアプリケーションからYellowfinへのWebサービス呼び出しを使用して行われます。これは、OEMアプリケーションのユーザーが静的である場合、手動で管理することもできます。
こちらのセクションでは、Webサービスを介したユーザーの作成、操作、および削除方法について説明します。OEMアプリケーションでユーザーの変更が行われるとすぐに、Webサービスが呼び出されてユーザーの変更がミラーリングされることが想定されています。
関数
| Expand |
|---|
|
以下のコードは、ユーザーを作成するためのYellowfin Webサービスを呼び出します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
person.setUserId("test@yellowfin.com.au");
person.setPassword("test");
person.setFirstName("Simple");
person.setLastName("Simon");
person.setInitial("S");
person.setSalutationCode("MR");
person.setRoleCode("YFADMIN");
person.setEmailAddress("test@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("ADDUSER");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success");
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
|
このコードは「rs.getStatusCode()」で、「SUCCESS」を返します。それ以外の場合は、ユーザー作成プロセスが失敗した理由を説明するエラーメッセージを返します。 こちらの関数は、Yellowfinにユーザーを作成します。「AdministrationPerson」オブジェクト内の詳細が、ユーザー作成プロセスで使用されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “ADDUSER” | | Webサービス関数です。 | Person | AdministrationPerson | ユーザー作成プロセスに関する新規ユーザー詳細のすべてを保持する、「AdministrationPerson」オブジェクトです。 |
「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson 要素 | データ型 | 説明 | UserId | String | 新規ユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 | Password | String | 新規ユーザーのパスワードです。 | FirstName | String | 新規ユーザーの名です。 | LastName | String | 新規ユーザーの姓です。 | Initial | String | 新規ユーザーのミドルネームです。 | SalutationCode | String | 新規ユーザーの敬称です。値の選択肢、は以下の通りです。 | RoleCode | String | Yellowfinのロールです。こちらで指定するロールは、「参照コード（YFADMIN）」、または「ロール（Yellowfin管理者）」の名前にすることができます。 | EmailAddress | String | 新規ユーザーの電子メールアドレスです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
| title | DELUSER / DELETEUSER |
|---|
|
以下のコードは、ユーザーを削除するためのYellowfin Webサービスを呼び出します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
person.setUserId("test@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELUSER");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success");
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
|
このコードは「rs.getStatusCode()」で、「SUCCESS」を返します。それ以外の場合は、ユーザー削除プロセスが失敗した理由を説明するエラーメッセージを返します。 この関数は、Yellowfinからユーザーを削除します。「AdministrationPerson」オブジェクト内の詳細が、ユーザー削除プロセスで使用されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “DELUSER”、または“DELETEUSER” | | Webサービス関数です。 | Person | AdministrationPerson | ユーザー削除プロセスに関するユーザー詳細のすべてを保持する、「AdministrationPerso」オブジェクトです。 |
「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
ユーザー情報の取得とテスト
作成されたユーザーの詳細は、Webサービス呼び出しを使用して取得することができます。「AdministrationPerson」オブジェクトのUser IDフィールドは、ユーザーを識別するために使用されます。結果として、投入された「AdministrationPerson」オブジェクトが返されます。セキュリティ上の理由から、パスワードは返されず、「NULL」となります。また、こちらのセクションでは、ユーザー情報をアプリケーションに照らし合わせてテストすることもできます。
| Expand |
|---|
|
以下のコードは、ユーザー詳細を取得するためのYellowfin Webサービスを呼び出します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
Person.setUserId("testuser@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETUSER");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success");
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
|
こちらのコードは、ユーザー詳細を含む「AdministrationPerson」オブジェクトを返し、「rs.getStatusCode()」で、「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。 この関数は、Yellowfinの特定ユーザー詳細を取得します。「AdministrationPerson」オブジェクト内の詳細が取得プロセスで使用されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “GETUSER” | | Webサービス関数です。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する、「AdministrationPerson」オブジェクトです。 |
「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Person | AdministrationPerson | 返されたユーザー詳細のすべてを保持する、「AdministrationPerson」オブジェクトです。 |
|
| Expand |
|---|
|
以下のコードは、内部IpIdを介してユーザー詳細を取得するための、Yellowfin Webサービスを呼び出します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
Person.setIpId(5);
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETUSERBYIP");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success");
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
|
こちらのコードは、ユーザー詳細を含む「AdministrationPerson」オブジェクトを返し、「rs.getStatusCode()」で、「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。 この関数は、Yellowfinの特定ユーザーのIP IDを検索し、そのユーザーの詳細を取得します。「AdministrationPerson」オブジェクト内の詳細が取得プロセスで使用されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “GETUSERBYIP” | | Webサービス関数です。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する、「AdministrationPerson」オブジェクトです。 |
「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | | IP ID | Integer| | YellowfinユーザーのIP ID |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Person | AdministrationPerson | 返されたユーザー詳細のすべてを保持する、「AdministrationPerson」オブジェクトです。 |
|
| Expand |
|---|
|
この関数は、特定の検索文字列に基づいて、Yellowfinからユーザーを取得します。この文字列がユーザーの名、姓、および電子メールアドレスと比較されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “GETUSERSFROMSEARCH” | | Webサービス関数です。 | Parameters | Array（String） | Yellowfinユーザーの名、姓、および電子メールアドレスと照合する検索文字列です。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | People | Array（AdministrationPerson） | 「AdministrationPerson」オブジェクトの配列です。これらのオブジェクトには、検索文字列に一致した、返されたユーザーの詳細が保持されます。 |
|
| Expand |
|---|
|
以下のコードは、ユーザーをテストするためのYellowfin Webサービスを呼び出します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
person.setUserId("admin@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setFunction("VALIDATEUSER");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、成功すると、特定ユーザーの「AdministrationPerson」オブジェクトを返します。それ以外の場合は、ユーザー検証プロセスが失敗した理由を説明するエラーメッセージを返します。 こちらの関数は、指定されたYellowfinユーザーが、現在アプリケーション内に存在するかどうかを確認してテストします。「AdministrationPerson」オブジェクト内の詳細が、ユーザー検証プロセスで使用されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “VALIDATEUSER” | | Webサービス関数です。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する、「AdministrationPerson」オブジェクトです。 |
「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Person | AdministrationPerson | 返されたユーザーの詳細すべてを保持する、「AdministrationPerson」オブジェクトです。 |
|
| Expand |
|---|
|
以下のコードは、ユーザーのパスワードをテストするためのYellowfin Webサービスを呼び出します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
person.setUserId("testuser@yellowfin.com.au");
person.setPassword("test");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("VALIDATEPASSWORD");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、パスワードの有効期限が切れているかどうかを確認し、有効期限が切れていない場合は、「rs.getStatusCode()」で、「FAILURE」を返します。それ以外の場合は、「SUCCESS」を返します。 こちらの関数は、Yellowfinユーザーのパスワードをテストします。「AdministrationPerson」オブジェクト内の詳細が、パスワード検証プロセスで使用されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “VALIDATEUSER” | | Webサービス関数です。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する、「AdministrationPerson」オブジェクトです。 |
「AdministrationPerson」オブジェクトで設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 | Password | String | Yellowfinユーザーのパスワードです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
ユーザー情報の操作
ユーザーの詳細は、Webサービスの呼び出しを使用して、後から変更することができます。「AdministrationPerson」オブジェクトの「User ID」フィールドは、ユーザーを識別するために使用されるため、変更することができません。「AdministrationPerson」オブジェクト内のその他のフィールドには、新しい変更内容が投入されます。セキュリティ上の理由から、このWebサービス呼び出しを使用してユーザーのパスワードを変更することはできませんが、個別の「CHANGEPASSWORD」関数（下記）を使用して変更することができます。
| Expand |
|---|
|
以下のコードは、ユーザーの詳細を編集するためのYellowfin Webサービスを呼び出します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
person.setUserId("testuser");
person.setFirstName("John");
person.setLastName("Doe");
person.setInitial("F");
person.setSalutationCode("MR");
person.setRoleCode("YFADMIN");
person.setEmailAddress("testuser@yellowfin.com.au")
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("UPDATEUSER");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、ユーザー詳細を含む「AdministrationPerson」オブジェクトを返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。 こちらの関数は、指定されたYellowfinユーザーの詳細を更新します。「AdministrationPerson」オブジェクト内の詳細が更新プロセスで使用されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “UPDATEUSER” | | Webサービス関数です。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する、「AdministrationPerson」オブジェクトです。 |
「AdministrationPerson」オブジェクトで設定できるパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 | Password | String | Yellowfinユーザーのパスワードです。 | FirstName | String | Yellowfinユーザーの名です。 | LastName | String | Yellowfinユーザーの姓です。 | Initial | String | Yellowfinユーザーのミドルネームです。 | SalutationCode | String | Yellowfinユーザーの敬称です。値の選択肢は、は以下の通りです。 | RoleCode | String | Yellowfinのロールです。こちらで指定するロールは、「参照コード（YFADMIN）」、または「ロール（Yellowfin管理者）」の名前にすることができます。 | EmailAddress | String | Yellowfinユーザーの電子メールアドレスです。 | LanguageCode | String | 優先言語を表す2文字のコードです。 | IpId | Integer | 内部Yellowfin IP IDです。 | TimeZoneCode | String | YellowfinユーザーのTimeZoneCodeです。有効な値については、付録を参照してください。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Person | AdministrationPerson | 更新されたユーザーの詳細すべてを保持する「AdministrationPerson」オブジェクトです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、指定されたYellowfinユーザーのパスワードを変更します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
person.setUserId("test@yellowfin.com.au");
person.setPassword("testtest");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("CHANGEPASSWORD");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、指定されたYellowfinユーザーのパスワードを変更します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “CHANGEPASSWORD” | | Webサービス関数です。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクト。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 | Password | String | Yellowfinユーザーの新規パスワードです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
ユーザーに属するオブジェクトの取得
様々なWebサービス呼び出しを使用して、デフォルト組織、またはクライアント組織内のユーザーに属するオブジェクトを取得することができます。応答で返されるオブジェクトは、リクエストで実行される呼び出しのタイプに依存します。
| Expand |
|---|
| title | GETUSERREPORTS / GETALLUSERREPORTS |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能な「Webサービス名」を含むすべてのレポートを返します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
Person.setUserId("testuser@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETUSERREPORTS");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getReports()」で「AdministrationReport」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。 こちらの関数は、指定されたYellowfinユーザーがアクセス可能な「Webサービス名」を含むすべてのレポートを返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “GETUSERREPORTS” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクト。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Reports | AdministrationReport | AdministrationReportオブジェクトの配列。これらのオブジェクトにはレポートメタデータが保持されます。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なすべてのレポートを返します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
Person.setUserId("testuser@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETALLUSERREPORTS");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getReports()」で「AdministrationReport」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “GETUSERREPORTS” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクト。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Reports | AdministrationReport | 「AdministrationReport」オブジェクトの配列です。これらのオブジェクトには、レポートメタデータが保持されます。 |
|
| Expand |
|---|
| title | GETREPORTSWITHCOMMENTS |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なすべてのコメントされたレポートを返します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
Person.setUserId("testuser@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETREPORTSWITHCOMMENTS");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getReports()」で「AdministrationReport」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。 こちらの関数は、指定されたYellowfinユーザーがアクセス可能なYellowfin内のコメントされたすべてのレポートを返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “GETREPORTSWITHCOMMENTS” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクト。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Reports | AdministrationReport | 「AdministrationReport」オブジェクトの配列です。これらのオブジェクトには、レポートメタデータが保持されます。 |
|
| Expand |
|---|
| title | GETFAVOURITES / GETFAVORITES |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なすべての「レポートのお気に入り」を返します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
Person.setUserId("testuser@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETFAVOURITES");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getReports()」で「AdministrationReport」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。 こちらの関数は、指定されたYellowfinユーザーのすべてのお気に入りのレポートを返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “GETFAVOURITES”または“GETFAVORITES” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Reports | AdministrationReport | 「AdministrationReport」オブジェクトの配列です。これらのオブジェクトには、レポートメタデータが保持されます。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーの「受信トレイ」内にあるすべてのレポートを返します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
Person.setUserId("testuser@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETINBOX");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getReports()」で「AdministrationReport」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。 こちらの関数は、指定されたYellowfinユーザーの受信トレイ内にあるレポートを返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “GETINBOX” | String | Webサービス関数です。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | | Reports | AdministrationReport | 「AdministrationReport」オブジェクトの配列です。これらのオブジェクトには、レポートメタデータが保持されます。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なレポートを含まないすべてのダッシュボードタブを返します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
Person.setUserId("testuser@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETUSERTABS");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getReportGroups()」で「AdministrationReportGroup」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、指定されたYellowfinユーザーがアクセス可能なダッシュボードタブの一覧を返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “GETUSERTABS” | String | Webサービス関数です。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | ReportsGroups | AdministrationReportGroup | 「AdministrationReportGroup」オブジェクトの配列です。これらのオブジェクトには、ダッシュボードメタデータが保持されます。 |
|
| Expand |
|---|
| title | GETUSERTABSWITHREPORTS |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なレポートを含むすべてのダッシュボードタブを返します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
Person.setUserId("testuser@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETUSERTABS");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getReportGroups()」で「AdministrationReportGroup」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、指定されたYellowfinユーザーがアクセス可能なダッシュボードタブの一覧を返します。このとき、レポートのメタデータも同時にロードされます。ダッシュボードタブのすべてのレポートのメタデータは、「AdministrationReportGroup」オブジェクト内に含まれます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “GETUSERTABSWITHREPORTS” | String | Webサービス関数です。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | ReportsGroups | AdministrationReportGroup | 「AdministrationReportGroup」オブジェクトの配列です。これらのオブジェクトには、ダッシュボードメタデータが保持されます。この特定の関数では、レポートのメタデータも、このオブジェクトの「GroupReports()」パラメーターにロードされます。 |
|
| Expand |
|---|
|
こちらの関数は、指定されたダッシュボードタブ内に含まれるレポートの一覧を返します。このレポートには、Yellowfinの指定されたユーザーがアクセスすることができます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “LOADTABREPORTS” | String | Webサービス関数です。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 | ReportGroup | AdministrationReportGroup | 取得プロセスに関するダッシュボードタブIDを保持する「AdministrationReportGroup」オブジェクトです。 |
「AdministrationPerson」、および「AdministrationReportGroup」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
| AdministrationReportGroup要素 | データ型 | 説明 | ReportGroupId | String | ダッシュボードタブIDです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | ReportGroups | AdministrationReportGroup | 「AdministrationReportGroup」オブジェクトの配列です。これらのオブジェクトには、ダッシュボードメタデータが保持されます。この特定の関数では、レポートのメタデータも、このオブジェクトの「GroupReports()」パラメーターにロードされます。 |
|
グループとロールの管理
Webサービス呼び出しを使用して、グループとロールの作成や変更をすることができます。応答で返されるオブジェクトは、リクエストで実行される呼び出しのタイプに依存します。
注意：システム構成ページで、クライアント組織機能を有効化している場合、特定のタイプの呼び出しについて適用可能な場合は、クライアント組織を指定することもできます。
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内で使用可能なすべてのロールを返します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
rsr.setOrgId(new Integer(1));
rsr.setFunction("LISTROLES");
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getRoles()」で「AdministrationRole」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。 こちらの関数は、Yellowfin内で使用可能なすべてのロールを返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “LISTROLES” | String | Webサービス関数です。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Role | AdministrationRole | 「AdministrationRole」オブジェクトの配列です。これらのオブジェクトには、Yellowfinロールのメタデータが保持されます。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内で使用可能なすべてのグループを返します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get groups in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("LISTGROUPS");
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getGroups()」で「AdministrationGroup」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、Yellowfin内で使用可能なすべてのユーザーグループを返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “LISTGROUPS” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Groups | AdministrationGroup | 「AdministrationGroup」オブジェクトの配列です。これらのオブジェクトには、Yellowfinユーザーグループのメタデータが保持されます。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループおよびそのメンバーを返します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Group Name");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETGROUP");
rsr.setGroup(group);
rs = AdministrationService.remoteAdministrationCall(rsr);
group = rs.getGroup();
AdministrationGroupMember[] groupMembers = group.getGroupMembers();
|
こちらのコードは、「rs.getGroup()」で「AdministrationGroup」オブジェクトを返し、「rs.getGroupMembers()」で「AdministrationGroupMembers」の配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、指定されたYellowfinグループ、およびそのメンバーの一覧を返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “GETGROUP” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Group | AdministrationGroup | 取得プロセスに関するYellowfinユーザーグループの名前を保持する「AdministrationGroup」オブジェクトです。 |
「AdministrationGroup」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationGroup要素 | データ型 | 説明 | GroupName | String | 指定したYellowfinグループの名前です。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Group | AdministrationGroup | グループメタデータを保持する「AdministrationGroup」オブジェクトの配列です。グループメンバーも、このオブジェクトの「GroupMembers()」のパラメーターにロードされます。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinに指定されたグループを作成します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Group Name");
group.setGroupDescription("Group Description");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to create the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("CREATEGROUP");
rsr.setGroup(group);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 注意：「AdministrationPerson」オブジェクトの「AdministrationGroupMember」配列に入力することによって、新規作成されたグループに、既存のYellowfinユーザーを同時に配置することもできます。各「AdministrationPerson」オブジェクトに必要なのは、LoginId変数セットのみであり、「AdministrationGroupMember」配列は、「group.setGroupMembers()」に保存されます。 こちらの関数は、Yellowfinグループを作成します。こちらの関数では、新規グループに既存のYellowfinユーザーを保存できる点にも注意してください。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “CREATEGROUP” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Group | AdministrationGroup | 取得プロセスに関するYellowfinユーザーグループの名前を保持する「AdministrationGroup」オブジェクトです。 |
「AdministrationGroup」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationGroup要素 | データ型 | 説明 | GroupName | String | 指定したYellowfinグループの名前です。 | GroupDescription | String | 指定したYellowfinグループの説明です。 | GroupMembers | Array（AdministrationPerson） | 「AdministrationPerson」オブジェクトの配列です。これはオプションのパラメーターで、既存のYellowfinユーザーを、このグループに保存するよう設定することができます。こちらのシナリオの場合、各「AdministrationPerson」オブジェクトに必要なのは、オブジェクトごとにそのUserIdパラメーターを設定することだけです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループに指定されたユーザーを含めます。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();
AdministrationPerson person = new AdministrationPerson();
group.setGroupName("Group Name");
person.setUserId("test@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("INCLUDEUSERINGROUP");
rsr.setGroup(group);
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、指定されたグループに指定されたYellowfinユーザーを含めます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “INCLUDEUSERINGROUP” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Group | AdministrationGroup | 取得プロセスに関するYellowfinユーザーグループの名前を保持する「AdministrationGroup」オブジェクトです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 |
「AdministrationGroup」、および「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationGroup要素 | データ型 | 説明 | GroupName | String | 指定したYellowfinグループの名前です。 |
| AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
| title | EXCLUDEUSERFROMGROUP |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループから指定されたユーザーを除外します。 注意：このユーザーは、グループから削除されるのではなく、グループ定義から除外されるだけです。こちらは、以下のような場合に有効です。 - John Doeは、グループAのメンバーである。
- グループAは、グループBのメンバーである。
- John DoeはグループBのメンバーであってはならないため、グループBから除外する必要がある。
| Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();
AdministrationPerson person = new AdministrationPerson();
group.setGroupName("Group Name");
person.setUserId("test@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("EXCLUDEUSERFROMGROUP");
rsr.setGroup(group);
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、指定されたグループから指定されたYellowfinユーザーを除外します。このユーザーはグループから削除されるのではなく、グループ定義から除外されるだけである点に注意してください。こちらは、以下のような場合に有効です。 - John Doeは、グループAのメンバーである。
- グループAは、グループBのメンバーである。
- John DoeはグループBのメンバーであってはならないため、グループBから除外する必要がある。
| リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “EXCLUDEUSERFROMGROUP” | String | Webサービス関数です。 | OrgRef | String | この関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Group | AdministrationGroup | 取得プロセスに関するYellowfinユーザーグループの名前を保持する「AdministrationGroup」オブジェクトです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 |
「AdministrationGroup」、および「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationGroup要素 | データ型 | 説明 | GroupName | String | 指定したYellowfinグループの名前です。 |
| AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループから指定されたユーザーを削除します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();
AdministrationPerson person = new AdministrationPerson();
group.setGroupName("Group Name");
person.setUserId("test@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("DELUSERFROMGROUP");
rsr.setGroup(group);
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、指定したグループから指定されたYellowfinユーザーを削除します。こちらのシナリオは、「EXCLUDEUSERFROMGROUP」のシナリオとは異なります。こちらの関数の場合、ユーザーはグループから完全に削除される点に注意してください。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “DELUSERFROMGROUP” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Group | AdministrationGroup | 取得プロセスに関するYellowfinユーザーグループの名前を保持する「AdministrationGroup」オブジェクトです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 |
「AdministrationGroup」、および「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationGroup要素 | データ型 | 説明 | GroupName | String | 指定したYellowfinグループの名前です。 |
| AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループを変更します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Group Name");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("MODIFYGROUP");
rsr.setGroup(group);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 注意：「AdministrationPerson」オブジェクトの「AdministrationGroupMember」配列を投入することによって、変更されたグループに、既存のYellowfinユーザーを同時に配置することもできます。各「AdministrationPerson」オブジェクトに必要なのは、LoginId変数セットのみであり、「AdministrationGroupMember」配列は、「group.setGroupMembers()」に保存されます。 こちらの関数は、Yellowfinの指定されたグループの詳細を変更します。こちらの関数では、新規グループに既存のYellowfinユーザーを保存できる点にも注意してください。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “MODIFYGROUP” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Group | AdministrationGroup | 取得プロセスに関するYellowfinユーザーグループの名前を保持する「AdministrationGroup」オブジェクトです。 |
「AdministrationGroup」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationGroup要素 | データ型 | 説明 | GroupName | String | 指定したYellowfinグループの名前です。 | GroupDescription | String | 指定したYellowfinグループの説明です。 | GroupMembers | Array（AdministrationPerson） | 「AdministrationPerson」オブジェクトの配列です。こちらはオプションのパラメーターで、既存のYellowfinユーザーを、このグループに保存するよう設定することができます。こちらのシナリオの場合、各「AdministrationPerson」オブジェクトに必要なのは、LoginIdパラメーターを設定することだけです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループを削除します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Group Name");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("DELETEGROUP");
rsr.setGroup(group);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、Yellowfinから指定されたユーザーを削除します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “DELETEGROUP” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Group | AdministrationGroup | 取得プロセスに関するYellowfinユーザーグループの名前を保持する「AdministrationGroup」オブジェクトです。 |
「AdministrationGroup」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationGroup要素 | データ型 | 説明 | GroupName | String | 指定したYellowfinグループの名前です。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
クライアント組織機能
Yellowfinには、クライアント組織と呼ばれる機能があり、こちらの機能を使用することで、複数のYellowfin仮想インスタンスを、同じサーバーインスタンスに配置することができます。
クライアント組織機能は、以下に示す使用可能なWebサービスの呼び出しによって、管理することができます。
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内のすべてのクライアント組織を一覧表示します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("LISTCLIENTS");
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「AdministrationClientOrg」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、Yellowfin内で使用可能なすべてのクライアント組織を一覧表示します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “LISTCLIENTS” | String | Webサービス関数です。 |
返される応答には、以下のパラメーターが含まれます。 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。 |
|
| Expand |
|---|
|
以下コードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織を取得します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETCLIENT");
rsr.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getClient()」で「AdministrationClientOrg」オブジェクトを返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、Yellowfin内の指定されたクライアント組織の詳細を取得します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “GETCLIENT” | String | Webサービス関数です。 | Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。 |
「AdministrationClientOrg」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationClientOrg要素 | データ型 | 説明 | ClientReferenceId | Integer | 指定されたクライアント組織のクライアント参照IDです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内に指定されたクライアント組織を作成します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
aco.setClientName("CLIENTNAME");
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
aco.setTimeZoneCode("AUSTRALIA/SYDNEY");
aco.setDefaultOrg(false);
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("CREATECLIENT");
rsr.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、Yellowfinに指定されたクライアント組織を作成します。 リクエスト要素 | データ型 | 説明 |
|---|
LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “CREATECLIENT” | String | Webサービス関数です。 | Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。 |
「AdministrationClientOrg」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationClientOrg要素 | データ型 | 説明 | ClientName | String | クライアント組織の名前です。 | ClientReferenceID | String | クライアントの識別に使用される、固有のIDであるクライアント参照IDです。 | TimeZoneCode | String | クライアント組織のローカルタイムゾーンコードです。 | DefaultOrg | Boolean | こちらの組織がデフォルト組織である場合に、「true」を返すBoolean値です。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織を削除します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETECLIENT");
rsr.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、Yellowfinの指定されたクライアント組織を削除します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “DELETECLIENT” | String | Webサービス関数です。 | Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。 |
「AdministrationClientOrg」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationClientOrg要素 | データ型 | 説明 | ClientReferenceId | Integer | 指定されたクライアント組織のクライアント参照IDです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織を更新します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
aco.setClientName("CLIENTNAME");
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
aco.setTimeZoneCode("AUSTRALIA/SYDNEY");
aco.setDefaultOrg(false);
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("UPDATECLIENT");
rsr.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織を更新します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “UPDATECLIENT” | String | Webサービス関数です。 | Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。 |
「AdministrationClientOrg」オブジェクトで、設定できるパラメーターは、以下の通りです。 | AdministrationClientOrg要素 | データ型 | 説明 | ClientName | String | クライアント組織の名前です。 | ClientReferenceId | Integer | 指定されたクライアント組織のクライアント参照IDです。こちらのIDは、最初の取得プロセスに使用され、こちらの関数の使用中に変更することができない点に、注意が必要です。 | TimeZoneCode | String | クライアント組織のローカルタイムゾーンコードです。 | DefaultOrg | Boolean | こちらの組織がデフォルト組織である場合に、「true」を返すBoolean値です。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織に属する、すべてのユーザーを一覧表示します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
AdministrationPerson[] people = null;
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("LISTUSERSATCLIENT");
rsr.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr);
people = rs.getPeople();
|
こちらのコードは、「rs.getPeople()」で「AdministrationPerson」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、Yellowfinの指定されたクライアント組織に属する、すべてのYellowfinユーザーを一覧表示します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “LISTUSERSATCLIENT” | String | Webサービス関数です。 | Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。 |
「AdministrationClientOrg」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationClientOrg要素 | データ型 | 説明 | ClientReferenceId | Integer | 指定されたクライアント組織のクライアント参照IDです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | People | Array（AdministrationPerson） | 「AdministrationPerson」オブジェクトの配列です。各オブジェクトには、Yellowfinユーザーのメタデータが保持されます。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたユーザーがアクセス可能なすべてのクライアント組織を一覧表示します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg[] clients = null;
AdministrationPerson person = new AdministrationPerson();
person.setUserId("test@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETUSERACCESS");
rsr.setPerson(person);
rs = AdministrationService.remoteAdministrationCall(rsr);
clients = rs.getClients();
|
こちらのコードは、「rs.getClients()」で「AdministrationClientOrg」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “GETUSERACCESS” | String | Webサービス関数です。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 |
「AdministrationClientOrg」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationClientOrgy要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | Clients | Array（AdministrationClientOrg） | 「AdministrationClientOrg」オブジェクトの配列です。各オブジェクトには、Yellowfinクライアント組織のメタデータが保持されます。 |
|
| Expand |
|---|
|
デフォルト組織への追加以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたユーザーへ、デフォルト組織へのアクセス権を追加します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
AdministrationPerson person = new AdministrationPerson();
person.setUserId("test@yellowfin.com.au");
aco.setDefaultOrg(true);
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("ADDUSERACCESS");
rsr.setPerson(person);
rsr.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr); |
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、Yellowfinの指定されたユーザーに対して指定されたクライアント組織へのアクセス権を追加します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “ADDUSERACCESS” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 | Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント組織のクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
クライアント組織への追加以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたユーザーに対して、指定されたクライアント組織へのアクセス権を追加します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
AdministrationPerson person = new AdministrationPerson();
person.setUserId("test@yellowfin.com.au");
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("ADDUSERACCESS");
rsr.setPerson(person);
rs.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、Yellowfinの指定されたユーザーに対して指定されたクライアント組織へのアクセス権を追加します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “ADDUSERACCESS” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 | Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント組織のクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。 |
「AdministrationPerson」、および「AdministrationClientOrg」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
| AdministrationClientOrg要素 | データ型 | 説明 | ClientReferenceId | Integer | 指定されたクライアント組織のクライアント参照IDです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
デフォルト組織からの削除以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたユーザーから、デフォルト組織へのアクセス権を削除します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
AdministrationPerson person = new AdministrationPerson();
person.setUserId("test@yellowfin.com.au");
aco.setDefaultOrg(false);
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("REMOVEUSERACCESS");
rsr.setPerson(person);
rsr.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr); |
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、Yellowfinの指定されたユーザーに対して、指定されたクライアント組織へのアクセス権を削除します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “REMOVEUSERACCESS” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 | Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント組織のクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
クライアント組織からの削除以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたユーザーに対して指定されたクライアント組織へのアクセス権を削除します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
AdministrationPerson person = new AdministrationPerson();
person.setUserId("test@yellowfin.com.au");
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("REMOVEUSERACCESS");
rsr.setPerson(person);
rs.setClient(aco);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、Yellowfinの指定されたユーザーに対して、指定されたクライアント組織へのアクセス権を削除します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “REMOVEUSERACCESS” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 | Client | AdministrationClientOrg | 取得プロセスに関するYellowfinクライアント組織のクライアント参照IDを保持する「AdministrationClientOrg」オブジェクトです。 |
「AdministrationPerson」、および「AdministrationClientOrg」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
| AdministrationClientOrg要素 | データ型 | 説明 | ClientReferenceId | Integer | 指定されたクライアント組織のクライアント参照IDです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
コンテンツのエクスポートとインポート
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内でエクスポート可能なすべてのコンテンツを取得します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
ContentResource[] cr = null;
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETCONTENT");
rs = AdministrationService.remoteAdministrationCall(rsr);
cr = rs.getContentResources();
|
こちらのコードは、「rs.getContentResources()」で「ContentResource」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “GETCONTENT” | String | Webサービス関数です。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | ContentResources | Array（ContentResource） | 「ContentResource」オブジェクトの配列です。各「ContentResource」オブジェクトには、Yellowfinでエクスポート可能な、すべてのコンテンツのエクスポートメタデータが保持されます。 |
|
| Expand |
|---|
| title | GETEXPORTDEPENDENCIES |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、特定のYellowfin成果物についての従属関係を取得します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
ContentResource[] cr = null;
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETEXPORTDEPENDENCIES");
rs = AdministrationService.remoteAdministrationCall(rsr);
cr = rs.getContentResources();
|
こちらのコードは、「rs.getContentResources()」で「ContentResource」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、特定のYellowfin成果物についての従属関係を取得します。最初に、GETCONTENT Webサービス呼び出しを実行して、エクスポート可能なすべてのコンテンツメタデータを取得することができます。このコンテンツメタデータは、「ContentResource」オブジェクトの配列という形式で取得され、この関数呼び出しでそれぞれの従属関係を取得するために使用することができます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “GETEXPORTDEPENDENCIES” | String | Webサービス関数です。 | ContentResources | Array（ContentResource） | 「ContentResource」オブジェクトの配列。これらのオブジェクトには、特定のYellowfin成果物のメタデータが保持されます。 |
「ContentResource」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | ContentResource要素 | データ型 | ResourceName | String | ResourceDescription | String | ResourceType | String | ResourceOrgId | Integer | ResourceCode | String |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | ContentResources | Array（ContentResource） | 「ContentResource」オブジェクトの配列です。これらのオブジェクトには、従属関係メタデータが保持されます。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定された成果物をエクスポートします。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// It is advisable to run a GETCONTENT web service call beforehand to retrieve the necessary ContentResource objects
// This list can be copied over to the exportList array below
ContentResource[] exportList;
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("EXPORTCONTENT");
rsr.setContentResources(exportList);
rs = AdministrationService.remoteAdministrationCall(rsr);
rbo = rs.getBinaryAttachments();
|
こちらのコードは、「rs.getBinaryAttachments()」で「ReportBinaryObjects」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、Yellowfin内の指定された成果物をエクスポートします。最初に、GETCONTENT Webサービス呼び出しを実行して、エクスポート可能なすべてのコンテンツメタデータを取得することができます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “EXPORTCONTENT” | String | Webサービス関数です。 | ContentResources | Array（ContentResource） | 「ContentResource」オブジェクトの配列です。これらのオブジェクトには、特定のYellowfin成果物のメタデータが保持されます。 |
「ContentResource」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | ContentResource要素 | データ型 | ResourceName | String | ResourceDescription | String | ResourceType | String | ResourceOrgId | Integer | ResourceCode | String |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | BinaryAttachments | Array（ReportBinaryObjects） | 「ReportBinaryObject」オブジェクトの配列です。これらのオブジェクトには、エクスポートされた成果物のXMLが保持されます。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのインポートファイルを読み取り、インポートするオブジェクトを返します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
Byte[] data = <XML import file>;
ContentResource[] cr = null;
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETIMPORTCONTENT");
rsr.setParameters( new String[] { Base64.encodeBytes(data) } );
rs = AdministrationService.remoteAdministrationCall(rsr);
cr = rs.getContentResources();
|
こちらのコードは、「rs.getContentResources()」で「ContentResource」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数の詳細な動作例については、Yellowfin WebサービスディレクトリYellowfin\development\examples\web servicesにある「ws_admin_import.jsp」を参照してください。 こちらの関数は、YellowfinのXMLインポートファイルを読み取り、アプリケーションにインポート可能なオブジェクトの一覧を返します。こちらの関数の入力には、Base64でエンコードされたXMLファイルを使用してください。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “GETIMPORTCONTENT” | String | Webサービス関数です。 | Parameters | Array（String） | Base64でエンコードされた、多数のXMLインポートファイルの配列です。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | ContentResources | Array（ContentResource） | 「ContentResource」オブジェクトの配列です。これらのオブジェクトには、特定のYellowfin成果物のメタデータが保持されます。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのインポートオブジェクトをテストします。通常、この関数はGETIMPORTCONTENT Webサービス呼び出しのあとに実行します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
Byte[] data = <XML import file>;
ImportIssue[] ii = null;
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("TESTIMPORTCONTENT");
rsr.setParameters( new String[] { Base64.encodeBytes(data) } );
rs = AdministrationService.remoteAdministrationCall(rsr);
ii = rs.getImportIssues();
|
こちらのコードは、インポートファイルに問題がある場合には、「rs.getImportIssues()」で「ImportIssue」オブジェクトの配列を返し、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数の詳細な動作例については、Yellowfin WebサービスディレクトリYellowfin\development\examples\web servicesにある「ws_admin_import.jsp」を参照してください。 こちらの関数は、Yellowfinのインポートオブジェクトの一覧をテストします。通常、この関数はGETIMPORTCONTENT Webサービス呼び出しのあとに実行され、YellowfinのXMLインポートファイルを読み取り、アプリケーションにインポート可能なオブジェクトの一覧を返します。こちらの関数は、この一覧内のすべてのオブジェクトについて検証プロセスを実行します。検証プロセス中に発生したすべての問題は、応答で「ImportIssue」オブジェクトとして返されます。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “TESTIMPORTCONTENT” | String | Webサービス関数です。 | Parameters | Array（String） | Base64でエンコードされた、多数のXMLインポートファイルの配列です。 | ImportOptions | Array（ImportOption） | コンテンツのインポート方法を制御する「ImportOption」オブジェクトの配列です。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | ImportIssues | Array（ImportIssue） | 「ImportIssue」オブジェクトの配列です。これらのオブジェクトには、検証プロセスから返されたエラーメッセージが含まれます。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、指定されたYellowfinのインポートオブジェクトをアプリケーションにインポートします。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
Byte[] data = <XML import file>;
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("IMPORTCONTENT");
rsr.setParameters( new String[] { Base64.encodeBytes(data) } );
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数の詳細な動作例については、Yellowfin WebサービスディレクトリYellowfin\development\examples\web servicesにある「ws_admin_import.jsp」を参照してください。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “IMPORTCONTENT” | String | Webサービス関数です。 | Parameters | Array（String） | Base64でエンコードされた、多数のXMLインポートファイルの配列です。 | ImportOptions | Array（ImportOption） | コンテンツのインポート方法を制御する「ImportOption」オブジェクトの配列です。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
コンテンツの削除
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのレポートを削除します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// This is a Yellowfin Report UUID
String[] parameters ={
"7368e6d4-6167-4a16-ba52-ffa2440a5c8c"
};
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETEREPORT");
// If the report ID is not set, then the code will look for the UUID in parameters
rsr.setReportId(12345);
rsr.setParameters(parameters);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “DELETEREPORT” | String | Webサービス関数です。 | Parameters | Array（String） | YellowfinレポートのUUIDです。ReportIdが設定されている場合、こちらの設定は必要ありません。 | ReportId | Integer | YellowfinレポートのIDです。Parameterの配列にUUIDが設定されている場合、こちらの設定は必要ありません。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのビューを削除します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// This example has a Yellowfin View UUID. The parameter value here can be either the UUID
// or the Yellowfin View ID
String[] parameters ={
"7368e6d4-6167-4a16-ba52-ffa2440a5c8c"
};
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETEVIEW");
rsr.setParameters(parameters);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “DELETEVIEW” | String | Webサービス関数です。 | Parameters | Array（String） | YellowfinのビューID、またはUUIDを設定することができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのデータソースを削除します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// This is the Yellowfin Data Source ID
String[] parameters ={
"23456"
};
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETESOURCE");
rsr.setParameters(parameters);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “DELETESOURCE” | String | Webサービス関数です。 | Parameters | Array（String） | YellowfinのデータソースID、またはUUIDを設定することができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのダッシュボードタブを削除します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// This is the Yellowfin Dashboard Tab UUID
String[] parameters ={
"7368e6d4-6167-4a16-ba52-ffa2440a5c8c"
};
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETETAB");
rsr.setDashboardTabId(11223);
// If the Dashboard Tab ID is not set, then the code will look for the UUID in parameters
rsr.setParameters(parameters);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “DELETETAB” | String | Webサービス関数です。 | Parameters | Array（String） | YellowfinダッシュボードタブのUUIDです。DashboardTabIdパラメーターが設定されている場合、こちらの設定は必要ありません。 | DashboardTabId | Integer | ダッシュボードタブIDです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
キャッシュ管理
| Expand |
|---|
|
こちらの関数は、Yellowfin内の指定された参照コードを、再読み込みします。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “RELOADCODES” | String | Webサービス関数です。 | Parameters | Array（String） | 参照コードの一覧です。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのジオメトリーキャッシュをクリアします。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// This is a Yellowfin View ID
String[] parameters ={
"48910"
};
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GEOMETRYFLUSH");
rsr.setParameters(parameters);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、Yellowfinのジオメトリーキャッシュをクリアします。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “GEOMETRYFLUSH” | String | Webサービス関数です。 | Parameters | Array（String） | ジオメトリーオブジェクトのキャッシュ元となるビューIDの一覧です。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのビューのキャッシュを削除します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// This is a Yellowfin View ID
String[] parameters ={
"49283"
};
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("REMOVEVIEW");
rsr.setParameters(parameters);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、Yellowfinのビューのキャッシュを削除します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “REMOVEVIEW” | String | Webサービス関数です。 | Parameters | Array（String） | ビューIDの一覧です。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinにおけるレポートのキャッシュされた定義を削除します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// This is a Yellowfin Report ID
String[] parameters ={
"11111"
};
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("FLUSHREPORT");
rsr.setParameters(parameters);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “FLUSHREPORT” | String | Webサービス関数です。 | Parameters | Array（String） | レポートIDの一覧です。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータス。可能な値は以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinにおけるダッシュボードのキャッシュされた定義を削除します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// This is a Yellowfin Dashboard Tab ID
String[] parameters ={
"12345"
};
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("FLUSHTAB");
rsr.setParameters(parameters);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “FLUSHTAB” | String | Webサービス関数です。 | Parameters | Array（String） | タブIDの一覧です。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinでライセンス定義を再読み込みします。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("RELOADLICENCE");
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “RELOADLICENCE” | String | Webサービス関数です。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたデータソースの接続プールを閉じます。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// This is a Yellowfin Data Source ID
String[] parameters ={
"11111"
};
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("CLOSECONNECTIONPOOL");
rsr.setParameters(parameters);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “CLOSECONNECTIONPOOL” | String | Webサービス関数です。 | Parameters | Array（String） | YellowfinのデータソースIDです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
| title | FLUSHCACHEDFILTERCACHE |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたフィルターのフィルターキャッシュをフラッシュします。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
// This is a Yellowfin Filter ID
String[] parameters ={
"12345"
};
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("FLUSHCACHEDFILTERCACHE");
rsr.setParameters(parameters);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “FLUSHCACHEDFILTERCACHE” | String | Webサービス関数です。 | Parameters | Array（String） | フィルターIDです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
その他
| Expand |
|---|
|
こちらの関数は、指定されたレポートがYellowfinの指定されたユーザーのお気に入り一覧に存在するかどうかを確認します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “ISUSERFAVOURITE” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 | ReportId | Integer | レポートの固有のIDです。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
| title | ADDTOFAVOURITES / ADDTOFAVORITES |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、指定されたレポートを指定されたユーザーのお気に入り一覧に追加します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
person.setUserId("test@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("ADDTOFAVOURITES");
rsr.setPerson(person);
rs.setReportId(12345);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、指定されたレポートを指定されたユーザーのレポートのお気に入り一覧に追加します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “ADDTOFAVOURITES"、または"ADDTOFAVORITES” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 | ReportId | Integer | レポートの固有のIDです。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
| title | REMOVEFAVOURITES / REMOVEFAVORITES |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、指定されたユーザーのお気に入り一覧に対して指定されたレポートを削除します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
person.setUserId("test@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("REMOVEFAVOURITE");
rsr.setPerson(person);
rs.setReportId(12345);
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 こちらの関数は、指定されたユーザーのレポートのお気に入り一覧に対して指定されたレポートを削除します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.auなど）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “REMOVETOFAVOURITES"、または"REMOVETOFAVORITES” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクト。 | ReportId | Integer | レポートの固有のIDです。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
こちらの関数は、Yellowfin内の指定されたユーザーのすべてのアバターイメージを返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “GETAVATARS” | String Webサービス関数 | Parameters | Array（String） | Yellowfinユーザーの固有のIDです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 | BinaryAttachments | Array（ReportBinaryObject） | Base64でデコードされたアバターイメージを保持する「ReportBinary」オブジェクトの配列です。 |
|
| Expand |
|---|
|
こちらの関数は、Yellowfin内の指定されたユーザープロフィールのアバターイメージを設定します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “SETAVATARIMAGE” | String | Webサービス関数です。 | OrgRef | String | こちらの関数を特定のクライアント組織に適用する場合の、クライアント参照IDです。こちらのパラメーターは、オプションです。 | Person | AdministrationPerson | 取得プロセスに関するYellowfinユーザーのユーザーIDを保持する「AdministrationPerson」オブジェクトです。 | Parameters | Array（Bytes） | Base64でエンコードされたアバターイメージです。 |
「AdministrationPerson」オブジェクトで、設定が必要なパラメーターは、以下の通りです。 | AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 | IpId | Integer | Yellowfinユーザーの固有のIP ID。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
| Expand |
|---|
|
以下のコードは、Yellowfin Webサービスを呼び出し、エキスパートの承認プロセスを介してYellowfinのレポートを承認します。 | Code Block |
|---|
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("APPROVEREPORT");
rsr.setReportId(12345)
rs = AdministrationService.remoteAdministrationCall(rsr);
|
こちらのコードは、「rs.getStatusCode()」で「SUCCESS」を返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 | リクエスト要素 | データ型 | 説明 | LoginId | String | Yellowfin Webサービスへの接続に使用されるアカウントのログインIDです（例：admin@yellowfin.com.au）。 | Password | String | Yellowfin Webサービスへの接続に使用されるアカウントのパスワードです。 | OrgId | Integer | Yellowfin内のデフォルト組織IDです。常に、「1」に設定します。 | Function = “APPROVEREPORT” | String | Webサービス関数です。 | ReportId | Integer | レポートIDです。 |
返される応答には、以下のパラメーターが含まれます。 | 応答要素 | データ型 | 説明 | StatusCode | String | Webサービス呼び出しのステータスです。値の選択肢は、以下の通りです。 |
|
オブジェクト定義
| Expand |
|---|
| title | AdministrationPerson |
|---|
|
| AdministrationPerson要素 | データ型 | 説明 | UserId | String | YellowfinユーザーのユーザーIDです。これは、ログインIDの方法に応じて、ユーザーID、または電子メールアドレスにすることができます。 | Password | String | Yellowfinユーザーのパスワードです。 | FirstName | String | Yellowfinユーザーの名です。 | LastName | String | Yellowfinユーザーの姓です。 | Initial | String | Yellowfinユーザーのミドルネームの頭文字です。 | SalutationCode | String | Yellowfinユーザーの敬称です。値の選択肢は、以下の通りです。 | RoleCode | String | Yellowfinのロールです。こちらで指定するロールは、「参照コード（YFADMIN）」、または「ロール（Yellowfin管理者）」の名前にすることができます。 | EmailAddress | String | Yellowfinユーザーの電子メールアドレスです。 | LanguageCode | String | 優先言語を表す2文字のコードです。 | IpId | Integer | 内部Yellowfin IP IDです。 | TimeZoneCode | String | YellowfinユーザーのTimeZoneCodeです。 |
|
| Expand |
|---|
| title | AdministrationReport |
|---|
|
| AdministrationReport要素 | データ型 | ReportName | String | ReportDescription | String | ReportId | Integer | ExecutionObject | String | ReportCategory | String | ReportSubCategory | String | BirtData | String | SourceName | String | SourceId | Integer | AuthoringMode | String | ReportTemplate | String | DataOutput | String | DashboardEnabled | Boolean | ViewId | Integer | ViewName | String | ViewDescription | String | LastModifierName | String | LastModifierId | Integer | LastModifiedDate | Date | PublishDate | Date | DeliveryMode | String | LastRunTime | Integer | AverageRunTime | Integer | RoleCode | String | ChartTypeCode | String | Usage | Integer |
|
| Expand |
|---|
| title | AdministrationReportGroup |
|---|
|
| AdministrationReportGroup要素 | データ型 | 説明 | ReportGroupName | String | | ReportGroupDescription | String | | ReportGroupId | Integer | | ReportGroupStatus | String | | ReportGroupType | String | | ReportGroupInternalReference | String | | GroupReports | Array（AdministrationReports） | レポートメタデータを保持する「AdministrationReport」オブジェクトの配列です。これらは、ダッシュボードタブ内のポートレットを構成するレポートです。 | AssociatedReports | Array（Integer） | |
|
| Expand |
|---|
|
| AdministrationReportGroup要素 | データ型 | 説明 | RoleName | String | Yellowfinロールの名前です。 | RoleDescription | String | Yellowfinロールの説明です。 | RoleCode | String | データベースで生成されて参照されるYellowfinロールの内部コードです。 |
|
| Expand |
|---|
|
| AdministrationGroup要素 | データ型 | 説明 | GroupName | String | | GroupDescription | String | | GroupId | Integer | | GroupStatus | String | | GroupInternalReference | String | | GroupMembers | Array（AdministrationGroupMember） | 「AdministrationGroupMember」オブジェクトの配列です。これらのオブジェクトには、グループメンバーのメタデータが保持されます。 |
|
| Expand |
|---|
| title | AdministrationClientOrg |
|---|
|
| AdministrationClientOrg要素 | データ型 | 説明 | ClientName | String | クライアント組織の名前です。 | ClientReferenceID | String | クライアントの識別に使用される固有のIDであるクライアント参照IDです。 | TimeZoneCode | String | クライアント組織のローカルタイムゾーンコードです。有効な値については、付録を参照してください。 | DefaultOrg | Boolean | こちらの組織がデフォルト組織である場合に、「true」を返すBoolean値です。 |
|
| Expand |
|---|
|
| ReportBinaryObject要素 | データ型 | 説明 | Key | String | バイナリーオブジェクトストレージに使用される固有キーです。 | ContentType | String | バイナリーオブジェクトのMIMEタイプです。 | Data | Array（Byte） | バイナリーオブジェクトのRAWデータです。 |
|
| Expand |
|---|
|
| ContentResource要素 | データ型 | ResourceName | String | ResourceDescription | String | ResourceId | Integer | ResourceUUID | Integer | ResourceType | String | ResourceOrgId | Integer | ResourceCode | String |
|
| Expand |
|---|
|
| ImportOption要素 | データ型 | 説明 | ItemIndex | Integer | このオプションが付加されたアイテムのインデックスです。 | OptionKey | String | オプションのタイプです。 | OptionValue | String | このオプションに関連付けられた値です。 |
オプションキー | オプション値 | タスク | | SKIP | True False | インポートファイル内のアイテムをスキップします。 | | OPTION | ADD | インポートファイルのアイテムをインポートします。 | | OPTION | REPLACE | インポートファイルのアイテムで、既存のアイテムを置き換えます。 注意：置き換えるためには、既存のレポートが必要です。 | | EXISTING | Content UUID | 置き換えるコンテンツの内部IDが必要です。例えば、アイテムがビューの場合、こちらの値は、既存のビューIDになります。アイテムが、フォルダー、またはサブフォルダーの場合、IDではなくフォルダーコードになります。 | | DATABASETYPECODE | | Expand |
|---|
| | データベースシステム | データベースコード | | Generic ODBC Source | GENERICODBC | | Microsoft Access | MSACCESS | | DB2 AS400 | AS400 | | Cache DB | CACHEDB | | Columnar DB | COLUMNAR | | DB2 | DB2 | | Connection Cloud | CONNECTIONCLOUD | | Derby | DERBY | DIAPRISM | DIAPRISM | | FileMaker Pro | FILEMAKER | | Firebird | FIREBIRD | | FoxPro | FOXPROODBC | | H2 | H2 | | Hive | HIVE | | HSQLDB | HSQLDB | | Informix | INFORMIX | | Ingres | INGRES | | Vectorwise | VECTORWISE | | Interbase | INTERBASE | | Lucid | LUCIDDB | | MonetDB | MONETDB | | MySQL | MYSQL | | Netezza | NETEZZA | | Lotus Notes | NOTES | | NouDB | NOUDB | | Progress OpenEdge | OPENEDGE | | Oracle | ORACLE | | Pervasive | PERVASIVE | | PostgresSQL | POSTGRESQL | | Progress | PROGRESS | | SAP HANA | SAPHANA | | SAS | SASJDBC | | SqLite | SQLITE | | Microsoft SQL Server | MSSQLSERVER | | Sybase ASA / Sybase SQL Anywhere | SYBASEASA | | Sybase ASE | SYBASEASE | | Sybase IQ | SYBASEIQ | | TeraData | TERADATA | | Universe | UNIVERSE | | Vertica | VERTICA |
|
| インポート中に、データソースタイプの詳細を上書きします。 | | DRIVER | JDBC Driver classname | インポート時に、データソースホストの詳細を上書きします。 | | URL | A JDBC URL | インポート時に、データソースURLの詳細を上書きします。 | | DATASOURCE | XMLA Data Source | インポート時に、XMLAデータソースの詳細を上書きします。 | | CATALOG | XMLA Catalog | インポート時に、XMLAデータソースカタログの詳細を上書きします。 | | USERNAME | Source Username | インポート時に、データの詳細を上書きします。 | | PASSWORD1 | Source Password | インポート時に、データソースパスワードの詳細を上書きします。 注意：「PASSWORD2」の設定も必要です。 | | PASSWORD2 | Password Validation | インポート時に、データソースパスワードの詳細を上書きします。 | | SOURCE | SOURCE<SourceId> | 別のソースにビューを添付します。例：ID 39003のソースに添付する場合は、「SOURCE39003」になります。 | | CACHEVIEW | True False | キャッシュされたビューを、インポートでもキャッシュするかどうかを切り替えます。 | | CACHESOURCE | SOURCE<SourceId> | インポート時に、ビューをキャッシュするソースを選択します。例：ID 39003のソースを選択する場合は、「SOURCE39003」になります。 | | CATEGORY | Category Code | インポート時に、親フォルダーにサブフォルダーコードを割り当てます。 | | SOURCE | SOURCE<SourceId> | インポート時に、ソースにレポートを割り当てます。例：ID 39003のソースを選択する場合は、「SOURCE39003」になります。 | | VIEW | VIEW<ViewId> | インポート時に、ビューにレポートを割り当てます。例：ID 39003のビューを選択する場合は、「SOURCE39003」になります。 | | EXECUTIONOBJECTNAME | Name | インポート時に、webサービス実行オブジェクト名を割り当てます。webサービスを介して、このレポートを一意に識別する名前を提供します。 | | CATEGORY | CAT<CategoryCode> | インポート時に、既存のレポートフォルダーに、レポート割り当てます。例：TUTORIALというフォルダーの場合は、「CATTUTORIAL」になります。 | | SUBCATEGORY | CAT<CategoryCode> | インポート時に、上記で指定されたフォルダーの子フォルダーに当たる、既存のレポートサブフォルダーに、レポートを割り当てます。例：TUTORIALというフォルダーの場合は、「CATTUTORIAL」になります。 | | CATEGORY | IMP<CategoryCode> | インポート時に、同じエクスポートファイル内のフォルダーに、レポートを割り当てます。例：TUTORIALというフォルダーの場合は、「IMPTUTORIAL」になります。 | | SUBCATEGORY | IMP<CategoryCode> | インポート時に、上記で指定されたフォルダーの子フォルダーに当たる、同じエクスポートファイル内の既存のサブフォルダーに、レポートを割り当てます。例：TUTORIALというフォルダーの場合は、「IMPTUTORIAL」になります。 |
|
...