gusuku Customineで作成した各種カスタマイズを、まとめてkintone上にバックアップして管理したいというご要望にお答えし、「カスタマイズ管理アプリのレコードを更新する」という「やること」がリリースされました。
こちらのやることはJob Runnerによるカスタマイズになりますので、一度設定して「直ちに実行」で動作を確認したあとは、スケジュールを設定して定期実行タスクを実行することで、以後自動的に組織内に作成される全てのカスタマイズのバックアップがkintoneに保存されるようになります。ぜひご活用いただければと思います。
利用を開始するための事前準備
「Customine カスタマイズ管理アプリ」の準備
まず、以下のフィールドを持ったCustomine カスタマイズ管理アプリをkintoneアプリとして作成します。弊社で作成したアプリのテンプレートもございますので、こちらをご利用いただくことも可能です。
Customine カスタマイズ管理アプリ テンプレート（70Kbyte）
アプリを作成したら、「kintone API トークン」を1つ生成してください。アクセス権は「レコード閲覧」「レコード追加」「レコード編集」の各権限が必要です。
必要なフィールドコード一覧
「gusuku API キー」の準備
gusuku API キーも利用しますので、gusuku 共通管理画面のAPIキータブよりAPIキーを作成してください。
カスタマイズのアクセス権限を設定している組織の場合、このgusuku APIキーにカスタマイズの表示権限を付与する必要がありますのでご注意ください。詳細は後述します。
定期実行タスクの設定と実行
事前準備が完了したら、新しいカスタマイズとして定期実行タスクを作成してください。カスタマイズの内容としては、これだけになります。
作成したら一度「ジョブ生成・設定」をクリックし、「直ちに実行」をクリックして動作を確認してみてください。
問題なく設定されている場合でも、初回の実行時には作成済みのカスタマイズ数に比例して時間がかかりますので、しばらくお待ちください。
途中でなにかエラーが出た場合、そのエラーが出る前までの分はkintoneアプリに登録されます。エラー内容を確認し、設定などを修正して再度「直ちに実行」をしてみてください。
2回目以降の実行は、更新がなければそれほど時間はかからず終了します。
組織が所有しているすべてのカスタマイズがkintoneに保存されれば、動作確認は完了です。お好みのスケジュールを設定・保存し、自動的にバックアップとして実行されるようにジョブをセットしておいてください。
カスタマイズ管理アプリに作成されるレコードの内容
作成されるレコードの内容は以下のようになります。 注意が必要なフィールドは以下のとおりです。
カスタマイズID： Customineが管理するカスタマイズのID。重複不可の必須フィールドで、このIDは変更してはいけません。
リビジョン： カスタマイズのリビジョン。変更があるとこのリビジョンが上がっていきます。
カスタマイズファイル： Customineから「カスタマイズをファイルへ書き出し」でダウンロードできるカスタマイズファイルです。常に、更新された時点で最新のファイルが1つ添付されます。
カスタマイズファイルは、カスタマイズ一覧画面の「Customineファイルから読み込み」や、作成画面の「カスタマイズをファイルから読み込み」でそのまま読み込むことが出来るファイルです。
また、リビジョンごとに1つのファイルが更新されていきます。ですので、kintoneの変更履歴から過去のファイルをダウンロードして、その時点のカスタマイズを読み込むことで復元する、といった操作も可能となります。
「カスタマイズのアクセス権限設定」を設定している場合に必要な権限設定について
カスタマイズのアクセス権限設定についてで解説している、アクセス権限設定をしている場合、この「カスタマイズ管理アプリのレコードを更新する」もその設定に従います。
権限は「カスタマイズ表示のみ可能」な権限が必要となりますので、これを設定してください。具体的には以下のステップで設定することをおすすめいたします。
カスタマイズのアクセス権限設定について の「グループを用いたカスタマイズのアクセス権限設定」節で紹介されているように、グループを作成する（例：「カスタマイズ管理」という名前のグループを作成）
このグループのメンバーとして、「gusuku API キー」の準備のところで作成したAPIキーを追加して保存
「kintoneアプリ管理」アプリで、すべてのアプリに対して作成したグループを「カスタマイズ表示のみ可能ユーザー」として追加
上記の設定で、作成したgusuku APIキーにすべてのアプリの「カスタマイズ表示のみ可能」権限を付与することが可能です。
まとめ
ぜひ「カスタマイズ管理アプリのレコードを更新する」を設定して、カスタマイズの履歴管理にご活用ください！
設定作業についてご不明な点があれば、チャットサポートまでお問い合わせいただければと思います。