ファイル送信コネクタ

ファイル送信コネクタについて

ファイル送信コネクターを使用して、コンプライアンスおよびデータバックアップの目的で XM Discover からエンリッチされたデータを抽出したり、外部アプリケーション内で処理したりすることができます。

センテンスおよびドキュメントレベルでデータをエクスポートし、新しいレコードと更新されたレコードに制限して、エクスポートするフィールド、エンリッチメント、および分類を選択することができます。ファイル送信コネクタにより、セキュアファイル転送プロトコル (SFTP) サーバにデータが保存されます。

開始前

ファイル送信コネクタを使用してジョブを設定する前に、以下を確認してください。

• SFTP アカウントのユーザ名とパスワードです。
• XM Discoverによって提供されるファイルを暗号化する場合は、PGP/GPGキー。

サポートされているファイル形式は以下のとおりです。

• 区切りテキストファイル (CSV)。
• JavaScript Object Notation ファイル (JSON)。

接続の設定

1. コネクタにサインインします。
2. ジョブの右上隅にある新規ジョブボタンをクリックします。
   
3. [コネクタ] ページで、送信ソースに移動します。
   
4. ファイル送信をクリックします。

ファイル送信コネクタジョブの設定

接続を設定したら、以下のステップに従ってジョブを設定します。

• ステップ 1: ジョブ名の入力
• ステップ 2: プロジェクトと説明の指定
• ステップ3：クアルトリクスSFTPフォルダーの認証情報を指定
• ステップ4：XM Discoverのエクスポート認証情報を設定
• ステップ 5: クエリ設定
• ステップ 6: ファイル設定の提供
• ステップ 7：必要なフィールドのクアルトリクスへのマッピング
• ステップ 9: フィルタの指定 (オプション) およびレコード制限
• ステップ 10: 通知設定 (オプション)
• ステップ 11: ジョブの追加オプションの設定
• ステップ 12: すべてのジョブ設定の確認

ヒント：［戻る］ボタンと［次へ］ボタンをクリックしてページ間を移動するか、矢印キーを使用します：［左］キーを押すと戻り、［右］をクリックすると次に進みます。設定をキャンセルする場合は、［キャンセル］ボタンをクリックします。

ステップ 1: ジョブ名の入力

1. ページの左上の [ジョブ名] ボックスに、認識可能なジョブ名を入力します。
   
   ヒント: 設定時に各ページの上部に表示される [ジョブ名] フィールドを使用して、設定時にジョブ名を変更することができます。
2. [次へ] をクリックします。

ステップ 2: プロジェクトと説明の指定

1. [プロジェクトおよび説明の指定] ページで、プロジェクトプルダウンリストからデータを抽出するプロジェクトを選択します。
   
   ヒント：プロジェクトは、Export APIキーで識別されるプロジェクトと一致する必要があります。不一致がある場合、ジョブでは API キーによって識別されたプロジェクトが使用されます。
   ヒント: [職務概要] ボックスにジョブに関するメモを入力するオプションがあります。ジョブ記述書ボックスに入力したジョブ記述書は、コネクタ一覧でのみアクセス可能であり、ジョブのデータの一部としてエクスポートされません。
2. [次へ] をクリックします。

ステップ3：クアルトリクスSFTPアカウントの認証情報の提供

1. Qualtrics SFTP フォルダの認証情報の指定ページで、ドロップダウンメニューから既存の認証情報のセットを選択するか、新しい認証情報のセットを追加することができます。新しい認証情報セットの追加の詳細については、「新しい SFTP 認証情報の追加」セクションを参照してください。
   
2. ［次へ］をクリックします。

ステップ4：XM Discoverのエクスポート認証情報を設定

1. XM Discover エクスポート認証情報の設定ページで、自分の地域に関連する XM Discover エクスポート API サービス URL (エンドポイントタイプなし) を HOST ボックスに入力します。
   
   ヒント：詳細については、「Export API v2 Endpoints」を参照してください。
2. [次へ] をクリックします。

