Page History

Versions Compared

Key

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

...

クライアント組織機能は、以下に示す使用可能なWebサービス呼び出しによって管理することができます。

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内で使用可能なすべてのクライアント組織を一覧表示します。

リクエスト要素	データ型	説明
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 = “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に指定されたクライアント組織を作成します。

リクエスト要素	データ型	説明	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 webservicesYellowfin Webサービスへの接続に使用されるアカウントのパスワード。
OrgId	Integer	Primary organisation ID within Yellowfin. Always set this to 1.	Yellowfin内のデフォルト組織ID。常に1に設定します。
Function = 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を返すブール値

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

応答要素

データ型

説明

Response Element

Data Type

Description

StatusCode

String

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

SUCCESS
FAILURE

Expand

title	DELETECLIENT

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

Code Block
AdministrationServiceRequest rsr =

The following code will call the Yellowfin web service and delete the specified client organisation within 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内の指定されたクライアント組織を更新します。

リクエスト要素	データ型	説明	Data Type
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 = “UPDATECLIENT”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

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

SUCCESS
FAILURE

Expand

title	LISTUSERSATCLIENT

title	LISTUSERSATCLIENT

以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織に属するすべてのユーザーを一覧表示します。The following code will call the Yellowfin web service and list all users belonging to the specified client organisation within 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 function
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:

Webサービス関数。
Client	AdministrationClientOrg	取得プロセスに関する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@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 = “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（AdministrationClientOrg）

AdministrationClientOrgオブジェクトの配列。各オブジェクトにはYellowfinクライアント組織のメタデータが保持されます。Array of AdministrationClientOrg objects. Each object holds Yellowfin client organisation metadata

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:

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.

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 = “ADDUSERACCESS”	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
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:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

...

Content

Space Tools

Versions Compared

Old Version 9

New Version 10

Key