This guide will walk you through configuring event notifications and stored procedures in CL Connect.



1.  Open to the machine that CL Connect is installed on. Launch the CL Connect application, and click on the first step for the wizard.


From within the wizard go to the Initial Setup step and enable both Event Notifications and Stored Procudure (if you have not already):

blob1478108505256.png


Next you would click on Event Notifications on the left hand side of the menu, and then configure the event notifications you want the application to listen for:


blob1478108777758.png


When configuring the event notifications you want the handle method to be Procedure for each event to indicate this is going to call a stored procedure. The database command field will be the package name followed by the stored procedure name, note that the package/stored procedure name in the example is from the provided default procedure. If you change the stored procedure name and/or package name ensure to put update that field.


blob1478206404794.png    



Step 6 - CL Connect DSN

The next step on that page is to ensure you can connect to the DSN you had previously established.  Select DSN as the connection type then enter the DSN name you created previously for the database connection.  Next, enter the database username and password to be used when connecting to the database using the DSN connection.  If you have forgotten the credentials you set up, or need to reconfigure them go to your Administrative tools and take a look at your ODBC Data Sources. From here you can test the connection to be sure the stored procedure can be accessed.

blob1478109252689.png




Step 7 - CL Connect Stored Procedure

Click continue and we will now set up the Stored Procedure. First you enter the package.name of the Stored Procedure, in the example below we are using the name and packaged used in the provided default stored procedure, but ensure your the package and name you enter matches any changes you may have made. Then click Add Stored Procedure:

blob1478206806686.png

The next step is another potential deviation from the default stored procedure provided below. Here you will be adding all of the parameters that need to be passed to the stored procedure. If you have modified the procedure and added additional parameters please add them in this step as well.


In the default stored procedure we have 5 different parameters: 

 PROCEDURE p_transaction (StudentId VARCHAR2,

                            AwardYear VARCHAR2,

                            TransactionCategoryId INTEGER,

                            EventNotificationId INTEGER,

                            DocumentName VARCHAR2);


So on this page we would hit the add button, and for the first parameter enter the following information:

blob1478109991098.png


The Source Field is our variable name for the different information that gets sent with event notifications, these are defined under the event property values section below.


The image below shows the parameter setup that should be configured as the default based on the unchanged stored procedure.  Again as a reminder: if you add any additional parameters to the stored procedure please add those parameters in this step accordingly:

blob1478124114442.png




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.


Event values:

  • EventId:  represents the unique identifier of the event notification.  This value is always present.
  • EventNotificationId: the event notification Id defined in the web.config from the Student Verification > School Settings > Integration > Event Notification
  • EventNotificationName: represents the name of the event notification.  This value is always present.
  • EventDescription: represents the description of the event notification.  This value is always present.
  • EventDateTimeUtcStandard: the date and time in UTC that the event occured, format: MM/dd/yyyy HH:mm:ss tt
  • EventDateTimeUtcLong: the date and time in UTC that the event occured, format: dddd, MMMMdd, yyyy
  • EventDateTimeUtcShort: the date and time in UTC that the event occured, format: M/d/yyyy
  • EventStudentId: this 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.
  • EventSvStudentId: the 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.
  • EventSvUserId: the 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.
  • EventSvTransactionId: the 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.
  • EventAwardYearFormat1: the 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
  • EventAwardYearFormat2: the 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
  • EventSvDocumentId: the 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.
  • EventAdditionalInfoId: the 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.
  • EventSvTransactionCategoryId: the 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.
  • EventAppealTransactionOutcomeId: the outcomeId associated with an appeal transaction. Available options currently include 1 = Approved, 2 = Denied, 3 = Rescinded
  • EventCommunicationBody: the body of the communication that was sent. This identifier is optional, and if not applicable this value will be null.
  • EventCommunicationTypeId: the 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.
  • EventCommunicationType: the 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.
  • EventCommunicationAddress: the 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 values:

  • DocumentFullStoredPath: the full path to where a document is stored.
  • DocumentNewFileName: the file name of a newly indexed file.
  • DocumentOriginalFileName: the file name of a file that has been indexed.
  • DocumentStatus: the status of the document
  • DocumentRejectComments: the reject comments for the document if rejected
  • DocumentRejectReason: the reason for rejection 
  • DocumentDateSubmitted: the date the document was submitted to the Student Verification portal
  • DocumentType: the type of the document, this is a unique identifying string.
  • DocumentName: the name of the document(original)
  • DocumentAwardYearId: the document award year Id, format: 6 (for 2016)
  • DocumentAwardYearFormat1: the document's award year, format: 2014-2015
  • DocumentAwardYearFormat2: the document's  award year, format: 1415




Once this is finished, please move on to the 'SIS Integration Test' page.