受信自動連携API

▶ 受信自動連携APIとは

連携相手側のデータを、定期的に取り込む機能です。
他システムから定期的にファイル（csv,txt,xlsx）を取得し、データを登録または更新します。
連携相手側のファイルの列と取込先の項目を紐付け設定することで、連携相手のフォーマットに合わせた取り込みをすることができます。

受信できる情報は、「自動連携API」＞「連携できる情報」を参照してください。

▶ 受信設定ステップ

▶ 取り込み方法

取り込むファイルをどこから取得するかによって、取り込み方法を使い分けます。

アップロード

他のサーバーからファイルを取得する場合、この方式を利用してください。

確認事項

• 接続テスト用のツールを利用しデータ取り込み先に接続できるか確認を行う。（任意）
• アップローダーをインストールするOS
• 取り込みファイルの配置場所（絶対パス）
  ※アップローダーはAPI受信設定後にダウンロードできます
  アップローダーでファイルの取り込みが実行されます。（アップローダーごとに取り込み間隔が指定できます）

NI Collabo 360文書共有管理

取り込みファイルの版管理も実施し、定期的にデータを取り込む場合に利用してください。

確認事項

• 取り込みファイルを配置している文書BOX
  ※定期実行（MapScorer自動連携APIタスク）にてファイルが取り込まれます。（1時間ごと）

ファイル指定（NIサーバー内に配置）

NIサーバーに直接ファイルの配置が可能な場合、この方式を利用してください。

確認事項

• 取り込みファイルを配置先（NIサーバー内の絶対パス）
  ※定期実行（MapScorer自動連携APIタスク）にてファイルが取り込まれます。（1時間ごと）

▶ Step1.受信設定前の準備

• 連携データのファイル（csv,txt,xlsx）：実際に運用するものと同じ形式のファイルを準備してください。
• 取り込むファイルの内容：取り込むファイルが連携相手先の差分データか全てのデータかを確認してください。
  他基幹システムなどから差分ファイルが出力できる場合は、基幹側で差分データを出力することを推奨します。
• 取り込み方法：取込ファイルの配置場所によって取り込み方法は以下をお勧めします。
  他のサーバーからファイルを取得・・・アップロード
  NI製品のサーバーからファイルを取得・・・ファイル指定
  NI Collabo 360文書共有管理からファイルを取得・・・文書共有管理
  詳しくは、「取り込み方法」を参照してください。
• 取込ファイルの配置先情報：取り込み方法ごとに以下の確認をしてください。
  アップロード・・・ファイル配置先サーバーのファイルの絶対パス
  ファイル指定・・・NI製品のサーバー内のファイルの絶対パス
  文書共有管理・・・ファイルがアップロードされている文書共有管理BOX

▶ Step2.受信設定を登録する

取込するAPIの設定をします。
設定の例は、「設定サンプル」を参照してください。

1. システム設定の「運用管理」タブより「自動連携API」の「受信自動連携API」を選択します。
   ⇒「自動連携API／受信自動連携API」画面が表示されます。
2. 「新規登録」ボタンをクリックします。
   ⇒新規登録画面が表示されます。
3. 必要事項を入力し、最後に「読み込み」ボタンをクリックします。

取込ファイル指定でのワイルドカード

ファイル受信方式が『アップロード』の場合は、取込ファイル指定のファイル名にワイルドカード（*）を指定できます。
『tokyo*.csv』と指定すると、『tokyo』で始まり『.csv』で終わるファイルが取り込み対象になります。

複数のファイルが取り込み対象になった場合は、次のとおりです。

• 取り込むのは、前回の取り込みより後に更新されたファイルだけです。データが重複して取り込まれたり、余分な負荷がかかったりすることはありません。
• 最終更新日の昇順で取り込みます。
• 1度に取り込めるのは最大20ファイルです。
• ファイルの合計が100MBを超える場合はアップロードできません。

データ取込方式（スキップデータ）

選んだ選択肢によって新規登録・更新しなかったデータを、スキップデータといいます。
スキップデータはエラーにならず、次の方法で確認できます。

• 自動連携APIの受信ログ画面に合計件数が表示されます。
• 送受信ログ＞詳細からログを確認することができます。
• 送受信ログ＞詳細の「出力（スキップデータ）」ボタンから出力することができます。

取込オプション

