カスタマイズ自動実行とは何ですか
kintone のカスタマイズ JavaScript は、本来だれかがブラウザで画面を開いたときにしか動きません。そのため「毎朝 7 時に再計算する」「レコードが追加されたら別アプリを更新する」といった処理を、画面用の JavaScript のまま自動で動かすことはできません。
カスタマイズ自動実行は、お客様の代わりにブラウザで kintone の画面を開くことで、この問題を解決します。弊社のサービスが、お客様の登録した「自動実行ユーザー」として kintone にログインし、お客様ごとに分かれた実行環境で、指定された画面を開きます。カスタマイズ JavaScript はいつもどおり動き、その様子は録画されます。
結果(成功・失敗、録画、コンソールログ、失敗時のスクリーンショット)は、お客様の kintone 環境にある契約管理アプリに、実行ごとのレコードとして記録されます。
どのような方に向いていますか
- kintone の構築・開発を行うシステムインテグレーター。 画面用に書いたカスタマイズ JavaScript を、定期実行やレコード操作に連動した実行へそのまま転用したい場合。
- kintone の専任担当者がいる企業。 プラグインを導入して自分で試せる方が、外部のバッチ用サーバーを用意せずに自動処理を組みたい場合。
導入から契約、解約まで、すべてお客様自身の操作で完結します。弊社への問い合わせや打合せは必要ありません。
どのように動きますか
- トリガーが発生するスケジュール(毎時・毎日・毎週・毎月)、レコード操作(kintone の Webhook)、または手動の「今すぐ実行」。
- 実行環境が画面を開くお客様ごとに分かれた実行環境が、自動実行ユーザーとしてログインした状態の実際のブラウザで、ジョブで指定された画面を開きます。
- カスタマイズ JavaScript が動く人が画面を開いたときと同じイベントが発生し、いつもの JavaScript がそのまま実行されます。必要なら、画面のボタンを押すなどの操作も行います。
- 結果と録画が記録される成功・失敗、録画、コンソールログ、失敗時のスクリーンショットが、お客様の kintone の契約管理アプリに記録されます。失敗は kintone の通知で知らせることができます。
「いつ」「どの画面を開くか」「何をもって完了とするか」を決めたものを「ジョブ」と呼びます。ジョブは、kintone のプラグイン設定画面で作成します。
何ができますか
| トリガー | スケジュール(毎時・毎日・毎週・毎月の決まった時刻、日本時間)、レコード操作(追加・編集・削除、ステータスの更新、コメントの書き込み)、手動実行。 |
|---|---|
| 開く画面 | レコード一覧、レコード詳細、レコード編集、レコード追加、同じアプリ配下の指定した URL。編集・追加画面では保存ボタンまで押せます。 |
| 対象レコード | レコード操作のトリガーでは操作されたレコード。スケジュール・手動では、レコード番号の指定、または絞り込みクエリに合うレコードを順に処理。 |
| 画面を開いた後の操作 | 入力・クリック・待つ、を順に実行。カスタマイズが画面に追加したボタンを押す用途に使えます。 |
| 完了の判定 | JavaScript から done() を呼ぶ(推奨)、通信が止まったら完了、指定した要素が現れたら完了。 |
| 記録 | 実行ごとの録画、コンソールログ、失敗時のスクリーンショットを、kintone の契約管理アプリに保存。 |
| 失敗時の対応 | 自動やり直し(回数を設定)、kintone の通知設定による失敗の通知。 |
| 契約の管理 | 契約状況、同時実行数、利用分析(待ち時間や稼働率)、請求書、実行ログの確認と、契約・同時実行数の変更・解約を、kintone 内の契約管理アプリで実施。 |
設定の詳細は導入ガイドをご覧ください。
使う前に知っておくべき条件と制約は何ですか
- kintone のコース: スタンダードコース以上が必要です(JavaScript カスタマイズとプラグインを使うため)。
- 必要な権限: 契約管理アプリの作成には、テンプレートファイルからアプリを作成できる権限が必要です。自動実行したいアプリを追加するとき(プラグインの読み込み)には、kintone システム管理者の権限と、そのアプリの管理権限が必要です。
- 自動実行ユーザー: 人と兼用しない専用ユーザーを 1 人用意します。ログイン名とパスワードでログインできる必要があり、2 要素認証を有効にしたユーザーと、SAML 認証でしかログインできないユーザーは使えません。kintone のライセンスを 1 ユーザー分使います。
- IP アドレス制限: 制限をしている環境では、契約管理アプリに表示される弊社の固定の送信元 IP アドレスを許可するか、セキュアアクセス(クライアント証明書)を使います。
- Webhook が届かない操作: kintone の仕様により、ファイルからの読み込み、一括削除、REST API での複数レコードの一括追加・削除では、レコード操作のトリガーは動きません。
- 実行開始までの時間: 実行環境は、実行するものがあるときだけ起動します。同時実行数に空きがあれば、通常は数秒で始まります。長く実行がなかった後の最初の実行や、弊社がサービスを更新した直後は、数十秒かかることがあります(いずれも参考値であり、保証する時間ではありません)。
- kintone の画面変更: kintone のアップデートでログイン画面や保存ボタンの作りが変わると、一時的に実行できなくなることがあります。その場合は弊社側で対応します。
認証情報とデータはどう扱われますか
- ブラウザを動かす実行環境は、お客様ごとに分かれています。ほかのお客様と使い回されることはありません。
- 実行環境には運用基盤の管理権限を持たせておらず、そのお客様自身の実行依頼だけを受け取れる構成です。
- 登録された自動実行ユーザーの認証情報は暗号化して保管し、登録後に再表示することはありません。
- 自動実行ユーザーのパスワードは、お客様のカスタマイズ JavaScript を動かす実行環境には渡しません。ログインは、お客様の JavaScript を動かさない別の環境で行い、実行環境にはログイン済みの状態だけを渡します。実行結果の kintone への記録も、その別の環境で行います。Basic 認証の情報とクライアント証明書は、ブラウザが kintone に接続するために必要なので、実行環境に渡されます。
- 録画は弊社側で 30 日間保存し、お客様の kintone の契約管理アプリにも保存します。実行履歴は弊社側で 90 日間保存します。
- データは 日本国内(東京)のデータセンターに保管します。
- 弊社のサービスの API は、kintone(cybozu.com)が中継した要求だけを受け付けます。kintone の外から直接呼び出すことはできません。
料金はいくらですか
同時実行数 1 件 月額 9,000 円 (税抜)
料金は、ご契約の同時実行数(同時に実行できるジョブの数)で決まります。同時実行数を超えた依頼は、空きが出るまで順番に待ちます。同時に動かしたいジョブが増えたら、同時実行数を増やします。同時実行数は、ご契約後いつでも変更できます。ジョブの数と実行回数に上限はありません。
無料お試しは 14 日間(自動実行ユーザーを登録した時点から数えます)で、同時実行数 1 件、ジョブ 5 件、実行 420 回まで使えます。クレジットカードの登録は不要で、お試しの終了後に料金が自動で請求されることはありません。
どうやって始めますか
申し込みフォームはありません。契約管理アプリのテンプレートをダウンロードし、お客様の kintone に読み込むところから始めます。
- 契約管理アプリを作成するkcae-contract-app.zip を保存し、kintone で「アプリを作成」→「テンプレートファイルを読み込んで作成」を選んで、zip を指定します。zip は展開せず、そのまま使います。このアプリにプラグインは必要ありません。
- お試しを開始する作成したアプリを開くと、契約の画面が表示されます。利用規約とプライバシーポリシーへの同意のチェックを入れて「お試しを開始」を押すと、無料お試しがすぐに始まります。認証情報や支払情報の入力は不要です。
- 自動実行ユーザーを登録する同じ画面の「共通設定」で、自動実行ユーザーのログイン名とパスワードを登録します。登録のときに、弊社がその kintone に実際に接続して確認します。お試しの 14 日間は、この登録ができた時点から数えます。実行の結果は契約管理アプリに記録されるため、記録のための設定は必要ありません。
- 自動実行したいアプリを追加する同じ画面の「ジョブ」に、自動実行したいアプリの ID(アプリの URL の
/k/の後の数字)を入力して「追加してジョブを作成」を押します。「カスタマイズ自動実行」プラグインが kintone に読み込まれてそのアプリに追加され、プラグイン設定画面が開きます。この手順には kintone システム管理者の権限が必要です。 - ジョブを作る開いたプラグイン設定画面で、ジョブ(トリガー、開く画面、完了の条件)を作成します。
ダウンロードおよびご利用にあたっては、利用規約とプライバシーポリシーをご確認ください。
よくある質問
kintone のカスタマイズ JavaScript を定期実行(スケジュール実行)できますか。
できます。トリガーに「スケジュール」を選ぶと、毎時・毎日・毎週・毎月の決まった時刻(日本時間)に、指定した画面を開いてカスタマイズ JavaScript を動かします。
既存のカスタマイズ JavaScript を書き換える必要はありますか。
処理そのものを書き換える必要はありません。処理の最後に完了の合図(window.__AUTO_EXECUTOR__?.done())を 1 行足す方法を推奨しています。JavaScript を書き換えられない場合は、「通信が止まったら完了」「指定した要素が現れたら完了」という判定方法を選べます。
2 要素認証を有効にしたユーザーを自動実行ユーザーにできますか。
できません。2 要素認証を有効にしたユーザーと、SAML 認証でしかログインできないユーザーは、自動実行ユーザーにできません。ログイン名とパスワードでログインできる専用ユーザーを用意してください。
IP アドレス制限をしている環境でも使えますか。
使えます。弊社の送信元 IP アドレスは固定で、契約管理アプリに表示されます。この IP アドレスを cybozu.com 共通管理で許可するか、セキュアアクセス(クライアント証明書)を使ってください。
同時実行数とは何ですか。何が 1 つに数えられますか。
同時に実行できるジョブの数です。1 つの実行(ブラウザで画面を開いてから完了するまで)が、同時実行数 1 件を使います。同時実行数が 1 件なら一度に 1 つ、3 件なら一度に 3 つまで実行できます。これを超えた依頼は、空きが出るまで順番に待ちます。ジョブの数や 1 か月の実行回数は、同時実行数には関係しません。
無料お試しの期間や上限を過ぎると、どうなりますか。
実行が行われなくなります。自動的に有料契約へ切り替わることはなく、料金が自動で請求されることもありません。期間の終了後、またはジョブ数・実行回数の上限を超えた分の実行は、画面を開かずに「失敗」として記録され、気づけるように同じ理由の最初の 1 件は契約管理アプリにも記録されます。続けて使う場合は、契約管理アプリから有料契約の手続きをしてください。
自動実行ユーザーのパスワードはどのように保管されますか。
暗号化して弊社のサービス側に保管します。登録後に画面へ再表示されることはなく、kintone にも保存しません。契約管理アプリの中に保存されるのは、接続用のキーだけです。パスワードは、お客様のカスタマイズ JavaScript を動かす実行環境には渡しません。ログインは、お客様の JavaScript を動かさない別の環境で行い、実行環境にはログイン済みの状態だけを渡します。実行結果の kintone への記録も、その別の環境で行います。Basic 認証の情報とクライアント証明書は、ブラウザが kintone に接続するために必要なので、実行環境に渡されます。