【SharePoint】ER図やテーブル設計書を自動作成！SharePoint ERD Generatorを公開しました！【拡張機能】

はじめに

こんにちは、reireです。

約２カ月ほど前、DataverseのER図を自動生成するブラウザ拡張機能『Dataverse ERD Generator』を公開し、QiitaおよびPower Appsのアドベントカレンダーとしても記事をアップさせていただきました。

そして今回は、『Dataverse ERD Generator』をSharePointリスト向けにして、
さらに機能追加を行いより便利になった拡張機能である『SharePoint ERD Generator』を公開したので、そちらの宣伝および使い方の説明になります！

本拡張機能のご利用について
本拡張機能、および本拡張機能により生成された成果物は、個人、組織を問わず検証や業務利用など幅広い用途でご利用いただけます。

ですが、本拡張機能は製作者が個人用に開発したものを、Chrome Web Store上で無償公開したものとなります。

そのためMicrosoftやSharePointなどの仕様変更や、
テナントやネットワークの設定でSharePoint REST APIがブロックされている、
または本拡張機能の不具合により正常にご利用いただけない場合もございます点をご了承ください。
また、その場合の補償などもできかねますので、利用者様の責任の範囲でご利用いただきますようお願いいたします。

SharePoint ERD Generatorとは

SharePoint ERD Generatorは、
以前公開したDataverse ERD Generatorと同様にサイト内の全リストの列や参照情報を取得しPlantUMLでER図を出力できるほか、
各リストの設計をシートごとに分けてExcelへ出力したり、
出力対象とするリストを選択することができる、といった機能が追加された拡張機能です！

使い方

1. SharePointサイトにアクセスして、ブラウザのツールバーからこの拡張機能をクリックします

2. するとポップアップが表示され、現在のサイトURLが自動検出されます
   

3. 以下の項目を設定することができます

   • 言語の選択
     右上のドロップダウンで言語（JP/EN）を選択します
     ここで選択した言語は、出力されたUMLコードやExcel表の型名やヘッダーに反映されます
   • 表示する列名の選択
     UMLコードでInternal Name(内部列名) とDisplay Name(表示列名)、どちらを列名として表示するかを選択します
   • カスタム列の追加
     Excelを出力するにあたり、任意でカスタム列を追加することが可能です
     設計書として利用する際などに、備考や説明といった列を追加してあげると便利なのではないでしょうか

4. 「Generate Diagram」 ボタンをクリックします

5. するとUMLコードが生成され、以下のアクションが可能になります
   

   • Excel: 各リストの定義書をExcelで出力し、ダウンロードできます
     
   • Filter: ExcelやUMLに出力するリストを選択することができます
     以前の『Dataverse ERD Generator』はソリューション単位でしたが、今回はサイト内のリストすべて取得してしまいます。
     ですが、サイト内に複数のシステムやアプリのリストが混在していることも多いのではないでしょうか。
     その対策として今回は、目的の範囲のリストを選択して出力できるよう、Filter機能を追加してみました。
     
   • Preview: PlantUML ServerでER図を開くことができます
     
   • Copy: UMLコードをクリップボードにコピーすることで、VScodeなどでレイアウトを整えるなどの編集作業を行うことができます
     

最後に

以上、『SharePoint ERD Generator』の宣伝と使い方でした。

ここ１年は本業でDataverse関連の案件をいただくことが多く、自分でも苦労する場面が多かったためDataverse版を夏ごろに開発し、年末に一般公開を致しました。
ですが、年明けからは一転してSharePointリストを扱うお話を伺うことが多くなり、やっぱりSharePoint版も欲しい！ と思い開発した経緯になります。

また、Microsoft MVPであるAkiraさん、やまさんが運営されているYoutubeライブ『Power Apps Weekly News』でも取り上げていただきました！
こうやってお話しいただけたことで、面倒な公開申請まで頑張るモチベーションを保てた面もあります…！
本当にありがとうございます！！

それに、普通に考えたらSharePointリストの方がずっと多くの方に、多くの場面で利用されているんだから、SharePointリスト版の方がもっと需要あるはずだよね、ということでこちらも公開前提で開発をしてみました。

ただ同じものを開発するのも面白くないので、フィルター機能やExcel出力機能といった追加機能もあると便利だと思いチャレンジしてみました。
なかなか仕様に悩む場面もありましたが、結果として多くのPower Platform開発者やSharePoint管理者を支援することができる、便利な拡張機能になったのではないかと手前味噌ながら思います。

少なくとも自分が欲しい機能を詰め込んだので、私自身の業務はめちゃくちゃ効率化されました！！
(とはいえ、かなり急ぎ足で開発、公開したのと、テストした環境も幅広くはないので、もし不具合などありましたらご報告いただけますと助かります…！)

そのうち『Dataverse ERD Generator』の方にも今回追加したフィルター機能やExcel出力機能は追加したいと思いますので、
ぜひ『SharePoint ERD Generator』ともども使ってみていただいて、
Chrome Web Storeの方で感想やフィードバックをいただけると嬉しいです！！

それでは！