Page History

...

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

注意: if クライアント組織 機能を システム構成 ページでオンにしている場合、特定のタイプの呼び出しについて適用可能な場合はクライアント組織を指定することもできます。

...

Expand
title CREATEGROUP
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinに指定されたグループを作成します。 Code Block AdministrationServiceRequest rsr = new AdminstrationServiceRequest(); AdministrationServiceResponse rs = null; AdministrationGroup group = new AdministrationGroup(); group.setGroupName("Group Name"); group.setGroupDescription("Group Description"); rsr.setLoginId(this.username); rsr.setPassword(this.password); rsr.setOrgId(new Integer(1)); // uncomment line below and set Client Reference ID if you wish to create the group in a client organisation // rsr.setOrgRef("CLIENTREFERENCEIDHERE"); rsr.setFunction("CREATEGROUP"); rsr.setGroup(group); rs = AdministrationService.remoteAdministrationCall(rsr); このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 注意: AdministrationPersonオブジェクトのAdministrationGroupMember配列を投入することによって、新規作成されたグループに既存のYellowfinユーザーを同時に配置することもできます。各AdministrationPersonオブジェクトに必要なのはLoginId変数セットのみであり、AdministrationGroupMember配列はgroup.setGroupMembers()に保存されます。 この関数はYellowfinグループを作成します。この関数では、新規グループに既存のYellowfinユーザーを保存できる点にも注意してください。 リクエスト要素 データ型 説明 LoginId String Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 Password String Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 OrgId Integer Yellowfin内のデフォルト組織ID。常に1に設定します。 Function = "CREATEGROUP" String Webサービス関数。 OrgRef String この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 Group AdministrationGroup 取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。 AdministrationGroupオブジェクトで設定が必要なパラメーターは、以下の通りです。 AdministrationGroup Element データ型 説明 GroupName String 指定したYellowfinグループの名前 GroupDescription String 指定したYellowfinグループの説明 GroupMembers Array (AdministrationPerson) AdministrationPersonオブジェクトの配列。これはオプションのパラメーターで、既存のYellowfinユーザーをこのグループに保存するよう設定することができます。このシナリオの場合、AdministrationPersonオブジェクトに必要なのは、オブジェクトごとにそのUserIdパラメーターを設定することだけです。 返される応答には、以下のパラメーターが含まれます。 応答要素 データ型 説明 StatusCode String Webサービス呼び出しのステータス。可能な値は以下の通りです。 SUCCESS FAILURE

...

Expand
title EXCLUDEUSERINGROUP
以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループから指定されたユーザーを除外します。注意: このユーザーはグループから削除されるのではなく、グループ定義から除外されるだけです。これが役立つのは、たとえば以下のような場合です。* John DoeはグループAのメンバーである* グループAはグループBのメンバーである* John DoeはグループBのメンバーであってはならないため、グループBから除外する必要がある Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; AdministrationGroup group = new AdministrationGroup(); AdministrationPerson person = new AdministrationPerson(); group.setGroupName("Group Name"); person.setUserId("test@yellowfin.com.au"); rsr.setLoginId(this.username); rsr.setPassword(this.password); rsr.setOrgId(new Integer(1)); // uncomment line below and set Client Reference ID if you wish to get the group in a client organisation // rsr.setOrgRef("CLIENTREFERENCEIDHERE"); rsr.setFunction("EXCLUDEUSERINGROUP"); rsr.setGroup(group); rsr.setPerson(person); rs = AdministrationService.remoteAdministrationCall(rsr); このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。 この関数は、指定されたグループから指定されたYellowfinユーザーを除外します。このユーザーはグループから削除されるのではなく、グループ定義から除外されるだけである点に注意してください。これが役立つのは、たとえば以下のような場合です。 John DoeはグループAのメンバーである* グループAはグループBのメンバーである* John DoeはグループBのメンバーであってはならないため、グループBから除外する必要がある リクエスト要素 データ型 説明 LoginId String Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 Password String Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 OrgId Integer Yellowfin内のデフォルト組織ID。常に1に設定します。 Function = "EXCLUDEUSERINGROUP" String Webサービス関数。 OrgRef String この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 Group AdministrationGroup The AdministrationGroup object holding the Yellowfin user group's name for the retrieval process Person AdministrationPerson 取得プロセスに関するYellowfinユーザーのユーザーIDを保持するAdministrationPersonオブジェクト。 These are the parameters that you need to set in the AdministrationGroup and AdministrationPerson objects: AdministrationGroup Element データ型 説明 GroupName String Name of the specified Yellowfin group AdministrationPerson要素 データ型 説明 UserId String YellowfinユーザーのユーザーID。これは、ログインIDの方法に応じてユーザーIDまたは電子メールアドレスにすることができます。 返される応答には、以下のパラメーターが含まれます。 応答要素 データ型 説明 StatusCode String Webサービス呼び出しのステータス。可能な値は以下の通りです。 SUCCESS FAILURE |

...

Expand
title MODIFYGROUP
The 以下のコードは、Yellowfin Webサービスを呼び出し、Yellowfinの指定されたグループを変更します。 Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; AdministrationGroup group = new AdministrationGroup(); group.setGroupName("Group Name"); rsr.setLoginId(this.username); rsr.setPassword(this.password); rsr.setOrgId(new Integer(1)); // uncomment line below and set Client Reference ID if you wish to get the group in a client organisation // rsr.setOrgRef("CLIENTREFERENCEIDHERE"); rsr.setFunction("MODIFYGROUP"); rsr.setGroup(group); rs = AdministrationService.remoteAdministrationCall(rsr); このコードはrs.getStatusCode()でSUCCESSを返します。それ以外の場合は、プロセスが失敗した理由を説明するエラーを返します。注意: AdministrationPersonオブジェクトのAdministrationGroupMember配列を投入することによって、変更されたこのグループに既存のYellowfinユーザーを同時に配置することもできます。各AdministrationPersonオブジェクトに必要なのはLoginId変数セットのみであり、AdministrationGroupMember配列はgroup.setGroupMembers()に保存されます。 この関数はYellowfinの指定されたグループの詳細を変更します。この関数では、新規グループに既存のYellowfinユーザーを保存できる点にも注意してください。 リクエスト要素 データ型 説明 LoginId String Yellowfin Webサービスへの接続に使用されるアカウントのログインID（admin@yellowfin.com.auなど）。 Password String Yellowfin Webサービスへの接続に使用されるアカウントのパスワード。 OrgId Integer Yellowfin内のデフォルト組織ID。常に1に設定します。 Function = "MODIFYGROUP" String Webサービス関数。 OrgRef String この関数を特定のクライアント組織に適用する場合には、クライアント参照ID。このパラメーターはオプションです。 Group AdministrationGroup 取得プロセスに関するYellowfinユーザーグループの名前を保持するAdministrationGroupオブジェクト。 AdministrationGroupオブジェクトで設定が必要なパラメーターは、以下の通りです。 AdministrationGroup Element データ型 説明 GroupName String 指定したYellowfinグループの名前 GroupDescription String 指定したYellowfinグループの説明 GroupMembers Array (AdministrationPerson) AdministrationPersonオブジェクトの配列。これはオプションのパラメーターで、既存のYellowfinユーザーをこのグループに保存するよう設定することができます。このシナリオの場合、AdministrationPersonオブジェクトに必要なのは、オブジェクトごとにそのLoginIdパラメーターを設定することだけです。 返される応答には、以下のパラメーターが含まれます。 応答要素 データ型 説明 StatusCode String Webサービス呼び出しのステータス。可能な値は以下の通りです。 SUCCESS FAILURE

...