Body
Overview
Campus Logic provides some extremely good documentation on standing up the Connect server. The initial on-boarding email provided links to all this documentation that's hosted on their Freshdesk site.
- Server Specs: https://campuslogicinc.freshdesk.com/solution/articles/5000701770-cl-connect-minimum-system-requirements
- Firewall Rules: https://campuslogicinc.freshdesk.com/support/solutions/articles/5000721492
- Setup CL Connect Guides: https://campuslogicinc.freshdesk.com/solution/folders/5000284765
The documentation was generated with Windows 2012R2 as the OS platform. Since any servers deployed today are a minimum of Win2019, just follow the procedures, substituting .Net 4.7 for .Net 4.5.
Once you have successfully completed the IIS and CL Connect Settings document then you are ready to create and test the API connectivity that's discussed in their Setup API Credentials document.
To complete the API setup, you must have access to Platform Manager. I am using our sandbox/test environment to create this documentation
Outbound API Connection (NIC to Campus Labs)
- Log into Platform Management using this URL: https://nicsandbox-pm.campuslogic.com
- You will be prompted to select which Application you want to Manage, select ScholarshipUniverse and click Continue
- From your CampusLogic environment, select your user icon in the top, right corner and click Platform Management
- Select the Integration option in the left menu
- and click the Credentials Management tile
- Click the Add+ button in the top, right corner to generate a new set of credentials
- It will create a username and a password. Make a note of the password since we will need to enter those later when we configure the Connect server you built
- Now Remote Desktop or console into the Connect server you built
- At the desktop, launch a browser and navigate to http://localhost. Once the CL Connect window appears, click the Clicking here... link for #1 Setup CL Connect
- From the Initial Setup page, select either Sandbox or Production from the drop-down menu depending on the environment you're setting up. Then you can either click Continue at the bottom or click the API Credentials link on the left to move forward
- Enter in the Username and Password you created in PlatformManagement and click Test
- If the test comes back with a green "Connection Successful" message, you've entered in the correct credentials
- If the test comes back with a red "Invalid Credentials" message, double-check that the credentials you're entering are correct
- This verifies the connectivity sourced from the on-premise connect server to the Campus Lab instance in the cloud.
Inbound API Connectivity (Campus Labs to NIC)
- Log into ScholarshipUniverse and launch Platform Management
- Click on Integration on the left navigation pane and select Event Notifications
- Select the Add button under Client Endpoints (if there is already a URL here, you'll have an edit icon represented by a pencil)
- Complete the following fields:
- Endpoint URL
- This is the URL assigned to your instance of CL Connect. You must append "/api/NotificationEvent" to the end of the URL. This is where our system writes the events data. For us, this is https://tclconnect.nic.edu/api/NotificationEvent for test and https://clconnect.nic.edu/api/NotificationEvent for production
- Username
- This is not generated by the system. Just so that it's easily identifiable, I just used the same username provided by the outbound connection and added "_inbound" as a suffix.
- Password
- Click the Generate New Password button to create one. This is generated by the system and cannot be altered.
- Before you click on Test Endpoint, we have to add this account on the Connect Server. Remote back into the console of the Connect server and bring up the CL Connect Setup screen - At the desktop, launch a browser and navigate to http://localhost. Once the CL Connect window appears, click the Clicking here... link for #1 Setup CL Connect
- Click on Applications Settings and enter in the Username and Password you just created in Platform Management under "Incoming API"
- Click on Continue and then Select Save Configurations on the bottom of the left navigation window
- Now you can go back into Platform Management under Integration->Event Notifications and test that Client Endpoint you created earlier. Click on the Edit icon
- And then click on Test Endpoint
- If all is well, you should see the following message in green:
- Now be sure to SAVE the configuration
That completes the communications setup between Campus Logic and the on premise Connect server