Optional Source Formats for Liaison CAS
  • 16 Nov 2023
  • 6 minute read
  • Dark
    Light
  • PDF

Optional Source Formats for Liaison CAS

  • Dark
    Light
  • PDF

Article summary

There are two optional source formats available, described below, that may be configured if desired:

  • All CAS by Liaison - In Progress Applications

  • All CAS by Liaison - Coursework

In Progress Applications Source Format

Applicants who are In Progress have selected at least one of your programs, but have not yet submitted their application. Depending on the CAS, you may be able to receive full or partial data for these applicants. Consult Liaison's documentation for your CAS to determine if there are any visibility restrictions on In Progress applications.

Add the Source Format

To add the All CAS by Liaison - In Progress Applications source format:

  1. Select Database from the top navigation bar and select Source Format Library.

  2. Search for "All CAS by Liaison - In Progress Applications" and select Add.

  3. Navigate to the new source format and click Edit.

  4. On the Import Automation tab, update the Import Path/Mask field to specify the file path and file name pattern that the source format should use to pick up the file. For example: liaison/casapi-app-started_*.csv

    mceclip0.png

    These file names will be configured in the CAS API subscription step.

    For example, in the subscription, to configure the data files to correspond with the Import Path/Mask value liaison/casapi-app-started_*.csv, the following settings in the CAS API subscription can be used:

         "sftpBaseDirectory": "/incoming/liaison/",
         "sftpPathTemplate": "casapi-app-started_
                              ___
                              _.csv"

    Note: The user account added in the previous step has access to the /incoming/liaison/ directory. If you choose to configure the CAS API subscriptions to deliver data files to different directories, then the user account must be updated to grant it access to those additional directories. Using the example path and file name pattern shown above, the pre-configured access settings can be used.

Important!

You will not be able to map any fields until you receive or manually upload a file from Liaison.

Be sure to use a sample file delivered by the CAS API subscription for an in-progress application to ensure that all possible data points are included. By default, blank/null values are not sent via CAS API subscriptions, so if you need to adjust remap settings for a particular source field, and you do not see it on the Fields page, you will need to upload this sample file again.

Configure the Remap Settings

To configure the remap settings for the All CAS by Liaison - In Progress Applications source format:

  1. Select Database from the top navigation bar and select Source Formats.

  2. Find the All CAS by Liaison - In Progress Applications source format and select Remap to confirm destinations and to set up additional data mappings for this source format.

  3. After selecting Remap, you will see all of the Slate destination fields currently mapped for the data points included in the file.

There is a unique for merging field that is used to properly match subsequent application data to the appropriate person record within Slate. This field is pre-mapped in the All CAS by Liaison - In Progress Applications source format:

  • CAS/Liaison Person ID

This field is automatically created during an overnight process that occurs after you have added the All CAS by Liaison - Applications source format. The following field is pre-mapped and should not be adjusted, nor should other fields be mapped to this destination.

Source Field

Destination Field

casApplicantId

CAS/Liaison Person ID

Important!

This data is considered in progress, and it does not contain a completed application. As such, application-scoped fields should not be mapped. When an application is submitted, all application data points are sent in the submitted applications API subscription configured above.

Tip

Refer to Liaison's documentation for more information about the different application statuses.

What should I do if my institution accepts multiple CAS applications?

Refer to the section Multiple CAS Applications below.

How do I activate the import?

Refer to the section Activation below.

Coursework Source Format

The All CAS by Liaison - Coursework source format will import coursework information entered on the application at the point of verification. Learn more about CAS coursework verification in Liaison's Applicant Processing Reference Guide.
Each course entered on the application will be represented by its own row in the coursework file.

Add the Source Format

To add the All CAS by Liaison - Coursework source format:

  1. Select Database from the top navigation bar and select Source Format Library.

  2. Search for "All CAS by Liaison - Coursework" and select Add.

  3. Navigate to the new source format and click Edit.

  4. On the Import Automation tab, update the Import Path/Mask field to specify the file path and file name pattern that the source format should use to pick up the file. For example: liaison/casapi-app-coursework_*.json

    mceclip0.png

    These file names will be configured in the CAS API subscription step.

    For example, in the subscription, to configure the data files to correspond with the Import Path/Mask value liaison/casapi-app-coursework_*.json, the following settings in the CAS API subscription can be used:

         "sftpBaseDirectory": "/incoming/liaison/",
         "sftpPathTemplate": "casapi-app-coursework_
                              ___
                              __.json"

    Note: The user account added in the previous step has access to the /incoming/liaison/ directory. If you choose to configure the CAS API subscriptions to deliver data files to different directories, then the user account must be updated to grant it access to those additional directories. Using the example path and file name pattern shown above, the pre-configured access settings can be used.

Important!

You will not be able to map any fields until you receive or manually upload a file from Liaison.

Be sure to use a sample file delivered by the CAS API subscription for coursework to ensure that all possible data points are included. By default, blank/null values are not sent via CAS API subscriptions, so if you need to adjust remap settings for a particular source field, and you do not see it on the Fields page, you will need to upload this sample file again.

Configure the Remap Settings

To configure the remap settings for the All CAS by Liaison - Coursework source format:

  1. Select Database from the top navigation bar and select Source Formats.

  2. Find the All CAS by Liaison - Coursework source format and select Remap to confirm destinations and to set up additional data mappings for this source format.

  3. After selecting Remap, you will see all of the Slate destination fields currently mapped for the data points included in the file.

There is a unique for merging field that is used to properly match the coursework file to the appropriate person record within Slate.  Another unique for merging field is mapped to associate each course with the appropriate school record. These fields are pre-mapped in the All CAS by Liaison - Coursework source format:

  • CAS/Liaison Person ID

  • CAS/Liaison School ID

These fields are automatically created during an overnight process that occurs after you have added the All CAS by Liaison - Applications source format.
The following fields are pre-mapped and should not be adjusted, nor should other fields be mapped to these destinations.

Source Field

Destination Field

casApplicantId

CAS/Liaison Person ID

collegeAttendedId

School: CAS/Liaison School ID

id

School Courses: School Course: External ID

How should I map the term or semester?

This depends on your processes. Some institutions choose the Semester date field to store this data, others institutions use the prompt-based Term field (prompt key course_term), and others store data in both fields.

Within the data, the source field termYear contains the year that the term began. This can be mapped to School Course: Semester, but note that because Semester is a date field, the date will be stored as January 1 of that year, since the month and day are not included in the data. 

If your institution stores data in the Term field, the term, termType, and termYear fields can be mapped to School Course: Term as a field fusion, should your course term prompts require that level of specificity.  

What should I do if my institution accepts multiple CAS applications?

Refer to the section Multiple CAS Applications below.

How do I activate the import?

Refer to the section Activation below.

Multiple CAS Applications

If your institution accepts multiple CAS applications (e.g., Business CAS and Graduate CAS), additional CAS API subscriptions can be created. The same source format can be used to import the data from multiple subscriptions. To do this, use the same SFTP Path Template for each CAS API subscription.

Activation

Use the same testing steps described in the Add the Applications Source Format section in this article. Once you have finished testing the remap configurations, the source format can be activated in production:

  1. In the All CAS by Liaison - In Progress Applications source format, click Edit.

  2. Update the Remap Active flag to Active.

    Note: When this flag is active, data for existing files uploaded on or after the Remap As Of Date that are Awaiting Import will be imported using the remap settings as they are currently configured.

    mceclip1.png

  3. Click Save.


Was this article helpful?