This guide will walk you through configuring event notifications and stored procedures in CL Connect. This article assumes the API communication between Platform Management and CL Connect has been established already.

 

NOTE: Instructions for setting up the secure communication between Platform Management and the IIS website, CL Connect, are in this article: Setup API Credentials in Platform Management

  

Step by Step Guide:

 

1.  Navigate to the CL Connect landing page and select the Clicking Here option on Step 1 - Setup CL Connect 

 

 

Initial Setup:


2. Select the check boxes for Event Notifications and Stored Procedure.


3. Click on the Event Notifications on the left menu.

 

 

Event Notifications:


4. Enter the event numbers CL Connect should be listening for.


5. Select Procedure in the dropdown menu for the method for each event to indicate this is going to call a stored procedure. 


6. The database command field will be the package name followed by the stored procedure name.

 

INFO: The package/stored procedure name in the example is from the Banner stored procedure for StudentForms template.

 

  • Connection Type: Select DSN

 

NOTE: Here are instructions to Install ODBC Drivers and Create a DSN.

 

  • DSN Name: This will be the name created for the DSN.

 

  • DSN Username: This will be the username created for the DSN.

 

  • DSN Password: This will be the password created for the DSN. 


7. Click on the Test Database Connection button.

 

If the credentials have been forgotten or need to be reconfigured then go to Administrative Tools and take a look at the ODBC Data Sources. From here, test the connection to be sure the stored procedure can be accessed.

 

8. Click on the Continue button.

  

 

Stored Procedure Settings:


  • Stored Procedure Name: Enter the package name of the stored procedure.


INFO: The package/stored procedure name in the example is from the Banner stored procedure for StudentForms template.


9. Click on the Add Stored Procedure button.

 

 

Parameter Values:


This is another potential deviation from the Banner stored procedure for StudentForms template. Here the parameters added will be passed to the stored procedure. If anything is modified in the procedure to add additional parameters then it must be mirrored to the CL Connect configuration as well.


In the Banner stored procedure for StudentForms template has 5 different parameters: 


 

10 . Click on the Add button below the Parameter Values.

 

 

Enter each parameter value listed in the procedure must be created in the same order here. 


  • Name: This must match the value in the stored procedure.


  • Data Type: This must match the value in the stored procedure.


  • Length: (if applicable) This must match the value in the table.


  • Source Field: This is the CampusLogic variable name for data sent with the Event Notifications.

  

NOTE: This articles provides more details related to data values for the events with the attached spreadsheet: Event Notifications Guide and they are defined in the Event Property Values section below.

 


Event Property Values:

 

NOTE: Only event values (ie: values starting with Event) can be used in the eventNotifications dbCommandFieldValue. The documentSettings dbCommandFieldValue and propertyFieldValue have access to all of the properties listed below.


Property ValueDescription
EventIdRepresents the unique identifier of the event notification. This value is always present.
EventNotificationIdThe event notification Id defined in the web.config from the Student Verification > School Settings > Integration > Event Notification>Select the appropriate dropdowns> Select the recommended event notifications - generally 101,104, 105, 107 and 403.
EventNotificationNameRepresents the name of the event notification. This value is always present.
EventDescriptionRepresents the description of the event notification. This value is always present.
EventDateTimeUtcStandardThe date and time in UTC that the event occurred, format:  MM/dd/yyyy HH:mm:ss tt
EventDateTimeUtcLongThe date and time in UTC that the event occurred, format:  dddd, MMMMdd, yyyy
EventDateTimeUtcShortThe date and time in UTC that the event occurred, format:  M/d/yyyy
EventStudentIdThis is the school student id provided by the student when they created their user account. This value is present when the event notification is in relation to a student record, otherwise it will be an empty string.
EventSvStudentIdThe unique identifier for the student record in the CampusLogic system. This identifier is optional depending on the type of event notification being sent and may be required when calling the CampusLogic API to retrieve other information. If not applicable this value will be null.
EventSvUserIdThe unique identifier for the student user account record in the CampusLogic system. This identifier is optional and may be required when calling the CampusLogic API to retrieve other information. If not applicable this value will be null.
EventSvTransactionIdThe unique identifier for the student award year transaction in the CampusLogic system. This identifier is optional and may be required when calling the CampusLogic API to retrieve other information. If not applicable this value will be null.
EventAwardYearFormat1The award years associated with the student transaction. This identifier is optional depending on the type of event notification being sent and may be required when calling the CampusLogicAPI to retrieve other information. If not applicable this value will be empty string., format:  2014-2015
EventAwardYearFormat2The award years associated with the student transaction. This identifier is optional depending on the type of event notification being sent and may be required when calling the CampusLogicAPI to retrieve other information. If not applicable this value will be empty string, format: 1415
EventSvDocumentIdThe unique identifier for the associated student document in the CampusLogic system. This identifier is optional and may be required when calling the CampusLogic API to retrieve other information. If not applicable this value will be null.
EventAdditionalInfoIdThe unique identifier for the associated communication event notification in the CampusLogic system. This identifier is optional and may be required when calling the CampusLogic API to retrieve other information. If not applicable this value will be null.
EventSvTransactionCategoryIdThe transaction category associated with the transaction. Available options currently include: 1 = Student Verification, 2 = SAP Appeal, 3 = PJ Dependency Override Appeal, 4 = PJ EFC Appeal, 5 = Other, 51 = Cost of Attendance 
EventAppealTransactionOutcomeIdThe Outcome ID associated with an appeal transaction. Available options currently include "Approved", "Denied", and "Rescinded".
EventSvTransactionTrackingGroupThe Tracking Group name associated with the transaction. For Appeals, this will match the Tracking Group name you assign in StudentForms. For Verification, this will reflect who created the transaction. Current options include "School" or "Student".
EventCommunicationBodyThe body of the communication that was sent. This identifier is optional, and if not applicable this value will be null.
EventCommunicationTypeIdThe typeId associated with a communication. Available options currently include: 1 = Email, 2 = SMS. This identifier is optional, and if not applicable this value will be null.
EventCommunicationTypeThe description of type associated with a communication. Available options currently include "Email", "SMS". This identifier is optional, and if not applicable this value will be null.
EventCommunicationAddressThe address where the communication was sent. Available options would be an email address or phone number. This identifier is optional, and if not applicable this value will be null.
EventCommunicationAddressThe address where the communication was sent. Available options would be an email address or phone number. This identifier is optional, and if not applicable this value will be null.



Document Event Property Values:

 

Property ValueDescription
DocumentFullStoredPathThe full path to where a document is stored.
DocumentNewFileNameThe file name of a newly indexed file.
DocumentOriginalFileNameThe file name of a file that has been indexed.
DocumentStatusThe status of the document
DocumentRejectCommentsThe reject comments for the document if rejected
DocumentRejectReasonThe reason for rejection 
DocumentDateSubmittedThe date the document was submitted to the Student Verification portal
DocumentTypeThe type of the document, this is a unique identifying string.
DocumentNameThe name of the document (default name if not mapped in StudentForms)
DocumentAwardYearIdThe document award year Id, format: 6 (for 2016)
DocumentAwardYearFormat1The document's award year, format: 2014-2015
DocumentAwardYearFormat2The document's award year, format: 1415 (for 2014-2015)


11. The image below shows the parameter setup that should be configured as the Banner stored procedure for StudentForms template.  


As a reminder, if any additional parameters are added to the stored procedure they must be added in CL Connect as well.

  

12. Click on the Continue button.

 

 

Save Configurations:


13. Click on the Save button.

 


14. When this is finished, please move on to this article: SIS Integration Test


Related Articles:


Other schools have shared their stored procedures with us. These can be used for a starting point of creating your own: