Installation Guide
Installing Portal Docs Hub for JSM in your Jira Cloud instance is done through a direct installation link from Atlassian Forge.
Portal Docs Hub for JSM is not yet published on the Atlassian Marketplace. Installation is currently done exclusively through the official developer link provided below.
Prerequisites​
- Jira Administrator or Site Administrator permissions to install Forge apps.
- Internet connection and access to your instance (
your-domain.atlassian.net). - Jira Service Management enabled on the site.
Direct installation link​
Install Portal Docs Hub for JSM
Installation steps (Administrators)​
- Log in to Jira Cloud with administrator credentials.
- Open the direct installation link above.
- Select your Jira Cloud site if prompted.
- Review the requested permissions (scopes), including
write:jira-work, and confirm with Accept & install. - Wait for Atlassian to complete the Forge app deployment.
- Verify in Apps → Manage apps that Portal Docs Hub for JSM appears as installed.
The app requests permissions for Confluence search, Jira issue reading and writing (write:jira-work, to update the Case Documentation field), and Forge KVS storage. All permissions follow Forge's least-privilege principle. See Permissions and requirements.
Not an Administrator?​
If you don't have administration privileges, share the installation link with your Jira administrator and request they install Portal Docs Hub for JSM on the site.
Verify the installation​
- Open any ticket in a Jira Service Management project.
- In the agent view, click the button with the plug icon located below the issue title.
- In the agent view, look for the Case Documentation panel.
- In the customer portal, look for the Shared Documentation panel.
If the panels are displayed correctly, the installation was successful.
Screen checklist​
To use the Case Documentation field (version 1.5.0 or later), add it to the project screens:
| Screen | When | Purpose |
|---|---|---|
| Transition screen | On each transition where the agent should manage documents | Edit the case documentation during the transition |
| Create screen | If documents are shared when the issue is created | Add documents in the create dialog |
| Edit screen | Always when Automation for Jira is used | Let Automation see inclusions made from the panel and the transition |
If the field is not on the issue type's edit screen, the document is still saved on the case, but the field is not updated and Automation does not fire. See Automation for Jira.
The field and the documentation validator are only available in company-managed projects.
Automatic updates (Forge)​
Forge apps are updated through Atlassian's infrastructure. If a version introduces new scopes, Atlassian will request your approval before applying them.
Upgrading from an earlier version​
Version 1.5.0 adds the write:jira-work scope. If your site already had the app installed:
- Go to Apps → Manage apps.
- Find Portal Docs Hub for JSM and accept the permission update.
Until the upgrade is accepted, the site stays on the previous version and does not get the Case Documentation field, the validator or the origin for Automation.