1. Browse to File Definitions on the left options panel.

2. Click Add. 

Name: This should match the File Definition Name indicated in either the File Store or Documents section.

File Name Format: This field will allow you to configure the prefix of the file name. For a list of available tokens, please refer to the Event Values in this document.
    Note: If a file is found in the specified file store path with the same name, it will append the current datetime (UTC) to the name of the file. Required.

Include Header Record: Determines whether a header row will be added to the generated file. False by default. Required. 

Index File Extension: The extension for the file. Options available include .txt and .csv. Default is .csv.

Index File Format: The format of the generated file. Options available are csv, csvnoquotes, tabdelimeted, and fixedwidth. Default value is .csv

File Store Mapping Collection: A collection of any fields you would like to configure from your event notifications.


3. Click Add


Field Size: The length of the field

Data Type: The data type for the field. Defaulted to String.

Field Name: The name of the field.

Value Type:

 No Value: To be used when you would like fixed width field to be blank. 

 Basic Property Value: The basic value for the property must be one of the "Event Property Values" shown below.

  

 Constant Value: A constant value to be placed in the index file. For example: documentName: "R".

 Database Command: see dbCommandFieldValue in eventNotificationSettings

 Dynamic Field Value: A string that represents a javascript expression that can be used to alter any of the Existing Event Property Values. For example: dynamicFieldValue="'EventAwardYearFormat1'.substring(5,9)". If this value does not contain valid javascript, then this will cause an error.

  




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>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 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



Next Step: Flat File Testing