Page History

Versions Compared

Old Version 7

changes.mady.by.user Yellowfin Admin

Saved on Jul 21, 2015

compared with

New Version Current

changes.mady.by.user Yellowfin Admin

Saved on Mar 24, 2016

Key

This line was added.
This line was removed.
Formatting was changed.

Comment: Migration of unmigrated content due to installation of a new plugin

...

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オブジェクトの内容は、ログインしているユーザーを定義するために使用されます。

Request Elementリクエスト要素	Data Typeデータ型	Description説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “LOGINUSER”		Web services functionWebサービス関数。
Person	AdministrationPersonThe AdministrationPerson object holding all of the new user’s details for the user creation process	ユーザー作成プロセスに関する新規ユーザーの詳細すべてを保持するAdministrationPersonオブジェクト。
OrgRef	String	Client Org Internal Reference Id (optional). This will log the user into a given Client Org. If this is not set, then the user will be prompted with the Client Org Selection page on login.

These are the parameters that you need to set in the AdministrationPerson object:

AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the user that you wish to login. This can be the user ID or the email address, depending on the Logon ID method.
Password	String	Password of the new user.

The response returned will contain these parameters:

クライアント組織の内部参照ID（オプション）。ユーザーを指定されたクライアント組織にログインさせます。設定しない場合は、ユーザーのログオン時に「クライアント組織の選択」ページが表示されます。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明
UserId	String	ログインするユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。
Password	String	新規ユーザーのパスワード。

返される応答には、以下のパラメーターが含まれます。

応答要素	データ型	説明
StatusCode	String	Webサービス呼び出しのステータス。可能な値は以下の通りです。
Response Element	Data Type	Description
StatusCode	String	Status of the web service call. Possible values include: SUCCESS FAILURE
LoginSessionId	String	A unique login token. This token is appended to the Login URL to take a user directly into Yellowfin.

Redirecting to Yellowfin with the login token

一意のログイントークン。このトークンはログインURLに付加され、ユーザーをYellowfinに直接移動させます。

ログイントークンを使用したYellowfinへのリダイレクト

Webサービス呼び出しから受信したトークン（AdministrationResponse.LoginSessionIdの内容）を使用して、ユーザーを以下のURLに転送できます：Using the token received from the webservice call (the contents of AdministrationResponse.LoginSessionId), you can forward the user to the URL:

http://<YELLOWFIN-SERVER>/logon.i4?LoginWebserviceId=<TOKEN>

This URL will bypass the authentication screen in Yellowfin and take the user directly into Yellowfin.

The token has a limited validity period. It must be used within 5 minutes, and once it has been used, it cannot be used again. To make subsequent calls from a third party application into Yellowfin, you must call the LOGINUSER web service again.

Using the token with the JavaScript API

このURLを使用することにより、Yellowfinの認証画面がバイパスされ、ユーザーはYellowfinに直接移動します。

トークンには有効期限があります。5分以内に使用する必要があり、いったん使用すると再利用はできません。その後、サードパーティのアプリケーションからYellowfinに呼び出しを行うときは、LOGINUSER Webサービスを再度呼び出す必要があります。

JavaScript APIでのトークンの使用

埋め込みJavaScript APIウィジェットでSSO（シングルサインオン）トークンを使用することもできます。トークンは、次のようにスクリプトレットURLに追加されます：The SSO token can also be used with embedded JavaScript API widgets. The token is added to the scriptlet URL like this:

<script type="text/javascript" src="http://localhost/JsAPI?dashUUID=e9a6ab0a-bcb0-4fe6-9663-4dd33e58f08e&token=<TOKEN>"></script>

Specifying Session Options

You can pass variables/switches that toggle functionality only for the session created via this Single Sign On request. These options can be enabled by passing them via the Parameters attribute in the AdministrationRequest, or by appending them to the redirection URL.

Parameters are added to the AdministrationRequest.Parameters attribute as a list of key value pairs, like:

YFTOOLBAR=TRUE

ENTRY=DASHBOARD

script>

セッションオプションの指定

このシングルサインオンリクエストを介して作成されるセッションに対してのみ機能を切り替える変数/スイッチを渡すことができます。このようなオプションを有効にするには、AdministrationRequestでParameters属性を使用して渡すか、またはリダイレクトURLに付加します。

パラメーターは、以下のようにキー値ペアのリストとしてAdministrationRequest.Parameters属性に追加されます：

YFTOOLBAR=TRUE

ENTRY=DASHBOARD

ログインURLで渡されるオプションは次のようになります：Options passed on the login URL look like:

http://<yellowfin-server>/logon.i4?LoginWebserviceId=<token>&yftoolbar=true&entry=DASHBOARD

Here is a list of the available options:

使用可能なオプションの一覧を以下に示します：

パラメーターオプションキー	URLオプションキー	説明	Parameter Option Key	URL Option Key	Description
YFTOOLBAR	yftoolbar	`TRUE`/`FALSE`. Hide the Yellowfin toolbar for this session.。このセッションのYellowfinツールバーを隠します。
ENTRY	entryDetermine the user's only entry point on completion of the login process. This is used in conjunction with other parameters to determine the content the user is shown. Possible values:	ログインプロセスを完了するためのユーザーの唯一の起点を指定します。ほかのパラメーターとともに使用して、ユーザーに表示される内容を指定します。可能な値： `DASHBOARD` `REPORTLIST` `BROWSE` `BROWSETAB` `CREATEREPORT` `EDITREPORT` `VIEWREPORT` `ADMINISTRATION` `EDITDASHBOARD` `VIEWDASHBOARD` `VIEWSTORYBOARD` `TIMELINE`
REPORTID	reportid	Used with `ENTRY = EDITREPORT` or `VIEWREPORT`. This is the internal Id of the report to redirect to.または`VIEWREPORT`とともに使用します。これは、リダイレクト先レポートの内部IDです。
REPORTUUID	reportuuid	Used with `ENTRY = EDITREPORT` or `VIEWREPORT`. This is the UUID of the rpeort to redirect to.または`VIEWREPORT`とともに使用します。これは、リダイレクト先レポートのUUIDです。
STORYBOARDUUID	storyboarduuid	Used with `ENTRY = VIEWSTORYBOARD`. This is the UUID of the storyboard to redirect to.とともに使用します。これは、リダイレクト先ストーリーボードのUUIDです。
MOBILEDEVICE	mobiledevice	`TRUE`/`FALSE`. Takes the user to a mobile version of the Yellowfin interface.。ユーザーをYellowfinインターフェースのモバイルバージョンに移動させます。
REPORTNAME	reportname	Used with `ENTRY = EDITREPORT` or `VIEWREPORT`. This is the name of the report to redirect to.または`VIEWREPORT`とともに使用します。これは、リダイレクト先レポートの名前です。
DISABLESOURCEFILTERS		`TRUE`/`FALSE`. Disable Source Filter or Client Reference Filters for this user, for this session. This allows the user to see all data. This doesn't work for content based on Client Source Substitution.。このセッションにおけるこのユーザーのソースフィルターまたはクライアント参照フィルターを無効化します。こうすると、ユーザーはすべてのデータを表示できます。クライアントソースに基づくコンテンツには効果がありません。
DISABLEHEADER	disableheader	`TRUE`/`FALSE`. Hide the Yellowfin header for this session.。このセッションのYellowfinヘッダーを隠します。
HIDEHEADER	hideheader	Same as `DISABLEHEADER`.と同じです。
DISABLEFOOTER	disablefooter	`TRUE`/`FALSE`. Hide the Yellowfin footer for this session.。このセッションのYellowfinフッターを隠します。
HIDEFOOTER	hidefooter	Same as `DISABLEFOOTER`.と同じです。
DISABLESIDENAV	disablesidenav	`TRUE`/`FALSE`. Hide the Yellowfin side navigation for this session.。このセッションのYellowfin側のナビゲーションを隠します。
HIDESIDENAV	hidesidenav	Same as `DISABLESIDENAV`.と同じです。
DISABLELOGOFF	disablelogoff	`TRUE`/`FALSE`. Hide the Yellowfin logoff link for this session.。このセッションのYellowfinログオフリンクを隠します。
HIDELOGOFF	hidelogoff	Same as `DISABLELOGOFF`.と同じです。
REASONCODE	reasoncode	このセッションで生成されるすべてのイベントに記録されるカスタム文字列（80文字のASCII文字）。イベントは、Yellowfinデータベースのイベントテーブルに記録されます。このオプションは、JavaScript APIで使用することもできます。
REASONDESCRIPTION	reasondescription	このセッションで生成されるすべてのイベントに記録されるカスタム文字列（2048文字のASCII文字）。イベントは、Yellowfinデータベースのイベントテーブルに記録されます。このオプションは、JavaScript APIで使用することもできます。	Custom string (80 ASCII characters) that will be dropped into all events generated by this session. Events are dropped in the Event table in the Yellowfin database. This option can also be used with the JavaScript API.	REASONDESCRIPTION	reasondescription	Custom string (2048 ASCII characters) that will be dropped into all events generated by this session. Events are dropped in the Event table in the Yellowfin database. This option can also be used with the JavaScript API.
DASHBOARDID	dashboardid	Used with `ENTRY = EDITDASHBOARD` or `VIEWDASHBOARD`. This is the internal id of the dashboard tab to redirect to.または`VIEWDASHBOARD`とともに使用します。これは、リダイレクト先ダッシュボードタブの内部IDです。
DASHBOARDUUID	dashboarduuid	Used with `ENTRY = EDITDASHBOARD` or `VIEWDASHBOARD`. This is the internal id of the dashboard tab to redirect to.または`VIEWDASHBOARD`とともに使用します。これは、リダイレクト先ダッシュボードタブの内部IDです。
FILTER<ID>	filter<ID>	Used with `ENTRY = VIEWREPORT`. Override filter values for the given report. FILTER is appended with the internal ID of the filter, plus the string representation of the filter value. For example: `FILTER2134=MALE` You can pass multiple filters for the one report.	`ENTRY = VIEWREPORT`とともに使用します。指定されたレポートのフィルター値を上書きします。FILTERにはフィルターの内部IDを付加し、その後にフィルター値の文字列表現が続きます。例： `FILTER2134=MALE` 1つのレポートで複数のフィルターを渡すことができます。
SOURCEFILTER_<FILTERCODE>		このセッションのこのユーザーのソースフィルター値を上書きします。 `SOURCEFILTER_`には「ソースフィルター」設定ページの「フィルタータイプコード」を付加し、その後にアクセスできるようにする値を続けます。例：	SOURCEFILTER_<FILTERCODE>		Override the source filter values for this user for this session. `SOURCEFILTER_` is appended with the Filter Type Code from the Source Filter setup page, plus the value you wish to give access to. For example: `SOURCEFILTER_COUNTRY=AU` You can pass multiple source filter values for the one session. This option can also be used with the JavaScript API.1つのセッションで複数のソースフィルター値を渡すことができます。このオプションは、JavaScript APIで使用することもできます。
CONTENT_<INCLUDE/EXCLUDE>	Override the content access that a user has for this session. `CONTENT_` is appended with either `INCLUDE` or `EXCLUDE`. The value for this key is either the Content Category Code, or the Content Category UUID. If you choose to `INCLUDE` content, then these will be the only Content Categories that the user will have access to. If you choose to `EXCLUDE` content, then these excluded Content Categories will be removed from the content that the user normally	このセッションでユーザーが持つコンテンツアクセス権を上書きします。`CONTENT_`には`INCLUDE`または`EXCLUDE`を付加します。このキーの値は、コンテンツカテゴリーコードまたはコンテンツカテゴリーUUIDです。コンテンツの組み入れ（`INCLUDE`）を選択した場合、これらはユーザーがアクセスできるようにするコンテンツカテゴリーのみになります。コンテンツの除外（`EXCLUDE`）を選択した場合、これらの除外コンテンツカテゴリーは、ユーザーが通常アクセスできるコンテンツから削除されます。コンテンツの組み入れおよび除外は、カテゴリーレベルに基づきます。指定したカテゴリーのすべてのサブカテゴリーが組み入れまたは除外されます。カテゴリーのコードおよびUUIDを使用した組み入れ/除外の例： has access to. Inclusion and Exclusion of content is based on the Category level. All sub categories with the specified category are included or excluded. An example of including/excluding with category codes and UUIDs: `CONTENT_INCLUDE=TUTORIAL` `CONTENT_INCLUDE=c83357db-8aef-4ec7-ab72-fce34de9ee77` `CONTENT_EXCLUDE=TUTORIAL` `CONTENT_EXCLUDE=c83357db-8aef-4ec7-ab72-fce34de9ee77` It is not logical to use both `INCLUDE` and `EXCLUDE` for the same session. This option can also be used with the JavaScript API.同じセッションで`INCLUDE`と`EXCLUDE`の両方を使用することは論理的ではありません。このオプションは、JavaScript APIで使用することもできます。

