Page History
| Anchor | ||||
|---|---|---|---|---|
|
| Table of Contents | ||
|---|---|---|
|
ユーザーの複製および管理
| Styleclass | ||
|---|---|---|
| ||
これにより、Yellowfinでは、ログインしているユーザーを識別し、必要となる制限がある場合はその制限を適用することができます。通常、同期はOEMアプリケーションからYellowfinへのWebサービス呼び出しを使用して行われます。これは、OEMアプリケーションのユーザーが概して静的である場合には、手動で管理することもできます。
このセクションでは、Webサービスを介したユーザーの作成、操作、および削除方法の概要について説明します。OEMアプリケーションでユーザーの変更が行われるとすぐに、Webサービスが呼び出されてユーザーの変更がミラーリングされることが想定されています。
関数
| Expand | ||
|---|---|---|
| ||
以下のコードは、ユーザーを作成するためのYellowfin Webサービスを呼び出します。
|
...
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、ユーザー作成プロセスが失敗した理由を説明するエラーメッセージを返します。この関数はYellowfinにユーザーを作成します。AdministrationPersonオブジェクト内の詳細がユーザー作成プロセスで使用されます。 |
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
The AdministrationPerson object holding all of the new user's details for the user creation process
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
|
These are the parameters that you need to set in the AdministrationPerson object:
...
AdministrationPerson Element
...
Data Type
...
|
...
|
...
|
...
|
...
|
...
Middle name of the new user
|
...
|
...
|
...
Email address of the new user
返される応答には、以下のパラメーターが含まれます。
|
The response returned will contain these parameters:
...
Response Element
...
Data Type
...
|
...
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、ユーザーを削除するためのYellowfin Webサービスを呼び出します。
|
...
|
...
このコードはrs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、ユーザー削除プロセスが失敗した理由を説明するエラーメッセージを返します。
|
...
Request Element
...
Data Type
...
Description
...
LoginId
...
String
...
|
...
|
...
|
...
|
...
The AdministrationPerson object holding all of the user's details for the user creation process
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
ユーザー情報の取得およびテスト
作成されたユーザーの詳細は、Webサービス呼び出しを使用して取得することができます。AdministrationPersonオブジェクトのUserIdフィールドは、ユーザーを識別するために使用されます。結果として、投入されたAdministrationPersonオブジェクトが返されます。セキュリティ上の理由から、パスワードは返されず、NULLとなります。また、このセクションでは、ユーザー情報をアプリケーションに照らし合わせてテストすることもできます。
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
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 | ||
|---|---|---|
|
The following code will call the Yellowfin web service to retrieve a user's details:
以下のコードは、ユーザーの詳細を取得するためのYellowfin Webサービスを呼び出します。
|
...
|
...
このコードはユーザー詳細を含むAdministrationPersonオブジェクトを返し、rs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。
|
...
Request Element
...
Data Type
...
|
...
|
...
|
...
|
...
|
...
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
...
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
|
...
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、内部IpIdを介してユーザーの詳細を取得するためのYellowfin Webサービスを呼び出します。
|
...
|
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.
...
Request Element
...
Data Type
このコードはユーザー詳細を含むAdministrationPersonオブジェクトを返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。
|
...
|
...
|
...
|
...
|
...
|
...
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
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
|
|
...
IP ID of the Yellowfin User
返される応答には、以下のパラメーターが含まれます。
|
The response returned will contain these parameters:
...
Response Element
...
Data Type
...
|
...
|
...
|
| Expand | ||
|---|---|---|
|
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.
この関数は、特定の検索文字列に基づいて、Yellowfinからユーザーを取得します。この文字列がユーザーの名、姓、および電子メールアドレスと比較されます。
|
...
Request Element
...
Data Type
...
|
...
|
...
|
...
Primary organisation ID within Yellowfin. Always set this to 1.
|
...
|
...
|
...
Search string to match against Yellowfin users' first names, last names, and email address
The response returned will contain these parameters:
返される応答には、以下のパラメーターが含まれます。
|
...
Response Element
...
Data Type
...
|
...
|
...
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、ユーザーをテストするためのYellowfin Webサービスを呼び出します。
|
...
|
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.
...
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
このコードは、成功すると特定ユーザーのAdministrationPersonオブジェクトを返します。それ以外の場合は、ユーザー検証プロセスが失敗した理由を説明するエラーメッセージを返します。
|
...
OrgId
...
Integer
...
|
...
|
...
The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
|
These are the parameters that you need to set in the AdministrationPerson object:
...
AdministrationPerson Element
...
Data Type
...
|
...
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
...
返される応答には、以下のパラメーターが含まれます。
|
|
...
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、ユーザーのパスワードをテストするためのYellowfin Webサービスを呼び出します。
|
...
|
...
このコードは、パスワードの有効期限が切れているかどうかをチェックし、有効期限が切れていない場合にはrs.getStatusCode() |
...
でFAILUREを返します。それ以外の場合は、SUCCESSを返します。
|
...
Request Element
...
Data Type
...
Description
...
LoginId
...
String
...
|
...
|
...
|
...
|
...
The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
|
These are the parameters that you need to set in the AdministrationPerson object:
...
AdministrationPerson Element
...
Data Type
...
|
...
|
...
The response returned will contain these parameters:
...
Response Element
...
Data Type
...
Description
返される応答には、以下のパラメーターが含まれます。
|
...
|
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 | ||
|---|---|---|
|
...
以下のコードは、ユーザーの詳細を編集するためのYellowfin Webサービスを呼び出します。
|
...
|
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.
このコードはユーザー詳細を含むAdministrationPersonオブジェクトを返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。
|
...
Request Element
...
Data Type
...
|
...
|
...
|
...
|
...
|
...
|
...
The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process
AdministrationPersonオブジェクトで設定できるパラメーターは、以下の通りです。
|
These are the parameters that you can set in the AdministrationPerson object:
...
AdministrationPerson Element
...
Data Type
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
The TimeZoneCode of the Yellowfin user. See appendix for valid values.
...
T
he response returned will contain these parameters:
返される応答には、以下のパラメーターが含まれます。
|
...
Response Element
...
Data Type
...
Description
...
StatusCode
...
String
...
|
...
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、指定されたYellowfinユーザーのパスワードを変更します。
|
...
|
...
このコードはrs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
ユーザーに属するオブジェクトの取得
| Styleclass | ||
|---|---|---|
| ||
Retrieving Objects Belonging to a User
| Styleclass | ||
|---|---|---|
| ||
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.
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なWebサービス名を含むすべてのレポートを返します。
|
...
|
...
このコードは、rs.getReports() |
...
でAdministrationReportオブジェクトの配列を返し、rs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。
|
...
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
...
| title | GETALLUSERREPORTS |
|---|
The following code will call the Yellowfin web service and return all reports that are accessible for the particular user:
...
| Expand | ||
|---|---|---|
| ||
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なすべてのレポートを返します。
|
...
|
...
このコードは、rs.getReports() |
...
でAdministrationReportオブジェクトの配列を返し、rs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。
|
...
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
The following code will call the Yellowfin web service and return all commented reports that are accessible for the particular user:
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なすべてのコメントされたレポートを返します。
|
...
|
...
このコードは、rs.getReports() |
...
でAdministrationReportオブジェクトの配列を返し、rs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。
|
...
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なすべてのレポートのお気に入りを返します。
|
...
|
...
このコードは、rs.getReports() |
...
でAdministrationReportオブジェクトの配列を返し、rs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。
|
...
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
...
| title | GETINBOX |
|---|
The following code will call the Yellowfin web service and return all reports that are in the particular user's inbox:
...
| Expand | ||
|---|---|---|
| ||
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーの受信トレイ内にあるすべてのレポートを返します。
|
...
|
...
このコードは、rs.getReports() |
...
でAdministrationReportオブジェクトの配列を返し、rs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーメッセージを返します。
|
...
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なレポートを含まないすべてのダッシュボードタブを返します。
|
...
|
...
このコードは、rs.getReportGroups() |
...
でAdministrationReportGroupオブジェクトの配列を返し、rs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。|
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なレポートを含むすべてのダッシュボードタブを返します。
|
...
|
...
このコードは、rs.getReportGroups() |
...
でAdministrationReportGroupオブジェクトの配列を返し、rs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||
この関数は、指定されたダッシュボードタブ内に含まれるレポートの一覧を返します。このレポートには、Yellowfinの指定されたユーザーがアクセスすることができます。
AdministrationPersonおよびAdministrationReportGroupオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
グループおよびロールの管理
| Expand | ||
|---|---|---|
| ||
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.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 = "LOADTABREPORTS" | String | Web services function || Person | AdministrationPerson | The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process || 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:|| 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 ||| AdministrationReportGroup Element || Data Type || Description || ReportGroupId | String | 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:* 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. | |
...
| Styleclass | ||
|---|---|---|
|
...
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.
...
注意: if クライアント組織 機能を システム構成 ページでオンにしている場合、特定のタイプの呼び出しについて適用可能な場合はクライアント組織を指定することもできます。
...
| Expand | |
|---|---|
|
| |
The following code will call the Yellowfin web service and return all available roles within Yellowfin:
|
...
|
...
このコードは、rs.getGroups()でAdministrationGroupオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下コードは、Yellowfin Webサービスを呼び出し、Yellowfin内で使用可能なすべてのグループを返します。
|
...
|
...
このコードは、rs.getGroups() |
...
でAdministrationGroupオブジェクトの配列を返し、rs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループおよびそのメンバーを返します。
|
...
|
...
このコードは、rs.getGroup() |
...
でAdministrationGroupオブジェクトを返し、rs.getGroupMembers() |
...
でAdministrationGroupMembersの配列を返し、rs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
AdministrationGroupオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。|
|
| Expand | ||
|---|---|---|
| ||
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinに指定されたグループを作成します。 |
...
|
...
...
|
...
このコードはrs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 注意: AdministrationPersonオブジェクトのAdministrationGroupMember配列を投入することによって、新規作成されたグループに既存のYellowfinユーザーを同時に配置することもできます。各AdministrationPersonオブジェクトに必要なのはLoginId変数セットのみであり、AdministrationGroupMember配列はgroup.setGroupMembers()に保存されます。
AdministrationGroupオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
...
| title | INCLUDEUSERINGROUP |
|---|
The following code will call the Yellowfin web service and include a specified user into a specified group in Yellowfin:
...
| Expand | ||
|---|---|---|
| ||
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループに指定されたユーザーを含めます。
|
...
|
...
このコードはrs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
AdministrationGroupおよびAdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
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
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループから指定されたユーザーを除外します。 注意: このユーザーはグループから削除されるのではなく、グループ定義から除外されるだけです。これが役立つのは、たとえば以下のような場合です。* John DoeはグループAのメンバーである* グループAはグループBのメンバーである* John DoeはグループBのメンバーであってはならないため、グループBから除外する必要がある
|
...
|
...
このコードはrs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
|
...
|
...
|
...
|
...
| title | DELETEUSERFROMGROUP |
|---|
The following code will call the Yellowfin web service and delete a specified user from a specified group in Yellowfin:
...
| Expand | ||
|---|---|---|
| ||
The 以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループから指定されたユーザーを削除します。
|
...
|
...
このコードはrs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
AdministrationGroupおよびAdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
| ||
The |
...
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループを変更します。
|
...
|
...
このコードはrs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 注意: AdministrationPersonオブジェクトのAdministrationGroupMember配列を投入することによって、変更されたこのグループに既存のYellowfinユーザーを同時に配置することもできます。各AdministrationPersonオブジェクトに必要なのはLoginId変数セットのみであり、AdministrationGroupMember配列はgroup.setGroupMembers()に保存されます。
AdministrationGroupオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
...
| title | DELETEGROUP |
|---|
The following code will call the Yellowfin web service and delete the specified group in Yellowfin:
...
| Expand | ||
|---|---|---|
| ||
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループを削除します。
|
...
|
...
このコードはrs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
AdministrationGroupオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
マルチテナント機能
...
| Styleclass | ||
|---|---|---|
|
...
クライアント組織機能は、以下に示す使用可能なWebサービス呼び出しによって管理することができます。
Yellowfin contains functionality called クライアント組織, which allows multiple virtual instances of Yellowfin to reside in the same server instance.
Client Organisation functionality can be managed with the available web service calls listed below.
| Expand | ||
|---|---|---|
|
The following code will call the Yellowfin web service and list all client organisations within Yellowfin:
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内のすべてのクライアント組織を一覧表示します。
|
...
|
...
このコードは、AdministrationClientOrgオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
|
...
Web services function | |
...
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下コードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織を取得します。
|
...
|
...
このコードは、rs.getClient() |
...
でAdministrationClientOrgオブジェクトを返し、rs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
AdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内に指定されたクライアント組織を作成します。
|
...
|
...
このコードはrs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
AdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織を削除します。
|
...
|
...
このコードはrs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
AdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織を更新します。
|
...
|
...
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
AdministrationClientOrgオブジェクトで設定できるパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
...
| title | LISTUSERSATCLIENT |
|---|
The following code will call the Yellowfin web service and list all users belonging to the specified client organisation within Yellowfin:
...
| Expand | ||
|---|---|---|
| ||
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたクライアント組織に属するすべてのユーザーを一覧表示します。
|
...
|
...
このコードは、rs.getPeople() |
...
でAdministrationPersonオブジェクトの配列を返し、rs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
AdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたユーザーがアクセス可能なすべてのクライアント組織を一覧表示します。
|
...
The code will return an Array of AdministrationClientOrg objects in |
...
These are the parameters that you need to set in the AdministrationClientOrg object: |
...
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
| ||
The following code will call the Yellowfin web service and add access to a specified client organisation for a specified user within Yellowfin:
|
...
| 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:
...
|
...
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
AdministrationPersonおよびAdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
...
| 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:
...
| Expand | ||
|---|---|---|
| ||
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定されたユーザーに対して指定されたクライアント組織へのアクセス権を削除します。
|
|
...
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
|
...
|
...
AdministrationPersonおよびAdministrationClientOrgオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
この関数は、指定されたレポートがYellowfinの指定されたユーザーのお気に入り一覧に存在するかどうかをチェックします。
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。|
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、指定されたレポートを指定されたユーザーのお気に入り一覧に追加します。
|
...
|
...
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。|
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
| ||
The following code will call the Yellowfin web service and remove a specified report to a specified user's favourites list:
|
...
|
...
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
| Expand | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
この関数は、Yellowfin内の指定されたユーザーのすべてのアバターイメージを返します。
返される応答には、以下のパラメーターが含まれます。|
|
| Expand | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||
この関数は、Yellowfin内の指定されたユーザーのプロファイルのアバターイメージを設定します。
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
この関数は、Yellowfin内の指定された参照コードを再読み込みします。
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
| ||
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.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 = "GETAVATARS" | String Web services function || Parameters | Array (String) | The Unique IDs of Yellowfin users |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 || BinaryAttachments | Array (ReportBinaryObject) | Array of ReportBinary objects holding the Base64 decoded avatar images | |
| Expand | ||
|---|---|---|
| ||
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@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 = "SETAVATARIMAGE" | 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 || Parameters | Array (Bytes) | Base64 encoded avatar image |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 || IpId | Integer | Unique IP ID of the Yellowfin user |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 | |
| Expand | ||
|---|---|---|
| ||
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@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 = "RELOADCODES" | String | Web services function || Parameters | Array (String) | The list of Org Reference Codes |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 | |
...
| title | GEOMETRYFLUSH |
|---|
The following code will call the Yellowfin web service and clear the geometry cache in Yellowfin:
...
| Expand | ||
|---|---|---|
| ||
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのジオメトリキャッシュをクリアします。
|
...
|
...
このコードはrs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのビューのキャッシュを削除します。
|
...
|
...
このコードはrs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinにおけるレポートのキャッシュされた定義を削除します。
|
...
|
...
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinにおけるダッシュボードのキャッシュされた定義を削除します。
|
...
|
...
このコードはrs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのレポートを削除します。
|
...
|
...
このコードはrs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
|
...
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのビューを削除します。
|
...
|
...
このコードはrs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します
|
...
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのデータソースを削除します。
|
...
|
...
このコードはrs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのダッシュボードタブを削除します。
|
...
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのダッシュボードタブを削除します。
|
...
|
...
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinでライセンス定義を再読み込みします。
|
...
|
...
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたデータソースの接続プールを閉じます。
|
...
|
...
このコードはrs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたフィルターのフィルターキャッシュをフラッシュします。
|
...
|
...
このコードはrs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
返される応答には、以下のパラメーターが含まれます。
|
...
| title | APPROVEREPORT |
|---|
The following code will call the Yellowfin web service and approve a report in Yellowfin via the expert approval process:
...
| Expand | ||
|---|---|---|
| ||
以下のコードは、Yellowfin Webサービスを呼び出し、エキスパートの承認プロセスを介してYellowfinのレポートを承認します。
|
...
|
...
このコードはrs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内でエクスポート可能なすべてのコンテンツを取得します。
|
...
|
...
このコードは、rs.getContentResources() |
...
でContentResourceオブジェクトの配列を返し、rs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
返される応答には、以下のパラメーターが含まれます。
|
...
| title | GETEXPORTDEPENDENCIES |
|---|
The following code will call the Yellowfin web service and obtain dependencies for a specific Yellowfin artifact:
...
| Expand | ||
|---|---|---|
| ||
以下のコードは、Yellowfin Webサービスを呼び出し、特定のYellowfin成果物についての従属関係を取得します。
|
...
|
...
このコードは、rs.getContentResources() |
...
でContentResourceオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
ContentResourceオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
...
| title | EXPORTCONTENT |
|---|
The following code will call the Yellowfin web service and export the specified artifacts within Yellowfin:
...
| Expand | ||
|---|---|---|
| ||
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfin内の指定された成果物をエクスポートします。
|
...
|
...
このコードは、rs.getBinaryAttachments() |
...
でReportBinaryObjectsオブジェクトの配列を返し、rs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
|
...
|
...
ContentResourceオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
| Expand | ||
|---|---|---|
|
...
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのインポートファイルを読み取り、インポートするオブジェクトを返します。
|
...
|
...
このコードは、rs.getContentResources() |
...
でContentResourceオブジェクトの配列を返し、rs.getStatusCode() |
...
でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
返される応答には、以下のパラメーターが含まれます。
|
...
| title | TESTIMPORTCONTENT |
|---|
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:
...
| Expand | ||
|---|---|---|
| ||
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinのインポートオブジェクトをテストします。通常、この関数はGETIMPORTCONTENT Webサービス呼び出しのあとに実行します。
|
...
|
...
このコードは、インポートファイルに問題がある場合にはrs.getImportIssues() |
...
でImportIssueオブジェクトの配列を返し、rs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
返される応答には、以下のパラメーターが含まれます。
|
...
| title | IMPORTCONTENT |
|---|
The following code will call the Yellowfin web service and import the specified Yellowfin import objects into the application:
...
| Expand | ||
|---|---|---|
| ||
ImportIssueオブジェクトの配列。これらのオブジェクトには、検証プロセスから返されたエラーメッセージが含まれます。
|
|
The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.Refer to ws_admin_import.jsp in your Yellowfin web services directory Yellowfindevelopmentexamplesweb services for a more detailed example of how this function would work.|| 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 = "IMPORTCONTENT" | String | Web services function || Parameters | Array (String) | 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:|| Response Element || Data Type || Description ||| StatusCode | String | Status of the web service call. Possible values include:* SUCCESS* FAILURE |
...
このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。
返される応答には、以下のパラメーターが含まれます。
|
オブジェクト定義
| Styleclass | ||
|---|---|---|
|
...
| Expand | ||
|---|---|---|
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
| Expand | ||
|---|---|---|
| ||
|
...
|
| Expand | ||
|---|---|---|
| ||
|
...
|
...
|
...
|
| Expand | ||
|---|---|---|
| ||
|
...
|
...
|
...
|
...
The business description of the Yellowfin Role
...
RoleCode
...
String
...
|
| Expand | ||
|---|---|---|
| ||
|
...
|
...
|
...
|
| Expand | ||
|---|---|---|
| ||
|
...
|
...
|
...
|
...
|
...
|
...
|
| Expand | ||
|---|---|---|
| ||
|
...
|
...
|
...
|
...
|
...
|
| Expand | ||
|---|---|---|
| ||
|
...
|
| Expand | ||
|---|---|---|
| ||
|
...
|
...
|
...
|
...
|
...
|
| horizontalrule |
|---|
| Styleclass | ||
|---|---|---|
| ||