製品共通

送信自動連携API

Sales Force AssistantやSales Quote Assistant、nyoiboxのデータを、定期的に自動で出力する機能です。
テキスト形式でファイルに出力します。
集計、レポートに利用したり、他システムとデータ連携するなど、Sales Force AssistantやSales Quote Assistant、nyoiboxに蓄積されたデータを様々な用途で再利用することが可能です。

送信設定ステップ

Step1.共通設定
共通設定
Step2.出力ファイル設定
出力ファイル設定
Step3.出力条件設定
出力条件設定
Step4.設定保存
設定を保存する
Step5.ダウンローダー設定
アップローダー、ダウンローダーをインストールする
※送信設定を保存後にインストール可能です。

送信設定を登録する

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

補足
出力方法は「ダウンロード」方式のみとなります。

ダウンロード

※サーバーから出力ファイルを受信し、指定したフォルダに格納するプログラム(以降、「ダウンローダー」)を利用して出力します。

※ダウンローダーはWindows版とLinux版があり、NI製品サーバーとは別サーバー(連携相手のサーバーを想定)にインストールします。

※ダウンローダーが定期的にサーバーにアクセスし、出力処理を行います。

※ダウンローダーがインストールされたサーバーは、ログインしていない状態でも動作可能です。

※ダウンローダーのインストール方法は、「アップローダー、ダウンローダーをインストールする」を参照してください。

※ダウンローダーの実行スケジュールを変更する場合は、「自動連携APIの実行スケジュールを変更する」を参照してください。

Step1.共通設定

項目名称説明
出力元データの出力元機能を選択します。
社員・部署・役職・顧客情報・パーソン情報・商品マスタ・単位区分別単価・案件情報・納入機器・売上情報・予算情報・商談情報・業務情報・顧客の声・対応履歴・フリーフォーム・見積書・受注伝票・納品書・顧客別商品価格・仕訳(経費精算)・仕訳(支払管理)・全銀振込データ(経費精算)・全銀振込データ(支払管理)・ワークフロー・タイムカード・フォームBOX・Priv.BOX

次の出力元機能は、更にそれぞれ専用の出力テンプレートを選択します。
・仕訳:NI Collabo 360>経費精算(仕訳)または支払管理>仕訳データ作成ビュー下部の「仕訳データ作成書式」
・タイムカード:NI Collabo 360>システム設定>タイムカード/出力設定で登録されているテンプレート

※フォームBOXやPriv.BOXの場合、BOXの閲覧制限や項目のアクセス権の設定に関わらず、出力する項目を設定できます。
出力内容を見せたくない場合は、選択項目から外してください。

※出力元がnyoiboxかつクラウドサービスの場合、設定の上限数は20個です。
使用区分送信設定を使用するかしないかを設定します。
設定名送信設定の設定名を入力します。
※最大文字数は256文字
ダウンローダー[インストール先OS]
出力ファイルを配置するサーバーのOSに合わせて指定します。

[認証パスワード]
パスワードを入力します。
自動作成されるダウンローダーに反映されます。
保存されている認証パスワードとダウンローダーのパスワードが一致している場合のみ出力を実行します。

[インストーラー]
送信設定を保存後に、「インストーラー」ボタンが有効になります。
送信設定後にダウンロードしてインストールしてください。

※インストール方法は、「アップローダー、ダウンローダーをインストールする」を参照してください。

[接続テスト用ツール]
データ出力元のサーバーへの接続テストを行うツールをダウンロードすることができます。
プロキシサーバー、UTMなどデータ取込先のサーバーへの接続に不安がある場合にご利用ください。

Step2.出力ファイル設定

項目名称説明
出力先指定出力結果の場所をダウンローダーのインストール先の絶対パスで指定します。
自動作成されるダウンローダーに反映されます。
以下の日付書式予約語を指定すると、出力先の名称にダウンローダーの実行開始日時を含められます。
年→%Y 月→%m 日→%d 時→%H 分→%M 秒→%S

■出力ファイル名の設定例
 【例1】出力ファイル名を「C:\CSV20150101\shain.csv」としたい場合
  ⇒「C:\CSV%Y%m%d\shain.csv」と入力します。
 【例2】出力ファイル名を「C:\CSV\shain_2015-01-01-141530.csv」と出力したい場合
  ⇒「C:\CSV\shain_%Y-%m-%d-%H%M%S.csv」と入力します。
また、同一のファイル名が存在した場合、上書きするか追記するかを選択できます。

