はじめに
この記事は、はじめてcli-kintoneを利用して、特定のフォルダへCSVファイルを作成する、Windowsユーザーへ向けた記事です。
この記事で目指す内容は以下です。
- 毎時、kintoneの最新データがCSVへダウンロードされる
この記事は以下の解説をします
- kintoneのアプリからデータを取得するbatファイルを書く
- batファイルをタスクスケジューラーに登録する
- タスクスケジューラーを試験する
この記事で解説する手順を実行すれば、Windows上でkintoneのデータを自動的にCSVとして取得できるようになります。
それでははじめましょう。
kintoneのアプリからデータを取得するbatファイルを書こう
batファイルはコマンドプロンプト(cmd.exe)で実行されるファイルです。
cli-kintoneはkintoneからデータを取得するプログラムで、batファイルから呼び出すことができます。
ファイルを作る
まず、適当なフォルダを作って、ファイルを作成します。テキストファイルで大丈夫です。
できたら、名前をつけます。"get-kintone.bat"としましょう。
cli-kintoneを手に入れよう
👆のURLへアクセスします。
こんな感じのページになると思います。
そこで、末尾が "win.zip" となっている、ファイルをダウンロードします。
ダウンロードしたファイルを開くと、"cli-kintone.exe"というファイルがありますね。
これをコピーします。
先ほど作ったフォルダに貼り付けます。
これで、get-kintone.batとcli-kitnone.exeが並んでいるフォルダができました。
kintoneの設定を取得しよう
kintoneで、CSVに出力したいアプリへ行きます。
アプリへ行ったら、URLの下記の部分を拾います。
280ですね。
これは、アプリID という数値です。アプリIDはよく使うので、覚えておいてください。
次に、URLの下記の部分を拾います。
xxxxx.cybozu.comですね。
これは、ドメイン という値です。ドメインもよく使うので、覚えておいてください。
そうしたら、歯車マーク⚙から、設定画面を開きます。
設定＞APIトークン
アクセス権をつけてあげます。（閲覧にチェックが入っていれば大丈夫。）
できたら、APIトークンの文字列を拾います。
ここまでで、取得できている値は以下の通りです。
- アプリID
- ドメイン
- APIトークン
get-kintone.batを編集してみよう
先ほど作ったget-kintone.batファイルに戻りましょう。
これを、テキストエディタで開きます。メモ帳でオーケーです。
できたら、上記のようになるように記述します。
以下をコピーペーストでもOK
cli-kintone.exe record export --base-url https://[example.cybozu.com] --app [アプリID] --api-token [トークン] >タイムカードデータ.csv
pause
">タイムカードデータ.csv"とありますが、">[ファイル名]"で、コマンドが実行された結果(標準出力)をファイル名のファイルに書き出すことを表しています。
ファイル名の部分は、出力したいフォルダと合わせて書くことができますが、今回は同じ場所に出力させるので、そのままファイル名を書いています。
pause は、実行を途中で止める命令です。
で、この文字列の、[example.cybozu.com], [アプリID], [トークン]を書き換えます。
[example.cybozu.com]をドメインに書き換える
[アプリID]をアプリIDに書き換える
[トークン]をAPIトークンに書き換える
例えば、こんな感じです。
書き換えたら、保存します。この時、「名前をつけて保存」を選んでください 。
👆図の部分が、デフォルトでは"utf-8"になっているはずです。これを"ANSI"に変えてあげてください。
get-kintone.batを実行してみよう
get-kintone.batを ダブルクリック してみましょう。
黒い画面が出て、止まったら、画面を消すと、ファイルができているはずです。
これで、kintoneからCSVを取得することができるようになりました。
このCSVファイルを、普通のExcelファイルで開くと、文字化けしてしまいます。
きれいなデータとして開きたい場合は、以下のようにします。
Excelを空の状態で開いて、
データ＞データの取得～ファイルから＞テキストまたはCSV
ここでファイルを選んであげると、Excelにきれいにロードされます。
pauseを除去しよう
ここまで上手に動くようになったら、pauseの文を除去します。
これでもう一度動かしてみてください。
黒い画面が一瞬出て、すぐに消えるようになりましたね。
タスクスケジューラへ登録しよう
まずはタスクスケジューラーを見つけましょう。
Windowsの左下にある検索窓を開いて、"タスク"などのキーワードで検索します。
いますね。タスクスケジューラを開きます。
基本タスクの作成から、作成画面を開きます。
名前を入れましょう。好きな名前で構いません。
次へを押します。
毎日
ここは何も変えない
プログラムの開始を選ぶ
この画面で、get-kintone.batファイルを選んでおきます。
まだ、【開く】を押さないで。図の〇のあたりをクリックします。
こうなるので、右クリックをして、フォルダのパスをコピー しておきます。
コピーしたら、【開く】を押す。
開くを押すと、プログラム(get-kintone.bat)が登録されましたね。
👆の開始（オプション）のところに コピーしたフォルダのパス を設置します。
こうなる。そうしたら、【次へ＞完了】で保存します。
get-kintoneが作成されました。
作成したタスクの設定を変更しよう
作成したタスクの、設定を変更することができます。
タスクを 右クリック＞プロパティ を押します。
トリガー＞編集
「1時間ごとに1日間、get-kintone.batを実行するタスク」を0時に開始して、1日間隔で繰り返します。
👆のようになります。
これで設定は完了です。
タスクを実行してみよう
このまま0時まで待てば実行されますが、実際に試してみましょう。
タスクを右クリックします。
👆で「実行する」をクリック。
クリックすると、何も起きません。
そこで、少し待って、F5ボタンを押下すると、画面が更新されます。
「この操作を正しく終了しました」と出ていればOKです。
もし実行が終わらない場合、pause文を消し忘れています。確認してみてください。
まとめ
- cli-kintone(くりきんとん)のダウンロードのしかた
- batファイル（バッチファイル）を利用したcli-kintoneの呼び出し方
- タスクスケジューラーへのタスク登録
- タスクスケジューラーへ登録されたタスクの変更と実行
以上の手順を解説しました。
参考にしたリンクは以下です。
できるようになりましたら、こちら記事も大変参考になります。
この記事は以上です。ありがとうございました。
kintoneのプラグイン開発や研修などを行っています。
お仕事のお話はこちらまで。