Content Compliance Scan

Requirements

• Jahia 8.2 with jContent 3.7 or later. jContent and the GraphQL provider ship with Jahia; the module declares both and does not start without them.
• No external service, no configuration file, no role to create.

1. Install the module (once per server)

1. Install it from the Jahia Store, or download content-compliance-scan-1.0.0.jar from the GitHub release.
2. For the file: open Administration > Server > Modules and Extensions > Modules, tab Installed modules. Under Upload module from file, click Select module, choose the jar and upload it.
3. Content Compliance Scan appears in the list with the state Started.

2. Enable it on each site

1. In the same list, click Content Compliance Scan.
2. Under Usage in sites, switch each site that should be checked from Disabled to Enabled.

A site whose template set or another enabled module depends on content-compliance-scan has it already.

3. Create the glossaries

In jContent, Content Folders, in any folder of the site's contents: New content > Compliance > Compliance glossary, one per language, then its Non-authorised terms. Guide: glossary-guide.md.

4. Check it works

• Open a page in Page Builder: the Compliance scan button is in the header.
• In jContent, Additional > Compliance shows the site report.
• The page scan needs the right to edit the page, the report access to jContent. The default editor role holds both; a reviewer can open the report but not the page scan.

Upgrade

Upload the new version the same way; Jahia stops the previous version and starts the new one. Uploading a version that is already installed again is skipped unless you force the update.

Scripted install (administrators)

With Jahia's provisioning API, as a server administrator:

curl -u root:<password> https://<jahia>/modules/api/provisioning \  -F 'script=[{"installOrUpgradeBundle":"content-compliance-scan-1.0.0.jar","start":true},{"enable":"content-compliance-scan","site":"<siteKey>"}];type=application/json' \  -F file=@content-compliance-scan-1.0.0.jar

Content Compliance Scan checks the text of your site against glossaries of non-authorised terms. "Free", "guaranteed", "best", a retired product name: the people who own the wording list the terms once, with the reason and what to write instead, and editors see every use before they publish.

Glossaries, one per language

• Legal or Brand create Compliance glossaries in the site's content folders, one or more per language, and add their Non-authorised terms: the term, how it matches, the reason, the suggested wording.
• Matching ignores case and accents, phrases match across line breaks and non-breaking spaces, and a term can match the whole word, any word starting with it, or anywhere.
• Several glossaries can apply to one language: every issue names its glossary, and a term two glossaries share shows each glossary's reason.

Scan the page you are editing

• Compliance scan in the Page Builder header checks the page in the language you are editing: its content, the content it reuses, its header and footer and the items its listings show.
• The result is Compliant, Not compliant (with a "do not publish yet" warning) or Not checked when no glossary covers the language.
• Each use shows the field, the sentence with the term highlighted, the reason and the suggested wording; Edit opens the content and the scan runs again when you close the editor.

Report on the whole site

• Additional > Compliance in jContent scans every page and every content item of the site in one language.
• Terms are ranked by use, and each page or content item opens into its issues, with links to Page Builder and Content Editor.
• Export CSV (one row per issue, ready for Excel) and Export JSON (the whole report) share the result with the people who own the wording.

Safe by design

• Scans read the content being edited, with the editor's own rights, and never change anything.
• The page scan needs the right to edit the page, the site report access to jContent, and both run only on sites where the module is enabled.
• Informational in this version: it tells editors what to fix before publishing, it does not block publication.