How to connect Jira with SharePoint
This "how-to-connect" documentation will explain the
initial configuration of an example connection from Jira to a SharePoint Online List in Office 365. We will be
synchronizing data stored in Jira.
This guide presupposes that you have installed the
Layer2 Cloud Connector and that you are familiar with its basic functionality. The Layer2 Cloud Connector User Documentation will provide you with all
1. Configuring Jira
2. Configuring the Layer2 Cloud Connector
2.1 Creating a new
2.2 Configuring the
Data Entity 1
2.3 Configuring the Data
2.4 Running your
3. Hints and known issues
3.2 Data model
3.3 Batch operations
1. Configuring Jira
You only need the website address from your Jira and an E-Mail address from your Jira environment.
2. Configuring the Layer2 Cloud
2.1. Creating a new connection
Create a new connection by using the Create New
Connection option in the Actions pane (right-hand side). The new connection will appear at the
bottom of the Connection Manager List (left-hand side). Click on your newly created connection to open the
connection configuration settings.
Choose a meaningful name for your connection and replace
the current "New Connection" Connection Title with it.
Connections to Jira can be bi-directional. An initial
connection should always be uni-directional to assure that both data entities are identical before switching to
bi-directional. Therefore, choose Left to Right as Direction. You can change this setting
after your initial synchronisation finished successfully.
2.2. Configuring the Data Entity 1
We will now set up our Data Entities.
Go to the data entity “Data Entity 1” to open the configuration settings.
Choose a Data Entity Title. It is
recommended to give your entities meaningful names to maintain an overview when you decide to set up multiple
Select the Data Provider for Jira from
the data provider list. You can search for Jira by typing into the selection box.
For the Connection String, we need the in step 1 mentioned
information. You can copy the below connection string and adjust it to match your gathered information. Use the
Verify Connection String option to evaluate if the provided connection string is valid.
- "URL" this property points to your Jira website.
- "User" this property points to an existing email address inside your Jira environment.
Enter the user account's password into the Password field.
The field masks the value for better security.
The Select Statement text box is used to define specific
data queries. We will be gathering some fields from our Worklogs table. You can copy the below select
statement and adjust it to match your needs. A more simple select statement can look like this: SELECT * FROM Issues. After adjusting the select statement to your needs, save your changes by using the right-hand pane option Save
SELECT Id, IssueId, IssueKey, Comment, Started, TimeSpent, TimeSpentSeconds FROM Worklogs
check if all necessary columns are received, you can use the Preview Data option on the
right-hand pane which will provide you with a pop-up window showing your sample data from your Jira entity.
Configuring the Data Entity 2
We are going to send the data to a custom SharePoint
Online list. It's required that you set up this list prior to the next steps. Your list should contain matching
columns according to your source entity.
Use the left-hand pane to switch to the data entity
"Data Entity 2". We will be using the Layer2 SharePoint Provider for this
For more information about the SharePoint provider
You can copy the below Connection String
which contains the minimum of required properties to connect to your custom SharePoint Online list.
- "URL=https://your_custom_sharepoint_url/AllItems.aspx;" this property defines the URL of your custom list that
will be addressed.
- "Authentication=Office365;" this property will determine the authentication method used. Office365 is the
default authentication method to access Microsoft Office 365 / SharePoint Online. This method will not work in
case of federation, e.g. ADFS. For further authentication method you can consult the provider specifications
- "[email protected];" this property should describe the user you wish to connect to SharePoint to.
the password that belongs to the user account used in the connection string into the Password field.
Save your changes by using the right-hand pane option Save
the next step, we will configure our mapping settings. Click on the Mappings option on the
left-hand pane. If your fields from SharePoint are named identical to the fields from
your source system, the Enable Auto Mapping option will match those columns. Disabling this
option allows you to match your columns as needed. We enabled auto-mapping in our setup. Save your changes by
using the right-hand pane option Save Changes.
2.4. Running your connection
To run your connection switch back to the main connection configuration node
and use the Run Now Button located on the bottom of the setup page. The Run Synchronization Toolbox will also
display the synchronization process.
is a data preview of the information we have accessed in our source entity:
will be the result in our SharePoint Online list after our initial successful synchronization:
If you want to use a bi-directional syncronization, you can now switch your
connection directon after our first initial synchronization run finished successfully. See section 3.1 for further
3. Hints and known issues
3.1. Connection direction
As far as tested, this connection supports
uni-directional as well as bi-directional synchronizations.
After adjusting the direction to bi-directional, you should check your
Mappings settings again because some systems might include read-only columns that cannot be mapped directly.
We also recommend to choose a Conflict Resolution that matches your
environments needs. You can find out more about the different conflict resolutions in our Layer2 Cloud
Connector User Documentation
3.2. Data model
To see all the tables and
views you can access with the Jira provider, use these queries in the Select Statement:
SELECT * FROM sys_tables
SELECT * FROM sys_views
If there are more tables or views available, you can load them with the
option "load more" in the popup window.
3.3. Batch operations
If you try to make multiple operations at the same
time, you can get an error that batch operations not allowed. Set the parameter
Other=’BatchSize=1’ in your connection string to avoid this error.