Expand

title	LOGINUSERNOPASSWORD (Single Sign On)	LOGINUSERNOPASSWORD（シングルサインオン）

このサービスは、LOGINUSERと完全に互換がありますが、ログインするユーザーのパスワードが必要ありません。

オプションはLOGINUSERと同じですが、以下の点が異なります：

AdministrationRequest.FunctionはLOGINUSERNOPASSWORDに設定されます
AdministrationPerson.Passwordは空にできます

この機能を有効にするには、Yellowfinデータベースの設定テーブルに追加のパラメーターを追加する必要があります：

This service is a drop in replacement for LOGINUSER, but the password for the user being logged in is not required.

Options are the same as LOGINUSER except for:

AdministrationRequest.Function will be set to LOGINUSERNOPASSWORD
AdministrationPerson.Password can be blank

An extra parameter needs to be added to the Configuration table of the Yellowfin database to enable this functionality:

IpOrg	ConfigTypeCode	ConfigCode	ConfigData
1	SYSTEM	SIMPLE_AUTHENTICATION	TRUE

You may need to restart Yellowfin for the database change to take affect.

データベースの変更を有効にするために、Yellowfinの再起動が必要になることがあります。

この設定オプションがYellowfinに追加されていない場合は、WebサービスエラーYou will receive a web service arror 26: UNSECURE_LOGIN_NOT_ENABLED if this configuration option is not added to the Yellowfin database.

...

が発生します。

ユーザーの複製および管理

Styleclass

Class	topLink

top

User replication involves synchronising each user in the OEM application with a named user in Yellowfin.

This allows Yellowfin to identify the user who is logged in, and to apply any restrictions that may be required. Synchronisation is usually performed using web service calls from the OEM application to Yellowfin. This can also be managed manually if users in the OEM application are generally static.

This section will outline how to create, manipulate, and delete users via web services. It is assumed that the web service is called to mirror user changes immediately after a user modification is made in the OEM application.

Functions

ページトップ

ユーザーの複製とは、OEMアプリケーション内の各ユーザーをYellowfinのユーザーに同期させることを指します。

これにより、Yellowfinでは、ログインしているユーザーを識別し、必要となる制限がある場合はその制限を適用することができます。通常、同期はOEMアプリケーションからYellowfinへのWebサービス呼び出しを使用して行われます。これは、OEMアプリケーションのユーザーが概して静的である場合には、手動で管理することもできます。

このセクションでは、Webサービスを介したユーザーの作成、操作、および削除方法の概要について説明します。OEMアプリケーションでユーザーの変更が行われるとすぐに、Webサービスが呼び出されてユーザーの変更がミラーリングされることが想定されています。

関数

Expand

title	ADDUSER

以下のコードは、ユーザーを作成するためのYellowfin Webサービスを呼び出します。

Code Block

Expand

title	ADDUSER

The following code will call the Yellowfin web service to create a user:

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());
				
}

This code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error message explaining why the user creation process failed.

This function will create a user in Yellowfin. The details in the AdministrationPerson object will be used in the user creation process.

でSUCCESSを返します。それ以外の場合は、ユーザー作成プロセスが失敗した理由を説明するエラーメッセージを返します。

この関数はYellowfinにユーザーを作成します。AdministrationPersonオブジェクト内の詳細がユーザー作成プロセスで使用されます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “ADDUSER”		Web services functionWebサービス関数。
Person	AdministrationPerson	The AdministrationPerson object holding all of the new user’s details for the user creation process

These are the parameters that you need to set in the AdministrationPerson object:

ユーザー作成プロセスに関する新規ユーザーの詳細すべてを保持するAdministrationPersonオブジェクト。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明	AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the new user. This can be the user ID or the email address, depending on the Logon ID method新規ユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。
Password	String	Password of the new user新規ユーザーのパスワード。
FirstName	String	新規ユーザーの名。
LastName	String	新規ユーザーの姓。	First name of of the new user	LastName	String	Last name of of the new user
Initial	String	Middle name of the new user新規ユーザーのミドルネーム。
SalutationCode	String	Title of the new user. Possible values include:新規ユーザーの敬称。可能な値は以下の通りです。 DR MISS MR MRS MS
RoleCode	String	Yellowfin role. The specified role here can be the Org Reference Code (YFADMIN) or the name of the role (Yellowfin Administrator)Yellowfinのロール。ここで指定するロールは、参照コード（YFADMIN）またはロール（Yellowfin管理者）の名前にすることができます。
EmailAddress	String	Email address of the new user

The response returned will contain these parameters:

新規ユーザーの電子メールアドレス。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	DELUSER / DELETEUSER

The following code will call the Yellowfin web service to delete a user:以下のコードは、ユーザーを削除するための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());
				
}

This code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error message explaining why the user deletion process failed.

This function will delete a user from Yellowfin. The details in the AdministrationPerson object will be used in the user deletion process.

でSUCCESSを返します。それ以外の場合は、ユーザー削除プロセスが失敗した理由を説明するエラーメッセージを返します。

この関数はYellowfinからユーザーを削除します。AdministrationPersonオブジェクト内の詳細がユーザー削除プロセスで使用されます。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “DELUSER” or “DELETEUSER”“DELUSER”または“DELETEUSER”		Web services functionWebサービス関数。
Person	AdministrationPerson	The AdministrationPerson object holding all of the user’s details for the user creation process

These are the parameters that you need to set in the AdministrationPerson object:

AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Retrieving & Validating User Information

ユーザー削除プロセスに関するユーザーの詳細すべてを保持するAdministrationPersonオブジェクト。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明
UserId	String	YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

ユーザー情報の取得およびテスト

作成されたユーザーの詳細は、Webサービス呼び出しを使用して取得することができます。AdministrationPersonオブジェクトのUserIdフィールドは、ユーザーを識別するために使用されます。結果として、投入されたAdministrationPersonオブジェクトが返されます。セキュリティ上の理由から、パスワードは返されず、NULLとなります。また、このセクションでは、ユーザー情報をアプリケーションに照らし合わせてテストすることもできます。Once a user has been created, the user's details can be retrieved using a web service call. The User ID field in the AdministrationPerson object is used to identify the user. As a result, a populated AdministrationPerson object will be returned. For security reasons, passwords will not be returned and will be NULL. User information can also be validated against the application in this section.

Expand

title	GETUSER

The following code will call the Yellowfin web service to retrieve a user’s details:以下のコードは、ユーザーの詳細を取得するための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());
				
}

This code will return an AdministrationPerson object with the user’s details and SUCCESS in the このコードはユーザー詳細を含むAdministrationPersonオブジェクトを返し、rs.getStatusCode(), otherwise it will return an error message explaining why the process failed.

This function will retrieve the details of a particular user in Yellowfin. The details in the AdministrationPerson object will be used in the retrieval process.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。

この関数はYellowfinの特定ユーザーの詳細を取得します。AdministrationPersonオブジェクト内の詳細が取得プロセスで使用されます。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETUSER”		Web services functionWebサービス関数。
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson object:

取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明	AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

返される応答には、以下のパラメーターが含まれます。

応答要素	データ型	説明
StatusCode	String	Webサービス呼び出しのステータス。可能な値は以下の通りです。
Response Element	Data Type	Description
StatusCode	String	Status of the web service call. Possible values include: SUCCESS FAILURE
Person	AdministrationPersonThe AdministrationPerson object holding all of the returned user’s details	返されたユーザーの詳細すべてを保持するAdministrationPersonオブジェクト。

Expand

title	GETUSERBYIP

The following code will call the Yellowfin web service to retrieve a user’s details via their internal IpId:以下のコードは、内部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());
				
}

This function will retrieve the details of a particular user in Yellowfin by looking up their IP ID. The details in the AdministrationPerson object will be used in the retrieval process.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。

この関数はYellowfinの特定ユーザーのIP IDを検索し、そのユーザーの詳細を取得します。AdministrationPersonオブジェクト内の詳細が取得プロセスで使用されます。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “GETUSERBYIP”		Web services functionWebサービス関数。
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson object:

AdministrationPerson Element	Data Type	Description

