How to Integrate Jira Service Management with SharePoint as a Document Repository

How to Integrate Jira Service Management with SharePoint as a Document Repository

 


This guide explains how to set up Jira Service Management (JSM) so that each request automatically gets a dedicated folder in SharePoint, and all related documents are stored in SharePoint instead of Jira’s native attachment storage.

It covers:

  • What the integration supports

  • How to configure automation

  • Known limitations and behavior

  • Best‑practice recommendations

  • Where to get additional help


1. Prerequisites

Before you start, make sure:

  • You are using Jira Data Center.

  • The SharePoint Connector for Jira app is installed and licensed.

  • You have:

    • Admin access to the relevant JSM project.

    • Appropriate permissions to the SharePoint site / document library that will store request folders.


2. What This Integration Enables

When configured, the SharePoint Connector for Jira can:

  1. Automatically create a SharePoint folder per JSM ticket

    • A new folder is created for each new JSM issue.

    • The folder can be named after the Jira issue key (e.g. ABC-123).

  2. Store all request documents in SharePoint

    • Files uploaded by request participants (via the JSM customer portal).

    • Files added by agents (internal attachments, responses, solution documents, etc.).

    • All are stored in the linked SharePoint folder, not Jira’s native storage.

  3. Support both customer and agent workflows

    • Requesters can upload documents as part of the request.

    • Agents can add files during investigation and resolution.

    • All files are consolidated in SharePoint for traceability and institutional document‑management compliance.


3. Configure Automation for Folder Creation

You will use project‑level automation so that a SharePoint folder is created and linked every time a ticket is created.

3.1. Open the Automation Guide

Review the official configuration and automation instructions:

This guide explains how to:

  • Connect Jira to SharePoint.

  • Configure the base location in SharePoint.

  • Create and customize automation rules.

3.2. High‑Level Setup Steps

  1. Connect Jira to SharePoint

    • In the SharePoint Connector for Jira configuration:

      • Define the SharePoint site and document library.

      • Set the parent folder/location under which request folders will be created.

  2. Configure the JSM project

    • Go to your JSM project settings.

    • Open the section used by the SharePoint Connector (see the automation guide).

    • Confirm the project is linked to the correct SharePoint configuration.

  3. Create an automation rule to create folders

    Typical pattern:

    • Trigger:

      • Issue created (for the relevant JSM project).

    • Action:

      • Use the SharePoint Connector for Jira action to:

        • Create a folder in the configured SharePoint location.

        • Name the folder with the issue key (e.g. {{issue.key}}).

        • Link that folder to the issue.

  4. Save and enable the rule

    • Save the rule and ensure it is enabled.

    • Optionally restrict the rule:

      • To certain request types.

      • Or to specific issue types (if not all need SharePoint storage).

3.3. Validate the Setup

  1. Create a test request via the JSM portal.

  2. Once the issue is created:

    • Refresh the issue page.

    • Confirm that:

      • A SharePoint folder was created with the ticket key as the name.

      • The folder is linked in the issue view (panel/link provided by the connector).

  3. Upload a file from:

    • The customer portal (as a requester).

    • The agent view (as an agent).

  4. Check in SharePoint that:

    • Both files appear in the same folder for that request.


4. Known Limitations and Expected Behavior

The following behavior is expected due to Jira API constraints:

  1. Folder is created after the ticket is created

    • The SharePoint folder cannot exist during the initial request creation form.

    • Folder creation happens post‑creation via automation.

  2. Folder is not visible in the initial ticket creation view

    • While filling in the request form, there is no SharePoint folder yet.

    • After submitting, the ticket is created, then the automation runs.

  3. Page refresh is required

    • The SharePoint folder link/panel becomes visible only:

      • After the ticket exists, and

      • After the issue page is refreshed (or reopened).

    • This is normal and tied to how Jira events and UI refresh work.

Document this for your users so they understand that the folder will not appear instantly on first load.


5. Best Practices and Recommendations

To make the integration reliable and user‑friendly:

5.1. Use the Official Connector

  • Use the SharePoint Connector for Jira rather than custom scripts or ad‑hoc integrations.

  • This ensures:

    • A supported, secure, and maintained solution.

    • Better alignment with Jira and SharePoint authentication and permissions.

5.2. Follow the Automation Guide

  • Configure automation exactly as described in the official documentation:

  • Keep rules consistent across similar projects:

    • Standard folder naming: e.g. issue key, or issue key + short summary.

    • Clear rule conditions for when folders should be created.

5.3. Communicate the Refresh Requirement

  • Inform agents (and, if relevant, power users/requesters) that:

    • The SharePoint folder is only available after ticket creation.

    • A page refresh is needed for the SharePoint panel/link to show.

  • Include a short note in:

    • Internal runbooks.

    • Project onboarding documentation.

5.4. Align with Institutional Document Policies

  • Work with your compliance / records management stakeholders to confirm:

    • The chosen SharePoint site and library meet policy and retention requirements.

    • Permissions in SharePoint align with Jira project access where appropriate.

  • Define:

    • Where to store sensitive documents.

    • Any restrictions on who can upload, modify, or delete files.

5.5. Test and Monitor Regularly

  • Test in a non‑production project first:

    • Different request types.

    • Different user roles (customers vs. agents).

  • Periodically review:

    • That folders are still being created correctly.

    • That links remain valid after any SharePoint or Jira changes.

    • That automation rules have not been accidentally disabled or modified.


6. Getting More Help

If you need deeper customization or run into issues:

  • Review the SharePoint Connector for Jira documentation.

  • Consult internal platform or admin teams if:

    • You require custom folder structures.

    • You are dealing with complex SharePoint permission models.

  • Use the internal automation guide for reference: