こちらで紹介するwebサービスの呼び出しは、コンテンツのエクスポートとインポートに関連しています。webサービスAPIは現在、以下のタイプのコンテンツのエクスポートとインポートを制限しています。
こちらのプロセスは、エクスポート可能な情報を取得し、他のサービスで再利用するための、エクスポートwebサービスを実行する方法を紹介します。
Yellowfinの各コンテンツタイプで、オブジェクトのresorceType値を把握する必要があります。
コンテンツタイプ | ContentResource resourceType |
レポートカテゴリー | RPTCATEGORY |
レポートサブカテゴリー | RPTSUBCATEGORY |
データソース | DATASOURCE |
ビュー | VIEW |
ダッシュボード | GROUP |
レポート | REPORT |
データトランスフォーメーション | ETLPROCESS |
こちらの関数は、エクスポート可能なすべてのYellowfinコンテンツを返します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
リクエストの例以下は、こちらのリクエストのSOAP XMLの例です。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
応答の例サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
こちらの関数は、選択したYellowfinのコンテンツを、XMLファイルにエクスポートします。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
以下のパラメーターは、こちらの関数を呼び出すためにContentResourceオブジェクトに指定します。
リクエストの例以下は、こちらのリクエストのSOAP XMLの例です。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
ReportBinaryObject配列は、こちらの呼び出しに以下のパラメーターを返します。
応答の例サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
こちらの関数は、特定のコンテンツのすべての依存関係を返します。ContentResourceオブジェクトは、リソースID(GETCONTENTの呼び出しを使用して取得することができます)とともにコンテンツを指定するために使用します。 例えば、レポートが定義されたコンテンツタイプであれば、応答にはレポートカテゴリー、サブカテゴリー、データソース、ビューなどの依存関係が表示されます。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
以下のパラメーターは、こちらの関数を呼び出すためにContentResourceオブジェクトに指定します。
リクエストの例以下は、こちらのリクエストのSOAP XMLの例です。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
応答の例サービスは、今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
Yellowfinのインポートwebサービスを使用するには、以下のヒントを参照してください。
インポートするコンテンツを指定するImportContentオブジェクトをセットアップするには、optionValueを提供することで、optionKeyパラメーターを定義しなくてはいけません。以下は、利用可能な組み合わせの例です。
例えば、あるYellowfinレポートを、その依存関係(データソース、ビュー、カテゴリー、サブカテゴリー)とともにエクスポートする場合、ContentResourceオブジェクト(GETIMPORTCONTENTの呼び出しにより取得します)は、以下のように表示されます。
次に、5つのすべての項目に対して、インポートオプションを定義しなくてはいけません。ImportOptionのitemIndexパラメーターは、各ContentResource項目のindex番号に対応しているので、上記のContentResource配列の例では、次のように表示されます。
レポートを今回の例の他の既存レポートに置き換え、その他すべてのコンテンツをインポートしない場合は、ImportOptionオブジェクトの構成は、以下のようになります。
コンテンツを「新規」としてインポートする場合、その依存関係をImportOptionオブジェクト内で指定しなくてはいけない点に注意してください。そのため、新規レポートは、必要な依存関係(ビュー、カテゴリー、サブカテゴリー)のインポートなしにインポートすることができません(注意:エクスポートファイルから取得される依存関係を使用する代わりに、レポートの依存関係を対象環境内の既存のものと置き換える選択をすることができます)。主要なコンテンツタイプに要求される依存関係は、以下を参照してください。
|
こちらの関数は、提供されるYFX、またはXMLファイルを読み、特定のコンテンツをインポート可能なContentResourceオブジェクトへ配置します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
こちらの関数は、XML、またはYFXファイルからコンテンツをYellowfinへインポートします。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
リクエストの例以下は、こちらのリクエストのSOAP XMLの例です。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
応答の例サービスは今回のSOAPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
こちらのwebサービスは、データソースの検証を行わない以外は、IMPORTCONTENTと同様です。 |
こちらの関数は、YFX、またはXMLファイルからインポートされる可能性のあるコンテンツのテスト、および検証を行います。この関数は、実際のデータのインポートは実行しません。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
リクエストの例以下は、こちらのリクエストのSOAP XMLの例です。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
応答の例サービスは、今回のSAOPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
こちらのwebサービスは、TESTIMPORTCONTENTと同様のコンテンツインポートテストを実行しますが、TESTIMPORTCONTENTと異なり、データソースの検証は行いません。 |
Yellowfinのコンテンツ翻訳機能は、レポートやビュー、ダッシュボードのようなコンテンツを、元の言語から翻訳することができます。こちらの機能と翻訳プロセスについて、より詳細な情報は、こちらをクリックしてください。以下のwebサービスには、翻訳されたコンテンツのエクスポートとインポートが含まれます。
注意:翻訳可能なコンテンツをエクスポートする前に、Yellowfin内で他の言語を定義してください。
こちらのwebサービスは、翻訳されたコンテンツをCSVファイルにエクスポートします。返されるデータは、すべての有効なビュー、レポート、ダッシュボードにわたる翻訳可能なコンテンツです。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
リクエストの例以下は、こちらのリクエストのSOAP XMLの例です。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
応答の例サービスは、今回のSAOPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|
こちらの関数は、Yellowfinに翻訳CSVファイルをインポートします。このファイルは、指定したコンテンツをエクスポートする際に、コンテンツ翻訳プロセス中に生成されます。他の詳細とともに、ファイルには、他に指定した言語のカラム(列)が含まれます。翻訳したコンテンツをその構成されたカラム(列)に追加し、こちらの関数を使用して、システムにファイルをインポートし直します。 リクエストパラメーター以下の要素は、こちらのリクエストとともに渡されます。
リクエストの例以下は、こちらのリクエストのSOAP XMLの例です。
応答パラメーター返される応答には、これらのパラメーターが含まれます。
応答の例サービスは、今回のSAOPの例に基づき、以下の応答を返します。
手順Javaの例を使用して、こちらの呼び出しを実行するための詳細な手順は、以下を参照してください。
完成例以下は、こちらのwebサービスの呼び出しの完成例です。こちらを使用するには、以下の手順に従います。
|