IpId|Integer|IP ID of the Yellowfin User|

The response returned will contain these parameters:

取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明

IP ID|Integer|YellowfinユーザーのIP ID|

返される応答には、以下のパラメーターが含まれます。

応答要素	データ型	説明
StatusCode	String	Webサービス呼び出しのステータス。可能な値は以下の通りです。
Response Element	Data Type	Description
StatusCode	String	Status of the web service call. Possible values include: SUCCESS FAILURE
Person	AdministrationPersonThe AdministrationPerson object holding all of the returned user’s details	返されたユーザーの詳細すべてを保持するAdministrationPersonオブジェクト。

Expand

title	GETUSERFROMSEARCH

この関数は、特定の検索文字列に基づいて、Yellowfinからユーザーを取得します。この文字列がユーザーの名、姓、および電子メールアドレスと比較されます。

リクエスト要素	データ型	説明

This function will retrieve users from Yellowfin based on a specific search string. This string is compared against the user’s first name, last name, and email address.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETUSERSFROMSEARCH”		Web services functionWebサービス関数。
Parameters	Array (String)	Search string to match against Yellowfin users’ first names, last names, and email address

The response returned will contain these parameters:

Array（String）

Yellowfinユーザーの名、姓、および電子メールアドレスと照合する検索文字列。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

People

Array (AdministrationPerson)

Array（AdministrationPerson）

AdministrationPersonオブジェクトの配列。これらのオブジェクトには、検索文字列に一致した、返されたユーザーの詳細が保持されます。An array of AdministrationPerson objects. These objects hold the returned users’ details that match the search string

Expand

title	VALIDATEUSER

The following code will call the Yellowfin web service to validate a user:以下のコードは、ユーザーをテストするための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);

This code will return an AdministrationPerson object of the particular user if successful; otherwise it will return an error message explaining why the user validation process failed.

This function will validate a specified Yellowfin user, checking if the user currently exists within the application. The details in the AdministrationPerson object will be used in the user validation process.

このコードは、成功すると特定ユーザーのAdministrationPersonオブジェクトを返します。それ以外の場合は、ユーザー検証プロセスが失敗した理由を説明するエラーメッセージを返します。

この関数は、指定されたYellowfinユーザーがアプリケーション内に現在存在するかどうかをチェックしてテストします。AdministrationPersonオブジェクト内の詳細がユーザー検証プロセスで使用されます。

リクエスト要素	データ型	説明	Request Element
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = Function = “VALIDATEUSER”		Web services functionWebサービス関数。
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson object:

取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明	AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Person

AdministrationPersonThe AdministrationPerson object holding all of the returned user’s details

返されたユーザーの詳細すべてを保持するAdministrationPersonオブジェクト。

Expand

title	VALIDATEPASSWORD

The following code will call the Yellowfin web service to validate a user’s password:以下のコードは、ユーザーのパスワードをテストするための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);

This code will check if the password is expired and will return FAILURE in the rs.getStatusCode() if it is not, otherwise it will return SUCCESS.

This function will validate a Yellowfin user’s password. The details in the AdministrationPerson object will be used in the password validation process.

このコードは、パスワードの有効期限が切れているかどうかをチェックし、有効期限が切れていない場合にはrs.getStatusCode()でFAILUREを返します。それ以外の場合は、SUCCESSを返します。

この関数はYellowfinユーザーのパスワードをテストします。AdministrationPersonオブジェクト内の詳細がパスワード検証プロセスで使用されます。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “VALIDATEUSER”		Web services functionWebサービス関数。
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson object:

取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明	AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method
Password	String	Password of the Yellowfin user

The response returned will contain these parameters:

YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。
Password	String	Yellowfinユーザーのパスワード。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Manipulating User Information

ユーザー情報の操作

ユーザーの詳細は、Webサービス呼び出しを使用してあとから変更することができます。AdministrationPersonオブジェクトのUserIdフィールドは、ユーザーを識別するために使用されるため、変更することができません。AdministrationPersonオブジェクト内のその他のフィールドには、新しい変更内容が投入されます。セキュリティ上の理由から、このWebサービス呼び出しを使用してユーザーのパスワードを変更することはできませんが、個別のCHANGEPASSWORD関数（下記）を使用して変更することができます。A user's details can be modified at a later time using a web service call. The User ID field in the AdministrationPerson object is used to identify the user, so this cannot be changed. The rest of the fields within an AdministrationPerson object are populated with the new changes. For security reasons, the user's password cannot be changed with this web service call, but with a separate CHANGEPASSWORD function (below).

Expand

title	UPDATEUSER

The following code will call the Yellowfin web service to edit a user’s details:以下のコードは、ユーザーの詳細を編集するための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);

This function will update a specified Yellowfin user’s details. The details in the AdministrationPerson object will be used in the update process.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。

この関数は指定されたYellowfinユーザーの詳細を更新します。AdministrationPersonオブジェクト内の詳細が更新プロセスで使用されます。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “UPDATEUSER”		Web services functionWebサービス関数。
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process

These are the parameters that you can set in the AdministrationPerson object:

取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。

AdministrationPersonオブジェクトで設定できるパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID methodYellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。
Password	String	Password of the Yellowfin userYellowfinユーザーのパスワード。
FirstName	String	First name of of the Yellowfin userYellowfinユーザーの名。
LastName	String	Last name of of the Yellowfin userYellowfinユーザーの姓。
Initial	String	Middle name of the Yellowfin userYellowfinユーザーのミドルネーム。
SalutationCode	String	Title of the Yellowfin user. Possible values include:Yellowfinユーザーの敬称。可能な値は以下の通りです。 DR MISS MR MRS MS
RoleCode	String	Yellowfin role. The specified role here can be the Org Reference Code (YFADMIN) or the name of the role (Yellowfin Administrator)Yellowfinのロール。ここで指定するロールは、参照コード（YFADMIN）またはロール（Yellowfin管理者）の名前にすることができます。
EmailAddress	String	Email address of the Yellowfin userYellowfinユーザーの電子メールアドレス。
LanguageCode	String	Two letter code for the preferred language優先言語を表す2文字のコード。
IpId	Integer	Internal Yellowfin 内部Yellowfin IP IDID。
TimeZoneCode	String	The TimeZoneCode of the Yellowfin user. See appendix for valid values.

The response returned will contain these parameters:

YellowfinユーザーのTimeZoneCode。有効な値については、付録を参照してください。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Person

AdministrationPersonThe AdministrationPerson object holding all of the updated user’s details

更新されたユーザーの詳細すべてを保持するAdministrationPersonオブジェクト。

Expand

title	CHANGEPASSWORD

The following code will call the Yellowfin web service and change the password for the specified Yellowfin user:以下のコードは、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);

The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will change a specified Yellowfin user’s password.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数は指定されたYellowfinユーザーのパスワードを変更します。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “CHANGEPASSWORD”		Web services functionWebサービス関数。
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson object:

取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明	AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID methodYellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。
Password	String	New password of the Yellowfin user

The response returned will contain these parameters:

Yellowfinユーザーの新規パスワード。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

...

ユーザーに属するオブジェクトの取得

Styleclass

Class	topLink

top

Objects belonging to a user in a Primary or Client Organisation can be retrieved with various web service calls. The objects returned in the response will be dependent on the type of call made in the request.

ページトップ

さまざまなWebサービス呼び出しを使用して、デフォルト組織またはクライアント組織内のユーザーに属するオブジェクトを取得することができます。応答で返されるオブジェクトは、リクエストで実行される呼び出しのタイプに依存します。

Expand

title	GETUSERREPORTS / GETALLUSERREPORTS

The following code will call the Yellowfin web service and return all reports with a Web Services Name that are accessible for the particular user:以下のコードは、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);

This function will return all reports with a webservice name that are accessible for the specified Yellowfin user.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。

この関数は、指定されたYellowfinユーザーがアクセス可能なWebサービス名を含むすべてのレポートを返します。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETUSERREPORTS”	String	Web services functionWebサービス関数。
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson object:

AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

	この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明
UserId	String	YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

返される応答には、以下のパラメーターが含まれます。

応答要素	データ型	説明
StatusCode	String	Webサービス呼び出しのステータス。可能な値は以下の通りです。
Response Element	Data Type	Description
StatusCode	String	Status of the web service call. Possible values include: SUCCESS FAILURE
Reports	AdministrationReportAn array of AdministrationReport objects. These objects hold report metadata.	AdministrationReportオブジェクトの配列。これらのオブジェクトにはレポートメタデータが保持されます。

Expand

title	GETALLUSERREPORTS

以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なすべてのレポートを返します。

The following code will call the Yellowfin web service and return all reports that are accessible for the particular user:

Code Block

AdministrationServiceRequest rsr = new

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);

This code will return an Array of AdministrationReport objects in このコードは、rs.getReports() and SUCCESS in でAdministrationReportオブジェクトの配列を返し、rs.getStatusCode(), otherwise it will return an error message explaining why the process failed.でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETUSERREPORTS”	String	Web services functionWebサービス関数。
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson object:

取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです

AdministrationPerson要素	データ型	説明	AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Reports

AdministrationReportAn array of AdministrationReport objects. These objects hold report metadata.

AdministrationReportオブジェクトの配列。これらのオブジェクトにはレポートメタデータが保持されます。

Expand

title	GETREPORTSWITHCOMMENTS

The following code will call the Yellowfin web service and return all commented reports that are accessible for the particular user:以下のコードは、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);

This function will return all commented reports in Yellowfin that are accessible by the specified Yellowfin user.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。

この関数は、指定されたYellowfinユーザーがアクセス可能なYellowfin内のコメントされたすべてのレポートを返します。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETREPORTSWITHCOMMENTS”	String	Web services functionWebサービス関数。
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson object:

取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明	AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

返される応答には、以下のパラメーターが含まれます。

応答要素	データ型	説明
StatusCode	String	Webサービス呼び出しのステータス。可能な値は以下の通りです。
Response Element	Data Type	Description
StatusCode	String	Status of the web service call. Possible values include: SUCCESS FAILURE
Reports	AdministrationReportAn array of AdministrationReport objects. These objects hold report metadata.	AdministrationReportオブジェクトの配列。これらのオブジェクトにはレポートメタデータが保持されます。

Expand

title	GETFAVOURITES / GETFAVORITES

The following code will call the Yellowfin web service and return all report favourites that are accessible for the particular user:以下のコードは、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);

This function will return all the favourite reports of a specified Yellowfin user.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。

