pptb-entity-fields-analyzer 0.0.0-stage โ†’ 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,22 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Hamza AMRAOUI
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
22
+
package/README.md CHANGED
@@ -1,3 +1,242 @@
1
- # Temporary Holding Version
1
+ ![Entity Fields Analyzer icon](https://raw.githubusercontent.com/AmraouiH/EntityFieldsAnalyzer-PPTB/main/public/icon/entity-fields-analyzer.svg)
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ # Entity Fields Analyzer
4
+
5
+ **A Power Platform ToolBox tool that shows what is really inside a Dataverse table.**
6
+
7
+ *Reads the fields. Measures what is filled. Estimates the room left. Recommends what to clean up. Never writes to Dataverse.*
8
+
9
+ [![npm](https://img.shields.io/npm/v/pptb-entity-fields-analyzer?color=cb3837&logo=npm)](https://www.npmjs.com/package/pptb-entity-fields-analyzer)
10
+ [![Power Platform ToolBox](https://img.shields.io/badge/Power%20Platform-ToolBox-742774)](https://www.powerplatformtoolbox.com/)
11
+ [![Originally on XrmToolBox](https://img.shields.io/badge/originally%20on-XrmToolBox-1e6fba)](https://www.xrmtoolbox.com/plugins/EntityFieldsAnalyser/)
12
+ [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/AmraouiH/EntityFieldsAnalyzer-PPTB/blob/main/LICENSE)
13
+ [![Dataverse](https://img.shields.io/badge/Dynamics%20365-Dataverse-0078d4)](https://learn.microsoft.com/power-apps/developer/data-platform/)
14
+ [![Read-only](https://img.shields.io/badge/Dataverse%20access-read--only-2ead33)](#what-this-tool-changes)
15
+
16
+ > **From XrmToolBox to Power Platform ToolBox.** This tool comes from [**Entity Fields Analyser**](https://www.xrmtoolbox.com/plugins/EntityFieldsAnalyser/), the XrmToolBox plugin by Hamza AMRAOUI with more than 50,000 downloads. It is ported by the same author.
17
+
18
+ ![Overview of the fields of a table](https://raw.githubusercontent.com/AmraouiH/EntityFieldsAnalyzer-PPTB/main/docs/screenshots/overview.png)
19
+
20
+ ---
21
+
22
+ ## What it does
23
+
24
+ You pick a table. It gives you a clear picture of its fields, and an Excel report of what it found.
25
+
26
+ | | |
27
+ |---|---|
28
+ | ๐Ÿ” **Explains the table** | Field types, standard or custom, managed or unmanaged, publisher prefixes, settings, fields created over time. |
29
+ | ๐Ÿ“‹ **Lists every field** | Metadata, quick filters, type filter, search and sort. 32 more columns with *All metadata columns*. |
30
+ | ๐Ÿงช **Measures real usage** | Fill rate of each field across the records you can read: never used, rarely used (under 5%), least used custom fields. |
31
+ | ๐Ÿ“ **Plans capacity** | Estimate of the physical columns used out of 1,024, and a calculator for the fields you want to add. |
32
+ | ๐Ÿ’ก **Recommends** | Findings sorted by severity in the Excel report: clean-up, data quality, documentation, ALM, security. |
33
+ | ๐Ÿ“Š **Reports in Excel** | One workbook with a dashboard, native charts and up to 9 sheets. |
34
+ | ๐ŸŒ **Feels at home** | English and French, light and dark theme. |
35
+
36
+ ---
37
+
38
+ ## How it differs from other ToolBox tools
39
+
40
+ Some listed tools also read field metadata or values. Entity Fields Analyzer is about the **health of one table**: how full every field is, how many of the 1,024 columns are used, and what to clean up.
41
+
42
+ | Tool | What it is for | What Entity Fields Analyzer adds |
43
+ |---|---|---|
44
+ | **Entity Field Catalog** | Exports the field metadata of several tables of a solution to Excel or CSV | Fill rates, capacity estimate and calculator, interactive charts, clean-up recommendations |
45
+ | **Metadata Browser** | Browses metadata and compares it across environments | Fill rates from the records, capacity planning, a report that analyses the table |
46
+ | **Data Validation** | Runs the tests you configure on columns, including whether they contain data | Fill rate of every field with no setup, combined with origin, capacity and recommendations |
47
+ | **Field Reference Finder** | Finds the components that reference a field | It is the step before: which fields are worth checking. Use Field Reference Finder before deleting one |
48
+
49
+ For documentation of many tables, comparison between environments or dependency search, use those tools.
50
+
51
+ ---
52
+
53
+ ## How an analysis runs
54
+
55
+ ```
56
+ Get Entities โ”€โ”€โ–บ Pick a table โ”€โ”€โ–บ Choose a mode โ”€โ”€โ–บ Analyse
57
+ โ”‚
58
+ Excel report โ—„โ”€โ”€ Export โ—„โ”€โ”€ Drill down โ—„โ”€โ”€ Charts and figures
59
+ ```
60
+
61
+ | Step | What happens | Your role |
62
+ |---|---|---|
63
+ | **1. Load** | Lists the tables of the connected environment | **Click Get Entities** |
64
+ | **2. Choose** | Filters and searches by display or schema name | **Pick a table and a mode** |
65
+ | **3. Analyse** | Reads the metadata, and the records if you asked for data usage | **Click Analyse** |
66
+ | **4. Explore** | Every chart and tile opens the matching fields, already filtered | Click what interests you |
67
+ | **5. Report** | Builds the Excel workbook on your computer | **Click Export to Excel** |
68
+
69
+ > **Nothing is read until you click, and nothing is ever written to Dataverse.** Stop or Esc interrupts an analysis.
70
+
71
+ ---
72
+
73
+ ## Quick start
74
+
75
+ **1. Open the tool**
76
+
77
+ In [Power Platform ToolBox](https://www.powerplatformtoolbox.com/), open **Entity Fields Analyzer** and pick a Dataverse connection. To run it from the source code, see [Run from source](#run-from-source).
78
+
79
+ **2. Load your tables**
80
+
81
+ Click **Get Entities**, then select a table.
82
+
83
+ **3. Pick a mode and analyse**
84
+
85
+ | Mode | What it reads | When to use it |
86
+ |---|---|---|
87
+ | **Metadata only** | The definition of the fields | A fast look at the structure and the capacity |
88
+ | **Metadata + Data usage** | The definition, plus every record you can read | Before a clean-up. Slower on large tables |
89
+
90
+ **4. Export**
91
+
92
+ Click **Export to Excel** to save and share the report.
93
+
94
+ ---
95
+
96
+ ## A closer look
97
+
98
+ ### Fields
99
+
100
+ Every field with its metadata. The fields that are empty in every record are highlighted.
101
+
102
+ ![Fields with their metadata and fill rate](https://raw.githubusercontent.com/AmraouiH/EntityFieldsAnalyzer-PPTB/main/docs/screenshots/fields.png)
103
+
104
+ ### Data usage
105
+
106
+ How full each field is, and where to start the clean-up.
107
+
108
+ ![Data usage of the fields](https://raw.githubusercontent.com/AmraouiH/EntityFieldsAnalyzer-PPTB/main/docs/screenshots/data-usage.png)
109
+
110
+ ### Capacity
111
+
112
+ What consumes the columns, and whether the fields you plan to add will fit.
113
+
114
+ ![Column capacity and calculator](https://raw.githubusercontent.com/AmraouiH/EntityFieldsAnalyzer-PPTB/main/docs/screenshots/capacity.png)
115
+
116
+ ### Dark theme
117
+
118
+ The tool follows the theme of the ToolBox.
119
+
120
+ ![Overview in the dark theme](https://raw.githubusercontent.com/AmraouiH/EntityFieldsAnalyzer-PPTB/main/docs/screenshots/overview-dark.png)
121
+
122
+ *Screenshots use demo data.*
123
+
124
+ ---
125
+
126
+ ## What is in the Excel report
127
+
128
+ | Sheet | Content |
129
+ |---|---|
130
+ | **Metadata** | Every analysed field with its properties, in a sheet named after the table |
131
+ | **Dashboard** | Key figures and native Excel charts |
132
+ | **Summary** | The figures of the analysis and the number of findings |
133
+ | **Recommendations** | Each finding with its severity and what to do |
134
+ | **Data usage** | Fill rate per field, only in *Metadata + Data usage* mode |
135
+ | **By Type** | Breakdown per field type |
136
+ | **By Publisher** | Breakdown per publisher prefix |
137
+ | **Lookups** | Lookup fields and the tables they target |
138
+ | **Timeline** | Fields created over time |
139
+
140
+ ---
141
+
142
+ ## How the figures are computed
143
+
144
+ - **Analysed fields**: readable attributes, without virtual, party list, composite and companion attributes (`AttributeOf`).
145
+ - **Fill rate**: share of the records read where the field has a value. `0`, `No` and an empty text count as values.
146
+ - **Column capacity**: an estimate with the weights below, against 1,024 columns.
147
+
148
+ | Field type | Columns |
149
+ |---|---|
150
+ | Lookup, Owner | 3 |
151
+ | Option set, Money, Boolean, Status | 2 |
152
+ | Any other type | 1 |
153
+
154
+ Background: [Field limits in Dynamics 365: how many fields is too many fields?](https://hamzaamraoui.medium.com/field-limits-in-dynamics-365-how-many-fields-is-too-many-fields-ab39c699336e)
155
+
156
+ ---
157
+
158
+ ## What this tool changes
159
+
160
+ **Nothing in Dataverse.** The tool never creates, updates, deletes or publishes anything.
161
+
162
+ On your computer, it writes the Excel report when you export it, and three preferences in the ToolBox settings: language, entity filter and metadata columns.
163
+
164
+ ---
165
+
166
+ ## Safety
167
+
168
+ - Only read requests, sent to the connected environment through the ToolBox.
169
+ - No external host, no telemetry.
170
+ - Records are read in memory, page by page. Only a counter per field is kept: no record value is stored or exported.
171
+ - A stopped analysis keeps no partial result.
172
+ - A secured field that reads as empty is never proposed for deletion.
173
+
174
+ Always check forms, views, processes, plugins and integrations before deleting a field. You remain responsible for what you delete.
175
+
176
+ ---
177
+
178
+ ## Limitations
179
+
180
+ - **Not analysed**: multi-select choices, files and images, which are virtual attributes.
181
+ - **Permissions**: records you cannot read are not counted, and secured fields you cannot read look empty. Check with a privileged account before a clean-up.
182
+ - **Large tables**: data usage reads every record, so it takes time and counts toward the Dataverse service protection limits. Pages shrink automatically to stay under the 16 MB response limit of the ToolBox.
183
+ - **Unpublished changes**: included when Dataverse accepts `RetrieveEntity`. Otherwise the tool reads the published metadata and tells you.
184
+
185
+ ---
186
+
187
+ ## Run from source
188
+
189
+ | Requirement | Why |
190
+ |---|---|
191
+ | Power Platform ToolBox | runs the tool |
192
+ | Node.js 20.19+ | build and tests |
193
+ | Edge or Chrome | end-to-end tests |
194
+
195
+ ```bash
196
+ git clone https://github.com/AmraouiH/EntityFieldsAnalyzer-PPTB.git
197
+ cd EntityFieldsAnalyzer-PPTB
198
+ npm install
199
+ npm run build
200
+ ```
201
+
202
+ Then, in Power Platform ToolBox:
203
+
204
+ 1. Open **Settings**, turn on **Show Debug Menu** and select **Save**.
205
+ 2. In **Debug**, under **Load Local Tool**, select **Browse** and pick the folder that contains `package.json`.
206
+ 3. Select **Load Tool**.
207
+
208
+ | Command | Purpose |
209
+ |---|---|
210
+ | `npm run build` | Type-check and build into `dist/` |
211
+ | `npm run dev-watch` | Development build, rebuilt on save |
212
+ | `npm run validate` | Marketplace validation of the package |
213
+ | `npm run test:logic` | Tests of the calculations, paging and Excel report |
214
+ | `npm run test:e2e` | Browser tests against a simulated Dataverse and ToolBox |
215
+
216
+ ---
217
+
218
+ ## AI Assistance
219
+
220
+ A substantial part of the code, the tests and this documentation was written with an AI coding assistant (Claude Code, by Anthropic). See the [AI-Assisted Development policy](https://docs.powerplatformtoolbox.com/policies/ai-assisted-development).
221
+
222
+ ---
223
+
224
+ ## Credits
225
+
226
+ Entity Fields Analyzer is a port of [**Entity Fields Analyser** for XrmToolBox](https://www.xrmtoolbox.com/plugins/EntityFieldsAnalyser/) by [Hamza AMRAOUI](https://www.linkedin.com/in/hamza-amraoui/) ([source code](https://github.com/AmraouiH/Entity-Field-Analyser)).
227
+
228
+ The original repository has no license file. Its author publishes this port under the MIT license.
229
+
230
+ ---
231
+
232
+ ## Support
233
+
234
+ If the tool helps you, you can support its development on [PayPal](https://www.paypal.com/paypalme/EntityFieldsAnalyser). Bugs and ideas are welcome in [GitHub issues](https://github.com/AmraouiH/EntityFieldsAnalyzer-PPTB/issues).
235
+
236
+ ---
237
+
238
+ ## License
239
+
240
+ [MIT](https://github.com/AmraouiH/EntityFieldsAnalyzer-PPTB/blob/main/LICENSE) ยฉ 2026 Hamza AMRAOUI
241
+
242
+ **[XrmToolBox version](https://www.xrmtoolbox.com/plugins/EntityFieldsAnalyser/)** ยท **[Source](https://github.com/AmraouiH/EntityFieldsAnalyzer-PPTB)** ยท **[Issues](https://github.com/AmraouiH/EntityFieldsAnalyzer-PPTB/issues)** ยท **[LinkedIn](https://www.linkedin.com/in/hamza-amraoui/)**