Skip to content

[FEATURE] Custom Reports: JSON export and import of report configurations - #4120

Open
Jonathon-Meney-Torq wants to merge 2 commits into
pimcore:2026.xfrom
TorqIT:feat/custom-report-json-import-export
Open

Jonathon-Meney-Torq wants to merge 2 commits into
pimcore:2026.xfrom
TorqIT:feat/custom-report-json-import-export

Conversation

@Jonathon-Meney-Torq

@Jonathon-Meney-Torq Jonathon-Meney-Torq commented Sep 21, 2026 •

Copy link
Copy Markdown

Changes in this pull request

Closes pimcore/platform-version#505

Adds JSON export and import of custom report configurations to the Custom Reports Configuration editor.

  • Report tree context menu gets an Export action that downloads the report configuration via GET /bundle/custom-reports/config/{name}/export.
  • Sidebar toolbar gets an import button that opens the shared ImportModal (JSON only) and posts to POST /bundle/custom-reports/config/import. After a successful import the tree is refetched, the reports menu reloaded and the imported report opened.
  • Generated API slice extended with the two new endpoints.

Additional info

Requires the companion backend PR: pimcore/studio-backend-bundle#2050

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

The generated transfer hooks mishandle Blob responses and multipart uploads, and the import button lacks an accessible name.

Get a fresh assessment by requesting another Copilot review.

Review effort: Balanced
Findings: 1 High severity · 1 Medium severity

Open (2)
What changed in this PR

Adds JSON import/export support to the Custom Reports editor.

Changes:

  • Adds report export actions and JSON import UI.
  • Refreshes and opens successfully imported reports.
  • Extends generated report API endpoints and translations.

Review contract:

  • Claimed: Adds report configuration import/export.
  • Root cause/boundary: UI handling is correctly located in the reports editor, but API transport handling is incomplete (custom-reports-api-slice-enhanced.ts:18-20).
  • Call sites: Direct UI transfers work independently; newly exported RTK Query hooks remain affected.
  • Compatibility: Changes are additive with no identified breaking API changes.
  • Tests/docs: Translation coverage was added; no report-specific automated tests were found.
  • Risk: Binary export and multipart import hooks require correction before approval.
File Description
translations/​studio.en.yaml Adds import messages.
config-transfer-urls.ts Builds transfer URLs and downloads exports.
reports-sidebar.tsx Adds export handling and post-import refresh.
toolbar.tsx Adds the import control.
import-button.tsx Implements JSON upload modal behavior.
custom-reports-api-slice.gen.ts Adds generated transfer endpoints and types.
custom-reports-api-slice-enhanced.ts Exposes transfer hooks and adjusts tags.

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@Jonathon-Meney-Torq
Jonathon-Meney-Torq marked this pull request as ready for review September 21, 2026 13:32
@sonarqubecloud

Copy link
Copy Markdown

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🔵 Needs a closer look

File-import security and compatibility with the required companion backend change need final maintainer verification.

Review effort: Balanced
Findings: None

Resolved since last review (2)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Export and Upload of Reports

2 participants