■出力先フォルダ(ディレクトリ)の設定例
 【例1】出力先フォルダを「C:\CSV20190101\zenfuriDir」としたい場合
  ⇒「C:\CSV%Y%m%d\zenfuriDir」と入力します。
 【例2】出力先フォルダを「C:\CSV\zenfuriDir_2019-01-01-141530」と出力したい場合
  ⇒「C:\CSV\zenfuriDir_%Y-%m-%d-%H%M%S」と入力します。

※全銀振込データを出力時、同一のファイル名が存在した場合は常に上書きとなります
項目名1行目に項目名を出力する場合に選択します。
自動作成されるダウンローダーに反映されます。

■出力元が「仕訳」の場合
仕訳データ作成書式のその他設定「✓項目名の行を出力しない」の設定は、こちらには適用されません。項目名を出力しない場合は、「1行目は項目名」にチェックを入れないでください。
囲み文字項目を””で囲む場合に選択します。
区切り文字区切り文字を選択します。
言語言語を選択します。

■出力元が「商品マスタ」の場合
Sales Quote Assistantがインストールされている環境では、次の多言語管理の条件を満たすときは、Sales Quote Assistant>システム設定>その他/言語設定で追加されているSales Quote Assistant専用言語を含めて選択できます。

※多言語管理の条件:Sales Quote Assistant>システム設定>商品マスタ/多言語管理の設定が「商品名を多言語登録する」のとき。
文字コード文字コードを「Shift-JIS」「EUC-JP」「UTF-8」から選択します。
自動作成されるダウンローダーに反映されます。
選択項目出力する項目を設定します。出力元:ワークフローの場合はソート順も選択できます。
また、見積共有管理と連携した申請書類の場合、選択項目[見積情報]を選択すると、ワークフローに見積情報を含めて出力します。

※出力元:社員・部署・役職・ワークフロー・フォームBOX・Priv.BOXの場合のみ表示されます。
基幹システム連携設定基幹システム向けに出力するかどうかを設定します。

※出力元:受注伝票かつ出力設定(受注伝票)を設定している場合のみ表示されます。
テンプレート 出力出力条件、ソート順となるテンプレートを設定します。
選択ボタンをクリックすると、テンプレート設定画面が起動します。

※出力元:顧客情報・パーソン情報・商品マスタ・単位区分別単価・商談情報・業務情報・案件情報・納入機器・売上情報・予算情報・顧客の声・対応履歴・フリーフォーム・見積書・受注伝票・納品書・顧客別商品価格の場合のみ表示されます。
出力形式社員項目の部署の出力形式を「部署名」「表示名」から選択します。

※出力元:顧客情報・パーソン情報・案件情報・納入機器・売上情報・予算情報・商談情報・顧客の声・対応履歴・業務情報・フリーフォーム・見積書・受注伝票・納品書の場合のみ表示されます。
改行出力ファイルの改行コードを設定します。

※出力元:全銀振込データの場合のみ表示されます。

注意

共通の出力注意事項

  • 出力ファイル設定の「言語」で設定している言語が削除された場合、日本で出力を行います。
  • 仕訳やタイムカードなどの出力テンプレートの登録・編集には専用の役割・権限ロールなどの割り当てが必要になる場合があります。詳しくは各機能のマニュアルを参照ください。
  • 送信自動連携APIの設定を一度保存すると、これら出力テンプレートの指定は変更できません。
  • 送信自動連携APIの設定を保存したあと、出力テンプレートの内容を変更すると変更後の内容に従って出力します。
  • 出力テンプレートを削除されると送信自動連携APIでは正しい結果を出力できなくなります。
  • 予期しない変更の影響を避けるためにも送信自動連携API専用のテンプレートを作成することを推奨します。
  • 出力先指定の同一名のファイルが存在した場合「追記する」を指定されている場合は、文字コードを途中で変更すると、前回までに出力された出力ファイルと新たに出力されるファイルの文字コードの差異により文字化けする原因となります。
    その場合は、事前に前回出力された出力ファイルを削除した上でダウンローダーの再インストールが必要です。
  • 2019年8月26日以前のバージョンで設定されたWindowsOS用ダウンローダーでは、UTF-8にBOMが付与される場合がありました。
    BOMの付与を前提に運用している場合、2019年10月1日バージョン以降のダウンローダーを再インストール後に出力されるファイルはBOM無しとなることにご注意ください。

