Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
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.
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.
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.
Number | Renewals | Invoices |
---|---|---|
Parameter | Description |
---|---|
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).
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.
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.
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.
Parameter | Description |
---|---|
Parameter | Description |
---|---|
Template Field | Expected Output |
---|---|
Parameter | Description |
---|---|
Parameter | Description |
---|
[Subject]
E-mail subject line.
[Password]
Subscriber’s new password.
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).
[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
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).
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). |
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 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.
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 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.
Parameter | Description |
---|---|
Parameter | Description |
---|---|
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 |
---|---|
Parameter | 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).
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.
[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).
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).