...
- Type the following command at the ../transfer-client/ command prompt: java -jar transfer-client.jar --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 2. If you have a Download Client version that is prior to V5.3.0, an error displays. You can upgrade
...
- to the latest Download Client version available here (transfer-client.jar file):
https://cccnext.jira.com/wiki/display/PD/User+Guides
...
- Contact CCC Tech Center Technical Support to get your Download client. The Technical SupportSupport representative will deliver the Download client zip file to you via Dropbox or some other means that they will indicate to you. 2. Once you receive the 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.
...
javax.net.ssl.keyStore Specifies the Java Keystore thatthat contains the certificate to validate your college to the CCC Transfer Server
...
- 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.
| Note |
|---|
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 |
|---|
Note: You only need to change your keystore one time for it take effect for all applications (both CCCApply applications (Standard and International) and the CC Promise Grant application). |
- 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.
...
- 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.
...
- 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
...
- 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).
...
- 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
...
- When prompted to enter your current keystore password, enter they keystore password you set in
...
- step 3e, above.
...
- Enter the same password as in step 3e when prompted to enter and re-enter your new key
...
- password.
...
- 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
- 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).
- 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:
...
- You will have sample job and format definition XML files included in your package. These files willwill 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 |
|---|
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. |
...
- Using a text or XML editor, open the sample job XML file for the application for which you plan toto download student application data.
| Note |
|---|
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. |
- Ensure that the job element's misCode attribute includes your college's three-digit MIS code. The jobjob 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 |
|---|
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.). |
- 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.)
- 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 |
|---|
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. |
- 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 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. StandardFormat.xml for the CCCApply Standard application.)
| Note |
|---|
Note: Your format file must always be stored in the formats directory of the Download Client files in order for it to be processed. |
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).
- Open a command prompt (Start Menu -> type command for Windows) or open your Terminal windowwindow (Mac/ *nix).
- At the command, navigate to the directory where your job and format definitions XML files are locatedlocated and then type the following command:
- For Windows: download.bat jobs\StandardJob.xml
- For Mac/*nix: ./download.sh jobs/StandardJob.xml
- Press your enter key and the download file will run.
- You can navigate to the downloaded file and open it in a text editor to see the downloaded datadata (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.
- 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.
| Info |
|---|
| 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.
...
<file directory="c:/temp" formatId="ccMainV1" prefix="contracosta" suffix=".txt" /> <file directory="c:/temp" formatId="ccInstV1" prefix="contracosta" suffix=".txt" /> </job>
| Warning |
|---|
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.
...
The table below includes all the columns/fields you can download to your college SIS for the Promise Grant application. Refer to the CC Promise Grant Data Dictionary for detailed field definitions.
Element | Type | Length | Null? | Down- | Report Center? | Rules? |
app_id bigint No No
app_lang string 2 Yes Yes Yes
...