東海DX伴走室
業務システム

kintoneのカスタマイズ・プラグインが増えすぎたら|棚卸しと外し方

公開  約15分で読めます
この記事の要点
  • ✓棚卸しは、システム全体のカスタマイズ、プラグインの一覧、アプリごとのJavaScript・CSSの順に書き出し、現場への聞き取りと合わせて一枚の台帳にまとめます。
  • ✓外すときは、ファイルと設定を保管してから試験用アプリで一つずつ確かめ、月に一度しか動かない処理まで見届けてから本番に反映します。
  • ✓今後は、追加の申請、ファイル名の付け方、台帳の更新、年1回の見直しを決めておき、外注先からは読める状態の元ファイルと説明書を必ず受け取ります。

1. 「誰も直せない」状態は、こうして積み上がる

kintoneは、画面に部品を並べるだけで受注台帳や工事台帳のアプリを作れます。標準の機能で足りないところは、JavaScriptやCSSによるカスタマイズと、プラグインで補えます。金額の合計を別の書き方で出す、入力の誤りを保存前に止める、帳票を出力する、別のアプリへ転記する、といった便利な動きの多くは、この二つで作られています。

困るのは、入れた人がいなくなったあとです。よくある経緯は、最初に社内の詳しい人がいくつか入れ、次に外注先が見積書や請求書の出力を作り、その後に別の担当者が無料のプラグインを試しに足す、という流れです。どれも当時は必要だったものですが、何のために入れたかの記録が残っておらず、同じ働きをする仕組みが二重に動いていることも珍しくありません。次のような様子が見えたら、積み上がりが限界に近づいています。

  • ・項目を一つ足したいだけなのに、「触ると何かが壊れるかもしれない」と誰も手を出さない
  • ・保存を押すとエラーが出るが、どのカスタマイズが原因なのか分からない
  • ・契約が切れた有料プラグインや、提供元の更新が止まったプラグインが入ったままになっている
  • ・同じアプリに、出どころの分からないJavaScriptのファイルが何本も並んでいる
  • ・外注先と連絡が取れず、元のファイルも説明書も社内に残っていない
  • ・kintoneの画面が更新されるたびに、一部の表示やボタンがおかしくなる
ポイント二つ以上当てはまるなら、新しい機能を足す前に棚卸しを先に行ってください。中身の分からないものの上に足すと、壊れたときに原因を切り分けられなくなります。

2. 棚卸しに手を付ける前に決める3つのこと

棚卸しは、いきなり設定画面を開いて消していく作業ではありません。先に「誰が」「いつ」「どこで」試すのかを決めておかないと、途中で業務が止まり、元に戻せなくなります。

担当者を一人決め、権限を確かめる

システム全体に効くカスタマイズやプラグインの一覧を見るには、kintoneシステム管理の権限が要ります。アプリごとの設定を見るには、そのアプリの管理権限が要ります。総務や情報担当の中から窓口を一人決め、必要な権限が付いているかを最初に確かめてください。複数人で同時に触ると、誰が何を変えたのか分からなくなります。

触ってよい時期と、止まると困る業務を洗い出す

月末の請求締め、給与の締め、工事の出来高の集計など、kintoneが止まると困る日は会社ごとに決まっています。その前後は本番の設定に手を入れない、と先に決めておきます。経理や工事部の責任者に「この週は触らないでほしい」という日を聞いておくと、作業の日程が組みやすくなります。

試験用のアプリを用意する

本番のアプリをいきなり変えるのではなく、アプリを再利用してコピーをつくり、そちらで試します。コピーにはJavaScriptやプラグインの設定も引き継がれますが、データは引き継がれないため、確かめたい動きに合わせて数件だけ試しの記録を入れておきます。

注意コピーした試験用アプリでも、JavaScriptの中で別アプリの番号を指定して書き込む作りになっていると、本番の別アプリにデータが入ってしまいます。転記や連携の動きがあるアプリは、試す前に書き込み先がどこかを必ず確かめてください。

3. 棚卸しの手順|どこに何が入っているかを書き出す

棚卸しの目的は、全部を理解することではなく、「どこに、何が、何のために入っているか」を一覧にすることです。中身のプログラムが読めなくても、置き場所と動く場面が分かれば、残すか外すかの判断はできます。次の順番で進めます。