ステップ 5: クエリ設定

［クエリー設定］ページで、XM Discoverからデータをエクスポートするレベルを指定し、取得するレコードを選択できます。

1. [データレベルを選択] プルダウンリストから以下のいずれかを選択して、送信データに関連付けられたデータの粒度レベルを選択します。
   
   • センテンス: トピック、センチメント、工数スコアなどのより詳細な情報およびセンチメントレベルのエンリッチメントにセンテンスレベルのエクスポートを使用します。
   • ドキュメント: ドキュメント全体に関連する構造化属性の値をエクスポートする場合は、ドキュメントレベルのエクスポートを使用します。
     注意：文章レベルのエンリッチメントを使用する場合は、データレベルを文に設定します。
   • 各レベルで使用可能な拡張の詳細については、即座に利用可能な属性を参照してください。
2. [クエリを入力] ボックスで、送信データをフィルタするクエリを指定します (オプション)。
   ヒント：Designer でのデータの検索に使用したものと同じ構文を使用します。サポートされている検索クエリの詳細については、検索クエリを参照してください。
   例: 1 つまたは複数の調査 ID を指定して、構文 surveyid:sv_01 を使用して選択した調査レコードのみを更新することができます。
3. 送信データに適用されるプロジェクトのフィルタの名称を Enter the filter name ボックスに入力します (オプション)。
4. [取得するレコードを選択] で、抽出するレコードを選択します。
   • 新規レコードをロードします (デフォルト)。最後に送信ジョブが実行されてから登録されたレコードのみを抽出します。
   • 新規レコードおよび更新済レコードをロードします。最後に送信ジョブが実行されてから登録または更新されたレコードを抽出します。
   • 更新されたレコードをロードします。最後に送信ジョブが実行された後に更新されたレコードのみを抽出します。
     ヒント：ファイル送信コネクタージョブが［新しいレコードと更新されたレコードを読み込み］または［更新されたレコードをロード］に設定されているものは、毎週または毎月の頻度でのみ実行されるようにスケジュールできます。
     注意：分類を実行または再実行すると、XM Discoverシステムのレコードが更新されます。
5. 送信データに含める分類データを定義することができます (オプション)。プロジェクトで利用可能なすべてのモデルの分類データを含めるには、すべてのモデルチェックボックスを選択します。選択したモデルのみを含める場合は、すべてのモデルチェックボックスを選択しないでください。すべてのモデルオプションが選択されていない場合は、ドロップダウンメニューから送信データに含める特定のモデルを選択することができます。
   
6. モデルルールを適用してフィルタ結果ドロップダウンメニューから、以下のいずれかのオプションを選択します。
   • 無視: 選択したモデルに基づくフィルタリングは適用されません。
   • 現在分類済: 最新の分類実行時に、選択したモデルによって分類された文/文書を返します。
   • 分類済: 選択したモデルによって任意の時点で分類された文/文書を返します。
7. カテゴリ名ではなくカテゴリ ID を返すかどうか (false) チェックボックスを選択して、カテゴリ名の代わりにカテゴリ ID を使用します (オプション)。
8. すべての最下位ノードパスを含むフィルタクエリを適用して結果を選択し、”leaf_only flag” パラメータが設定された複数のモデルをエクスポート API 呼出に追加します (オプション)。
9. [次へ] をクリックします。

ステップ 6: ファイル設定の提供

ファイル設定の指定ページで、データエクスポートに使用するファイルタイプを選択し、選択したファイルタイプに応じて、ファイルを保存する場所を指定し、その他の設定を指定します。

1. ファイル設定セクションで、以下の 2 つのオプションからファイルタイプを選択します。
   
   • 区切りテキストファイル (CSV): 区切りテキスト (CSV) ファイルを使用してデータをエクスポートする場合に選択します。
   • JavaScript Object Notation ファイル (JSON): JavaScript Object Notation (JSON) ファイルを使用してデータをエクスポートする場合に選択します。
