Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
This appendix describes the file formats required for Circulation's import and export files.
Circulation receives most of its information via data entry (subscriber transactions and so on), and outputs it mainly as documents (bundle tops, renewal notices, etc.). However, in many cases Circulation can import and export information with ASCII files, so that the information can be interfaced with another software product. This appendix documents the required formats for these import and export files.
ASCII (American Standard Code for Information Interchange) files consist of 128 decimal numbers ranging from zero through 127 assigned to letters, numbers, punctuation marks, and the most common special characters. When viewed, ASCII files look much like text files.
A typical ASCII file will contain a certain number of records; each record will be broken down into a certain number of fields (the number of fields will be the same for each record). The file’s format describes the fields and how the computer should differentiate between one field and another.
Some formats are “fixed length”—the computer is told how many places are contained in the first field, how many in the second, and so on. Other formats have a “delimiter”—a certain character such as a comma, space, or pipe symbol (|) that lets the computer know where one field ends and another begins. In this case, each record also has a delimiter, usually a carriage return. Circulation uses both fixed length and delimited formats. Many Circulation formats are space delimited, with quotes around character fields—this is the standard PROGRESS style for formats.
Some of the more complex file formats used by Circulation have several different types of records. Typically, there is a single “batch header” and “batch trailer” record that contains total amounts for the file. In between are multiple “detail” records, one for each transaction.
To interface information between Circulation and other software, you will need to configure the other application so that it can read the Circulation format. In some cases (such as TeleDirect), the file is written in a format specified by the other application. Most (though not all) files are exported or imported from the /dti/exchange/cm directory.
Note: If you have additional database sets, the directory used will be /dti/exchange/<dblist>
. For example, if you have a separate set of Circulation databases called “cmtest”, the directory used will be /dti/exchange/cmtest
.
Note:
If importing masked credit card numbers (credit card numbers where only the last four digits are readable for security purposes), you must use an asterisk (“*”) for masked characters.
Topics |
---|
The /dti/exchange/<db>/secure
directory stores files containing private subscriber and account information, including credit card numbers, bank numbers, bank account numbers, social security numbers, and tax IDs. This directory can be made secure through UNIX/Linux, so that only authorized users are able to access it and the files stored within it.
Currently, this directory is used for refund files, credit card and bank draft interface files, and the Vendor Change Report export file. If you plan to restrict access to this directory, be sure that the permissions group you assign includes all users who need to create these files. The menu options that use this directory will be available only to users who have access to the secure directory. For other users, a message will be displayed indicating that they do not have the necessary permission.
When the secure directory is created, permissions are wide open by default. If you want to restrict this directory, you must do so through UNIX/Linux. Refer to your UNIX/Linux documentation for more information on restricting permissions to a directory.
When using Graphical Customer Service, access to the secure
directory is determined by the user who started the Webspeed agent. If the user who starts the Webspeed agent does not have permission to the access the secure directory, then refunds cannot be entered.
To ensure access to the secure
directory when using the graphical interface, the Webspeed agents should be started by a root process when the backup is finished or when the server is rebooted.
Note: All of the interfaces described in this section require a separate license fee to use. Contact the Newscycle Support Center for more information.
Location: /dti/exchange/cm/secure
.
File types: Account credit card payments can be exported in the following formats:
Edgil and EdgCapture—Edgil and EdgCapture files are fixed format. The file name will be “ed[batch].[date][sequence#]
”, where [date] is the batch date in DDMMYYYY format, and [sequence#] is the number of times the Edgil export has been run on that date.
EIGEN—The EIGEN file is tab delimited. The file name will be “ei[batch]
”, where [batch] is the name of the account payment batch.
ICVerify—The ICVerify file is comma-delimited with fields in double quotes. The file name will be “ic[batch]
”.
Paymentech—The Paymentech file is comma-delimited. If a field needs to contain a comma as data, it must be coded as <COMMA>. The use of new lines or double quotes is not allowed in any field.
The file name will be “pt[BatchID].csv
” for payments or “ptref[BatchID].csv
” for batch refunds. In addition, if the Business Rules— Should customer service payments create separate batches by publication? and Should credit card refunds create separate export files by publication?, are set to “yes”, the publication will also be appended to the file name as follows: “pt[BatchID][Publication].cs
v” or “ptref[BatchID][Publication].csv
”.
Customer Service refunds are exported one at a time and not in a batch. The file name for Customer Service refunds will be “ptref[SubscriptionID]-[unique number].csv
”.
POS-Partner 2000—The POS-Partner 2000 file is comma-delimited, with no quotes around each field. There are no batch or file header or trailer records. POS-partner 2000 is an upgrade of the POS-partner 2.24 file format (called VISANET in the system), so there are similarities between the two formats. The file name will be “pos[batch name].txt
”.
Skipjack—The Skipjack file is variable length, with each line followed by a carriage return and line feed. The file name will be “sj[batch ID]
”
TransFirst Transaction Central—The export file name is as follows: <YY><MM><DD><Sequence Number>.CCK
, where Sequence Number = 01-999. For example, an entire file name might be 10052101.CCK. The export file is comma-delimited with quotation marks around the text.
Note:
Typically, credit card export files can be split out by publication via Business Rules. However, this is not possible with TransFirst Transaction Central due to the file-naming requirements.
viaWARP—The viaWARP file is comma-delimited, with fields in double quotes. The file name will be “vw[BatchID]
”.
Virtual Terminal—The Virtual Terminal file is comma-delimited with no quotes around the fields with each transaction on its own line. There are no batch or file header or trailer records.
The file name will be “vt[BatchID].txt
” for payments or “vtref[BatchID].txt
” for batch refunds. In addition, if the Business Rules— Should customer service payments create separate batches by publication? and Should credit card refunds create separate export files by publication?, are set to “yes”, the publication will also be appended to the file name as follows: “vt[BatchID][Publication].txt
” or “vtref[BatchID][Publication].txt
”.
VISANET—The VISANET format is comma-delimited, with fields in double quotes. The file name will be “vs[batch name].txt
”.
American Express—Credit card payments may be exported to a separate American Express file (based on Business Rules), which is fixed length. The American Express file will be named “ae[batch]
”, where [batch] is the name of the account payment batch.
Business Rules govern which format is used.
File type: Fixed length
Location: /dti/exchange/cm/cm1099misc.d
or cm1099int.d
Description: 1099 Balance Detail
Delimitation: Fixed Length
Total Record Length: 169 Characters
Description: Interface Trailer
Delimitation: Fixed Length
Total Record Length: 14 Characters
File type: Fixed length.
Location: Prints on account invoice (not exported). Business Rules determine whether a scan line is printed and the two digit company number to use. The printer must also be set up to print scan lines (in Setup | System | Device | Specifics | Device Control
).
To calculate the check digit, the odd positions are multiplied by 2, the even by 1, and the resulting digits are totaled. The last digit of the total is subtracted from 10, and the remainder is the check digit. Note that it is the digits that are totaled, not the numbers. So, if on odd position were 7, then 7 * 2 would be 14; when totaled, Circulation would not add 14, but 5 (1 + 4).
For example, with the number 76543210
, Multiplying the odd digits by 2 and the even by one would give us:
1461046220
The sum of these digits is 26. 10 - 6 = 4. So the check digit will be 4.
The export format for the Paragraph 3 by ZIP report is given below. This is the standard AAM electronic filing format.
One record is be exported for each ZIP Code with over 25 copies. ZIP Codes with under 25 copies are combined into a miscellaneous record by state (one record per state). The ZIP Code “99999” is exported for all miscellaneous records.
File type: Comma-delimited.
Location: /dti/exchange/cm
. The file name is specified at run time.
Field | Format | Description |
---|---|---|
Max Length | Content |
---|---|
Record | Length | Field |
---|---|---|
Record | Length | Field |
---|---|---|
Field | Sample Output |
---|---|
Col | Field | Length | Description |
---|---|---|---|
Col | Field | Length | Description |
---|---|---|---|
Col | Field | Length | Description |
---|---|---|---|
Field | Sample Output |
---|---|
Field | Sample Output |
---|---|
# | Name | Type | Valid Characters | Description |
---|---|---|---|---|
# | Name | Type | Valid Characters | Description |
---|---|---|---|---|
# | Name | Type | Valid Characters | Description |
---|---|---|---|---|
Record | Format | Value |
---|---|---|
Field Name | Position | Length | Description |
---|---|---|---|
Field | Sample Output |
---|---|
Field | Length | Position | Description |
---|---|---|---|
Length | Position | Content |
---|---|---|
Length | Pos | Content |
---|---|---|
Length | Pos | Content |
---|---|---|
Length | Position | Content |
---|---|---|
Length | Position | Content |
---|---|---|
Field | Length | Required | Description |
---|---|---|---|
Field | Length | Required | Description |
---|---|---|---|
Length | Description |
---|
Field | Format | Description |
---|
Field | Order | Type | Length | Description |
---|
Field | Format | Description |
---|
Invoice Date
date
Invoice date, MMDDYYYY
Invoice Begin Date
date
Begin date of the invoice period, MMDDYYYY
Balance Forward
9(8.2)
Balance forward for this invoice
Balance Due
9(8.2)
Balance due for this invoice
AAM Zone
X(8)
Primary AAM zone defined for the route
Distribution Method
X(8)
Distribution method (route type)
Charge Code
X(8)
The charge code. For payments, the term “Payment” will be exported in this field.
Description
X(30)
Description of the charges
Credit/Debit
X(6)
“Credit” or “Debit”
Quantity
9(7.3)
Quantity
Amount
9(8.2)
Amount
Route
X(8)
Route ID
Publication
X(8)
Publication ID
16
Term ID Group (from Business Rules)
2
“12” (Transaction Code)
19
Credit Card Number
4
Expire Date (format yymm)
9
Payment Amount (no decimal, last two characters are cents)
8
Approval Code (blank)
40
Account ID or Subscriber ID
Control Record
1
H (Control Record begins)
8
System date, format DDMMYYYY
1
Merchant ID (from Business Rules)
1
Filler (spaces)
2
Sequence number (number of Edgil exports so far on this date)
1
OEP ID (from Business Rules)
1
1 (held transaction option)
65
Filler (spaces)
Detail Record
1
1 (Detail Record begins)
4
Transaction sequence (the order of the payment in the file)
2
Transaction code (“SA”)
1
OEP ID (from Business Rules)
1
Merchant ID (from Business Rules)
8
System date, format DDMMYYYY
2
Sequence number (from the Control record)
4
Transaction sequence (the order of the payment in the file)
2
Filler (spaces)
24
Credit card number
6
Credit card expiration date, format MMYY plus 2 spaces
7
Payment amount, including cents, format 9999999
8
Authorization code (spaces)
2
Card holder state (spaces)
8
Filler (spaces)
Detail Record 2
1
2 (Detail Record 2 begins)
4
Transaction sequence (the order of the payment in the file)
19
Account’s or subscriber’s first name plus last name
1
Octal 35 (GS-1)
19
Account’s or subscriber’s address, line 1
1
Octal 35 (GS-2)
20
Account’s or subscriber’s address, line 2
9
Account’s or subscriber’s Zip code plus extension
6
Filler (spaces)
Detail Record 3
1
3 (Detail Record 3 begins)
4
Transaction sequence (the order of the payment in the file)
15
Account’s or subscriber’s primary phone number, format (999)999-9999, plus 2 spaces
15
Account or subscriber number
12
Account’s or subscriber’s city
10
Account or subscriber number
4
ID of user who entered payments
5
Payment batch ID
4
Payment sequence (the order of the payment in the batch)
10
Filler (spaces)
Trailer Record
1
T (Trailer Record begins)
4
Total number of detail records in batch (detail 1 + 2 + 3)
9
Total amount of all payments in batch
66
Filler (spaces)
Control Record
1
H (Control record begins)
8
System date, format DDMMYYYY
1
Merchant ID (from Business Rules)
1
Filler (space)
2
Sequence number (number of EdgCapture exports so far on this date)
1
OEP ID (from Business Rules)
1
2 (held transaction option)
65
Filler (spaces)
Detail Record
1
1 (Detail record begins)
4
Transaction sequence (the order of the payment in the file)
2
Transaction code (“SA” sale for payments and “CR” credit for refunds)
1
OEP ID (from Business Rules)
1
Merchant ID (from Business Rules)
8
System date, format DDMMYYYY
2
Sequence number (from the Control record)
4
Transaction sequence (the order of the payment in the file)
2
Filler (spaces)
24
Subscriber’s credit card or bank account number
6
Credit card expiration date, format MMYY plus 2 spaces
7
Payment amount, including cents, format 9999999
8
Authorization code (spaces)
2
Card holder state (spaces)
8
Filler (spaces)
Detail Record 2
1
2 (Detail Record 2 begins)
4
Transaction sequence (the order of the payment in the file)
19
Subscriber’s first name plus last name
1
ASCII 29 (GS-1)
19
Subscriber’s address, line 1
1
ASCII 29 (GS-2)
20
Subscriber’s address, line 2
9
Subscriber’s ZIP Code plus ZIP extension
6
Filler (spaces)
Detail Record 3
1
3 (Detail Record 3 begins)
4
Transaction sequence (the order of the payment in the file)
15
Subscriber’s primary phone number, format 9999999999, plus 5 spaces
15
Subscription account number
12
Subscriber’s city
10
Subscription account number
6
ID of user who entered payments
10
Subscription payment batch ID
7
Payment sequence (the order of the payment in the batch)
Detail Record 4
1
4 (Detail Record 4 begins)
4
Transaction sequence (the order of the payment in the file)
75
Filler (spaces)
Detail Record 5
1
5 (Detail Record 5 begins)
4
Transaction sequence (the order of the payment in the file)
9
Subscriber’s bank routing number
1
B (direct debit) if auto renew payment, otherwise A (check draft)
1
A if client type entered with payment is “personal” or blank, B if client type is “business”
64
Filler (spaces)
Trailer Record
1
T (Trailer Record begins)
4
Total number of detail records in batch (detail 1 + 2 + 3 + 4 + 5)
9
Total amount of all payments in batch
66
Filler (spaces)
“C1” (beginning of payment batch record)
“C1”
User ID of operator who processed payments
“tomk”
Account or subscription ID
“4726A”
Credit card number
“57483773”
Expiration date of credit card (YYMM or MMYY format, depending on Business Rules)
“9901”
Payment amount including tip (use decimal point—e.g. 2.33)
“50.09”
MOTO only: Placeholder for “recurring” yes/no flag. Currently blank.
blank
Account or subscriber Zip code
“55443”
Account or subscriber house number (0 if house number is blank)
“412”
14 blank fields
““,””,””,””, etc ...
——————————————————————————————
——————————
“ST” (beginning of close batch record)
“ST”
21 blank fields
““,””,””,””, etc ...
1
Line Type
1
Value = H (Header record). (Required, Alphanumeric)
2
Line Number
N/A
Value = 1 (Row number). Will always be 1 for the Header record. (Required, Number)
3
Format Version
5
Stored in Business Rules (Subscriber Payments and Accounts Payments sections). (Required, Alphanumeric)
4
User Name
32
Must be all upper case. Stored in Business Rules (Subscriber Payments and Account Payments sections). (Required, Alphanumeric)
5
File Name
32
Must match the name of the uploaded file, minus the file extension. Must be all lower case. For example, if the uploaded file is “ptBATCH.csv”, the File Name field would be “ptbatch”. (Required, Alphanumeric)
6
Detail Record Total
6
Total of all lines with Line Type = D. The “Line Number” of the final D record should contain the same value as this field. (Required, Number)
1
Line Type
1
Value = D (Detail record). (Required, Alphanumeric)
2
Line Number
6
The first detail record will always be 1 and increment by 1 for each subsequent record. The final D record line number must equal the Detail Record Total in the Header record. (Required, Number)
3
Line Subset Type
Reserved for future use.
4
Line Subset Number
Reserved for future use.
5
Transaction Type
3
Value = O (the letter O, not zero) for New Order. (Required, Alphanumeric)
6
Transaction New Order Transaction Type
2
Value for payments = AC (Authorization and mark for capture). Value for refunds = R (Refund Request). (Required, Alphanumeric)
7
Order Number
22
Subscription ID for subscriber payments/refunds, Account ID for account payments. (Required, Alphanumeric)
8
Industry Type
2
Value = MO (Mail Order Transaction). (Required, Alphanumeric)
9
Transaction Amount
12
Payment/refund amount. Store “$5.00” as “500”. (Required, Number)
10
Credit Card Number
19
Credit Card Number. Although this field can be left blank for ECP payments, since ECP payments are not exported, this field is required in the DTI batch file. (Conditional, Number)
11
Card Type/Brand
2
Not used. (Conditional, Number)
12
Card Expiration Date
4
Card Expiration Date. Format = MMYY. Since this may be left blank only for ECP payments, it is required in the DTI batch file. (Conditional, Number)
13
N/A
N/A
N/A
14
Switch – Solo Issue Number
2
Not used. (Conditional, Number)
15
Switch – Solo Card Start Date
4
Not used. (Conditional, Number)
16
ECP Bank Routing and Transit Number
9
Not used. (Conditional, Number)
17
ECP Customer DDA Account Number
17
Not used. (Conditional, Alphanumeric)
18
ECP Bank Account Deposit Type
1
Not used. (Conditional, Alphanumeric)
19
ECP Authorization Method
1
Not used. (Conditional, Alphanumeric)
20
ECP Payment Delivery Method
1
Not used. (Conditional, Alphanumeric)
21
Cardholder Billing Address Zip Code
10
Subscriber or account’s Zip code. Format = 99999 or 99999-9999. (Optional, Alphanumeric)
22
Cardholder Billing Address Line 1
30
Subscriber or account’s first address line. (Optional, Alphanumeric)
23
Cardholder Billing Address Line 2
30
Subscriber or account’s second address line. (Optional, Alphanumeric)
24
Cardholder Billing City
20
Subscriber or account’s city. (Optional, Alphanumeric)
25
Cardholder Billing State
2
Subscriber or account’s state. (Optional, Alphanumeric)
26
Cardholder Billing Name
30
Subscriber or account’s first name, middle initial, last name, and name suffix (“John P Smith Jr”). (Optional, Alphanumeric)
27
Cardholder Billing Address Country Code
2
Subscriber or account’s country. “US” for United States, “CA” for Canada, “GB” for Great Britain, “UK” for United Kingdom, Blank for all other countries. (Optional, Alphanumeric)
28
Use Profile Customer Reference Number
22
Not used. (Conditional, Alphanumeric)
29
Profile Order From Indicator
1
Not used. (Conditional, Alphanumeric)
30
Profile Customer Reference Number
22
Not used. (Conditional, Alphanumeric)
31
Profile Order Override Indicator
2
Not used. (Conditional, Alphanumeric)
32
N/A
N/A
N/A
33
N/A
N/A
N/A
34
Prior Authorization Code
6
Not used. (Optional, Alphanumeric)
35
Comments
64
Payment or refund’s transaction number. (Optional, Number)
36
Shipping Tracking Reference Number
40
Not used. (Optional, Alphanumeric)
37
Tax Indicator
1
“0” for all account payments and subscriber refunds. “1” for subscriber payments that have a non-zero tax amount. “2” for subscriber payments that have a zero tax amount. Newscycle does not store tax data for account payments or subscriber refunds, so this field will be “0” for all account payments and subscriber refunds. Tax data are available for subscriber payments. (Conditional, Number)
38
Tax Amount
12
“0” for all account payments and subscriber refunds. Newscycle does not store tax data for account payments or subscriber refunds, so this field will be “0” for all account payments and subscriber refunds. Tax data are available for subscriber payments. (Conditional, Number)
39
Customer Purchase Order Number
17
Blank for account payments and subscriber refunds. For subscriber payments, store the PurchaseNumber field from the Subscription table. Newscycle does not have a purchase order number associated with accounts. For subscribers, a purchase order number can be entered with a start or a billing change, and it is stored in the Subscription record. (Conditional, Alphanumeric)
40
Shipping to: Zip Code
10
Not used. (Conditional, Alphanumeric)
41
Ship to: Name
30
Not used. (Conditional, Alphanumeric)
42
Ship to: Address Line 1
30
Not used. (Conditional, Alphanumeric)
43
Ship to: Address Line 2
30
Not used. (Conditional, Alphanumeric)
44
Ship to: City
20
Not used. (Conditional, Alphanumeric)
45
Ship to: State
2
Not used. (Conditional, Alphanumeric)
46
Amex Purchasing Card Data Addendum #1
40
Not used. (Conditional, Alphanumeric)
47
Amex Purchasing Card Data Addendum #2
40
Not used. (Conditional, Alphanumeric)
48
Amex Purchasing Card Data Addendum #3
40
Not used. (Conditional, Alphanumeric)
49
Amex Purchasing Card Data Addendum #4
40
Not used. (Conditional, Alphanumeric)
50
N/A
N/A
N/A
51
Trace Number for Retry Logic
16
Payment or refund’s transaction number. Unique identifier for this transaction that tells Paymentech not to process the transaction again if it appears in a subsequent file. (Optional, Number)
52
Soft Descriptor Merchant Name
25
Not used. (Conditional, Alphanumeric)
53
Soft Descriptor Product Description
18
Not used. (Conditional, Alphanumeric)
54
Soft Descriptor Merchant City
13
Not used. (Optional, Alphanumeric)
55
Soft Descriptor Merchant Phone
12
Not used. (Conditional, Alphanumeric)
56
Soft Descriptor Merchant Email
13
Not used. (Conditional, Alphanumeric)
57
Soft Description Merchant URL
13
Not used. (Conditional, Alphanumeric)
58
Recurring Indicator
2
Not used. (Conditional, Alphanumeric)
59
European Direct Debit Bank Sort Code
10
Not used. (Conditional, Alphanumeric)
60
European Direct Debit Country Code
2
Not used. (Conditional, Alphanumeric)
61
European Direct Debit RIB
2
Not used. (Optional, Alphanumeric)
1
Line Type
1
Value = T (Trailer Record). (Required, Alphanumeric)
2
Line Number
6
Value = 1 (the row number). This will always be 1 for the trailer record. (Required, Number)
V Number (from Business Rules)
12345678
Credit Card Account Number
4.8E+15
Expiration Date (mmyy)
807
Transaction Amount
36
Transaction Type
“Pending Authorization” for payments; “Credit” for refunds
Billing Address 1 (account house number)
377
Billing Zip code (account Zip code)
55107
Card Not Present
N
Ship Date (mm/dd/yy) (payment date)
08/30/06
Invoice Number (batch name and account ID, or batch name and subscriber ID)
AR00784 1230002 or CS06083074 1230002
Name
sjname=<firstname+lastname>&
Email Address
email=<occupant email address>& If no occupant email address exists, the value will be “email=none@skipjack.com&”
StreetAddress
streetaddress=<housenumber>& If no house number exists, the value will be “streetaddress=none&”
City
city=<city>&
State
state=<state>&
Zip Code
zipcode=<Zip code>&
Credit Card Account Number
accountnumber=<credit card number>&
Credit Card Expiration Month
month=<month credit card expires>&
Credit Card Expiration Year
year=<year credit card expires>&
Amount of Transaction
Transactionamount=<total amount of payment>& This amount includes any subscription amount, tips and subscriber payment adjustments associated with the payment. Must use a decimal with the amount.
Ship to phone number
shiptophone=<area code+phone number>& If no phone exists, the value will be “shiptophone=none&”
Order Number
ordernumber=<account ID>&
Transaction ID
transactionid=<CashTransaction.TranNumber>&
Application Name
App=CM&
Orderstring
orderstring=<itemnum1~itemdesc1~1~0.00~N~||>
1
Description
X(10)
Alphanumeric (a-z, A-Z, 0-9) . # , ’ / ( ) - and Space
Required for ACH and appears on bank statements. “cc” for credit card payments and refunds; otherwise, the bank description.
2
Type
X(2)
Alpha (CC, CK, SA)
CC (credit card), CK (checking account), or SA (savings account)
3
Trans Code
9(2)
0-9
00 (debit credit card), 01 (credit card), 27 (debit checking), 37 (debit savings)
4
ABA Expire
9(4/9)
0-9
Expire date CC (MMYY) / ABA Routing No - checking or savings
5
Account No
9(17)
0-9
Account number (credit card, checking, or savings)
6
Account Name
X(30)
Alphanumeric (a-z, A-Z, 0-9) and Space
Name on account (credit card, checking or savings). Note: Do not include commas.
7
Ref ID
X(50)
Alphanumeric (a-z, A-Z, 0-9) . = [ # : _ * / @ ; \ - , ’ / ] - and Space
User’s unique reference ID (subscription ID for subscription transactions; account ID for account transactions).
8
Amount
Currency (8)
Numeric (0-9) and .
Transaction amount with decimal point (no double quotes)
9
Address
X(30)
Alphanumeric (a-z, A-Z, 0-9) . # , ‘ / ( ) - and Space
Street address of account holder AVS (Address Verification System)
10
Zip Code
9(10)
0-9
Zip code of account holder (no dashes) - AVS
11
SECC Code
X(3)
Alpha PPD, CCD, WEB, TEL
NACHA SECC code indicating the type of transaction (e.g., PPD, CCD, WEB, TEL)
12
PO Number
X(16)
Alphanumeric (a-z, A-Z, 0-9)
Purchase order number (required for Card Not Present transactions (MOPO, E-Commerce) and Corporate Business & Purchase Card transactions
13
Tax Amount
Currency (8)
Numeric (0-9) and .
Sales Tax Amount (with decimal point, enclosed within double quotes)
14
Tax Indicator
9(1)
Numeric (0-2)
0 (Non Taxable), 1 (Taxable), or 2 (Tax Exempt)
15
Company Name
X(16)
Alphanumeric (a-z, A-Z, 0-9)
Merchant name will be used if field is omitted. Required for ACH; appears on bank statement
Card Number
9999999999999999 (16 dig.)
Credit card number
Expiration Date
MM/YY
Credit card expiration date
Amount
9999999999.99 (10.2 dig.)
Payment amount
Transaction Type
X(9)
Value=”SALE” for a single payment, “REFUND” for a refund, or “RECURRING” for a recurring payment.
Street Address
X(20)
Account or subscriber’s street address
Zip Code
X(9)
Account or subscriber’s Zip + Zip extension
Customer Code
X(17)
Account ID or Subscription ID
Sales Tax
9999999999 (10 dig.)
Blank
Invoice Number
X(25)
Blank
CVV2 Indicator
9
CVV2Indicator=<9> Value=”1” if CVV2 is present Value=”0” if CVV2 is not present
CVV2 Value
9999
CVV2Value=<9999> CVV2 value, if available; otherwise blank.
Approval Code
X(6)
Blank
User Defined Field 0
newspaper defined
Blank
User Defined Field 1
newspaper defined
Blank
User Defined Field 2
newspaper defined
Blank
User Defined Field 3
newspaper defined
newspaper defined
User Defined Field 4
newspaper defined
newspaper defined
User Defined Field 5
newspaper defined
newspaper defined
User Defined Field 6
newspaper defined
newspaper defined
User Defined Field 7
newspaper defined
newspaper defined
User Defined Field 8
newspaper defined
newspaper defined
User Defined Field 9
newspaper defined
Current date in MMYY format
Transaction Type
1
x (1)
The desired transaction type. Valid values: S or 0 = Sale C or 1 = Credit This is a required field.
Credit Card Account Number
2
x (16)
The credit card account number. This is a required field.
Expiration Date
3
4 (MMYY)
The credit card’s expiration date in MMYY format. This is a required field. Example: 1009
Transaction Amount
4
9 (10.2)
Amount of payment or refund. This is a required field.
Invoice Number
5
x (20)
Batch ID and subscriber or account ID. This is a required field.
Billing Address
6
x (50)
This is the cardholder’s street address. First line of street address (up to 50 characters). This is a required field.
Billing Zip
7
x (5)
This is the cardholder’s Zip code. This is a required field.
Customer ID
8
x (20)
This is an optional field.
Customer Email
9
x (50)
This is an optional field.
E/C Indicator
10
x (2)
EC, MO This is an optional field.
Discretionary Transaction Fields 1 – 6
Nov-16
x (30)
These are optional fields.
Comment
17
x (50)
This is an optional field.
First Name
18
x (50)
Subscriber’s full name, such as “John Q Smith Jr”.
Last Name
19
x (50)
The cardholder’s last name. This is an optional field.
Billing Address Line 2
20
x (50)
Second line of the cardholder’s street address. This is an optional field.
Billing City
21
x (30)
This is the cardholder’s city. This is an optional field.
Billing State
22
x (2)
This is the cardholder’s state. This is an optional field.
Shipping Address
23
x (50)
This is the cardholder’s shipping street address. This is an optional field.
Shipping Address Line 2
24
x (50)
Second line of the cardholder’s shipping street address. This is an optional field.
Shipping City
25
x (30)
This is the cardholder’s shipping city. This is an optional field.
Shipping State
26
x (2)
This is the cardholder’s shipping state. This is an optional field.
Shipping Zip
27
9 (5)
This is the cardholder’s shipping Zip code. This is an optional field.
Tax
28
9 (10.2)
Must be within the following range.1-22% X the sale amount of the transaction, per Visa rules. A value of 0.00 will cause any corporate cards that come through to downgrade, causing the merchant to pay a higher processing fee. This is an optional field.
Customer Code/PO#
29
x (17)
The cardholder’s customer code for a commercial card transaction. This is an optional field.
Credit Card Account Number
“444444444”
Expire Date (mmyy)
“0802”
Merchant ID (from Business Rules)
“975463102”
Transaction Amount (including tip and cash payment adjustments)
“36.00”
Transaction Status
“Pending Authorization” for payments; “Credit” for refunds.
Cardholder ID (account house number and ZIP)
“377 55107”
Cardholder ID Code (N)
“N”
Transaction Date (mm/dd/yy)
“08/02/98”
Mail Order Transaction ID (1)
“1”
Purchase ID (batch name, record number of payment in batch, and subscriber ID)
“080202 17 123002”
Purchase ID Code (0)
“0”
Total Amount (same as Transaction Amount)
“36.00”
User Comments (CIRC)
“CIRC”
Record type
3
01-Mar
“CRQ”
Originator Reference Number
7
04-Oct
Account ID or Subscription ID
Unit Separator
1
11
“/”
Accounting System Code
1
12
“0”
Transaction Type
2
13-14
“05”
Merchant ID
10
15-24
The merchant ID defined in Business Rules
Unit Separator
1
25
“/”
Condition Code
1
26
“0”
App Code
1
27
“2”
Card Issue Code
2
28-29
“AX”
Account Information
15
30-44
The account’s or subscriber’s credit card number
Unit Separator
1
45
“/”
Expire Date
4
46-49
The credit card expiration date, format “mmyy”
Unit Separator
1
50
“/”
Authorization Amount
8
51-58
Account payment including tip, or subscriber payment including tip and cash payment adjustment. Last two positions are for ¢
Currency Code
3
59-61
“USD”
1
1
T (beginning of transmitter record)
4
02-May
Payment year
1
6
Blank (you would change this to “P” if reporting for the previous year)
9
Jul-15
Transmitter’s TIN or SSN (Federal ID number prompted for on 1099 screen)
5
16-20
Transmitter code (as prompted for on 1099 screen)
7
21-27
Blank
1
28
Test indicator (“T” if FILE TYPE = “test”, blank if “production”)
1
29
Foreign entity indicator—enter “1” if transmitter is a foreign entity, otherwise blank
40
30-69
Transmitter name (company name)
40
70-109
Transmitter name, continued (additional information)
40
110-149
Company name
40
150-189
Company name, continued (additional information)
40
190-229
Mailing address (company address)
40
230-269
City (city in company address)
2
270-271
State (state in company address)
9
272-280
ZIP Code (ZIP Code in company address)
15
281-295
Blank
8
296-303
Total number of payees (total number of “B” records in file)
40
304-343
Contact name (as prompted for on 1099 screen)
15
344-358
Contact phone number (as prompted for on 1099 screen)
50
359-408
Contact e-mail address (as prompted for on 1099 screen)
2
409-410
LS (magnetic tape file indicator)
6
411-416
Transmitter’s Media Number
83
417-499
Blank
8
500-507
Record sequence number (order of record in file)
10
508-517
Blank
1
518
Vendor indicator. “V” if your software was purchased from a vendor or other source; “I” if your software was produced by in-house programmers.
40
519-558
Vendor Name (“Newscycle SOLUTIONS”)
40
559-598
Vendor Address (Newscycle’s address)
40
599-638
Vendor City (“BLOOMINGTON”)
2
639-640
Vendor State (“MN”)
9
641-649
Vendor ZIP Code (“55425”)
40
650-689
Vendor Contact (Newscycle’s CEO)
15
690-704
Vendor Contact Phone (“6516390121”)
35
705-739
Vendor e-mail (“SUPPORT@NewscycleSOLUTIONS.COM”)
9
740-748
Blank
2
749-750
Blank or carriage return/line feed
1
1
A (beginning of header record)
4
02-May
Payment year
6
06-Nov
blanks
9
Dec-20
Transmitter’s TIN or SSN (Federal ID number prompted for on 1099 screen)
4
21-24
Blank (if applicable, change to payer name control from mail label of 1099 package)
1
25
Blank (last filing indicator)
1
26
Blank (if combined federal/state filer, change to “1”)
1
27
A (type of return—1099 misc.)
14
28-41
7 followed by 11 blanks (amount code)
6
42-47
Blank
1
48
1 (original file indicator—if not original change to blank)
1
49
Blank (replacement file indicator—if replacement file change to 1)
1
50
Blank (correction file indicator—if correction file change to 1)
1
51
Blank
1
52
Foreign entity indicator (blank unless your country is not US)
40
53-92
Payer’s name (company name)
40
93-132
Second payer name (company name, continued)
1
133
0 (transfer agent indicator)
40
134-173
Payer shipping address (company address)
40
174-213
Payer city (from company address)
2
214-215
Payer state (from company address)
9
216-224
Payer ZIP Code (from company address)
15
225-239
Payer phone (company area code and phone)
260
240-499
Blank
8
500-507
Record sequence number (order of record in file)
241
508-748
Blank
2
749-750
Blank or carriage return or line feed
1
1
B (beginning of account records)
4
02-May
Record year
1
6
Blank (change to “G” if one transaction correction or first correction of two; change to “C” if second of two transaction corrections)
4
07-Oct
Name control (first four letters of account’s last name)
1
11
2 (Type of taxpayer ID—SSN)
9
Dec-20
Social security number
20
21-40
Payer’s account number (account’s vendor ID)
4
41-44
Blank (office code of payer)
10
45-54
Blank
72
55-126
Payment amounts 1-6 (all zeros)
12
127-138
Payment amount 7 (box 7)
12
139-150
Payment amount 8 (all zeros)
12
151-162
Payment amount 9 (box 9)
60
163-222
Payment amounts A, B, C, D, and E (all zeros)
12
223-246
Payment totals F and G (all zeros)
1
247
Foreign country indicator
40
248-287
Payee name (account’s name)
40
288-327
Second payee name (account’s name, continued)
40
328-367
Blank
40
368-407
Payee mailing address (account’s address)
40
408-447
Blank
40
448-487
Payee city (city from account’s address)
2
488-489
Payee state (from account’s address)
9
490-498
Payee ZIP (from account’s address
1
499
Blank
8
500-507
Record sequence number (order of record in file)
36
508-543
Blank
1
544
Blank (second tax identification notice)
2
545-456
Blank
1
547
Direct sales indicator (“1” if over 5,000 in sales, otherwise blank)
115
548-662
Blank
60
663-722
Blank (special data entries)
12
723-734
State income tax withheld (all zeros)
12
735-746
Local income tax withheld (all zeros)
2
747-748
Blank (combined federal/state code)
2
749-750
Blank, or carriage return or line feed
1
1
C (beginning of trailer record)
8
02-Sep
Number of account records
6
Oct-15
Blank
108
16-123
Control totals 1-6 (all zeros)
18
124-141
Control total 7 (total box 7)
18
142-159
Control total 8 (all zeros)
18
160-177
Control total 9 (all zeros)
90
178-267
Control totals A, B, and C (all zeros)
35
268-303
Control totals F and G (all zeros)
195
304-499
Blank
8
500-507
Record sequence number (order of record in file)
241
508-748
Blank
2
749-750
Blank, or carriage return or line feed
1
1
F (beginning of batch trailer)
8
02-Sep
Number of “A” records
21
Oct-30
All zeros
19
31-49
Blank
8
50-57
Total Number Payees (number of account records)
442
58-499
Blank
8
500-507
Record sequence number (order of record in file)
241
508-748
Blank
2
749-750
Blank, or carriage return or line feed
TRANSACTION_TYPE
x(3)
Yes
Transaction type
BUSINESS_UNIT
x(5)
Yes
Newspaper business unit
XX_CIRC_TYPE
x(1)
Yes
Circulation type
XX_CIRC_ID1
x(15)
Yes
Circulation ID 1
XX_CIRC_ID2
x(10)
Yes
Circulation ID 2
WTHD_BASIS_AMOUNT
9(00.0)
Yes
Withholding basis amount
WTHD_CLASS
x(5)
Yes
1099 withholding class
DIRECT_SALES
x(1)
Yes
Direct sales of 5k or more
DESCR100
x(100)
No
Description
TRANSACTION_TYPE
x(3)
Yes
Transaction type
BUSINESS_UNIT
x(5)
Yes
Newspaper business unit
REC_COUNT_SUM
9(5)
Yes
Total record count
PYMNT_TOTAL
9(00.000)
Yes
Total payment amount
2 | Lockbox company (from Business Rules) |
8 | Invoice amount (last two digits are decimals) |
13 | Invoice number |
1 | Check digit (based on positions 1-23) |
13 | Invoice Number |
1 | Check digit (based on positions 25-37) |
8 | Invoice Amount |
1 | Check digit (based on positions 1-46) |
Publication | X(8) | Publication ID |
Edition | X(8) | Edition ID |
Publish Date | date | Publish date, MMDDYYYY |
Day of Week | X(3) | Day of the week (e.g., “Sun”, “Mon”) |
AAM Zone | X(10) | AAM zone |
AAM Column | X(10) | AAM reporting column |
Distribution Method | X(8) | Distribution method |
AAM Price Level | X(8) | AAM price level |
Draw Total | 9(7) | Gross draw total |
Authorized Return Total | 9(7) | Authorized return total |
Unauthorized Return Total | 9(7) | Unauthorized return total |
Draw Adjustment Total | 9(7) | Draw adjustment total |
Route | X(8) | Route ID |
Zip code | X(10) | Zip code ID |
Member # | 1 | Number | 6 | AAM Member # from the Business Rules. |
Pub Code | 2 | Character | 10 | Publication code for main and branded editions (from Publication Edition setup). |
Para3date | 3 | Date |
6 | Date of Para 3 Circulation, MMDDYY |
Zip code | 4 | Number | 5 | Zip code (99999, if a miscellaneous record) |
HD_Print | 5 | Number | 8 | Home delivery and mail print circulation |
SC_ Print | 6 | Number | 8 | Single copy print circulation |
BT_Print | 7 | Number | 8 | Business traveler print circulation (AAM column with a Paid/Verified Type of “Business/Traveler”) |
Verified_Print | 8 | Number | 8 | Verified print circulation |
Paid_DigRep | 9 | Number | 8 | All paid digital replica circulation |
Verified_DigRep | 10 | Number | 8 | Verified digital replica circulation |
Paid_DigNRep | 11 | Number | 8 | All paid, digital non-replica circulation |
Verified_DigNRep | 12 | Number | 8 | Verified digital non-replica circulation |
State Name | 13 | Text | 25 | State Name. Only for miscellaneous data rows. |
Publication | X(8) | Publication ID |
Route | X(8) | Route ID |
Subscription | 9(10) | Subscription ID |
Name/Address Line 1 | X(30) | Name and address, line 1 |
Name/Address Line 2 | X(30) | Name and address, line 2 |
Name/Address Line 3 | X(30) | Name and address, line 3 |
Name/Address Line 4 | X(30) | Name and address, line 4 |
Name/Address Line 5 | X(30) | Name and address, line 5 |
Name/Address Line 6 | X(30) | Name and address, line 6 |
City | X(28) | City ID |
State | X(3) | State ID |
Zip Code | X(10) | Zip code ID |
Phone Number | X(14) | Subscriber’s phone number |
Status | X(32) | “Active” or “Inactive” |
Delivery Schedule | X(8) | Delivery schedule ID |
Copies | 9(3) | Number of copies delivered |
Start Date | date | Start date of the subscription, MMDDYYYY |
Expiration Date | date | Expiration date of the subscription, MMDDYYYY |
Payment Length and Term | X(13) | Payment length and term of the last payment |
Payment Amount | 9(6.2) | Last payment amount |
Last Payment Date | date | Last payment date, MMDDYYYY |
Rate Code | X(20) | Subscription rate code ID |
AAM Column | X(10) | Subscription’s AAM column, if the subscriber has an AAM column that overrides the default. If the subscriber doesn’t have an override AAM column, this field is blank. |
Note: The Admail interface requires a separate license fee to use. Contact the Naviga Support Center for details.
File Type: Fixed length.
Location: /dti/exchange/cm
. The file name is defined as part of the setup of the Admail format in TM.
File location: /dti/exchange/cm
. The file name will be autorenewsMMDDYY-xxx, where “MMDDYY” represents the month, date and year of the export, respectively, and “xxx” represents an incrementing sequence number that distinguishes files exported on the same day.
In addition, many fields in the Detailed Export 2 format will be blank, and a few will have different data in them:
In the Subscription Data segment, the Lockbox Scan Line field will always be blank.
In the Subscription Data segment, the Last Renewal Date will be the date of the last auto renew transaction.
Only one rate will be populated in the Rate Data segment, and likewise only one set of taxes will be populated in the Tax Data segment.
In the Messages Continued segment (M2), the Renewal Period Messages and General Message will be blank.
Field | L | Description |
---|---|---|
Fields | Description |
---|
Record | Length | Field |
---|
File Type: Pipe delimited. The format will be the same as for the except that two additional segments are added after the P1 segment. The A1 segment contains auto-renew information, and A2 segments contain auto renew adjustments. The fields contained in this segment are given below.
Auto Renew data |
---|
Ext-Number
5
House number
Ext-Fract
1
House number modifier
Ext-Apt
6
Unit number
Ext-Direct
2
Predirectional
Ext-Street-Name
22
Street name
Ext-Street-Type
4
Street type
Ext-City
4
City
Ext-ZIP
9
ZIP code, plus ZIP extension (no dash)
Ext-Pub
2
Publication
Ext-Postal-Route-Info
10
Postal carrier route type and number
Publication | The publication for which you are exporting rounded draw info. |
Rounding Entity | The truck or route group for which rounded draw and advance draw are being listed. |
Run Date | The publishing date that you are exporting information for, in mmddyyyy format (month, day, year). |
Section | The advance section for which this rounded draw pertains. |
Insert Mix Combination | The insert mix for which this rounded draw pertains. |
Rounded Draw | The rounded draw for this truck or route group, within the section/insert combination listed above. |
Advance Draw | The advance draw for this truck or route group (prior to rounding), within the section/insert combination listed above. |
Rounding Model | The ID of the rounding model used to round the advance draw. |
Header | 1 | H (Header data begins) |
| 6 | ACS participant (newspaper) ID |
| 10 | File creation date (yyyy/mm/dd) |
| 9 | Total number of subscribers contained in file |
| 9 | Total number of COAs |
| 9 | Total number of nixies |
| 8 | Shipment number on invoice |
| 1 | File class (1 = 1st class, 2 = Periodicals, 3 = Standard A, 4 = Standard B) |
| 1 | Media type sent (typically, this will be “9”) |
| 375 | Filler |
|
|
|
COA record | 1 | 2 (COA or nixie data begins) |
| 8 | Record sequence number |
| 7 | Participant code |
| 16 | Key line (subscription ID + check digit) |
| 8 | Date of move (yyyymmdd) |
| 1 | Move type (F = Family, I = Individual, B = Business) |
| 1 | Deliverability code (space = newaddress elements, K = no forward address, G = PO Box closed, C = No delivery at this address, W = Temporary address change) |
| 3 | USPS site ID |
| 47 | COA name |
| 1 | Old address type |
| 28 | Old urbanization name |
| 60 | Old address |
| 35 | Old city-state-ZIP |
| 1 | New address type |
| 1 | New urbanization name |
| 60 | New address |
| 35 | New city-state-ZIP |
| 66 | Formatted mail label |
| 2 | Filler |
| 4 | Postage due |
| 8 | Filler |
| 1 | Notification type (A = Future, B = 1st Class, C = Periodicals, D = Std A, E = Std B, F = Periodical Follow-Up notification) |
|
|
|
Nixie record | 1 | 2 (COA or nixie data begins) |
| 8 | Record sequence number |
| 7 | Participant code |
| 16 | Key line (subscription ID + check digit) |
| 7 | Filler |
| 1 | Deliverability code (A = Attempted, no known, B = Returned for better address, D = Outside delivery limits, E = In dispute, I = Insufficient address, L = Illegible, N = No such number, Q = Not deliverable as address, R = Refused, S = No such street, U = Unclaimed, V = Vacant, X = No such office) |
| 3 | USPS site ID |
| 166 | filler |
| 5 | Old ZIP |
| 213 | filler |
| A1 (Auto renew data begins) |
| Tip Amount |
| Credit Card Number (if credit card auto renew) |
| Credit Card Authorization Number (if credit card auto renew) |
| Credit Card Expiration Date (if credit card auto renew) |
| Bank Number (if bank draft auto renew) |
| Client Type (if bank draft auto renew) |
| Account Type (if bank draft auto renew) |
| Account Number (if bank draft auto renew) |
|
|
(For each A1 record, one or more A2 records can be created for each auto renew adjustment.) |
|
| A2 (Auto renew data begins) |
| Auto renew adjustment code ID |
| Adjustment code description |
Auto renew adjustment amount |
File Type: Pipe delimited
File location: /dti/exchange/cm
. The file name is specified at runtime.
The Auto Notice Export can use the “Detailed Export 2” format (described with Renewal Notices) or the “DTI Standard” format, depending on Business Rules. The DTI Standard format is described below.
File Type: Pipe delimited
File location: /dti/exchange/cm
. The file name will be noticeMMDDYY-xxx
, where “MMDDYY” represents the month, date and year of the export, respectively, and “xxx” represents an incrementing sequence number that distinguishes files exported on the same day. The file contain the following items, delimited by the pipe symbol (|):
Bank draft formats can be used for subscriber payments, subscriber refunds, account direct deposits, and account withdrawals. The formats described in this section will be the same regardless of how they’re used. Several bank draft formats are supported; they are listed in the following table.
The ACH (Automated Clearing House) bank draft format is used by most U.S. banks. The ACH format will be used if the electronic file format in the Bank record is set to “ACH”.
The ACH file is fixed-length and will be located in /dti/exchange/cm/secure. It can be used for:
Subscriber payments—The file will have the same name as the batch, with the following exception. When the Business Rule Should customer service payments create separate payment batches by publication? is answered “Yes,” and the Business Rule For one-time bank draft payments, should a new batch be created daily? is answered “No,” the file name for Customer Service batches will have the first character of the batch id replaced with the first character of the company short name (when not blank) or the first character of the company ID from Company setup. For example, if the batch name is “CS13072201” and the company short name is “Times,” the file name would be “TS13072201.”
Subscriber refunds—The file will have the same name as the batch.
Account direct deposits—The file will be named depositMMDDYY-xxx.d
.
Note: ACH bank draft files will always have a number of records that is divisible by 10. When necessary, filler records will be added to the end of the file in order to round up to the nearest 10. For example, if a file has 32 records, 8 filler records will be added, to make a total of 40 records in the file.
The RBC (Royal Bank of Canada) bank draft format is used by many banks in Canada. The RBC format will be used if the electronic file format in the Bank record is set to “RBC”.
The RBC file is fixed-length and will be located in /dti/exchange/cm/secure. It can be used for:
Subscriber payments—The file will have the same name as the batch.
Subscriber refunds—The file will have the same name as the batch.
Account direct deposits—The file will be named depositMMDDYY-xxx.d
.
The HSBC file is fixed-length and will be located in /dti/exchange/cm/secure. It can be used for:
Subscriber auto payments
Account bank draft payments
Account direct deposits
The CIBC (Canadian Imperial Bank of Commerce) bank draft format is used in Canada. The CIBC format will be used if the electronic file format in the Bank record is set to “CIBC”.
The CIBC file is fixed-length and will be located in /dti/exchange/cm/secure
. It can be used for:
Subscriber payments—The file will have the same name as the batch.
Subscriber refunds—The file will have the same name as the batch.
Account direct deposits—The file will be named depositMMDDYY-xxx.d
.
Account withdrawals—The file will be named paymentMMDDYY-xxx
.
The BACS (Bankers Automated Clearing Services) bank draft format is used by many banks in the United Kingdom. The BACS format will be used if the electronic file format in the Bank record is set to “BACS”.
The BACS file is fixed-length and will be located in /dti/exchange/cm/secure
. It can be used for:
Subscriber payments—The file will have the same name as the batch.
Subscriber refunds—The file will have the same name as the batch.
Account direct deposits—The file will be named depositMMDDYY-xxx.d
.
Account withdrawals—The file will be named paymentMMDDYY-xxx
.
The EdgCapture bank draft format is a fixed-length format and will be located in /dti/exchange/cm/secure
. Business Rules determine if bank draft payments are included in the EdgCapture credit card export.
The EdgCapture file will be named “edgcapture[type][productID].[date][sequence#]
”, where:
[type] will be “ar” for auto renew payments, “ot” for one-time payments, or “ref” for refunds.
[date] will be the batch date in DDMMYYYY format.
[sequence#] will be the number of times the EdgCapture export has been run on that day.
The EdgCapture format is used for account and subscriber credit card payments, subscriber refunds, and subscriber bank draft payments. It is described on Account Credit Card Payment Formats | EdgCapture.
The Edgil bank draft format is a fixed-length format and will be located in /dti/exchange/cm/secure
. Business Rules determine if bank draft payments are included in the Edgil credit card export.
The Edgil format can be used for subscriber payments and refunds—The file will be named edgilar.[date][sequence#]
for auto-renews, or edgilot.[date][sequence#]
for one-time bank drafts.
[date] is the batch date in DDMMYYYY format, and [sequence#] is the number of times the Edgil export has been run on that date. If more than 9,999 records are being exported, multiple Edgil files will be created, using the same naming convention but with suffixes of 1, 2, 3, and so on.
The Intell-A-Check bank draft format is a fixed-length format and will be located in /dti/exchange/cm/secure
. Business Rules determine if bank draft payments should be exported using Intell-A-Check.
The Intell-A-Check format can be used for subscriber payments and refunds. The file will be named icheck[batchID].txt
.
Field |
---|
Field |
---|
Bank Draft Format |
---|
Record | Length | Content |
---|---|---|
Record | Length | Content |
---|---|---|
Record | Length | Position | Content |
---|---|---|---|
Record | L | Pos | Content |
---|---|---|---|
Field | Format | Value |
---|---|---|
Record | L | Field |
---|---|---|
Field | Format | Value |
---|---|---|
Subscription ID
Subscriber Name (first + last)
Subscriber First Name
Subscriber Last Name
Subscriber Address Line 1
Subscriber Address Line 2
Subscriber Address Line 3
Subscriber Address Line 4
Subscriber Address Line 5
Subscriber City
Subscriber State
Subscriber ZIP
Subscriber ZIP Extension
Subscriber ZIP Bar Code
Bill-to Occupant Name (first + last)
Bill-to Occupant First Name
Bill-to Occupant Last Name
Bill-to Occupant Address Line 1
Bill-to Occupant Address Line 2
Bill-to Occupant Address Line 3
Bill-to Occupant Address Line 4
Bill-to Occupant Address Line 5
Bill-to Occupant City
Bill-to Occupant State
Bill-to Occupant ZIP
Bill-to Occupant ZIP Extension
Bill-to Occupant ZIP Bar Code
Subscriber Area Code
Subscriber Phone Number
Available Refund Amount
Date Exported
Publication Name
Subscription ID
Deliver-To First Name
Deliver-To Last Name
Deliver-To Other Name
Deliver-To Address (1)
Deliver-To Address (2)
Deliver-To City
Deliver-To State
Deliver-To ZIP
Bill-To First Name
Bill-To Last Name
Bill-To Other Name
Bill-To Address (1)
Bill-To Address (2)
Bill-To City
Bill-To State
Bill-To ZIP
Bill-To Route
Auto Renew Subs. Length
Auto Renew Subs. Term
Auto Renew Amount
Credit Card Type
Expire Date
Product
Current Expire Date
File Header
1
“1” (record type code)
2
“01” (priority code)
1
Not used
9
Automated clearing house from BANK (immediate destination)
10
Immediate origin from BANK, or if this is blank, client number from BANK (immediate origin)
6
Run date (YYMMDD format) (file creation date)
4
Run time (HHMM format; military) (file creation time)
1
“A” (file ID modifier)
3
“094” (record size)
2
“10” (blocking factor)
1
“1” (format code)
23
Bank description from Bank setup (immediate destination name)
23
Company short name from Company setup (immediate origin name)
8
Not used (reference code)
Batch Header
1
“5” (record type code)
3
“225” for payments, “220” for refunds and direct deposits (service class code)
15
Company short name from Company setup (company name)
20
Not used (company discretionary data)
10
Client number from Bank setup (company identification)
3
“WEB” for web payments; “PPD” for all other entries (standard entry class code)
10
Short description from data entry screen (company entry description)
6
Run date (YYMMDD format) (company descriptive date)
6
Run date (YYMMDD format) (effective entry date)
3
Not used (settlement date (Julian format))
1
“1” (originator status code)
8
Originating DFI from Bank setup; or, if this is blank, automated clearing house from Bank setup (originating depository financial institution (DFI) identification)
7
“0000001” (batch number)
Detail Record
1
“6” (record type code)
2
(transaction code) • For payments: “27” for checking account, “28” for prenotification, “37” for savings account. • For refunds and account direct deposits: “22” for checking account, “32” for savings account. • For account direct deposit prenotification: “23” for checking account, “33” for savings account.
8
First 8 digits of the subscriber or account bank number (receiving DFI identification)
1
Last digit of subscriber or account bank number (check digit)
17
Subscriber or account bank account number (DFI account number)
10
Payment/refund/direct deposit amount, including tip (no decimal point) (amount)
15
Subscriber or account ID (individual identification number)
22
Subscriber or account name (individual name)
2
“S” followed by a space for web payments; blank for all other entries (discretionary data; payment type code)
1
“0” (addenda record indicator)
15
First 8 characters of the automated clearing house from Bank setup, followed by a unique number (trace number = DFI # + unique #)
Batch Control
1
“8” (record type code)
3
“225” for payments, “220” for refunds or direct deposits (service class code)
6
Total number of detail records (entry/addenda count)
10
Entry hash number
12
Total amount of payments; zeros for a refund or direct deposit batch (total debit entry dollar amount)
12
Total amount of refunds or direct deposits; zeros for a payment batch (total credit entry dollar amount)
10
Client number from Bank setup (company identification)
19
Not used (message authentication code)
6
Not used (reserved)
8
First 8 characters of the automated clearing house from Bank setup (Originating DFI identification)
7
“0000001” (batch number)
File Control
1
“9” (record type code)
6
“000001” (batch count)
6
Total of all lines divided by ten and rounded (block count)
8
Total number of detail records (entry/addenda count)
10
Entry hash number
12
Total amount of payments; zeros for a refund or direct deposit batch (total debit entry dollar amount in file)
12
Total amount of refunds or direct deposits; zeros for a payment batch (total credit entry dollar amount in file)
39
Not used (reserved)
Header
6
“000001” (file header begins)
1
“A” (header record)
3
“HDR” (transaction code)
10
Newspaper bank account number
30
Newspaper company name
4
File creation number
7
File creation date (Julian format)
3
“CAD” (currency type)
1
“1” (input type)
15
Not used
Header Count
6
000002 (header count)
65
Not used
1
“N” (client level optional)
8
Not used
Detail Record
6
Record count (detail record begins)
1
“D” for payments; “C” for direct deposits (payment type)
3
“450” for payments; “200” for direct deposits (transaction code)
10
Newspaper bank account number
1
Not used
19
Subscriber or account ID
1
“1” (payment number)
1
Not used
1
“0” (filler)
8
Bank number of the subscriber or account
18
Bank account number of the subscriber or account
1
Not used
10
Payment or deposit amount, including tip
Detail Count
6
Payment record count
7
Transaction date (Julian format)
30
Name of the subscriber or account (last, first)
1
“E” (language code)
1
Not used
15
Short description
11
Not used
1
“N” (optional records indicator)
8
Not used
Trailer
6
Trailer count (file trailer begins)
1
“Z” (record type)
3
“TRL” (transaction code)
10
Newspaper bank account number
20
Not used (must be zeros)
6
Number of payments or deposits
14
Total amount (no decimal point)
20
Not used (must be zeros)
Trailer Count
6
Trailer record count
74
Not used
Header
1
1
Record type (“A”)
9
02-10
Record sequence / count
10
11-20
EFT Originator ID—a 10-digit unique ID provided by HSBC
4
21-24
File creation number. Identifier of this EFT file. Each file must contain a file creation number that is greater than that of previously transmitted files.
6
25-30
File creation date. Format CYYDDD: C = 0 (no change in turn of century), YY = year, DDD = Julian date (e.g., Dec. 15 is 350).
5
31-35
HSBC institution ID; always “01600”
20
36-55
Blank
3
56-58
Currency code: CAD (Canadian dollar) or USD (US dollar)
1406
59+
Blank
Detail Debit/Credit Record The detail records define information for each transaction in the EFT file.
1
1
Record type (“C” - credit payment or “D” - debit payment)
9
02-10
Record sequence / count. Increment by 1 from same field in header record.
10
11-20
EFT Originator ID. Must be the same as the EFT Originator in the header record.
4
21-24
File creation number. Must be the same as the file creation number in the header record.
Segment 1
3
25-27
CPA transaction code.
10
28-37
Amount of EFT transaction.
1
38
Due date century. 0 (no change in turn of century)
2
39-40
Due date year. 2008 = 08.
3
41-43
Due date day. Julian.
4
44-47
Financial institution bank number, format 0999
5
48-52
Financial institution branch number, format 99999
12
53-64
Participant account number. Must be left-justified; do not zero fill. Significant digits only.
22
65-86
Item trace number; all “0”
3
87-89
Stored trans type; all “0”
15
90-104
Short name. Your company’s name for participant statements. Do not enter zeros in this field.
30
105-134
Transaction payee / payor name. Mandatory.
30
135-164
Long name. Your company’s name for participant statements.
10
165-174
EFT originator ID. Must be the same as the EFT originator ID in the header record.
19
175-193
Transaction origination Xref. Optional.
9
194-202
Transaction return financial institution.
12
203-214
Transaction return account.
15
215-229
Originator’s sundry info. May remain blank.
22
230-251
Stored trace number. Blank.
2
252-253
Settlement code. Blank.
11
254-264
Invalid data element. All “0”.
Detail records may include 6 segments or transactions. Segments 2-6 have the same format at Segment 1 (described above)
265-504
Segment 2
505-744
Segment 3
745-984
Segment 4
985-1224
Segment 5
1225-1464
Segment 6
Trailer Record (must be the last record of the EFT file)
1
1
Record type; “Z”
02-Oct
9
Record sequence / count. Increment by 1 from same field in previous record.
Nov-20
10
EFT Originator ID. Must be the same as the EFT Originator ID in the header record.
21-24
4
File creation number. Must be the same as the file creation number in the header record.
25-38
14
Amount of debit payment transactions (type D). Right-justified with leading zeros.
39-46
8
Total number of debit payment transactions (type D). Right-justified with leading zeros.
47-60
14
Amount of credit payment transactions (type C). Right-justified with leading zeros.
61-68
8
Total number of credit payment transactions (type C). Right-justified with leading zeros.
69-82
14
Number of Err Corr “E”. Should be “0”.
83-90
8
Value of Err Corr “E”. Should be “0”.
91-104
14
Number of Err Corr “F”. Should be “0”.
105-112
8
Value of Err Corr “F”. Should be “0”.
113+
1352
Filler.
File Header
1
1
“1” (file header record begins)
2
02-03
Spaces
5
04-08
Receiving data center (from Bank setup)
5
09-13
Spaces
10
14-23
Originator number (client number from Bank setup)
6
24-29
File creation date (format MMDDYY)
4
30-33
File creation number
1
34
Spaces
4
35-38
Bank number (from Bank setup)
5
39-43
Branch number (from Bank setup)
12
44-55
Bank account number (from Bank setup)
2
56-57
Spaces
15
58-72
Company Name
1
73
Space
3
74-76
Currency indicator (“CAD” = Canadian dollar, “USD” = US dollar)
4
77-80
Spaces
Batch Header
1
1
“5” (batch header record begins)
46
02-47
Spaces
3
48-50
“450” (transaction type)
10
51-60
Descriptive statement (short description entered at run time)
6
61-66
Export date
14
67-80
Spaces
Detail Record
1
1
“6” (detail record begins)
1
2
Credit/debit indicator. “C” direct deposits, “D” for account withdrawals and subscriber bank drafts.
1
3
Space
4
04-07
Bank number of the subscriber or account
5
08-12
Branch number of the subscriber or account
12
13-24
Bank account number of the subscriber or account
5
25-29
Spaces
10
30-39
Payment amount (last two positions are cents)
13
40-52
Cross-reference number (payment sequence number)
22
53-74
Name of the subscriber or account
6
75-80
Spaces
Batch Trailer
1
1
“7” (batch trailer record begins)
3
02-04
“450” (transaction type)
6
05-10
Batch record count
10
11-20
“9999999999” (hash total)
20
21-40
Spaces
12
41-52
Batch payment total (last two positions are cents)
28
53-80
Spaces
File Trailer
1
1
“9” (file trailer record begins)
6
02-07
Batch count
6
08-13
Record count
67
14-80
Spaces
Destination Sort Code
9(6)
Sort code assigned with the subscriber or account payment
Destination Account Number
9(8)
Account number assigned with the subscriber or account payment
Destination Account Type
9(1)
Value=”0”
Transaction Code
9(2)
Value=”01” for initial payment or direct debit Value=”0N” for pre-notifications Value=”99” for refunds or payments to account Value=”19” for final collection Value=”17” for all other payments or direct debits
Originating Sort Code
9(6)
The sort code defined in Bank setup
Originating Account Number
9(8)
The bank account number defined in Bank setup
Free Format
X(4)
Space filled
Amount
9(11)
No decimal point, with leading zeros
Originating Account Name
X(18)
The newspaper’s account name defined in Bank setup (left justified)
Reference
X(18)
Subscription or account ID
Destination Account Name
X(18)
First and last name of the subscriber or account (left justified)
Control Record
1
H (Control record begins)
8
System date in DDMMYYYY format
1
Merchant ID (from Business Rules)
1
Filler (spaces)
2
Sequence number (number of Edgil exports so far on this date)
1
OEP ID (from Business Rules)
1
1 (held transaction option)
65
Filler (spaces)
Detail Record
1
1 (Detail record begins)
4
Transaction sequence (the order of the payment in the file)
2
SA (transaction code—SA = “sale”)
1
OEP ID (from Business Rules)
1
Merchant ID (from Business Rules)
8
System date in DDMMYYYY format
2
Sequence number (from the Control record)
4
Transaction sequence (the order of the payment in the file)
2
Filler (spaces)
24
Subscriber or account bank account number
6
Credit card expiration date (spaces)
7
Payment amount, including cents, format 9999999
8
Authorization code (spaces)
2
Card holder state (spaces)
8
Filler (spaces)
Detail Record 2
1
2 (Detail record 2 begins)
4
Transaction sequence (the order of the payment in the file)
19
Subscriber or account first name plus last name
1
Oct 35 (GS-1)
19
Subscriber or account address, line 1
1
Oct 35 (GS-2)
20
Subscriber or account address, line 2
9
Subscriber or account Zip code plus Zip extension
6
Filler (spaces)
Detail Record 3
1
3 (Detail record 3 begins)
4
Transaction sequence (the order of the payment in the file)
15
Subscriber or account primary phone number, format (999)999-9999, plus 2 spaces
15
Account number of subscription or account
12
Subscriber or account city
10
Account number of subscription or account
4
ID of user who entered payments
5
Subscription or account payment batch ID
4
Payment sequence (the order of the payment in the batch)
10
Filler (spaces)
Detail Record 4
1
4 (Detail record 4 begins)
4
Transaction sequence (the order of the payment in the file)
75
Filler (spaces)
Detail Record 5
1
5 (Detail record 5 begins)
4
Transaction sequence (the order of the payment in the file)
9
Subscriber or account bank number
1
B if auto renew payment, otherwise A
1
A if client type entered with payment is “personal” or blank, B if client type is “business”
64
Filler (spaces)
Trailer Record
1
T (Trailer record begins)
4
Total number of detail records in batch (detail 1 + 2 + 3 + 4 + 5)
9
Total amount of all payments in batch
66
Filler (spaces)
Check Date
MM/DD/YYYY
Payment date
Check Number
9(10)
Check number
ABA
9(9)
Subscriber or account bank number
Account Number
9(20)
Subscriber or account bank account number
Amount
9.99 (17.2)
Amount
Memo
X(40)
Blank
Name1
X(35)
First name
Name2
X(35)
Last name
Street
X(40)
Street name
City
X(25)
City
State
X(2)
State
Zip
X(5)
Zip code
Date Posted
MM/DD/YYYY
Payment date
Requester
X(16)
Requester ID defined within bank setup
MICR Alignment
X(1)
Value=”R”
Check PayTo Name
X(40)
Populated by the setting of the Business Rule, If interfacing bank draft payments to Intell-A-Check, what text should be exported in the ‘Check Pay To Name’ field?
Confirm Letter Request
Y/N
Value=”N”
Transaction Type
X(4)
Blank
Customer ID
X(32)
Subscription or account ID
Reference Code
X(32)
Blank
Fee
9.99 (3.2)
Blank
Record Number (ID)
X(8)
Blank
Bank Name
X(50)
Blank
Bank City
X(30)
Blank
Bank State
X(2)
Blank
User Name
X(16)
User ID from subscription or account payment
Printed
Y/N
Value=”N”
Confirm Letter Printed
Y/N
Value=”N”
Phone
9(10)
Phone number
Status
X(8)
Blank
Group ID
X(2)
Blank
SSN
9(9)
Blank
Drivers License
X(24)
Blank
Drivers License State
X(2)
Blank
DOB
MM/DD/YYYY
Blank
Check Type
X(1)
Value=”P” for personal or “B” for business
Verify Required
Y/N
Value=”N”
Verify Status
Y/N
Value=”N”
Verify Time
MM/DD/YYYY HH:MM:SS
Blank
Verify Response Status
Y/N
Blank
Verify Text
X(32)
Blank
Verify Code
X(16)
Blank
ACH Entry Class
X(3)
“WEB” if payment was made via the web; otherwise Blank
Settled
Y/N
Blank
Date Settled
MM/DD/YYYY
Blank
PrintToPaper
Y/N
Value=”N”
UDK1
X(8)
Blank
UDK2
X(16)
Blank
UDK3
X(32)
Blank
Location ID
X(4)
Blank
Split Number
9(2)
Blank
Split Amount
9.99 (17.2)
Blank
Split Account Number
9(24)
Blank
Saving Account
Y/N
Value=”N” for checking and “Y” for savings
Verification Station ID
X(16)
Blank
MICR
X(40)
Blank
Surcharge
9.99 (3.2)
Blank
Additional Principle
9.99 (7.2)
Blank
Fee Printed
Y/N
Value=”N”
Fee Date Printed
MM/DD/YYYY
Blank
Batch ID
X(8)
Blank
Batch Sequence Number
9(6)
Blank
Batch Lot Number
9(6)
Blank
Credit
Y/N
Value=”N”
Date Printed
MM/DD/YYYY
Blank
Frozen
Y/N
Value=”N”
Note:
The Bellatrix Interface requires a separate license fee to use. Contact the Naviga Support Center for more information.
File type: Fixed length with spaces between each field.
Location: /dti/exchange/cm
. The import file should be named xferout.scs
. The export file will be named xferin.scs
.
Predefined file map: “AdjmntOnly”
File type: Fixed length
Location: /dti/exchange/cm
.
File name: Specified when running the Bonus Day Adjustment utility
Note: Burt requires a separate license fee. Contact the Newscycle Support Center for details.
Targeted Marketing address information can be exported for the Burt Address Manager application. A file map, “BurtMgr”, is used to export address data from Targeted Marketing. This file map has a usage of “TM”.
The entry discount and presort discount are exported to the carrier route (CR) file. Two Business Rules in the Route Services section to allow the entry of this information:
What entry discount code should be exported to Burt?
What presort discount code should be exported to Burt?
Note: Contact Naviga Support for assistance in setting up conversion programs.
The Burt Address Manager format is given in the following table.
File type: Pipe delimited.
Location: /dti/exchange/cm/ccinvddmm
, where d=day and m=month.
Note: Burt requires a separate license fee. Contact the Naviga Support Center for details.
In Targeted Marketing, you can export draw and truck information in a format required by Burt Technologies software. Three fixed-length ASCII files are created: one each for Draw Control, Draw by Ad Route, and Draw by Carrier Route. The files will be exported to the /dti/exchange/cm directory. A fourth fixed-length file for the File Name Index will also be created, or appended if it already exists.
The file formats are described below.
Draw by Ad Route Checksum; file name: ARCTM.MMDDYY
Draw by Ad Route; file name: ARTM.MMDDYY
Draw by carrier route; file name: CRTM.MMDDYY
File name index; file name: FN
Note: Burt requires a separate license fee. Contact the Naviga Support Center for details.
File type: Fixed length. A space is exported for field delimiters, unless the BurtPlus add-on is used, in which case a pipe symbol (|) is exported for field delimiters.
Location: /dti/exchange/cm
. The names for each of the four files are given below. In the file names, [draw type] will be “P” (pending), “AC” (actual) or “AD” (advance), and [extension] will be the product ID and/or draw date (format mmddyy), based on the Business Rule What should the file extension be for Burt export files?. For example, if the Business Rule was answered “Product ID and Draw Date”, the Carrier Route file exported for actual draw on May 9 2012 for the Times would be named CRAC.Times050912.
File name: ARC[draw type].[extension]
.
File name: AR[draw type].[extension].
File name: CR[draw type].[extension]
.
File name: FN. Note that this file is appended each time the Burt Export is run.
This file will be exported when the Burt export is run with the BurtPlus add-on activated. One record will be exported for each route. Its primary purpose is to identify carriers/dealers and the routes they deliver/manage.
File name: CRD[draw type].[extension]
.
This file will be exported when the Burt export is run with the BurtPlus add-on activated, and contains messages for starts, stops, etc. similar to those that print on the bundle tops. For each message, seven records are exported with incrementing message sequences and the following content in the Message field:
Sequence 1. Message type (Start, Stop, Complaint, etc.) and product ID
Sequence 2. Subscriber’s address
Sequence 3. Subscriber’s last name, first name, phone, delivery placement, delivery instructions
Sequence 4. If message is for a stop and related to a move out, “Move Stop”; if related to a delivery schedule change, “Service Change”; otherwise the stop reason code and description. If message is for a start related to a move, “Move Start”; if related to a delivery schedule change, “Service Change”. If message is a delivery placement, new placement instructions. If message is related to a complaint, the complaint code and text. If message is a previous delivery, “Previous [previous delivery day] [previous delivery tran date] Delivery.” If a Message transaction, message text exports here.
Sequence 5. If a Message transaction and text is more than 254 characters, the rest of the message exports here.
Sequence 6. Delivery schedule ID, copies, subscription ID, transaction create date and time.
Sequence 7. Blank.
File name: CM[draw type].[extension]
.
Record | L | Content |
---|---|---|
Record | L | Content |
---|---|---|
Bill Area | Setup Area | Data Element | Data Type |
---|---|---|---|
Length | Content | Example |
---|---|---|
Fields | Length | Description |
---|---|---|
Field | Format | Position | Value | Notes |
---|---|---|---|---|
Burt Column | Circ Value | Type | Length | Comment |
---|---|---|---|---|
Field | Length |
---|
Field | Length |
---|
Field | Sample Output | Max Length |
---|
Field | Format | Description |
---|
Field | Format | Description |
---|
Field | Format | Description |
---|
Field | Format | Description |
---|
Field Name | Field Length and Type | Field Contents |
---|
Field Name | Field Length and Type | Field Contents |
---|
Field Name | Field Length and Type | Field Contents |
---|
Field Name | Field Length and Type | Field Contents |
---|
Field Name | Field Length and Type | Field Contents |
---|
Field Name | Field Length and Type | Field Contents |
---|
Control Header
5
Number of records
5
Total returns
File Detail Record
5
Internal ID #
8
Sales date (yyyymmdd)
1
Not used
1
Edition
3
Zone number
3
Route number (“group”)
1
Rack/dealer (1 for rack, 2 for other routes)
5
Counter/dealer #
14
Outlet number
40
Outlet address
5
ZIP Code
3
Draw
3
Returns
3
Sold
6
Cash
5
Time loaded (hh:mm)
5
First sale (hh:mm)
5
Last sale (hh:mm)
Control Header
5
Number of records
5
Total draw
Detail Record
8
Sales date (yyyymmdd)
1
0 (not used)
1
Edition
1
Rack/dealer (1 for rack, 2 for other routes)
14
Outlet number
3
Draw
1
Update flag
*
*
AccountID
Character
Note: These data elements can be used with any bill area.
BillAreaID
Character
BillSourceID
Character
CompanyID
Character
LineFeed
N/A
LiteralValue
Character
TypeOfBill
Character
*
Draw
DistrictID
Character
Note: These data elements can be used with any bill area used for draw format setup.
ProductID
Character
RouteID
Character
RouteType
Character
Account Information
Bill
AccountClassID
Character
AccountGroupID
Character
AccountNumber
Character
AccountTaxID
Character
AccountType
Character
AreaCode
Character
BankNumber
Character
BillDate
Date
BillingAccountID
Character
BillingDepotID
Character
BillingDistrictID
Character
BillingDropOrder
Character
BillingTruckID
Character
Building
Character
CarriageReturn
N/A
CityID
Character
CollectorID
Character
Complex
Character
CountryID
Character
CountyID
Character
CreditCardOnFile
Logical
CurrentBillAmount
Character
DeliveryPointID
Character
DepotID
Character
DistributionCodeID
Character
DistrictID
Character
DropOrder
Integer
DueDate
Date
EMailAddress
Character
FirstName
Character
HonorificID
Character
HouseNumber
Character
HouseNumberModifier
Character
InvoiceNumber
Integer
LastBillAmount
Decimal
LastBillDate
Date
LastName
Character
MiddleInitial
Character
NameAddressLine1
Character
NameAddressLine2
Character
NameAddressLine3
Character
NameAddressLine4
Character
NameAddressLine5
Character
NameAddressLine6
Character
OccupantSalutationID
Character
OtherName
Character
OtherNameUsage
Character
ParentDropOrder
Integer
ParentTruckID
Character
PastDueBalance
Decimal
Phone
Character
PostDirectional
Character
PreDirectional
Character
ProductID
Character
RCTI
Logical
RemitToAddressLine1
Character
RemitToAddressLine2
Character
RemitToAddressLine3
Character
RemitToAddressLine4
Character
RemitToAddressLine5
Character
RemitToAddressLine6
Character
RemitToAddressLine7
Character
RouteID
Character
RouteName
Character
ScanLine
Character
SecondaryAreaCode
Character
SecondaryPhone
Character
StateID
Character
StreetName
Character
StreetSuffixID
Character
Tax
Character
Terms
Character
TotalDue
Decimal
TruckID
Character
UnitDesignatorID
Character
UnitNumber
Character
ZipBarCode
Character
ZipCode
Character
ZipExtension
Character
AdvanceDrawCharge
Bill
Amount
Decimal
AmountPlusTax
Decimal
BASCategoryID
Character
BillingAccountID
Character
CarriageReturn
N/A
ChargeCodeID
Character
ChargeDate
Date
CityTaxAmount
Decimal
CountryTaxAmount
Decimal
CountyTaxAmount
Decimal
DeliveryScheduleID
Character
Description
Character
DistrictID
Character
DrawClassID
Character
GLAccountID
Character
GLDescription
Character
ProductID
Character
Quantity
Decimal
RateCodeID
Character
RecapFormat
Character
RecapID
Character
Reversal
Logical
RouteID
Character
RouteName
Character
RouteType
Character
StateTaxAmount
Decimal
UnitRate
Decimal
AdvanceDrawCharge
Draw
CoverDate
Date
DeliveryScheduleID
Character
DrawClassID
Character
DrawDate
Date
DrawTotal
Integer
EditionID
Character
RecapFormat
Character
RecapID
Character
RouteName
Character
SubstituteDelivery
Logical
Advance Drop Comp
Bill
Amount
Decimal
AmountPlusTax
Decimal
BASCategoryID
Character
BillingAccountID
Character
CarriageReturn
N/A
ChargeCodeID
Character
ChargeDate
Date
ChargeTypeID
Character
CityTaxAmount
Decimal
CountryTaxAmount
Decimal
CountyTaxAmount
Decimal
Description
Character
GLAccountID
Character
GLDescription
Character
ProductID
Character
Quantity
Decimal
RecapFormat
Character
RecapID
Character
Remarks
Character
RouteID
Character
RouteName
Character
StateTaxAmount
Decimal
UnitRate
Decimal
Advance Misc Charge
Bill
Amount
Decimal
AmountPlusTax
Decimal
BASCategoryID
Character
BillingAccountID
Character
CarriageReturn
N/A
ChargeCodeID
Character
ChargeDate
Date
ChargeTypeID
Character
CityTaxAmount
Decimal
CountryTaxAmount
Decimal
CountyTaxAmount
Decimal
Description
Character
GLAccountID
Character
GLDescription
Character
ProductID
Character
Quantity
Decimal
RateCodeID
Character
RecapFormat
Character
RecapID
Character
Remarks
Character
RouteID
Character
RouteName
Character
StateTaxAmount
Decimal
UnitRate
Decimal
Aging
Bill
AgeCurrent
Decimal
AgePeriod1
Decimal
AgePeriod2
Decimal
AgePeriod3
Decimal
AgePeriod4
Decimal
Balance Forward
Bill
LastBillAmount
Decimal
LastBillDate
Date
Bill Message
Bill
EntityID
Character
EntityType
Character
MessageText
Character
PrintOrder
Integer
Bonus
Bill
BASCategoryID
Character
BillingAccountID
Character
BonusTotal
Decimal
CarriageReturn
N/A
ChargeCodeID
Character
ChargeDate
Date
DeliveryScheduleID
Character
Description
Character
DistrictID
Character
DrawClassID
Character
GLAccountID
Character
GLDescription
Character
ProductID
Character
RecapFormat
Character
RecapID
Character
RouteID
Character
RouteName
Character
RouteType
Character
Bonus
Draw
BillingAccountID
Character
BonusDate
Date
BonusTotal
Decimal
CarriageReturn
N/A
DeliveryScheduleID
Character
DrawClassID
Character
RecapFormat
Character
RecapID
Character
RouteName
Character
Collection Message
Bill
CollectMessage
Character
Debit Memo
Bill
Description
Character
DueDate
Date
OriginalAmount
Decimal
Discount Amount
Bill
DiscountAmount
Decimal
DiscountDate
Date
Draw Charge
Bill
AccountID
Character
Amount
Decimal
AmountPlusTax
Decimal
BASCategoryID
Character
BillAreaID
Character
BillingAccountID
Character
BillingMethod
Character
BillSourceID
Character
CarriageReturn
N/A
ChargeCodeID
Character
ChargeDate
Date
CityTaxAmount
Decimal
CompanyID
Character
CountryTaxAmount
Decimal
CountyTaxAmount
Decimal
DeliveryScheduleID
Character
Description
Character
DistrictID
Character
DrawClassID
Character
GLAccountID
Character
GLDescription
Character
LineFeed
N/A
LiteralValue
Character
ProductID
Character
Quantity
Decimal
RateCodeID
Character
RecapFormat
Character
RecapID
Character
Reversal
Logical
RouteID
Character
RouteName
Character
RouteType
Character
StateTaxAmount
Decimal
SubscriberRateCodeID
Character
TypeOfBill
Character
UnitRate
Decimal
Draw Charge
Draw
BillingAccountID
Character
CarriageReturn
N/A
CoverDate
Date
DeliveryScheduleID
Character
DrawClassID
Character
DrawDate
Date
DrawTotal
Integer
EditionID
Character
RecapFormat
Character
RecapID
Character
RouteName
Character
SubstituteDelivery
Logical
Drop Compensation
Bill
Amount
Decimal
AmountPlusTax
Decimal
BASCategoryID
Character
BillingAccountID
Character
CarriageReturn
N/A
ChargeCodeID
Character
ChargeDate
Date
ChargeTypeID
Character
CityTaxAmount
Decimal
CountryTaxAmount
Decimal
CountyTaxAmount
Decimal
Description
Character
GLAccountID
Character
GLDescription
Character
ProductID
Character
Quantity
Decimal
RecapFormat
Character
RecapID
Character
Remarks
Character
RouteID
Character
RouteName
Character
StateTaxAmount
Decimal
Drop Credit
Bill
Amount
Decimal
AmountPlusTax
Decimal
BASCategoryID
Character
BillingAccountID
Character
CarriageReturn
N/A
ChargeCodeID
Character
ChargeDate
Date
ChargeTypeID
Character
CityTaxAmount
Decimal
CountryTaxAmount
Decimal
CountyTaxAmount
Decimal
Description
Character
GLAccountID
Character
GLDescription
Character
ProductID
Character
Quantity
Decimal
RecapFormat
Character
RecapID
Character
Remarks
Character
RouteID
Character
RouteName
Character
StateTaxAmount
Decimal
TaxableAmount
Decimal
TaxAuthorityID
Character
UnitRate
Decimal
GL Detail
Bill
Amount
Decimal
BillingAccountID
Character
CarriageReturn
N/A
DebitAmount
Decimal
GLAccountID
Character
GLDescription
Character
Levy Balance
Bill
ChargeCodeID
Character
ClosingBalance
Decimal
CurrentActivity
Decimal
Description
Character
OpeningBalance
Decimal
Misc Charge
Bill
Amount
Decimal
AmountPlusTax
Decimal
BASCategoryID
Character
BillingAccountID
Character
CarriageReturn
N/A
ChargeCodeID
Character
ChargeDate
Date
ChargeTypeID
Character
CityTaxAmount
Decimal
CountryTaxAmount
Decimal
CountyTaxAmount
Decimal
Description
Character
GLAccountID
Character
GLDescription
Character
ProductID
Character
Quantity
Decimal
RateCodeID
Character
RecapFormat
Character
RecapID
Character
Remarks
Character
RouteID
Character
RouteName
Character
StateTaxAmount
Decimal
TaxableAmount
Decimal
TaxAuthorityID
Character
UnitRate
Decimal
Misc Charge Reversal
Bill
Amount
Decimal
AmountPlusTax
Decimal
BASCategoryID
Character
BillingAccountID
Character
CarriageReturn
N/A
ChargeCodeID
Character
ChargeDate
Date
ChargeTypeID
Character
CityTaxAmount
Decimal
CountryTaxAmount
Decimal
CountyTaxAmount
Decimal
Description
Character
GLAccountID
Character
GLDescription
Character
ProductID
Character
Quantity
Decimal
RateCodeID
Character
RecapFormat
Character
RecapID
Character
Remarks
Character
RouteID
Character
RouteName
Character
StateTaxAmount
Decimal
UnitRate
Decimal
Net Due
Bill
Amount
Decimal
DueDate
Date
Office Pay Audit
Bill
BillingAccountID
Character
CarriageReturn
N/A
DeliveryScheduleID
Character
ExpireDate
Date
RouteID
Character
RouteName
Character
SubscriberAddress
Character
SubscriberName
Character
SubscriptionID
Integer
TotalCopies
Integer
Payment
Bill
Amount
Decimal
Remarks
Character
TranDate
Date
Recurring Charge Bal
Bill
BillingAccountID
Character
CarriageReturn
N/A
ChargeCodeID
Character
ClosingBalance
Decimal
CurrentActivity
Decimal
Description
Character
Interest
Decimal
OpeningBalance
Decimal
RouteID
Character
RouteName
Character
Returns
Bill
Amount
Decimal
AmountPlusTax
Decimal
BASCategoryID
Character
BillingAccountID
Character
CarriageReturn
N/A
ChargeCodeID
Character
ChargeDate
Date
CityTaxAmount
Decimal
CountryTaxAmount
Decimal
CountyTaxAmount
Decimal
DeliveryScheduleID
Character
Description
Character
DistrictID
Character
DrawClassID
Character
GLAccountID
Character
GLDescription
Character
ProductID
Character
Quantity
Decimal
RateCodeID
Character
RecapFormat
Character
RecapID
Character
Reversal
Logical
RouteID
Character
RouteName
Character
RouteType
Character
StateTaxAmount
Decimal
UnitRate
Decimal
Returns
Draw
AccountID
Character
BarCode
Character
BillAreaID
Character
BillingAccountID
Character
BillSourceID
Character
CarriageReturn
N/A
ClaimDate
Date
ClaimReference
Character
CompanyID
Character
DeliveryScheduleID
Character
DistrictID
Character
DrawClassID
Character
DrawDate
Date
DrawTotal
Decimal
IdentificationNumber
Character
IssueNumber
Character
LineFeed
N/A
LiteralValue
Character
ProductID
Character
RecapFormat
Character
RecapID
Character
RouteID
Character
RouteName
Character
RouteType
Character
SubstituteDelivery
Logical
TypeOfBill
Character
WeekNumber
Character
Year
Character
Total Due
Bill
Amount
Character
DueDate
Date
10
Subscription ID
551322
7
Value of the bonus day adjustment. If run for days, a value will be determined based on the last day in the subscription period. This field will always have a leading minus sign and a decimal point. The value of the bonus day adjustment needs to be an “AdjustmentAmount” data element within the file map “AdjmntOnly.” When entering or modifying the setup of this data element, you will be prompted for a valid sub adjust code in the Code Map field that appears (see below).
-1.2
Route
8
The single copy or home delivery route for which you are interfacing insert mix and bundle size information. You can have a record with a route of “*” to cover all other routes not included in the file.
Product
8
The publication for which you are interfacing insert mix and bundle size information.
Publish Date
8
The publishing date that you are interfacing information for, in mmddyyyy format (month, day, year).
Quantity
5
The draw quantity for this route. This quantity is used only for the mix records, and will not change the route’s actual or advance draw.
Mix Name
8
The name of the insert mix for this route. You can have a record with “*” to cover routes with no insert mix.
Mix Combination
10
The mix combination for this route. This corresponds to a certain combination of inserts being delivered by the route. This must be an integer.
Paper Section
8
The section of the paper where the preprints will be inserted. If you are interfacing sizes for a regular (rather than advanced run), leave this field blank.
Standard Size Minimum Size Maximum Size
3 3 3
In these fields, enter the bundle sizes for the route. Note: routes with the same mix combination should have the same bundle sizes. If the interface finds a route with the same combination but different sizes, it will prompt the user during runtime as to whether the sizes should be kept or updated.
Route
X(8)
01-Aug
Route ID
Ignore
Selling Product
X(8)
Sep-16
Deliverable
Circulation Product
Delivery Product
X(8)
17-24
TM Product — Deliverable to use
Ignore
Publish Date
99/99/9999
25-34
mm/dd/yyyy
Publishing Date
Quantity
9(9)
35-43
Draw Quantity
Ignore
Preprint Schedule ID
9(10)
44-53
Preprint Schedule ID
Ignore
Customer Name
X(32)
54-85
Advertiser Name
Ignore
Version Description
X(30)
86-115
Version Identifier
Ignore
Ad Line
X(20)
116-135
Ad Line for Insert
Ignore
Paper Section
X(8)
136-143
Section of the Paper
Section, or leave blank for the live run
Carrier Bonus Charge Code
X(8)
144-151
Charge Code for Bonus
Ignore
Bonus Amount
9(7.6)
152-165
Bonus Amount
Ignore
Preprint Type
X(8)
166-173
Preprint Type
Ignore
Weight
9(2.4)
174-180
Weight
Ignore
Package Name
X(8)
181-188
Mix Name
InsertPlus Mix Name
Package Sequence
9(10)
189-198
Mix Combination
InsertPlus Mix Combination
Standard Size
9(4)
199-202
Standard Bundle Size
Circulation only supports bundle sizes of 3 characters, so only the last 3 digits of each field are imported.
Minimum Size
9(4)
203-206
Minimum Bundle Size
Circulation only supports bundle sizes of 3 characters, so only the last 3 digits of each field are imported.
Maximum Size
9(4)
207-210
Maximum Bundle Size
Circulation only supports bundle sizes of 3 characters, so only the last 3 digits of each field are imported.
AX_ID
Address ID
Float (decimal)
ADDR_KEY
Blank
Char
15
ADDRESS_TYPE
Dwelling types mapped to H, A or B in the conversion program.
Char
1
H=Home A=Apt B=Business
CARR_RTE
Address PO Route
Char
4
Postal Carrier Route
WALK_SEQUENCE
PO Route Sequence
Integer
ZIP_CODE
Address Zip
Char
5
ZIP_PLUS4
Zip Extension
Char
4
DPC
Blank
Char
2
STREET_NUMBER
Address House Number
Char
10
APARTMENT_NUMBER
Address Unit Number
Char
10
Unit type is not exported
BUILDING_NUMBER
Address Building
Char
10
STREET_NAME
Address Predirectional + Street Name+ Street Type+ Postdirectional
Char
50
CITY
Address City
Char
50
STATE
Address State
Char
2
LONGITUDE
Address Longitude
Char
11
LATITUDE
Address Latitude
Char
11
CENSUS_BLK
Blank
Char
20
TAP_HD_SUN
Carrier Route ID
Char
10
Burt Ad Route, Sunday
TAP_HD_DLY
Blank
Char
10
Burt Ad Route, Daily
SUB_HD_SUN
Y or N, based on whether occupant’s delivery schedule includes Sunday. This is determined by a conversion program.
Char
1
Y if Sunday subscriber; else N
SUB_HD_DLY
Same as field above, but for daily delivery. This is determined by a conversion program.
Char
1
Y if Daily subscriber; else N
TMC_TYPE
Blank
Char
1
Blank, optional
TMC_PROD
First character of TM product ID
Char
1
Blank, optional
TMC_EDITN
Blank
Char
4
Blank, optional
TMC_ZONE
5-digit Zip
Char
10
Primary Order Entry - Selection (Zip + directional)
SUB_ZIP
Blank
Char
1
Blank, optional
TMC_TG
Blank
Char
2
Blank, optional
TMC_ENTRY
Blank
Char
1
Blank, optional
SI_PRIZM
Blank
Char
2
Prizm demographic code
SI_1
Demographic answer (must modify to select demographic)
Char
2
User-defined selective
SI_2
Blank
Char
2
User-defined selective
Note: SI_2 - SI_15 can be changed to add additional demographics.
SI_3
Blank
Char
2
User-defined selective
SI_4
Blank
Char
2
User-defined selective
SI_5
Blank
Char
2
User-defined selective
SI_6
Blank
Char
2
User-defined selective
SI_7
Blank
Char
2
User-defined selective
SI_8
Blank
Char
2
User-defined selective
SI_9
Blank
Char
2
User-defined selective
SI_10
Blank
Char
2
User-defined selective
SI_11
Blank
Char
2
User-defined selective
SI_12
Blank
Char
2
User-defined selective
SI_13
Blank
Char
2
User-defined selective
SI_14
Blank
Char
2
User-defined selective
SI_15
Blank
Char
2
User-defined selective
Version
0 (zero)
Small int
Use to group address lists by effective date. Set to 0.
Account ID | 8 |
Credit Card Number | 20 |
Amount (decimal before last 2 positions) | 12 |
Original Payment Date (format mmddyy) | 6 |
Account ID | 10 |
Credit Card Number | 20 |
Amount (decimal before last 2 positions) | 12 |
Original Payment Date (format mmddyy) | 6 |
Billing Period Start Date | 06/01/97| | 8 |
Billing Period End Date | 06/30/97| | 8 |
Run Date | 06/20/97| | 8 |
Address Line 1 | LAURA RIDING| | 30 |
Address Line 2 | 650 BELL CREEK RD| | 30 |
Address Line 3 | OURTOWN WV 25043-9411| | 30 |
Address Line 4 | | | 30 |
Address Line 5 | | | 30 |
Address Line 6 | | | 30 |
Occupant First Name | LAURA| | 12 |
Occupant Last Name | RIDING| | 30 |
House Number | 650| | 10 |
House Number Modifier | | | 3 |
Pre Directional | | | 2 |
Street Name | BELL CREEK| | 28 |
Street Type | RD| | 7 |
Post Directional | | | 2 |
Unit Type | | | 6 |
Unit Number | | | 8 |
City | OURTOWN| | 28 |
State | WV| | 2 |
ZIP | 25043| | 10 |
ZIP Extension | 9411| | 4 |
Occupant Area Code | 434| | 5 |
Occupant Phone Number | 541-6913| | 8 |
Route Delivering Subscription | T0415| | 8 |
Subscription ID | 34101| | 10 |
Billing Start Date | 06/01/99| | 8 |
Billing End Date | 06/30/99| | 8 |
Rate | CC7D| | 20 |
Amount to Collect | 15.5| | 14 |
Days at Rate | 30| | 10 |
City Tax Authority | | | 9 |
City Tax Amount | 0| | 10 |
County Tax Authority | | | 9 |
County Tax Amount | 0| | 10 |
State Tax Authority | WVTAX| | 9 |
State Tax Amount | .35| | 10 |
Country Tax Authority | | | 9 |
Country Tax Amount | 0| | 10 |
Current Subscription Start Date | 05/01/96| | 8 |
Source Code | CS| | 8 |
Subsource | | | 8 |
Reason Code | PROMO| | 8 |
Original Start Date | 05/01/96| | 8 |
Delivery Schedule | 7D| | 8 |
Last Rate Change Date | ?| | 8 |
ProductID | STAR| | 8 |
Area | METRO| | 8 |
Region | NORTH| | 8 |
Zone | BELL| | 8 |
District | 11| | 8 |
Route | T0415| | 8 |
Route Walk Sequence | 0| | 7 |
Carrier | 3184| | 8 |
Carrier Address Line 1 | THOMAS STANHOPE| | 30 |
Carrier Address Line 2 | PO BOX 656| | 30 |
Carrier Address Line 3 | OURTOWN WV 25041| | 30 |
Carrier Address Line 4 | | | 30 |
Carrier Address Line 5 | | | 30 |
Carrier Address Line 6 | | | 30 |
Routing Schedule | X(6) | The Burt routing schedule defined in Format Set |
Field Delimiter | X(1) | space |
Publication Date | 99/99/99 | Delivery date selected in processing; formatted as MM/DD/YY |
Field Delimiter | X(1) | space |
Route Count | 999999 | Number of routes exported |
Field Delimiter | X(1) | space |
Draw Total | 999999999 (9 dig.) | Total draw exported |
Ad Route | X(10) | Route ID |
Field Delimiter | X(1) | space |
Reserved | X(4) | spaces |
Field Delimiter | X(1) | space |
Draw Quantity | 999999999 (9 dig.) | Draw for the route |
Field Delimiter | X(1) | space |
Class of Sale | X(2) | “HD” for Home Delivery; “SC” for Single Copy |
Field Delimiter | X(1) | space |
Product Type | X(2) | Product type defined in Format Set |
Field Delimiter | X(1) | space |
Ad Zone | X(8) | Ad Zone, Truck ID, or Zip Code assigned to the route (Ad Zone Type defined for the Burt Format Set). The Ad Zone option is available only if InsertPlus is being used. |
Field Delimiter | X(1) | space |
Editorial Zone | X(10) | Edition assigned to the route for the delivery date selected in processing |
Field Delimiter | X(1) | space |
Packages per bundle | 9999 | zeros |
Field Delimiter | X(1) | space |
Route Classification | X(6) | spaces |
Field Delimiter | X(1) | space |
Trip | X(10) | Truck ID |
Field Delimiter | X(1) | space |
Packet Number | 9999 | zeros |
Field Delimiter | X(1) | space |
First Key | 9999 | zeros |
Field Delimiter | X(1) | space |
Second Key | 9999 | zeros |
Field Delimiter | X(1) | space |
Bundle Order | X(4) | spaces |
Delivery Schedule | X(6) | The Burt routing schedule defined in Format Set |
Field Delimiter | X(1) | space |
Publication Date | 99/99/99 | Delivery date selected in processing; formatted as MM/DD/YY |
Field Delimiter | X(1) | space |
Reserved | X(5) | spaces |
Field Delimiter | X(1) | space |
Carrier Route | X(15) | Route ID |
Field Delimiter | X(1) | space |
Ad Route | X(10) | Route ID |
Field Delimiter | X(1) | space |
Reserved | X(4) | spaces |
Field Delimiter | X(1) | space |
Draw Quantity | 999999 | Draw quantity for the route |
Field Delimiter | X(1) | space |
Route Sequence | 9999 | zeros |
Field Delimiter | X(1) | space |
Drop | X(10) | Truck ID + TruckDropSequence.DropOrder |
Field Delimiter | X(1) | space |
Drop Sequence | 9999 | Drop order |
Field Delimiter | X(1) | space |
Trip/Load | X(10) | Truck ID |
Field Delimiter | X(1) | space |
Trip/Load Sequence | 9999 | zeros |
Field Delimiter | X(1) | space |
Truck | X(6) | Truck |
Field Delimiter | X(1) | space |
Sequence Offset | HH:MM | 00:00 |
Reserved | X(10) | space |
Field Delimiter | X(1) | space |
Reserved | X(6) | space |
Field Delimiter | X(1) | space |
Zip Code | 99999 | Primary Zip for the route |
Field Delimiter | X(1) | space |
Class of Sale | X(2) | “HD” for Home Delivery; “SC” for Single Copy |
Field Delimiter | X(1) | space |
Product Type | X(2) | Product type defined in Format Set |
Field Delimiter | X(1) | space |
Ad Zone | X(8) | Ad Zone, Truck ID, or Zip Code assigned to the route (Ad Zone Type defined for the Burt Format Set). The Ad Zone option is available only if InsertPlus is being used. |
Field Delimiter | X(1) | space |
Editorial Zone | X(10) | Edition assigned to the route for the delivery date selected in processing |
Field Delimiter | X(1) | space |
PPB | 9999 | zeros |
Field Delimiter | X(1) | space |
Route Class | X(6) | spaces |
Field Delimiter | X(1) | space |
Reserved | X(3) | space |
Field Delimiter | X(1) | space |
Entry Discount | X(3) | spaces |
Field Delimiter | X(1) | space |
Presort Discount | 99 | zeros |
Field Delimiter | X(1) | space |
Packet Number | 9999 | zeros |
Field Delimiter | X(1) | space |
First Key | 9999 | zeros |
Field Delimiter | X(1) | space |
Second Key | 9999 | zeros |
Field Delimiter | X(1) | space |
Bundle Order | X(4) | spaces |
Delivery or Routing Schedule | X(6) | The Burt routing schedule defined in Format Set |
Field Delimiter | X(1) | space |
Publication Date | 99/99/99 | Delivery date selected in processing; formatted as MM/DD/YY |
Field Delimiter | X(1) | space |
Checksum File | X(12) | ARC[P, AC, AD].MMDDYY |
Field Delimiter | X(1) | space |
Draw by Ad Route | X(12) | AR[P, AC, AD].MMDDYY |
Field Delimiter | X(1) | space |
Draw by Carrier Route | X(12) | CR[P, AC, AD].MMDDYY |
Field Delimiter | X(1) | space |
Delivery Schedule | x(6) | The routing scheduled entered at runtime |
Field Delimiter | x(1) | Space |
Publication Date | mm/dd/yy | The draw date entered at runtime |
Field Delimiter | x(1) | Space |
Route Count | 9(6) | Number of routes exported |
Field Delimiter | x(1) | Space |
Draw Total | 9(9) | Total draw exported |
Ad Route | x(10) or x(15) | Route ID or ad zone ID or “MAIL” + editionID (based on Business Rules). Note: if Burt version 7 is used (based on Business Rules) this field is extended to 15 characters. |
Field Delimiter | x(1) | Space |
Reserved | x(4) | Spaces. Note: if Burt version 7 is used (based on Business Rules) this field and the previous delimiter are not exported, and the Ad Route field is extended to 15 characters. |
Field Delimiter | x(1) | Space |
Draw Quantity | 9(9) | Draw for the route |
Field Delimiter | x(1) | Space |
Class of Sale | x(2) | Based on the Business Rules, this can be “HD” for Home Delivery and “SC” for Single Copy, or the first two characters of the route’s route type or single copy type |
Field Delimiter | x(1) | Space |
Product Type | x(2) | “I” if Product Type was Parts; “C” if Product Type was Routes or Completes (as prompted for at runtime) |
Field Delimiter | x(1) | Space |
Ad Zone | x(8) or x(15) | Ad Zone, Truck ID or Zip Code, as defined at runtime. Note: if Burt version 7 is used (based on Business Rules) this field is extended to 15 characters. |
Field Delimiter | x(1) | Space |
Editorial Zone | x(10) | Edition ID for draw date selected at runtime. If ad zones are exported as ad routes, an edition ID is only exported if all routes in the ad zone have the same edition. |
Field Delimiter | x(1) | Space |
Packages per bundle | 9(4) | Zeros |
Field Delimiter | x(1) | Space |
Route Classification | x(6) | Spaces |
Field Delimiter | x(1) | Space |
Trip | x(10) | Truck ID or “MAIL” + editionID (based on Business Rules) |
Field Delimiter | x(1) | Space |
Packet Number | 9(4) | Zeros |
Field Delimiter | x(1) | Space |
First Key | 9(4) | Zeros |
Field Delimiter | x(1) | Space |
Second Key | 9(4) | Zeros |
Field Delimiter | x(1) | Space |
Bundle Order | x(4) | Spaces |
Delivery Schedule | x(6) | The routing scheduled entered at runtime |
Field Delimiter | x(1) | Space |
Publication Date | mm/dd/yy | The draw date entered at runtime |
Field Delimiter | x(1) | Space |
Reserved | x(5) | Spaces |
Field Delimiter | x(1) | Space |
Carrier Route | x(15) | Route ID or “MAIL” + editionID (based on Business Rules) |
Field Delimiter | x(1) | Space |
Ad Route | x(10) or x(15) | Route ID or ad zone ID (based on Business Rules). Note: if Burt version 7 is used (based on Business Rules) this field is extended to 15 characters. |
Field Delimiter | x(1) | Space |
Reserved | x(4) | Spaces. Note: if Burt version 7 is used (based on Business Rules) this field and the previous delimiter are not exported, and the Ad Route field is extended to 15 characters. |
Field Delimiter | x(1) | Space |
Draw Quantity | 9(6) | Draw quantity for the route |
Field Delimiter | x(1) | Space |
Route Sequence | 9(4) | Order in which route is dropped by truck, or “0000” (based on the Business Rules) |
Field Delimiter | x(1) | Space |
Drop | x(10) | Truck ID + first 4 digits of drop order |
Field Delimiter | x(1) | Space |
Drop Sequence | 9(4) | Drop order. Burt is limited to a 4-digit sequence. If the route’s drop sequence is over 4 digits, only the first 4 digits will be exported. |
Field Delimiter | x(1) | Space |
Trip/Load | x(10) | Truck ID of truck that drops route |
Field Delimiter | x(1) | Space |
Trip/Load Sequence | 9(4) | Zeros |
Field Delimiter | 1(1) | Space |
Truck | x(6) | Truck ID (if relay trucks are used, parent truck) |
Field Delimiter | x(1) | Space |
Sequence Offset | HH:MM | 00:00 or last for digits of the truck departure (based on the Business Rules) |
Field Delimiter | x(1) | Space |
Reserved | x(10) | Spaces |
Field Delimiter | x(1) | Space |
Reserved | x(6) | Spaces |
Field Delimiter | x(1) | Space |
Zip Code | 9(5) | Primary Zip for the route |
Field Delimiter | x(1) | Space |
Class of Sale | x(2) | Based on the Business Rules, this can be “HD” for Home Delivery and “SC” for Single Copy, or the first two characters of the route’s route type or single copy type |
Field Delimiter | x(1) | Space |
Product Type | x(2) | “I” if Product Type was Parts; “C” if Product Type was Routes or Completes (as prompted for at runtime). Product types can also vary by route (as defined in Route Setup) and have other values. |
Field Delimiter | x(1) | Space |
Ad Zone | x(8) or x(15) | Ad Zone, Truck ID or Zip code, as defined at runtime. Note: if Burt version 7 is used (based on Business Rules) this field is extended to 15 characters. |
Field Delimiter | x(1) | Space |
Editorial Zone | x(10) | Edition ID for draw date selected at runtime |
Field Delimiter | x(1) | Space |
PPB | 9(4) | Zeros |
Field Delimiter | x(1) | Space |
Route Class | x(6) | Spaces |
Field Delimiter | x(1) | Space |
Reserved | x(3) | Space |
Field Delimiter | x(1) | Space |
Entry Discount | x(3) | Entry discount specified in the Business Rules |
Field Delimiter | x(1) | Space |
Presort Discount | 9(2) | Presort discount specified in the Business Rules |
Field Delimiter | x(1) | Space |
Packet Number | 9(4) | Zeros |
Field Delimiter | x(1) | Space |
First Key | 9(4) | Zeros |
Field Delimiter | X(1) | Space |
Second Key | 9(4) | Zeros |
Field Delimiter | X(1) | Space |
Bundle Order | X(4) | Spaces |
Delivery Schedule | x(6) | The routing scheduled entered at runtime |
Field Delimiter | x(1) | Space |
Publication Date | mm/dd/yy | The draw date entered at runtime |
Field Delimiter | X(1) | Space |
Checksum File | x(12) | Name of Ad Route Checksum file created by export |
Field Delimiter | x(1) | Space |
Draw by Ad Route | X(12) | Name of Draw by Ad Route file created by export |
Field Delimiter | x(1) | Space |
Draw by Carrier Route | X(12) | Name of Draw by Carrier Route file created by export |
Delimiter | X(1) | Space |
Carrier Route | x(15) | Route ID |
Field Delimiter | x(1) | Pipe |
Description | x(35) | Route name |
Field Delimiter | x(1) | Pipe |
Note | x(35) | Blank |
Field Delimiter | x(1) | Pipe |
Class of Sale | x(2) | Route’s class of sale (same as exported in CR file) |
Field Delimiter | x(1) | Pipe |
District | x(6) | First 6 characters of the route’s district |
Field Delimiter | x(1) | Pipe |
Zip Code | x(10) | Route’s Zip (same as exported in CR file) |
Field Delimiter | x(1) | Pipe |
Completes Only | x(3) | Blank |
Field Delimiter | x(1) | Pipe |
Complete at Plant | x(3) | Blank |
Field Delimiter | x(1) | Pipe |
Bundle Type | x(7) | “BULK” if route is bulked in truck sequence. Otherwise “LABELED”. |
Field Delimiter | x(1) | Pipe |
Label Type | x(8) | Blank |
Field Delimiter | x(1) | Pipe |
Carrier Manifest | x(3) | Blank |
Field Delimiter | x(1) | Pipe |
Carrier | x(10) | Account ID of carrier delivering the route. For dealers, the dealer account ID. |
Field Delimiter | x(1) | Pipe |
Special Instructions | - | Blank. |
Delivery Schedule | x(6) | The routing scheduled entered at runtime |
Field Delimiter | x(1) | Pipe |
Publication Date | mm/dd/yy | The draw date entered at runtime |
Field Delimiter | x(1) | Pipe |
Carrier Route | x(15) | Route ID |
Field Delimiter | x(1) | Pipe |
Sequence | 9(4) | Sequence of this message within all messages exported for route. Each message record for a route will have a unique sequence number. The first digit of the sequence will be the first digit of the Deliverable Sort for the publication, as defined in Deliverable Sort setup. If no Deliverable Sort is defined for the publication, “0” will be exported for the first digit. Note: When a route delivers multiple publications, the first digit of the Sequence field will be the publication identifier. |
Field Delimiter | x(1) | Pipe |
Message | x(254) | Message text |
File Type: Space-delimited with fields in double quotes
Location: /dti/exchange/cm
. The file name is prompted for when running the Chart of Acct Import option.
Each record must contain the fields shown below. If the GL account has no roll up account, leave the Roll Up Account ID blank.
File type: Pipe-delimited.
Location: /dti/exchange/cm/dmexp[product][edition].[MMDDYYYY]
, where “MMDDYYYY” are the month, day, and year of the run date.
This file is comma-delimited, with each field surrounded by quotes. The file will be written to the PW/data
directory and named <productid>dd.txt
, where “dd” is the day of the month.
The additional fields for single copy mail routes will only export for routes with a single copy type that matches the single copy type specified in the Business Rule— For which single copy type should mail labels print when using Postalsoft Presort and Label? These fields will not be exported if the Business Rule is not answered. If exported, the additional fields will be blank for subscriber records.
Note:
The Collectech interface requires a separate license fee to use. Contact the Naviga Support Center for details.
File type: Fixed length. Active, stopped and paid will be exported to separate files.
Location: /dti/exchange/cm
. The file name is user-defined, and the name will be appended with “active”, “stop” or “paid”.
The output format is pipe-delimited and contains the following fields.
File type: Fixed length.
Location: /dti/exchange/cm
. The file name is specified at runtime.
Field |
---|
Field | Example |
---|---|
Field | Description | Max Length |
---|---|---|
Field | Comments |
---|---|
Field | Length | Contents |
---|---|---|
Field |
---|
Field | L |
---|
Record | L | Field |
---|
Template Field | Expected Output |
---|
Carrier ID
Total Draw
Start Date
End Date
GL Company ID
“01”
Account ID
“00120002”
Description
“Returns”
Roll Up Account ID
“0012”
Export Type
D1 (at this time there is only one record type for the export)
2
Product ID
The publication being exported. If a combined pub is being exported, the route’s delivery publication will be exported here
8
Edition ID
The route’s edition.
8
Publish Date
The run date for the DM Report (format MM/DD/YYYY)
10
Truck ID
The route’s truck, if not dropped by a relay. If the route is dropped by a relay, the parent truck ID is exported
8
Truck Name
The name of the truck in the previous field
20
Relay Truck ID
The route’s truck, if dropped by a relay. If not, this field will be blank
8
Relay Truck Name
The name of the truck in the previous field
20
Drop order
The drop order of the route on the truck
8
District
The route’s district
8
Carrier
The route’s carrier ID
8
Route ID
The ID of the route being exported.
8
Subscription
The ID of the subscriber for this transaction, if any
10
Name
The subscriber’s first and last name
30
Address (fields 1-5)
The subscriber’s address
30
Phone Number
The subscriber’s phone number, if not unlisted. Format (999) 999-9999
14
Delivery Schedule
The subscriber’s delivery schedule
8
Billing Method
The subscriber’s billing method
15
Tran Type ID
The transaction type (start, stop, etc.)
15
Source Code
Source code for transaction
8
Subsource Code
The subsource for the transaction, if any
8
Reason Code
Reason code for transaction
8
Complaint Time
Complaint time, if transaction is a complaint. Format: 99:99:99
8
Delivery Complaint
Flag to indicate whether complaint is a delivery complaint (yes/no)
3
Days Adjusted
If transaction is a complaint, number of days subscription was extended
3
Entry Date
The entry date for the transaction
10
Transaction Date
The tran date entered for the transaction
10
Text (fields 1-5)
Complaint text, message text, or remarks (if transaction is not a complaint or message and remarks were entered)
30
Copies
Number of copies subscriber receives on run date
3
Expire Date
Subscription expire date (for office pay subscribers)
10
Restart Date
If the transaction is a stop and a restart date has been entered, it will be exported here
10
Create User
User who entered the transaction
8
Delivery Placement ID
The delivery placement
8
Placement Description
Description of the delivery placement
30
Label Group ID
CAPS
Edition ID
CAPS
First Name
Last Name
Firm Name
Address Line
Unit
Extra Address Line
City
County
State
Format x(2)
Country
Zip Code
Zip Extension
Zip Bar Code
Format x(2)
PO Route Type
PO Route Walk Sequence
Format “9999999”
Lot
Format “9999”
Lot Sequence
Delivery Point Usage Code
Format x(1)
Subscriber
Subscription ID
Expire Date
Address ID
Billing Method
Additional fields for single copy routes
Route ID
Draw Total
Publication Firm Name
Publication Name
Publishing Date
Publication Address
Publication Unit
Publication Extra Line
Publication City
Publication State
Publication ZIP
Publication ZIP Extension
Publication Delivery Point Bar Code
USPS Number
Truck ID
Truck Name
Truck Drop Order
Relay Info (4 fields)
Format x(30)
Bundle Info (4 fields)
Format x(30)
Route Drop Location
Route Drop Instructions
Truck Drop Location (4 fields)
Format x(30)
Truck Drop Instructions (4 fields)
Format x(30)
Account Number
25
Subscription account number
Responsible Party
30
Subscriber’s name (last name, first name). If subscription has bill-to occupant, then bill-to name is exported here
Account Name
30
If subscription has bill-to occupant, then delivery occupant name is exported here (otherwise blank)
Address Line 1
30
Subscriber’s street address. If subscription has bill-to address, then bill-to street address is used
Address Line 2
30
Second line of street address, if applicable
City
15
Address city
State
2
Address state
ZIP
9
Address ZIP Code, including ZIP + 4
Phone Number
10
Subscriber’s phone number, including area code. If subscription has bill-to occupant, bill-to is exported
Filler
1
This will be “0”
Social Security
9
This will be blank
Date of Last Payment
6
Last payment received for subscription, format YYMMDD
Date of Last Charge
6
This will be zeros
Balance 1
9
Cost of subscription for payment term entered (active subscribers) or grace owed amount (perm stopped subscribers). The last two digits will be decimals
Filler
1
This will be “+”
Balance 2
9
This will be zeros
Filler
1
This will be “+”
Balance 3
9
This will be zeros
Filler
1
This will be “+”
Descriptor Code 1 & 2
2
These fields will be blank
Field
Length
Contents
Account Number
25
Subscription account number
Payment Amount
8
Amount of last payment. The last two digits are decimals
Product ID |
Start Date |
End Date |
Date range (either “This Year” or “Last Year”) |
Transaction type |
Delivery schedule ID (from the subscription draw record) |
Transaction details (stop reason code or start source code) |
Draw movement (“UP” or “DOWN”; whether count numbers increased or decreased) |
Sunday print count |
Daily print count |
Sunday online count |
Daily online count |
Route ID | 8 |
Publication | 2 |
Start date for draw changes (format YYMMDD) | 6 |
Reversal date for draw changes (format YYMMDD). Leave blank if no reversal date. | 6 |
Draw Type (will be spaces) | 2 |
Sunday Draw (format 9999) | 4 |
Monday Draw | 4 |
Tuesday Draw | 4 |
Wednesday Draw | 4 |
Thursday Draw | 4 |
Friday Draw | 4 |
Saturday Draw | 4 |
Account Key | 10 | Subscription ID |
Name | 24 | Subscriber’s first name + last name |
Address 1 | 30 | Subscriber’s primary address, line 1 |
Address 2 | 30 | Subscriber’s primary address, line 2 |
Address 3 | 30 | Subscriber’s primary address, line 3 |
Bill-to Name | 24 | Bill-to Occupant’s first name + last name |
Bill-to Address 1 | 30 | Bill-to address, line 1 |
Bill-to Address 2 | 30 | Bill-to address, line 2 |
Bill-to Address 3 | 30 | Bill-to address, line 3 |
Message Line 1 | 68 | Rate code renewal message |
Message Line 2 | 68 | Spaces |
Expire Date | 8 | Subscription’s expire date, format YYYYMMDD |
Due Date | 8 | For renewals, the expire date. For invoices, the expire date + 7. Format YYYYMMDD |
Term 1 | 8 | Term and length of first rate term (in order of lowest to highest) |
Term 2 | 8 | Term and length of second rate term |
Term 3 | 8 | Term and length of third rate term |
Term 4 | 8 | Term and length of fourth rate term |
Week Description | 22 | “Number of Weeks” |
Copies | 3 | Number of copies the subscriber receives per delivery day |
Term 1 Weeks | 8 | Number of weeks for first term offered. (If term is months, this will be term * 4.3.) |
Term 2 Weeks | 8 | Number of weeks for second term offered. |
Term 3 Weeks | 8 | Number of weeks for third term offered. |
Term 4 Weeks | 8 | Number of weeks for fourth term offered. |
Filler | 22 | Spaces |
Filler | 3 | Zeros |
Filler | 32 | Spaces |
Rate Description | 22 | “Weekly Rate” |
Filler | 3 | Zeros |
Cost of Term 1 | 8 | Weekly rate for term 1 |
Cost of Term 2 | 8 | Weekly rate for term 2 |
Cost of Term 3 | 8 | Weekly rate for term 3 |
Cost of Term 4 | 8 | Weekly rate for term 4 |
Filler | 22 | Spaces |
Filler | 3 | Zeros |
Filler | 54 | Spaces |
Filler | 3 | Zeros |
Filler | 54 | Spaces |
Draw 6 | 3 | Zeros |
Filler | 32 | Spaces |
Trans. Cost 1 | 8 | Transportation cost (carrier credit for delivery subscription) for term 1 |
Trans. Cost 2 | 8 | Transportation cost for term 2 |
Trans. Cost 3 | 8 | Transportation cost for term 3 |
Trans. Cost 4 | 8 | Transportation cost for term 4 |
Net Cost 1 | 8 | Net cost for first term (term + tax) |
Net Cost 2 | 8 | Net cost for second term (term + tax) |
Net Cost 3 | 8 | Net cost for third term (term + tax) |
Net Cost 4 | 8 | Net cost for fourth term (term + tax) |
AAM Zone | 8 | AAM Zone of the address |
District | 8 | District manager for route delivering subscription |
Route | 8 | Route delivering subscription |
Carrier | 8 | Carrier delivering route on date renewals are processed |
Rate Code | 20 | Subscriber’s rate code |
Last Payment Date | 8 | Date of last subscriber payment, format YYYYMMDD |
Payment Total | 8 | Total amount of last payment, including tip, taxes, and cash adjustments. |
Payment Amount | 8 | The subscription amount of the last payment. |
Tax Amount | 8 | The tax collected from the last payment. |
Tip Amount | 8 | The tip amount from the last payment. |
Adjust Amount | 8 | The cash adjustment amount from the last payment. |
Vacation Days | 3 | The number of days newspaper was temp stopped (only temp stops with a reason code that can be printed on renewals will be included) |
Vac. Days Since | 8 | Date of temp stop, format YYYYMMDD |
Bill Type | 1 | “M” for mail. If route delivered, “R” for renewal or “I” for invoice |
Bill Terms | 1 | Number of terms offered subscriber. 1 term = “0” 2 terms = “2” 3 terms = “T” 4 terms = “F” |
Default Term | 8 | Term matching last payment amount. If none match (or no previous payment), next lowest term. |
Statement Date | 8 | Date the file was exported, format YYYYMMDD |
Email address | 67 | Occupant’s email address |
[CurrentDay] | Current day of month (e.g. 21) |
[CurrentDayName] | Name of current day (e.g. Wednesday) |
[CurrentMonth] | Current month of year (e.g. 7) |
[CurrentMonthName] | Current month name (e.g. July) |
[CurrentYear] | Current year (e.g. 2013) |
[Salutation] | Subscriber’s salutation (e.g. Mr.) |
[FirstName] | Subscriber’s first name |
[MiddleInitial] | Subscriber’s middle initial |
[LastName] | Subscriber’s last name |
[Honorific] | Subscriber’s honorific (e.g. Sr.) |
[FullName] | Subscriber’s complete name |
[OtherName] | Subscriber’s other name (DBA or other information) |
[EmailTo] | Occupant’s e-mail address (used only with text format) |
[ManageLinksHeading] | Heading for the Manage My Account links in the e-mail confirmations |
[iSubForgotURL] | Forgot Password link |
[iSubNewStartURL] | New Subscription link |
[iSubRegisterURL] | Registration link |
[iSubLoginURL] | Login link |
[iSubLoginAcctAdjURL] | Account Adjustments link |
[iSubLoginAcctHistURL] | Account History link |
[iSubLoginAcctInfoURL] | Change Account Info link |
[iSubLoginAcctProfileURL] | Account Profile Home link |
[iSubLoginAutorenewURL] | Autorenew link |
[iSubLoginBillOptURL] | Bill Delivery Option link |
[iSubLoginChgPwdURL] | Change Password link |
[iSubLoginComboChgURL] | Change Subscription link |
[iSubLoginComplaintURL] | Complaint (Delivery Feedback) link |
[iSubLoginContactUsURL] | Contact Us link |
[iSubLoginContestURL] | Contest link |
[iSubLoginDelOptHomeURL] | Delivery Options Home link |
[iSubLoginInsertURL] | Inserts link |
[iSubLoginMessageURL] | Messages link |
[iSubLoginPaymentURL] | Make a Payment link |
[iSubLoginPaymentHomeURL] | Payment Options Home link |
[iSubLoginTempStopURL] | Vacation Hold link |
[iSubLoginTipDonateURL] | Make a Tip or Donation link |
[iSubLoginViewRenewalURL] | View Renewals link |
Some Circulation features that send e-mails, such as Send eBills and the New Password button in Customer Services, use templates to format the look and feel of the e-mail. Naviga provides a default HTML and text templates, stored in subfolders under the email
directory of the Circulation application directory ($PRODIR). You can customize the templates with your own specific logo and branding.
If customizing templates, Naviga recommends creating a customized folder (e.g. /app/webcustom/cm/email
), and placing the templates in their respective subdirectories in the custom folder. For example, if using the path above, eBill e-mail templates would be stored in the /app/webcustom/cm/email/renewals
directory. The root custom directory should be specified in the Business Rule— What directory are customized email templates stored in? Circulation will then use templates in this directory rather than the default templates stored in the email
directory. If a custom template directory is specified but a custom version of a template (for day pass, digital vacation pack, etc.) does not exist, Circulation will use the standard version of the template.
If the template contains a link to the iServices Login page, the subscriber’s e-mail address will be included in the link, so that the e-mail will be pre-filled on the Subscriber Login page. The e-mail can optionally be encrypted, based on the Business Rule— For inbound URL parameters, what private key (character string) is used for encryption? (iServices & Mapping section). If no private key is supplied, the e-mail address will still be embedded in the Subscriber Login page link, but will not be encrypted.
The following sections list the variables that can be used in any e-mail template. Variables specific to templates are listed after the template example.
This template is located in the email/occupant
directory where Circulation is installed. The HTML version is named password.htm, and the text e-mail version is password.tmp
.
The customized version must have the same name (“password.htm” or “password.tmp
”).
If customizing the template, follow the customizing guidelines and standard list of variables in the Send eBill section (above). In addition, several variables specific to the New Password template can be used, listed in the table below.
These templates are used by Send eBills to e-mail an electronic version of the renewal notice. The eBill notice will provide a single renewal amount. This will be the amount for the first term in the sort order, based on the Business Rule— What should the sort order be for exporting rate terms on subscriber renewal notices? If subscribers click the payment link to enter a payment in iServices Subscriber, different terms can be selected at that point.
Default eBill e-mail templates are stored in the email/renewals
directory. Initially an HTML (billnotify.htm
) and a text template (billnotify.tmp
) are provided. You can have multiple templates that are used for invoices versus renewals, and for different renewal periods, using the names below. Send eBills will use the template for your specific renewal/invoice number, if defined. If not defined, it will use billnotifyren.htm or billnotifyinf.htm, based on whether a renewal notice or invoice is being sent. If those templates are not found, billnotify.htm
will be used.
For example, if the first renewal is different from subsequent notices, you can define billnotifyren1.htm. That will be used for the first renewal notice sent to subscribers. Subsequent renewal notices would use billnotify.htm
.
Note: If using the text templates, the same file names can be deployed, with the “.tmp
” extension rather than “.htm
”.
Naviga recommends moving the templates to the custom template directory, as explained above. If you don't plan to create customized e-mails for each eBill renewal/invoice number, you must remove any undesired HTML templates from your the “renewals" e-mail directory.
All of the eBill e-mail templates contain the following content areas:
Header. The Header area includes a newspaper logo and link to the newspaper website.
Content. The Content area includes transaction by default.
Sidebar. The Sidebar area can be customized for marketing message or links to iServices Subscriber.
Footer. The Footer area includes the newspaper name and address and any other newspaper enterprise items, such as social media links.
The table below lists all of the HTML variables (dates, name, URLS, redirects, image and logos) that may be used when customizing your eBill notification templates. Note that the iServices variables only pertain to sites with iServices Subscriber.
If you use Google Analytics for website tracking, the eBill e-mail templates automatically send tracking information when subscribers click on a link within the e-mail. The following values are used:
Originating source (&utm_source): “circulation”
Medium type (&utm_medium): "email"
E-mail template name (&utm_campaign): the file name of the template being used, not including the file extension (e.g. "billnotify")
https://[domain]/[script]/custservice/web/login.html?utm_source=circulation&utm_medium=email&utm_campaign=billnotify
Naviga recommends following these best practices when customizing HTML e-mail templates:
Use tables and explicitly set widths in table cells (TD tag) so that the HTML e-mails display at the intended size.
Images must reside on a publicly accessible location and use the ALT attribute since many e-mail clients (e.g. Gmail and Outlook) by default suppress images.
Keep the HTML page width small (e.g. 600 pixels).
Do not use external CSS files. While designing the template, place CSS style in the head and then prior to testing extract all CSS to be in line. You may use http://premailer.dialect.ca as a tool to extract the CSS styles.
Define hyper links with target="_blank" so they automatically open a new window.
When a temp stop digital vacation pack is entered (in Customer Service or iServices), a confirmation e-mail will be sent to the customer, which can contain a URL and login information for the digital edition. The content for this e-mail is determined by an HTML template, digivacpac.htm, located in the email/custservic
e directory where Circulation is installed. A text version, digivacpac.tmp
, is also available.
The template can be customized and placed in a custom folder, identified by the Business Rule— What directory are customized email templates stored in? If customizing the template, it still must have the same name and be in the custservice
subfolder.
The template is used to send an e-mail confirmation when a stop or restart is entered in Customer Service. A default HTML template is contained in the email/custservice/tempstop.htm
file, located in the Circulation code set. A text template, tempstop.tmp
, is located in the same directory.
If access to a digital edition is granted as part of a complaint transaction, an e-mail confirmation will be sent to the subscriber using this template. A default template is contained in the email/custservice
directory in the CM code set. There are separate templates, dgtlcomplaint.htm
and dgtlcomplaint.tmp
, for HTML and text e-mails, respectively.
E-mail settings in Website setup determine whether the e-mail is sent in HTML or text format, the protocol and “from” name, and other parameters related to the e-mail and the template. See in the Setup Manual. Optional elements in the template only display if there is data for the field.
Parameter | Description |
---|---|
Number | Renewals | Invoices |
---|---|---|
Parameter | Description |
---|---|
Parameter | Description |
---|---|
Parameter | Description |
---|---|
Parameter | Description |
---|
Parameter | Description |
---|
[Subject]
E-mail subject line.
[Password]
Subscriber’s new password.
1
billnotifyren1.htm
billnotifyinv1.htm
2
billnotifyren2.htm
billnotifyinv2.htm
3
billnotifyren3.htm
billnotifyinv3.htm
4
billnotifyren4.htm
billnotifyinv4.htm
5
billnotifyren5.htm
billnotifyinv5.htm
6
billnotifyren6.htm
billnotifyinv6.htm
7
billnotifyren7.htm
billnotifyinv7.htm
8
billnotifyren8.htm
billnotifyinv8.htm
9
billnotifyren9.htm
billnotifyinv9.htm
Any
billnotifyren.htm
billnotify.htm (if billnotifyren.htm is not found)
billnotifyinv.htm
billnotify.htm (if billnotifyinv.htm is not found)
Renewal parameters
[Account]
SubscriptionID
[BillDate]
Renewal date
[BillAmount]
1st rate term amount (only one rate term included)
[DueDate]
“Upon Receipt” if no expire or expire date is less than current date; otherwise the expiration date
Miscellaneous
[ImagePath]
Directory containing images (e.g. logo - header.jpg).
[Logo]
Uses image path and appends email specific logo (header600px.jpg).
Subscriber information
[AccountNumber]
Subscriber’s ID.
[EmailAddress]
Subscriber’s e-mail address.
[AddressLine]
Subscriber’s address
[Phone]
Subscriber’s phone number.
[TransactionDate]
Date that complaint was entered.
[DeliveryFrequency]
Delivery schedule description.
[DeliveryMethod]
Subscriber’s delivery method.
[BillingMethod]
Subscriber’s billing method
[PublicationName]
Name of publication complaint was entered for.
[Edition]
Name of edition complaint was entered for.
[StartDate]
Date of the new start.
[RenewalDelivery]
Subscriber’s renewal delivery option.
[BillFullName]
Billing subscriber’s name.
[BillAddressLines]
Billing subscriber’s address.
[BillPhone]
Billing subscriber’s phone.
[BillEmailAddress]
Billing subscriber’s e-mail address.
[SuspendText]
Defined in Blurb Setup: Start has been suspended blurb used on Start Confirmation web page and email
iServices Subscriber URLs (if necessary also append "site" parameter)
[ImagePath]
Directory containing images (e.g. logo - header.jpg).
General variables
[Subject]
Title of confirmation e-mail.
Subscriber information
[Account]
Subscriber’s ID.
[Action]
“Access digital edition”
[Comments]
Comments entered for the temp stop transaction.
[DeliveryFrequency]
Delivery schedule description.
[DeliveryMethod]
Subscriber’s delivery method.
[PublicationName]
Name of publication being renewed.
[ReasonDesc]
Stop reason code description.
[RequestMode]
Digital vacation pack request method (“deleted” or “received”).
[StartDate]
Restart date.
[StopDate]
Temp stop date.
[SubmitDate]
Date that digital vacation pack was requested.
iServices Subscriber URLs (if necessary also append "site" parameter)
[EPaperURL]
Electronic edition link.
[ImagePath]
Directory containing images (e.g. logo - header.jpg).
Subscriber information |
|
[AccountNumber] | Subscriber’s ID. |
[TransactionDate] | Date that complaint was entered. |
[DeliveryFrequency] | Delivery schedule description. |
[DeliveryMethod] | Subscriber’s delivery method. |
[Edition] | Name of edition complaint was entered for. |
[PublicationName] | Name of publication complaint was entered for. |
[StartDate] | Date of the restart. |
[RequestType] | Type of transaction (“vacation hold” or “restart”). |
[RequestMode] | “Received” when creating or editing a temporary stop. |
[ReasonDesc] | Stop/restart reason code description. |
[Action] | Stop action (donate, hold papers, extend expire, etc.). |
[Comments] | Remarks entered with stop. |
[VacCreditMsg] | Vacation credit rules message. |
|
|
iServices Subscriber URLs (if necessary also append "site" parameter) |
|
[ImagePath] | Directory containing images (e.g. logo - header.jpg). |
General variables |
|
[Subject] | Title of confirmation e-mail. |
|
|
Subscriber information |
|
[AccountNumber] | Subscriber’s ID. |
[TransactionDate] | Date that complaint was entered. |
[Comments] | Comments entered for the complaint transaction. |
[DeliveryFrequency] | Delivery schedule description. |
[DeliveryMethod] | Subscriber’s delivery method. |
[PublicationName] | Name of publication complaint was entered for. |
[Edition] | Name of edition complaint was entered for. |
[ReasonDesc] | Complaint code description. |
[ComplaintDate] | Delivery date that the complaint was entered for. |
[Resolution] | Complaint resolution action (“Access digital edition” or “Access digital edition now and redelivery later”) |
[AltAddress] | Redelivery address for complaint. |
|
|
iServices Subscriber URLs (if necessary also append "site" parameter) |
|
[EPaperURL] | Digital edition link. |
[ImagePath] | Directory containing images (e.g. logo - header.jpg). |
The template is used to send an e-mail confirmation when a payment is entered with a payment amount of zero (only a tip or donation amount is specified) in Customer Service. A default HTML template is contained in the email/custservice/tipdonate.htm
file, located in the Circulation code set. A text template, tipdonate.tmp
, is located in the same directory.
The formats of the files that are exported and imported using the Export/Import Account Rates option are given below. Note that, for the import, the first line of each file is ignored (because it is expected to be the column header for the fields). The export option exports the column header as the first line of data for each file.
Note: The files are tab-delimited.
The template is used to send an e-mail confirmation when a payment is entered in Customer Service. A default HTML template is contained in the email/custservice/payment.htm
file, located in the Circulation code set. A text template, payment.tmp
, is located in the same directory.
The following data elements can be used with the “1099Export” usage. This usage or the 1099 Forms Export usage can be used to export 1099 reporting information in the 1099 Forms option (see 1099 Forms).
File mapping can be used for the following options.
The formats of the files that are exported and imported using the Export/Import Subscription Rates option are given below. Note that, for the import, the first line of each file is ignored (because it is expected to be the column header for the fields). The export option exports the column header as the first line of data for each file.
The following data elements can be used with the “AccountLockbox” usage.
* Field is required.
** Field is required if a record identifier is entered on the record type setup screen.
The following data elements can be used with the “AddressExport” and “AddressImprt” usages.
* Field is required
** Field can only be exported if addresses are stored unparsed in the database and QAS is used for address correction
Parameter | Description |
---|---|
File | Field | Format |
---|---|---|
Parameter | Description |
---|---|
Data Element | Description |
---|---|
File Map Usage |
---|
Field # | Field | Format | Required |
---|
Field # | Field | Format | Required |
---|
Field # | Field | Format | Required |
---|
Field # | Field | Format | Required |
---|
Field # | Field | Format | Required |
---|
Field # | Field | Format | Required |
---|
Field # | Field | Format | Required |
---|
Field # | Field | Format | Required |
---|
Field # | Field | Format | Required |
---|
Field # | Field | Format | Required |
---|
Field # | Field | Format | Required |
---|
Field # | Field | Format | Required |
---|
Field # | Field | Format | Required |
---|
Field # | Field | Format | Required |
---|
Field # | Field | Format | Required |
---|
Field # | Field | Format | Required |
---|
File: Reason Info |
---|
Data Element | Description |
---|
Data Element | Description |
---|
Subscriber information
[AccountNumber]
Subscriber’s ID.
[TransactionDate]
Date that complaint was entered.
[DeliveryFrequency]
Delivery schedule description.
[DeliveryMethod]
Subscriber’s delivery method.
[PublicationName]
Name of publication complaint was entered for.
[Edition]
Name of edition complaint was entered for.
[PaymentType]
Payment type selected by user
[PaymentOption]
Payment option selected by user: CHECKING ACCOUNT or CREDIT CARD
[BankRoutingNumber]
Bank routing number
[PaymentAccountNumber]
Subscription.SubscriptionID
[CardExpireDate]
Expiration date
[PaymentAccountHolderName]
Account holder name
[AdjustmentLabel]
Payment adjustment, if any
[AdjustmentAmount]
Payment adjustment amount (if not zero), such as NIE
[TipAmount]
Tip amount
[Total]
Calculated total amount (subscription cost + NIE donation + tip)
[Authorization]
Credit card authorization
{TermsConditions}
Defined in Blurb Setup; will vary depending on whether the transaction is auto-renew or single payment, and whether a bank account or credit card was used.
iServices Subscriber URLs (if necessary also append "site" parameter)
[ImagePath]
Directory containing images (e.g. logo - header.jpg).
Rate Code
RateCodeID
x(20)
StartDate
99/99/9999
EndDate
99/99/9999
Description
x(30)
CarrierRateType
x(8)
WholesaleAmount
9(8.2-)
WholesaleUnitRate
9(6.6-)
RetailAmount
9(8.2-)
RetailUnitRate
9(6.6-)
Account Rate Class
CarrierRateClassID
x(8)
Description
x(30)
Route Rate Class
DistribPointRateClassID
x(8)
Description
x(30)
Rule Rate Link
RuleDeliverableID
x(12)
RuleDeliveryID
x(12)
RuleDistribPointID
x(12)
RuleCarrierID
x(12)
StartDate
99/99/9999
EndDate
99/99/9999
Carrier Rate Type
x(8)
*DrawRateCodeID
x(20)
*DrawChargeCodeID
x(8)
*CreditRateCodeID
x(20)
*CreditChargeCodeID
x(8)
*ReturnRateCodeID
x(20)
*ReturnChargeCodeID
x(8)
*WeightBonusRateID
x(8)
*PieceBonusRateID
x(8)
* In the Rule Rate Link table, these fields are defined as arrays and have array elements 1 – 7 that correspond to each day of the week: Sun – Sat (1-7).
For example: DrawRateCodeID[1], DrawRateCodeID[2], DrawRateCodeID[3], DrawRateCodeID[4], DrawRateCodeID[5], DrawRateCodeID[6], DrawRateCodeID[7].
Product Rule
RuleDeliverableID
x(12)
ProductID
x(8)
Delivery Rule
RuleDeliveryID
x(12)
RateCodeID
x(20)
DeliveryScheduleID
x(8)
DistribMethod
x(8)
BonusDayDelivery
x(1)
Route Rule
RuleDistribPointID
x(12)
RouteID
x(8)
DistrictID
x(8)
DistribPointRateClassID
x(8)
AAMZoneID
x(6)
DrawTypeClass
x(15)
PaperCount
9(7)
Account Rule
RuleCarrierID
x(12)
CarrierTypeID
x(8)
CarrierRateClassID
x(8)
AgeGroup
x(5)
ContractLength
9(5)
Subscriber information
[AccountNumber]
Subscriber’s ID.
[TransactionDate]
Date that complaint was entered.
[DeliveryFrequency]
Delivery schedule description.
[DeliveryMethod]
Subscriber’s delivery method.
[PublicationName]
Name of publication complaint was entered for.
[Edition]
Name of edition complaint was entered for.
[CurrentDateLabel]
“Paid Through”/ ”Renewal Date”
[ExpireDate]
Paid Through Date/Renewal Date
[NewDateLabel]
New “Paid Through”/ New “Renewal Date”
[PaysThruDate]
New Paid Through Date/New Renewal Date
[PaymentTerm]
Payment term selected by user
[PaymentType]
Payment type selected by user
[PaymentOption]
Payment option selected by user: CHECKING ACCOUNT or CREDIT CARD
[BankRoutingNumber]
Bank routing number
[PaymentAccountNumber]
Subscription.SubscriptionID
[CardExpireDate]
Expiration date
[PaymentAccountHolderName]
Account holder name
[PastDueAmount]
Calculated past-due amount (if not zero)
[PastDueTax]
Past due tax amount
[PastDueDeliveryFee]
Past due delivery fee
[PastDueTotal]
Total past due amount
[PastDueBlurb]
Blurb is displayed when past due exists
[TermCost]
Payment term cost
[TermTaxCost]
Payment term tax cost
[TermDeliveryFee]
Payment term delivery fee
[TermTotal]
Payment term total amount
[TermConditions]
Payment conditions
[PremiumTotalDesc]
Premium day description
[Coupon]
Coupon amount applied
[AdjustmentLabel]
Payment adjustment, if any
[AdjustmentAmount]
Payment adjustment amount (if not zero), such as NIE
[TipAmount]
Tip amount (if not zero)
[Total]
Calculated total amount (subscription cost + NIE donation + tip)
[Authorization]
Credit card authorization
{TermsConditions}
Defined in Blurb Setup; will vary depending on whether the transaction is auto-renew or single payment, and whether a bank account or credit card was used.
iServices Subscriber URLs (if necessary also append "site" parameter)
[ImagePath]
Directory containing images (e.g. logo - header.jpg).
Amount
Payment amount
Business Unit
Newspaper business unit
Direct Sales Indicator
Direct sales indicator (“1” if over 5,000 in sales, otherwise blank)
Filler
Linefeed
Literal Value
Tax ID Number
Transmitter’s TIN or SSN (Federal ID number prompted for on 1099 screen)
Vendor ID
Payer’s account number (account’s vendor ID)
Vendor Prefix
The prefix is defined in Business Rules: What is the prefix used for vendors when interfacing to the PeopleSoft accounting system? (General section)
Withholding Class
1099 withholding class. If the carrier has amounts in both box 3 and box 7, separate records will be exported.
Withholding Type
1099 withholding type (“IRS” for interest 1099s or “FED” for miscellaneous).
1 | RateCodeID | x(20) | yes |
2 | RateType | x(8) | yes |
3 | StartDate | 99/99/9999 | yes |
4 | EndDate | 99/99/9999 | yes |
5 | Description | x(30) | no |
6 | NextRateCodeID | x(20) | yes |
7 | TurnoverRateCodeID | x(20) | yes |
8 | AllowPreviousDelivery | y/n | yes |
9 | MarketingTerm | x(8) | no |
10 | MarketingLength | >>>9- | no |
11 | AAMPriceLevelID | x(8) | yes |
12 | BalanceForwardRate | y/n | yes |
13 | IsRefundable | y/n | yes |
14 | MinPeriodRequired | y/n | yes |
15 | Combo ID (optional) | x(8) | no |
16 | Digital Restate Type | x(12) | yes. Valid options: “All Digital”, “One Digital”, “None” |
17 | Digital Draw Type | x(17) | yes. Valid options: “Standard”, “Best Digital Only”, “Unpaid”, “None” |
18 | Incld In Bonus Day | y/n | yes |
1 | RateCodeID | x(20) | yes |
2 | CompanyID | x(4) | yes |
3 | ProductID | x(8) | yes |
4 | DistribMethod | x(8) | yes |
5 | AAMZoneID | x(6) | yes |
6 | AreaID | x(8) | yes |
7 | RegionID | x(8) | yes |
8 | DistribZoneID | x(8) | yes |
9 | DistrictID | x(8) | yes |
10 | DeliveryScheduleID | x(8) | yes |
11 | * DiscountGLAccountID | x(40) | yes |
1 | RateCodeID | x(20) | yes |
2 | PaymentLength | >>>9- | yes |
3 | PaymentTerm | x(8) | yes. Valid options: “Year”, “Quarter”, “Month”, “Week”, “Day” (day pass only) |
4 | StartDate | 99/99/9999 | yes |
5 | EndDate | 99/99/9999 | yes |
6 | Amount | >>,>>>,>>9.99- | yes |
7 | *AmountByDay | >>,>>>.99 | yes |
8 | *PercentByDay | >>>.999999 | yes |
9 | *ExtraCostByDay | >>>>>.999999 | yes |
10 | ShowOnInvoice | x(8) | yes. Valid options: “Always”, “Never”, “Previous” |
11 | ShowOnRenewal | x(8) |
|
12 | FullVacPacDays | >>>9 | yes |
13 | HalfVacPacDays | >>>9 | yes |
14 | MaximumVacPacAmount | >>,>>>,>>9.99- | yes |
* In the Discount Rate Code and Rate Terms files; these fields are defined as arrays and have array elements 1 – 7 that correspond to each day of the week: Sun – Sat (1-7). For example: DiscountGLAccountID[1], DiscountGLAccountID[2], DiscountGLAccountID[3], DiscountGLAccountID[4], DiscountGLAccountID[5], DiscountGLAccountID[6], DiscountGLAccountID[7]. |
|
|
1 | RateCodeID | x(20) | yes |
2 | PaymentLength | >>>9- | yes |
3 | PaymentTerm | x(8) | yes |
4 | StartDate | 99/99/9999 | yes |
5 | EndDate | 99/99/9999 | yes |
6 | ProductID | x(8) | yes |
7 | DeliveryMethod | x(8) | yes |
8 | DeliveryScheduleID | x(8) | yes |
9 | *AmountByDay | >>,>>>.99 | yes |
* This field is defined as an array and has array elements 1 – 7 that correspond to each day of the week: Sun – Sat (1-7). For example: AmountByDay[1], AmountByDay[2], AmountByDay[3], AmountByDay[4], AmountByDay[5], AmountByDay[6], AmountByDay[7]. |
|
|
1 | Auto Pay Type | x(20) | yes. This will always be “AutoRenewBillingTerm” |
2 | RateCodeID | x(20) | yes |
3 | BillLength | >>>9- | yes |
4 | BillTerm | x(8) | yes |
5 | StartDate | 99/99/9999 | yes |
6 | EndDate | 99/99/9999 | yes |
7 | Amount | >>,>>>,>>9.99- | yes |
1 | Auto Pay Type | x(20) | yes. This will always be “AutoRenewBillingTermByPM” |
2 | RateCodeID | x(20) | yes |
3 | BillLength | >>>9- | yes |
4 | BillTerm | x(8) | yes |
5 | StartDate | 99/99/9999 | yes |
6 | EndDate | 99/99/9999 | yes |
7 | ProductID | x(8) | yes |
8 | DeliveryMethod | x(8) | yes |
9 | DeliveryScheduleID | x(8) | yes |
10 | Amount | >>,>>>,>>9.99- | yes |
1 | RulePublicationID | x(12) | yes |
2 | RuleSubscriptionID | x(12) | yes |
3 | RuleOccupantID | x(12) | yes |
4 | RulePaymentID | x(12) | yes |
5 | RuleLocationID | x(12) | yes |
6 | StartDate | 99/99/9999 | yes |
7 | EndDate | 99/99/9999 | yes |
8 | RateCodeID | x(20) | yes |
1 | RuleSubscriptionID | x(12) | yes |
2 | DeliveryType | x(8) | yes |
3 | SourceCode | x(8) | yes |
4 | DeliveryScheduleID | x(8) | yes |
5 | ReasonCode | x(8) | yes |
6 | DaysStopped | >>>9 | yes |
1 | ReasonCode | x(8) | yes |
2 | StartDate | 99/99/9999 | yes |
3 | EndDate | 99/99/9999 | yes |
4 | RequireRemark | y/n | yes |
5 | Description | x(30) | yes |
6 | UpdateDraw | y/n | yes |
7 | PrintOnBundle | y/n | yes |
8 | PrintCodeOnBundle | y/n | yes |
1 | RuleLocationID | x(12) | yes |
2 | RouteID | x(8) | yes |
3 | DistrictID | x(8) | yes |
4 | SubscriptionRateClassID | x(8) | yes |
5 | CensusTractID | 999999.99 | yes |
6 | DwellingTypeID | x(10) | yes |
7 | AAMZoneID | x(6) | yes |
8 | CityID | x(28) | yes |
9 | CountyID | x(25) | yes |
10 | StateID | x(3) | yes |
11 | CountryID | x(3) | yes |
12 | ZipCode | x(5) | yes |
13 | ZipExtension | x(4) | yes |
14 | DeliveryPlacementID | x(8) | yes |
15 | DeliveryAddressType | x(8) | yes |
1 | RuleOccupantID | x(12) | yes |
2 | OccupantTypeID | x(15) | yes |
1 | RulePaymentID | x(12) | yes |
2 | PaymentType | x(22) | yes. Valid values: “Credit Card Auto Renew”, “Bank Draft Auto Renew”, “*” |
1 | SubscriptionRateClassID | x(8) | yes |
2 | Description | x(30) | no |
1 | RateCodeID | x(20) | yes |
2 | StartDate | 99/99/9999 | yes |
3 | EndDate | 99/99/9999 | yes |
4 | FixedEndDate | 99/99/9999 | yes |
5 | StopSourceCode | x(8) | yes |
6 | StopReasonCode | x(8) | yes |
7 | DonationCode | x(8) | yes |
1 | RateCodeID | x(20) | yes |
2 | PaymentLength | >>>9- | yes |
3 | PaymentTerm | x(8) | yes |
4 | RewardID | x(12) | yes |
5 | OfferCodeID | x(8) | yes |
6 | StartDate | 99/99/9999 | yes |
7 | EndDate | 99/99/9999 | yes |
8 | RewardAmount | >>>9- | yes |
9 | AutoRenewReward | >>>9- | yes |
1 | TranTypeID | x(12) | yes |
2 | ReasonCode | x(8) | yes |
3 | SourceCode | x(8) | yes |
4 | StartDate | 99/99/9999 | yes |
5 | EndDate | 99/99/9999 | no |
Field # | Field | Format | Required |
1 | ProductID | x(8) | yes |
2 | TranTypeID | x(12) | yes |
3 | ReasonCode | x(8) | yes |
4 | ZipCode | x(5) | yes |
5 | ZipExtension | x(4) | yes “*” is exported if field is not used with transaction type |
6 | AreaID | x(8) | yes “*” is exported if field is not used with transaction type |
7 | RegionID | x(8) | yes “*” is exported if field is not used with transaction type |
8 | DistribZoneID | x(8) | yes “*” is exported if field is not used with transaction type |
9 | DistrictID | x(8) | yes “*” is exported if field is not used with transaction type |
10 | StartDate | 99/99/9999 | yes |
11 | EndDate | 99/99/9999 | no |
12 | GLAccountID | x(40) | no |
13 | Reminder | x(30) | no |
14 | GenerateArrearsCCInvoice | x(12) | yes Valid values: “Before Batch”, “After Batch”, “Both”, “Never”. |
15 | GenerateAdvanceCCInvoice | x(12) | yes Valid values: “Before Batch”, “After Batch”, “Both”, “Never”. |
16 | PrintOnRenewal | x(8) | yes. Valid values: “Never”, “Summary”, “Detail”. |
17 | RenewalDescription | x(30) | no |
18 | ApplyVacationRules | y/n | yes |
Account Holder Name | The name on bank or credit card account. |
Account ID | The ID of the account. |
Authorization Number | Authorization number for authorized credit card transactions. |
Balance Due | The balance due. |
Batch Payment Total | Total of all payments in the batch. |
Batch Record Count | Number of records in the batch. |
Bill Source ID | The bill source (group of accounts being billed together, such as Carrier, Dealer, NIE). |
Cash Batch Date | Date of the batch. |
Check Number | Number on the check. |
Comments | Comments for the batch. |
Company Number | Company number. |
Credit Card Expires | Expire date of credit card. |
Credit Card Number | Credit card number, if account paid with credit card. |
Credit Card Type | The credit card type (Visa, MasterCard, etc.) |
Credit Card Vault ID | Vault ID used only for off-site credit card storage |
File Payment Total | Payment total in the file. |
File Record Count | The total number of records in the file. |
Filler | Filler denotes blank fields or information that will not be used in Circulation; these fields will be ignored. |
Invoice Date | Date of the invoice. |
Invoice Number | Number of the invoice. |
Lockbox ID | ID of the lockbox. |
Masked Credit Card Number | Credit card number with all but the last four digits masked (replaced with “*”). Used only for off-site credit card storage. |
Payment Amount* | Amount of the payment. |
Payment Date | Date of the payment. |
Payment Type | The type of payment (credit card, check, etc.) |
Record Identifier** | Field that identifies the record type, for example “D” to indicate a detail record. This must be the first field in the record. |
Route ID | The ID of the route. |
Scan Line Check Digit | Check digit of the lockbox scan line. |
Signature File Name | File name of the signature image from Syncronex. |
Use Credit Card On File | Y/N flag to use the credit card number in the account record. |
Accuracy Factor | 8-character accuracy factor of latitude and longitude. |
Additional (Geographic) Data** |
|
Address ID* | 10-digit sequentially assigned number used to uniquely identify the record. |
Address Lines 1-6 | The address in “unparsed” format, lines 1 through 6. |
Address Sort | Defines the sort order of an address within the postal code and extension. |
Building | Building name. |
Census Block ID | Census block identifier. |
Census Tract ID | Census tract identifier. |
City ID | City. |
Cleanse | Address’s cleans setting (Y/N). |
Cleanse Data Date | Cleanse data. |
Cleanse Date |
|
Cleanse Score |
|
Cleanse Time |
|
Cleanse User |
|
Complex | Complex name. |
Congressional District | Congressional district of the address. |
Country ID | Country. |
County ID | County. |
Create Date | Record create information. |
Create Time |
|
Create User |
|
Dbl Dependent Locality** |
|
Delivery Office Number** |
|
Delivery Point ID |
|
Department 1** |
|
Department 2** |
|
Dependent Locality** |
|
Dependent Thoroughfare** |
|
Directions To Address | Directions to the address. |
Dual Address | Whether this is a dual address. |
Dwelling Status Date | Date on which the dwelling status was verified. |
Dwelling Status ID | The dwelling status. |
Dwelling Type ID | The dwelling type. |
Filler | Available only for the Address Export. |
Function* | A (add), C (change), or D (delete). Available only for the Address Import. |
House Number | The house number. |
House Number Modifier | The modifier of the house number. |
INSEE Code** |
|
Language | The language ID. |
Latitude | Latitude location of the address. |
Level Designator ID | The level (e.g., floor) |
Level Number | The level number |
Line Feed | Available only for the Address Export. |
Literal Value | Available only for the Address Export. |
Longitude | Longitude location of the address. |
Lot | Lot number. |
Lot Sequence | Lot sequence. |
Mail Accessible | Whether this address is mail accessible. |
Military Foreign 1 | First address line for military or foreign addresses. |
Military Foreign 2 | Second address line for military or foreign addresses. |
Modify Date | Record modify information. |
Modify Time |
|
Modify User |
|
Non (Postally) Required Locality** |
|
Odd Even | Odd or even side of the street |
Organization |
|
PO Route Number, PO Route Type, PO Route Walk Sequence | Address post office route number, type and walk sequence. |
PO Route Type, |
|
PO Route Walk Sequence |
|
Post Directional | Street name post-modifier, such as the “N” in “Main St N”. |
Pre Directional | Street name pre-modifier, such as the “N” in “N Main St”. |
Prev Zip Code | Previous Zip code. Available only for the Address Import. |
Prev Zip Extension | Previous Zip code extension. Available only for the Address Import. |
Route Accessible | Indicates if this address is accessible by circulation carriers for the delivery of publications and products. |
State ID | The state. |
Street Name | The street name (e.g., “Main”) |
Street Suffix ID | The street suffix (e.g., “North”) |
Sub-Building Name** |
|
Town of 25 ID | The town of 25. |
Unit Designator ID | The unit designator (e.g., “Apt.”) |
Unit Number | The unit number (e.g., the “135” in “Apt. 135”) |
ZIP Bar Code, ZIP Code, ZIP Extension | Zip code, Zip code + 4, and Zip bar code. |
The following data elements can be used with the “1099FormsExport” usage. This usage or the 1099 Export usage can be used to export 1099 reporting information in the 1099 Forms option.
The 1099 Forms can be exported in three formats: 1099-INT, 1099-Misc, and 1099-NEC. The interest income received report is exported using Form 1099-INT. Miscellaneous income is exported using Form 1099-Misc. The nonemployee compensation report is exported using Form 1099-NEC.
The following data elements can be used with the “AccountStatement” usage.
The following data elements can be used with the “ALTDrawAdjImprt” usage.
* Field is required.
The following data elements can be used with the “AltDrawChgImprt” usage.
* Field is required.
File maps used for the Audit GL Transactions export have a usage of “AuditGLTrans,” and the following data elements can be used:
Data Element | Description |
---|---|
Data Element |
---|
Data Element |
---|
Data Element |
---|
Data Element | Description |
---|---|
BondInterest-Box3
Bond interest amount (prints in Box 3)
Business Address Line 1 Business Address Line 2 etc.
The business address (lines 1-6) is exported by these elements
Business Phone
Business phone number
Filler
InterestIncome-Box1
Interest income amount (prints in Box 1)
Linefeed
Literal Value
NonEmployeeComp-Box7
Non-employee compensation amount (prints in Box 7)
OtherIncome-Box3
Other income amount (prints in Box 3)
PayerFederalIDNumber
Federal ID number specified when running the export
RecipientAccountNumber
Account’s vendor ID
RecipientCity
This and the following fields contain information about the account (carrier)
RecipientCityStateZip
RecipientName
RecipientState
RecipientStreetAddress
RecipientTaxIDNumber
Tax ID number specified for account
RecipientZip
Resale-Box9
Resale amount (prints in Box 9)
StateNumber
State number specified when running the export
BusinessAddressLine1
BusinessAddressLine2
BusinessAddressLine3
BusinessAddressLine4
BusinessPhone
PayerFederalIDNumber
RecipientTaxIDNumber
RecipientName
RecipientStreetAddress
RecipientCityStateZip
RecipientAccountNumber
InterestIncome-Box1
BondInterest-Box3
StateNumber
BusinessAddressLine1
BusinessAddressLine2
BusinessAddressLine3
BusinessAddressLine4
BusinessPhone
PayerFederalIDNumber
RecipientTaxIDNumber
RecipientName
RecipientStreetAddress
RecipientCityStateZip
RecipientAccountNumber
OtherIncome-Box3
NonEmployeeComp-Box7
Resale-Box9
BusinessAddressLine1
BusinessAddressLine2
BusinessAddressLine3
BusinessAddressLine4
BusinessPhone
PayerFederalIDNumber
RecipientTaxIDNumber
RecipientName
RecipientStreetAddress
RecipientCityStateZip
RecipientAccountNumber
NonEmployeeComp-Box1
StateNumber
Account Group Address Line (1-6)
Address associated with the account group.
Account Group ID
The account group to which the account belongs.
Account ID
The ID of the account.
Age Balance
The balance due for an aging period.
Age Current
The current balance due.
Age Periods 1-4
Up to four aging periods can be included.
Age Unapplied
The unapplied amount for an aging period.
Area Code
Area code portion of the account’s phone number.
Area ID
The ID of the bill area.
Balance Type
Indicates if the account has a credit, debit, or zero balance.
Bill Source ID
The bill source (group of accounts being billed together, such as Carrier, Dealer, NIE).
Building
The building identifier, such as “Building 212”.
Charges Detail (Parent Element)
Details about a charge (parent element). Also from the following child elements: Account ID, Amount, Bill Batch ID, Carrier ID, Charge Batch ID, Charge Code ID, Charge Date, Charge Type ID, Delivery Route ID, Delivery Schedule ID, Description, Entity ID, Entity Type, GL Account ID, Line Feed, Literal Value, Product ID, Quantity, Rate Code ID, Remarks, Retail Amount, Reversal, Route ID, Route Name, Transportation GL Account ID, and Unit Rate.
City ID
The city.
CollectorID
ID of the collector assigned to the account.
Company ID
The ID of the company.
Complex
The name of the complex, such as “Oak Park Apartments”.
Country ID
The country.
County ID
The county.
Credit Card On File
Indicates whether the account has a credit card number on file.
Distrib Zone ID
ID of the distribution zone.
District ID
ID of the district.
Drop Order
Drop order.
Extension
The local extension of the phone number.
First Name
The first name on the account.
Historical Aging Detail
Aging detail (parent element). Also choose from the following child elements: Account ID, Age Balance, Age Current, Age Period 1-12, Age Unapplied, Bill Date, Bill Source ID, Company ID, Last Bill Amount, Last Bill Date, Line Feed, and Literal Value.
Honorific ID
Occupant’s honorific (name suffix)
House Number
The house number for this address, such as “103” for the address “103 Main Street”.
House Number Modifier
Modifier of the house number, like “½” in the address “103 ½ Main St”.
Invoice Detail
Invoice detail (parent element). Also choose from the following child elements: Account ID, Balance Due, Bill Batch ID, Bill Source ID, Company ID, Discount Amount, Discount Date, Due Date, Invoice Date, Invoice Number, Line Feed, Literal Value, and Original Amount.
Last Name
The account’s last name.
Line Feed
A line feed to start a new line.
Literal Value
A literal value.
Location
Description of the location.
Middle Initial
Occupant’s middle initial.
Name Address Lines 1-6
Up to six lines of name and address information in an unparsed format.
Occupant Salutation ID
Occupant’s title, such as “Mr.”
Other Name
Account’s other name
Other Name Usage
Account’s other name usage
Payment Detail
Details about a payment (parent element). Also select from the following child elements: Account ID, Adjustment Amount, Adjustment ID, Bank ID, Bill Batch ID, Bill Source ID, Cash Amount, Cash Batch ID, Check Number, Company ID, Discount Amount, Invoice Number, Line Feed, Literal Value, Lockbox ID, Payment Amount, Payment Date, Payment Method, Tran Type, and Unapplied Amount.
Phone
The account’s phone number.
Post Directional
Street name post-modifier, such as the “N” in “Main St N”.
Pre Directional
Street name pre-modifier, such as the “N” in “N Main St”.
Product ID
ID of the product.
Region ID
ID of the region.
Remit To Address Lines 1-7
The remit-to address.
Route ID
ID of the route.
Route Name
Name of the route.
Run Date
Date of the export.
State ID
The state.
Street Name
Street name for this address, such as “Main” for the “103 Main Street” address. This will be the PO box if the address has one.
Street Suffix ID
The suffix street direction, such as “N” in “1234 Main St N”.
Truck ID
ID of the truck.
Truck Name
Name of the truck.
Truck Sequence ID
ID of the truck sequence.
Unit Designator ID
Enter the type of unit, such as Apt, Lot, Room, Suite.
Unit Number
The number of the unit, such as the “20” in “Apt 20”.
ZIP Bar Code, ZIP Code, ZIP Extension
Zip code, Zip code + 4, and Zip bar code.
Barcode | House Returns |
Branch Name | Identification Number * |
Claim Reference | Line Sequence |
Customer Identifier | Record Identifier |
Customer Name | Supplier Identifier |
Draw Adjustment | Supplier Name |
Draw Class ID | Trade Returns |
Draw Date | Version Number |
File Date | Week Number |
Filler | Year |
Generation Number |
|
Adjust Or Replace |
Barcode |
Draw Change Amount [Sun-Sat] |
Draw Type Class |
Effective Date |
Filler |
Identification Number* |
Record Identifier |
Reversal Date |
Amount | GL Account ID | Payment Or Refund Type |
Source Code | Authorization Number | GL Batch ID |
Posted | Source Code Description | Comments |
GL Company ID | Posted Batch ID | Source Field [1-10] |
Create Date | GL Tran Date | Posted Date |
Source Key [1-10] | Create Time | GL Tran Number |
Reason Code | Source Table | Create User |
Journal Code | Reason Code Description | Source Tran Number |
Credit Card Type | Line Feed | Reference Entity ID |
Source Transaction | Filler | Literal Value |
Reference Entity Type | Subscription ID | Fiscal Period |
Memo | Set Number | Suspended |
Fiscal Year |
The “AuthImport” file mapping usage is used with this option. The possible data elements are described in the following table.
* Field is required.
The following data elements can be used with the “BASREconcilSumm” usage.
* Field is required.
The following data elements can be used with the “BalanceFwdBill” usage.
The following data elements can be used with the “BASReconcilDtl” usage.
* Field is required.
The following data elements can be used with the “BundleTops” usage.
The following data elements can be used with the “CarrierMailExp” usage.
Data Element | Description |
---|---|
Data Element | Description |
---|---|
Data Element | Description |
---|---|
Data Element | Description |
---|---|
Data Element | Description |
---|
OccupantID
Recommended. The ID of the occupant accessing the subscription.
AuthDate*
Required. The date of the authentication.
AuthTime
Recommended. The time of the authentication.
AuthOnly
“Yes” or “No.” Must be set to “Yes” if authentication information is used for AAM purposes. If this data element is not included in the file map, its value will be set to “Yes” automatically when imported into Circulation.
AuthType*
Required. The authentication integration used, such as the online content vendor: “Tecnavia,” “Pressmart,” “Standard,” “Saxotech,” etc.
AuthControl
Must be a valid authentication control ID (set up in CMO Setup). If this data element is not included in the file map, the user will be prompted to enter it when running the Authentication Import option.
AuthenticationReason
Optional. Reason authentication was performed, such as “Paymeter”.
AuthProductList
A comma-separated list of Circulation product IDs that limits authentication to subscribers receiving at least one of the specified products.
SubscriptionID
The ID of the subscription being accessed. If only an occupant ID is supplied, Circulation will use the Authentication Detail records defined for the authentication control to determine which subscription was accessed.
Amount
Amount
BAS Category*
BAS category
Quantity
Quantity
Balance Forward Amount
Country Tax Message
Payment Detail
Balance Forward Date
County Tax Amount
Publication Name
Billed Through Date
County Tax Message
Purchase Order Number
Bill To Address 1
Deliver To Address 1
Rate Amount
Bill To Address 2
Deliver To Address 2
Rate Amount Before Tax
Bill To Address 3
Deliver To Address 3
Rate Code ID
Bill To Delivery Point Code
Deliver To Delivery Point Code
Rate Code Message
Bill To Indicator
Deliver To Name
Rate Description
Bill To Name
Deliver To Zip
Renewal Number
Bill To Postal Route
Deliver To Zip Extension
Renewal Period Message 1
Bill To Zip
Delivery Route
Renewal Period Message 2
Bill To Zip Extension
Delivery Schedule ID
Run Date
Carrier Name
Due When
Scan Line
Carrier Primary Phone
Expire Change Detail
Start Reason
City Tax Amount
Expire Date
State Tax Amount
City Tax Message
General Message
State Tax Message
Copy Message 1
Line Feed
Subscription ID
Copy Message 2
Literal Value
Subscription Primary Phone
Country Tax Amount
Payment Adjustment Detail
Total Amount Due
Account ID
Account ID
Amount
Amount
BAS Category*
BAS category
Charge Code Description
Description of charge code
Charge Code ID
ID of charge code
Charge Date
Date of the charge
Charge Type
Type of charge
City Tax Amount
Tax amount for city
City Tax Authority
Tax authority for city
City Tax Change
Change in city tax
City Tax Exempt Chg
Tax exempt change for city
City Tax Exempt Reason
Reason for tax exempt change
Country Tax Amount
Tax amount for country
Country Tax Authority
Tax authority for country
Country Tax Change
Change in country tax
Country Tax Exempt Chg
Tax exempt change for country
Country Tax Exempt Reason
Reason for tax exempt change
County Tax Amount
Tax amount for county
County Tax Authority
Tax authority for county
County Tax Change
Change in county tax
County Tax Exempt Chg
Tax exempt change for county
County Tax Exempt Reason
Reason for tax exempt change
Product ID
ID of the product
Quantity
Quantity
Route ID
ID of the route
State Tax Amount
Tax amount for state
State Tax Authority
Tax authority for state
State Tax Change
Change in state tax
State Tax Exempt Chg
Tax exempt change for state
State Tax Exempt Reason
Reason for tax exempt change
Transaction Reference
Reference number
Unit Rate
Rate per unit
Account ID
Account ID
Account Name
Account’s name
Account Phone Number
Account’s phone number
Additional Product Detail
AccountID, AccountName, AccountPhoneNumber, AdditionalProductID, AdZoneID, DepartureID, Description, DistribTypeMessage, DropLocationLine [1-6], DropOrder, EditionID, GeneralMessage, InsertMix, LineFeed, LiteralValue, ProductID, PublicationName, PublishDate, RouteID, RouteName, StandardSize, SupplyingTruckID, TotalDraw
Advance Draw Detail
ComboCode, ComponentRouteID, DrawTotal, KeyBundleSize, NumberOfStandardBundles, PaperSectionID, StandardBundleSize
Advance Sections
Number of advance sections
AdZoneID
Ad zone ID
Barcode
The 15-digit barcode
Bulk [Route]
The route’s bulk value from Distribution Maintenance.
Bundle Method
The bundle method
Carrier Collect Draw
Carrier collect draw
Combined Draw Detail
ComponentRouteID, DrawClassID, DrawClassTotal, DrawTotal, KeyBundleSize, NumberOfStandardBundles
CombinedPublGroupDrawDetail
AccountID, AccountName, AccountPhoneNumber, AdZoneID, BundleMethod, ComponentProductID, ComponentPublicationName, DepartureID, DistribTypeMessage, DrawTotal, DropLocationLine [1-6], EditionID, GeneralMessage, InsertMix, KeyBundleSize, LabeledBundles, LineFeed, LiteralValue, MaximumBundleSize, MinimumBundleSize, MultiPackID, NumberOfBundles, NumberOfStandardBundles, ProductID, PublicationName, PublishDate, RouteID, SecondKeyBundleSize, StandardBundleSize, StandardWeight, TruckID, TruckSequenceID, Weight
Component Route Name
The route name, when multiple routes are combined
Departure ID
The truck departure
Distrib Type Message
Route, motor, or single copy message entered in Bundle Info
Draw Comparison
MonthlyAverageLastYear, MonthlyAveragePercentChange, MonthlyAverageQuantityChange, MonthlyAverageThisYear, Weekday, YTDAverageLastYear, YTDAveragePercentChange, YTDAverageQuantityChange, YTDAverageThisYear
Draw Total
Total draw
Drop Location (Lines 1-7)
Drop address (lines 1-6) and drop instructions (line 7)
Drop Order
Drop order
Edition ID
Edition ID
Final Mix
The insert mix name and combo code
General Message
“All” message entered in Bundle Info.
Insert Detail
CustomerName
Insert Mix
Name of the insert mix.
Key Bundle Size
Size of key bundle.
Labeled Bundles
Number of labeled bundles.
Line Feed
A line feed to start a new line.
Literal Value
Literal fields are hard-coded to display whatever is entered in “format”. For example, if a field should always display “Z”, set it up as a literal value and enter “Z” in FORMAT.
Maximum Bundle Size
The maximum size of bundles.
Message Detail
BillingMethod, ComponentProductID, ComponentRouteID, Copies, DeliveryInstructions, DeliveryScheduleID, ExpireDate, MessageDate, MessageText, MessageType, NameAddressLine(1-6), Reason, RestartDate, SubscriberPhoneNumber, SubscriptionID
Message Recap
BillingMethod, ComponentProductID, Copies, DeliveryScheduleID, MessageType
Minimum Bundle Size
The minimum size of bundles.
Number of Bundles
The total number of bundles.
Number of Standard Bundles
The number of standard bundles.
Office Pay Draw
Total office pay draw.
Paid Comp Draw
Total paid comp draw.
Print Key Bundles Only
Print Key Bundles Only field in Enter Bundle Info.
Print Key Bundles Only [Route]
The route’s Print Key Bundle Only value from Distribution Maintenance.
Product ID
ID of the product.
Publication Name
Name of the publication.
Publish Date
The publishing date.
Remarks
Remarks about the subscription.
Route ID
The ID of the route.
Route List
AdditionalProducts, Copies, DeliveryDirections, DeliveryInstructions, NameAddressLine (1-6)
Route Name
The name of the route.
Sample Draw
Total sample draw.
Second Key Bundle Size
If bundle tops are run with a split key, this is the size of the additional key bundle that will be produced.
Service Draw
Total service draw.
Stacker Detail Lines 1-7
Stacker detail lines from Distribution Maintenance.
Standard Bundle Size
The standard bundle size.
Supplying Truck ID
ID of the supplying truck.
Third Party Draw
Total third party draw.
Truck ID
The ID of the truck.
Truck Sequence ID
Truck sequence.
Unpaid Comp Draw
Total unpaid comp draw.
Week Number
The week’s number.
Weight
Total weight.
Wrapper Detail
BundleNumber, BundleSize, CarrierCollectDraw, DrawTotal, KeyBundleSize, NumberOfBundles, NumberOfStandardBundles, OfficePayDraw, PaidCompDraw, SampleDraw, SecondKeyBundleSize, ServiceDraw, StandardBundleSize, ThirdPartyDraw, UnpaidCompDraw, WrapNumber
Year
The year.
Account ID | The ID of the account. |
Account Name | Account’s name |
Account Phone Number | Account’s phone number |
Ad Zone ID | Ad zone ID |
All Message | “All” message entered in Bundle Info. |
Billing Method | Account’s billing method |
Building | Address’ building |
Carrier Notification ID | ID of the account notification method |
City ID | City |
Complex | Address’ complex |
Component Product ID | ID of the component product, if part of a combined publication. Same as the Product ID if there is no combined publication. |
Component Route ID | Route ID associated with the component product, if part of a combined publication. Same as the Route ID if there is no combined publication. |
Copies | Number of copies |
Copies [day of week] | Copies by day of the week |
Create Date Create Time Create User | Date, time and user information for the message |
Delivery Instructions | Instructions for delivering the paper to the subscriber |
Delivery Schedule ID | ID of the delivery schedule |
Directions to Address | Directions to the subscriber’s address |
Distrib Type Message | Route, motor, or single copy message entered in Bundle Info |
Drop Location Line [1-6] | Drop location (lines 1-6) |
Drop Order | The drop order of the route on the truck |
Edition ID | The route’s edition |
Expire Date | Subscription expire date (for office pay subscribers) |
External Subscription ID | Subscriber’s ID for external publication |
First Name | Occupant’s first name |
Honorific ID | Occupant’s honorific |
House Number | Address house number |
House Number Modifier | Address’ house number modifier |
Insert Mix | Name of the insert mix |
Last Name | Occupant’s last name |
Level Designator ID | Address’ level type |
Level Number | Address’ level number |
Line Feed | A line feed to start a new line |
Literal Value | Literal fields are hard-coded to display whatever is entered in “format”. For example, if a field should always display “Z”, set it up as a literal value and enter “Z” in FORMAT. |
Message Date | Date of the message |
Message ID | ID of the message |
Message Label | Label of the message |
Message Text | Text of the message |
Message Type | Type of message |
Method Type | The type of notification method (e.g., phone type if notification method is phone) |
Middle Initial | Occupant’s middle initial |
Name Address Line [1-6] | These six lines can be used for the subscriber’s name and address, rather than using individual name and address elements. |
Notification Method | Type of account notification (email, phone, etc.) |
Notification Method Details | Specific phone number, email address, URL, etc. |
Occupant Salutation ID | The occupant’s title |
Other Name | Occupant’s other name |
Permanent | Indicates whether the reason code is permanent |
Postdirectional | Address postdirectional |
Predirectional | Address predirectional |
Primary Contract Holder | Setting of the Business Rule, What account demographic should be used for the Primary Contract Holder in the Vendor and Carrier Mail Exports? (Account Setup section). |
Product ID Publication Name | Subscriber’s publication ID and name |
Publish Date | Publishing date on which transaction was processed |
Rate Code ID | Subscriber’s rate code |
Rate Description | Description of subscriber’s rate code |
Reason | Reason code entered for transaction |
Restart Date | Subscriber’s restart date |
Route ID | ID of the route |
Route Name | Name of the route |
Source Code | Source code entered for the transaction |
State ID | State |
Street Name | Address street name |
Street Suffix ID | Street type |
Subscriber Phone Area Code | Area code of subscriber’s phone number (e.g., the 304 in 3045551234) |
Subscriber Phone Number | Subscriber’s phone number, including area code (e.g., 3045551234) |
Subscriber Phone Prefix and Line | Subscriber’s phone number, not including area code (e.g., 5551234) |
Subscription ID | Subscriber’s subscription ID |
Subsource ID | Subsource for source code entered with transaction. |
TM Product ID | ID of the TM product |
Tran Date | Transaction date for subscriber transaction. |
Tran Number | Transaction ID |
Tran Type ID | Transaction type |
Truck ID | ID of the truck |
Unit Designator ID | Address’ unit designator |
Unit Number | Address’ unit number |
Zip Code | Zip/postal code |
Zip Extension | Zip/postal extension |
The following data elements can be used with the “CleanseFlagExp” usage.
File maps used for the Import Campaign option have a usage “CampaignImp,” and the following data elements can be used. Required fields are indicated with an asterisk (*).
* Field is required.
The following fields are conditionally required and will produce errors if they are not present when expected:
TM Product ID, Reject Response, and Followup Response are required when the Allowable Usage is “Canvass.”
Parent Forecasted Responses and Parent Number Solicited are required when generating a new parent campaign (i.e., if it does not yet exist).
Start Type is required when the Tran Type ID is “Start.”
Delivery Schedule ID is required if the Tran Type is “Start,” “DelivSched,” or “DelivSched w/BillingChg.”
Term and Length are required if the allowable usage is “Renewals.”
The following data elements can be used with the “ComplaintSummary” usage.
* Field is required.
The following data elements can be used with the “CleanseFlagImp” usage.
* Field is required.
The following data elements can be used with the “ComplaintDetail” usage.
* Field is required.
Data Element |
---|
Account ID* | Days Adjust | Modify Time |
---|
Accuracy Factor
Directions To Address
Modify Date
Address ID
Dual Address
Modify Time
Address Sort
Dwelling Status Date
Modify User
Building
Dwelling Status ID
Odd Even
Can Drop Credit
Dwelling Type ID
PO Route Number
Census Block ID
Formatted Address Line [1-6]
PO Route Type
Census Tract ID
House Number
PO Route Walk Sequence
City ID
House Number Modifier
Post Directional
Cleanse
Language
Pre Directional
Cleanse Data Date
Latitude
Route Accessible
Cleanse Date
Level Designator ID
State ID
Cleanse Time
Level Number
Street Name
Cleanse User
Line Feed
Street Suffix ID
Complex
Literal Value
Town of 25 ID
Congressional District
Longitude
Unit Designator ID
Country ID
LOT
Unit Number
County ID
LOT Sequence
Zip Bar Code
Create Date
Mail Accessible
Zip Code
Create Time
Military Foreign
Zip Extension
Create User
Action*
Event Number
Reason Code*
Allowable Usage*
Followup Response
Reject Response
All Zip Codes*
Forecasted Responses
Renewal Delivery Method
Auto Assign
Image URL
Source Code*
Billing Method*
Is Searchable
Start Date*
Campaign Code*
Length
Start Email Parameters
Campaign Script
Lock Method
Start Type
Combo ID
Number Solicited
Sub Source ID
Confirmation Page Script
Parent Campaign Code*
Term
Cost Per Order
Parent Forecasted Responses
TM Product ID
Delivery Method*
Parent Number Solicited
Tran Type ID*
Delivery Schedule ID
Priority Order
Zip Code
Description
Product ID*
Zip Code List
End Date
Rate Code ID*
Account ID*
Account Name
Complaint Code*
District Manager
Number of Complaints*
Route ID*
Accuracy Factor | Directions To Address | Modify Date |
Address ID* | Dual Address | Modify Time |
Address Sort | Dwelling Status Date | Modify User |
Building | Dwelling Status ID | Odd Even |
Can Drop Credit | Dwelling Type ID | PO Route Number |
Census Block ID | Filler | PO Route Type |
Census Tract ID | Formatted Address Line [1-6] | PO Route Walk Sequence |
City ID | House Number | Post Directional |
Cleanse* | House Number Modifier | Pre Directional |
Cleanse Data Date | Language | Record Identifier |
Cleanse Date | Latitude | Route Accessible |
Cleanse Time | Level Designator ID | State ID |
Cleanse User | Level Number | Street Name |
Complex | Line Feed | Street Suffix ID |
Congressional District | Literal Value | Town of 25 ID |
Country ID | Longitude | Unit Designator ID |
County ID | LOT | Unit Number |
Create Date | LOT Sequence | Zip Bar Code |
Create Time | Mail Accessible | Zip Code |
Create User | Military Foreign | Zip Extension |
Account Name | Delivery Schedule ID | Modify User |
Address ID | Discount | Name Address Line [1-6] |
Bonus | Dispatch Date | Number of Complaints |
Bundle Print Date | Dispatch Time | Number of Formal Complaints |
Card Print Date | Dispatch User | Occupant ID |
Cause Code | District ID | Print For Carrier |
Charge Batch ID | District Manager | Redeliver |
Complaint Code ID | DM Call | Redeliver Instructions |
Complaint Date | External Subscription ID | Route ID* |
Complaint Text | Formal | Sequence Number |
Complaint Time | Formal Address ID | Source Code |
Compliance Date | Formal Complaint Date | Subscriber Phone |
Compliance Time | Formal Complaint Time | Subscription ID* |
Create Date | Formal Occupant ID | Tran Number |
Create Time | Modify Date | Urgent |
Create User |
|
|
The following data elements can be used with the “CommHistImport” usage.
The following data elements can be used with the “DispatchExport” usage.
The standard export file maps for the Dispatch Interface are given below. “Dispatch” is the standard format, and “DispatchPlus” is the standard format plus the Redelivery and Dispatch flags at the end.
The following data elements can be used with the “CCExpire” usage.
The following data elements can be used with the “DNCImport” usage.
* Field is required
The following data elements can be used with the “DoNotCall” usage.
* Field is required
Data Element | Description |
---|---|
SEQ | “Dispatch” | “DispatchPlus” |
---|---|---|
Data Element | Description |
---|
Data Element | Description |
---|
Communication Item ID
ID of communication item whose history is being imported.
Communication Method Details*
Occupant’s e-mail address, phone number or address for the communication item above.
Communication Method ID*
Occupant’s communication method (email, phone or mail).
Delivery Date
Date communication was sent to occupant.
Delivery Time
Time communication was sent to occupant.
Occupant ID*
ID of occupant receiving the communication.
AddressLine[1-6]
Dispatch Type
Page Modem Phone
Shortage Quantity
Carriage Return
District ID
Page To Area Code
State ID
Carrier ID
Filler
Page To Phone
Street Name
CityID
First Name
Post Directional
Street Suffix ID
Copies
House Number
Pre Directional
Subscriber Area Code
Create Date
House number Modifier
Product ID
Subscriber Phone
Create Time
Last Name
Reason Code
Subscription ID
Create User
Line Feed
Reason Desc
Tran Date
Delivery Directions
Literal Value
Redelivery
Unit Number
Delivery Request
Message Text
Redelivery Instructions
Unit Type
Delivery Schedule ID
Other Name
Route ID
Urgent
Dispatch
Overage Quantity
Service Area
Zip Code
DispatchID
Page Modem Area Code
10
Dispatch Type
Dispatch Type
20
Page Modem Area Code
Page Modem Area Code
30
Page Modem Phone
Page Modem Phone
40
Page To Area Code
Page To Area Code
50
Page To Phone
Page To Phone
60
Service Area
Service Area
70
District ID
District ID
80
Product ID
Product ID
90
Route ID
Route ID
100
Carrier ID
Carrier ID
110
Create Date
Create Date
120
Create Time
Create Time
130
Create User
Create User
140
Subscription ID
Subscription ID
150
Delivery Schedule ID
Delivery Schedule ID
160
Reason Code
Reason Code
170
Reason Desc
Reason Desc
180
Address Line 1
Address Line 1
190
Address Line 2
Address Line 2
200
Address Line 3
Address Line 3
210
Address Line 4
Address Line 4
220
Address Line 5
Address Line 5
230
Address Line 6
Address Line 6
240
Redelivery Instructions
Redelivery Instructions
250
Delivery Directions
Delivery Directions
260
Delivery Request
Delivery Request
270
Urgent
Urgent
280
Subscriber Area Code
Subscriber Area Code
290
Subscriber Phone
Subscriber Phone
300
Message Text
Message Text
310
Shortage Quantity
Shortage Quantity
320
Overage Quantity
Overage Quantity
330
Dispatch ID
Dispatch ID
340
Filler
350
Redelivery
360
Filler
370
Dispatch
AddressLine[1-4] | CreditCardExpires | OccFirstName |
BillAddressLine[1-4] | CreditCardExpiresMasked | OccLastName |
BillFirstName | CreditCardNumber | OccPhone |
BillLastName | CreditCardNumberMasked | PublicationName |
BillToCityID | CreditCardTypeID | StateID |
BillToStateID | Filler | SubscriptionID |
BillToZipCode | LineFeed | ZipBarCode |
BillToZipExtension | LiteralValue | ZipCode |
CityID | OccAreaCode | ZipExtension |
Action | Add or Delete flag (“A” or “D”), used in DNC changes file. |
Area Code* | Subscriber’s area code. |
Change Date | Change date, used in DNC changes file. |
Filler | Filler fields will be blank. |
Phone* | Subscriber’s phone number. |
Action | Add or Delete flag (“A” or “D”), used in DNC changes file. |
Area Code* | Subscriber’s area code. |
Change Date | Change date, used in DNC changes file. |
Filler | Filler fields will be blank. |
Phone* | Subscriber’s phone number. |
The following data elements can be used with the “DrawAdjImport” usage.
* Field is required
The following data elements can be used with the “DropCreditAudit” usage.
The following data elements can be used with the “DrwForecastExprt” usage.
The following data elements can be used with the “DrawChgImport” usage.
* Field is required
** Field is required if a record identifier is entered on the record type setup screen.
Data Element | Description |
---|---|
Data Element | Description |
---|
AAM Draw Date
The draw adjustment date for AAM reporting purposes. This will be the same as the Draw Date unless AAM has already been closed for the draw date.
Amount Collected
The amount collected from the route.
Control Total
Populates the Control Papers field in Returns for a Day and Returns for a Week.
Draw Adjustment
The draw adjustment quantity.
Draw Date
The publishing date for the returns.
Import Edition ID
The edition of the product that is being returned. Note: If ImportEditionID is included in the import file for draw adjustment transactions, it will be ignored upon import.
Product ID
The product that is being returned.
Record Identifier
Field that identifies the record type, for example “D” to indicate a detail record. This must be the first field in the record.
Route ID*
The ID of the route. This field is required.
Account Area Code
Account First Name
Account Formatted Phone
Account Honorific ID
Account ID
Account Last Name
Account Middle Initial
Account Name Address [1-6]
Account Other Name
Account Other Name Usage
Account Phone
Account Salutation ID
Address detail
Bill Account fields (same as account fields, above)
Bill Source Description
Bill Source ID
Company ID
Company Name
Line Feed
Literal Value
Process End Date
Process Start Date
Account ID
Drop Country ID
Export End Date
Address Line [1 - 6]
Drop County ID
Export Start Date
Area ID
Drop House Number
Filler
Demographic Answer
Drop House Number Modifier
Line Feed
Distribution Type
Drop Post Directional
Literal Value
Distrib Zone ID
Drop Pre Directional
Other Name
District ID
Drop State ID
Product ID
Draw Adjust Total
Drop Street Name
Region ID
Draw Class ID
Drop Street Suffix ID
Return Total
Draw Date
Drop Unit Designator ID
Route Class ID
Draw Total
Drop Unit Number
Route ID
Drop Address Line [1-6]
Drop Zip
Route Name
Drop City ID
Drop Zip Extension
Route Type ID
Edition ID
Truck ID
Adjust or Replace | Indicates whether the draw should be adjusted (increased or decreased) or replaced. |
Draw Change Amount (Mon-Sun) | The amount that the draw should be adjusted or replaced. Negative adjustments will have a minus (-) sign. |
Draw Type Class | The draw class. |
Effective Date | The first date that this draw change will be in effect. |
Filler | Filler fields will be blank. |
Product ID | The product to which this draw change applies. |
Record Identifier** | Field that identifies the record type, for example “D” to indicate a detail record. This must be the first field in the record. |
Reversal Date | The date on which the draw change should be reversed (may be blank). |
Route ID* | The ID of the route. |
File maps used for the Audit GL Interface Journal export have a usage of “GLAudit,” and the following data elements can be used:
* Field is required.
The following data elements can be used with the “DropTimeImport” usage.
* Field is required.
Amount
GLCompanyID*
Comments
GLTranDate
CreateDate
GLTranNumber*
CreateTime
JournalCode
CreateUser
Memo
CreditAmount
Posted
DebitAmount
PostedBatchID
FiscalPeriod
PostedDate
FiscalYear
ReferenceEntityID
GLAccountID*
ReferenceEntityType
GLBatchID
Suspended
Delivery Date |
Delivery Time |
Departure ID |
Drop Order |
Product ID |
Run Date |
Truck ID* |
Truck Sequence ID |
File maps used for the GL Interface Journal export have a usage of “GLInterJrnl,” and the following data elements can be used:
Amount | GLTranDate | OccupantTypeID |
Comments | GLTranNumber | OtherName |
DebitOrCredit | HonorificID | Posted |
DtCrAmount | JournalCode | PostedBatchID |
FirstName | LastName | PostedDate |
FiscalPeriod | Memo | ReferenceEntityID |
FiscalYear | MiddleInitial | ReferenceEntityType |
GLAccountID | OccupantID | SetNumber |
GLBatchID | OccupantSalutationID | Suspended |
GLCompanyID | OccupantTitle |
|
The following data elements can be used with the “MerchandiseRpt” usage.
File maps used for the GL Export have a usage of “GLExport,” and the following data elements can be used:
Account First Name
Bill To Street Name
Longitude
Account Honorific ID
Bill To Street Suffix ID
LOT
Account ID
Bill To Town Of 25 ID
LOT Sequence
Account Last Name
Bill To Unit Designator ID
Mail Accessible
Account Middle Initial
Bill To Unit Number
Merchandise Code
Account Occupant ID
Bill To Zip Bar Code
Middle Initial
Account Occupant Salutation ID
Bill To Zip Code
Military Foreign
Address ID
Bill To Zip Extension
Name Address Lines [1-6]
Billing Method
Campaign Code
Occupant ID
Bill To Address ID
Canvass Board Number
Occupant Type ID
Bill To Building
Carrier ID
Other Name
Bill To Census Block ID
Census Block ID
Other Name Usage
Bill To Census Tract ID
Census Tract ID
Payment Amount
Bill To City ID
City ID
Payment Term Length
Bill To Complex
Complex
PO Route Number
Bill To Congressional District
Congressional District
PO Route Type
Bill To Country ID
Country ID
PO Route Walk Sequence
Bill To County ID
County ID
Post Directional
Bill To Dwelling Status Date
Delivery Schedule ID
Pre Directional
Bill To Dwelling Status ID
Description
Process Date
Bill To Dwelling Type ID
Dwelling Status Date
Product ID
Bill To House Number
Dwelling Status ID
Reason Code
Bill To House Number Modifier
Dwelling Type ID
Route Accessible
Bill To Language
Email Address
Route ID
Bill To Latitude
First Name
Source Code
Bill To Level Designator ID
Formatted Phone
State ID
Bill To Level Number
Fulfillment Date
Street Name
Bill To Longitude
Honorific ID
Street Suffix ID
Bill To LOT
House Number
Subscription ID
Bill To LOT Sequence
House Number Modifier
Town of 25 ID
Bill To Mail Accessible
Language
Tran Date
Bill To Military Foreign
Last Name
Tran Type
Bill To Name Address Line [1-6]
Latitude
Unit Designator ID
Bill To PO Route Number
Level Designator ID
Unit Number
Bill To PO Route Type
Level Number
Zip Bar Code
Bill To PO Route Walk Sequence
Line Feed
Zip Code
Bill To State ID
Literal Value
Zip Extension
Amount | Fiscal Period YY | GL Transaction Posted Batch ID | Reference Entity Type |
Authorization Number | Fiscal Year | GL Transaction Posted Date | RollUpGLAccountID |
Chart of Accounts Description | GL Account ID | Journal Code | Set Number |
Comments | GL Account ID Char1-5 | Journal Code YYPP | Source Code |
Control Total Credits | GL Account ID Char7-11 | Line Feed | Source Code Description |
Control Total Debits | GL Account ID Char13-17 | Literal Value | Source Field [1-10] |
Create Date | GL Account ID Char19-22 | Memo | Source Key [1-10] |
Create Time | GL Batch ID | Payment Or Refund Type | Source Table |
Create User | GL Company ID | Process Start Date | Source Tran Number |
Credit Card Type | GL Journal Description | Process End Date | Source Transaction |
Filler | GL Tran Date | Reason Code | Subscription ID |
Fiscal Period | GL Tran Number | Reason Code Description | Suspended |
| GL Transaction Posted | Reference Entity ID | Total Journal Entries Exported |
The following data elements can be used with the “MiscChgCredImp” usage.
The following data elements can be used with the “NoteImport” usage.
* Field is required.
The following data elements can be used with the “PymtAuthor” usage.
* Field is required
** Field is required if a record identifier is entered on the record type setup screen.
The following data elements can be used with the “PastDueLetter” usage.
Data Element | Description |
---|
Data Element | Description |
---|
Data Element | Description |
---|
Data Element | Description |
---|
Account ID* | Carrier’s account ID |
Amount* | Charge/credit amount (format 9999.99) |
Charge Code ID | ID of miscellaneous charge/credit code used with charge |
Charge Date | Date of charge |
Description | Description of charge |
Draw Total | Draw of route associated with charge/credit |
Remarks | Remarks, if any, on the charge/credit |
Route ID | Route associated with charge/credit |
Filler | Filler fields will be blank. |
Reason | Reason code entered for the transaction |
Remarks* | Remarks, if any, on the note transaction. Field has a maximum of 2000 characters. |
Source | Source code entered for the transaction |
SubscriptionID* | Subscriber’s subscription ID |
TranDate | Transaction date for note transaction |
Abort Status | Indicates whether the payment was processed. |
Account Number | Account number for bank draft payments/declines. |
Address Verification | Indicates whether the subscriber’s address has been verified. |
Authorization Number | Payment authorization number, typically supplied for credit card payments. |
BACS Originator ID | Bank originator ID for draft payments/declines. |
Bank Number | Bank number for draft payments/declines. |
Batch Count | The total number of records in the batch. |
Batch Date | The date the batch was created. |
Batch Total | The total amount for the payment batch. |
Beginning Sequence | This data element is not currently used. |
Credit Card Number | The subscriber’s credit card number. |
Edgil ID | ID assigned to the payment by the Edgil system. |
Ending Sequence | This data element is not currently used. |
File Sequence | This data element is not currently used. |
Filler | Filler denotes blank fields or information that will not be used in Circulation; these fields will be ignored. |
Merchant ID | Credit card merchant ID |
Record Identifier** | Field that identifies the record type, for example “D” to indicate a detail record. This must be the first field in the record. |
Reference Number | Unique customer reference (could include account number). |
Remarks | Remarks. |
Response Message | Payment authorization response text. |
Subscription ID | Subscriber’s account ID in Circulation. |
Tran Amount* | Payment amount. |
Tran Code | Transaction code that describes the type of payment. |
Tran Date | Date of payment. |
Tran Number | Payment transaction number. |
Trans Sequence | This data element is not currently used. |
Tran Status | Status of payment (authorized, rejected, etc.). |
Account ID | The account ID of the carrier/dealer. |
Age Balance | The balance due for an aging period. |
Age Current | The current balance due. |
Age Periods 1-4 | Up to four aging periods can be included. |
Age Unapplied | The unapplied amount for an aging period. |
Allow Web Access | Allow web access setting (yes/no) |
Area Code | Area code portion of the account’s phone number. |
Attention Line | Occupant’s attention line. |
Collector ID | ID of the collector assigned to this account. |
Company Name | Name of the company. |
Delivery Date | The date the letter was delivered. |
Due Date | Date on which the balance is due. |
Due Day Name | Day of the week the balance is due. |
EMail Address | Occupant’s email address. |
Extension | Occupant’s phone number extension. |
Firm Name | Firm name, if other name usage is “Firm”. |
First Name | Occupant’s first name. |
Formatted Phone | Occupant’s formatted phone number. |
Honorific ID | Occupant’s honorific (name suffix) |
Last Bill Amount | Amount of the last bill. |
Last Bill Date | Date of the last bill. |
Last Invoice Date | Date of the last invoice. |
Last Name | Occupant’s last name. |
Last Payment Amount | Amount of last payment. |
Last Payment Date | Date of last payment. |
Literal Value | Literal fields are hard-coded to display whatever is entered in “format”. For example, if a field should always display “Z”, set it up as a literal value and enter “Z” in FORMAT. |
Middle Initial | Occupant’s middle initial. |
Name Address Line 1 | Address lines 1 through 6 (using unparsed addresses) |
Occupant Title | Occupant’s title. |
Occupant TypeID | Account’s occupant type. |
Other Name | Occupant’s other name. |
Other Name Usage | Usage of occupant’s other name. |
Past Due Amount | Past due amount. |
Phone | Occupant’s phone number. |
Phone Unlisted | Phone number unlisted setting (yes/no) |
Short Name | Abbreviated company name used by banks. |
Terms ID | Subscription term. |
Truck ID | Truck ID from the truck sequence files. |
The following table lists the data elements available for the “PostBillExp” usage, which is used for the Finnish Post Export with an export type of “Billing.”
The following table lists the data elements available for the “PostSubFull” usage, which is used for the Finnish Post Export with an export type of “Full Audit.”
The following data elements can be used with the “OfficePayAudit” usage.
The following table lists the data elements available for the “PostSubAudit” usage, which is used for the Finnish Post Export with an export type of “Subscriber Audit.”
Carriage Return
Filler
Line Feed
Literal Value
Price Code
Publish Date
Quantity
Service Code
USPS Number
Volume Number
Weight
Activity Indicator
Carriage Return
Copies
Delivery Frequency
Filler
Line Feed
Literal Value
Other Name
Post Code
Product ID
Publish Date
Route ID
Subscriber Address
Subscriber Name
Subscriber Name + Other Name
Subscription ID
Address ID
Delivery Placement ID
Longitude
Receive Bonus Days
Allow Web Access
Delivery Schedule ID
Mail Accessible
Renewal Delivery Override
Area Code
Directions To Address
Middle Initial
Renewal Override Code
Area Code + Phone
Dwelling Status Date
Military Foreign
Report Period End Date
Attention Line
Dwelling Status ID
Name Address Line [1-6]
Report Period Start Date
Auto Pay
Dwelling Type ID
Number of Renewals Sent
Route Accessible
Bill Address ID
Email Address
Occupant ID
Route ID
Billing Method
Expire Date
Occupant Salutation ID
Route Name
Bill Occupant ID
Extension
Occupant Title
Send Invoice
Bill Source ID
Firm Name
Occupant Type ID
Send Renewal
Building
First Name
Original Start Date
Short Name
Carrier ID
Gets Paper
Other Name
State ID
Carrier Name
Home Page
Other Name Usage
Street Name
Census Block ID
Honorific ID
Phone
Street Suffix ID
Census Tract ID
House Number Modifier
Phone Unlisted
Subscriber
City ID
Last Name
PO Route Number
Subscription ID
Company ID
Last Payment Amount
PO Route Type
Subscription Status
Complaint Days Adjust
Last Payment Date
PO Route Walk Sequence
Town of 25 ID
Complex
Last Payment Length
Post Directional
Transaction Detail
Country ID
Last Payment Method
Pre Directional
Unit Designator ID
County ID
Last Payment Term
Product ID
Unit Number
Credit Detail
Latitude
Publication Name
Zip Bar Code
Date Last Renewal Sent
Line Feed
Purchase Number
Zip Code
Delivery Instructions
Literal Value
Rate Code ID
Zip Extension
Activity Indicator
Carriage Return
Copies
Delivery Frequency
Filler
Line Feed
Literal Value
Other Name
Post Code
Product ID
Publish Date
Route ID
Subscriber Address
Subscriber Name
Subscriber Name + Other Name
Subscription ID
The following data elements can be used with the “ProofOfSale” usage.
* Field is required
The following data elements can be used with the “RouterImport” usage.
* Indicates a required element
The following table lists the data elements available for the “SubBilling” File Map usage.
The following table lists the data elements that can be used with the “RouteData” file map usage, which is used for exporting the Route Delivery List.
* Delivery Detail can include the following detail elements:
AddressID, AddressLine[1-5], AllowWebAccess, AreaCode, AreaCode+Phone, AreaID, AttentionLine, Building, CensusBlockID, CensusTractID, CityID, Complex, Copies[Sun-Sat], CountryID, CountyID, DeliveryInstructions, DeliveryPlacementID, DeliveryScheduleID, DepotID, DirectionsToAddress, DistribZoneID, DistrictID, DropLocation, DwellingStatusDate, DwellingStatusID, DwellingTypeID, Extension, ExternalSubscriptionID, Filler, FirmName, FirstName, HouseNumber, HouseNumberModifier , LastName, LineFeed, LiteralValue, MailAccessible, MilitaryForeign, Name, NameAddress [Lines1-6], OccupantID, OccupantTitle, OccupantTypeID, OriginalStartDate, OtherName, OtherNameUsage, Phone, PhoneUnlisted, PORouteNumber, PORouteType, PORouteWalkSequence, PostDirectional, PreDirectional, ProductID, RateCodeID, RegionID, RenewalDeliveryOverride, RenewalOverrideCode, RouteAccessible, RouteID, ShortName, StateID, StreetName, StreetSuffixID, SubscriptionID, TownOf25ID, UnitDesignatorID, UnitNumber, ZipBarCode, ZipCode, ZipCode+ZipExtension, ZipExtension
The following data elements can be used with the “RouteAddrLabel” usage, which can be used with the Route Labels and Previous Delivery Labels menu options.
* Can contain the following detail elements:
Attention Line, Building, City ID, Complex, Country ID, District Description, District ID, Drop Order, Edition Id, Expire Date, Filler, Firm Name, First Name, Honorific ID, House Number, House Number Modifier, Label Line [1-6], Last Name, Line Feed, Literal Value, Mail Stop, Middle Initial, Occupant Title, Other Name, Other Name Usage, Post Directional, Pre Directional, Product ID, Route ID, State ID, Street Name, Street Suffix ID, Subscription ID, Truck ID, Unit Designator ID, Unit Number, Zip Code, Zip Extension
The following table lists the data elements available for the “ReturnsJournal” File Map usage. Some of the data elements are valid only for certain types of draw adjustments (route, single copy, or TM), and the table shows which elements are valid for each. When a data element is exported for a table that does not use that field, a blank will be exported instead of a value.
* Field is required.
Data Element | Description |
---|---|
Data Element | Data Element |
---|---|
Data Element | Route | Single Copy | TM |
---|---|---|---|
AccountID*
The account to which the proof of sale applies.
AdjustmentAmount*
The copies sold amount.
BillSourceID
The account’s bill source.
CompanyID
The account’s company.
InvoiceNumber
The invoice number for the copies sold.
TranDate
The transaction date for copies sold.
AAM Zone ID
Address ID*
New Route ID*
Old Route ID*
Product ID*
Record Identifier
SubscriptionID
RateTerm2ExpireDate
LastName
RateTerm3Amount
FirstName
RateTerm3ExpireDate
HouseNumber
RateTerm3Length
StreetName
RateTerm4Amount
StreetSuffixID
RateTerm4ExpireDate
UnitDesignatorID
RateTerm4Length
UnitNumber
RateTerm1PremiumAmount
CityID
RateTerm2PremiumAmount
StateID
RateTerm3PremiumAmount
ZipCode
RateTerm4PremiumAmount
RateTerm1Amount
RateTerm1AmountWithTaxes
RateTerm1ExpireDate
ActivationFeeAmount
RateTerm1Length
PrintedBillFeeAmount
RateTerm2Amount
ProductID
ActivationFeeTax
ActivationCityFeeTax
ActivationCountyFeeTax
ActivationStateFeeTax
ActivationCountryFeeTax
PrintedBillFeeTax
PrintedBillCityFeeTax
PrintedBillCountyFeeTax
PrintedBillStateFeeTax
PrintedBillCountryFeeTax
Address ID
Drop Location
Region ID
Address Line [1-5]
Dwelling Status Date
Route Accessible
Area ID
Dwelling Status ID
Route ID
Building
Dwelling Type ID
State ID
Census Block ID
Filler
Street Name
Census Tract ID
House Number
Street Suffix ID
City ID
House Number Modifier
Supply Truck ID
Complex
Line Feed
Town of 25 ID
Country ID
Literal Value
Truck ID
County ID
Mail Accessible
Truck Name
Delivery Detail (has detail)*
Military Foreign
Unit Designator ID
Delivery Placement ID
PO Route Number
Unit Number
Demographic Answer
PO Route Type
Zip Bar Code
Depot ID
PO Route Walk Sequence
Zip Code
Directions To Address
Post Directional
Zip Code + Zip Extension
Distrib Zone ID
Pre Directional
Zip Extension
District ID
Address Line [1-5]
House Number
Product ID
Attention Line
House Number Modifier
Route ID
Building
Label Detail*
Route Name
City ID
Last Name
State ID
Complex
Line Feed
Street Name
District Description
Literal Value
Street Suffix ID
District ID
Mail Stop
Subscription ID
Drop Order
Middle Initial
Truck ID
Edition ID
Occupant Title
Unit Designator ID
Expire Date
Other Name
Unit Number
Filler
Other Name Usage
Zip Code
Firm Name
Post Directional
Zip Code + Zip Extension
First Name
Pre Directional
Zip Extension
Honorific ID
ProductID*
X
X
X
RouteID*
X
X
X
DrawDate
X
X
X
DrawClassID
X
SequenceNumber
X
X
X
DrawAdjustID
X
X
X
AAMDrawDate
X
X
X
DrawAdjustDate
X
X
X
DrawAdjustment
X
X
X
DrawAdjustBatchID
X
X
X
BillBatchID
X
X
X
FullyBilled
X
X
X
AmountCollected
X
ShortageTranNumber
X
IsBadEdition
X
IsOverSupply
X
X
IsEarlyLateReturn
X
X
X
Remarks
X
ChargeBatchID
X
X
X
ChargeSequenceNumber
X
X
X
CreditSequenceNumber
X
X
X
ImportEditionID
X
TMProductID
X
DeliveryDate
X
DeliveryScheduleID
X
CarrierCollectDrawAdjust
X
OfficePayDrawAdjust
X
PaidCompDrawAdjust
X
UnpaidCompDrawAdjust
X
SampleDrawAdjust
X
ServiceDrawAdjust
X
ThirdPartyDrawAdjust
X
SubscriptionID
X
TranNumber
X
AAMColumnID
X
CreateDate
X
X
X
CreateTime
X
X
X
CreateUser
X
X
X
The following data elements can be used with the “SCByDay” usage.
The following data elements can be used with the “SoldImport” usage.
* Field is required
The following data elements can be used with the “RouteSmart” usage.
* Indicates a required element
File type: Pipe delimited.
Location: /dti/exchange/cm
. The file name is specified at run time.
Data Element | Description |
---|---|
Data Elements |
---|
Field | Format |
---|---|
Field | Description |
---|---|
Adjust Copies
Area
Company ID
Copies Delivered
Copies Returned
District
Draw Date
Filler
Line Feed
Literal Value
Location
Net Returns And Adjust
Net Sales
Product ID
Publication Name
Region
Return Percentage
Route ID
Sell Out
Single Copy Type
Zone
ProductID
The product to which the sold/shrink copies apply.
RouteID*
The ID of the route.
DrawDate
Date of the sold/shrink draw adjustment.
DrawAdjustment*
Draw adjustment for sold/shrink copies for the route.
AddressID
AddressLine1
AddressLine2
AddressLine3
AddressLine4
AddressLine5
AreaID
Building
CensusBlockID
CensusTractID
CityID
Complex
CountryID
CountyID
DeliveryDetail*
DeliveryPointID
DemographicAnswer
DepotID
DirectionsToAddress
DistribZoneID
DistrictID
DropLocation
DwellingStatusDate
DwellingStatusID
DwellingTypeID
Filler
HouseNumber
HouseNumberModifier
LevelDesignatorID
LevelNumber
LiteralValue
MailAccessible
MilitaryForeign
PORouteNumber
PORouteType
PORouteWalkSequence
PostDirectional
PreDirectional
RegionID
RouteAccessible
RouteID
StateID
StreetName
StreetSuffixID
SupplyTruckID
TownOf25ID
TruckID
TruckName
UnitDesignatorID
UnitNumber
ZipBarCode
ZipCode
ZipCode+ZipExtension
ZipExtension
AAM Zone
x(6)
Excluded
yes/no
Subscription ID
9999999999
Start Date
mm/dd/yy
End Date
mm/dd/yy
Grace Days
999999
Delivery Schedule
x(8)
Write-off Date
mm/dd/yy
Grace Owed Amount
9999999.99
Discount
999999.99
Total Amount
9999999.99
Grace Copies
999999
Grace Copies by Group (one field for each day group)
999999
Rate Code
x(20)
Exclude Reason Code
x(8)
pOutsideProfileList
Outer level tag containing list of profiles
OutsideProfile
Each Individual profile will be contained within an OutsideProfile tag
HmAddressId
Circulation AddressID for this profile's address
HouseNumber
House number for this profile's address
StreetName
Street name for this profile's address
Address2
2nd address line for this profile's address
Address3
3rd address line for this profile's address
City
City name for this profile's address
CountryCode
County for this profile's address
State
State for this profile's address
Zip
Postal (ZIP) Code for this profile's address
Latitude
Address latitude
Longitude
Address longitude
HmOccupantId
Circulation OccupantID for this profile's occupant
FirstName
Occupant's first name
SecondName
Occupant's last name
Phone
Occupant's primary phone
SecondPhone
Occupant's most relevant secondary phone
EmailAddress
Occupant's most relevant email address
Password
Encoded password for this occupant
Subscriber
Logical value indicating if occupant is an active subscriber to at least one publication
OutsideAnswers
Tag listing answers to demographics
OutsideAnswer
Each demographic with Map to Audience flagged that the occupant has answered will be exported in an OutsideAnswer node, containing Answer and QuestionID tags.
Answer
Occupant’s answer for the demographic in the QuestionID tag
QuestionID
Demographic being exported in this OutsideAnswer tag. This is the Audience Category specified for the demographic in Demographic setup (not the demographic ID). This must be a category defined in Audience.
OutsideSubscriptions
Tag listing subscriptions related to this profile (occupant and address)
OutsideSubscription
Each individual subscription for this profile will be contained within an OutsideSubscription tag
SubscriptionId
Circulation SubscriptionID (account number) for this subscription
ProductId
ID of publication this subscription is for
EditionId
ID of edition this subscription is for
DeliveryScheduleId
ID identifying delivery frequency for this subscription
DeliveryMethod
Subscription’s delivery method, identifying type of delivery (“Route”, “Online”, etc.)
BillingMethod
Subscription’s billing method, identify how it is billed (“Office Pay”, “Carrier Collect” etc.)
RateCodeId
Rate code associated with payment rate terms for this subscription
SubscriptionStatusId
Status of this subscription
IsRegisteredUser
Logical flag indicating if this profile is for a registered user of the website
OriginalStartDate
Start date of original term for this subscription
OriginalStartSourceCode
Start source code of original term for this subscription
OriginalStartReasonCode
Start reason code of original term for this subscription
OriginalExpireDate
Expiration date of original term for this subscription
OriginalStopDate
Stop date of original term for this subscription
OriginalStopSourceCode
Stop source code of original term for this subscription
OriginalStopReasonCode
Stop reason code of original term for this subscription
LastStartDate
Start date of current/last term for this subscription
LastStartSourceCode
Start source code of current/last term for this subscription
LastStartReasonCode
Start reason code of current/last term for this subscription
LastExpireDate
Expiration date of current/last term for this subscription
LastStopDate
Stop date of current/last term for this subscription
LastStopSourceCode
Stop source code of current/last term for this subscription
LastStopReasonCode
Stop reason code of current/last term for this subscription
FutureStartDate
Start date of future term for this subscription
FutureStartSourceCode
Start source code of future term for this subscription
FutureStartReasonCode
Start reason code of future term for this subscription
FutureExpireDate
Expire date of future term for this subscription
FutureStopDate
Stop date of future term for this subscription
FutureStopSourceCode
Stop source code of future term for this subscription
FutureStopReasonCode
Stop reason code of future term for this subscription
The content of the e-mail message sent to customers who purchase a day pass with a new e-mail address (or reset their password) is based on a new “Day Pass” e-mail template. A default HTML template is contained in the email/custservice/daypass.htm
file, located in the Circulation code set. A text template, daypass.tmp
, is located in the same directory.
You can customize the day pass template in the same way as the Digital Vacation Pack Template (above).
The template contains links to the publication website, based on two Business Rules in the iServices & Mapping section: What is the host name for Day Pass? and What is the URL path for Day Pass? Additional settings for the template (including a BCC recipient and whether to archive day pass confirmation e-mails) are defined in Website setup (see in the Setup Manual).
Parameter | Description |
---|---|
General variables
[Subject]
Title of confirmation e-mail.
Subscriber information
[AccountNumber]
Subscriber’s ID.
[PublicationName]
Name of day pass publication.
[SaleDateTime]
Date and time on which the day pass was purchased.
[ExpireDateTime]
Date and time on which the day pass will expire.
[PaymentType]
Type of payment.
[PaymentAmount]
Amount of payment.
[Password]
Subscriber’s password.
iServices Subscriber URLs (if necessary also append "site" parameter)
[DayPassURL]
Link to digital edition purchased by day pass.
[ImagePath]
Directory containing images (e.g. logo - header.jpg).