...
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 |
---|---|---|
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. |
Panel | ||
---|---|---|
|
...
| ||
<job url="https://admin.openccc.net:8443/ccctransfer" misCode="311,312,313" <file directory="c:/temp" formatId="ccMainV1" prefix="contracosta" suffix=".txt" /> |
...
The job is the root element for all download definitions.
Attributes
Environments for the URL Attribute
App Type/Environment | URL |
---|---|
Standard App PILOT | https://pilot.admin.openccc.net:8443/ccctransfer |
Standard PRODUCTION | https://admin.openccc.net:8443/ccctransfer |
BOG PILOT | https://pilot.admin.openccc.net:8443/ccctransferbog |
BOG PRODUCTION | https://admin.openccc.net:8443/ccctransferbog |
International PILOT | https://pilot.admin.openccc.net:8443/ccctransferintl |
International PRODUCTION | https://admin.openccc.net:8443/ccctransferintl |
<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.
...
<file directory="/somedir/downloads" prefix="main" suffix=".txt" formatId="fixedMain1" />
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.
| ||
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.
...
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. |
...
Panel | ||
---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?> |
...
<fieldList> |
...
<dateFormatter pattern="MM/dd/yyyy"/> |
...
<dateFormatter pattern="yyyy-MM-dd HH:mm:ss z" timezone="US/ Pacific"/> |
...
</fieldList> |
...
|
formatDefinition Element
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. |
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 |
---|---|---|
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 |
---|---|
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 />
<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 |
---|---|
pattern
A pattern string that is compatible with the Java programming language SimpleDateFormat.
...
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
...
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 removeDashes="false" /> </field>
Attribute Name | Description |
---|---|
name Name of the input field.
...
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.
...
The following example translates the res_status field as follows:
Database Field Value | Download File Value |
---|---|
1 | A1 |
2 | B2 |
3 | C3 |
Other |
...
Value | D4 |
Here are the attribute definitions:
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 |
---|---|
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) |
Attribute Name | Description |
---|---|
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 |
---|---|
len Specifies the length of the output field
...
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 |
---|---|
name Name of the input field
...
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 Application
The table below includes all the columns/fields you can download to your college SIS for the CCCApply Standard application. Refer to the CCCApply Data Dictionary for detailed field definitions.
...