このサービスは、Yellowfinに接続し、指定されたユーザーのログオントークンを取得します。このトークンがYellowfinログオンURLに渡されると、認証されるユーザーのログイン画面が無効化され、そのユーザーのセッションがただちに開始されます。
LOGINUSER関数は、指定されたユーザーをYellowfinにシングルサインオンさせます。AdministrationPersonオブジェクトの内容は、ログインしているユーザーを定義するために使用されます。
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
ログイントークンを使用したYellowfinへのリダイレクトWebサービス呼び出しから受信したトークン(AdministrationResponse.LoginSessionIdの内容)を使用して、ユーザーを以下のURLに転送できます:
このURLを使用することにより、Yellowfinの認証画面がバイパスされ、ユーザーはYellowfinに直接移動します。 トークンには有効期限があります。5分以内に使用する必要があり、いったん使用すると再利用はできません。その後、サードパーティのアプリケーションからYellowfinに呼び出しを行うときは、LOGINUSER Webサービスを再度呼び出す必要があります。 JavaScript APIでのトークンの使用埋め込みJavaScript APIウィジェットでSSO(シングルサインオン)トークンを使用することもできます。トークンは、次のようにスクリプトレットURLに追加されます:
セッションオプションの指定このシングルサインオンリクエストを介して作成されるセッションに対してのみ機能を切り替える変数/スイッチを渡すことができます。このようなオプションを有効にするには、AdministrationRequestでParameters属性を使用して渡すか、またはリダイレクトURLに付加します。 パラメーターは、以下のようにキー値ペアのリストとしてAdministrationRequest.Parameters属性に追加されます:
ログインURLで渡されるオプションは次のようになります:
使用可能なオプションの一覧を以下に示します:
|
このサービスは、 オプションは
この機能を有効にするには、Yellowfinデータベースの設定テーブルに追加のパラメーターを追加する必要があります:
データベースの変更を有効にするために、Yellowfinの再起動が必要になることがあります。 この設定オプションがYellowfinに追加されていない場合は、Webサービスエラー |
これにより、Yellowfinでは、ログインしているユーザーを識別し、必要となる制限がある場合はその制限を適用することができます。通常、同期はOEMアプリケーションからYellowfinへのWebサービス呼び出しを使用して行われます。これは、OEMアプリケーションのユーザーが概して静的である場合には、手動で管理することもできます。
このセクションでは、Webサービスを介したユーザーの作成、操作、および削除方法の概要について説明します。OEMアプリケーションでユーザーの変更が行われるとすぐに、Webサービスが呼び出されてユーザーの変更がミラーリングされることが想定されています。
以下のコードは、ユーザーを作成するためのYellowfin Webサービスを呼び出します。
このコードは この関数はYellowfinにユーザーを作成します。AdministrationPersonオブジェクト内の詳細がユーザー作成プロセスで使用されます。
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
以下のコードは、ユーザーを削除するためのYellowfin Webサービスを呼び出します。
このコードは この関数はYellowfinからユーザーを削除します。AdministrationPersonオブジェクト内の詳細がユーザー削除プロセスで使用されます。
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
作成されたユーザーの詳細は、Webサービス呼び出しを使用して取得することができます。AdministrationPersonオブジェクトのUserIdフィールドは、ユーザーを識別するために使用されます。結果として、投入されたAdministrationPersonオブジェクトが返されます。セキュリティ上の理由から、パスワードは返されず、NULL
となります。また、このセクションでは、ユーザー情報をアプリケーションに照らし合わせてテストすることもできます。
以下のコードは、ユーザーの詳細を取得するためのYellowfin Webサービスを呼び出します。
このコードはユーザー詳細を含むAdministrationPersonオブジェクトを返し、 この関数はYellowfinの特定ユーザーの詳細を取得します。AdministrationPersonオブジェクト内の詳細が取得プロセスで使用されます。
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
以下のコードは、内部IpIdを介してユーザーの詳細を取得するためのYellowfin Webサービスを呼び出します。
このコードはユーザー詳細を含むAdministrationPersonオブジェクトを返し、 この関数はYellowfinの特定ユーザーのIP IDを検索し、そのユーザーの詳細を取得します。AdministrationPersonオブジェクト内の詳細が取得プロセスで使用されます。
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
IP ID|Integer|YellowfinユーザーのIP ID| 返される応答には、以下のパラメーターが含まれます。
|
この関数は、特定の検索文字列に基づいて、Yellowfinからユーザーを取得します。この文字列がユーザーの名、姓、および電子メールアドレスと比較されます。
返される応答には、以下のパラメーターが含まれます。
|
以下のコードは、ユーザーをテストするためのYellowfin Webサービスを呼び出します。
このコードは、成功すると特定ユーザーのAdministrationPersonオブジェクトを返します。それ以外の場合は、ユーザー検証プロセスが失敗した理由を説明するエラーメッセージを返します。 この関数は、指定されたYellowfinユーザーがアプリケーション内に現在存在するかどうかをチェックしてテストします。AdministrationPersonオブジェクト内の詳細がユーザー検証プロセスで使用されます。
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
以下のコードは、ユーザーのパスワードをテストするためのYellowfin Webサービスを呼び出します。
このコードは、パスワードの有効期限が切れているかどうかをチェックし、有効期限が切れていない場合には この関数はYellowfinユーザーのパスワードをテストします。AdministrationPersonオブジェクト内の詳細がパスワード検証プロセスで使用されます。
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
ユーザーの詳細は、Webサービス呼び出しを使用してあとから変更することができます。AdministrationPersonオブジェクトのUserIdフィールドは、ユーザーを識別するために使用されるため、変更することができません。AdministrationPersonオブジェクト内のその他のフィールドには、新しい変更内容が投入されます。セキュリティ上の理由から、このWebサービス呼び出しを使用してユーザーのパスワードを変更することはできませんが、個別のCHANGEPASSWORD関数(下記)を使用して変更することができます。
以下のコードは、ユーザーの詳細を編集するためのYellowfin Webサービスを呼び出します。
このコードはユーザー詳細を含むAdministrationPersonオブジェクトを返し、 この関数は指定されたYellowfinユーザーの詳細を更新します。AdministrationPersonオブジェクト内の詳細が更新プロセスで使用されます。
AdministrationPersonオブジェクトで設定できるパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
以下のコードは、Yellowfin Webサービスを呼び出し、指定されたYellowfinユーザーのパスワードを変更します。
このコードは この関数は指定されたYellowfinユーザーのパスワードを変更します。
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なWebサービス名を含むすべてのレポートを返します。
このコードは、 この関数は、指定されたYellowfinユーザーがアクセス可能なWebサービス名を含むすべてのレポートを返します。
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なすべてのレポートを返します。
このコードは、
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです
返される応答には、以下のパラメーターが含まれます。
|
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なすべてのコメントされたレポートを返します。
このコードは、 この関数は、指定されたYellowfinユーザーがアクセス可能なYellowfin内のコメントされたすべてのレポートを返します。
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
以下のコードは、Yellowfin Webサービスを呼び出し、特定ユーザーがアクセス可能なすべてのレポートのお気に入りを返します。
このコードは、 この関数は、指定されたYellowfinユーザーのすべてのお気に入りのレポートを返します。
AdministrationPersonオブジェクトで設定が必要なパラメーターは、以下の通りです。
返される応答には、以下のパラメーターが含まれます。
|
The following code will call the Yellowfin web service and return all reports that are in the particular user’s inbox:
This code will return an Array of AdministrationReport objects in This function will return the reports that are in the inbox of a specified Yellowfin user.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and return all dashboard tabs without reports that are accessible for that particular user:
This code will return an Array of AdministrationReportGroup objects in This function will return a list of dashboard tabs that are accessible by the specified Yellowfin user.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and return all dashboard tabs with reports that are accessible for that particular user:
This code will return an Array of AdministrationReportGroup objects in This function will return a list of dashboard tabs that are accessible by the specified Yellowfin user, with the reports’ metadata loaded as well. The metadata for every report in the dashboard tab is contained within the AdministrationReportGroup object.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
This function will return a list of reports contained within a specified dashboard tab, that is accessible by a specified user in Yellowfin.
These are the parameters that you need to set in the AdministrationPerson and AdministrationReportGroup object:
The response returned will contain these parameters:
|
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.
The following code will call the Yellowfin web service and return all available roles within Yellowfin:
The code will return an Array of AdministrationRole objects in This function will return all the available roles within Yellowfin.
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and return all available groups within Yellowfin:
The code will return an Array of AdministrationGroup objects in This function will return all the available user groups within Yellowfin.
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and return the specified group with its members in Yellowfin:
The code will return an AdministrationGroup object in This function will return a specified Yellowfin group with a list of its members.
These are the parameters that you need to set in the AdministrationGroup object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and create the specified group in Yellowfin:
The code will return Note: you can also put existing Yellowfin users into this newly created group at the same time by populating an AdministrationGroupMember array of AdministrationPerson objects. Each AdministrationPerson object only needs the This function will create a Yellowfin group. Note that you are able to save existing Yellowfin users into the new group in this function as well.
These are the parameters that you need to set in the AdministrationGroup object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and include a specified user into a specified group in Yellowfin:
The code will return This function will include a specified Yellowfin user into a specified group.
These are the parameters that you need to set in the AdministrationGroup and AdministrationPerson objects:
The response returned will contain these parameters:
|
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:
The code will return This function will exclude a specified Yellowfin user from a specified group. Note that this user is not deleted from the group but merely excluded from the group definition. An example of why this would be useful is when:
These are the parameters that you need to set in the AdministrationGroup and AdministrationPerson objects:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and delete a specified user from a specified group in Yellowfin:
The code will return This function will delete a specified Yellowfin user from a specified group. Note that this scenario is different from the one in EXCLUDEUSERINGROUP – in this function a user will be permanently removed from the group.
These are the parameters that you need to set in the AdministrationGroup and AdministrationPerson objects:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and modify the specified group in Yellowfin:
The code will return Note: you can also put existing Yellowfin users into this modified group at the same time by populating an AdministrationGroupMember array of AdministrationPerson objects. Each AdministrationPerson object only needs the This function will modify the details for a specified group in Yellowfin. Note that you are able to save existing Yellowfin users into the new group in this function as well.
These are the parameters that you need to set in the AdministrationGroup object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and delete the specified group in Yellowfin:
The code will return This function will delete a specified group from Yellowfin.
These are the parameters that you need to set in the AdministrationGroup object:
The response returned will contain these parameters:
|
Client Organisation functionality can be managed with the available web service calls listed below.
The following code will call the Yellowfin web service and list all client organisations within Yellowfin:
The code will return an Array of AdministrationClientOrg objects and This function will list all client organisations available within Yellowfin.
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and get the specified client organisation within Yellowfin:
The code will return an AdministrationClientOrg object in This function will retrieve details for a specified client organisation within Yellowfin.
These are the parameters that you need to set in the AdministrationClientOrg object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and create the specified client organisation within Yellowfin:
The code will return The function will create the specified client organisation in Yellowfin.
These are the parameters that you need to set in the AdministrationClientOrg object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and delete the specified client organisation within Yellowfin:
The code will return This function will delete the specified client organisation in Yellowfin.
These are the parameters that you need to set in the AdministrationClientOrg object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and update the specified client organisation within Yellowfin:
The code will return The following code will call the Yellowfin webservice and update the specified client organisation within Yellowfin.
These are the parameters that you can set in the AdministrationClientOrg object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and list all users belonging to the specified client organisation within Yellowfin:
The code will return an Array of AdministrationPerson objects in This function will list all Yellowfin users belonging to the specified client organisation in Yellowfin.
These are the parameters that you need to set in the AdministrationClientOrg object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and list all client organisations accessible by a specified user within Yellowfin:
The code will return an Array of AdministrationClientOrg objects in
These are the parameters that you need to set in the AdministrationClientOrg object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and add access to a specified client organisation for a specified user within Yellowfin:
The code will return This function will add access to a specified client organisation for a specified user win Yellowfin.
These are the parameters that you need to set in the AdministrationPerson and AdministrationClientOrg objects:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and remove access to a specified client organisation for a specified user within Yellowfin:
The code will return This function will remove access to a specified client organisation for a specified user in Yellowfin.
These are the parameters that you need to set in the AdministrationPerson and AdministrationClientOrg objects:
The response returned will contain these parameters:
|
This function will check if a specified report is in a specified user’s favourites list in Yellowfin.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and add a specified report to a specified user’s favourites list:
The code will return This function will add a specified report to a specified user’s report favourites list.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and remove a specified report to a specified user’s favourites list:
The code will return This function will remove a specified report to a specified user’s report favourites list.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
This function will return all avatar images of specified users within Yellowfin:
The response returned will contain these parameters:
|
This function will set the avatar image of the specified user’s profile within Yellowfin:
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
This function will reload the specified Org Reference Codes within Yellowfin.
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and clear the geometry cache in Yellowfin:
The code will return The function will clear the geometry cache in Yellowfin.
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and remove a view’s cache in Yellowfin:
The code will return This function will remove a view's cache in Yellowfin.
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and remove a report’s cached definitions in Yellowfin:
The code will return
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and remove a dashboard’s cached definitions in Yellowfin:
The code will return
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and delete a report in Yellowfin:
The code will return
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and delete a view in Yellowfin:
The code will return
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and delete a data source in Yellowfin:
The code will return {
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and delete a dashboard tab in Yellowfin:
The code will return
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and reload the licence definitions in Yellowfin:
The code will return
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and close the specified data source’s connection pool in Yellowfin:
The code will return
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and flush the specified filter’s filter cache in Yellowfin:
The code will return
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and approve a report in Yellowfin via the expert approval process:
The code will return
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and obtain all exportable content within Yellowfin:
The code will return an Array of ContentResource objects in
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and obtain dependencies for a specific Yellowfin artifact:
The code will return an Array of ContentResource objects in This function will obtain dependencies for a specific Yellowfin artifact. Note, you can execute the GETCONTENT webservices call to retrieve all exportable content metadata first. This comes in the form of an array of ContentResource objects which can be then used in this function call to retrieve their respective dependencies.
These are the parameters that you need to set in the ContentResource object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and export the specified artifacts within Yellowfin:
The code will return an Array of ReportBinaryObjects objects in This function will export the specified artifacts within Yellowfin. Note, you can execute the GETCONTENT webservices call to retrieve all exportable content metadata first.
These are the parameters that you need to set in the ContentResource object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and read a Yellowfin import file, returning the objects to be imported:
The code will return an Array of ContentResource objects in Refer to This function will read a Yellowfin XML import file and return a list of objects that can be imported into the application. This function will be expecting a Base64 encoded XML file as input.
The response returned will contain these parameters:
|
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:
The code will return an Array of ImportIssue objects in Refer to This function will validate a list of Yellowfin import objects. This function usually follows after the GETIMPORTCONTENT webservices call, where it reads a Yellowfin XML import file and returns a list of objects that can be imported into the application. In this function, it performs a validation process for every object in that list. Any issues encountered during the validation process is returned as ImportIssue objects in the response.
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and import the specified Yellowfin import objects into the application:
The code will return Refer to
The response returned will contain these parameters:
|
|
|
|
|
|
|
|
|
|