ワークフロー、見積情報の出力注意事項

  • ワークフロー、見積情報は最新マスタの項目で出力を行います。
  • マスタに項目を追加した場合、送信設定画面の選択項目にて該当項目を選択すると、出力対象になります。
  • マスタから項目を削除した場合、それ以前の申請データの該当項目は、出力できません。

全銀振込データの出力注意事項

  • 全銀振込データ1件につき1ファイル出力されます。
    全銀振込データが複数ある場合、1ファイルにまとめて出力されません。

タイムカードの出力注意事項

  • タイムカードは出力日時の前日を基準に、タイムカードの「月度」に設定された内容をもとに出力されます。
    出力日時は会社標準タイムゾーンに準拠します。
  • 1行目は項目名を出力する場合、選択している出力テンプレートの出力形式が「日付ごとに出力」に設定されているときのみ有効です。
  • 出力対象の社員・部署・グループ・役職は使用中または使用停止中のものが対象になります。
    対象がすでに削除されている場合は出力されません。
  • 設定されていたタイムカード/出力設定テンプレートがすでに削除されていた場合は、「初期値」の内容で出力されます。
  • 出力される社員の順番は、社員一覧の並び順です。

フォームBOX・Priv.BOXの出力注意事項

  • 更新日時の出力形式は「年月日 時分秒」です。
    ロケールに依存せず、UTC(協定世界時)で出力されます。
    更新したことがない情報(登録のみの情報)は、登録日時が出力されます。
  • 複数設定されている場合、順番に実行されます。
    そのさい、APIの実行間隔は15分空けられます。
    たとえば、1番目に実行されたAPIの終了時間から15分以降に2番目のAPIが実行されます。3番目以降も同様です。

補足

ロケールについて

  • 出力ファイルの日付データは「日本」ロケールの形式となります

テンプレート設定画面

  • 「選択」ボタンをクリックすると、送信設定画面に反映されます。
  • テンプレート登録詳細は、Sales Force Assistantの「共通操作」またはSales Quote Assistantのユーザー操作マニュアルを参照してください。
  • 登録したテンプレートは本機能専用となります。テキスト出力やリスト表示で登録したテンプレートは使用できません。
  • 出力元にSales Force Assistantの機能を選択時、出力項目はテキスト出力の対象に設定している項目が表示されます。テキスト出力したい項目は、各機能の業務別項目設定より、対象項目のテキスト出力「テキスト出力の対象とする」にチェックを入れてください。

■出力元:全銀振込データの場合

  • 出力ファイルの言語は会社標準言語、文字コードはShift-JISとなります。
  • 出力内容は全銀協規定フォーマットに準拠して出力されます。

Step3.出力条件設定

項目名称説明
出力方式差分データだけを出力する場合に選択します。
前回送信日時以降に登録・更新されたデータのみ出力します。
※出力元:顧客情報・パーソン情報・商品マスタ・単位区分別単価・商談情報・業務情報・案件情報・納入機器・売上情報・予算情報・顧客の声・対応履歴・フリーフォーム・見積書・受注伝票・納品書・顧客別商品価格・仕訳・全銀振込データ・ワークフロー・フォームBOX・Priv.BOXの場合のみ表示されます。
使用区分出力を行う使用区分を選択します。
※出力元:社員・部署・役職の場合のみ表示されます。
ターゲットリスト出力条件として、既存のターゲットリストを選択するか、新規にターゲットリストを作成できます。
ターゲットリストについては、Sales Force Assistantの「共通操作」またはSales QuoteAssistantのユーザー操作マニュアルを参照してください。

※出力元:顧客情報・パーソン情報・商談情報・業務情報・案件情報・納入機器・売上情報・顧客の声・対応履歴・フリーフォーム・見積書・受注伝票・納品書の場合のみ表示されます。
決裁状況出力を行う決裁状況を選択します。

※出力元:ワークフローの場合のみ表示されます。
期間出力を行うワークフロー申請期間を設定します。

※出力元:仕訳・全銀振込データ・ワークフローの場合のみ表示されます。
商品分類商品分類を指定して出力する場合に選択します。
複数階層がある場合、子階層のキーワードも加味して検索します。

※出力元:商品マスタ・単位区分別単価・顧客別商品価格の場合のみ表示されます。
商品名/商品名2商品名または商品名2を検索して出力する場合に選択します。
キーワードをスペース区切りで設定した場合、AND検索します。