2. ［区切りテキストファイル］（CSV）を選択した場合は、このファイルタイプに設定オプションを適用します。
   • ファイルエンコーディング: ファイルで使用するエンコードシステムを選択します。
   • 区切り文字: ファイル内のデータエントリを区切る文字を指定します。1 文字のみ。CSV を使用する場合、区切り記号はカンマです。
   • 囲み文字: ファイル内の各データフィールドを囲む文字を指定します。1 文字のみ。
   • 封入なし: 封入文字がオプションの場合は、このチェックボックスを選択します。
3. [ファイルの場所] セクションで [参照] をクリックして、SFTP サーバ上のファイルを保存するフォルダを指定します。
4. ファイルの保存場所を選択ウィンドウで、ファイルを保存するフォルダを選択します。
   
   ヒント：フォルダーの名前をクリックして選択し、フォルダーアイコンをクリックしてフォルダーを開きます。
5. ファイルが保存されているフォルダを選択したら、OK をクリックします。
6. 命名規則セクションで、以下のオプションを選択することができます。
   
   • 接頭辞のファイル名を入力してください。このオプションを選択すると、生成されたファイル名に追加される接頭辞を指定します。このオプションを使用してカスタム命名規則を適用し、どのファイルが特定のジョブまたはジョブ実行に対応しているかをより深く理解します。
     ヒント：値には[ ] \ / を含めることはできず、100文字以下にする必要があります。
   • 接尾辞のファイル名を指定してください。このオプションを選択すると、生成されたファイル名に追加される接尾辞が提供されます。このオプションを使用してカスタム命名規則を適用し、どのファイルが特定のジョブまたはジョブ実行に対応しているかをより深く理解します。
     ヒント：値には[ ] \ / を含めることはできず、100文字以下にする必要があります。
7. XM Discoverで提供されるファイルを暗号化し、暗号化用のPGP/GPGキーをPGP/GPGキーボックスで提供できます（オプション）。XM Discoverによって提供されるファイルの暗号化チェックボックスを選択して、XM Discoverからデータが安全に転送されるようにし、暗号化用のPGP/GPGキーを指定します。または、暗号化が不要な場合は、XM Discoverによって提供されるファイルを暗号化チェックボックスをオフにします。
8. [次へ] をクリックします。

ステップ 7: ファイルへの目的の項目のマッピング

［目的のフィールドをファイルにマッピング］
ページでは、エクスポートに含めるXM Discoverの属性と分類結果を選択できます。

1. 空のカスタムフィールドボックス内をクリックし、エクスポートに含めるXM Discoverフィールドを選択します。
2. データのエクスポート形式を [データ型] ドロップダウンメニューから選択します。
3. [属性名] ボックスに、エクスポートされたファイルで使用するフィールドの名前を入力します。
4. 必要に応じて、プラス (+ ) アイコンをクリックしてカスタムフィールドを追加し、エクスポートファイルのフィールドにマッピングします。
5. [次へ] をクリックします。

ステップ 8: フィルタの指定 (オプション) およびレコード制限

1. フィルタ指定ページで、ジョブに対してフィルタ条件を定義して、その条件を満たすレコードのみをエクスポートすることができます (オプション)。
   
   ヒント：フィルターの適用の詳細については、「コネクターフィルター」を参照してください。
2. [レコード制限の指定]ボックスでレコード制限を指定できます。また、すべてのレコードを 1 回のプッシュでエクスポートする場合は、レコード制限をデフォルトのすべてのままにしておくこともできます。
   ヒント：レコード制限は、ジョブの実行ごとの制限です。1,000 に設定すると、ジョブは設定した任意のスケジュールで実行され、1,000 レコードのエクスポート後に停止します。日次に設定すると、1 日に 1 回実行され、1 日に最大 1,000 件のレコードがエクスポートされます。
   ヒント：会話データの場合、上限は行ではなく会話に基づいて適用されます。
3. [次へ] をクリックします。

ステップ 9: 通知設定 (オプション)

