Content Report React Module

A comprehensive content reporting tool for Jahia DX, built with React and the Moonstone UI library. This module provides powerful insights into your Jahia site's content through various customizable reports.

Overview

The Content Report React module offers a modern, user-friendly interface for generating and viewing detailed reports about your Jahia site content. It features a site overview dashboard and multiple specialized reports covering content, languages, visibility, metadata, and system information.

Features

📊 Site Overview Dashboard

Content Metrics: Pages, deployed modules, registered users, content nodes (jnt:content), editorial contents (jmix:editorialContent)
Workflow Tracking: Pending workflow tasks count
Asset Management: Files (jnt:file) and Images (jmix:image) counts
Language Support: Available site languages count with visual display
Content Activity (Last 30 Days):
- New content created
- Modified content items
- Published content items
- Published vs Unpublished nodes comparison
- Average time from creation to publication
- Top contributors ranked by content count (with medal badges 🥇🥈🥉)

📝 Content Reports

By Author and Date: Filter pages or all content by combining author and date range criteria; supports creation vs. modification date toggle
By Author: List content created or last modified by a specific author
By All Dates: Break down content activity per month and type, with creation or modification date scope
Before Date: List content created or modified before a given date
By Type: Analyze content distribution grouped by node type
By Type (Detailed): Same as By Type with additional per-node detail rows
By Status: View content filtered by publication status
Work in Progress: Content marked as WIP — still being edited, not ready for publication
Workflow Instances: All content with a pending workflow task (awaiting review, approval, or publication)
Marked for Deletion: Content flagged for removal, including child node counts and publication status

🔗 References Reports

References: Content references between two paths — only shows content actually used on a page
Unused Assets: Files under a chosen path that are not referenced anywhere in the site, with MIME type icons and direct media folder links

🌍 Language Reports

Languages: Content breakdown across all site languages
Language Detail: Per-language detail for a specific target language
Pages Without Title: Pages missing a title in one or more languages
Untranslated Content: Content existing in other languages but missing a translation for the selected target language

👁️ Visibility Reports

Live Visibility Conditions: Content with active conditional visibility rules, showing conditions, match status, and current visibility state
Expired Content: Content whose visibility end date has already passed (no longer live)
Scheduled Content: Content with a future visibility start date not yet reached

🔍 Metadata Reports

Pages Without Keywords: Pages missing SEO keyword metadata
Pages Without Description: Pages missing descriptions in one or more languages

👥 Users & Groups Report

Report Users & Groups: Generate a CSV report of all Jahia users across all sites, including group memberships; reports are stored in JCR and downloadable directly from the page

⚙️ System Reports

Locked Content: All content currently locked by users, showing creator, lock holder, and location
Custom Cache Content: Content with custom cache expiration settings, showing expiration values to help optimize cache performance
ACL Inheritance Break: Nodes where ACL inheritance has been broken (custom permissions overriding parent), useful for security auditing

Requirements

Jahia DX: 8.2.0.0 or higher
Java: 11 or higher
Node.js: 20.14.0 (via frontend-maven-plugin)
Yarn: 1.22.19

Installation

From Source

Clone the repository:

git clone https://github.com/smonier/contentReportReact.git
cd contentReportReact

Build the module:

mvn clean install

Deploy the generated JAR to your Jahia server:

cp target/contentReportReact-1.0.0-SNAPSHOT.jar $JAHIA_HOME/modules/

From Binary

Download the latest release JAR
Copy to your Jahia modules directory
Restart Jahia or deploy via Module Management

Usage

Accessing the Module

Log in to Jahia as an administrator
Navigate to Additional From your Site jContent
Select Content Report from the settings menu

Running Reports

Select a Report: Choose from the categorized menu on the left
Configure Parameters:
- Set the content path (use Browse button for picker)
- Configure date ranges, filters, and other options
- Enable/disable optional filters via checkboxes
Execute: Click "Run Report" button
View Results: Results display in a sortable, paginated table

Report Categories

Overview: Site-wide statistics and metrics
Content: Content analysis and filtering reports
Languages: Translation and localization reports
Visibility: Publication status and access control reports
Metadata: SEO and metadata completeness reports
System: Technical and administrative reports

Report Columns

Reports support various column types:

