The Coupon & Discount Setup Information is taken from your Coupon and Discount setup file and includes the setup information for all the coupons and discounts set up in your system. To generate this file during End of Day, Coupon/Discount Setup Information must be set to Y in getdata (see Setting Up Data Sharing) and at least one coupon or discount must exist.
The following table explains the naming conventions of the coupon and discount setup data share file: #####q[md].shr
| Field | Definition | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ##### | Store Number | ||||||||||||||||||||||||||||||||
| q | This character denotes that the file contains coupon and discount setups. | ||||||||||||||||||||||||||||||||
| m | This character denotes the month. The characters range from a to l and are as follows:
|
||||||||||||||||||||||||||||||||
| d | This character denotes the day. The characters range from a to z and 1 to 5 and are as follows:
|
The following is an example of an actual record in what is known as “comma-delimited” format. This means that the information you entered in each field in this POS system record is separated by a comma.
“06/20/2011″,”C”,”MGR5″,”Manager $5″,…
We have numbered the fields in the following record in order to explain them more clearly to you. Each bolded number indicates one field.
| Note: | Some of the fields contained in this file are for internal system processing only and may not be useful to you. |
| 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 |
| “06/20/2011” | “C” | “MGR5” | “Manager $5” | “5.00” | “06/01/2011” | “” | “” | “” | “” | “MGR” | “N” | “4011” |
| 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 |
| “” | “” | “” | “” | “” | “” | “” | “” | “” | “” | “A” | “” | “N” | “N” | “N” | “N” | “N” | “N” |
| 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 |
| “” | “N” | “N” | “” | “” | Y | “1” | “” | “” | “” | “” | “” | “” | 1000 | “” | “” |
The following chart lists and describes the contents of the (q) coupon and discount file.
| Num. | Description | Definition | ISI Field Name | Output Format* | Quoted? | Example Value | General Release Version When Added |
|---|---|---|---|---|---|---|---|
| 1 | Date | File creation date | none | ##/##/#### | X | 06/20/2011 | 11.1 |
| 2 | Type | C for coupon or D for discount. Dollar amount if coupon. Percent if discount (.10 = 10%) | infd.type | X(1) | X | C | 11.1 |
| 3 | ID | Coupon or discount ID | infd.id | X(6) | X | MGR5 | 11.1 |
| 4 | Description | Coupon or discount description | infd.desc | X(20) | X | Manager $5 | 11.1 |
| 5 | Amount/Rate | Amount if coupon, percent if discount | infd.amount | #4.2 | 5.00 | 11.1 | |
| 6 | Effective Date | Date coupon or discount can begin being accepted | infd.effective_date | ##/##/#### | X | 06/01/2011 | 11.1 |
| 7 | Drop Date | Date coupon or discount will no longer be accepted | infd.drop_date | ##/##/#### | X | 11.1 | |
| 8 | Central Send Flag | Only populated by OIL Central | infd.send_flag | X(1) | X | 11.1 | |
| 9 | Unused | infd.unused8 | X(5) | X | 11.1 | ||
| 10 | Unused | infd.unused9 | X(3) | X | 11.1 | ||
| 11 | Category ID | ID of category assigned to coupon or discount | infd.cat | X(3) | X | MGR | 11.1 |
| 12 | Include Coupon Flag | Y or N to indicate if coupon should be calculated prior to discounts | infd.inc_coup | X(1) | X | N | 11.1 |
| 13 | Account Number | Coupon or discount account number | infd.account | #6.2 | 4011 | 11.1 | |
| 14 | Apply/Exclude | Service codes that the coupon or discount can either be applied to or be excluded from applying to. 10 fields available. | infd.appl, infd.appl2 – infd.appl10 | X(3) | X | 11.1 | |
| 24 | Apply/Exclude Flag | A or X to indicate if the service codes are applied to or excluded from | infd.apex | X(1) | X | A | 11.1 |
| 25 | DMS Control Flag | Y or N. Only applicable for a store interfaced with a dealer management system. | infd.dms_ctl_flag | X(1) | X | 11.1 | |
| 26 | Reduce Taxable | Y or N for each tax type to indicate if the tax should be reduced because of coupons and discounts. 5 fields available. | infd.reducetax1 – infd.reducetax5 | X(1) | X | N | 11.1 |
| 31 | Validate Redemption Code | Y or N depending on if the redemption code should be validated. | infd.validate_rd_id | X(1) | X | N | 11.6 |
| 32 | Redemption Code Size | Denotes the code length to validate during invoicing (30 digit max). | infd.redempt_dize | #(2,0) | X | 11.6 | |
| 33 | Allow Duplication | Y or N for if this promotion can be used multiple times on a single invoice. | infd.allow_dup | X(1) | X | N | 11.6 |
| 34 | Require One Time Use Code Web Validation | Y or N for if this promotion requires one time use code validation during cash out. | infd.web_validate | X(1) | X | N | 11.10 |
| 35 | Employee Security Level for Overriding Web Validation | Employee security level setting [1-9] allowing override of one time use code validation. | infd.web_override | #1.0 | X | 11.10 | |
| 36 | Campaign Code Used During Validation | 16 character code from webCenral campaign setup. | infd.campaign_id | X(16) | X | 11.10 | |
| 37 | Require Redemption Code | Y or N for if users should be prompted for a redemption code during invoicing. | infd.rqr_redempt_id | X(1) | X | Y | 11.14 |
| 38 | Store Number | Number of the store. | inf0.store_nbr | X(5) | X | 1 | 15.3 |
| 39 | Max Amount | The maximum $ amount a discount may apply against an invoice. A value of 0 means that there is no maximum set. | infd.max | #4.2 | 15.10 | ||
| 40 | Apply/Exclude Service Code 11 through 200 | Service codes to require on invoice or disallow for coupon/discount application. | infd.appl11 – infd.appl30, infda.appl31 – infda.appl200 | X(3) | X | 15.10 | |
| 41 | Authorized employee security level | The minimum security level an employee must have to authorize the use of this promotion. A value of 0 means that authorization is not required. | infd.emp_override | #2.0 | 15.10 | ||
| 42 | Apply basis | Apply or exclude by specified service codes or categories. “S” means service code, “C” means category. | infd.apply_basis | X(1) | X | 15.10 | |
| 43 | Minimum sales quantity | Minimum quantity of items of the applicable service codes or categories required to apply promotion to invoice. | infd.min_qty | #4.2 | 15.10 | ||
| 44 | Discount basis | The value in this field is only used for discounts. “A” means that the discount applies to all applicable items based on service code or category. “H” means that the discount will apply to the highest sale priced item of the applicable service code or category. “L” means that the discount will apply to the lowest sale priced item of the applicable service code or category. | infd.discount basis | X(1) | X | 15.10 | |
| 45 | Required points | This is the amount of points required to be able to apply this coupon to a work order. For use in combination with the points based club feature. | infd.required_points | #8.0 | 15.14 | ||
| 46 | Automatic/Setup Only | Flag to determine if the coupon can be used during invoicing or if it is limited to club/fleet rewards. “Y” restricts the coupon/discount from use during invoicing. “N” allows use of the coupon/discount anywhere. A blank value functions the same as a “N” in the code. | infd.auto_only | X(1) | X | 15.14 | |
| 47 | Include in Help | Flag to determine if the coupon/discount will be visible in F1 help during tendering. A “N” will hide the coupon/discount from F1 help (as well as mobile help) during tendering/cashiering. A “Y” allows the coupon/discount as always. A blank value functions the same as a “Y” in the code. | infd.inc_help | X(1) | X | 15.14 |
* The Output Format column uses X to represent string fields and # to represent numeric fields. E.g. X(5) represents a string up to five characters in length. #(14) represents a number up to 14 digits in length.