この関数は、指定されたYellowfinユーザーのすべてのお気に入りのレポートを返します。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETFAVOURITES” or “GETFAVORITES”“GETFAVOURITES”または“GETFAVORITES”	String	Web services functionWebサービス関数。
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson object:

取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明	AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

返される応答には、以下のパラメーターが含まれます。

String Status of the web service call. Possible values include:

応答要素	データ型	説明
StatusCode	String	Webサービス呼び出しのステータス。可能な値は以下の通りです。
Response Element	Data Type	Description
StatusCode	SUCCESS FAILURE
Reports	AdministrationReportAn array of AdministrationReport objects. These objects hold report metadata.	AdministrationReportオブジェクトの配列。これらのオブジェクトにはレポートメタデータが保持されます。

Expand

title	GETINBOX

The following code will call the Yellowfin web service and return all reports that are in the particular user’s inbox:以下のコードは、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);

This function will return the reports that are in the inbox of a specified Yellowfin user.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。

この関数は、指定されたYellowfinユーザーの受信トレイ内にあるレポートを返します。

リクエスト要素	データ型	説明	Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.		Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETINBOX”	String	Webサービス関数。	Function = “GETINBOX”	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson object:

取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明	AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

返される応答には、以下のパラメーターが含まれます。

応答要素	データ型	説明
StatusCode	String
Reports	AdministrationReport	AdministrationReportオブジェクトの配列。これらのオブジェクトにはレポートメタデータが保持されます。
Response Element	Data Type	Description
StatusCode	String Status of the web service call. Possible values include: SUCCESS FAILURE
Reports	AdministrationReport	An array of AdministrationReport objects. These objects hold report metadata.

Expand

title	GETUSERTABS

The following code will call the Yellowfin web service and return all dashboard tabs without reports that are accessible for that particular user:以下のコードは、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);

This code will return an Array of AdministrationReportGroup objects in このコードは、rs.getReportGroups() and SUCCESS in でAdministrationReportGroupオブジェクトの配列を返し、rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will return a list of dashboard tabs that are accessible by the specified Yellowfin user.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数は、指定されたYellowfinユーザーがアクセス可能なダッシュボードタブの一覧を返します。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETUSERTABS”	String	Web services functionWebサービス関数。
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson object:

AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

	この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明
UserId	String	YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

返される応答には、以下のパラメーターが含まれます。

String Status of the web service call. Possible values include:

応答要素	データ型	説明
StatusCode	String	Webサービス呼び出しのステータス。可能な値は以下の通りです。
Response Element	Data Type	Description
StatusCode	SUCCESS FAILURE
ReportsGroups	AdministrationReportGroupAn array of AdministrationReportGroup objects. These objects hold dashboard metadata.	AdministrationReportGroupオブジェクトの配列。これらのオブジェクトにはダッシュボードメタデータが保持されます。

Expand

title	GETUSERTABSWITHREPORTS

以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なレポートを含むすべてのダッシュボードタブを返します。

Code Block
AdministrationServiceRequest rsr = new AdminstrationServiceRequest

The following code will call the Yellowfin web service and return all dashboard tabs with reports that are accessible for that particular user:

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);

This function will return a list of dashboard tabs that are accessible by the specified Yellowfin user, with the reports’ metadata loaded as well. The metadata for every report in the dashboard tab is contained within the AdministrationReportGroup object.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数は、指定されたYellowfinユーザーがアクセス可能なダッシュボードタブの一覧を返します。このとき、レポートのメタデータも同時にロードされます。ダッシュボードタブのすべてのレポートのメタデータは、AdministrationReportGroupオブジェクト内に含まれます。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETUSERTABSWITHREPORTS”	String	Web services functionWebサービス関数。
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson object:

取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明	AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

返される応答には、以下のパラメーターが含まれます。

String Status of the web service call. Possible values include:

応答要素	データ型	説明
StatusCode	String	Webサービス呼び出しのステータス。可能な値は以下の通りです。
Response Element	Data Type	Description
StatusCode	SUCCESS FAILURE
ReportsGroups	AdministrationReportGroupAn array of AdministrationReportGroup objects. These objects hold dashboard metadata. For this particular function, the reports’ metadata is also loaded into this object’s GroupReports() parameter.	AdministrationReportGroupオブジェクトの配列。これらのオブジェクトにはダッシュボードメタデータが保持されます。この特定の関数では、レポートのメタデータもこのオブジェクトのGroupReports()パラメーターにロードされます。

Expand

title	LOADTABREPORTS

この関数は、指定されたダッシュボードタブ内に含まれるレポートの一覧を返します。このレポートには、Yellowfinの指定されたユーザーがアクセスすることができます。

リクエスト要素	データ型	説明

This function will return a list of reports contained within a specified dashboard tab, that is accessible by a specified user in Yellowfin.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “LOADTABREPORTS”	String	Web services functionWebサービス関数。
Person	AdministrationPersonThe AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process	取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。
ReportGroup	AdministrationReportGroup	The AdministrationReportGroup object holding the Dashboard Tab ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson and AdministrationReportGroup object:

取得プロセスに関するダッシュボードタブIDを保持するAdministrationReportGroupオブジェクト。

AdministrationPersonおよびAdministrationReportGroupオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明	AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method		YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

AdministrationReportGroup要素	データ型	説明
AdministrationReportGroup Element	Data Type	Description
ReportGroupId	String	Dashboard Tab ID

The response returned will contain these parameters:

ダッシュボードタブID

返される応答には、以下のパラメーターが含まれます。

Description

応答要素

データ型

説明

Response Element

Data Type

StatusCode

String Status of the web service call. Possible values include:

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

ReportGroups

AdministrationReportGroup

An array of AdministrationReportGroup objects. These objects hold dashboard metadata. For this particular function, the reports’ metadata is also loaded into this object’s GroupReports() parameter.

...

AdministrationReportGroupオブジェクトの配列。これらのオブジェクトにはダッシュボードメタデータが保持されます。この特定の関数では、レポートのメタデータもこのオブジェクトのGroupReports()パラメーターにロードされます。

グループ及びロールの管理

Styleclass

Class	topLink

top

Groups and Roles can be created and modified with a web service call. The objects returned in the response is dependent on the type of call made in the request.

ページトップ

Webサービス呼び出しを使用して、グループとロールを作成および変更することができます。応答で返されるオブジェクトは、リクエストで実行される呼び出しのタイプに依存します。

注意：クライアント組織機能を「システム設定」ページでオンにしている場合、特定のタイプの呼び出しについて適用可能な場合はクライアント組織を指定することもできます。Note: if Client Org functionality is turned on in the システム設定 page, a Client Org can also be specified where applicable for certain types of calls.

Expand

title	LISTROLES

The following code will call the Yellowfin web service and return all available roles within Yellowfin:以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内で使用可能なすべてのロールを返します。

Code Block

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;

rsr.setOrgId(new Integer(1));
rsr.setFunction("LISTROLES");

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return an Array of AdministrationRole objects in このコードは、rs.getRoles() and SUCCESS in でAdministrationRoleオブジェクトの配列を返し、rs.getStatusCode().

This function will return all the available roles within Yellowfin.

でSUCCESSを返します。

この関数は、Yellowfin内で使用可能なすべてのロールを返します。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “LISTROLES”	String	Web services function

The response returned will contain these parameters:

Webサービス関数。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

ロール

AdministrationRole

AdministrationRoleオブジェクトの配列。これらのオブジェクトにはYellowfinロールのメタデータが保持されます。

Roles

AdministrationRole

An array of AdministrationRole objects. These objects hold Yellowfin Role metadata.

Expand

title	LISTGROUPS

The following code will call the Yellowfin web service and return all available groups within Yellowfin:以下コードは、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);

The code will return an Array of AdministrationGroup objects in このコードは、rs.getGroups() and SUCCESS in でAdministrationGroupオブジェクトの配列を返し、rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will return all the available user groups within Yellowfin.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数は、Yellowfin内で使用可能なすべてのユーザーグループを返します。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “LISTGROUPS”	String	Web services functionWebサービス関数。
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.

The response returned will contain these parameters:

この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。

返される応答には、以下のパラメーターが含まれます。

応答要素	データ型	説明
StatusCode	String	Webサービス呼び出しのステータス。可能な値は以下の通りです。
Response Element	Data Type	Description
StatusCode	String	Status of the web service call. Possible values include: SUCCESS FAILURE
Groupsグループ	AdministrationGroupAn array of AdministrationGroup objects. These objects hold Yellowfin user group metadata.	AdministrationGroupオブジェクトの配列。これらのオブジェクトにはYellowfinユーザーグループのメタデータが保持されます。

Expand

title	GETGROUP

The following code will call the Yellowfin web service and return the specified group with its members in Yellowfin:以下のコードは、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();

The code will return an AdministrationGroup object in このコードは、rs.getGroup(), an Array of AdministrationGroupMembers in でAdministrationGroupオブジェクトを返し、rs.getGroup().getGroupMembers(), and SUCCESS in でAdministrationGroupMembersの配列を返し、rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will return a specified Yellowfin group with a list of its members.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数は、指定されたYellowfinグループおよびそのメンバーの一覧を返します。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auauなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETGROUP”	String	Web services functionWebサービス関数。
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Group	AdministrationGroup	The AdministrationGroup object holding the Yellowfin user group’s name for the retrieval process

These are the parameters that you need to set in the AdministrationGroup object:

取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。

AdministrationGroupオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationGroup要素	データ型	説明	AdministrationGroup Element	Data Type	Description
GroupName	String	Name of the specified Yellowfin Group

The response returned will contain these parameters:

指定したYellowfinグループの名前

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Group

AdministrationGroupAn array

of AdministrationGroup objects holding group metadata. The group members are also loaded into this object's GroupMembers() parameter.グループメタデータを保持するAdministrationGroupオブジェクトの配列。グループメンバーもこのオブジェクトのGroupMembers()のパラメーターにロードされます。

Expand

title	CREATEGROUP

The following code will call the Yellowfin web service and create the specified group in Yellowfin:以下のコードは、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);

The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

注意：AdministrationPersonオブジェクトのAdministrationGroupMember配列に入力することによって、新規作成されたグループに既存のYellowfinユーザーを同時に配置することもできます。各AdministrationPersonオブジェクトに必要なのはLoginId変数セットのみであり、AdministrationGroupMember配列はNote: you can also put existing Yellowfin users into this newly created group at the same time by populating an AdministrationGroupMember array of AdministrationPerson objects. Each AdministrationPerson object only needs the LoginId variable set, and the AdministrationGroupMember array is saved at group.setGroupMembers().

