CLIツールcli-kintoneの特徴と効果的なユースケースについて

著者名:田中 信乃介( サイボウズ株式会社 (External link)

目次

はじめに

kintoneは画面上で操作する以外にも、さまざまなデータの操作方法があります。
本記事では、コマンドラインで操作できるCLIツール「cli-kintone」について、特徴と効果的なユースケースを紹介します。

kintoneのデータを操作する方法

kintoneのデータを操作するには、3つの方法があります。

  • kintoneの画面上で操作(GUI)
  • 一般的なカスタマイズ(API)
  • コマンドラインで操作(CLIツール)

GUI、API、CLIツールには、それぞれ次のような特徴があります。

操作方法 学習コスト 実行レベル 自動化 主な利用者
GUI 低い(見たままに操作できる) 簡単 自動化しづらい エンドユーザー(非IT人材含む)が利用
API 高い(プログラミングの知識が必要) プログラム開発が必要 高度な自動化が構築できる プラグイン/連携サービスの開発者(エンジニア)が利用
CLIツール 中程度(CLIの知識が必要) 比較的簡単 シェルスクリプトで簡単な自動化ができる kintoneの導入/運用に関わるIT人材(SI、情シス)が利用

今回説明するCLIツールは、GUIよりも自動化が簡単で、APIよりも学習コストは低いのが特徴です。

cli-kintoneとは?

cli-kintone とは、コマンドでkintoneのデータを入出力できるCLIツールです。
cli-kintoneには、次の4つの強みがあります。

  • 無料
  • 添付ファイルを含めたデータのインポート/エクスポートが可能
  • 定時実行が可能
  • サイボウズが開発・提供している信頼性

効果的なユースケースの紹介

ここからは、cil-kintoneを利用した4つの効果的なユースケースについて、それぞれ深堀りして紹介します。

1. 定期的なデータ連携

cil-kintoneを利用すると、バッチ処理でデータを定期的にインポート/エクスポートができます。
たとえば、毎日決まった時間にkintoneのデータを連携すると、その日の最新のデータを連携先のシステムでも確認できます。

information

cil-kintoneを利用して定期的にCSVをエクスポートできます。
連携先システムへのアップロードは、別プログラムを実行する必要があります。

具体的には次のような事例があります。

  • 各種トランザクションデータ(売上・案件・在庫・生産・購買等々)を一時間ごとに、別システムへ連携する。
  • マスターデータを一日に一度だけ、別システムへ連携する。

2. 既存システムからkintoneへデータ移行

既存システムからkintoneへデータ移行する場合にも、cil-kintoneは便利です。

cil-kintoneの強みのひとつは、添付ファイルのインポート/エクスポートができることです。
そのため、添付ファイルを含めたデータの移行ができます。

information

既存システムからCSVや添付ファイルをエクスポートするには、別プログラムを実行する必要があります。
エクスポートしたデータを、cil-kintoneを利用してインポートできます。

具体的には次のような事例があります。

  • 既存システムからkintoneへ、添付ファイルを含めてリプレイスする。
  • 複数の部署でドメインを分けて利用しているkintoneを、添付ファイルを含めてひとつのkintoneドメインに統一する。

3. バックアップ

kintone上のデータを外部サーバーなどにバックアップする目的でもcli-klintoneは活用できます。

また、 定期的なデータ連携 をすることで、常に最新のデータをバックアップできます。

4. その他(一時的な活用)

その他にも、cli-kintoneはスポット的な活用ができます。
具体的には次のような事例があります。

  • 棚卸しなどkintoneのデータをエクスポートして、表計算や、外部システムで作業する。
  • データを一括でリネームする。
  • 添付ファイルを一括でダウンロードする。

使い方

チュートリアル「はじめようcli-kintone」シリーズにまとめられています。
まずは、 イントロダクション を確認してください。

おわりに

ここで紹介したユースケースは、ほんの一部です。
ぜひ業務に沿った活用をしてみてください。

また、cli-kintoneへの機能に対する要望や質問は Github Issues (External link) で受け付けています。