CCCApply Download Client User Guide

Version 6.9.1
Updated: 05/18/2022


Contents:


Overview

When a student submits a CCCApply (Standard or International) or CC Promise Grant application, their application responses are stored in the CCC Technology Center's submitted application database in two tables: submitted_application and submitted_question_response (for supplemental question responses). The submitted_application table contains the applicants' responses on their application and a number of fields from their user account at the time they submit.

The Download Client is a platform-neutral, command-line tool you use to download all students' application data for all three applications to a local computer, allowing you to import it into your college's SIS. After you unzip the Download Client, you will use a text or XML editor to set up a properties file and then edit two sample XML files (job and format definitions) that allow you to:

  • configure which student application data to retrieve

  • define the data format for the download file

Sample job and format definitions XML files are available for each CCCApply application (Standard/Noncredit, International, and CC Promise Grant) as a part of the Download Client package.

After configuring your properties and job and format definitions XML files you can run download jobs in your test environment and SIS to confirm the data is mapping and storing correctly in your SIS prior to downloading data from the production server. Download jobs can be set for both the application data and supplemental question responses.

 

Working with XML

Although working with computer languages can be daunting, you don't need to be an expert to work with the Download Client XML files, and you don't need any sophisticated tools. A simple text editor and a rudimentary understanding of XML hierarchy will be helpful.

If you are comfortable writing computer software, you can of course use the tools that best suit you. Otherwise, create your XML files using your operating system's built-in text editor. On Windows, the text editor is called Notepad, and on OS X, it is called TextEdit.

Note: These applications can work with file formats other than plain text. Be sure to save your files in plain text format.

Important: Do not use XML Notepad to edit your XML files. It adds a BOM (Byte Order Mark) to the file and will cause the download job to abnormally terminate and an error message may display indicating that the XML file contains a BOM. See more notes below.

If you run your download and get the BOM error, you can take one of the following actions to remove it:

  • Copy and paste your XML content into a plain text editor or some other suitable tool to remove the extra characters (the BOM), such at Notepad. You can save the file as ANSI to remove the BOM.

  • Switch to an XML editor that allows you to save the content and remove the BOM, such as one of the following:

  • XML Copy Editor

To remove the BOM, click on options from the Tools menu and de-select "Save UTF byte order mark". Save your file.

  • Notepad ++

To remove the BOM, select "Encode in UTF-8 without BOM" from the Encoding menu. Save your file.

 

