This guide will walk you through setting up CL Connect for the Award Letter Print integration 

Allows configuration in regards to the process for AwardLetter that pulls Award Letters with the template type of Print into a designated file.



To set this up, please do the following:


1. Open CL Connect and navigate to the Event Notifications tab

2. Click Add another event. Then, enter a 501 in the events to respond to field and change the dropdown to Print.



3. Next, click on the Award Letter Print tab on the left.


4. Enter the path to the Award Letter Print folder you created


5. Enter 'EventStudentId' in the File Name Format field .





*UploadPath: The path where the pdfs will be dropped. The path must be different then all of the other designated in the CLConnect application. You must also allow the appropriate read/write permissions on the specified path.  

File Name Format:  The name of the file. Default value will be StudentId.pdf if none specified.



4. Finally, contact your CSM and let them know that you would like to proceed with the print integration. Additional work must be completed by CampusLogic's product team on the back end.



Available tokens:
  • AlTemplateType: This token allows for the type of template (i.e. undergrad vs graduate) to be displayed in the name of the output files.
  • 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


* = Required


Web.config example:


ieWU5MD-jEXnVst2mtorzbQWUJRVIfUvng.png



 

Once this is complete, please move on to the next guide here: Award Letter Print Testing