SharePoint Connector for Jira - Cloud

Action reference

Each SharePoint action in Jira automation has its own input fields and outputs. This page lists them for every action, together with how the action behaves in special situations.

Create SharePoint folder

Creates a folder in a SharePoint document library. Use it to give each work item, space or request type its own place for files. To show the folder on the work item in the SharePoint Connector for Jira panel, follow the Connect SharePoint item to work item step.

Inputs

Field

Required

Description

Site

REQUIRED

The SharePoint site

Document library

REQUIRED

The Document library within the site

Folder path

OPTIONAL

An existing (sub)folder in the document library. Leave empty to use the library root.

Folder name

REQUIRED

Name of the folder to be created. Supports smart values, for example {{issue.key}}.

Outputs

Smart value

Description

{{createdSharepointItem.folderUrl}}

URL of the created folder

Behavior

Situation

Result

Folder already exists

CONTINUES Action continues and returns the existing folder

Folder path does not exist

FAILS Action fails

The folder path is the parent location where the new folder is created; if that parent path does not exist, the folder cannot be created.

Get SharePoint item

Looks up an existing file or folder by its path and makes its URL available to later actions. Use it when the item already exists, for example because another rule created it, and you want to upload to it, disconnect it, or delete it.

Inputs

Field

Required

Description

Site

REQUIRED

SharePoint site of the item

Document library

REQUIRED

Library within the site

Item path

REQUIRED

Path to the file or folder in the library, for example {{issue.key}} or Archive/{{issue.key}}

Outputs

Smart value

Description

{{fetchedSharepointItem.itemUrl}}

URL of the item

Behaviour

Situation

Result

Item does not exist

FAILS Action fails

Upload Jira attachment to SharePoint

Copies an attachment from the current work item to a SharePoint folder. Use it to store files in SharePoint instead of Jira. The attachment stays on the work item unless a later action in the rule removes it.

Inputs

Field

Required

Description

Location

REQUIRED

URL of the target folder, for example {{createdSharepointItem.folderUrl}}

Attachment name

REQUIRED

Name of the attachment, for example {{changelog.Attachment.toString}}

Conflict behaviour

REQUIRED

Select Keep both, Overwrite or Skip. See Behavior below.

Outputs

Smart value

Description

{{createdSharepointUpload.itemUrl}}

URL of the uploaded file

{{createdSharepointUpload.uploadedFileName}}

File name in SharePoint

{{createdSharepointUpload.folderUrl}}

URL of the target folder

{{createdSharepointUpload.siteName}}

Name of the site

{{createdSharepointUpload.libraryName}}

Name of the document library

Behavior

Situation

Result

File name exists, Keep both is selected

File is uploaded with a suffix, for example file_1.pdf.

File name exists, Overwrite is selected

Existing file is replaced. No new version is created.

File name exists, Skip is selected

File is not uploaded.

Connect SharePoint item to work item

Adds a SharePoint file or folder to a work item’s SharePoint panel, so users can open it directly from Jira. Use it after you create a folder or upload a file. The item itself stays in SharePoint.

Inputs

Field

Required

Description

Work item

REQUIRED

Key of the work item. Use {{issue.key}} for the work item the rule runs on.

Item URL

REQUIRED

URL of the file or folder, for example {{createdSharepointItem.folderUrl}} or {{createdSharepointUpload.itemUrl}}

Outputs

None.

Behavior

Situation

Result

Item is connected

The item appears in the work item’s SharePoint panel. The panel must be open on the work item.

Disconnect SharePoint item from work item

Removes a SharePoint file or folder from a work item’s SharePoint panel. The item itself stays in SharePoint. Use it before deleting a folder so the panel doesn't show a broken link.

Inputs

Field

Required

Description

Work item

REQUIRED

Key of the work item. Use {{issue.key}} for the work item the rule runs on.

Item URL

REQUIRED

URL of the file or folder, for example {{createdSharepointItem.folderUrl}} or {{createdSharepointUpload.itemUrl}}

Outputs

Smart value

Description

{{updatedSharepointItem.wasItemDisconnected}}

true if the item was disconnected

Behavior

Situation

Result

Item is not connected to the work item

CONTINUES Action continues

Delete SharePoint folder

Deletes a SharePoint folder, identified by its URL. Use it to clean up Exchange folders you no longer need. By default, it deletes only empty folders, so no files are accidentally lost.

If you turn off Only delete if empty, the action also deletes folders that contain files. It deletes the files along with the folder.

Inputs

Field

Required

Description

Folder URL

REQUIRED

URL of the folder, for example {{fetchedSharepointItem.itemUrl}}

Only delete if empty

OPTIONAL

If on, the action only deletes the folder when it is empty. On by default.

Outputs

Smart value

Description

{{deletedSharepointItem.wasFolderDeleted}}

true if the folder was deleted

Behavior

Situation

Result

Folder is not empty and Only delete if empty is on

CONTINUES Action continues without deleting. wasFolderDeleted is false.

Folder does not exist

FAILS Action fails

Item is not a folder

FAILS Action fails