※出力元:商品マスタ・単位区分別単価・顧客別商品価格の場合のみ表示されます。
商品コード/商品コード2商品コードまたは商品コード2を検索して出力する場合に選択します。
キーワードをスペース区切りで設定した場合、AND検索します。

※出力元:商品マスタ・単位区分別単価・顧客別商品価格の場合のみ表示されます。
年度出力を行う年度を選択します。

※出力元:予算情報の場合のみ表示されます。
予算単位出力を行う予算単位を選択します。

※出力元:予算情報の場合のみ表示されます。
予算種類出力を行う予算種類を選択します。

※出力元:予算情報の場合のみ表示されます。
閲覧制限閲覧制限が設定されているデータを出力する場合に選択します。
出力対象データや対象データに紐付く顧客情報に個別閲覧制限がかかっていてもデータを出力します。

※出力元:顧客情報・パーソン情報・商談情報・業務情報・案件情報・納入機器・売上情報・予算情報・顧客の声・対応履歴・フリーフォーム・見積書・受注伝票・納品書・ワークフローの場合のみ表示されます。
参照可否業務別項目設定の参照可否に『参照可能とする』が設定されている項目を出力する場合に選択します。操作者が参照できない項目も出力します。
参照可否が設定されている項目を出力しない場合は、チェックを入れずに保存してください。

※出力元:顧客情報・パーソン情報・案件情報・納入機器・予算情報・商談情報
業務情報・顧客の声・対応履歴・フリーフォーム・見積書・受注伝票・納品書の場合のみ表示されます。
顧客情報顧客情報を指定して出力する場合に選択します。

※出力元:顧客別商品価格の場合のみ表示されます。
使用停止使用中、使用停止を指定して出力する場合に選択します。

※出力元:商品マスタ・単位区分別単価・顧客別商品価格の場合のみ表示されます。
言語商品マスタの商品の使用言語を指定して出力する場合に選択します。
複数設定した場合、OR検索します。

※出力元:商品マスタ・単位区分別単価の場合で且つ Sales Quote Assistant>商品マスタの多言語管理の設定で“商品ごとに使用言語を指定する”管理方法の場合のみ表示されます。なお、送信設定を保存した後に商品マスタの多言語管理の管理方法を変更してしまうと保存されている当該設定の選択値と実際の設定に差が生じたり予期しない出力結果となる可能性があるので設定の際はご注意ください。
通貨通貨を指定して出力する場合に選択します。
複数設定した場合、OR検索します。

※出力元:商品マスタ・単位区分別単価の場合のみ表示されます。
グループキーグループキーを指定して出力する場合に選択します。
複数設定した場合、OR検索します。

※出力元:商品マスタ・単位区分別単価・顧客別商品価格の場合のみ表示されます。
仕訳元出力する仕訳元の対象を選択します。

※出力元:仕訳の場合のみ表示されます。
対象機能出力する対象機能を選択します。

※出力元:全銀振込データの場合のみ表示されます。
出力対象入力候補または選択ボタンから出力する対象を選択します。
使用停止社員を含んで出力したい場合は、「使用停止社員を含む」にチェックを入れてください。

※出力元:タイムカードの場合のみ表示されます。
制限された情報閲覧制限やアクセス権が設定されている情報も出力する場合はチェックを入れます。

※出力元:フォームBOX・Priv.BOXの場合のみ表示されます。
詳細な検索条件検索条件を指定して出力する場合に入力します。

※出力元:フォームBOX・Priv.BOXの場合のみ表示されます。

補足

ターゲットリストの設定について

  • 他の社員によるターゲットリストの設定変更を禁止させるためには、「公開する」のチェックを外して、ターゲットリストを非公開設定してください。
    ※選択されたターゲットリストを公開設定している場合、他の社員も出力条件の変更が可能となり、誤って設定を変更する可能性があります。
  • 設定するターゲットリストが自動ターゲットリストの場合、
    「自部署」や「自分」など、検索するユーザーによって結果が異なる検索条件を使用すると、正しく出力されないケースがあるため利用しないでください。

Step4.設定保存

最後に「保存」ボタンをクリックして、設定を保存します。

Step5.ダウンローダー保存

ダウンローダーをインストールします。
ダウンローダーのインストール方法は、「アップローダー、ダウンローダーをインストールする」を参照してください。

送信設定を並び替える

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

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

送信設定を削除する

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

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

注意

  • 削除された送信設定を復元することはできません。
TOP