top of page

kintoneのER図・アプリ間の依存関係を確認する方法|変更前の点検と記録

14 時間前
読了時間: 6分

kintoneのアプリ同士、どこでつながっているか説明できますか?

「この顧客マスタを変更すると、どのアプリに影響する?」「前任者が作ったアプリの関係が分からない」。アプリが増えると、個別の設定を見ただけでは全体のつながりを把握しにくくなります。


kintoneのER図やアプリ関係図を作るときは、アプリを線で結ぶだけでなく、つながりの種類・向き・根拠となる設定を残すことが大切です。この記事では、関係を調べる手順と、AppInsight for kintoneを使った確認方法を紹介します。


1.ER図で整理すること、設定で確かめること

ER図は、データのまとまりとその関係を表す図です。kintoneでは、まず「どのアプリが、どのアプリの情報を利用しているか」を整理すると、保守や引き継ぎに役立ちます。


ただし、アプリ間に線があるだけでは、データをコピーするのか、関連するレコードを表示するのかまでは分かりません。厳密なデータ設計としてER図を使う場合は、キーになる項目や1対多などの関係も、実際の設定・業務ルールに沿って確認します。


2.最初に分けたい3種類のつながり

ルックアップ:別アプリの情報を参照し、値を取得してコピーします。調査では、関連付けるアプリ、コピー元のフィールド、ほかにコピーする項目を記録します。参照元のレコードを変更しても、すでに取得した値が自動で追従するわけではありません。


関連レコード一覧:条件に合う関連レコードを一覧表示する機能です。値をコピーするルックアップとは区別し、参照先アプリと表示条件を確認します。


アプリアクション:開いているレコードの値を使い、同じアプリや別アプリに新しいレコードを作成する機能です。コピー元・コピー先の項目を確認します。基本的な違いは、kintone公式ヘルプ「アプリ間でデータを連携する」でも確認できます。


3.顧客・案件・請求の例で、線の意味をそろえる

たとえば、次の構成を考えます。これは説明用の例であり、特定のお客様の環境を示すものではありません。


① 案件管理 → 顧客管理:顧客コードをルックアップし、顧客名を取得する。

② 顧客管理 → 案件管理:顧客コードが一致する案件を関連レコード一覧に表示する。

③ 案件管理 → 請求管理:アプリアクションで案件名などをコピーし、請求レコードを作成する。


この例の矢印は「設定があるアプリ → 参照先またはコピー先」を表します。①と②には同じ2つのアプリが登場しますが、役割は異なります。図には「ルックアップ」「関連レコード」「アクション」と線の種類を添え、矢印の意味も凡例に残しましょう。


4.アプリ間の依存関係を確認する5つの手順

手順1:対象を決める。

最初から全アプリを一枚にまとめず、変更予定のアプリと、その業務で使う周辺アプリから始めます。アプリ名だけでなくアプリIDも控えると、似た名前のアプリを区別できます。


手順2:設定上のつながりを集める。

ルックアップ、関連レコード一覧、アクションの設定を確認します。「このアプリが参照する先」に加え、「このアプリを参照している別アプリ」も調べます。対象アプリだけを見て調査を終えないことがポイントです。


手順3:つながりを一段先までたどる。

顧客情報を案件に取り込み、その案件から請求を作る運用なら、案件だけでなく請求側も確認候補になります。ただし、線がつながっていることと、変更が自動で伝わることは別です。コピーのタイミングや実際の操作を確かめます。


手順4:JavaScript・プラグイン・外部連携を補う。

標準機能以外で別アプリを参照する場合もあります。カスタマイズの設定、管理しているコード、連携サービスの設定、運用担当者への確認を組み合わせ、図だけでは拾えない関係を補います。


手順5:根拠と確認日を残す。

関係の一覧には、設定名、フィールドコード、確認したファイルなどの根拠を添えます。未確認のものは「関係なし」にせず「未確認」と記録し、担当者と次の確認事項を決めます。


5.AppInsightで関係と参照元を見える化する

AppInsight for kintoneは、アプリ構成や依存関係、変更時の影響を確認するためのツールです。ルックアップ・関連レコード・アクションに加え、JavaScriptの参照関係も図で確認でき、参照する側・される側を分けて経路をたどれます。

AppInsightの関係図と影響分析。案件管理を参照するアプリと、案件管理が依存する先を確認できます。
AppInsightの関係図と影響分析。案件管理を参照するアプリと、案件管理が依存する先を確認できます。

まず対象アプリの関係を確認し、気になるつながりから参照元の設定やコードを調べます。フィールドの変更・削除を検討するときは、削除影響の一覧や詳細の根拠も合わせて確認すると、点検する場所を整理できます。構成表や図の一部はMarkdown・CSV・Mermaidで共有・保存できます。

連携詳細の表示例。関連レコードの設定「取引品番」と、接続する項目「代理店コード」を確認できます。
連携詳細の表示例。関連レコードの設定「取引品番」と、接続する項目「代理店コード」を確認できます。

通常版では構成・依存関係・変更影響の確認を行い、AI Review版では解析結果をもとに確認事項や構造の説明を整理できます。AIレビューは、削除可否や設計の良し悪しを自動で決定する機能ではありません。


JavaScriptの動的な参照、外部ファイル、プラグイン内部などは検出できない場合があります。「図に線がない=影響がない」とは判断せず、実際の設定・コード・運用と照合してください。


6.そのまま使える依存関係の記録ひな形

変更前の調査や引き継ぎでは、次の項目を1つの関係につき1件ずつ残すと、後から確認しやすくなります。


対象アプリ名/アプリID:

相手アプリ名/アプリID:

関係の種類:ルックアップ・関連レコード・アクション・JavaScript・その他

関係の向きと意味:

関連するフィールド名/フィールドコード:

根拠となる設定名・ファイル:

変更した場合に確認する操作:

確認状況:確認済み・未確認

確認日/確認者:

残っている確認事項/担当者:


先ほどの例なら「案件管理 → 顧客管理/ルックアップ/顧客コードで顧客名を取得」と記録し、根拠となるルックアップ設定と、変更後に試す取得操作を添えます。アプリIDやフィールドコードには、自分の環境で確認した値を記入してください。


7.図を作った後は、変更前の点検と引き継ぎに使う

関係を整理したら、変更対象を参照するアプリと、実際に試す操作を決めます。たとえば、ルックアップでの取得、関連レコードの表示、アクションでの作成を点検対象にし、業務担当者にも結果を確認してもらいます。変更後は図と記録を更新し、次の担当者が根拠をたどれる状態にします。



自分のkintone環境で、アプリのつながりを確認する

アプリの全体像を把握する第一歩は、つながりの種類と根拠をそろえることです。手作業での調査を整理したい方は、AppInsightの商品ページ

で機能と通常版・AI Review版の違いをご確認ください。ページ内の「無料で試す」から、実際のアプリ構成で確認できます。



コメント


bottom of page