1. Configuration Reference for Student Financial Planning
  2. Letter Guide

Letter Guide

Use this workbook to associate letter codes defined in the reporting tool to the appropriate message triggering action.

Workbook Description

The file name for this workbook is LETTER.csv.

Configuration Workbooks are delivered in the form of Excel spreadsheets. In these spreadsheets, every configurable field is represented as a spreadsheet column and there are as many spreadsheet rows as needed for that particular configuration. Here are the column descriptions:
  • Field Name.
  • Column: Spreadsheet column associated with the field.
  • Required?: Denote if you're required to populate the field or not.
  • Field Type and Accepted Values:
    • String: These are usually alphanumeric.
    • Integer: Numeric, a whole number.
    • Double: Numeric with places to the right of the decimal.
    • Enumeration: List of values.
    • Boolean: True or False, Yes or No.
    • Groovy script: A logical query using groovy script.
    • Date: yyyy-mm-dd format.
  • Description.
Field Name Column Required? Field Type and Accepted Values Description
MAPPING_ ACTIVE A Y

Enumeration

List of enumerations:
  • TRUE
  • FALSE

Determines if the Triggering Event is activated to trigger Letters.
MESSAGE_CLASS B Y

Enumeration

List of enumerations:
  • FasCreditBalanceInformationEvent
  • FasDisbursementAcceptanceInformationEvent
  • FasDisbursementAcceptanceInformationV2Event
  • FasDisbursementCancelEvent
  • FasDisbursementInformationEvent
  • FasDocumentRejectedEvent
  • FasDocumentRequestCanceledEvent
  • FasDocumentRequestEvent
  • FasFinancialPlanOutboundEvent
  • FasGrantOverpaymentReferralEvent
  • FasProfessionalJudgementProcessOutboundEvent
  • FasReleaseStudentRecordHoldEvent
  • FasReturnToLenderEvent
  • FasSapAcademicInformationEvent
  • FasSapAppealsProcessInformationEvent
  • FasStudentAwardInformationEvent
  • FasStudentAwardInformationV2Event
  • FasStudentNotificationEvent
  • FasStudentRecordHoldPlacedEvent
  • FasValidIsirProcessStatusInformationEvent
  • TeachEligibilityCheckFailed
  • TitleIvEligibilityCheckFailed

Name of Letter Triggering Event.
REPORT_NAME C Y

Enumeration

List of enumerations:
  • FasDocumentRequestReport
  • FasSapAcademicInformationReport
  • FasSapAppealsProcessInformationReport
  • FasStudentAwardInformationReport
  • FasDisbursementInformationReport

Name of JRXML file called by the Letter Triggering Event.

This is only used for Jaspersoft letter generation.
DEFN_ACTIVE D Y

Enumeration

List of enumerations:
  • TRUE
  • FALSE

Determines if the Letter is active in SFA.
CUSTOMER_LETTER_CODE E Y

String

Alphanumeric ASCII text, up to 255 characters.

Customer-defined Letter Code of Letter.
LETTER_CODE F Y

String

Alphanumeric ASCII text, up to 255 characters.

Letter Code of Letter that SFA uses within its Letter triggering logic. This Letter Code must match the Letter Code returned by the corresponding _LetterCode.jrxml file.
LETTER_DESC G Y

String

Alphanumeric ASCII text, up to 255 characters.

Description/Name of Letter.
LETTER_DELAY H N

Integer

Measured in Minutes:
  • 1 = 1min
  • 60 = 1hr
  • 120 =2hr

Letter Delay

A NULL value for this field allows its respective Letter to be generated in real-time.
Letter_Code_Criteria I Y Groovy script Use this Groovy script to define when a Letter is generated for a specific LETTER_CODE after the triggering event.

Enable the Configuration in the UI

You do not have to complete any setup in the user interface to enable this configuration.

Required Permissions

You must have a role with this General Permission through Roles Management to view the configuration in the UI.

  • Student

See Set General Permissions Matrix.

Considerations for Configuration

The following event messages can be leveraged to trigger a letter.

Note: Event applicable to SFP only are indicated.
  • FasCreditBalanceInformationEvent-SFP only
  • FasDisbursementAcceptanceInformationEvent-SFP only
  • FasDisbursementAcceptanceInformationV2Event-SFP only
  • FasDisbursementCancelEvent-SFP only
  • FasDisbursementInformationEvent-SFP only
  • FasDocumentRejectedEvent
  • FasDocumentRequestCanceledEvent
  • FasDocumentRequestEvent
  • FasFinancialPlanOutboundEvent-SFP only
  • FasGrantOverpaymentReferralEvent-SFP only
  • FasProfessionalJudgementProcessOutboundEvent
  • FasReleaseStudentRecordHoldEvent-SFP only
  • FasReturnToLenderEvent-SFP only
  • FasSapAcademicInformationEvent-SFP only
  • FasSapAppealsProcessInformationEvent-SFP only
  • FasStudentAwardInformationEvent-SFP only
  • FasStudentAwardInformationV2Event-SFP only
  • FasStudentNotificationEvent
  • FasStudentRecordHoldPlacedEvent-SFP only
  • FasValidIsirProcessStatusInformationEvent
  • TeachEligibilityCheckFailed-SFP only
  • TitleIvEligibilityCheckFailed-SFP only
  • FasFinancialPlanOutboundV2Event-SFP only

Related Topics