Page History

Versions Compared

Key

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

...

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

The SSO token can also be used with embedded JavaScript API widgets. The token is added to the scriptlet URL like this:

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

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

JavaScript APIでのトークンの使用

埋め込みJavaScript APIウィジェットでSSO（シングルサインオン）トークンを使用することもできます。トークンは、次のようにスクリプトレットURLに追加されます：

<script type="text<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.

script>

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

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

パラメーターは、以下のようにキー値ペアのリストとしてAdministrationRequest.Parameters属性に追加されます：Parameters are added to the AdministrationRequest.Parameters attribute as a list of key value pairs, like:

YFTOOLBAR=TRUE

ENTRY=DASHBOARD

Options passed on the login URL look like:

ログインURLで渡されるオプションは次のようになります：

http: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	reasoncodeCustom	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.このセッションで生成されるすべてのイベントに記録されるカスタム文字列（80文字のASCII文字）。イベントは、Yellowfinデータベースのイベントテーブルに記録されます。このオプションは、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.		このセッションで生成されるすべてのイベントに記録されるカスタム文字列（2048文字のASCII文字）。イベントは、Yellowfinデータベースのイベントテーブルに記録されます。このオプションは、JavaScript APIで使用することもできます。
DASHBOARDID	dashboardid	`ENTRY = EDITDASHBOARD`または`VIEWDASHBOARD`とともに使用します。これは、リダイレクト先ダッシュボードタブの内部IDです。	DASHBOARDID	dashboardid	Used with `ENTRY = EDITDASHBOARD` or `VIEWDASHBOARD`. This is the internal id of the dashboard tab to redirect to.
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:とともに使用します。指定されたレポートのフィルター値を上書きします。FILTERにはフィルターの内部IDを付加し、その後にフィルター値の文字列表現が続きます。例： `FILTER2134=MALE` You can pass multiple filters for the one report.1つのレポートで複数のフィルターを渡すことができます。
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.		このセッションのこのユーザーのソースフィルター値を上書きします。 `SOURCEFILTER_`には「ソースフィルター」設定ページの「フィルタータイプコード」を付加し、その後にアクセスできるようにする値を続けます。例： `SOURCEFILTER_COUNTRY=AU` 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.

User Replication and Managment

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.

...

が発生します。

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

Styleclass

Class	topLink

ページトップ

ユーザーの複製では、OEMアプリケーション内の各ユーザーとYellowfin内の名前付きユーザーが同期されます。

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

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

関数

Expand

title	ADDUSER

The following code will call the Yellowfin web service to create a user:以下のコードは、ユーザーを作成するためのYellowfin Webサービスを呼び出します。

Code Block

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

person.setUserId("test@yellowfin.com.au");
person.setPassword("test");
person.setFirstName("Simple");
person.setLastName("Simon");
person.setInitial("S");
person.setSalutationCode("MR");
person.setRoleCode("YFADMIN");
person.setEmailAddress("test@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("ADDUSER");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

if ("SUCCESS".equals(rs.getStatusCode()) ) {
				
out.write("Success");
				
} else {
			
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
				
}

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	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 = “ADDUSER”		Web services function
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:

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

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

AdministrationPerson要素	データ型	説明
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	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:

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

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

応答要素

データ型

説明

StatusCode

String

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

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

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”		Web services function
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

“DELUSER”または“DELETEUSER”		Webサービス関数。
Person	AdministrationPerson	ユーザー削除プロセスに関するユーザーの詳細すべてを保持する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または電子メールアドレスにすることができます。

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

応答要素

データ型

説明

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	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 code will return an AdministrationPerson object with the user’s details and SUCCESS in the 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 by looking up their IP ID. The details in the AdministrationPerson object will be used in the retrieval process.

このコードはユーザー詳細を含むAdministrationPersonオブジェクトを返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。

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

リクエスト要素	データ型	説明
LoginId	String	Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。
Password	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Yellowfin内のデフォルト組織ID。常に1に設定します。
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）

AdministrationPersonオブジェクトの配列。これらのオブジェクトには、検索文字列に一致した、返されたユーザーの詳細が保持されます。

People

Array (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オブジェクト内の詳細がユーザー検証プロセスで使用されます。

リクエスト要素	データ型	説明
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:

AdministrationPerson

取得プロセスに関する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.

rsr);

このコードは、パスワードの有効期限が切れているかどうかをチェックし、有効期限が切れていない場合にはrs.getStatusCode()でFAILUREを返します。それ以外の場合は、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 = “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 methodYellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。
Password	String	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

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 code will return an AdministrationPerson object with the user’s details and SUCCESS in the rs.getStatusCode(), otherwise it will return an error message explaining why the process failed.

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

この関数は指定された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	Yellowfinユーザーの名。First name of of the Yellowfin user
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@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 = “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.この関数を特定のクライアント組織に適用する場合には、クライアント参照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	GETALLUSERREPORTS

The following code will call the Yellowfin web service and return all 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("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@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 = “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	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 code will return an Array of AdministrationReport objects in このコードは、rs.getReports() and SUCCESS in rs.getStatusCode(), otherwise it will return an error message explaining why the process failed.

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

でAdministrationReportオブジェクトの配列を返し、rs.getStatusCode()で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:

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を保持する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	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ユーザーのすべてのお気に入りのレポートを返します。

リクエスト要素	データ型	説明	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	String	Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。Password of the account used to connect to Yellowfin webservices
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:

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 code will return an Array of AdministrationReport objects in rs.getReports() and SUCCESS in rs.getStatusCode(), otherwise it will return an error message explaining why the process failed.

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

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 = “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.
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:

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.

...

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.

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.

...

Styleclass

Class	topLink

top

Yellowfin contains functionality called Client Organisations クライアント組織, which allows multiple virtual instances of Yellowfin to reside in the same server instance.

...

Content

Space Tools

Versions Compared

Old Version 7

New Version 8

Key

Redirecting to Yellowfin with the login token

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

Using the token with the JavaScript API

JavaScript APIでのトークンの使用

Specifying Session Options

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

User Replication and Managment

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

関数

Retrieving & Validating User Information

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

Manipulating User Information

ユーザー情報の操作

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