Connect to Atlassian

Overview

This guide will walk you through establishing a connection required for the Atlassian integration. It is divided into three sections.

• Before You Begin
• Prepare Atlassian Account
• Establish Connection

Section 1: Before You Begin

Atlassian Administrator Role

• The Customer must have the administrator role in Atlassian.

Important Notes

• The Customer will obtain these values from Atlassian (see Section 2). It's important to copy and store these values somewhere safe until they are ready to use in Section 3. The API Token can only be shown once, so it is imperative that you save this value securely once it's created.
  • • Email
    • Company Subdomain
    • API Token

Section 2: Obtain API Token and Company Subdomain from Atlassian

Task 1: Obtain Atlassian API Token

This Task will be completed by the Customer.

• Step 1: Log in to https://id.atlassian.com/manage-profile/security/api-tokens
• Step 2: Click the Create API token button.

• Step 3: The Create an API token pop-up will appear. In the Label field, enter Paylocity Integration. Then, click the Create button.

• Step 4: Copy your new API Token and store it securely. For security reasons it isn't possible to view the token after closing the creation dialog.

Task 2: Find Atlassian Subdomain

This Task will be completed by the Customer.

• Step 1: Log in to your Atlassian account as an administrator. 
• Step 2: You will need to obtain your Atlassian Company Subdomain. In the address bar, copy the first part of the URL as shown in the screenshot below. This is the Company Subdomain and it will be needed to complete the next section. Make sure to copy it and save it somewhere accessible.
  • • Note: The below screenshot is just an example, and your Domain Name will be different. 

Section 3: Establish Connection

Task 1: Paylocity Representative Generates Link

This Task will be completed by a representative from Paylocity while on a call with the Customer. 

• Step 1: On the left menu, click/expand Integration Management.

• Step 2: Click Apps from the drop-down menu.

• Step 3: Scroll down until you see the Atlassian application. Click the application icon or anywhere within the row where the application is located.

• Step 4: You will be taken to the Atlassian screen. Click the App Options button on the top right of your screen.

• Step 5: Select Generate link from the drop-down menu.

• Step 6: A link will appear under the App Options button. Copy the link by highlighting the text, right-clicking, and selecting Copy.

• Step 7: At this point, Paylocity will provide the link to the Customer while on the call and keep the current Cloudsnap page open. 

Task 2: Customer Connects to Atlassian

This Task will be completed by the Customer while still on the call with their Paylocity representative. 

• Step 1: Paste the link into your browser and press Enter. It will take you to the Atlassian screen. The fields are Email, Company Subdomain, and API Token. Paste the values you obtained in Section 2 here. 
  • • Email: Use your Atlassian administrator Email here.
    • Company Subdomain: See Section 2, Task 2.
    • API Token: See Section 2, Task 1. 

• Step 2: Click Update App. 

• Step 3: You will see the screen shown below. This indicates that your credentials were stored for the integration.

Task 3: Paylocity Tech Services Confirms Connection in Cloudsnap

This Task will be completed by a representative from Paylocity while on the call with the Customer. 

• Step 1: After the Customer confirms that their credentials have been stored (Section 3, Task 2, Step 4), click the Test Connection button in Cloudsnap at the top right of your screen. If you are no longer on the Atlassian page in Cloudsnap, follow Steps 1-3 in Task 1 of this section. 
  • If successful, a green checkmark will appear to the left of the Test Connection button. 
    • If the connection succeeds, this indicates that the Atlassian connection has been established, and the connection can be used for Atlassian.
    • If the connection fails, check and correct the Atlassian credentials.