図1 kintoneのカスタマイズ・プラグインを棚卸しする順番
  1. 01アプリの一覧を出す社内で使っているアプリを書き出し、最後に記録が入った時期を確かめる。何年も使われていないアプリはこの時点で分けておく
  2. 02システム全体のカスタマイズを見るkintoneシステム管理の「JavaScript / CSSによるカスタマイズ」に登録されているものを書き出す。ここに入ったものはすべてのアプリに効く
  3. 03プラグインの一覧を写すkintoneシステム管理のプラグインの画面で、入っているプラグインの名前と、どのアプリで使われているかを書き出す
  4. 04アプリごとのJavaScript・CSSを見る各アプリの設定の「JavaScript / CSSでカスタマイズ」を開き、ファイル名と並び順、URL指定かどうかを写し、ファイルをダウンロードして保管する
  5. 05現場に動きを聞くそのアプリを毎日使う人に、保存したとき・開いたときに何が起きるか、どのボタンを使っているかを聞く
  6. 06台帳にまとめるここまでの情報を一つの表にまとめ、目的が分からないものに印を付ける
システム全体のカスタマイズを先に見るのは、アプリの不具合の原因が実は全体側にある、ということがあるためです。
表1 棚卸し台帳に書く項目
項目書く内容確かめ方
置き場所システム全体/アプリ名システム管理の画面とアプリの設定
種類JavaScript/CSS/プラグイン設定画面の一覧
名前ファイル名・プラグイン名設定画面の一覧
動く場面開いたとき・保存したとき・ボタンを押したときなどファイルの中身と現場への聞き取り
目的何のために入れたか現場・前任者・外注先への聞き取り
入れた人と時期前任者名、外注先名、おおよその年社内の記録、メール、請求書
使っている人部署・担当者現場への聞き取り
契約と更新有料か無料か、契約期限、提供元の更新が続いているか契約書、提供元の案内
判断残す/外す候補/置き換え次の章の基準で決める
出典:東海DX伴走室編集部の整理

プログラムが読めなくても分かること

ダウンロードしたJavaScriptのファイルは、メモ帳などで開けば中身を見られます。全部を読む必要はありません。まずファイルの冒頭に、作った人や目的の注記がないかを見ます。次に、どの場面で動くかを示す書き方を探します。たとえば「create」は新しく記録をつくる画面、「edit」は編集の画面、「submit」は保存するとき、「index」は一覧の画面を表していることが多く、これだけで「保存のときに何かを確かめている」といった見当がつきます。

もう一つの手がかりが、フィールドコードです。アプリの項目には一つずつフィールドコードという名前が付いていて、JavaScriptはその名前で項目を指定しています。ファイルの中に出てくるフィールドコードを拾えば、どの項目を触っているかが分かります。逆に言えば、フィールドコードを変えると、それを使っているJavaScriptは動かなくなります。棚卸しの間は、フィールドコードの変更を止めておいてください。

注意JavaScriptがファイルではなくURLで登録されている場合、その中身は外部のサーバーに置かれています。前任の外注先のサーバーであれば、契約が終わると突然読み込めなくなり、アプリの動きが止まることがあります。URL指定のものは、中身を手元に保管できるか、優先して確かめてください。

現場への聞き取りで聞くこと

  • ・このアプリで毎日押しているボタンや、使っている帳票の出力はどれか
  • ・保存したときに、勝手に入る値や、出てくる注意の表示はあるか
  • ・一覧の画面で、色が付く・並びが変わるなど、標準とは違う見え方をしている所はどこか
  • ・最近、動きが変わった・おかしくなったと感じる所はあるか
  • ・使っていないボタンや、意味の分からない表示はあるか
  • ・月に一度、年に一度だけ使う機能はあるか(締め、年度の切り替えなど)

4. 残す・外す・置き換えるの見分け方

台帳ができたら、一つずつ扱いを決めます。迷ったときは「毎日の業務で使われているか」「中身と目的を説明できるか」「これからも直せる見込みがあるか」の三つで考えます。使われていて、説明もでき、直せるものは残します。どれかが欠けているものは、外すか置き換えるかを検討します。

表2 カスタマイズ・プラグインの状態ごとの扱い
状態扱い理由・やること
毎日使われ、代わりがない残す台帳と説明書を整え、次に直せる状態にする
誰も使っておらず、目的も分からない外す候補試験用アプリで外して影響を確かめてから本番へ
同じ働きをするものが二つある片方に寄せるより新しく、説明できる方を残す
kintoneの標準機能でできる標準機能に置き換える画面の更新で壊れる心配が減る
契約切れ・提供元の更新が止まった置き換えるか外す不具合が出ても直してもらえない
外部のURLから読み込んでいる手元に保管するか外す読み込めなくなると突然止まる
画面の部品を直接いじっている作り方を見直すkintoneの画面の更新で動かなくなりやすい
出典:東海DX伴走室編集部の整理

まず標準機能で足りないかを確かめる

