Progress Agentic RAG for Magnolia

Install on author and public instances

1. Request the version 1.0.0 JAR from Noice and add it to your deployment.
2. Copy magnolia-progress-arag-1.0.0.jar into the webapp's WEB-INF/lib on the author and every public instance, then restart. If you manage modules through Maven, use the supplied artifact through your organisation's repository.
3. On the author, open AdminCentral and look for Agentic RAG in the Content group. Its tabs are AI insights, Sync and Settings.
4. In the Security app, assign progress-arag-admin to administrators and progress-arag-editor to authors who need AI insights. Installation creates these roles without assigning them to users.

Installation also creates the progress-arag workspace and permits anonymous access to the visitor Ask endpoint. Configure the connection before adding an Ask component to a public page.

Connect a Knowledge Box

1. In Progress Agentic RAG, create or open the Knowledge Box for your site in the region appropriate to your organisation. Copy its API endpoint.
2. Create a Knowledge Box API key with the Contributor role for the author instance. Create a separate Reader key for visitors' questions on public instances. Account API keys are not suitable for this connection.
3. Open Agentic RAG > Settings, enter the endpoint and configure the Contributor key, then choose Connect. The connection test checks access to the Knowledge Box, write access and answer generation.

Keep credentials on the server. For managed deployments, inject PROGRESS_ARAG_API_KEY and PROGRESS_ARAG_READER_KEY through your secret manager. DX Core can reference entries in Magnolia Password Manager. Pasted keys use the module's encrypted storage. See data and credentials for details.

Choose the content answers can use

In Settings, select the site roots and DAM document folders to include. Enter the public website address for each target and check its example citation URL. Exclude private or irrelevant branches. You can also configure language, template exclusions, the main content selector and document file limits.

Keep Send only published content enabled, then choose Load everything. Loading runs in the background. Later publishing adds or updates content; unpublishing and published deletions remove it. With the default setting, editing a page without publishing keeps its published version in the Knowledge Box. Turning this setting off allows draft content to be synced.

The Sync tab shows progress and failures. Use Try again after correcting an issue, or Leave this out to exclude an item. Pause all syncing stops loading and publish sync until you resume. Sync runs on the author only.

Use a Reader key on the public site

Settings saved on the author stay on the author. Set these environment variables on every public instance, using your own zone, Knowledge Box ID and Reader key:

PROGRESS_ARAG_ZONE=YOUR_ZONE
PROGRESS_ARAG_KB_ID=YOUR_KNOWLEDGE_BOX_ID
PROGRESS_ARAG_READER_KEY=YOUR_READER_KEY

Optional variables are PROGRESS_ARAG_SEARCH_CONFIGURATION and PROGRESS_ARAG_ANSWER_MODEL. Public instances do not need a Contributor key. The browser calls /.rest/progress-arag/v1/ask on Magnolia; Magnolia calls Progress server-side.

The default question limit is 20 per visitor per minute, per instance. Add an appropriate CDN or WAF limit for your deployment. Ensure your reverse proxy allows streaming responses from the Ask endpoint without buffering them.

Add answers with sources to a page

A developer must allow the component in the relevant template area:

areas:
  main:
    availableComponents:
      progressAragAsk:
        id: progress-arag:components/ask

1. Open a page in the Pages app and choose Add component > Ask (Progress Agentic RAG).
2. Set a title, introduction and up to four suggested questions. Choose a look that suits the site.
3. Under Advanced, optionally limit answers to selected sites or document folders. Select a heading level that fits the page and review the disclaimer.
4. Save, test questions and source links, then publish the page.

Visitors receive a streamed answer with links to the source pages and documents. For more useful answers, write direct explanations under descriptive headings, keep facts current and prefer text-based documents to scanned copies.

Review recommendations before applying them

Open Agentic RAG > AI insights, or select a page in Pages and choose Analyse with AI insights. Select a page and choose Analyse for structural checks and Knowledge Box analysis. Quick check only runs the local checks without Knowledge Box analysis.

Results include AI-answer and SEO scores, content gaps, citation checks and suggested titles, descriptions and FAQs. They guide editorial review; they do not guarantee visibility in external search or answer engines. Suggestions do not change your page automatically. Review and edit them before use.

Question and citation results are most useful when the page is already published and synced. The Site report runs quick checks across synced pages and highlights common issues and pages that may need attention.

Understand what leaves Magnolia

• Sync sends the selected pages' text and metadata, or the original selected DAM documents, to your configured Knowledge Box. Published-only sync is enabled by default; administrators can disable it.
• AI insights sends the selected page for analysis, including unpublished edits when present. Visitor Ask sends the question and up to six previous conversation turns to Progress. Processing and retention follow your Progress agreement.
• Author and public permissions remain distinct: administrators manage settings and sync, editors use insights, and anonymous visitors can use the Ask endpoint. Editor page access follows Magnolia permissions.

Credential storage

The module checks environment variables or JVM properties first, then configured Magnolia Password Manager entries, then module-encrypted keys. JVM properties are progressArag.apiKey and progressArag.readerKey. Configure a separate Reader key for Ask; if none is configured on the author, Ask can fall back to its Contributor key.

Pasted keys are encrypted with AES-256-GCM. The encryption key is created at WEB-INF/config/progress-arag/secret.key, or can be supplied through PROGRESS_ARAG_SECRET_KEY (base64-encoded 32 bytes) or a key file set by progressArag.secretKeyFile. Keep it in protected server storage and preserve it across deployments; losing it requires re-entering the API keys. API keys are write-only in Settings and stay out of browser configuration.

Disconnect and uninstall

1. Remove Ask components from published pages before removing their module.
2. To remove the module's content from the Knowledge Box, use Settings > Disconnect > Remove synced content. This pauses sync and removes items created by this module; other Knowledge Box content is retained.
3. Remove the JAR from the author and every public instance, then restart them.

Removing the JAR stops module calls. Settings and sync state remain in the progress-arag workspace until an administrator removes them. Back up any settings you intend to reuse and revoke unused Progress API keys.

Troubleshooting and help

Connection fails or the key is read-only

Use a Contributor key from the correct Knowledge Box for sync. Check the endpoint and the Knowledge Box's answer model.

An edited page still has its old answer

With published-only sync enabled, publish the page to update its content in the Knowledge Box. Check the Sync tab for failures.

The public component says it is not configured

Check the zone, Knowledge Box ID and Reader key on the public instance. Author settings are not copied automatically.

Answers arrive all at once

Check reverse-proxy buffering and compression for the Ask endpoint.

Noice develops and maintains this module. For installation help, compatibility, module availability or a private security report, contact [email protected]. Include the module and Magnolia versions, the affected feature and redacted logs from work.noice.progressarag. Keep credentials out of support messages.