Text: Standard text display
Date: Formatted date/time values
Boolean: Checkmark/cross indicators
Link: Clickable content links
HTML: Rich formatted content
i18n: Internationalized property values

Configuration

Custom Reports

Reports are configured in src/javascript/AdminPanel/AdminPanel.constants.js:

{
    id: 'myReport',
    labelKey: 'menu.myReport',
    descriptionKey: 'descriptions.myReport',
    type: 'legacy',
    category: 'content',
    fields: [
        {name: 'pathTxt', type: 'path', labelKey: 'fields.path', required: true},
        // ... more fields
    ],
    columns: [
        {key: 'title', labelKey: 'columns.title', sortable: true},
        // ... more columns
    ]
}

Translations

The module supports 6 languages with complete translations:

src/main/resources/javascript/locales/en.json (English)
src/main/resources/javascript/locales/fr.json (French)
src/main/resources/javascript/locales/de.json (German)
src/main/resources/javascript/locales/es.json (Spanish)
src/main/resources/javascript/locales/it.json (Italian)
src/main/resources/javascript/locales/pt.json (Portuguese)

Content Activity Translation Keys (added for all languages):

{
  "result": {
    "contentActivity": "Content Activity (Last 30 Days)",
    "newContentLast30Days": "New Content Created",
    "modifiedContentLast30Days": "Modified Content Items",
    "publishedContentLast30Days": "Published Content Items",
    "unpublishedNodes": "Unpublished Nodes",
    "publishedNodes": "Published Nodes",
    "averageTimeToPublish": "Average Time to Publish",
    "days": "days",
    "topContributors": "Top Contributors",
    "items": "items",
    "noContributorsData": "No contributors data available for the last 30 days"
  }
}

Backend Reports

Create custom report beans by extending BaseReport or QueryReport:

@Component
public class MyCustomReport extends QueryReport {
    @Override
    public String getId() {
        return "myReport";
    }
    
    @Override
    protected String buildQuery(Map<String, String> parameters) {
        // Build JCR SQL-2 query
        return "SELECT * FROM [jnt:page] WHERE ISDESCENDANTNODE('" + path + "')";
    }
}

Development

Project Structure

contentReportReact/
├── src/
│   ├── javascript/          # React frontend
│   │   ├── AdminPanel/      # Main UI components
│   │   │   ├── reports/     # Report-specific components
│   │   │   └── AdminPanel.constants.js
│   │   ├── graphql/         # GraphQL queries
│   │   └── styles/          # SCSS styles
│   └── main/
│       ├── java/            # Java backend
│       │   └── org/jahia/modules/contentreports/
│       │       ├── bean/    # Report implementations
│       │       ├── graphql/ # GraphQL resolvers
│       │       └── service/ # Business logic
│       └── resources/
│           ├── definitions/ # GraphQL schema
│           └── javascript/  # Built assets
│               ├── apps/    # Webpack output
│               └── locales/ # i18n files
├── package.json
├── pom.xml
└── webpack.config.js

Building for Development

# Install dependencies
yarn install

# Development mode with watch
yarn dev

# Production build
yarn build:production

# Lint code
yarn lint
yarn lint:fix

# Clean build artifacts
yarn clean

Adding a New Report

Define Report Configuration (AdminPanel.constants.js):

{
    id: 'newReport',
    labelKey: 'menu.newReport',
    type: 'legacy',
    category: 'content',
    fields: [...],
    columns: [...]
}

Add Translations (en.json, fr.json):

{
    "menu": {
        "newReport": "New Report"
    },
    "descriptions": {
        "newReport": "Description of the new report"
    }
}

Create Backend Report (Java):

@Component
public class ReportNewReport extends QueryReport {
    @Override
    public String getId() {
        return "newReport";
    }
    
    @Override
    protected String buildQuery(Map<String, String> parameters) {
        // Implement query logic
    }
}

Build and Test:
```
mvn clean install -DskipTests
```

GraphQL API

The module exposes GraphQL queries for accessing reports:

query {
  admin {
    contentReports {
      overview(siteKey: "/sites/mysite", language: "en") {
        siteName
        nbPages
        nbContents
        nbFiles
        nbImages
        languages
        # Content Activity (Last 30 Days)
        newContentLast30Days
        modifiedContentLast30Days
        publishedContentLast30Days
        unpublishedNodes
        publishedNodes
        averageTimeToPublish
        topContributors {
          username
          contentCount
        }
      }
      rawReport(
        siteKey: "mysite"
        language: "en"
        reportId: "20"
        offset: 0
        limit: 100
        parameterName1: "pathTxt"
        parameterValue1: "/sites/mysite"
      )
    }
  }
}