カスタマイズで作られた動きの中には、kintoneの標準の設定でできるものが混ざっています。入れた当時は標準機能では届かなかったものもあれば、作った人が標準機能を知らなかっただけのものもあります。標準機能に置き換えられれば、プログラムを直せる人がいなくても、アプリの管理者が画面から設定を変えられるようになります。次のような動きは、標準機能で足りないかを先に確かめてください。

  • ・入力していないと保存できないようにする(必須項目の設定)
  • ・同じ番号の二重登録を防ぐ(値の重複を禁止する設定)
  • ・数量と単価から金額を出す(計算の項目)
  • ・取引先や品目のマスタから名前や単価を引いてくる(ルックアップ)
  • ・関連する別アプリの記録を一覧で見せる(関連レコード一覧)
  • ・承認の順番や状態を管理する(プロセス管理)
  • ・人によって見せる項目・触れる項目を変える(アクセス権の設定)
注意画面の見た目を変えるために、kintoneの画面の部品を直接書き換えている作りは、kintone側の画面の見直しで動かなくなることがあります。画面が更新されるたびに表示が崩れるなら、この作り方を疑ってください。

5. 要らないものを外す手順と、元に戻す準備

外す候補が決まっても、一度にまとめて外すのは避けます。複数を同時に外すと、何かが動かなくなったときに、どれが原因か分からなくなるためです。外す前に、いつでも元に戻せる準備を整えておきます。

  • ・アプリに登録されたJavaScript・CSSのファイルをすべてダウンロードし、日付を付けたフォルダに保管する
  • ・プラグインの設定画面を画面の写しで残す(外すと設定内容は戻らないことがある)
  • ・対象のアプリをテンプレートとして書き出しておく
  • ・大事なデータはCSVで書き出しておく
  • ・外す順番と、外した日を台帳に書く欄を用意する
図2 一つのカスタマイズを外すときの進め方の例
  1. 1週目保管と準備。ファイル・設定の写し・テンプレートを残し、関係する部署に外す予定を伝える
  2. 2週目試験用アプリで外し、新規作成・編集・保存・一覧表示・帳票の出力を一通り試す
  3. 3週目締めの日を避けて本番で外し、アプリを更新する。現場には「動きが変わったらすぐ連絡を」と伝える
  4. 4週目以降月の締めや月に一度の処理をまたいで様子を見る。問題がなければ台帳に「外した」と書く
  5. 次の候補一つ目が落ち着いてから、次の候補に取りかかる

本番で外したら、アプリの設定画面で「アプリを更新」を押して反映します。外したファイルは捨てずに保管フォルダに残しておき、問題が出たら同じファイルを同じ並び順で登録し直せば元の状態に戻せます。JavaScriptは並び順に意味があることが多く、順番を変えると動かなくなる場合があるため、棚卸しで写した並び順をそのまま守ってください。

注意月末の締めや年度の切り替えでしか動かない処理は、外してすぐには影響が見えません。「しばらく問題がないから大丈夫」と判断する前に、その処理の日をまたいだかを確かめてください。

プラグインを外すときに見ること

プラグインは、まず使っているアプリの設定から外し、すべてのアプリで使われなくなってから、システム管理の画面から削除します。有料のプラグインは、外したあとも契約が自動で続いていないかを、契約書や請求書で確かめます。社内の誰も契約の中身を知らないプラグインは、請求書の宛先や引き落としの明細から提供元を探すと見つかることがあります。

6. これからの記録の残し方|次の担当者が困らないために

棚卸しをしても、記録の残し方を変えなければ、数年後にまた同じ状態になります。担当者が替わっても、台帳と保管フォルダを見れば何が入っているか分かる状態を目指します。必要なのは難しい文書ではなく、決まった場所に、決まった形で書くことです。

表3 残しておく記録と置き場所
記録中身置き場所
カスタマイズ台帳棚卸しでつくった一覧を、追加・変更・削除のたびに更新kintoneの中に台帳アプリをつくる
元ファイルJavaScript・CSSの読める状態のファイル。日付ごとに保管社内の共有フォルダ
説明書何のために、どの場面で、どの項目を触るか台帳アプリの添付、または共有フォルダ
変更の記録いつ、誰が、何を、なぜ変えたか台帳アプリのコメント欄
契約の記録有料プラグインの提供元、契約期限、連絡先台帳アプリと契約書の保管場所
出典:東海DX伴走室編集部の整理

台帳はExcelでも構いませんが、kintoneの中に一つアプリをつくっておくと、変更の記録をコメントで残せて、担当者が替わっても探す場所が一つで済みます。台帳アプリ自体には、カスタマイズを入れないでおくと安心です。

図3 記録のルールを決める前と後
導入前
  • 欲しい人が、思いついたときにプラグインを足している
  • ファイル名が「custom.js」「new2.js」など中身の分からない名前
  • 変更したことを知っているのは、変えた本人だけ
  • 不具合が出ると、設定画面を一つずつ開いて原因を探す
  • 外注先が納めたファイルが、読めない形のものしか残っていない
