This guide will walk-through how to setup Document Event Notifications in CL Connect. This article assumes that the API communication between Platform Management to the CL Connect server is working properly. This will configure CL Connect to be listening for the events that are subscribed to in Platform Management.
Step by Step Guide:
1. Sign into the server where CL Connect is installed.
2. Create/identify a folder location for the document files.
NOTE: This article links to steps to Create/Identify Network Folders
3. Navigate to the CL Connect landing page.
4. Click on the first “Clicking Here…” for Setup CL Connect.
Initial Setup:
5. On the Initial Setup page, select Event Notifications, Documents, and File Definitions.
NOTE: Only select File Definitions if an accompanying index file is wanted with the document files.
Event Notifications:
6. Select Event Notifications (image below) on the left-hand menu.
7. Enter the Events that were subscribed to in Platform Management.
INFO: If you have not subscribed to events in Platform Management yet, please go back to this article.
8. Select Document Retrieval from the dropdown menu.
NOTE: Connection Type is dependent on the SIS integration. If the SIS integration is completed, do not change this. If it is not, change it to None.
9. Click on the Continue button.
Document Form:
10. The Document Storage File Path (image balow) will be the folder location to save the output files from CL Connect.
INFO: If a folder location has not been created yet, please follow the steps outlined in this article to Create/Identify Network Folders
11. Click on the Test button to test the connection/permissions to the file path.
12. Select True/False if an index file is wanted.
13. If an Index File Enabled = True, then enter the File Definition Name.
NOTE: The File Definition Name on the Document Form page MUST match the Name for the File Definition section that is coming up next.
14. Click on the Continue button.
NOTE: If the Index File Enabled = False, skip to step 19.
File Definitions:
15. Click on Add.
- Name: This should match the File Definition Name indicated in the Documents section.
- File Name Format: This is the file name for both the document and index files. You can use a combination of static and dynamic text. See Event Property Values below for dynamic text options.
NOTE: If a file with the same name is found in the specified Document Storage File Path, it will append the current datetime (in UTC) to the name of the file.
- Include Header Record: Determines whether a header row will be added to the generated file. Default is False.
- File Extension: The extension for the file. Options available include txt and csv. Default is csv.
- File Format: The format of the generated file. Options available are CSV, CSV No Quotes, Tab Delimited, Fixed Width, and XML. Default value is CSV.
- File Mapping Collection: A collection of any fields configured for the event notifications output.
16. Click on Add under the Field Mapping Collection for the fields that will appear in the index file.
Field Size: The length of the field. (Maximum is 255)
Data Type: The data type for the field. (Default is String)
Field Name: This will be the column header.
Value Type: (see option below)
- No Value: To be used when expecting the field to be blank.
- Basic Property Value: The basic value for the property Event Property Values shown below.
Event Property Values:
| Property Value | Description |
| 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>Select the appropriate dropdowns> Select the recommended event notifications - generally 101,104, 105, 107 and 403. |
| 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 occurred, format: MM/dd/yyyy HH:mm:ss tt |
| EventDateTimeUtcLong | The date and time in UTC that the event occurred, format: dddd, MMMMdd, yyyy |
| EventDateTimeUtcShort | The date and time in UTC that the event occurred, 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, 5 = Other, 51 = Cost of Attendance |
| EventAppealTransactionOutcomeId | The Outcome ID associated with an appeal transaction. Available options currently include "Approved", "Denied", and "Rescinded". |
| EventSvTransactionTrackingGroup | The 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". |
| 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. |
| 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 Property Values:
| Property Value | Description |
| 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 (default name if not mapped in StudentForms) |
| 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 (for 2014-2015) |
ScholarshipUniverse Event Property Values
| Property Value | Description |
| StudentId | This is the school student id provided by the student when they created their user account. |
| SuAmount | Amount awarded for the scholarship. |
| SuAwardYearName | Name of the Award Year related to the scholarship. |
| SuClientTermId | Internal identifier for each term created. |
| SuDepartmentName | Name of the department associated with the scholarship. |
| SuDonorName | Name of the donor of the scholarship. |
| SuFundCode | Fund Code associated with the scholarship. |
| SuFundCodeAlternates | Fund Code alternative names (ex. SIS12345). |
| SuOrganizationName | Name of the organization associated with the scholarship. |
| SuPostAmountAdjustment | Adjusted amount of a scholarship award. |
| SuPostBatchUser | The name of the user who batch posted an award. |
| SuPostType | Status type of an award (Add, Update or Cancel). |
| SuScholarshipAwardId | Internal identifier associated with an award. |
| SuScholarshipId | Internal identifier associated with a scholarship. |
| SuScholarshipName | Name of the scholarship. |
| SuStudentFirstName | First name of the student associated with the award. |
| SuStudentLastName | Last name of the student associated with the award. |
| SuTermComments | Comments in ScholarshipUniverse associated with the term. |
| SuTermName | Name of the term the award is associated with. |
| UpdatedByUser | ID of the staff member who last updated the award. |
| UpdatedByUsername | Username of the staff member who last update the award. |
- Constant Value: A constant value to be placed in the index file.
INFO: For the example, Location = ChandlerCampus
- Database Command: If CL Connect has a ODBC/DSN connection to the SIS database or Connection String then database commands can be written here.
- Dynamic Field Value: A string that represents a JavaScript expression that can be used to alter any of the existing Event Property Values.The Event Property Values require single quotes around them or it will not work.
INFO: For example, Dynamic Value = 'EventAwardYearFormat1'.substring(5,9)
If this value does not contain valid JavaScript, then this will cause an error in the Log Records.
17. When the Field Mapping is complete for the index file click on Save.
18. Click on Continue.
Save Configurations:
19. Finally Save Configurations by clicking on the Save button on the right-hand side.
Troubleshooting: Document Imaging Common Issues
Testing: Document Imaging Testing