This function will create a Yellowfin group. Note that you are able to save existing Yellowfin users into the new group in this function as well.

に保存されます。

この関数はYellowfinグループを作成します。この関数では、新規グループに既存のYellowfinユーザーを保存できる点にも注意してください。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.
Function = “CREATEGROUP”	String	Web services functionWebサービス関数。
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Group	AdministrationGroup	The AdministrationGroup object holding the Yellowfin user group’s name for the retrieval process

These are the parameters that you need to set in the AdministrationGroup object:

取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。

AdministrationGroupオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationGroup要素	データ型	説明	AdministrationGroup Element
GroupName	String	Name of the specified Yellowfin group指定したYellowfinグループの名前
GroupDescription	String	Business description of the specified Yellowfin group	指定したYellowfinグループの説明
GroupMembers	Array (AdministrationPerson)	An array of AdministrationPerson objects. This is an optional parameter where you can set to save existing Yellowfin users into this group. Each AdministrationPerson object in this scenario only needs to have its UserId parameter set.

The response returned will contain these parameters:

Array（AdministrationPerson）

AdministrationPersonオブジェクトの配列。これはオプションのパラメーターで、既存のYellowfinユーザーをこのグループに保存するよう設定することができます。このシナリオの場合、AdministrationPersonオブジェクトに必要なのは、オブジェクトごとにそのUserIdパラメーターを設定することだけです。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	INCLUDEUSERINGROUP

The following code will call the Yellowfin web service and include a specified user into a specified group in Yellowfin:以下のコードは、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);

The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will include a specified Yellowfin user into a specified group.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数は、指定されたグループに指定されたYellowfinユーザーを含めます。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.auYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “INCLUDEUSERINGROUP”	String	Web services functionWebサービス関数。
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Group	AdministrationGroupThe AdministrationGroup object holding the Yellowfin user group’s name for the retrieval process	取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User Id for the retrieval process

These are the parameters that you need to set in the AdministrationGroup and AdministrationPerson objects:

取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。

AdministrationGroupおよびAdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationGroup要素	データ型	説明	AdministrationGroup Element	Data Type	Description
GroupName	String	Name of the specified Yellowfin group	指定したYellowfinグループの名前

AdministrationPerson要素	データ型	説明	AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Expand

title	EXCLUDEUSERINGROUP

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループから指定されたユーザーを除外します。

注意：このユーザーはグループから削除されるのではなく、グループ定義から除外されるだけです。これが役立つのは、たとえば以下のような場合です。

John DoeはグループAのメンバーである
グループAはグループBのメンバーである
John DoeはグループBのメンバーであってはならないため、グループBから除外する必要がある

The following code will call the Yellowfin web service and exclude a specified user from a specified group in Yellowfin.

Note: this user is not deleted from the group but merely excluded from the group definition. An example of why this would be useful is when:

John Doe is a member of Group A
Group A is a member of Group B
John Doe shouldn’t be a member of Group B, therefore he should be excluded from Group 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("EXCLUDEUSERINGROUP");
rsr.setGroup(group);
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will exclude a specified Yellowfin user from a specified group. Note that this user is not deleted from the group but merely excluded from the group definition. An example of why this would be useful is when:

John Doe is a member of Group A
Group A is a member of Group B
John Doe shouldn’t be a member of Group B, therefore he is to be excluded from Group B

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数は、指定されたグループから指定されたYellowfinユーザーを除外します。このユーザーはグループから削除されるのではなく、グループ定義から除外されるだけである点に注意してください。これが役立つのは、たとえば以下のような場合です。

John DoeはグループAのメンバーである
グループAはグループBのメンバーである
John DoeはグループBのメンバーであってはならないため、グループBから除外する必要がある

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “EXCLUDEUSERINGROUP”	String	Web services functionWebサービス関数。
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Group	AdministrationGroupThe AdministrationGroup object holding the Yellowfin user group’s name for the retrieval process	取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User Id for the retrieval process

These are the parameters that you need to set in the AdministrationGroup and AdministrationPerson objects:

取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。

AdministrationGroupおよびAdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationGroup要素	データ型	説明	AdministrationGroup Element	Data Type	Description
GroupName	String	Name of the specified Yellowfin group	指定したYellowfinグループの名前

AdministrationPerson要素	データ型	説明	AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	DELETEUSERFROMGROUP

The following code will call the Yellowfin web service and delete a specified user from a specified group in Yellowfin:以下のコードは、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);

The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will delete a specified Yellowfin user from a specified group. Note that this scenario is different from the one in EXCLUDEUSERINGROUP – in this function a user will be permanently removed from the group.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数は、指定したグループから指定されたYellowfinユーザーを削除します。このシナリオはEXCLUDEUSERINGROUPのシナリオとは異なります。この関数の場合、ユーザーはグループから完全に削除される点に注意してください。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “DELUSERFROMGROUP”	String	Web services functionWebサービス関数。
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.
Group	AdministrationGroup	The AdministrationGroup object holding the Yellowfin user group’s name for the retrieval process
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User Id for the retrieval process

These are the parameters that you need to set in the AdministrationGroup and AdministrationPerson objects:

	この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Group	AdministrationGroup	取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。

AdministrationGroupおよびAdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationGroup要素	データ型	説明	AdministrationGroup Element	Data Type	Description
GroupName	String	Name of the specified Yellowfin group	指定したYellowfinグループの名前

AdministrationPerson要素	データ型	説明	AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	MODIFYGROUP

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループを変更します。

Code Block

The following code will call the Yellowfin web service and modify the specified group in 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);

注意：AdministrationPersonオブジェクトのAdministrationGroupMember配列を投入することによって、変更されたグループに既存のYellowfinユーザーを同時に配置することもできます。各AdministrationPersonオブジェクトに必要なのはLoginId変数セットのみであり、AdministrationGroupMember配列はNote: you can also put existing Yellowfin users into this modified group at the same time by populating an AdministrationGroupMember array of AdministrationPerson objects. Each AdministrationPerson object only needs the LoginId variable set, and the AdministrationGroupMember array is saved at group.setGroupMembers().

This function will modify the details for a specified group in Yellowfin. Note that you are able to save existing Yellowfin users into the new group in this function as well.

に保存されます。

この関数はYellowfinの指定されたグループの詳細を変更します。この関数では、新規グループに既存のYellowfinユーザーを保存できる点にも注意してください。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “MODIFYGROUP”	String	Web services functionWebサービス関数。
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Group	AdministrationGroup	The AdministrationGroup object holding the Yellowfin user group’s name for the retrieval process

These are the parameters that you need to set in the AdministrationGroup object:

取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。

AdministrationGroupオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationGroup要素	データ型	説明
GroupName	String	Name of the specified Yellowfin group指定したYellowfinグループの名前
GroupDescription	String	Business description of the specified Yellowfin group指定したYellowfinグループの説明
GroupMembers	Array (AdministrationPerson)	An array of AdministrationPerson objects. This is an optional parameter where you can set to save existing Yellowfin users into this group. Each AdministrationPerson object in this scenario only needs to have its LoginId parameter set.

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Array（AdministrationPerson）

AdministrationPersonオブジェクトの配列。これはオプションのパラメーターで、既存のYellowfinユーザーをこのグループに保存するよう設定することができます。このシナリオの場合、AdministrationPersonオブジェクトに必要なのは、オブジェクトごとにそのLoginIdパラメーターを設定することだけです。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	DELETEGROUP

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループを削除します。

Code Block
AdministrationServiceRequest rsr = new AdministrationServiceRequest()

Expand

title	DELETEGROUP

The following code will call the Yellowfin web service and delete the specified group in 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);

The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will delete a specified group from Yellowfin.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数はYellowfinから指定されたユーザーを削除します。

リクエスト要素	データ型	説明
Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “DELETEGROUP”	String	Web services functionWebサービス関数。
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Group	AdministrationGroup	The AdministrationGroup object holding the Yellowfin user group’s name for the retrieval process

These are the parameters that you need to set in the AdministrationGroup object:

取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。

AdministrationGroupオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationGroup要素	データ型	説明	AdministrationGroup Element	Data Type	Description
GroupName	String	Name of the specified Yellowfin group

The response returned will contain these parameters:

指定したYellowfinグループの名前

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

...

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

マルチテナント機能

Styleclass

Class	topLink

top

Yellowfin contains functionality called Client Organisations, which allows multiple virtual instances of Yellowfin to reside in the same server instance.

ページトップ

Yellowfinには、クライアント組織と呼ばれる機能があり、この機能を使用するとYellowfinの複数の仮想インスタンスを同じサーバーインスタンスに配置できます。

クライアント組織機能は、以下に示す使用可能なWebサービス呼び出しによって管理することができます。Client Organisation functionality can be managed with the available web service calls listed below.

Expand

title	LISTCLIENTS

The following code will call the Yellowfin web service and list all client organisations within Yellowfin:以下のコードは、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);

The code will return an Array of AdministrationClientOrg objects and SUCCESS in このコードは、AdministrationClientOrgオブジェクトの配列を返し、rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will list all client organisations available within Yellowfin.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数は、Yellowfin内で使用可能なすべてのクライアント組織を一覧表示します。

リクエスト要素	データ型	説明	Request Element
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservices	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “LISTCLIENTS”	String	Web services function

The response returned will contain these parameters:

Webサービス関数。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	GETCLIENT

The following code will call the Yellowfin web service and get the specified client organisation within Yellowfin:以下コードは、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);

The code will return an AdministrationClientOrg object in このコードは、rs.getClient() and SUCCESS in でAdministrationClientOrgオブジェクトを返し、rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will retrieve details for a specified client organisation within Yellowfin.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数はYellowfin内の指定されたクライアント組織の詳細を取得します。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETCLIENT”	String	Web services functionWebサービス関数。
Client	AdministrationClientOrg	The AdministrationClientOrg object holding the Yellowfin client reference ID for the retrieval process

These are the parameters that you need to set in the AdministrationClientOrg object:

取得プロセスに関するYellowfinクライアント参照IDを保持するAdministrationClientOrgオブジェクト。

AdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationClientOrg要素	データ型	説明	AdministrationClientOrg Element	Data Type	Description
ClientReferenceId	Integer	Client Reference ID for the specified client organisation

The response returned will contain these parameters:

指定されたクライアント組織のクライアント参照ID

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	CREATECLIENT