導入後
  • 追加は窓口に申し出てから、台帳に書いて入れる
  • ファイル名を「アプリ名_働き_日付」の形でそろえる
  • 変更のたびに、台帳アプリのコメントに理由と日付を残す
  • 不具合が出たら、台帳で「保存のときに動くもの」を絞り込んで見当をつける
  • 外注先からは、読める状態の元ファイルと説明書を受け取って保管している

社内で決めておくルール

  • ・プラグインやJavaScriptを足すときは、窓口の担当者に申し出て、台帳に書いてから入れる
  • ・無料のプラグインを試すときは、本番ではなく試験用アプリで試す
  • ・JavaScriptのファイルの冒頭に、目的・作った人・作った日・触っている項目を書く
  • ・フィールドコードを変えるときは、台帳でその項目を使っているものがないか先に確かめる
  • ・年に一度、台帳と実際の設定を見比べ、使われていないものを外す候補に挙げる
  • ・担当者が替わるときは、台帳と保管フォルダの場所を引き継ぎの書類に必ず書く

7. 外注先とのやり取りと、作り直しを考える目安

外注先が作ったカスタマイズで特に困るのが、納められたファイルが、人が読めない形に変換されている場合です。プログラムは、動かすときに文字を詰めて読みにくくした形にすることがあり、その形しか残っていないと、別の会社に直してもらうのも難しくなります。前任の外注先と連絡が取れるなら、棚卸しのついでに、読める状態の元ファイルと説明書が残っていないかを問い合わせてください。

これから外注するときに取り決めること

  • ・読める状態の元ファイルを、納品物として受け取る
  • ・何のために、どの場面で、どの項目を触るかを書いた説明書を受け取る
  • ・ファイルを外部のURLで読み込ませず、自社のアプリに登録する形で納めてもらう
  • ・納めたものを社内や別の会社が直してよいかを、契約の中で確かめておく
  • ・使っているプラグインがあれば、名前・提供元・有料か無料かを一覧でもらう

棚卸しでは片付かないとき

棚卸しをしてみると、外せるものより、外せないものの方が多いことが分かる場合があります。受注から出荷、工事の受付から請求まで、業務の流れの大部分がカスタマイズでつながっていて、一つを直すと別の所に響く状態です。この場合は、一つずつ外すより、業務の流れを書き出したうえで、kintoneの中で作り直すのか、別のしくみに移すのかを考える段階に来ています。

どちらを選ぶにしても、棚卸しでつくった台帳はそのまま役に立ちます。「どの業務で、どんな動きが必要だったか」が一覧になっているため、作り直しの範囲を決めるときも、見積を比べるときも、抜け漏れを防ぐ材料になります。まずは台帳をつくり、目的の分からないものに印を付けるところまで、社内で進めてみてください。

8. よくあるご質問

Q
プログラムが分かる社員がいなくても、棚卸しはできますか。
A
できます。棚卸しで必要なのは、設定画面に何が入っているかを写すことと、現場にどんな動きをしているかを聞くことです。ファイルの中身は、どの場面で動くか、どの項目を触っているかの見当をつけるために見る程度で足ります。外すかどうか迷うものだけ、詳しい人に見てもらってください。
Q
使っていないように見えるプラグインは、すぐに削除してよいですか。
A
すぐには削除しないでください。月に一度や年に一度しか使わない機能かもしれません。まずアプリの設定から外し、設定画面の写しを残したうえで、締めの日をまたいで様子を見ます。どのアプリでも使われていないと確かめてから、システム管理の画面で削除します。
Q
前任の外注先と連絡が取れません。どうすればよいですか。
A
アプリに登録されているファイルは、設定画面からダウンロードできるので、まず手元に保管してください。URLで外部から読み込んでいるものは、読み込めなくなると動きが止まるため、優先して中身を確保するか、代わりを検討します。読めない形のファイルしかない場合は、その動きを標準機能で置き換えられないかを先に確かめます。
Q
棚卸しにはどれくらいの時間がかかりますか。
A
アプリの数と、カスタマイズの入り方によって大きく変わります。書き出しと聞き取りまでは数日でも進められますが、外す作業は一つずつ試して締めの日をまたぐため、月単位で考えておくと無理がありません。
Q
今後、新しいプラグインを入れるのは避けた方がよいですか。
A
避ける必要はありません。窓口に申し出て台帳に書く、試験用アプリで試す、有料なら契約期限を記録する、という手順を守れば、入れたものの中身が分からなくなる事態は防げます。入れる前に、標準機能でできないかを一度確かめる習慣も付けてください。
編集部
この記事を書いた人
東海DX伴走室編集部
東海4県の製造業・建設業のDXを支援しています。制度の内容は、公開日時点の公的機関の資料をもとにしています。
まずは30分、
無料でご相談ください
売り込みはしません。つくらないほうがよい場合は、そうお伝えします。
フォームで相談する(無料)
訪問でも、オンラインでも伺います。