Overview
This guide will walk you through establishing a connection required for the Blackbaud Financial Edge (FE) NXT integration. It is divided into three sections.
Section 1: Before You Begin
Blackbaud FE NXT Administrator Role
- The Customer must have the administrator role.
Important Notes
-
The values listed below are generated in Blackbaud FE NXT. The Customer will obtain these values in Section 2. It is important to copy and store these values somewhere safe until they are ready to use in Section 3.
-
- Application ID
- Primary Application Secret
- Primary Access Key
-
Section 2: Prepare Blackbaud FE NXT Account
Task 1: Add Paylocity Application in Blackbaud FE NXT, Add Redirect URIs, and Change Scope to Full Data Access
- Step 1: Log in to Blackbaud FE NXT. Click your user icon located at the top right of your screen.
- Step 2: Select Blackbaud Account from the drop-down menu.
- Step 3: On the next screen, select SKY Developer.
- Step 4: Select My applications.
- Step 5: Click the Add button located at the top of your screen.
-
Step 6: Complete the Add Application form using the values below for each highlighted field below. Then, click the Save button.
- Application Name: Paylocity
- Application Details: Paylocity Integration
- Publisher: Paylocity
- Application Website URL: https://paylocity.com
The Paylocity application is created.
- Step 7: Under Redirect URIs, click the Edit redirect URIs button. (Note: You will have to add two redirect URIs.)
- Step 8: Select Add a redirect URI.
-
Step 9: Enter the following Redirect URI into the empty field as shown in the screenshot below. Then, click the Add a redirect URI button.
-
- https://app.csnapstage.com/oauth_flow/complete
-
- Step 10: Enter the following Redirect URI into the empty field as shown in the screenshot below. Then, click the Save button.
-
-
- https://app.cloudsnap.com/oauth_flow/complete
-
- Step 11: You will be taken back to the Paylocity application screen. Under Scopes, click the Edit scopes button.
- Step 12: Select Full data access. Then, click the Save button.
Task 2: Obtain Application ID and Primary Application Secret
- Step 1: If you are completing this task immediately following the previous task (Section 2, Task 1), the Paylocity screen will still be open. If not, follow Steps 1-4 in Section 2, Task 1, and then click into the Paylocity application.
- Step 2: At the top left of your screen, you will see the Application ID and Primary Applicaiton Secret. Click Show to expose the values, and then click the clipboard icons to copy the values. (Note: Make sure to paste these values somewhere safe and easily accessible, because you will need these in a later section).
Task 3: Obtain API Subscription
- Step 1: Click your user icon located at the top right of your screen.
- Step 2: Select Blackbaud Account from the drop-down menu.
- Step 3: On the next screen, select SKY Developer.
- Step 4: Select My subscriptions.
- Step 5: Under Standard APIs, you will find the Primary Access Key. Click Show to expose the value, and then click the clipboard icon to copy the value. (Note: Make sure to paste this value somewhere safe and easily accessible, because you will need this in a later section).
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 Blackbaud Financial Edge NXT application. Click the application icon or anywhere within the row where the Blackbaud Financial Edge NXT application is located.
- Step 4: You will be taken to the Blackbaud FE NXT 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 Blackbaud
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. It will take you to the Connect Paylocity to Blackbaud Financial Edge NXT screen. The fields are Application ID, Primary Application Secret, and Primary Access Key. Paste the values you obtained in Section 2 here.
- Step 2: Click Update App.
- Step 3: You will see the screen below. Click the Connect button.
- Step 3: You will be taken back to Blackbaud and prompted to authorize the integration. Click the Authorize button.
- Step 4: 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 Blackbaud 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 Blackbaud Financial Edge NXT connection has been established, and the connection can be used for Blackbaud Financial Edge NXT.
- If the connection fails, check and correct the Blackbaud Financial Edge NXT credentials.
-
If successful, a green checkmark will appear to the left of the Test Connection button.
Comments
0 comments
Please sign in to leave a comment.