The following code will call the Yellowfin web service and create the specified client organisation within Yellowfin:以下のコードは、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);

The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.

The function will create the specified client organisation in Yellowfin.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数はYellowfinに指定されたクライアント組織を作成します。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “CREATECLIENT”	String	Web services functionWebサービス関数。
Client	AdministrationClientOrg	The AdministrationClientOrg object holding the Yellowfin client reference ID for the retrieval process

These are the parameters that you need to set in the AdministrationClientOrg object:

取得プロセスに関するYellowfinクライアント参照IDを保持するAdministrationClientOrgオブジェクト。

AdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationClientOrg要素	データ型	説明
ClientName	String	Name of the client organisationクライアント組織の名前
ClientReferenceID	String	Client Reference ID which is the unique ID used to identify a clientクライアントの識別に使用される固有のIDであるクライアント参照ID
TimeZoneCode	String	A client organisation’s local time zone code.クライアント組織のローカルタイムゾーンコード
DefaultOrg	Boolean	Boolean value that returns true if this organisation is the primary organisation

The response returned will contain these parameters:

この組織がデフォルト組織である場合にtrueを返すブール値

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Expand

title	DELETECLIENT

The following code will call the Yellowfin web service and delete the specified client organisation within Yellowfin:以下のコードは、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);

The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will delete the specified client organisation in Yellowfin.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数はYellowfinの指定されたクライアント組織を削除します。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “DELETECLIENT”	String	Web services functionWebサービス関数。
Client	AdministrationClientOrg	The AdministrationClientOrg object holding the Yellowfin client reference ID for the retrieval process

These are the parameters that you need to set in the AdministrationClientOrg object:

取得プロセスに関するYellowfinクライアント参照IDを保持するAdministrationClientOrgオブジェクト。

AdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationClientOrg要素	データ型	説明	AdministrationClientOrg Element	Data Type	Description
ClientReferenceId	Integer	Client Reference ID for the specified client organisation

The response returned will contain these parameters:

指定されたクライアント組織のクライアント参照ID

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	UPDATECLIENT

The following code will call the Yellowfin web service and update the specified client organisation within Yellowfin:以下のコードは、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);

The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.

The following code will call the Yellowfin webservice and update the specified client organisation within Yellowfin.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織を更新します。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “UPDATECLIENT”	String	Web services functionWebサービス関数。
Client	AdministrationClientOrg	The AdministrationClientOrg object holding the Yellowfin client reference ID for the retrieval process

These are the parameters that you can set in the AdministrationClientOrg object:

取得プロセスに関するYellowfinクライアント参照IDを保持するAdministrationClientOrgオブジェクト。

AdministrationClientOrgオブジェクトで設定できるパラメーターは、以下の通りです。

AdministrationClientOrg要素	データ型	説明
ClientName	String	Name of the client organisationクライアント組織の名前
ClientReferenceId	Integer	Client Reference ID for the specified client organisation. Note that this is used for the initial retrieval process, and cannot be modified during the usage of this function指定されたクライアント組織のクライアント参照ID。このIDは最初の取得プロセスに使用され、この関数の使用中には変更することができない点に注意が必要です。
TimeZoneCode	String	A client organisation’s local time zone code.クライアント組織のローカルタイムゾーンコード
DefaultOrg	Boolean	Boolean value that returns true if this organisation is the primary organisation

The response returned will contain these parameters:

この組織がデフォルト組織である場合にtrueを返すブール値

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Expand

title	LISTUSERSATCLIENT

The following code will call the Yellowfin web service and list all users belonging to the specified client organisation within Yellowfin:以下のコードは、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();

The code will return an Array of AdministrationPerson objects in このコードは、rs.getPeople() and SUCCESS in でAdministrationPersonオブジェクトの配列を返し、rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will list all Yellowfin users belonging to the specified client organisation in Yellowfin.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数はYellowfinの指定されたクライアント組織に属するすべてのYellowfinユーザーを一覧表示します。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “LISTUSERSATCLIENT”	String	Web services functionWebサービス関数。
Client	AdministrationClientOrg	The AdministrationClientOrg object holding the Yellowfin client reference ID for the retrieval process

These are the parameters that you need to set in the AdministrationClientOrg object:

取得プロセスに関するYellowfinクライアント参照IDを保持するAdministrationClientOrgオブジェクト。

AdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationClientOrg要素	データ型	説明	AdministrationClientOrg Element	Data Type	Description
ClientReferenceId	Integer	Client Reference ID for the specified client organisation

The response returned will contain these parameters:

指定されたクライアント組織のクライアント参照ID

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

People

Array (AdministrationPerson)

Array（AdministrationPerson）

AdministrationPersonオブジェクトの配列。各オブジェクトにはYellowfinユーザーのメタデータが保持されます。Array of AdministrationPerson objects. Each object holds Yellowfin user metadata.

Expand

title	GETUSERACCESS

The following code will call the Yellowfin web service and list all client organisations accessible by a specified user within Yellowfin:以下のコードは、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();

The code will return an Array of AdministrationClientOrg objects in このコードは、rs.getClients() and SUCCESS in でAdministrationClientOrgオブジェクトの配列を返し、rs.getStatusCode(), otherwise it will return an error explaining why the process failed.でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETUSERACCESS”	String	Web services functionWebサービス関数。
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process

These are the parameters that you need to set in the AdministrationClientOrg object:

取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。

AdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明	AdministrationPersonElement	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Clients

Array (AdministrationClientOrg)

Array of AdministrationClientOrg objects. Each object holds Yellowfin client organisation metadata

Array（AdministrationClientOrg）

AdministrationClientOrgオブジェクトの配列。各オブジェクトにはYellowfinクライアント組織のメタデータが保持されます。

Expand

title	ADDUSERACCESS

The following code will call the Yellowfin web service and add access to a specified client organisation for a specified user within Yellowfin:以下のコードは、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);

The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will add access to a specified client organisation for a specified user win Yellowfin.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数は、Yellowfinの指定されたユーザーに対して指定されたクライアント組織へのアクセス権を追加します。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auauなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “ADDUSERACCESS”	String	Web services functionWebサービス関数。
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process
Client	AdministrationClientOrg	The AdministrationClientOrg object holding the Yellowfin client organisation’s Client Reference ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson and AdministrationClientOrg objects:

AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

AdministrationClientOrg Element	Data Type	Description
ClientReferenceId	Integer	Client Reference ID for the specified client organisation

The response returned will contain these parameters:

	この関数を特定のクライアント組織に適用する場合には、クライアント参照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サービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Expand

title	REMOVEUSERACCESS

The following code will call the Yellowfin web service and remove access to a specified client organisation for a specified user within Yellowfin:以下のコードは、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);

The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will remove access to a specified client organisation for a specified user in Yellowfin.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数は、Yellowfinの指定されたユーザーに対して指定されたクライアント組織へのアクセス権を削除します。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auauなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “REMOVEUSERACCESS”	String	Web services functionWebサービス関数。
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process
Client	AdministrationClientOrg	The AdministrationClientOrg object holding the Yellowfin client organisation’s Client Reference ID for the retrieval process

These are the parameters that you need to set in the AdministrationPerson and AdministrationClientOrg objects:

AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

AdministrationClientOrg Element	Data Type	Description
ClientReferenceId	Integer	Client Reference ID for the specified client organisation

The response returned will contain these parameters:

	この関数を特定のクライアント組織に適用する場合には、クライアント参照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サービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Expand

title	ISREPORTFAVOURITE

この関数は、指定されたレポートがYellowfinの指定されたユーザーのお気に入り一覧に存在するかどうかをチェックします。

リクエスト要素	データ型	説明

This function will check if a specified report is in a specified user’s favourites list in Yellowfin.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “ISUSERFAVOURITE”	String	Web services functionWebサービス関数。
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Person	AdministrationPersonThe AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process	取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。
ReportId	Integer	Unique ID for the report

These are the parameters that you need to set in the AdministrationPerson object:

レポートの固有のID。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明	AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	ADDTOFAVOURITES / ADDTOFAVORITES

The following code will call the Yellowfin web service and add a specified report to a specified user’s favourites list:以下のコードは、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);

The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will add a specified report to a specified user’s report favourites list.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数は、指定されたレポートを指定されたユーザーのレポートのお気に入り一覧に追加します。

リクエスト要素	データ型	説明	Request Element
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservices	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “ADDTOFAVOURITES" OR または"ADDTOFAVORITES”	String	Web services functionWebサービス関数。
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Person	AdministrationPersonThe AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process	取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。
ReportId	Integer	Unique ID for the report

These are the parameters that you need to set in the AdministrationPerson object:

レポートの固有のID。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明	AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	REMOVEFAVOURITES / REMOVEFAVORITES

The following code will call the Yellowfin web service and remove a specified report to a specified user’s favourites list:以下のコードは、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);

The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will remove a specified report to a specified user’s report favourites list.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数は、指定されたユーザーのレポートのお気に入り一覧に対して指定されたレポートを削除します。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “REMOVETOFAVOURITES" OR または"REMOVETOFAVORITES”	String	Web services functionWebサービス関数。
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process
ReportId	Integer	Unique ID for the report

These are the parameters that you need to set in the AdministrationPerson object:

AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method

The response returned will contain these parameters:

	この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Person	AdministrationPerson	取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。
ReportId	Integer	レポートの固有のID。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明
UserId	String	YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Expand

title	GETAVATARS

この関数は、Yellowfin内の指定されたユーザーのすべてのアバターイメージを返します。

リクエスト要素	データ型	説明

This function will return all avatar images of specified users within Yellowfin:

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETAVATARS”	String Web services functionWebサービス関数。
Parameters	Array (String)	The Unique IDs of Yellowfin users

The response returned will contain these parameters:

Array（String）

Yellowfinユーザーの固有のID。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

BinaryAttachments

Array (ReportBinaryObject)

Array（ReportBinaryObject）

Base64でデコードされたアバターイメージを保持するReportBinaryオブジェクトの配列。Array of ReportBinary objects holding the Base64 decoded avatar images

Expand

title	SETAVATARIMAGE

この関数は、Yellowfin内の指定されたユーザーのプロファイルのアバターイメージを設定します。

リクエスト要素	データ型	説明

This function will set the avatar image of the specified user’s profile within Yellowfin:

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “SETAVATARIMAGE”	String	Web services functionWebサービス関数。
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。
Person	AdministrationPersonThe AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process	取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。
Parameters	Array (Bytes)	Base64 encoded avatar image

