本記事ではWindowsのタスクスケジューラ機能を利用してホットプロファイルに登録されているデータを出力する「データ出力ツール」についてご案内します。
2023年12月22日リリースのデータ出力ツール(Ver.10.1.0)からAPIキーを利用してのログイン方法に変更となります。
最新のデータ出力ツールはこちらからお申込みください。
データ出力ツールとは?
外部システムとの連携のために、出力される複数種類のCSVファイル(名刺、リード、商談、商談明細、会社、目標管理、報告)を、定期的に指定フォルダに出力するツールです。
特徴
- お客様所有のwindows端末より定期的(Windowsのタスクスケジューラの機能)にデータを入手できます
- 定型フォーマットにて出力されますので外部連携を組むことが容易です
(*バージョンアップ等によりフィールドの配列に変更がある場合がありますので注意ください) - 差分のみの取得など効率の良いデータ取得が可能です
ご利用の流れ
データ出力ツールご利用の流れは以下の通りです。
稼働環境
.NET Framework 4.8が必要となります。
OS |
|
CPU | OS推奨値以上 推奨:クアッドコア Intel Xeon 2.33GHz同等以上 |
メモリ | OS推奨値以上 推奨: 4GB以上 |
HDD |
インストールには、システムドライブに5MB以上の空き容量が必要です。 出力ファイルの配置先となるドライブは、十分な空き容量のあるシステムドライブ以外のローカルドライブを指定されることを推奨します |
Step1:接続設定(接続確認)
1. データ出力ツール.zipを任意のフォルダに解凍します。
2. フォルダ内「AboutOutputTool.exe」を右クリックして「管理者として実行」を選択します。
3. 「HotProfileデータ出力ツール」ログイン画面が表示されることを確認します。
4. ホットプロファイルのWebアプリ(ブラウザ)を開き、APIキーを確認します。
※APIの発行方法についてはこちらをご確認ください。
5. Webアプリ(ブラウザ)で確認したAPIキーを入力後 [ ログイン確認 ] ボタンをクリックし、
接続ができることを確認します。
6. 出力先フォルダ、対象期間を入力し [ 保存 ] ボタンをクリックします。
※「保存済みAPIキー」にマスクしたAPIキーが表示されます。
項目名 | 説明 |
出力フォルダ名 | データの出力先フォルダを指定します。 出力フォルダ名は、出力ツールを実行する端末内のフォルダを推奨しています。 ※クラウド上への保存も可能ですが、ネットワークの接続状態によってファイルが破損し、正しく保存できない可能性がございます |
対象期間 |
以下いずれかで設定します
|
文字コード |
以下から選択します
|
※同一端末上で設定内容に変更がある場合は、再度AboutOutputTool.exeを実行してください
Step2:スケジュール登録
Windows OS 標準のタスクスケジューラより定期的にCSVファイルを出力する設定を行います。
はじめに:タスクスケジューラを起動
1. Windowsボタンを右クリック
2. ファイル名を指定して実行
3. taskschd.msc と入力し、[ OK ] をクリック
※Windowsボタン右クリック > コントロールパネル > 管理ツール > タスクスケジューラ でも同様に起動できます
4. [ タスクスケジューラライブラリ ] を右クリックして [ タスクの作成 ] を選択します
2.全般/トリガータブの設定
下記の通り設定してください
項目名 | 説明 |
名前 | (例)商談情報出力 など任意の名前をつけてください *スケジュールを管理するための名前です |
ユーザーがログオンしているかどうかにかかわらず実行する |
チェック |
最上位の特権で実行する |
チェック |
構成 |
[Windows 7、Windows Server 2008R2] を選択 |
設定 |
毎日 |
開始 |
開始時刻は22:00~6:59の間より指定してください |
停止するまでの時間 |
チェック |
有効 |
チェック |
3.操作タブの設定
出力したいデータにあわせて下表の「引数の追加」部分を変更し、設定してください
項目名 | 説明 |
プログラム/スクリプト | [ 参照 ] ボタンよりAboutOutputTool.exeを指定してください |
引数の追加 ※名刺を出力したい場合 |
全件出力する場合:[/b /t:business_cards] |
引数の追加 ※リードを出力したい場合 |
全件出力する場合 [/b /t:leads] 差分出力する場合 [/b /t:leads /difference] |
引数の追加 ※報告を出力したい場合 |
全件出力する場合 [/b /t:daily_reports] 差分出力する場合 [/b /t:daily_reports /difference] |
引数の追加 ※商談を出力したい場合 |
全件出力する場合 [/b /t:deals] 差分出力する場合 [/b /t:deals /difference] |
引数の追加 ※会社を出力したい場合 |
全件出力する場合 [/b /t:clients] 差分出力する場合 [/b /t:clients /difference] |
開始 | AboutOutputTool.exe の配置されているフォルダパスを入力します 例: C:\データ出力ツール\AboutOutputTool.exe 上記の場合は、[C:\データ出力ツール] |
※名刺とリード、など複数のデータを出力したい場合は、引数別にタスクスケジューラでタスクを複数登録してください
※タスクは二重起動ができないため、前のタスクによるデータの出力が終わる時間を見込んだうえで、次のタスクの起動時間を設定してください
<差分出力の動作>
※差分出力の場合は 部分のデータを含みません
※差分処理を止め、初回の全件取得の部分から実行しなおしたい場合は、
[データ出力ツール\OutputDatetime_deals.enc] を削除して下さい
4.条件/設定タブの設定
下記の通り設定してください。
※[ 設定 ] タブの設定完了後、[ OK ] ボタンをクリック
項目名 | 説明 |
コンピューターをAC電源で使用している場合のみタスクを開始する | チェックを外してください |
タスクを実行するためにスリープを解除する | チェック |
タスクを要求時に実行する | チェック |
タスクを停止するまでの時間 | チェック *開始から終了までが22:00~7:00におさまるよう指定してください |
要求時に実行中のタスクが終了しない場合、タスクを強制的に停止する | チェックを外してください |
5.アカウント情報の入力
タスクを実行するユーザーのアカウント情報を入力し、[ OK ] をクリックしてください。
※各ユーザーは以下の権限が必要です
項目名 | 説明 |
タスクスケジューラの実行ユーザー | 本端末のローカルの管理者権限 |
出力ファイルの利用ユーザー | 本端末のローカルの管理者権限 |
連携システムから本ファイルの読み取りユーザー | 本端末のローカルの管理者権限 |
※出力ツールが稼働する時間にコンピューターの電源が入っている必要があります
自動で再起動が行われたり、電源が落ちないようお気を付けください
また、ネットワークに接続されている必要もあるので、接続が切れないよう注意してください
Step3:出力
Step2で設定したスケジュール・内容でデータ出力がされるかご確認下さい。
補足事項
ファイル構成
ファイルは出力するデータにより異なり、下記の構成で出力されます。
■名刺の場合
[指定のデータ出力フォルダ]
└yyyymmddhhmmss
└ business_cards.csv
■リードの場合
[指定のデータ出力フォルダ]
└leads_yyyymmddhhmmss.csv
■会社の場合
[指定のデータ出力フォルダ]
└yyyymmddhhmmss
└clients.csv
■報告の場合
[指定のデータ出力フォルダ]
└yyyymmddhhmmss
└daily_reports.csv
■商談の場合
[指定のデータ出力フォルダ]
└yyyymmddhhmmss
└clients.csv
└deals.csv
└deals_details.csv
└leads.csv
└objectives.csv
名刺データ
- 第二言語モードをご契約がない場合でも第二言語の項目が出力されます
- 名刺画像は出力対象外です
- カスタム項目は出力対象外です
※名刺データ以外(リード、会社、報告、商談、商談明細、目標)はカスタム項目も出力されます(カスタム項目の出力順序については次項「カスタム項目の出力順序」をご覧ください)
カスタム項目の出力順序
■リードの場合
「共通テンプレート(リード)」の表示項目設定の順に従います。(下図参照)
「ステータス:無効」や「共通テンプレート(リード)」の表示項目設定で選択されていないものは出力されません
<共通テンプレートの確認手順>
- Webアプリにログインし、[ 歯車アイコン ] > [ 表示項目設定 ] > [ 表示テンプレート管理 ] を選択します
- 「表示テンプレート名」にて「共通テンプレート(リード)」をクリックします
■報告/商談/会社の場合
作成された順序で出力されます。
※「ステータス:無効」は出力されません
出力の対象
■名刺の場合
出力ツールのログイン情報に入力されたユーザが閲覧できる範囲のデータが出力対象です。
他のユーザが「非公開」として登録した情報や、閲覧制限により閲覧できないデータは出力対象外となります。
例)Aさんが非公開で登録した名刺
出力ツールをBさんのログイン情報で設定し、名刺情報を出力した場合
⇒Aさんが非公開として登録した名刺は、Bさんが閲覧できないため、出力対象外となります
■リード/報告/商談の場合
出力ツールのログイン情報として入力したユーザに関わらず全てのデータが出力対象です。