Quick Guide: Running the Conversion Tool (Basic Version)
Prior to starting the ECT, the user should place the Excel files that will be used for input in the following
folder:
C:\Documents and Settings\\My Documents\EMTS Conversion Tool (ECT)\Input_Files
Figure 1 depicts this folder for a user "wgo." The "Input_Files" folder has been circled in this figure. Note
that the extension for all Excel files saved in this folder should be .xls rather than .xlsx (the default for Excel
2007).
Figure 1: EMTS Conversion Tool Input File Directory
EMTS Conversion Tool (ECT)
File Edit View Favorites Tools Help
Back - & JO Search
Folders
Address Q C:\Documents and Settings\wgo\My Documents\EMTS Conversion Tool (ECT)
File and Folder Tasks ^
My Documents
My Computer
My Network Places
Go
Good Files
Val_Log
Running the ECT
This guide describes how to run the ECT in its basic mode. Once the ECT is installed, it can be opened from
the Start Menu. Upon starting the ECT, the start-up page displayed in Figure 2 appears.
v>EPA
United Stales
Environmental Protection
Agency
EPA-420-B-10-010
February 2010
-------
Figure 2: Start-up Page of the ECT
ffl EMTS Conversion Tool (ECT) Front Page
File
Convert a delimited text file or Excel file to EMTS XML file (files can be zipped).
Advanced Version
Go | This version allows the flexibility that the Basic version doesn't.
Basic Version
This is a basic version which requires:
Go I 1) If using a text file then it must be a tab, comma, or bar delimited format.
2) The columns of the files must be the EPA recommended column names.
3) For an existing file all elements must be included, set unused defaults as blanks.
N.B. Please keep in mind that the ECT performs only basic QA checks while EMTS performs high-level QA checks which are
company specific and are based on a company's registration with EPA.
Therefore, it may be possible for a user to successfully convert files to XML using the ECT but then
an upload to EMTS may fail.
[ Don't show this page anymore.
If later you would like this see this display then, on the Main Menu, select ShowFrontPage and unselect Don't Show.
Exit
The user should click on "Go" under "Basic Version." Prior to doing this, the user can click on the "Don't
show this page anymore" box, if desired. This will cause the start-up screen to be skipped on subsequent
uses of the ECT, resulting in the processing starting up directly at the screen where the input files are
chosen.
Selecting Files
Once the "Go" button for the Basic Version is selected, the File Selection Screen appears (see Figure 3).
-------
FigureS: File Selection Screen
H EMTS Conversion Tool (ECT)
File Help File List View Show Front Page Show Log WinZip
wgo: Welcome to Version 1.0.0.8.3. This application will format an Excel or delimited file for conversion to XML.
Select a Folder on the left panel and File(s] on the right panel and click on the Process File(s) button to process OR Select the Build a New File button.
! Eld EMTS Conversion T oi A
; j Error_Files
B-d Good_Files
: H t3 lnput_Files
d Val_Log
i ffl d FinePrint files
d ForrnatXML
: d My Google Gadgets
d My Music
i d My Pictures
;-d My Videos
! Hd My Virtual Machines
Id New Folder
\ ft d PDF files
i £ d TotalValidatorTool
Sd NetHood
i-d PrintHood
: d PrivaclE
: f~^l Recent
: 1 ~t SendTo
+ , 1 Spark
fid Start Menu
i r^l Templates
-L r^-, , , ^ ,
< 1 >l
Name j Size
B BuyDenyExample1_Feb3.xls 37,888
m BuyExample1_Feb3.xls 37,888
GenerateAdvancedExample1_Feb3.xls 61,852
= GenerateExarnple1_Feb3.xls 61,352
H RetireExample1_Feb3.xls 44,544
H SellCancelExample1_Feb3.xls 37,376
H SellExarnple1_Feb3.xls 37,376
H SeparateExample1_Feb3.xls 43,008
Modified | Attribute |
2/3/201 02:07: 47PM A
2/3/201 01:28:37PM A
2/3/2010 2:1 1:08 PM A
2/3/201 01:54:20PM A
2/3/201 01:27:28PM A
2/3/2010 2:02:24 PM A
2/3/201 01:57:57PM A
2/3/201 01:26:35PM A
Process
Existing
File(s)
Or
Build a New
File
Or
Exit
Files
Input File(s] Folder: [C:\Documents and Settings\wgo\My Documents\EMTS Conversion Tool (ECT)\lnput_Files
*Qood File(s) Folder:
"Bad File(s) Folder:
C:\Documents and Settings\wgo\My DocumentsVEMTS Conversion Tool (ECT]\Good_Files
C:\Documents and Settings\wgo\My Documents\EMTS Conversion Tool (ECT)\Error_Files
Log File(s) Folder: |CADocurnents and Settings\wgo\My Documents\EMTS Conversion Tool (ECT]Wal_Log
"Location of formatted output that has NO errors.
""Location of formatted output that has errors.
Set Path
Set Path
Set Path
Set Path
The user should select the desired file(s) and click the "Process Existing File(s)" button, or click the "Build a
New File" button without selecting any files. To select multiple files, the user should press "Ctrl" on the
keyboard and click on all of the files to be processed. If the file name contains the transaction type, the ECT
will assume that the named transaction type is the type to process and will go immediately to the File
Processing Screen (Figure 4) when "Process Existing File(s)" is clicked. If the transaction type is not
contained in the file name, the user will be asked to specify the transaction type (see Figure 8).
Processing Files
The File Processing Screen is depicted in Figure 4. The user should first fill in the "Enter Company Info"
portion of File Processing Screen, indicated by "Step #2" in the figure.
-------
Figure 4: File Processing Screen
Process Rows Columns Help 5howLog WinZip
Step 82 - Enter Company Info
'User Login: |3S ' Submittal Creation Date: J2Q1Q-Q2-fl1
Header Inromation
"Application User ID: j~~~
Transmission ID: TED
Step 113 Piocess And Write to XML File
Output File Options Exit/Slop Processing
Progress:
Finished Loading Input Data.1 data records read.
The company information required includes:
User Login (is case sensitive and must be the same as the EMTS login);
Organization ID (EPA assigned, four-digit ID); and
Submittal Creation Date.
The ECT uses the following default settings when processing files: the output file is an uncompressed XML
file, and the output file name is formatted as "TtOrgId_YYYY-MM-DD-HH-MM-SS" where "Tt" is the
transaction type (i.e., Generate) and "Orgld" is the four-digit ID entered in the "Organization ID" field. To
change these default settings, the user should click the "Output File Options" button.
Figure 5: "Output File Options" Button
Process Rows Columns Help 5how Log
StepttS^Ptocess And Write to XML File
Q Output File Options D Exit/Stop Processir
Progress:
Finished Loading Input Data.3 data records read.
IIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIII
On the Formatted Output File Options screen (see Figure 6), the user can specify the output file type,
compression, and file name (compressed XML is the only format accepted by EMTS). To specify the file
name, the user should check the checkbox to override the default name and then enter a new file name.
The ECT automatically appends the transaction type of the file being processed to the beginning of the new
file name. In the example in Figure 6, if a Generate file were being processed, the output file name would be
"Generate01-26-2010.xml." Once a user updates the Formatted Output File Options screen, the updates
become the default setting for subsequent file conversions and remain so until the user goes back to the
Formatted Output File Options screen and changes the settings.
-------
Figure 6: Formatted Output File Options Screen
Formatted Output File Options
File type XML is the ONLY option required for submission/transmission
File Type(s)
W XML - This is the ONLY option required for submission/transmission
Excel - For your use only, not to be transmitted (if transmitted, it will be ignored.)
l~ Text - For your use only, not to be transmitted (if transmitted, it will be ignored.)
File Compression (using WinZip32)
''* Do Not Compress any Files
f~" Compress only the XML File for Node Submission/Transmission
Compress only the XML File for Node Submission/Transmission
'-"" Compress All Output File Types Selected Above (XML, Excel, Text) - It is NOT necessary to include Excel or Text in the compression.
Override Output File Name
Override the default name of TtOrgld_YYYY-MM-DD-HH-MM-SS where Tt is the Transaction Type.
Overridden File Name: 101-26-2010
Do NOT include the Folder (Path) name. The "Good Files" folder is assumed.
Other File Option(s)
l~ Display Processed File
(Text or Excel file only)
OK
After specifying the output file options, the user should click the "Process File" button. Note that if multiple
files have been selected for processing, only one file is processed at a time. In this case, a "Next file" button
will be visible next to the "Process File" button (see Figure 7). The user should first click the "Process File"
button, verify that the file processes successfully (see the Results of File Processing section in this Quick
Guide), and then press the "Next file" button.
-------
Figure?: "Next file" Button
Process Rows Columns Help Show Log WinZip
Step tt2 Enter Company Info
User Login:
Organisation ID:
i.t4bmitiul Cration Dale. iUiu-OJ-OI Submission Cor
Header Infomation
'Application User ID: jepa
Transmission ID: TED
Step 113 Process And Write to XML File
Output File Options
Next file J)
Progress:
Finished Loading Input Data.1 data records read.
Creating New Files
If the "Build a New File" button is clicked on the File Selection Screen (see Figure 3), a screen will appear
asking the user to specify the transaction type (see Figure 8).
Figure 8: Selecting the Transaction Type
Choose the Transaction Type
Select the transaction type from the drop-down pick list below for file:
Select Transaction Type:
Enter Skip this file
Once the user selects the transaction type and clicks "Enter," the File Processing Screen appears (Figure 9).
-------
Figure 9: File Processing Screen
ggj Gene rate Transaction Processing file:
Process Rows Columns Help Show Log WinZip
Step H3 Entei Company Info
"User Login: [SB - Submitial Creation Dste: |zQ 10-02-01 Submissi>
" Organisation ID: |
Step 84 Select column to upload
Headei Infomation
"^plication User ID: jepa~
ID: TED
fV Apply User Login Va
Add New Empty Row Copy Rowls) to New RowlsJ
Delete Row(s)
Show Legends
Select the appropriate columns fro
HOT on the input file.
e drop-downs below. Refer to the legend on the middle right as to whether fields are required or not. Rows can be sorted by (.licking on the column header. Changes made will be reflected in the new output file and
Required Fields
" Fuel Code
- BatchVolume
1 Fuel Category Code
* Production Date
" Process Code
* RINQuantiry
* GenerateFacilityldentifier
1 Batch Number Text
Optional Fields
DenaturantVolume
EquivalenceValue
Gen erat e Or ga nizat ion Ide ntif ie r
Transaction Detail CommentTent
ImportFacilityldentiher
Co Product Fields - Up to 3 sets
Co Product Code 1
Co Product Detail Comment Text 1
Co Product Code2
Co Product Detail Comment Text2
Co Product Code3
Co Product Detail CommentTextS
Feedstock Fields - Minimum = 1 set. Maximum = 3 sets
* Feedstock Code 1
* Renewable Siomass Indicator 1
Feedstock Volume 1
" Feedstock Measure Codel
" FeedstockDetailCommentTewtl
* Feedstock Code2
" RenewableBiornasslndicator2
Feedstock Measure Code2
* Feedstock Detail Comment Tenr.2
' Feedstock Code3
Renewable Biomass Indicators
" FeedstockVo!ume3
' Feedstock Measure CodeS
* Feedstock Detail Comment Te«t3
Step tt5 - Piocess And Write to XML File
Output File Options Exit/Stop Processing
Progress:
s set to Recommended Defaults
The user should first fill in the "Enter Company Info" portion of File Processing Screen, indicated by "Step
#3" in Figure 9. The company information required includes:
User Login (is case sensitive and must be the same as the EMTS login);
Organization ID (EPA assigned, four-digit ID); and
Submittal Creation Date.
Under the "Enter Company Info" section, a data grid should be visible. The user should fill in data. Once
the data is entered and the user information is complete, the user should click the "Process File" button.
Results of Processing
If processing is successful, the screen will display a message that reads "records were successfully
processed. Formatted to: XML file" (see Figure 10).
-------
EMTS Transaction Instructions
Figure 10: A Successfully Processed File
Step 83 - Process And Write to XML File
Output File Options
Recessing Data. Approw Records to
Finished processing Input Dat.
Formatted to: XML file.
Upon successful processing, the output XML file is written to the following directory:
C:\Documents and Settings\\My Documents\EMTS Conversion Tool (ECT)\Good_Files
If processing is not successful, the screen will display a message that includes, "Missing or incorrect value
for required element(s) in record(s):<...>, refer to columns marked." Figure 11 depicts an example of this.
If the user had previously selected the "Build a New File" option, a data grid will be visible and the
appropriate cell(s) in this grid will change color to indicate where the error has occurred.
Figure 11: An Unsuccessfully Processed File
Step it3 - Process And Write to XML File
Output File Options
I r~ Status
Exit/Stop Processing Missing or incorrect value for required element (s) in record (s): 1,
FVocess File
FVocessing Data. ApproH Records to be processed = 1
Finished processing Input Data. Records processed = 1.
1 records were found with errors, these files can not be loaded to the server.
The ECT maintains a log file, which can be used to view additional descriptions of the errors if processing is
unsuccessful. Clicking the "Show Log" button at the top of the file processing screen displays the log file in
the log viewer (see Figure 12). This viewer includes buttons which allow the user to print the log and to
select another log file for viewing. Clicking "Exit" closes the log viewer.
-------
Figure 12: Errors Reported in Log File
ffl C:\Documents and Settings\wgo\My DocumentsXEMTS Conversion Tool (ECT)Wal_Log\... [T~| O |[X |
INFO: {0} Finished Loading Input Data. 1 data records read.
INFO: {0}
Hvirn. if-\\
AJ
INFO: {0} I nput f ile: U3 enerateAnneM cPhee2. xls < X X >
INFO: {0}
INFO: {0} Missing: RIN Quantity
INFO: {0} -12/1 8/2009 3: 18: 48PM
INFO: {0} Missing data for required fields on record(s): 1 , Record will not be processed.
INFO: {0} Missing or incorrect value for required elemental in recordfs): 1,
INFO In!
ii T| r LJ . i.'-'.r
INFO: {0} Processing Data. Approx Records to be processed = 1
Finished processing Input Data. Records processed = 1.
1 records were found with errors, these files can not be loaded to the server.
I MFD- in\
^^III^HHHHHHHHHHHHI
Print Log
HI
Jll~
0 pen Another Log E xit
If a selected input file is not successfully processed, the ECT will still attempt to create an output XML file.
This file will be located in the following directory:
C:\Documents and Settings\\My Documents\EMTS Conversion Tool (ECT)\Error_Files
Only the data rows with no errors will be written to the output file. All data rows that contain errors will
not be converted to XML.
Processing Multiple Files
If multiple files were selected for processing and the user wishes to process the next file in the batch, the
user should click "Next file," as indicated in Figure 13. Before processing the next file, the user will have to
re-enter the Organization ID and the Submittal Creation Date. Note that the "Next file" button will be
present for all files except the last one in the batch.
-------
Figure 13: Processing Next File
Step S3 - Process And Write to XML File
Output File Options
Rocess File
But/Stop Processing
Q~NeKt file
)
Status
Processing Data. Approw Records to be processed = 1
Finished processing Input Data. Records processed =1.1 records were successfully processed.
Formatted to: XML file.
Compressed to: Ho compressions were selected.
Progress:
10
------- |