BridgeNexa.WebResource.Documenter 1.0.1

BridgeNexa Web Resource Documenter

BridgeNexa Web Resource Documenter is an XrmToolBox plugin that helps you inspect Dataverse web resources and generate a professional Word report.

It is designed for technical and functional documentation workflows where you need to quickly answer:

• What web resources exist in this environment?
• What does each resource do?
• What dependencies, API usage, and risks were detected?
• What should be reviewed or improved?

Quick Start (2 minutes)

1. Open XrmToolBox and connect to your Dataverse environment.
2. Launch BridgeNexa Web Resource Documenter.
3. Use the left Filters panel to narrow to the solution or types you care about.
4. In the grid, select the resources to include.
5. (Optional) Open the Settings tab and set title/author plus diagram options.
6. Click Export Document and save the .docx file.
7. Open the document in Word and update the table of contents field.

What The Plugin Does

• Loads web resources from the connected Dataverse environment.
• Lets you filter by solution, publisher, type, managed state, and text search.
• Runs static analysis on supported resource types.
• Produces a DOCX report with:
  • Environment and filter summary
  • Per-resource metadata
  • Functional summary and technical summary
  • Dependencies and API usage
  • Observations and risk findings
  • Confidence notes
  • Optional diagrams (rendered images and/or Mermaid text)

Supported Resource Types

• JavaScript
• HTML
• CSS
• XML
• RESX
• SVG
• Common image resources (basic metadata-focused analysis)

Typical Use Cases

• Solution handover documentation
• Release readiness reviews
• Legacy web resource audits
• Security and maintainability spot checks
• Migration planning input

Requirements

• XrmToolBox installed
• Access to a Dataverse environment
• Permissions to read web resources and related metadata
• Microsoft Word (or compatible DOCX viewer) to open generated reports

Installation

1. Build the plugin, or use the packaged output in artifacts/plugin-only.
2. Copy plugin files to your XrmToolBox plugin location.
3. Start XrmToolBox and open BridgeNexa Web Resource Documenter.

Important:

• Keep plugin dependencies together with the plugin DLL.
• If DocumentFormat.OpenXml.dll is missing, export will fail.

How To Use

1. Connect to your Dataverse environment in XrmToolBox.
2. Open BridgeNexa Web Resource Documenter.
3. Wait for resource loading to complete.
4. Narrow scope from the left Filters panel:
   • Solutions
   • Publishers
   • Types
   • Managed / Unmanaged
   • Name and display-name contains
5. Use the top quick search and type selector to refine results.
6. Select resources in the grid:
   • Check individual rows
   • Use Select All / Clear Selection actions
7. Configure export options in the Settings tab:
   • Include Mermaid diagrams
   • Include rendered diagram images
   • Include risk analysis
   • Include source snippets
   • Document title, author, subject
8. Click Export Document and choose a save location.
9. Open the generated DOCX and update the table of contents in Word if needed.

Report Output (High Level)

The generated document includes:

• Cover page
• Environment summary
• Selected filter summary
• Table of contents field
• Overall summary table
• Cross-resource relationship diagram section
• Per-resource analysis sections
• Optional Mermaid appendix

Troubleshooting

Export fails with OpenXml assembly error

Cause:

• Required dependency files were not copied with the plugin.

Fix:

• Deploy the full plugin package (plugin DLL + required dependency DLLs), not only the main DLL.

Export fails with surrogate pair / invalid character error

Cause:

• Source content contains invalid XML characters.

Status:

• The plugin sanitizes invalid surrogate and XML characters before DOCX serialization.

Sidebar or filters look clipped

Fix:

• Update to the latest plugin build where sidebar sizing and responsive filter layout were adjusted.

Notes

• Analysis is static (no runtime execution).
• Findings are best-effort and confidence-based.
• Very large environments may take longer to load and process.

Author

BridgeNexa