▶ Step3.読み込みファイルの形式を指定する

Step2で読み込んだファイルの解析結果を表示します。
読み込んだファイルと結果が異なっていた場合は、設定を切り替えます。
読み込んだファイルが間違っていた場合は、Step2に戻ります。

▶ Step4.名称、紐付けを設定する

Step1で読み込んだファイルから名称、紐付け設定等を反映します。
取込先ごとの注意事項は、「各業務の注意事項」を参照してください。

かんたん基幹連携について

受信設定の新規登録時に、項目名から判断して自動的に紐付を行います。
取込元と取込先を確認し、適切な紐付けに設定してください。

取込先項目の表示について

取込先に Sales Force Assistantの機能を選択時、取込先項目はテキスト入力の対象とする項目が表示されます。設定したい項目は、各機能の業務別項目設定より、対象項目のテキスト入力「テキスト入力の対象とする」にチェックを入れてください。

取込元と紐付かない項目について

1. Sales Force Assistantの必須項目が基幹システムに無い場合、初期値を設定することをお勧めします。
   新規登録時、未入力による入力エラーを回避できます。
   更新登録するさいは、初期値を反映することなく、Sales Force Assistantに入力された値を維持して取り込むことができます。
   【例】
   基幹システムには担当者がなく、SFAでは担当者が必須の場合。
   →初期値「システム管理者」を設定して取込み。
   
2. Sales Force Assistantの任意項目に初期値を設定している場合、新規登録時は、初期値で取り込まれます。
   更新登録時は、Sales Force Assistantに入力された値はクリアされます。
   
   ※ただし、商談情報、予算情報については対応外となり、初期値が反映されます。

識別子を利用した Sales Force Assistant（取込先）データの更新について

識別子はコードなど取り込むデータが一意に識別できる項目にチェックを入れてください。
識別子に指定した項目でSFAに一致するデータが1件存在する場合、取込先データは更新登録されます。
識別子に指定した項目でSFAに一致するデータが存在しない場合や識別子に指定した項目でSFAに一致するデータが複数存在する場合、取込元データは新規登録されます。
識別子を利用して更新登録したい場合は、識別子の値が重複しないようにしてください。

※取込先機能によっては新規登録時の重複チェックがかかり、重複エラーになります。識別子が未設定の場合は、新規登録されます。

※予算情報の場合、識別子のチェック項目は表示されません。以下の項目が識別子となります。
担当者単位：年度、予算種類、担当者、種別
顧客単位：年度、予算種類、顧客、種別
商品単位：年度、予算種類、担当者、顧客、商品分類、商品コード、種別
案件分類単位：年度、予算種類、担当者、案件分類、種別

取り込むデータに重複する識別子がある場合は分割して取り込みを行っていただくようお願いします。取り込む時にSFAに識別子が一致するデータが存在しない、または複数存在している場合、その識別子をもつ取り込みデータはすべて新規登録とみなして取り込まれます。

詳細設定画面

項目	説明
入力フィルター	項目の値を変換するときに、フィルターを選択、または、新規登録します。 表記の変換｛ひらがなカタカナの変換、大文字小文字の変換、特定の文字の置換［㈱→(株)］など｝に使用します。
分離	項目の値を分けて取り出すときに、設定します。 分離するための区切り文字を選択し、区切られた順番を番号として指定します。 氏名の姓と名とを別々の項目に分けて取り出すときなどに使用します。
結合	複数の項目の値を結合するときに、結合文字を選択します。 結合するための結合文字を選択し、結合する順番をプルダウンから指定します。 姓と名に分かれている項目を氏名として一つの項目にするときなどに使用します。 ※取込元複数項目と取込先1項目への結合について 　取込元の複数項目を取込先の1項目へ紐付けた時、 　結合順序の設定を保存しない場合、項目の紐付け順に結合します。 　任意の結合順序にしたい場合は、結合順序を設定してください。
区切り文字	項目の値を分ける場合に設定します。 チェックボックス項目や複数マスタを選択できる項目の場合は、複数選択した状態にするときに使用します。 納入機器コードから変換して読み込む項目の場合は、納入機器コードが複数に対して変換先のマスタが1つのときに使用します。納入機器コードの区切り文字と同じ文字を選択してください。 【例】納入機器コードから顧客情報を特定して商談情報を読み込む場合
変換	自動連携APIでコード指定にてデータを取り込む場合に設定します。 顧客情報や顧客の担当者情報などを取り込む場合、顧客名や部署名、社員名を指定せず顧客コードや部署コード、社員コードなどから取り込むときなどに使用します。 主な対象項目：部署、社員、顧客情報、パーソン情報、案件情報、商品マスタ 【指定例】 　顧客の担当者に「営業部 山田太郎」を登録する場合 　営業部の部署コード「gcode10」、山田太郎の社員コード「scode102」を指定。 　⇒取込み後、顧客の担当者に「営業部 山田太郎」が登録されます。 ※一致する情報が存在しなかった場合や一意に定まらなかった場合はエラーとなります。