These are the parameters that you need to set in the AdministrationPerson object:

Array（Bytes）

Base64でエンコードされたアバターイメージ。

AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。

AdministrationPerson要素	データ型	説明	AdministrationPerson Element	Data Type	Description
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID methodYellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。
IpId	Integer	Unique IP ID of the Yellowfin user

The response returned will contain these parameters:

Yellowfinユーザーの固有のIP ID。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Expand

title	RELOADCODES

この関数は、Yellowfin内の指定された参照コードを再読み込みします。

リクエスト要素	データ型	説明

This function will reload the specified Org Reference Codes within Yellowfin.

Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “RELOADCODES”	String	Web services functionWebサービス関数。
Parameters	Array (String)	The list of Org Reference Codes

The response returned will contain these parameters:

Array（String）

参照コードの一覧。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	GEOMETRYFLUSH

The following code will call the Yellowfin web service and clear the geometry cache in Yellowfin:以下のコードは、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);

The code will return SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.

The function will clear the geometry cache in Yellowfin.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数はYellowfinのジオメトリキャッシュをクリアします。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auauなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GEOMETRYFLUSH”	String	Web services functionWebサービス関数。
Parameters	Array (String)	The list of View IDs from which the geometry objects are cached with

The response returned will contain these parameters:

Array（String）

ジオメトリオブジェクトのキャッシュ元となるビューIDの一覧。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	REMOVEVIEW

The following code will call the Yellowfin web service and remove a view’s cache in Yellowfin:以下のコードは、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);

The code will return SUCCESS in rsこのコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will remove a view's cache in Yellowfin.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数はYellowfinのビューのキャッシュを削除します。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “REMOVEVIEW”	String	Web services functionWebサービス関数。
Parameters	Array (String)	The list of View IDs

The response returned will contain these parameters:

Array（String）

ビューIDの一覧。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	FLUSHREPORT

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinにおけるレポートのキャッシュされた定義を削除します。

The following code will call the Yellowfin web service and remove a report’s cached definitions in Yellowfin:

Code Block

AdministrationServiceRequest rsr =

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);

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “FLUSHREPORT”	String	Web services functionWebサービス関数。
Parameters	Array (String)	The list of Report IDs

The response returned will contain these parameters:

Array（String）

レポートIDの一覧。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	FLUSHTAB

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinにおけるダッシュボードのキャッシュされた定義を削除します。

Code Block
AdministrationServiceRequest rsr

The following code will call the Yellowfin web service and remove a dashboard’s cached definitions in 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);

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “FLUSHTAB”	String	Web services functionWebサービス関数。
Parameters	Array (String)	The list of Tab IDs

The response returned will contain these parameters:

Array（String）

タブIDの一覧。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	DELETEREPORT

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのレポートを削除します。

Code Block
AdministrationServiceRequest rsr

The following code will call the Yellowfin web service and delete a report in 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);

リクエスト要素	データ型	説明	Request Element
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.auYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “DELETEREPORT”	String	Web services functionWebサービス関数。
Parameters	Array (String)	Array（String）	YellowfinレポートのUUID。ReportIdが設定されている場合、この設定は必要ありません。The UUID of the Yellowfin Report. Note, you do not need to set this if ReportId is set
ReportId	Integer	The Yellowfin Report ID. Note, you do not need to set this if the UUID is set in the Parameter array

The response returned will contain these parameters:

YellowfinレポートのID。Parameterの配列にUUIDが設定されている場合、この設定は必要ありません。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

StatusCode

String

Webサービス呼び出しのステータス。可能な値は以下の通りです。

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Expand

title	DELETEVIEW

The following code will call the Yellowfin web service and delete a view in Yellowfin:以下のコードは、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);

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “DELETEVIEW”	String	Web services functionWebサービス関数。
Parameters	Array (String)	Either the Yellowfin View ID or UUID can be set here

The response returned will contain these parameters:

Array（String）

ここには、YellowfinのビューIDまたはUUIDを設定することができます。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	DELETESOURCE

The following code will call the Yellowfin web service and delete a data source in Yellowfin:以下のコードは、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);

The code will return {SUCCESS in このコードはrs.getStatusCode(), otherwise it will return an error explaining why the process failed.でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “DELETESOURCE”	String	Web services functionWebサービス関数。
Parameters	Array (String)	Either the Yellowfin Data Source ID or UUID can be set here

The response returned will contain these parameters:

Array（String）

ここには、YellowfinのデータソースIDまたはUUIDを設定することができます。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	DELETETAB

The following code will call the Yellowfin web service and delete a dashboard tab in Yellowfin:以下のコードは、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);

リクエスト要素	データ型	説明	Request Element
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “DELETETAB”	String	Web services functionWebサービス関数。
Parameters	Array (String)	Array（String）	YellowfinダッシュボードタブのUUID。DashboardTabIdパラメーターが設定されている場合、この設定は必要ありません。UUID of the Yellowfin Dashboard Tab. Note that this does not need to be set if the DashboardTabId parameter is set
DashboardTabId	Integer	ダッシュボードタブID。	Dashboard Tab ID

The response returned will contain these parameters:

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	RELOADLICENCE

The following code will call the Yellowfin web service and reload the licence definitions in Yellowfin:以下のコードは、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);

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “RELOADLICENCE”	String	Web services function

The response returned will contain these parameters:

Webサービス関数。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	CLOSECONNECTIONPOOL

The following code will call the Yellowfin web service and close the specified data source’s connection pool in Yellowfin:以下のコードは、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);

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “CLOSECONNECTIONPOOL”	String	Web services functionWebサービス関数。
Parameters	Array (String)	Yellowfin Data Source ID

The response returned will contain these parameters:

Array（String）

YellowfinのデータソースID。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	FLUSHCACHEDFILTERCACHE

The following code will call the Yellowfin web service and flush the specified filter’s filter cache in Yellowfin:以下のコードは、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);

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “FLUSHCACHEDFILTERCACHE”	String	Web services functionWebサービス関数。
Parameters	Array (String)	Filter ID

The response returned will contain these parameters:

Array（String）

フィルターID。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	APPROVEREPORT

以下のコードは、Yellowfin Webサービスを呼び出し、エキスパートの承認プロセスを介してYellowfinのレポートを承認します。

Code Block
AdministrationServiceRequest rsr

The following code will call the Yellowfin web service and approve a report in Yellowfin via the expert approval process:

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);

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “APPROVEREPORT”	String	Web services functionWebサービス関数。
ReportId	Integer	Report ID

The response returned will contain these parameters:

レポートID。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

Expand

title	GETCONTENT

The following code will call the Yellowfin web service and obtain all exportable content within Yellowfin:以下のコードは、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();

The code will return an Array of ContentResource objects in このコードは、rs.getContentResources() and SUCCESS in でContentResourceオブジェクトの配列を返し、rs.getStatusCode(), otherwise it will return an error explaining why the process failed.でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETCONTENT”	String	Web services function

The response returned will contain these parameters:

Webサービス関数。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

ContentResources

Array (ContentResource)

Array（ContentResource）

ContentResourceオブジェクトの配列。各ContentResourceオブジェクトには、Yellowfinでエクスポート可能なすべてのコンテンツのエクスポートメタデータが保持されます。Array of Content Resource objects. Each ContentResource object holds export metadata for all exportable content in Yellowfin.

Expand

title	GETEXPORTDEPENDENCIES

以下のコードは、Yellowfin Webサービスを呼び出し、特定のYellowfin成果物についての従属関係を取得します。

Code Block
AdministrationServiceRequest

The following code will call the Yellowfin web service and obtain dependencies for a specific Yellowfin artifact:

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();

This function will obtain dependencies for a specific Yellowfin artifact. Note, you can execute the GETCONTENT webservices call to retrieve all exportable content metadata first. This comes in the form of an array of ContentResource objects which can be then used in this function call to retrieve their respective dependencies.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数は、特定のYellowfin成果物についての従属関係を取得します。最初に、GETCONTENT Webサービス呼び出しを実行して、エクスポート可能なすべてのコンテンツメタデータを取得することができます。このコンテンツメタデータはContentResourceオブジェクトの配列という形式で取得され、この関数呼び出しでそれぞれの従属関係を取得するために使用することができます。

リクエスト要素	データ型	説明	Request Element
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfinYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = Function = “GETEXPORTDEPENDENCIES”	String	Web services functionWebサービス関数。
ContentResources	Array (ContentResource)	Array of ContentResource objects. These objects will hold specific Yellowfin artifact metadata

These are the parameters that you need to set in the ContentResource object:

Array（ContentResource）

ContentResourceオブジェクトの配列。これらのオブジェクトには、特定のYellowfin成果物のメタデータが保持されます。

ContentResourceオブジェクトで設定が必要なパラメーターは、以下の通りです。

ContentResource要素	データ型	ContentResource Element	Data Type
ResourceName	String
ResourceDescription	String
ResourceType	String
ResourceOrgId	Integer
ResourceCode	String

The response returned will contain these parameters:

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

ContentResources

Array (ContentResource)

Array（ContentResource）

ContentResourceオブジェクトの配列。これらのオブジェクトには従属関係メタデータが保持されます。Array of ContentResource objects. These objects will hold dependency metadata

Expand

title	EXPORTCONTENT

The following code will call the Yellowfin web service and export the specified artifacts within Yellowfin:以下のコードは、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();

The code will return an Array of ReportBinaryObjects objects in このコードは、rs.getBinaryAttachments() and SUCCESS in でReportBinaryObjectsオブジェクトの配列を返し、rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

This function will export the specified artifacts within Yellowfin. Note, you can execute the GETCONTENT webservices call to retrieve all exportable content metadata first.

でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

この関数はYellowfin内の指定された成果物をエクスポートします。最初に、GETCONTENT Webサービス呼び出しを実行して、エクスポート可能なすべてのコンテンツメタデータを取得することができます。

リクエスト要素	データ型	説明
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.auYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “EXPORTCONTENT”	String	Web services functionWebサービス関数。
ContentResources	Array (ContentResource)	Array of ContentResource objects. These objects will hold specific Yellowfin artifact metadata

These are the parameters that you need to set in the ContentResource object:

Array（ContentResource）

ContentResourceオブジェクトの配列。これらのオブジェクトには、特定のYellowfin成果物のメタデータが保持されます。

ContentResourceオブジェクトで設定が必要なパラメーターは、以下の通りです。

