Page History
Anchor | ||||
---|---|---|---|---|
|
Tip | ||
---|---|---|
| ||
If you are new to the batch file creation process, you can use the CTRP Accrual Batch File Tool to get you started. With it you can produce properly-formatted batch files that you can upload in the Accrual application. |
Note |
---|
When you create a batch file, ensure that each data element conforms to the requirements:
|
After you have prepared a batch file, you can upload it to CTRP. For instructions on submitting batch files, see Uploading Accrual Batch Data Files .
Key Facts about CTRP Accrual Batch Files
- The Accrual batch file format is based on the CTEP Clinical Data Update System (CDUS) file format. You can obtain a copy of the CDUS Instructions and Guidelines, which explains the CDUS file format in great detail, at the CTEP web site at http://ctep.cancer.gov/protocolDevelopment/electronic_applications/cdus.htm.
Although the CTRP accrual batch file format is CDUS-compatible, CTRP captures a subset of all the CDUS required data elements. Comparison of CTRP and CDUS Accrual Data Elements provides a list of all the CDUS fields with a note next to each field indicating whether CTRP captures it.
Different data elements are required and expected when submitting accrual data to CTRP for Complete trials (National, Externally Peer Reviewed, and Institutional) than for Abbreviated Trials (Industrial). Instructions are provided below for preparing batch files for both Complete and Abbreviated Trials.
A CTRP accrual batch file is a TXT (.txt) file with fields delimited (separated) by commas. The text file can be UTF-8 or ANSI-encoded.
Anchor 6348 6348 Each CTRP batch text file contains accrual data for a single trial. You can compress one or more CTRP accrual batch text files into a single Zip file and then upload this Zip file into CTRP. CTRP will unzip the file and process each TXT file. Your Zip file can include batch files for both Complete and Abbreviated Trials.
- Only Super Abstractors can upload accruals for CTEP and DCP trials in the CTRP.
Warning |
---|
Do not include the following items in Zip files that you intend to upload:
|
Each batch submission uploaded into CTRP is treated as an update to existing records or as an addition of new ones.
- Upload accruals for CTEP and DCP trials via CTEP CDUS batch accrual files only.
Anchor 6385 6385
Note |
---|
If you upload data to a trial that already has accrual data, the batch file is considered an update. The system compares your new data to existing data using identifiers. When the identifiers match, existing data in CTRP is updated. When there are no matching identifiers, data is added to the existing trial. For Abbreviated trials, the system updates the accrual counts. |
An Introduction to Batch Files
Note |
---|
This section provides general background information about batch file structure. Subsequent sections provide specific details about the Accrual batch file structure. |
Each line of text in a batch file corresponds to one record that consists of various required or optional data elements. Each data element is separated by a comma.
Traditional Table Structure
Column 1 | Column 2 | Column 3 | Column 4 |
---|---|---|---|
Row 1-Field 1 | Row 1-Field 2 | Row 1-Field 3 | Row 1-Field 4 |
Row 2-Field 1 | Row 2-Field 2 | Row 2-Field 3 | Row 2-Field 4 |
Corresponding Comma-Delimited Structure
Code Block | ||||
---|---|---|---|---|
| ||||
Field 1,Field 2,Field 3,Field 4
Field 1,Field 2,Field 3,Field 4 |
The number of fields in a row is dictated by the number of fields required in a CTRP or CDUS record. The Complete Trial Table and Abbreviated Trial Table indicate how many fields are required in each CDUS record, and how many are required in a CTRP record. The batch file must contain values or place holders (commas) equal to the number of required fields corresponding to the CDUS format. Leave fields that are not required by CTRP blank, but keep the commas to indicate the "missing" field values.
For example, if a CDUS record requires six fields, as shown below, and the CTRP record requires only three, use commas to indicate the "missing" values.
Code Block | ||||
---|---|---|---|---|
| ||||
CDUS Field 1,CDUS Field 2,CDUS Field 3,CDUS Field 4,CDUS Field 5,CDUS Field 6
|
Code Block | ||||
---|---|---|---|---|
| ||||
CTRP Field 1,CTRP Field 2,,,,CTRP Field 6
|
In a traditional table grid structure, the column headings indicate the order in which the field values occur. In CTRP batch files, the column heading is implicit, and the field order is sequential from left to right, beginning at Field 1.
Traditional Table Structure
Column 1 | Column 2 | Column 3 | Column 4 |
---|---|---|---|
Row 1-Field 1 | Row 1-Field 2 | Row 1-Field 3 | Row 1-Field 4 |
Code Block | ||||
---|---|---|---|---|
| ||||
Field #1,Field #2,Field #3,Field #4
|
The first field in each record is reserved for the table name, which is always in CAPITAL letters. The exact field number for each data element is provided in the Complete Trial Record Data Field Requirements and Abbreviated Trial Record Data Field Requirements tables.
Example - Using Automobiles Instead of Patients
Suppose CDUS stores information about cars (rather than accrued patients) in its database in a table called AUTOMOBILES.
In this example, CDUS records each of the following six data elements:
- Table Name
- VIN (Vehicle Identification Number)
- Make
- Model
- Color
- Year
These data elements are arranged in the following sequence:
Table Name | VIN | Make | Model | Color | Year |
---|
The corresponding comma-delimited sequence is as follows:
Code Block | ||||
---|---|---|---|---|
| ||||
<AUTOMOBILE>,<vin>,<make>,<model>,<color>,<year>
|
A traditional table structure for these CDUS data elements and their values are shown below.
Table Name | VIN | Make | Model | Color | Year |
---|---|---|---|---|---|
AUTOMOBILE | ABC-123456 | Ford | Mustang | Black | 1965 |
The corresponding comma-delimited structure is as follows:
Code Block | ||||
---|---|---|---|---|
| ||||
AUTOMOBILE,ABC-123456,Ford,Mustang,Black,1965
|
And, to extend this example, suppose that CTRP does not capture the Model nor Color of the car. In this case, the final record in the CTRP batch file would be as follows:
Code Block | ||||
---|---|---|---|---|
| ||||
AUTOMOBILE,ABC-123456,Ford,,,1965
|
File Naming Conventions
The CTRP Accrual Batch File is a TEXT file with fields delimited (separated) by commas. The file can have any name. However, we recommend using the following file naming conventions:
NCI Protocol Number_date.txt
(with the date format: YYYYMMDD)
Code Block | ||||
---|---|---|---|---|
| ||||
NCI-2012-00XXX_20090430.txt |
Info |
---|
The total number of characters in the file name including the file path must be less than or equal to 260. Use the file extensions |
...