▶ Step5.設定を保存する

最後に「保存して実行」または「保存」ボタンをクリックして、設定を保存します。
※設定時に読み込んだファイルのデータを登録する場合は、「保存して実行」ボタンをクリックしてください。
「保存して実行」ボタンをクリック後、データ取り込みが実行されます。項目設定など設定した内容の確認する場合などに利用します。

▶ Step6.アップローダー設定

ファイル受信方式「アップロード」を選択した場合、アップローダーをインストールします。
アップローダーのインストール方法は、「アップローダー、ダウンローダーをインストールする」を参照してください。

▶ 各業務の注意事項

社員

社員情報を新規登録時に、ログインID、パスワード項目が未設定の場合、自動的に値をセットします。

ログインID：システムIDを0埋めした4桁がセットされます。
【例】
システムIDが「15」の場合、「0015」がセットされます。
※既に同じログインIDが利用されていた場合は、4桁に「_1」から「_9」をセットします。
すべて利用されている場合は、重複エラーになります。
取り込みを行う場合は、利用されていない任意の値を取込ファイルに入力してください。

パスワード：「Pass123$」がセットされます。

パーソン情報

未入力項目の自動補完

パーソン情報のTEL・FAX・郵便番号・住所・ビル名等・URL・当社担当者のいずれかが未入力の場合、顧客情報から自動補完されます。顧客情報と同じ内容をパーソン情報へ入力する手間を省けます。以下の注意事項をご確認後、ご活用ください。

• 入力したTEL・FAX のいずれかが顧客情報と異なる場合、未入力のTEL・FAX は自動補完されません。
• 入力した郵便番号・住所・ビル名等のいずれかが顧客情報と異なる場合、未入力の郵便番号・住所・ビル名等・TEL・FAXは自動補完されません。
• 未入力のURL・当社担当者はその他の欄に関わらず自動補完されます。

パーソンコードでの登録・更新

パーソンコードを取り込んだ場合、登録済みのパーソンコードがあれば更新します。未登録の場合は新規登録になります。パーソンコードを取り込んでいない場合は、姓名で登録済みの情報をチェックします。姓名が一致するパーソンが1件であれば更新し、複数件一致した場合は新規に登録します。

商品マスタ

単位区分別単価を設定している商品マスタをCSV読み込みするとき、入数に未入力または0を指定した単位区分の設定は削除されます。

単位区分別単価

1. 入数に未入力または0を指定した単位区分の設定は削除されます。
2. 商品マスタに単位区分別単価を登録するためには、商品マスタを特定する必要があります。取込データは商品分類、商品名、商品コードで識別されます。
   （単位区分別単価は識別子が固定のため、識別子のチェック項目は表示されません。）
   そのため、商品名または商品コードのどちらかは紐付け設定することをおすすめします。
   以下は、データを取り込んだときにどの識別子が適用されるかまとめています。
   

顧客別商品価格

顧客別商品価格の場合、一致するデータが1件存在するとき取込先データは更新されます。
一致するデータが存在しない場合、取込元データは新規登録されます。
また、識別子のチェック項目は表示されません。以下の項目が識別子となります。
顧客情報、商品マスタ

案件情報

商談進捗度

システム設定＞Sales Force Assistant＞案件情報＞受注確度別商談進捗度にて、「受注確度の自動更新設定」が設定されている場合でも、商談進捗度は、取込元の情報が反映されます。

売上見込項目

