Contents Show
The EBT Processor system's format for the Approved Product List (APL) File is used for outbound communication from the SPIRIT system to the EBT Processor system.
The Approved Product List (APL) File is sent from the SPIRIT WIC system to the EBT Processor system during End of Day Processing. For more information, see the SPIRIT to EBT Files section of the EBT Processor Import/Export Files topic.
Also, see the Approved Product List (APL) Processing within the BatchProcessor topic for more information about Approved Product List (APL) File processes that occur during BatchProcessor Processing.
The Approved Product List (APL) File is applicable to your state when the Electronic Benefit Transfer (EBT) food delivery system is enabled for any site within your state.
|
|
NOTE: For more information about enabling the Electronic Benefit Transfer (EBT) food delivery system (or any other food delivery system, such as check, voucher, or direct distribution), see the Clinic screen in the Reference Utility application module. |
The Approved Product List (APL) File is generated during BatchProcessor Processing and sent to the folder names specified in the VALUE column of the FileSendPath and FileArchivePath rows within the EBTCONNECTIONINFO table of the SPIRIT database.
The name of the Approved Product List (APL) File is a combination of the values specified in the EBTCONNECTIONINFO table of the SPIRIT database.
|
|
NOTE: File names must match your state's EBT Processor's file name format requirements. The EBT Processor may also impose maximum length, date format, special character, or other restrictions. |
The naming syntax for the Approved Product List (APL) File sent to the FileSendPath specified in the EBTCONNECTIONINFO table of the SPIRIT database is based on the file type as follows:
When the file type is JPM, where the value of the FILETYPE column is equal to "0" in the EBTCONNECTIONINFO table of the SPIRIT database, the naming syntax is set to:
[File Name Variable]
For example, an Approved Product List (APL) File sent to the FileSendPath specified in the EBTCONNECTIONINFO table of the SPIRIT database might be named "C4WUPC".
The [File Name Variable] represents a combination of the [State Identifier Code] and WUPC.
"C4" in the example above is a [State Identifier Code] which signifies a Chickasaw Nation's Approved Product List (APL) File as designated by the Food and Nutrition Service (FNS) division of the United States Department of Agriculture (USDA). It is a 2-character alphanumeric value.
"WUPC" in the example above is a file naming convention which signifies an Approved Product List (APL) File. It is a 4-character value.
In the values above, "C4" and "WUPC" comprise a six-character Approved Product List (APL) File name example, but the exact name of the Approved Product List (APL) File in your state's environment will equal the value specified in the VALUE column of the APLFileName row within the EBTCONNECTIONINFO table of the SPIRIT database.
When the file type is WUMEI, where the value of the FILETYPE column is equal to "1" or "2" in the EBTCONNECTIONINFO table of the SPIRIT database, the naming syntax is set to:
[File Name Variable]{0:[Date Time Format Variable]}[File Name Variable][File Extension Variable]
For example, an Approved Product List (APL) File sent to the FileSendPath specified in the EBTCONNECTIONINFO table of the SPIRIT database might be named "APLfile.220924.231445.Clinic104.upnxml-2014".
The file name may be composed of a combination of alphanumeric characters and a date format as follows:
"APLfile." in the example above is a [File Name Variable] which signifies any user-defined alphanumeric value. Special characters, such as the period used here, may be allowed by your EBT Processor.
"{0:[Date Time Format Variable]}" is a date/time format and contains the following components:
"{0:" signifies the beginning of the date/time format.
The [Date Time Format Variable] signifies a standard date time format accepted by your state's EBT Processor. The format used in the example above is yyyyMMdd.HHMMSS.
"}" signifies the end of the date/time format.
During End of Day Command Line Batch Processing, the format is replaced by the actual date and time the Approved Product List (APL) File is processed. The example above includes the following date and time:
"220924" in the example above is a dating convention that signifies the date on which the Approved Product List (APL) File was generated. It is a 6-digit numeric value in "YYMMDD" format.
A period separates the date and time in this format.
"231445" in the example above is a dating convention that signifies the time in 24-hour military time (or 24-hour clock time) on which the Approved Product List (APL) File was processed. It is a 6-digit numeric value in "HHMMSS" format.
".Clinic104" in the example above is a [File Name Variable] which signifies any user-defined alphanumeric value. Special characters, such as the period used here, may be allowed by your EBT Processor.
".upnxml-2014" in the example above is a [File Extension Variable], which signifies the WIC Universal MIS EBT Interface (WUMEI) version supported. It is a 12-character value with alphanumeric and special characters.
The exact name of the File Extension Variable in your state's environment will equal the value specified in the VALUE column of the UPCPLUFileTypeExtension row within the EBTCONNECTIONINFO table of the SPIRIT database.
The exact file name in your state's environment will equal the values specified in the VALUE column of the APLFileName row followed by the VALUE column of the UPCPLUFileTypeExtension row, if applicable, within the EBTCONNECTIONINFO table of the SPIRIT database. At least one (1) alphanumeric character is required.
AND
The naming syntax for the Approved Product List (APL) File sent to the FileArchivePath specified in the EBTCONNECTIONINFO table of the SPIRIT database (to include a date and time stamp) is based on the file type as follows:
When the file type is JPM, where the value of the FILETYPE column is equal to "0" in the EBTCONNECTIONINFO table of the SPIRIT database, the naming syntax is set to:
[Original File Name][YYMMDD][HHMMSS]
For example, a Approved Product List (APL) File sent to the FileArchivePath specified in the EBTCONNECTIONINFO table of the SPIRIT database might be named "C4WUPC220924231512". In this example, the file processed on September 24, 2022, at twelve (12) seconds past 11:15 PM.
"C4WUPC" in the example above is the user-defined file name described above.
In the values above, "C4" and "WUPC" comprise a six-character Approved Product List (APL) File name example, but the exact name of the Approved Product List (APL) File in your state's environment will equal the value specified in the VALUE column of the APLFileName row within the EBTCONNECTIONINFO table of the SPIRIT database.
"220924" in the example above is a dating convention that signifies the date on which the Approved Product List (APL) File was processed. It is a 6-digit numeric value in "YYMMDD" format.
"231512" in the example above is a dating convention that signifies the time in 24-hour military time (or 24-hour clock time) on which the Approved Product List (APL) File was processed. It is a 6-digit numeric value in "HHMMSS" format, as follows:
"HH" = Hours
"MM" = Minutes
"SS" = Seconds
When the file type is WUMEI, where the value of the FILETYPE column is equal to "1" or "2" in the EBTCONNECTIONINFO table of the SPIRIT database, the naming syntax is set to:
[Original File Name][YYMMDD][HHMMSS][Sequence Number]
For example, a Approved Product List (APL) File sent to the FileArchivePath specified in the EBTCONNECTIONINFO table of the SPIRIT database might be named "APLfile.220924.231445.Clinic104.upnxml-2014.22092423151200". In this example, the file processed on September 24, 2022, at twelve (12) seconds past 11:15 PM.
"APLfile.220924.231445.Clinic104.upnxml-2014" in the example is the user-defined file name described above.
"220924" in the example above is a dating convention that signifies the date on which the Approved Product List (APL) File was processed. It is a 6-digit numeric value in "YYMMDD" format.
"231512" in the example above is a dating convention that signifies the time in 24-hour military time (or 24-hour clock time) on which the Approved Product List (APL) File was processed. It is a 6-digit numeric value in "HHMMSS" format, as follows:
"HH" = Hours
"MM" = Minutes
"SS" = Seconds
"00" in the example above is a file naming convention signifying a [Sequence Number] that begins with "00" and increments anytime a(n) Approved Product List (APL) File is created and one already exists in the specified path for the same day.
The Approved Product List (APL) File is also referred to by the following names in software solutions outside of the SPIRIT WIC system:
EBT Processor: "WIC UPC/PLU File"
WIC Direct: "WIC UPC/PLU File"
WIC EBT Middleware (WEM): "UPC-PLU-NTE / Approved Product List (APL) File"
The tables below describe the data elements that comprise the Approved Product List (APL) File.
|
|
NOTE: The Header Record position, Details Record position, and Trailer Record data elements do not apply to WUMEI file types. |
Header Record
|
SPIRIT Element |
WUMEI Name |
Position |
Length |
+Type |
*Notes |
|
Record Type |
Unmapped |
1-2 |
2 |
X |
Coded Value - 'HD'. |
|
Transaction Type |
File Name |
3-10 |
8 |
X |
"[State Identifier Code]WUPC". The [State Identifier Code] value as designated by the Food and Nutrition Service (FNS) division of the United States Department of Agriculture (USDA). For example, 'C4' is the [State Identifier Code] value for the Chickasaw Nation's WIC program as designated by FNS. The value is from the EBTCONNECTIONINFO table in the SPIRIT database. |
|
Date |
Date and time, transmission |
11-18 |
8 |
9 |
Date Field - "yyyyMMdd" format. |
|
Time |
Date and time, transmission |
19-26 |
8 |
9 |
Date Field - "HHMMSSFF" format. 'FF' signifies fractional seconds. |
|
Control Number |
File sequence number |
27-32 |
6 |
9 |
6-digit number incremented by 1 on each submission. |
|
WIC Program ID |
Unmapped |
33-34 |
2 |
X |
· |
|
Filler |
Unmapped |
35-250 |
216 |
X |
Empty space filled record. |
|
Error Code |
Unmapped |
251-426 |
176 |
X |
Space filled. |
|
Response Code |
Unmapped |
427-430 |
4 |
X |
Zero filled. |
+ For more information, see Field Data Types.
* For more information, see Annotations.
|
SPIRIT Element |
WUMEI Name |
Position |
Length |
+Type |
File Mapping from SPIRIT Database (Table. Column) |
*Notes |
|
~Record Type |
Unmapped |
1-2 |
2 |
X |
Unmapped |
Coded Value - 'DT'. |
|
~Action Code |
Action code |
3-4 |
2 |
X |
EBTAUTHORIZEDUPC. PRODUCTSTATUS IF PRODUCTSTATUS = "D" THEN '02' ELSE '01'. |
Coded Value.
|
|
~UPC/PLU Indicator |
Unmapped |
5-5 |
1 |
X |
EBTAUTHORIZEDUPC. PLUIND IF PLUIND = "Y" THEN 'P' ELSE 'U'. |
Coded Value.
|
|
~UPC/PLU Number |
UPC/PLU Data |
6-22 |
17 |
X |
EBTAUTHORIZEDUPC. UPCCD The UPCCD gets the length based on the EBTAUTHORIZEDUPC. UPCPLUDATALENGTH. |
· |
|
~Product Description |
Item Description |
23-64 |
42 |
X |
EBTAUTHORIZEDUPC. SHORTPRODUCTDESCRIPTION |
· |
|
~Unit of Measure |
Benefit Unit Description |
65-67 |
3 |
X |
EBTAUTHORIZEDUPC. UNITOFMEASURECD |
· |
|
~Manual Auth Hold Indicator |
Manual Voucher Indicator |
68-68 |
1 |
X |
EBTAUTHORIZEDUPC. MANUALAUTHHOLDINDICATOR |
Manual Authorized Hold Code. Coded Value.
|
|
~Category |
Category Code |
69-70 |
2 |
9 |
EBTAUTHORIZEDUPC. FOODCATEGORYCD |
2-character EBT category code. |
|
~Subcategory |
Subcategory Code |
71-73 |
3 |
9 |
EBTAUTHORIZEDUPC. FOODSUBCATEGORYCD |
3-character EBT sub-category code. |
|
~Quantity |
Benefit Quantity |
74-78 |
5 |
999v99 |
EBTAUTHORIZEDUPC. QUANTITY |
5 characters in 999v99 format with 2 implied decimals. |
|
~Maximum Price Array (21 Entries) |
· |
79-246 |
168 |
Mixed |
· |
· |
|
Peer Group Id |
· |
2 |
9 |
EBTMAR. PEERGROUP |
|
|
|
Peer Group Max Price |
· |
6 |
9999v99 |
EBTMAR. MARUPC OR EBTMAR. MARCATSUBCAT |
|
|
|
~Number of Peer Group Ids |
Number of WIC Vendor Peer Groups |
247-248 |
2 |
X |
Unmapped |
A count of the active Peer Groups. |
|
~NIT |
NIT |
249-254 |
6 |
X |
EBTCONNECTIONINFO. VALUE WHERE Name = 'NIT'. |
The WIC Authority ID value as designated by the Food and Nutrition Service (FNS) division of the United States Department of Agriculture (USDA). Coded Value. Space filled. For example, '011' is the WIC Authority ID value for the Chickasaw Nation's WIC program as designated by FNS. |
|
~Expire Date |
Date, End UPC/PLU Data |
255-262 |
8 |
9 |
EBTAUTHORIZEDUPC. ENDDATE |
Date Field - "yyyyMMdd" format. Zero filled if unknown. |
|
~Profile Number |
Unmapped |
263-271 |
9 |
9 |
EBTAUTHORIZEDUPC. VALUE WHERE Name = 'ProfileNum'. |
The State Agency's unique profile number identifier. Coded Value. Zero filled. For example, '500030011' is an example of a unique profile number identifier where the last 3 digits are '011' and represent the WIC Authority ID value or the WIC program identifier for the Chickasaw Nation's WIC program as designated by the Food and Nutrition Service (FNS) division of the United States Department of Agriculture (USDA). This field does not exist in the WUMEI; therefore, it is not used for SPIRIT to EBT Files. |
|
~Weight Product Indicator |
Unmapped |
272-272 |
1 |
X |
IF EBTAUTHORIZEDUPC. FOODCATEGORYCD = "CVB" AND EBTAUTHORIZEDUPC. PLUIND = "Y" THEN '1' ELSE '0' |
Coded Value.
|
|
~Purchase Indicator |
Purchase Indicator |
273-273 |
1 |
X |
EBTAUTHORIZEDUPC. PURCHASEINDICATOR |
Coded Value.
|
|
~Effective Date |
Date, Begin UPC/PLU Data |
274-281 |
8 |
9 |
EBTAUTHORIZEDUPC. STARTDATE |
Start Date in SPIRIT's UPC table. Date Field - "yyyyMMdd" format. Zero filled if unknown. |
|
~Rebate Flag |
Rebate Flag |
282-282 |
1 |
X |
EBTAUTHORIZEDUPC. REBATEITEM |
Coded Value.
|
|
~Price Type Code |
Price Type |
283-284 |
2 |
X |
Unmapped |
· |
|
~UPC/PLU Length |
UPC/PLU Data Length |
285-286 |
2 |
9 |
EBTAUTHORIZEDUPC. UPCPLUDATALENGTH |
· |
|
~Filler |
Unmapped |
287-289 |
3 |
X |
Unmapped |
Space filled. |
|
~APL Type Length |
APL Type Length |
290-290 |
1 |
9 |
Unmapped |
Space filled. |
|
~APL Types List |
APL Type |
291-299 |
9 |
9 |
EBTUPCAPLTYPE. APLTYPE |
10 characters. The first character indicates the number of APL types, and the remaining nine (9) characters contain the APL Type IDs, which can be applied as follows:
For example:
|
|
~Filler |
Unmapped |
300-422 |
123 |
X |
Unmapped |
Left aligned. Space filled. |
|
~Error Code |
Unmapped |
423-426 |
4 |
X |
Unmapped |
Space filled. |
|
~Response Code |
Unmapped |
427-430 |
4 |
X |
Unmapped |
Zero filled. |
~ Denotes a required SPIRIT Element.
+ For more information, see Field Data Types.
* For more information, see Annotations.
Trailer Record
|
SPIRIT Element |
WUMEI Name |
Position |
Length |
+Type |
*Notes |
|
Record Type |
Unmapped |
1-2 |
2 |
X |
Coded Value - 'TR'. |
|
Transaction Type |
File Name |
3-10 |
8 |
X |
"[State Identifier Code]WUPC". The [State Identifier Code] value as designated by the Food and Nutrition Service (FNS) division of the United States Department of Agriculture (USDA). For example, 'C4' is the [State Identifier Code] value for the Chickasaw Nation's WIC program as designated by FNS. The value is from the EBTCONNECTIONINFO table in the SPIRIT database. |
|
Date |
Date and time, transmission |
11-18 |
8 |
9 |
Date Field - "yyyyMMdd" format. |
|
Time |
Date and time, transmission |
19-26 |
8 |
9 |
Date Field - "HHMMSSFF" format. 'FF' signifies fractional seconds. |
|
Control Number |
File sequence number |
27-32 |
6 |
9 |
6-digit number incremented by 1 on each submission. |
|
Total Detail Records |
Unmapped |
33-38 |
6 |
9 |
Count of the number of detail records. Zero padded. |
|
Filler |
Unmapped |
39-250 |
212 |
X |
Space filled. |
|
Error Code |
Unmapped |
251-426 |
176 |
X |
Space filled. |
|
Response Code |
Unmapped |
427-430 |
4 |
X |
Zero filled. |
+ For more information, see Field Data Types.
* For more information, see Annotations.
|
Software Version: 2.40.00
Updated in Rel 2.38 per SWEB US 12652. Updated in Rel 2.40 per SWEB US153511