1. [通知設定] ページでは、以下に示すいずれかのイベントが発生した場合に、ジョブの参照者が受信する通知を選択することができます。
   • ゼロレコードがエクスポートされます。
   • 連続する欠落値が見つかりました。
   • ジョブの実行が失敗します。
   • ジョブの実行が部分的に成功した。
   • ジョブはタイムアウトで終了します。
   • ジョブが失敗します。
     ヒント：通知の任意の組み合わせを選択するか、通知を選択しないように決定することができます。この場合、ジョブの監視は通知を受信しません。通知設定の詳細については、ジョブ通知を参照してください。
     ヒント: ファイル送信コネクタジョブのデフォルトのタイムアウトは48時間です。
2. [次へ] をクリックします。

ステップ 10: ジョブの追加オプションの設定

1. ジョブの追加オプション設定ページの履歴/増分ジョブのスケジュールセクションで、以下のいずれかのオプションを選択します。
   • 差分データエクスポートのスケジュールを設定するには、[差分実行のスケジュール] を選択します。
     ヒント：ファイル送信コネクタージョブが［新しいレコードと更新されたレコードを読み込み］または［更新されたレコードをロード］に設定されているものは、毎週または毎月の頻度でのみ実行されるようにスケジュールできます。
     ヒント：データをエクスポートする前にジョブとその設定を検証する場合は、［ジョブを作成（ただし、データを取得しない）］オプションを使用します。増分実行のスケジュールの詳細については、ジョブスケジュールを参照してください。
   • ワンタイムプルを設定して、ワンタイムデータエクスポートを実行します。
     ヒント: スケジュール設定は後で変更できます。ワンタイム実行のデータ取得および通常実行のジョブスケジュールを参照してください。
2. 追加増分データセクションでは、関連するすべての履歴データをアウトバウンド転送で使用できるように、増分実行中にプルする追加データ (日数または時間数) を指定することができます (オプション)。
   ヒント：このフィールドの最大値は 30 日です。
3. [次へ] をクリックします。

ステップ 11: すべてのジョブ設定の確認

1. すべてのジョブ設定の確認ページでは、データエクスポートを実行する前に、ジョブのすべての設定の概要を表示し、必要に応じて設定を編集することができます。データエクスポートを実行するには、データエクスポートを実行する準備ができたら [完了] ボタンをクリックします。ジョブが正常に送信されたことを確認する確認メッセージが表示されます。
2. 終了をクリックすると、1 回限りのエクスポートが即時に実行されます。[ジョブを作成するがデータを取得しない] オプションを有効にしていない場合、スケジュールされたエクスポートはすぐに実行されてから、定義したスケジュールに従って実行されるように設定されます。

ジョブの監視
の詳細については、ジョブページ概要を参照してください。

新しい SFTP 認証情報の追加

1. 新規追加を選択します。
2. 新しい認証情報セットの名前を CONNECTION NAME ボックスに入力します。
   
3. SFTP ユーザ名を SFTP USERNAME ボックスに入力します。
4. SFTP パスワードを SFTP PASSWORD ボックスに入力します。
5. SFTP サーバアドレスを SFTP HOST ボックスに入力します。
6. SFTP ポートを [SFTP PORT] ボックスに入力します。
   ヒント：デフォルトのポートは 22 です。
7. 特定の期間が経過すると認証情報が期限切れになるよう設定できます (オプション)。この認証情報セットの有効期限を定義し、すべてのジョブウォッチャに対してリマインダを設定するには、有効期限通知の送信チェックボックスを選択します。[有効期限前の日数] ボックスが有効になります。
8. [有効期限前の日数] ボックスに値を入力して、通知が有効期限切れになるまでの日数を設定します。使用可能な値は 1 日から 100 日です。
   ヒント：このリマインダーは、有効期限が［有効期限までの日数］ボックスで設定した日数未満になると、ジョブが実行されるたびにトリガーされます。
9. カレンダ日付ピッカーから有効期限を選択します。これにより、有効期限が [有効期限] ボックスに追加されます。