案件情報更新時、売上実績情報に転送されていない明細をすべて削除し、取込元の情報にて、新規登録します。
システム設定＞Sales Force Assistant＞案件情報＞売上情報の自動転送が設定されている場合でも、取り込み時に売上実績情報として自動転送されません。
したがいまして、案件情報＋商談情報の取り込みを行う場合は、売上見込を売上実績に登録することをお勧めしません。

案件情報＋商談情報

1. Sales Force Assistantでは、案件の進捗管理を行うことができます。案件の進捗状況は、商談情報の内容にて更新される仕組みとなっていますので、案件情報＋商談情報の取込においても、商談情報を登録し、案件情報の進捗状況を更新します。
2. 1件の案件情報に関連する商談情報が、1件のみ登録されます。
   システム設定＞Sales Force Assistant＞案件情報＞関連案件入力モードの利用有無に依存しません。
3. 部署、担当者、顧客の取込先は、案件情報、商談情報それぞれに取込元を設定してください。
4. 取込先の項目として上部に案件情報項目、下部に商談情報項目が表示されます。
   

納入機器

納入機器に案件情報を関連付けて登録する際に案件名のみ指定して取り込んだ場合、顧客情報をもとに登録されます。
取込先の顧客情報と関連情報として取り込む案件情報の顧客情報からデータを特定できなかった場合は取り込むことができません。
詳細は、システム設定マニュアル「CSV入力」＞「案件情報を関連情報として取り込む」を参照してください。

▶ 設定サンプル

受信方式：アップロード（例1）

工事案件情報（フリーフォーム）にアップロードを利用して、データを取り込みたい。
また、データは差分だけを取り込み、前回の取込ファイルから無くなったデータを出力したい。
取込元サーバーのOSは、Windowsを利用

1. 「新規登録」ボタンをクリックします。
   

入力項目

2. 「読み込み」ボタンをクリックします。
3. 必要項目を選択します。
   ⇒「進む」ボタンをクリックします。

4. 読み込んだファイルを解析します。
   
   
   【例】取込元の建築主の氏名を取込先で姓と名に分けたい
   
   取込元：相川 弘（姓名の間は半角スペース）　⇒　取込先：【姓】相川【名】弘
   
   建築主と氏名（姓）/氏名（名）が同じ情報は、更新するようにしたい場合、以下の様に設定します。
   1. 「設定」 ボタンをクリックします。
   2. 入力フィルターの区切り文字に半角スペースを選択します。また、氏名（姓）の番号に1を、氏名（名）の番号に2をセットします。
   3. 氏名（姓）、氏名（名）の識別子に[✔]します。

5. 「保存」ボタンをクリックします。

受信方式：文書共有管理（例2）

工事案件情報（フリーフォーム）にNI Collabo 360の『文書共有管理』を使用して、データを取り込みたい。
また、前回の取込ファイルから無くなったデータをリスト管理したい。

1. 「新規登録」ボタンをクリックします。

入力項目

2. 「読み込み」ボタンをクリックします。
3. 必要項目を選択します。
   ⇒「進む」ボタンをクリックします。

4. 読み込んだファイルを解析します。

⇒「プレビュー」ボタンをクリックします。
紐付けや名称の確認をします。

5. 「保存」ボタンをクリックします。

受信方式：ファイル指定（例3）

工事案件情報（フリーフォーム）にファイル指定を利用して、データを取り込みたい。

1. 「新規登録」ボタンをクリックします。

入力項目

2. 「読み込み」ボタンをクリックします。
3. 必要項目を選択します。
   ⇒「進む」ボタンをクリックします。
4. 読み込んだファイルを解析します。
   ⇒紐付けや名称の確認をします。
   
5. 「保存」ボタンをクリックします。

▶ 受信設定を並び替える

登録した受信設定を並び替えます。

1. システム設定の「運用管理」タブより「自動連携API」の「受信自動連携API」を選択します。
   ⇒「自動連携API／受信自動連携API」画面が表示されます。
2. 移動したい受信設定を選択し、「並び替え」ボタンで並びを変更します。

▶ 受信設定を削除する

登録した受信設定を削除します。

1. システム設定の「運用管理」タブより「自動連携API」の「受信自動連携API」を選択します。
   ⇒「自動連携API／受信自動連携API」画面が表示されます。
2. 削除する受信設定のリンクをクリックします。
   ⇒受信設定の編集画面が表示されます。
3. 「削除」ボタンをクリックします。