Technologies

Frontend

React 18.2.0: UI framework
Moonstone 2.16.2: Jahia's design system
i18next: Internationalization
Axios: HTTP client
Webpack 5: Module bundler

Backend

Java 11: Backend language
GraphQL: API layer (graphql-java-annotations)
JCR: Content repository queries
Spring: Dependency injection
OSGi: Module framework

Performance Considerations

Reports use rep:count(item, skipChecks=1) for efficient counting
Client-side pagination for large datasets (default limit: 10,000)
Lazy loading of report results
Optimized JCR queries with proper indexing

Troubleshooting

Build Issues

Problem: Frontend build fails

yarn clean:all
yarn install
mvn clean install

Problem: Java compilation errors

Ensure Java 11+ is installed
Check Jahia parent POM version compatibility

Runtime Issues

Problem: Reports return no data

Verify user has read permissions on content
Check JCR query syntax in logs
Ensure site key and language are correct

Problem: Path picker not working

Verify Content Editor API is available
Check browser console for JavaScript errors

Debugging

Enable debug logging in Jahia:

log4j.logger.org.jahia.modules.contentreports=DEBUG

Contributing

Fork the repository
Create a feature branch: git checkout -b feature/my-feature
Commit changes: git commit -am 'Add new feature'
Push to branch: git push origin feature/my-feature
Submit a pull request

Code Standards

Follow ESLint rules for JavaScript
Use Java code formatting standards
Add translations for all new strings
Document complex logic with comments
Write meaningful commit messages

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Support

For issues, questions, or contributions:

GitHub Issues: https://github.com/smonier/contentReportReact/issues
Jahia Community: https://community.jahia.com

Changelog

Version 1.0.0-SNAPSHOT

Initial release
12+ pre-configured reports
Site overview dashboard with comprehensive metrics
Multi-language support (EN, FR, DE, ES, IT, PT)
Modern React UI with Moonstone design system
GraphQL API for report access
Customizable report framework
Asset tracking (files and images)
Workflow task monitoring
ACL inheritance break detection
Content Activity Analytics (Last 30 Days):
- New content created tracking
- Modified content items monitoring
- Published content items tracking
- Published vs unpublished nodes comparison
- Average time from creation to publication metric
- Top 5 contributors with ranking (medal badges)

Roadmap

Export reports to CSV/Excel
Scheduled report generation
Email notifications for report results
Custom report builder UI
Advanced filtering and search
Report templates and presets
Historical data tracking
Additional language support

Made with ❤️ for the Jahia Community

Name		Name	Last commit message	Last commit date
Latest commit History 40 Commits
.github/workflows		.github/workflows
.vscode		.vscode
node		node
src		src
.eslintignore		.eslintignore
.eslintrc.json		.eslintrc.json
.gitignore		.gitignore
.yarnrc.yml		.yarnrc.yml
README.md		README.md
babel.config.js		babel.config.js
package.json		package.json
pom.xml		pom.xml
pom.xml.releaseBackup		pom.xml.releaseBackup
release.properties		release.properties
schema.graphql		schema.graphql
webpack.config.js		webpack.config.js
yarn.lock		yarn.lock

Folders and files

Latest commit

History

Repository files navigation

Content Report React Module

Overview

Features

📊 Site Overview Dashboard

📝 Content Reports

🔗 References Reports

🌍 Language Reports

👁️ Visibility Reports

🔍 Metadata Reports

👥 Users & Groups Report

⚙️ System Reports

Requirements

Installation

From Source

From Binary

Usage

Accessing the Module

Running Reports

Report Categories

Report Columns

Configuration

Custom Reports

Translations

Backend Reports

Development

Project Structure

Building for Development

Adding a New Report

GraphQL API

Technologies

Frontend

Backend

Performance Considerations

Troubleshooting

Build Issues

Runtime Issues

Debugging

Contributing

Code Standards

License

Support

Changelog

Version 1.0.0-SNAPSHOT

Roadmap

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases 9

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages