Version 2018.2
Updated: 11.19.18
...
Table of Contents
...
Download Client 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 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:
...
.
...
Identifying Your Download Client Version
- If you have Download Client V5.4.0 installed, this will display: VERSION: 2016-03-08 12:35:19, 1.0-SNAPSHOT
- If you have Download Client V5.3.0 installed, this will display: VERSION: 2015-10-16 16:00:27, 1.0-SNAPSHOT 2
- If you have a Download Client version that is prior to V5.3.0, an error displays.
Troubleshooting
If you experience issues downloading your application data after a major release, use the following steps to determine your Download Client version:
Type the following command at the ../transfer-client/ command prompt: java -jar transfer-client.jar --version
| Info |
|---|
Upgrade to the Latest Download Client VerslonA new version of the Download Client Jar file, also called the transfer-client Jar file, is |
...
made available with each new CCCApply release. You can find it alongside the |
...
most recent version of |
...
the Download Client User Guide on the User Guides page. Go to https://cccnext.jira.com/wiki/display/PD/User+Guides - and look for the "transfer-client.jar" version matching the latest release version. |
| Note |
|---|
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. |
...
| Note |
|---|
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 |
|---|---|---|---|
| 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 CCCTech 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 CCCTech Center recommends that you change this password using the following steps.
...
Confirm that no errors are printed.
Preparing to Download Applications
...
...
Configuring Your Job and Format Files
...
| Note |
|---|
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
| Panel | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?> <fieldList> </fieldList> |
...
Fields in the download file appear in the order they are defined in the format definitions XML file.
Attributes
| 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="	" (tab is the delimiter; the 	 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. |
...
| 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 |
|---|---|
| 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 />
...
| 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:
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 |
|---|---|
| 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">
...
| 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.
...
| 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>
...