ContentResource要素	データ型	ContentResource Element	Data Type
ResourceName	String
ResourceDescription	String
ResourceType	String
ResourceOrgId	Integer
ResourceCode	String

The response returned will contain these parameters:

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

BinaryAttachments

Array(ReportBinaryObjects)

Array（ReportBinaryObjects）

ReportBinaryObjectオブジェクトの配列。これらのオブジェクトには、エクスポートされた成果物のXMLが保持されます。Array of ReportBinaryObject objects. These objects will hold the XML for exported artifacts.

Expand

title	GETIMPORTCONTENT

The following code will call the Yellowfin web service and read a Yellowfin import file, returning the objects to be imported:以下のコードは、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();

この関数の詳細な動作例については、Yellowfin WebサービスディレクトリYellowfinRefer to ws_admin_import.jsp in your Yellowfin web services directory Yellowfin\development\examples\web services for a more detailed example of how this function would work.

This function will read a Yellowfin XML import file and return a list of objects that can be imported into the application. This function will be expecting a Base64 encoded XML file as input.

にあるws_admin_import.jspを参照してください。

この関数は、YellowfinのXMLインポートファイルを読み取り、アプリケーションにインポート可能なオブジェクトの一覧を返します。この関数の入力には、Base64でエンコードされたXMLファイルを使用してください。

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1.Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “GETIMPORTCONTENT”	String	Web services functionWebサービス関数。
Parameters	Array (String)	Array of Base64 encoded chunks of the XML import file.

The response returned will contain these parameters:

Array（String）

Base64でエンコードされた多数のXMLインポートファイルの配列。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

ContentResources

Array (ContentResource)

Array of ContentResource objects. These objects will hold specific Yellowfin artifact metadata

Expand

title	TESTIMPORTCONTENT

Array（ContentResource）

ContentResourceオブジェクトの配列。これらのオブジェクトには、特定のYellowfin成果物のメタデータが保持されます。

Expand

title	TESTIMPORTCONTENT

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのインポートオブジェクトをテストします。通常、この関数はGETIMPORTCONTENT Webサービス呼び出しのあとに実行します。The following code will call the Yellowfin web service and validate the Yellowfin import objects. This function usually follows after the GETIMPORTCONTENT web services call:

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();

The code will return an Array of ImportIssue objects in このコードは、インポートファイルに問題がある場合にはrs.getImportIssues() if there are issues with the import file and SUCCESS in でImportIssueオブジェクトの配列を返し、rs.getStatusCode(), otherwise it will return an error explaining why the process failed.でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。

This function will validate a list of Yellowfin import objects. This function usually follows after the GETIMPORTCONTENT webservices call, where it reads a Yellowfin XML import file and returns a list of objects that can be imported into the application. In this function, it performs a validation process for every object in that list. Any issues encountered during the validation process is returned as ImportIssue objects in the response.

にある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に設定します。
Request Element	Data Type	Description
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password	String	Password of the account used to connect to Yellowfin webservices
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1
Function = “TESTIMPORTCONTENT”	String	Web services functionWebサービス関数。
Parameters	Array (String)	Array（String）	Base64でエンコードされた多数のXMLインポートファイルの配列。An array of Base64 encoded chunks of the XML import file
ImportOptions	Array(ImportOption)	An array of ImportOption objects that controls how content is imported.

The response returned will contain these parameters:

Array（ImportOption）

コンテンツのインポート方法を制御するImportOptionオブジェクトの配列。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

ImportIssues

Array (ImportIssue)

Array of ImportIssue objects. These objects will contain error messages returned from the validation process

Array（ImportIssue）

ImportIssueオブジェクトの配列。これらのオブジェクトには、検証プロセスから返されたエラーメッセージが含まれます。

Expand

title	IMPORTCONTENT

以下のコードは、Yellowfin Webサービスを呼び出し、指定されたYellowfinのインポートオブジェクトをアプリケーションにインポートします。

Expand

title	IMPORTCONTENT

The following code will call the Yellowfin web service and import the specified Yellowfin import objects into the application:

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);

この関数の詳細な動作例については、Yellowfin WebサービスディレクトリRefer to ws_admin_import.jsp in your Yellowfin web services directory Yellowfin\development\examples\web services for a more detailed example of how this function would work.にあるws_admin_import.jspを参照してください。

リクエスト要素	データ型	説明	Request Element
LoginId	String	Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.auYellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Password of the account used to connect to Yellowfin webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary Organisation ID within Yellowfin. Always set this to 1Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = “IMPORTCONTENT”	String	Web services functionWebサービス関数。
Parameters	Array (String)	Array（String）	Base64でエンコードされた多数のXMLインポートファイルの配列。An array of Base64 encoded chunks of the XML import file
ImportOptions	Array(ImportOption)	An array of ImportOption objects that controls how content is imported.

The response returned will contain these parameters:

Array（ImportOption）

コンテンツのインポート方法を制御するImportOptionオブジェクトの配列。

返される応答には、以下のパラメーターが含まれます。

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:Webサービス呼び出しのステータス。可能な値は以下の通りです。

SUCCESS
FAILURE

...

オブジェクト定義

Styleclass

Class	topLink

top ページトップ

Expand

title	AdministrationPerson

AdministrationPerson ElementAdministrationPerson要素	Data Typeデータ型	Description説明
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID methodYellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。
Password	String	Password of the Yellowfin userYellowfinユーザーのパスワード。
FirstName	String	First name of of the Yellowfin userYellowfinユーザーの名。
LastName	String	Last name of of the Yellowfin userYellowfinユーザーの姓。
Initial	String	Middle initial of the Yellowfin userYellowfinユーザーのミドルネームの頭文字。
SalutationCode	String	Title of the Yellowfin user. Possible values include:Yellowfinユーザーの敬称。可能な値は以下の通りです。 DR MISS MR MRS MS MRS MS
RoleCode	String	Yellowfinのロール。ここで指定するロールは、参照コード（YFADMIN）またはロール（Yellowfin管理者）の名前にすることができます。	RoleCode	String	Yellowfin role. The specified role here can be the Org Reference Code (YFADMIN) or the name of the role (Yellowfin Administrator)
EmailAddress	String	Email address of the Yellowfin userYellowfinユーザーの電子メールアドレス。
LanguageCode	String	Two letter code for the preferred language優先言語を表す2文字のコード。
IpId	Integer	Internal Yellowfin 内部Yellowfin IP IDID。
TimeZoneCode	String	The TimeZoneCode of the Yellowfin user.YellowfinユーザーのTimeZoneCode。

Expand

title	AdministrationReport

AdministrationReport ElementAdministrationReport要素	Data Typeデータ型
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 ElementAdministrationReportGroup要素	Data Typeデータ型	Description説明
ReportGroupName	String
ReportGroupDescription	String
ReportGroupId	Integer
ReportGroupStatus	String
ReportGroupType	String
ReportGroupInternalReference	String
GroupReports	Array (AdministrationReports)	Array（AdministrationReports）	レポートメタデータを保持するAdministrationReportオブジェクトの配列。これらは、ダッシュボードタブ内のポートレットを構成するレポートです。Array of AdministrationReport objects which hold report metadata. These are the reports that make up the portlets within the dashboard tab
AssociatedReports	Array (Integer)Array（Integer）

Expand

title	AdministrationRole

AdministrationReportGroup ElementAdministrationReportGroup要素	Data Typeデータ型	Description説明
RoleName	String	The name of the Yellowfin RoleYellowfinロールの名前
RoleDescription	String	The business description of the Yellowfin RoleYellowfinロールの説明
RoleCode	String	The internal code for the Yellowfin Role that is generated and referenced in the databaseデータベースで生成されて参照されるYellowfinロールの内部コード

Expand

title	AdministrationGroup

AdministrationGroup ElementAdministrationGroup要素	Data Typeデータ型	Description説明
GroupName	String
GroupDescription	String
GroupId	Integer
GroupStatus	String
GroupInternalReference	String
GroupMembers	Array (AdministrationGroupMember)	Array（AdministrationGroupMember）	AdministrationGroupMemberオブジェクトの配列。これらのオブジェクトにはグループメンバーのメタデータが保持されます。An array of AdministrationGroupMember objects. These objects hold group member metadata

Expand

title	AdministrationClientOrg

AdministrationClientOrg ElementAdministrationClientOrg要素	Data Typeデータ型	Description説明
ClientName	String	Name of the client organisationクライアント組織の名前
ClientReferenceID	String	Client Reference ID which is the unique ID used to identify a clientクライアントの識別に使用される固有のIDであるクライアント参照ID
TimeZoneCode	String	A client organisation’s local time zone code. See appendix for valid values.クライアント組織のローカルタイムゾーンコード有効な値については、付録を参照してください。
DefaultOrg	BooleanBoolean value that returns true if this organisation is the primary organisation	この組織がデフォルト組織である場合にtrueを返すブール値

Expand

title	ReportBinaryObject

ReportBinaryObject ElementReportBinaryObject要素	Data Typeデータ型	Description説明
Key	String	Unique key used for Binary Object storageバイナリーオブジェクトストレージに使用される固有キー
ContentType	String	MIME type for the Binary ObjectバイナリーオブジェクトのMIMEタイプ
Data	Array (Byte)	Array（Byte）	バイナリーオブジェクトのRAWデータRaw data for Binary Object

Expand

title	ContentResource

ContentResource ElementContentResource要素	Data Typeデータ型
ResourceName	String
ResourceDescription	String
ResourceId	Integer
ResourceUUID	Integer
ResourceType	String
ResourceOrgId	Integer
ResourceCode	String

Expand

title	ImportOption

ImportOption ElementImportOption要素	Data Typeデータ型	Description説明
ItemIndex	Integer	The index of the item that this option is attached too.このオプションが付加されたアイテムのインデックス
OptionKey	String	The type of option.オプションのタイプ
OptionValue	String	A value associated with this option.このオプションに関連付けられた値

horizontalrule

Styleclass

Class	topLink

top ページトップ

Content

Space Tools

Page History

Versions Compared

Old Version 7

New Version Current

Key

Redirecting to Yellowfin with the login token

ログイントークンを使用したYellowfinへのリダイレクト

Using the token with the JavaScript API

JavaScript APIでのトークンの使用

Specifying Session Options

セッションオプションの指定

ユーザーの複製および管理

Functions

関数

Retrieving & Validating User Information

ユーザー情報の取得およびテスト

Manipulating User Information

ユーザー情報の操作

ユーザーに属するオブジェクトの取得

グループ及びロールの管理

マルチテナント機能

オブジェクト定義