Download Client System Requirements

  • A Virtual Machine dedicated for the Download Client installation

  • Java 7 or higher of either the Java Runtime Environment (JRE) or Java Development Kit (JDK)

  • The latest Download Client version (the latest version is available here (as a transfer-client.v.xxx.jar file): Download Client Jar File

Supported Versions

The most recent Download Client version and one version back, are officially supported for each major CCCApply release.

Troubleshooting 

If you experience issues downloading your application data after a major release, use the following steps to determine your Download Client version:

  1. Type the following command at the ../transfer-client/ command prompt:  
    java -jar transfer-client.jar --version

  2. If you have Download Client V5.4.0 installed, this will display:
    VERSION: 2016-03-08 12:35:19, 1.0-SNAPSHOT

  3. If you have Download Client V5.3.0 installed, this will display:
    VERSION: 2015-10-16 16:00:27, 1.0-SNAPSHOT 2

  4. If you have a Download Client version that is prior to V5.3.0, an error message displays. You can upgrade to the latest version of the Download Client jar file by obtaining the latest version here: Download Client Jar Files or contact your Implementation & Configuration Engineer representative at the CCCTC Enabling Services & Support.

 

IMPORTANT: Upgrade to the Latest Version of the Download Client

A new version of the Download Client Jar file, also called the “transfer-client” jar file, is made available to colleges each time changes are made to the CCCApply database or after each major release.
You can find the latest version on the User Guides page of the CCCApply Public Documentation space, here: Download Client Jar File.

 

CCCApply Download Client - Current Production Version

When new data fields are added to CCCApply in a scheduled release, they need to be manually added to each relevant Application-specific Format Definitions XML file (every CCCApply application has it's own Format Definition XML and Job File XML) AND you must update your Download Client with the corresponding, release-specific “transfer-client.v.xxx” Jar file.  A new 'transfer-client-jar" is created for each release that includes database changes.  




Unzipping, Installing, and Configuring the Download Client

The following steps outline a "quick-start" process for a first-time unzip and configuration of the Download Client.

  • Detailed information about the underlying database information, as well as detailed XML and schema information, follows this quick-start section. Links to more detailed information are provided and noted where necessary.

  • If you have already installed and used the Download Client, then you may want to skip some of these steps and/or go directly to the detailed information provided in the job and format file configuration and data field sections.

Download Client Installation Steps

The steps that follow assume the ‘java’ and ‘jar’ commands are available from your PATH environment. The installers for both the JRE and JDK should install the Java runtime so that the various command-line tools, including ‘java’ and ‘jar’ are available in the system PATH.


If you have already installed the Download Client you can skip to: Preparing to Download Applications: Configuring Your Job and Format Files.

  1. Contact your CCCTC Implementation & Configuration Engineer (ICE) representative (Enabling Services & Support) to order your Download Client. The ICE representative will deliver the Download Client zip file to you via Dropbox or some other secure method that they will arrange with you.

  2. Once you receive your Download Client zip file, download the file to your local computer and extract it into a local file directory of your choice.
    Once you extract your Download Client, it should look something like this, with the expanded files within the transfer-client root folder:


     

It is assumed that the FTT_HOME environment variable indicates the fully-qualified path to this directory, e.g. FTT_HOME=c:\downloads\transfer-client

Note: Refer to the following information for supported parameter key configuration in the ccctransfer.properties file prior to changing your keystore password in the next steps:

Key

Description

Required?

Default Value

Key

Description

Required?

Default Value

javax.net.ssl.keyStore

Specifies the Java Keystore that contains the certificate to validate your college to the CCC Transfer Server

Yes

FTT_HOME/conf/client.jks

javax.net.ssl.keyStorePassword

Specifies the password for the keystore that javax.net.ssl.keyStore indicates.

Yes

password

 

3.  Change your college keystore password using the steps in this section. When you first receive the Download Client from the CCC Tech Center, a certificate is created for your college that controls which MIS code(s) you can access for downloads. The default password for this initial certificate is “password.” The CCC Tech Center recommends that you change this password using the following steps.

Note: Though security is driven by the key and not from the password to load the keys, we still recommend you change your password to be unique. Perform these steps from the machine where the keystore is installed.

Note: You only need to change your keystore one time for it take effect for all applications (all CCCApply applications (Standard/Noncredit and International) and the CC Promise Grant application).

 

a. Navigate to the transfer-client\conf\ directory and create a backup of your current client.jks file.

b. At a command prompt, navigate to the transfer-client\conf directory and locate your college key alias by entering the following command at a command prompt (press the Enter key after you type the command): keytool -list -keystore client.jks  The output from running this command will be a list of keys contained in the keystore.

c. Locate your college key alias by looking at the key name at the beginning of the entry of type "PrivateKeyEntry". The college key alias will usually be in the format of "xxx.edu" where xxx is your college’s initials.

d. Update your college keystore password by entering the following command at the command prompt from the transfer-client\conf directory (press the Enter key after you type the command): keytool -storepasswd -keystore client.jks

e. When prompted to enter your current keystore password, enter your current password (the password = password for all first-time Download Clients). You’ll be prompted to enter your new keystore password, and then prompted to re-enter the new keystone password (press the Enter key after each entry).

f. Update your college key password to match the keystore password you just set in step 3e above by entering the following command at the command prompt from the transfer-client\conf directory (press the Enter key after you type the command): keytool -keypasswd -alias <key_alias> -keystore client.jks

g. When prompted to enter your current keystore password, enter they keystore password you set in step 3e, above.

h. Enter the same password as in step 3e when prompted to enter and re-enter your new key password.

i. Open the conf/ccctransfer.properties file and edit the ccctransfer.keystore.password value to have your new password instead of the old one (password). That is, edit the word password after the = sign in this entry: ccctransfer.keystore.password=password

 

j. Save and close the conf/ccctransfer.properties file. You have now updated your college keystore password for all applications (CCCApply Standard and International, and CC Promise Grant).

k. Test the new keystore by entering the following command at the command prompt for each application.

To test the new keystore for your Pilot server, enter the following command at the command prompt:

Confirm that no errors are printed.

 

To test the new keystone for your Production server, enter the following command at the command prompt:

Confirm that no errors are printed.




Preparing to Download Applications

Configuring Your Job and Format Files

After installing the Download Client, you will need to configure the job and format XML files to specify which application data you want to download.

Noncredit Application Downloads

The CCCApply Noncredit application is a separate (optional) workflow within the CCCApply Standard application that allows students enrolling exclusively in noncredit courses to complete the application in an expedited manner, using skip logic to hide non-applicable and residency-related questions. If implemented, you can download submitted Noncredit applications using your existing Standard application Job File XML by adding the following two Noncredit Application fields to the format definition XML: <integrity_fg_81> and <non_credit>. These two fields are detailed further in the CCCApply Standard & Noncredit Application Data Dictionary

 

 1.  You will have sample job and format definition XML files included in your package. These files will usually include the application name in the file name (i.e. SampleBogJob1.xml in the image above is a sample job file for the BOG application).

Note: It is also wise to check the CCC Tech Center Public Documentation pages for the latest updates to Download Client files including the job and format definition XML files.  https://cccnext.jira.com/wiki/display/PD/User+Guides


2.  Using a text or XML editor, open the sample job XML file for the application for which you plan to download student application data.

Note: If this is your initial download, then you will likely be preparing to download the CCCApply Standard application since it is required you go live on that application prior to the Promise Grant or International applications.

3.  Ensure that the job element's misCode attribute includes your college's three-digit MIS code. The job element's URL attribute points to the Pilot database environment in the above image.

4. Update the file element's directory attribute by replacing the "downloads" in the above example to be the name of the directory on your local computer where you want the download file to be saved.

5. Update the formatId attribute by replacing the ccInst in the above example to be the same name of the formatId in the format definitions file.

Note: See the screenshot above and below for an illustration of this step. When you run the Download Client job, all format XML files in the formats directory are "opened" and scanned for the id that matches the formatId in the job XML file. When the matching id is found, that determines which format is applied to the downloaded data. 


6. Update the prefix and suffix attributes by replacing the "mycollege-inst" and ".txt" values with the file name prefix for your choice and the file-type extension of your choice (i.e. .csv, .txt, etc.).

7.  Save the job file by using Save As, and rename the file to the name of your choice. It's best practice to include the application name in the file name. (e.g. Standard Job.xml for the CCCApply Standard application.)

8.  Using a text or XML editor, open the format definitions XML file for the application for which you plan to download student application data.

Note: In the example below, the formatDefinition id attribute is highlighted. This value must match exactly the formatId attribute in the associated job XML file (see the image, above). Your format file can include more than one formatDefinition defined within it as long as each has a unique id attribute value. Changing that corresponding id in the Download Client job file is what determines which format is used for any particular download job.

 

9.  Edit the XML elements and attributes in the format definitions XML file to include the specific database fields that you want to download into your college's SIS. Use the following items to assist you in editing and validating this XML file:

  • the XML schema file for the format definitions file

  • the Data Fields for each of the student applications (CCCApply Standard and International, and CC Promise Grant)

  • the Data Dictionaries for each of the student applications

When you are done creating and validating the format definitions XML file, save the file using Save As, and rename the file to the name of your choice. It's best practice to include the application name in the file name. (e.g. StandardFormat.xml for the CCCApply Standard application.)

Note: Your format file must always be stored in the formats directory of the Download Client files in order for it to be processed.

 

Downloading Noncredit Applications

The CCCApply Noncredit application is a separate (optional) workflow within the CCCApply Standard application that allows students enrolling exclusively in noncredit courses to complete the application in an expedited manner, using skip logic to hide non-applicable and residency-related questions. If implemented, you can download submitted Noncredit applications using your existing Standard application Job File XML by adding the following two Noncredit Application fields to the format definition XML: <integrity_fg_81> and <non_credit>. These two fields are detailed further in the CCCApply Standard & Noncredit Application Data Dictionary

 

Running a Download Job

After installing the Download Client and configuring your job and format XML files, use the following steps to run a job to download your college's student applications (in order to import them into your college's SIS).

  1. Open a command prompt (Start Menu -> type command for Windows) or open your Terminal window (Mac/ *nix).

  2. At the command, navigate to the directory where your job and format definitions XML files are located and then type the following command:

    • For Windows: 
      download.bat jobs\StandardJob.xml

    • For Mac/*nix: .
      /download.sh jobs/StandardJob.xml





  3. Press your enter key and the download file will run.

  4. You can navigate to the downloaded file and open it in a text editor to see the downloaded data (remember that you set the directory for the download file to be saved to in the job XML file's file element directory attribute, in step 9, above). The data for all student applications that have not previously been downloaded appears in a single row, per student as in the image below.

  5. Follow the data import steps for your college's SIS to import the download file data. It is highly recommended you perform this for a test SIS database to ensure the downloaded data imports into your SIS correctly.

Tip: You can set up a Chron job to automate your application data downloads to occur on a regular basis.

 


Job File Configuration Details

The job file contains information about what student applications to download and what directories to use for the output file. A job file is created for each download job. When a job is set up in the college's scheduler, the job file name is passed as a parameter to the job.

The Job File

The job file controls the high-level aspects of the download, such as the server from which to retrieve the data. It also allows you to specify multiple downloads that may retrieve different datasets or present the data in different formats.

The Format Definitions File

The format definitions file allows you to select the specific fields you want to retrieve from the student applications and control the format of the data that the Download Client delivers to you.

Sample Job file

Attribute Name

Description

Function

Attribute Name

Description

Function

url

Specify the server URL for the system from which you want to download (see list below).

This allows you to create different jobs to download different jobs to download from different environments. Choose the URL for the environment you want to download, from the table below.

misCode

Specify the MIS code(s) for the college.

The college can only download applications for which they are authorized.

 

Filter Elements

Any given job has the basic constraint that only applications for the specified MIS codes can be retrieved. An optional filter is allowed to further restrict which student application data gets downloaded for a given job. With no filter specified, only data for "new" student applications for that MIS code are retrieved. An application is considered new if it has not previously been downloaded by the Download Client.

<job> element

The job is the root element for all download definitions.

Attributes

Environments for the URL Attribute

App Type/Environment

 URL

<file> element

The file element specifies the directory to create the download file, how the file name is formatted and which format definition to use.

Note: For Datatel colleges who have two definitions (one for main and one for Institutions attended), specifying the same prefix and suffix will put the output into a single file. If you want the output in two files, use a different prefix name parameter. The example above outputs to one file.


<file directory="/somedir/downloads" prefix="main" suffix=".txt" formatId="fixedMain1" />

Attribute Name

Description

Conditions

Attribute Name

Description

Conditions

directory

The directory the download file will be created in.

The directory must exist.

prefix

The prefix of the download file.



suffix

The suffix of the download file. 

i.e. .txt or .csv

formatId

The format id to use.

The format id must exist in a formatdefinitions.xml file, specified by the id attribute.

Note: A format definition file can contain more than one id attribute as in the sample below. However, format id's are intended to be unique. If you have the same id in more than one format definition file, the job will use the first one found in the formats folder. Also, more than one job file can point to the same format file (e.g. – you can set up job files for beta and production that point to the same format file.)

os

Defines the type of carriage return or line feed character.

os="windows" (Uses CR/LF) os="unix" (Uses LF) If os is omitted, it uses "windows" as the default.

 

Full File Name

Besides the prefix and suffix, the date and time are also included in the file name. Based on this example: <file directory="/ somedir / downloads" prefix="main" suffix=".txt" formatId="fixedMain1" /If the transfer job ran on feb 6 2014, the file name would be / somedir / downloads / main-140206-081228.txt where "140206" represents the date and "081228" represents the run time of the job.




Format Definitions File Configuration Details

The format definitions file is an XML file used to define student application data download format:

  • Which fields to include

  • How each field is formatted

  • Type of file (fixed or delimited)

  • id (must match the associated job file's formatID).

The example sample format definitions file below can be used in conjunction with clicking the links in the navigation panel to the left to find the data fields for:

  • Standard application data fields

  • CC Promise Grant data fields

  • International application data fields

  • Supplemental Questions answers

Note: You must always include the ccc_id field in your format definitions XML file for download jobs and include it as the data your store in your SIS. The California Community College Chancellor's office requires that each unique student ID be included in your MIS reporting data.

Sample Format Definition File

formatDefinition Element

Fields in the download file appear in the order they are defined in the format definitions XML file.

Attributes

Attribute Name

Value

Attribute Name

Value

outputFormat

Set the value to fixed or delimited.

Delimiter

For delimited files, specify the delimiter. The default is comma (",") if unspecified. Examples of delimited file:

outputFormat="delimited" delimiter="|" (pipe is the delimiter).

Note: You can use multiple characters as a delimiter, if desired.

outputFormat="delimited" delimiter="&#009;" (tab is the delimiter; the &#009; delimiter value results in tab delimited output)

applicationType

Specifies which type of applications you are downloading (Standard, CC Promise Grant, or International). If not specified, it will default to Standard applications. For BOG, applicationType="bogfw". For International, applicationType="intl".

stripDiacritics

 The stripDiacritics attribute will convert certain diacritic (non-English or foreign) characters to standard ascii characters. If omitted, the data will be sent as originally entered in the application. To convert diacritic characters, add stripDiacritics="true". Important note: If you use this attribute, be sure to test thoroughly before using it in production so you know you are getting the results you expect.

charset

Sets the charset that the output from the download client will utilize.

charset="ASCII" will place question marks (?) where non-standard/non-English characters are in the output. Multiple question marks can stand for a single non-standard/non-English character, meaning that if you have specified a specific length for a field's output, the end could get cut off if there are too many question marks in the user's value for that field.

charset="UTF-8" will print most non-standard/non-English characters in user output without unnecessarily adding to the length of the output.

If this attribute is not specified, it will default to ASCII.

 

Child Elements

<fieldList>

The fieldList contains a list of field definitions.

<field>

The field element defines how an individual field is formatted. The element value is the name of the field in the submitted_application table (see the Download Data section, below).

<field len="10" name="app_id" /> Attributes

Attribute Name

Description

Restrictions

Attribute Name

Description

Restrictions

len

The fixed width of the field.

Only applicable in the fixed format.

name

The name of the field (from the application's Data Dictionary) to output



 

<whitespace>

The whitespace element is only used in fixed format definitions when you want to insert fixed width spaces in between two fields.

<whitespace len="3" />

Attribute Name

Description

Attribute Name

Description

len

The fixed width of the whitespace.

 

<constant>

The constant element is used to insert a constant string value into the file. If you specify the len attribute, it will right pad the text with spaces if the len is greater than the length of the text. If you do not specify len, if will not add any padding.

<constant len="30">College one starts here</constant>

Attribute Name

Description

Attribute Name

Description

len

If specified, it will right pad the text with spaces if the len is greater than the length of the text. If omitted, if will not add any padding.

 

<newline>

The newline causes a carriage return (line feed). The newline element is aware of the operating system. For Windows it will add CR & LF. For Unix it will just add LF.

<newline />

 

<byAppId>

The byAppId element allows you to specify a single application for download when you provide a specific app_id value.

<byAppId app_id = '16197'/>

<dateFormatter>

A date formatter allows customization of how date/time values can be formatted using a pattern string. Example pattern strings are: MM/dd/yyyy, yyyy-MM-dd, etc.

<field name="tstmp_submit" len="20">

<dateFormatter pattern="yyyy-MM-dd HH:mm:ss z" timezone="US/Pacific"/> </field>

Attribute Name

Description

Attribute Name

Description

pattern

A pattern string that is compatible with the Java programming language SimpleDateFormat.

timezone

A time zone attribute that allows you to specify the time zone for downloaded dates. The timezone attribute value can be any of the values supported in the java.util.Timezone class (note that "US/Pacific" will work and be applicable for all California Community Colleges.

If no time zone is specified, the downloaded time zone defaults to Coordinated Universal Time (UTC) as measured from Pacific Standard Time Zone. That is:

  • UTC is eight hours ahead of local time when NOT in daylight savings time

  • UTC is seven hours ahead of local time when IN daylight savings time

 

Note: Daylight savings time takes effect from the second Sunday of March through the first Sunday of November.

 

For example, an application submitted to a California Community College at 3:30 pm/15:30:00 on November 15 will appear as 23:30:00 in the downloaded data--an eight hour time difference--if no timezone attribute is applied to the dateFormatter for timestamp fields.

An application submitted to a California Community College at 3:30 pm/15:30:00 on April 15, 2016 will appear as 22:30:00 in the downloaded data--a seven hour time difference--if no timezone attribute is applied to the dateFormatter for timestamp fields. The time is seven hours different than the actual application submit time due to Daylight Savings time.

 

<booleanFormatter>

The booleanFormatter allows you to configure what text displays/downloads for boolean-date type fields with true, false, and null values.

<booleanFormatter trueValue="1" falseValue="0" nullValue="?"/>

Attribute Name

Description

Attribute Name

Description

trueValue

Specifies the text to output in the field if the underlying value is true

falseValue

Specifies the text to output in the field if the underlying value is false

nullValue

The optional nullValue allows you to specify the output if the underlying value is null (i.e. replace the in nullValue="?" to be the value you want to display for underlying values that are null)

Note: If the nullValue attribute is not defined, then any fields with null values will default to display the falseValue attribute in your download data. If neither the nullValue nor the falseValue attributes are defined, then a null value downloads as a string of "false."

 

<ssnFormatter>

The ssnFormatter applies formatting to social security numbers to include or remove dashes. <field name="ssn" len="9">

<ssnFormatter /> </field>

<field name="ssn" len="11">

<ssnFormatter removeDashes="false" /> </field>

Attribute Name

Description

Attribute Name

Description

name

Name of the input field.

len

Specifies the length of the output field

removeDashes

If removeDashes="false", len should be 11. This will format an SSN field with dashes.

 

<simpleMapper>

The simpleMapper formatter provides a way to make simple translations of data.

Note: The simpleMapper only works for string data types (i.e. it does NOT work with smallint, boolean, etc.).

<field len="2" name="res_status">
<simpleMapper>
<unmatched>D4</unmatched>
<map>
<from>1</from>
<to>A1</to>
</map>
<map>
<from>2</from>
<to>B2</to>
</map>
<map>
<from>3</from>
<to>C3</to>
</map>
</simpleMapper>
</field>

The following example translates the res_status field as follows:

Database Field Value

Download File Value

Database Field Value

Download File Value

1

A1

2

B2

3

C3

Other Value

D4

Here are the attribute definitions:

Attribute Name

Description

Attribute Name

Description

len

Specifies the length of the output (<to>) field (fixed format only).

name

Name of the input field.

unmatched

Value to use if actual data does not match any of the from values If unmatched element is not specified, the actual data value will be used

 

<stringFormatter>

The stringFormatter allows you to configure text field values to display/download as all upper-case or lower-case letters and what text displays/downloads for text fields with null values.

<stringFormatter caseConversion="lowercase" nullValue="[null]"/>

Attribute Name

Description

Attribute Name

Description

caseConversion

The optional caseConversion attribute specifies the text string to output as all lower-case or all upper-case letters:

caseConversion="lowercase" caseConversion="uppercase"

nullValue

The optional nullValue attribute allows you to specify the output if the text string value is null:

nullValue="null" (to download the value null if the underlying field value is null)

nullValue="X" (to download the value X if the underlying field value is null)

Note: If the nullValue attribute is not defined, then any text-type fields with null values will default to display/download an empty string: " ".

 

<phoneFormatter>

The phoneFormatter is used to format phone numbers.

<field len="15" name="mainphone">
<phoneFormatter pattern="(999) 999-9999"/>
</field>

Attribute Name

Description

Attribute Name

Description

len

Specifies the length of the output field

pattern

See following table for sample patterns

name

Name of the input field

 

Here are some sample patterns:

Database Field Value

Pattern

Download Field Result

Database Field Value

Pattern

Download Field Result

530-332-2233

9999999999

5303322233

530-332-2233

9999999

3322233

530-332-2233

(999) 999-9999

(530) 332-2233

5303322233

(999) 999-9999

(530) 332-2233

 

<numberFormatter>

The numberFormatter can be used for applying a variety of formats to numbers.

Example for applying a format for currency:

<field name="dep_other_income" len="20">
<numberFormatter format="%,d.00"/>
</field>

Attribute Name

Description

Attribute Name

Description

name

Name of the input field

len

Specifies the length of the output field

format

See the following table for sample formats

Database Field Value

Format

Download Field Result

Database Field Value

Format

Download Field Result

25000

"$%,d.00"

$25,000.00

25000

"%,d.00"

25,000.00

Note: To view more format value examples, see: http://docs.oracle.com/javase/7/docs/api/java/util/ Formatter.html#syntax




Data Fields

CCCApply Standard and Noncredit Applications

The latest version of the CCCApply Standard & Noncredit Application Data Dictionary includes a complete table of all data columns/fields that can be downloaded to your college SIS for the CCCApply Standard and/or Noncredit applications. See "Appendix E: Table of Downloadable Fields" in the most current version of the CCCApply Standard & Noncredit Data Dictionary.

 

CCCApply International Application

The latest version of the CCCApply International Application Data Dictionary includes a complete table of all data columns/fields that can be downloaded to your college SIS for the CCCApply International application. See "Appendix E: Table of Downloadable Fields" in the current version of that data dictionary for specs.

 

Supplemental Questions Responses

Important: Please refer to the specific CCCApply application data dictionary for the Supplemental Questions field names that are populated in the corresponding database table and therefore the names you reference in your format definitions XML file.

When you configure your format definition XML file for supplemental question download by including the database field name below, the "nn" in the Database Field Name column example below is replaced with the number for each field of that type that you included in your supplemental questions (i.e. <field name = "supp_secret_01"/>, <field name = "supp_secret_02"/>, etc.).

Database Field Name

Format / Length

Max

Question Type

Comment

Database Field Name

Format / Length

Max

Question Type

Comment

supp_check_nn

boolean

50

Check box

nn=01 thru 50

supp_country_nn

Character (2)

5

Country code

nn=01 thru 05

supp_date_nn

Date

5

Date

nn=01 thru 05

supp_secret_nn

Character Varying (20)

5

Hidden Text Field

nn=01 thru 05

supp_menu_nn

Boolean

30

Menu

nn=01 thru 30

supp_phonenumber_nn

Character varying (25)

5

Phone Number

nn=01 thru 05

supp_state_nn

Character (2)

5

State code

nn=01 thru 05

supp_text_nn

Character Varying (250)

20

Text

nn=01 thru 20

supp_yesno_nn

Boolean

30

Yes/No

nn=01 thru 30

 

Reminder: Supplemental Question data fields are only available in the CCCApply Standard & Noncredit Application and the CCCApply International Application.

 

California College Promise Grant Online Application

The latest version of the California College Promise Grant Online Application Specification & Data Dictionary includes a complete table of all data columns/fields that can be downloaded to your college SIS for the CC Promise Grant Online application. See "Appendix B: Table of Downloadable Fields" in the current version of that data dictionary for specs.

 

Account Data Fields Mapping Chart

The table below shows a mapping of all OpenCCC Account data field names across all CCCApply applications.

Data Item

Account Data Element

Standard / Noncredit Data Element

CC Promise Grant (BOG) Data Element

International App Data Element

Data Item

Account Data Element

Standard / Noncredit Data Element

CC Promise Grant (BOG) Data Element

International App Data Element

CCCID

cccid

ccc_id

ccc_id

ccc_id

Date of Birth

birthdate

birthdate

birthdate

birthdate

Email Address

email

email

email

email

Legal Name: First

firstname

firstname

firstname

firstname

Legal Name: Last

lastname

lastname

lastname

lastname

Legal Name: Middle

middlename

middlename

middlename

middlename

Legal Name:Suffix

suffix

suffix

suffix

suffix

Main Telephone

mainphone

mainphone

mainphone

main_phone_number

Main Telephone Extension

mainphone_ext

mainphone_ext

mainphone_ext

main_phone_ext

Permanent Address: City

city

perm_city

city

perm_addr_city

Permanent Address: Country

county

perm_country

country

perm_addr_country

Permanent Address: Non-U.S. State/ Province

nonusaprovince

perm_nonusaprovince

province

perm_addr_nonusaprovince

Permanent Address: Postal Code

postalcode

perm_postalcode

postalcode

perm_addr_zip_code perm_addr_non_us_postal_code

Permanent Address: State

state

perm_state

state

perm_addr_state

Permanent Address: Street 1

streetaddress1

perm_streetaddress1

streetaddress1

perm_addr_streetaddress_1

Permanent Address: Street 2

streetaddress2

perm_streetaddress2

streetaddress2

perm_addr_streetaddress_2

Preferred Name: First

preferred_firstname

preferred_firstname

preferred_firstname

preferred_firstname

Preferred Name: Last

preferred_lastname

preferred_lastname

preferred_lastname

preferred_lastname

Preferred Name: Middle

preferred_middlename

preferred_middlename

preferred_middlename

preferred_middlename

Previous Name: First

otherfirstname

otherfirstname

otherfirstname

otherfirstname

Previous Name: Last

otherlastname

otherlastname

otherlastname

otherlastname

Previous Name: Middle

othermiddlename

othermiddlename

othermiddlename

othermiddlename

Second Telephone

secondphone

secondphone

secondphone

secondphone

Second Telephone Extension

secondphone_ext

secondphone_ext

secondphone_ext

secondphone_ext

Social Security Number: Other Exception

ssn_exception

ssn_exception

ssn_exception

ssn_exception

Social Security Number: None

ssn_no

ssn_no

ssn_no

ssn_no  

Social Security Number/TIN

ssn

ssn

ssn

ssn

Social Security Number/TIN Type

ssn_type

ssn_type

ssn_type

ssn_type

Text Permission: Main Telephone

mainphone_auth_txt

mainphone_auth_txt

mainphone_auth_txt

main_phone_auth_text

Text Permission: Second Telephone

secondphone_auth_txt

secondphone_auth_txt

secondphone_auth_txt

second_phone_auth_txt

Accepted Terms

acceptedTerms

acceptedTerms

acceptedTerms

acceptedTerms

Accepted Terms Timestamp

acceptedTerms_timestamp

acceptedTermsTimestamp

acceptedTermsTimestamp

acceptedTermsTimestamp

Address Validation Override

addressValidation_override

addressValidationOverride

addressValidationOverride

addressValidationOverride

Address Validation Override Timestamp

address.validation_override_timestamp

addressValidationOverrideTimestamp

addressValidationOverrideTimestamp

addressValidationOverrideTimestamp

Email Verified

emailVerified

emailVerified

emailVerified

emailVerified

Email Verified Timestamp

emailVerified_timestamp

emailVerifiedTimestamp

emailVerifiedTimestamp

emailVerifiedTimestamp

Phone Type

phoneType

phoneType

phoneType

phoneType

Phone Verified

phoneVerified

mainPhoneVerified

mainPhoneVerified

mainPhoneVerified

Phone. Verified Timestamp

phoneVerified_timestamp

mainPhoneVerifiedTimestamp

mainPhoneVerifiedTimestamp

mainPhoneVerifiedTimestamp

Preferred Method of Contact

preferredMethodOfContact

PreferredMethodOfContact

PreferredMethodOfContact

PreferredMethodOfContact

Verification Code

verificationCode

verificationCode

verificationCode

verificationCode